|
|
|
SiSU
Manual
Ralph Amissah
copy @ SiSU
SiSU - Manual,
|
1 |
What is SiSU? |
2 |
Extracts from the README |
1715 |
42. README |
42. README |
1716 |
1717 |
Homepage: <http://www.jus.uio.no/sisu> |
1718 |
1719 |
Outputs share a common citation numbering system, and any semantic meta-data provided about the document. |
1722 |
SiSU also provides concordance files, document content certificates and manifests of generated output. |
1723 |
A vim syntax highlighting file and an ftplugin with folds for sisu markup is provided. Vim 7 includes syntax highlighting for SiSU. |
1725 |
1726 |
Dependencies for various features are taken care of in sisu related packages. The package sisu-complete installs the whole of SiSU. |
1727 |
Homepage: <http://www.jus.uio.no/sisu> |
1729 |
SiSU - simple information structuring universe, is a publishing tool, document generation and management, (and search enabling) tool primarily for literary, academic and legal published works. |
1730 |
SiSU can be used for Internet, Intranet, local filesystem or cd publishing. |
1731 |
SiSU can be used directly off the filesystem, or from a database. |
1732 |
SiSU's scalability, is be dependent on your hardware, and filesystem (in my case Reiserfs), and/or database Postgresql. |
1733 |
1734 |
|
1735 |
|
1738 |
1740 |
1741 |
1742 |
1743 |
1744 |
1745 |
1746 |
1747 |
1748 |
1749 |
If you use Debian use the Debian packages, check the information at: |
1750 |
1751 |
(A) SiSU is available directly off the Debian archives for Sid and testing. It should necessary only to run as root: |
1752 |
1753 |
1754 |
(B) If there are newer versions of SiSU upstream of the Debian archives, they will be available by adding the following to your /etc/apt/sources.list |
1755 |
deb <http://www.jus.uio.no/sisu/archive> unstable main non-free |
1756 |
deb-src <http://www.jus.uio.no/sisu/archive> unstable main non-free |
1757 |
1759 |
1760 |
1761 |
1762 |
RPMs are provided though untested, they are prepared by running alien against the source package, and against the debs. |
1763 |
1764 |
1765 |
1766 |
Otherwise to install SiSU from source, check information at: |
1767 |
1768 |
alternative modes of installation from source are provided, setup.rb (by Minero Aoki), rake (by Jim Weirich) built install file, rant (by Stefan Lang) built install file, |
1769 |
Ruby is the essential dependency for the basic operation of SiSU |
1770 |
1771 |
1772 |
1773 |
Note however, that additional external package dependencies, such as texlive or postgresql should you desire to use it are not taken care of for you. |
1774 |
1775 |
this is a three step process, in the root directory of the unpacked SiSU as root type: |
1776 |
1777 |
1778 |
1779 |
1780 |
1781 |
1782 |
1783 |
1784 |
1785 |
1786 |
1787 |
1788 |
1789 |
1790 |
1791 |
This makes use of Rake (by Jim Weirich) and the provided Rakefile |
1792 |
1793 |
1794 |
1795 |
1796 |
(you may use the instructions above for rake substituting rant if rant is installed on your system, or you may use an independent installer created using rant as follows:) |
1797 |
1798 |
1799 |
1800 |
1801 |
1803 |
1804 |
1805 |
1806 |
1807 |
1808 |
1809 |
The following is from the debian/control file of sisu-0.58.2, which amongst other things provides the dependencies of sisu within Debian. |
1812 |
1820 |
Most of the installation should be taken care of by the aptitude or rant install. (The rant install if run in full will also test run the generation of the first document). |
1821 |
After installation of sisu-complete, move to the document samples directory |
1822 |
1823 |
1824 |
sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst |
1825 |
1826 |
sisu -NhwpoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst |
1827 |
look at output results, see the "sisu_manifest" page created for the document |
1828 |
or to generate an online document move to a writable directory, as the file will be downloaded there and e.g. |
1829 |
sisu -3 <http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst> |
1830 |
the database stuff is extra perhaps, the latex stuff could be considered extra perhaps but neither needs to be installed for most of sisu output to work |
1831 |
1832 |
gvim free_as_in_freedom.rms_and_free_software.sam_williams.sst |
1833 |
1834 |
1835 |
1836 |
1837 |
1838 |
1839 |
1840 |
1841 |
1842 |
1843 |
1844 |
1845 |
The default configuration/setup is contained within the program and is altered by configuration settings in etc[sisu version]/sisurc.yml or in ~/.sisu/sisurc.yml |
1846 |
|
1847 |
1848 |
1849 |
|
1850 |
* skins - changing the appearance of a project, directory or individual documents within ~/.sisu/skin |
1851 |
~/.sisu/skin/doc contains individual skins, with symbolic links from |
1852 |
~/.sisu/skin/dir if the contents of a directory are to take a particular document skin. |
1853 |
|
1854 |
|
1855 |
There are post installation steps (which are really part of the overall installation) |
1856 |
1858 |
Documents are marked up in SiSU syntax and kept in an ordinary text editable file, named with the suffix .sst, or .ssm |
1859 |
Marked up SiSU documents are usually kept in a sub-directory of your choosing |
1860 |
1861 |
1862 |
1863 |
1864 |
1865 |
1866 |
1867 |
'man sisu_markup-samples' [if the sisu-markup-samples package is also installed] |
1868 |
Once installed an interactive help is available typing 'sisu' (without) any flags, and select an option: |
1869 |
1870 |
1871 |
1872 |
1873 |
1874 |
1875 |
1876 |
1877 |
1878 |
1879 |
1880 |
1881 |
1882 |
1883 |
1884 |
1885 |
1886 |
1887 |
The defaults can be changed via SiSU's configure file sisurc.yml which the program expects to find in ./_sisu ~/.sisu or /etc/sisu (searched in that order, stopping on the first one found) |
1888 |
1889 |
1890 |
1891 |
1892 |
Once installed there is some information on SiSU Markup in its help: |
1893 |
1894 |
1895 |
1896 |
Sample marked up document are provided with the download tarball in the directory: |
1897 |
1898 |
1899 |
1900 |
More markup samples are available in the package sisu-markup-samples |
1901 |
<http://www.jus.uio.no/sisu/SiSU/download.html#sisu-markup-samples> |
1902 |
1903 |
1904 |
1905 |
There is syntax support for some editors provided (together with a README file) in |
1906 |
1907 |
1908 |
1909 |
1910 |
1911 |
1912 |
1913 |
1914 |
1915 |
1916 |
|
1917 |
|
1918 |
|
1919 |
1920 |
|
1921 |
1922 |
1923 |
1924 |
1925 |
<http://www.jus.uio.no/sisu/SiSU/changelog_markup_samples.html> |
1926 |
|
|
|
Output generated by
SiSU
0.59.1 2007-09-25 (2007w39/2)
|
SiSU using:
| |
SiSU is released under GPLv3 or later, <http://www.gnu.org/licenses/gpl.html> |
SiSU, developed using
Ruby
on
Debian/Gnu/Linux
software infrastructure,
with the usual GPL (or OSS) suspects.
|