diff options
Diffstat (limited to 'data/doc/sisu/html/sisu.8.html')
| -rw-r--r-- | data/doc/sisu/html/sisu.8.html | 195 |
1 files changed, 120 insertions, 75 deletions
diff --git a/data/doc/sisu/html/sisu.8.html b/data/doc/sisu/html/sisu.8.html index b79b71b1..c6134b33 100644 --- a/data/doc/sisu/html/sisu.8.html +++ b/data/doc/sisu/html/sisu.8.html @@ -19,65 +19,72 @@ document publishing system, that from a simple single marked-up document, produces a multitude of output formats including: html, latex, pdf, info, and sql output, which can be cross referenced as having the same document structure and text object numbering, "object citation numbering". Features -include its’ simple syntax; the semantic identification of documents using -the Dublin Core; document management; built to be associated with a revision -control system; text object numbering for the identification of a texts -location in any of the output formats, easy skinning on a site wide, or -per document basis, ... for more see <i>man</i> 1 sisu or <i><<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> +include its’ simple syntax; the semantic tagging of documents; document +management; built to be associated with a revision control system; text +object numbering for the identification of a texts location in any of the +output formats, easy skinning on a site wide, or per document basis; granular +search; a degree of future proofing ... for more see <i>man</i> 1 sisu or <i><<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> ></i> <p> -<b>SiSU is an alternative way of publishing and managing documents.</b> +<b>SiSU is a way of preparing, publishing, managing and searching documents.</b> + <h2><a name='sect3' href='#toc3'>Installation</a></h2> <p> -Up -to date information on SiSU downloads, and their installation should be -available from: <i><<a href='http://www.jus.uio.no/sisu/SiSU/download.html'>http://www.jus.uio.no/sisu/SiSU/download.html</a> -></i> or at: <i><<a href='http://www.jus.uio.no/sisu/sisu_download/download.html'>http://www.jus.uio.no/sisu/sisu_download/download.html</a> +Up to date information on SiSU downloads, and their installation +should be available from: <i><<a href='http://www.jus.uio.no/sisu/SiSU/download.html'>http://www.jus.uio.no/sisu/SiSU/download.html</a> +></i> or +at: <i><<a href='http://www.jus.uio.no/sisu/sisu_download/download.html'>http://www.jus.uio.no/sisu/sisu_download/download.html</a> +></i> <p> +There you should +find links to the latest source tarball, and instructions on how to install +SiSU. <p> +Sample marked up documents are are available at <i>/usr/share/doc/sisu/sisu_markup_samples/dfsg</i> +or equivalent directory, or online, see <i><<a href='http://www.jus.uio.no/sisu/SiSU/2.html'>http://www.jus.uio.no/sisu/SiSU/2.html</a> ></i> <p> -There you should find links to the latest source tarball, and instructions -on how to install SiSU. <p> -Sample marked up documents are are available at -<i>/usr/share/doc/sisu/sisu_markup_samples/dfsg</i> or equivalent directory, or -online at <i><<a href='http://www.jus.uio.no/sisu/sample/markup.html'>http://www.jus.uio.no/sisu/sample/markup.html</a> -></i> or for viewing in html -with syntax highlighting from <i><<a href='http://www.jus.uio.no/sisu/sample/syntax'>http://www.jus.uio.no/sisu/sample/syntax</a> -></i> <p> -A syntax -table is provided at <i>/usr/share/doc/sisu/on_markup.txt</i> or equivalent, and -online at <i><<a href='http://www.jus.uio.no/sisu/sample/on_markup.txt'>http://www.jus.uio.no/sisu/sample/on_markup.txt</a> -></i> <p> -<i>man</i> 1 sisu has a -syntax table along with processing commands. <p> -SiSU also provides some help -via the command: <i>sisu</i> --help and selecting an appropriate subject, e.g. <p> -<i>sisu</i> ---help commands <p> +<i>man</i> 1 sisu has a syntax table along with processing commands. <p> +SiSU also +provides some help via the command: <i>sisu</i> --help and selecting an appropriate +subject, e.g. <p> +<i>sisu</i> --help commands <p> <i>sisu</i> --help markup <p> <i>sisu</i> --help headers <p> -<i>sisu</i> --help env <p> -The rest -of this note is on post installation setup -<h2><a name='sect4' href='#toc4'>Post Installation Setup - Quick -start</a></h2> -<p> -After installation of sisu-complete, move to the document samples directory +<i>sisu</i> +--help env <p> +The rest of this note is on post installation setup +<h2><a name='sect4' href='#toc4'>Post Installation +Setup - Quick start</a></h2> <p> + +<p> After installation of sisu-complete, move to the document +samples directory, <p> cd /usr/share/doc/sisu/sisu_markup_samples/dfsg<br> <p> -and run <p> - sisu -1 free_as_in_freedom.rms_and_free_software.sam_williams.sst<br> - <p> +[this is not where you would normally work but provides sample documents +for testing, you may prefer instead to copy the contents of that directory +to a local directory before proceeding] <p> +and in that directory, initialise +the output directory with the command <p> +<i>sisu</i> -CC <p> +then run: <p> +<i>sisu</i> -1 free_as_in_freedom.rms_and_free_software.sam_williams.sst +<p> or the same: <p> - sisu -NhwpoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst<br> - <p> +<i>sisu</i> -NhwpoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst +<p> look at output results, see the "sisu_manifest" page created for the document <p> -To generate an online document move to a writable directory, (create a -work directory and cd into it) as the file will be downloaded there and -e.g. <p> +for an overview of your current sisu setup, type: <p> +<i>sisu</i> --help env <p> +or <p> +<i>sisu</i> +-V <p> +To generate a document from a remote url accessible location move to +a writable directory, (create a work directory and cd into it) as the file +will be downloaded there and e.g. <p> <i>sisu</i> -1 <a href='http://www.jus.uio.no/sisu/gpl3.fsf/gpl3.fsf.sst'>http://www.jus.uio.no/sisu/gpl3.fsf/gpl3.fsf.sst</a> - <p> + +<p> <i>sisu</i> -3 <a href='http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst'>http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst</a> <p> @@ -140,39 +147,76 @@ gives an idea of additional packages that SiSU can make use of if available, (the use/requirement of some of which are interdependent for specific actions by SiSU): <p> Package: sisu <p> -Depends: ruby (>= 1.8.4), libwebrick-ruby <p> +Depends: ruby (>= 1.8.2), libwebrick-ruby, unzip, zip +<p> +Conflicts: vim-sisu, sisu-vim, sisu-remote <p> +Replaces: vim-sisu, sisu-vim <p> Recommends: -sisu-pdf, sisu-sqlite, sisu-postgresql, librmagick-ruby, trang, tidy, librexml-ruby, -zip, unzip, openssl, rsync, openssh-client lsh-client,<br> - keychain, hyperestraier, kdissert<br> - <p> -Suggests: libfcgi-ruby1.8, rcs cvs, lv, texinfo, pinfo, rename <p> -Package: -sisu-complete <p> -Depends: ruby (>= 1.8.4), sisu, sisu-pdf, sisu-postgresql, sisu-sqlite +sisu-pdf, sisu-sqlite, sisu-postgresql, librmagick-ruby, trang, tidy, librexml-ruby, +openssl, rsync, openssh-client lsh-client, keychain, hyperestraier, kdissert +Suggests: rcs cvs, lv, texinfo, pinfo <p> +Package: sisu-complete <p> +Depends: ruby +(>= 1.8.2), sisu, sisu-pdf, sisu-postgresql, sisu-sqlite <p> +Recommends: hyperestraier <p> -Recommends: hyperestraier <p> Package: sisu-pdf <p> -Depends: sisu, tetex-bin texlive-base-bin, -tetex-extra texlive-latex-extra, texlive-latex-extra, latex-ucs<br> - <p> +Depends: sisu, texlive-latex-base, texlive-fonts-recommended, +texlive-latex-recommended, texlive-latex-extra <p> Suggests: evince, xpdf <p> -Package: sisu-postgresql <p> -Depends: sisu, postgresql-8.1, -libdbi-ruby, libdbm-ruby, libdbd-pg-ruby <p> -Suggests: pgaccess, libdbd-pgsql, postgresql-contrib-8.1 +Package: +sisu-postgresql <p> +Depends: sisu, libdbd-pg-ruby, libdbi-ruby, libdbm-ruby, postgresql <p> +Recommends: libfcgi-ruby <p> Package: sisu-sqlite <p> -Depends: sisu, sqlite, libdbi-ruby, libdbm-ruby, libdbd-sqlite-ruby +Depends: sisu, sqlite, libdbd-sqlite-ruby, +libdbi-ruby, libdbm-ruby <p> +Recommends: libfcgi-ruby <p> +Package: sisu-markup-samples <p> -Suggests: libdbd-sqlite <p> -Package: sisu-markup-samples <p> Depends: sisu <p> + +<h2><a name='sect6' href='#toc6'>Package Description</a></h2> +<b>sisu</b> <p> +Description: documents - structuring, +publishing in multiple formats and search <p> +SiSU is a lightweight markup +based, command line oriented, document structuring, publishing and search +framework for document collections. <p> +With minimal preparation of a plain-text, +(UTF-8) file, using its native markup syntax in your text editor of choice, +SiSU can generate various document formats (most of which share a common +object numbering system for locating content), including plain text, HTML, +XHTML, XML, OpenDocument text (ODF:ODT), LaTeX, PDF files, and populate +an SQL database with objects (roughly paragraph-sized chunks) so searches +may be performed and matches returned with that degree of granularity: +your search criteria is met by these documents and at these locations within +each document. Object numbering is particularly suitable for "published" +works (finalized texts as opposed to works that are frequently changed +or updated) for which it provides a fixed means of reference of content. +Document outputs also share semantic meta-data provided. <p> +SiSU also provides +concordance files, document content certificates and manifests of generated +output. <p> +A vim syntax highlighting file and an ftplugin with folds for sisu +markup is provided, as are syntax highlighting files for kate, kwrite, +gedit and diakonos. Vim 7 includes syntax highlighting for SiSU. <p> +man pages, +and interactive help are provided. <p> +Dependencies for various features are +taken care of in sisu related packages. The package sisu-complete installs +the whole of SiSU. <p> +Additional document markup samples are provided in the +package sisu-markup-samples which is found in the non-free archive the licenses +for the substantive content of the marked up documents provided is that +provided by the author or original publisher. <p> +Homepage: <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> +> </pre> -<h2><a name='sect6' href='#toc6'>Document -Resource Configuration</a></h2> -<b>sisu</b> resource configuration information is obtained -from sources (where they exist): <br> +<h2><a name='sect7' href='#toc7'>Document Resource Configuration</a></h2> +<b>sisu</b> resource configuration information +is obtained from sources (where they exist): <br> <pre>~/.sisu/sisurc.yaml/etc/sisu/[sisu version]/sisurc.yamlsisu program defaults</pre><p> <b>Skins</b> <p> @@ -190,16 +234,16 @@ of documents. <p> Usually all skin files are placed in the document skin directory: <i>~/.sisu/skin/doc</i> with softlinks being made to the skins contained there from other skin directories as required. -<h2><a name='sect7' href='#toc7'>Further Information</a></h2> +<h2><a name='sect8' href='#toc8'>Further Information</a></h2> <p> For more information on <i>SiSU</i> see: <i><<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> ></i> <p> or <i>man</i> sisu -<h2><a name='sect8' href='#toc8'>Author</a></h2> +<h2><a name='sect9' href='#toc9'>Author</a></h2> Ralph Amissah <i><ralph@amissah.com></i> or <i><ralph.amissah@gmail.com></i> -<h2><a name='sect9' href='#toc9'>See Also</a></h2> +<h2><a name='sect10' href='#toc10'>See Also</a></h2> <a href='http:~/bin/man2html?sisu:1'><b>sisu(1)</a> ,</b> <a href='http:~/bin/man2html?sisu_examples:1'><b>sisu_examples(1)</a> ,</b> <a href='http:~/bin/man2html?sisu_webrick:1'><b>sisu_webrick(1)</a> @@ -219,10 +263,11 @@ or <i><ralph.amissah@gmail.com></i> <li><a name='toc3' href='#sect3'>Installation</a></li> <li><a name='toc4' href='#sect4'>Post Installation Setup - Quick start</a></li> <li><a name='toc5' href='#sect5'>Debian INSTALLATION Note</a></li> -<li><a name='toc6' href='#sect6'>Document Resource Configuration</a></li> -<li><a name='toc7' href='#sect7'>Further Information</a></li> -<li><a name='toc8' href='#sect8'>Author</a></li> -<li><a name='toc9' href='#sect9'>See Also</a></li> +<li><a name='toc6' href='#sect6'>Package Description</a></li> +<li><a name='toc7' href='#sect7'>Document Resource Configuration</a></li> +<li><a name='toc8' href='#sect8'>Further Information</a></li> +<li><a name='toc9' href='#sect9'>Author</a></li> +<li><a name='toc10' href='#sect10'>See Also</a></li> </ul> </body> </html> |