diff options
Diffstat (limited to 'data/doc/sisu/markup-samples/sisu_manual/sisu_howto.sst')
| -rw-r--r-- | data/doc/sisu/markup-samples/sisu_manual/sisu_howto.sst | 301 |
1 files changed, 156 insertions, 145 deletions
diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_howto.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_howto.sst index 8dfee20b..34a4eab1 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_howto.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_howto.sst @@ -1,11 +1,13 @@ -% SiSU insert 3.0 +% SiSU insert 2.0 @title: SiSU :subtitle: Technical, Howto -@creator: :author: Amissah, Ralph +@creator: + :author: Amissah, Ralph -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 @classify: :type: information @@ -28,16 +30,16 @@ :bold: /Gnu|Debian|Ruby|SiSU/ @links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Homepage }http://www.sisudoc.org/ + { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/ + { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary + { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU :A~? @title @creator @@ -69,8 +71,6 @@ _* {~^ sisu.1 }http://www.jus.uio.no/sisu/man/sisu.1.html _* {~^ sisu.8 }http://www.jus.uio.no/sisu/man/sisu.8.html -_* {~^ sisu_examples.1 }http://www.jus.uio.no/sisu/man/sisu_examples.1.html - _* {~^ sisu_webrick.1 }http://www.jus.uio.no/sisu/man/sisu_webrick.1.html 2~ SiSU built-in help @@ -139,7 +139,11 @@ aptitude install sisu-sqlite ideally copy the sisu-examples directory to your home directory (because the directory in which you run this example should be writable) -cp -rv /usr/share/doc/sisu-markup-samples/v2/samples /. +cp -rv /usr/share/doc/sisu/markup-samples/samples . + +you are better off installing the package sisu-markup-samples which will make the following available + +cp -rv /usr/share/doc/sisu/markup-samples-non-free/samples . !_ (3) use sisu to create an sqlite database @@ -165,7 +169,9 @@ sisu -W within the sisu-examples directory -sisu -F webrick +sisu -F webserv=webrick + +and follow the instructions provided #here i run into a problem, you are working from a read only #directory..., not my usual mode of operation, to complete the example @@ -178,11 +184,11 @@ sisu -F webrick !_ (7) copy the search form to the cgi directory -the string should be provided as output from the previous command +sisu -F webserv=webrick -sudo cp -vi /usr/share/doc/sisu-markup-samples/v2/samples/sisu_sqlite.cgi /usr/lib/cgi-bin +and follow the instructions provided -sudo chmod -v 755 /usr/lib/cgi-bin/sisu_sqlite.cgi +% sudo chmod -v 755 /usr/lib/cgi-bin/sisu_sqlite.cgi !_ (8) open up the form in your browser and query it @@ -267,24 +273,36 @@ _1 sisu -vR[and processing flags] [filename/wildcard] Sample provided, on untarring the source tarball: -_1 conf/sisu/sisurc.yaml +_1 conf/sisu/v2/sisurc.yml + +_1 conf/sisu/v3/sisurc.yml and on installation under: -_1 /etc/sisu/sisurc.yaml +_1 /etc/sisu/v2/sisurc.yml + +_1 /etc/sisu/v3/sisurc.yml The following paths are searched: -_1 ./_sisu/sisurc.yaml +_1 ./_sisu/v2/sisurc.yml or ./_sisu/v3/sisurc.yml -_1 ~/.sisu/sisurc.yaml +_1 ./_sisu/sisurc.yml -_1 ./etc/sisu/sisurc.yaml +_1 ~/.sisu/v2/sisurc.yml or ~/.sisu/v3/sisurc.yml + +_1 ~/.sisu/sisurc.yml + +_1 /etc/sisu/v2/sisurc.yml /etc/sisu/v3/sisurc.yml + +_1 /etc/sisu/sisurc.yml 1~howto_markup Markup See sample markup provided on +http://www.sisudoc.org/ + http://www.jus.uio.no/sisu http://www.jus.uio.no/sisu_markup @@ -293,15 +311,21 @@ http://www.jus.uio.no/sisu/SiSU in particular for each of the document output samples provided, the source document is provided as well -http://www.jus.uio.no/sisu/SiSU/2#books +http://www.jus.uio.no/sisu/SiSU/examples.html on untarring the source tarball: -_1 data/sisu-examples/sample/document_samples_sisu_markup/ +_1 data/doc/sisu/markup-samples or the same once source is installed (or sisu-examples) under: -_1 /usr/share/doc/sisu-markup-samples/v2/samples +_1 /usr/share/doc/sisu/markup-samples/ + +and if you have sisu-markup-samples installed, under + +_1 data/doc/sisu/markup-samples-non-free/ + +_1 /usr/share/doc/sisu/markup-samples-non-free/ Some notes are contained within the man page, *{man sisu}* and within sisu help via the commands *{sisu help markup}* and *{sisu help headers}* @@ -385,19 +409,19 @@ here\~^ 2~ Links -{ SiSU }http://sisudoc.org +{ SiSU }http://www.sisudoc.org code{ -{ SiSU }http://sisudoc.org +{ SiSU }http://www.sisudoc.org }code -{sisu.png }http://sisudoc.org +{sisu.png }http://www.sisudoc.org code{ -{sisu.png }http://sisudoc.org +{sisu.png }http://www.sisudoc.org }code @@ -409,11 +433,11 @@ code{ }code -{~^ SiSU }http://sisudoc.org +{~^ SiSU }http://www.sisudoc.org code{ -{~^ SiSU }http://sisudoc.org +{~^ SiSU }http://www.sisudoc.org }code @@ -421,17 +445,17 @@ is equivalent to: code{ -{ SiSU }http://sisudoc.org ~{ http://sisudoc.org }~ +{ SiSU }http://www.sisudoc.org ~{ http://www.sisudoc.org }~ }code the same can be done with an image: -{~^ sisu.png "SiSU" }http://sisudoc.org +{~^ sisu.png "SiSU" }http://www.sisudoc.org code{ -{~^ sisu.png "SiSU" }http://sisudoc.org +{~^ sisu.png "SiSU" }http://www.sisudoc.org }code @@ -624,7 +648,9 @@ A document may specify its own/bespoke css file using the css header. SiSU 0.55 2007w27/6 2007-07-07 -Homepage: http://www.jus.uio.no/sisu +Homepage: http://www.sisudoc.org + +old homepage: http://www.jus.uio.no/sisu !_ Description @@ -646,7 +672,9 @@ Dependencies for various features are taken care of in sisu related packages. Th 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. -Homepage: http://www.jus.uio.no/sisu +Homepage: http://www.sisudoc.org + +old homepage: http://www.jus.uio.no/sisu 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. @@ -674,6 +702,8 @@ Once set up it is simple to use. 2~ Online Information, places to look +http://www.sisudoc.org + http://www.jus.uio.no/sisu Download Sources: @@ -816,74 +846,51 @@ Once installed see 'man 8 sisu' for some information on additional programs that The information in man 8 may not be most up to date, and it is possible that more useful information can be gleaned from the following notes taken from the Debian control file (end edited), 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). -The following is from the debian/control file of sisu-0.58.2, which amongst other things provides the dependencies of sisu within Debian. +The following is from the debian/control file of sisu-3.0.2, which amongst other things provides the dependencies of sisu within Debian. code{ -Package: sisu -Architecture: all -Depends: ruby (>= 1.8.2), libwebrick-ruby, unzip, zip -Conflicts: vim-sisu, sisu-vim, sisu-remote -Replaces: vim-sisu, sisu-vim -Recommends: sisu-pdf, sisu-sqlite, sisu-postgresql, librmagick-ruby, trang, -tidy, librexml-ruby, openssl, rsync, openssh-client | lsh-client, keychain, -hyperestraier, kdissert, vim-addon-manager -Suggests: rcs | cvs, lv, texinfo, pinfo - -Package: sisu-complete -Depends: ruby (>= 1.8.4), sisu, sisu-pdf, sisu-postgresql, sisu-sqlite -Recommends: hyperestraier - -Package: sisu-pdf -Architecture: all -Depends: sisu, texlive-latex-base, texlive-fonts-recommended, -texlive-latex-recommended, texlive-latex-extra -Suggests: evince, xpdf - -Package: sisu-postgresql -Depends: sisu, postgresql-8.1, libdbi-ruby, libdbm-ruby, libdbd-pg-ruby -Suggests: pgaccess, libdbd-pgsql, postgresql-contrib-8.1 - -Package: sisu-sqlite -Depends: sisu, sqlite, libdbi-ruby, libdbm-ruby, libdbd-sqlite-ruby -Suggests: libdbd-sqlite - -Package: sisu-markup-samples -Depends: sisu +Source: sisu +Section: text +Priority: optional +Maintainer: SiSU Project <sisu@lists.sisudoc.org> +Uploaders: Ralph Amissah <ralph@amissah.com> +Build-Depends: debhelper (>= 8) +Standards-Version: 3.9.1 +Homepage: http://www.sisudoc.org/ +Vcs-Browser: http://git.sisudoc.org/?p=code/sisu.git +Vcs-Git: git://git.sisudoc.org/git/code/sisu.git +XS-Dm-Upload-Allowed: yes }code code{ -Source: sisu -Section: text -Priority: optional -Maintainer: Ralph Amissah <ralph@amissah.com> -Build-Depends: debhelper (>= 5) -Standards-Version: 3.7.2 - Package: sisu Architecture: all -Depends: ruby (>= 1.8.2), ruby (<< 1.9), libwebrick-ruby, unzip, zip -Conflicts: vim-sisu, sisu-vim, sisu-remote -Replaces: vim-sisu, sisu-vim -Recommends: sisu-doc, sisu-pdf, sisu-sqlite, sisu-postgresql, hyperestraier, keychain, librmagick-ruby, librexml-ruby, openssl, openssh-client | lsh-client, rsync, tidy, vim-addon-manager -Suggests: kdissert, lv, rcs | cvs, pinfo, texinfo, trang +Depends: ${misc:Depends}, ruby (>= 1.8.2), libwebrick-ruby, rsync, unzip, zip +Recommends: + sisu-pdf, sisu-sqlite, sisu-postgresql, imagemagick, keychain, librmagick-ruby, + librexml-ruby, openssl, openssh-client | lsh-client, tidy, vim-addon-manager +Suggests: lv, calibre, pinfo, texinfo, trang +Conflicts: sisu-markup-samples (<= 1.0.11) +Replaces: sisu-markup-samples (<= 1.0.11) Description: documents - structuring, publishing in multiple formats and search SiSU is a lightweight markup based, command line oriented, document structuring, publishing and search framework for document collections. . 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, EPUB, 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. + 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, EPUB, 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. . SiSU also provides concordance files, document content certificates and manifests of generated output. @@ -901,8 +908,6 @@ of content. Document outputs also share semantic meta-data provided. 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. - . - Homepage: <http://www.jus.uio.no/sisu> }code @@ -910,35 +915,35 @@ code{ Package: sisu-complete Architecture: all -Depends: ruby (>= 1.8.2), ruby (<< 1.9), sisu, sisu-doc, sisu-pdf, sisu-postgresql, sisu-sqlite -Recommends: hyperestraier +Depends: + ${misc:Depends}, ruby (>= 1.8.2), sisu (= ${source:Version}), + sisu-pdf (= ${source:Version}), sisu-postgresql (= ${source:Version}), + sisu-sqlite (= ${source:Version}) Description: installs all SiSU related packages - This package installs SiSU and related packages that enable sisu to produce - pdf and to populate postgresql and sqlite databases. - . SiSU is a lightweight markup based document structuring, publishing and search framework for document collections. . - See sisu for a description of the package. + This package installs SiSU and related packages that enable sisu to produce + pdf and to populate PostgreSQL and sqlite databases. . - Homepage: <http://www.jus.uio.no/sisu> + See sisu for a description of the package. }code code{ -Package: sisu-doc +Package: sisu-pdf Architecture: all -Depends: sisu -Recommends: sisu-pdf, sisu-postgresql, sisu-sqlite -Description: sisu manual and other documentation for sisu - Multiple file formats generated output of sisu documentation generated from - sisu markup source documents included in the main package - . +Depends: + ${misc:Depends}, sisu, texlive-latex-base, texlive-fonts-recommended, + texlive-latex-recommended, texlive-latex-extra, texlive-xetex, lmodern, + ttf-liberation +Suggests: evince | pdf-viewer +Description: dependencies to convert SiSU LaTeX output to pdf SiSU is a lightweight markup based document structuring, publishing and search framework for document collections. . - Homepage: <http://www.jus.uio.no/sisu> + This package enables the conversion of SiSU LaTeX output to pdf. }code @@ -946,15 +951,16 @@ code{ Package: sisu-pdf Architecture: all -Depends: sisu, texlive-latex-base, texlive-fonts-recommended, texlive-latex-recommended, texlive-latex-extra -Recommends: sisu-doc +Depends: + ${misc:Depends}, sisu, texlive-latex-base, texlive-fonts-recommended, + texlive-latex-recommended, texlive-latex-extra, texlive-xetex, lmodern, + ttf-liberation +Suggests: evince | pdf-viewer Description: dependencies to convert SiSU LaTeX output to pdf - This package enables the conversion of SiSU LaTeX output to pdf. - . SiSU is a lightweight markup based document structuring, publishing and search framework for document collections. . - Homepage: <http://www.jus.uio.no/sisu> + This package enables the conversion of SiSU LaTeX output to pdf. }code @@ -962,11 +968,15 @@ code{ Package: sisu-postgresql Architecture: all -Depends: sisu, libdbd-pg-ruby, libdbi-ruby, libdbm-ruby, postgresql -Recommends: sisu-doc, libfcgi-ruby +Depends: + ${misc:Depends}, sisu, libdbd-pg-ruby, libdbd-pg-ruby1.8, libdbi-ruby, + libdbi-ruby1.8, libdbm-ruby, postgresql, libfcgi-ruby1.8 | libfcgi-ruby1.9.1 Suggests: postgresql-contrib -Description: SiSU dependencies for use with postgresql database - This package enables SiSU to populate a postgresql database. This is done at +Description: SiSU dependencies for use with PostgreSQL database + SiSU is a lightweight markup based document structuring, publishing and search + framework for document collections. + . + This package enables SiSU to populate a PostgreSQL database. This is done at an object/paragraph level, making granular searches of documents possible. . This relational database feature of SiSU is not required but provides @@ -974,11 +984,6 @@ Description: SiSU dependencies for use with postgresql database for matching units of text, primarily paragraphs that can be displayed or identified by object citation number, from which an index of documents matched and each matched paragraph within them can be displayed. - . - SiSU is a lightweight markup based document structuring, publishing and search - framework for document collections. - . - Homepage: <http://www.jus.uio.no/sisu> }code @@ -986,10 +991,15 @@ code{ Package: sisu-sqlite Architecture: all -Depends: sisu, sqlite, libdbd-sqlite-ruby, libdbi-ruby, libdbm-ruby -Recommends: sisu-doc, libfcgi-ruby -Description: SiSU dependencies for use with sqlite database - This package enables SiSU to populate an sqlite database. This is done at an +Depends: + ${misc:Depends}, sisu, sqlite3, libsqlite3-ruby, libdbd-sqlite3-ruby, + libdbd-sqlite3-ruby1.8, libdbi-ruby, libdbi-ruby1.8, libdbm-ruby, + libfcgi-ruby1.8 | libfcgi-ruby1.9.1 +Description: SiSU dependencies for use with SQLite database + SiSU is a lightweight markup based document structuring, publishing and search + framework for document collections. + . + This package enables SiSU to populate an SQLite database. This is done at an object/paragraph level, making granular searches of documents possible. . This relational database feature of SiSU is not required but provides @@ -997,11 +1007,6 @@ Description: SiSU dependencies for use with sqlite database for matching units of text, primarily paragraphs that can be displayed or identified by object citation number, from which an index of documents matched and each matched paragraph within them can be displayed. - . - SiSU is a lightweight markup based document structuring, publishing and search - framework for document collections. - . - Homepage: <http://www.jus.uio.no/sisu> }code @@ -1027,7 +1032,7 @@ look at output results, see the "sisu_manifest" page created for the document or to generate an online document move to a writable directory, as the file will be downloaded there and e.g. -sisu -3 http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst +sisu -3 http://www.jus.uio.no/sisu/src/free_culture.lawrence_lessig.sst 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 @@ -1168,11 +1173,11 @@ _1 ./data/doc/sisu/sisu_markup_samples/dfsg These are installed on the system usually at: -_1 /usr/share/doc/sisu/v2/sisu_markup_samples/samples +_1 /usr/share/doc/sisu/markup-samples/samples -More markup samples are available in the package sisu-markup-samples +More markup samples are available in the package sisu-markup-samples, which if installed should be available at: -_1 http://www.jus.uio.no/sisu/SiSU/download.html#sisu-markup-samples +_1 /usr/share/doc/sisu/markup-samples-non-free/samples Many more are available online off: @@ -1182,11 +1187,11 @@ _1 http://www.jus.uio.no/sisu/SiSU/examples.html There is syntax support for some editors provided (together with a README file) in -_1 ./data/sisu/conf/syntax +_1 ./data/sisu/v2/conf/editor-syntax-etc usually installed to: -_1 /usr/share/sisu/v2/conf/syntax +_1 /usr/share/sisu/v2/conf/editor-syntax-etc 2~ License @@ -1260,9 +1265,9 @@ _1 sisu -V 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. -_1 sisu -1 http://www.jus.uio.no/sisu/gpl3.fsf/gpl3.fsf.sst +_1 sisu -1 http://www.jus.uio.no/sisu/src/gpl.fsf.sst -_1 sisu -3 http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst +_1 sisu -3 http://www.jus.uio.no/sisu/src/free_culture.lawrence_lessig.sst examine source document, vim has syntax highlighting support @@ -1274,11 +1279,11 @@ _1 http://www.jus.uio.no/sisu/SiSU/examples.html it should also be possible to run sisu against sisupods (prepared zip files, created by running the command sisu -S [filename]), whether stored locally or remotely. -_1 sisu -3 http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip +_1 sisu -3 http://www.jus.uio.no/sisu/pod/free_culture.lawrence_lessig.sst.zip there is a security issue associated with the running of document skins that are not your own, so these are turned of by default, and the use of the following command, which switches on the associated skin is not recommended: -_1 sisu -3 --trust http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip +_1 sisu -3 --trust http://www.jus.uio.no/sisu/pod/free_culture.lawrence_lessig.sst.zip For help @@ -1302,12 +1307,16 @@ _1 mkdir ~/sisu_test _1 cd ~/sisu_test -_1 cp -a /usr/share/doc/sisu/v2/sisu_markup_samples/samples/* ~/sisu_test/. +_1 cp -a /usr/share/doc/sisu/markup-samples/samples/* ~/sisu_test/. -!_ Tip: -the markup syntax examples may be of interest +better if you have installed sisu-markup-samples -_1 http://www.jus.uio.no/sisu/sample/ +_1 cp -a /usr/share/doc/sisu/markup-samples-non-free/samples/* ~/sisu_test/. + +% !_ Tip: +% the markup syntax examples may be of interest +% +% _1 http://www.jus.uio.no/sisu/sample/ !_ Tip: @@ -1360,7 +1369,9 @@ Dependencies for various features are taken care of in sisu related packages. Th 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. -Homepage: http://www.jus.uio.no/sisu +Homepage: http://www.sisudoc.org + +old homepage: http://www.jus.uio.no/sisu 3~ Document Resource Configuration |