diff options
| author | Ralph Amissah <ralph@amissah.com> | 2011-05-29 20:33:38 -0400 |
|---|---|---|
| committer | Ralph Amissah <ralph@amissah.com> | 2011-05-29 20:33:38 -0400 |
| commit | 0e921adab8fbbd638f001a2876bccfb6820499a5 (patch) | |
| tree | aa4268dc5668e87def5c46b64fa0ac19cd228c18 | |
| parent | v3: options --find & --glob (-f -G) added, parses language sub-dirs (diff) | |
v3: documentation, minor update, includes --find / --globsisu_3.0.11
| -rw-r--r-- | data/doc/sisu/CHANGELOG_v3 | 2 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu-concordance.1.html | 12 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu-epub.1.html | 12 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu-git.1.html | 12 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu-harvest.1.html | 12 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu-html.1.html | 12 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu-odf.1.html | 12 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu-pdf.1.html | 26 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu-pg.1.html | 12 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu-po.1.html | 16 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu-sqlite.1.html | 12 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu-txt.1.html | 12 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu.1.html | 241 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu_termsheet.1.html | 12 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu_webrick.1.html | 12 | ||||
| -rw-r--r-- | data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst | 16 | ||||
| -rw-r--r-- | data/doc/sisu/markup-samples/sisu_manual/sisu_synopsis.ssi | 10 | ||||
| -rw-r--r-- | data/sisu/v3/v/version.yml | 4 | ||||
| -rw-r--r-- | man/man1/sisu.1 | 128 |
19 files changed, 321 insertions, 254 deletions
diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index 990ea871..1385aeb5 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -37,6 +37,8 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.11.orig.tar.gz * i18n, constants, some language information moved to i18n (from constants) + * documentation, minor update, includes --find / --glob + %% 3.0.10.orig.tar.gz (2011-05-23:21/1) http://git.sisudoc.org/?p=code/sisu.git;a=log;h=refs/tags/debian/3.0.10-1 http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.10.orig.tar.gz diff --git a/data/doc/sisu/html/sisu-concordance.1.html b/data/doc/sisu/html/sisu-concordance.1.html index f1ca71bb..adf6d102 100644 --- a/data/doc/sisu/html/sisu-concordance.1.html +++ b/data/doc/sisu/html/sisu-concordance.1.html @@ -50,12 +50,14 @@ for <b>sisu --concordance</b> (or <b>sisu -w</b>) which produces an HTML concord . <p> <h2><a name='sect4' href='#toc4'>Homepage</a></h2> -More information about <b>SiSU</b> can be found at <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> ->. - -<p> +More information about <b>SiSU</b> can be found at <<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a> +> +or <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> +>. +<p> <h2><a name='sect5' href='#toc5'>Author</a></h2> -<b>SiSU</b> was written by Ralph Amissah <<i>ralph@amissah.com</i>>. <p> +<b>SiSU</b> is written by Ralph Amissah <<i>ralph@amissah.com</i>>. +<p> <hr><p> <a name='toc'><b>Table of Contents</b></a><p> diff --git a/data/doc/sisu/html/sisu-epub.1.html b/data/doc/sisu/html/sisu-epub.1.html index 747756ac..f7ebeb73 100644 --- a/data/doc/sisu/html/sisu-epub.1.html +++ b/data/doc/sisu/html/sisu-epub.1.html @@ -50,12 +50,14 @@ The <b>sisu-epub</b> command is an alias for . <p> <h2><a name='sect4' href='#toc4'>Homepage</a></h2> -More information about <b>SiSU</b> can be found at <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> ->. - -<p> +More information about <b>SiSU</b> can be found at <<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a> +> +or <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> +>. +<p> <h2><a name='sect5' href='#toc5'>Author</a></h2> -<b>SiSU</b> was written by Ralph Amissah <<i>ralph@amissah.com</i>>. <p> +<b>SiSU</b> is written by Ralph Amissah <<i>ralph@amissah.com</i>>. +<p> <hr><p> <a name='toc'><b>Table of Contents</b></a><p> diff --git a/data/doc/sisu/html/sisu-git.1.html b/data/doc/sisu/html/sisu-git.1.html index 6c70396f..ef879ed5 100644 --- a/data/doc/sisu/html/sisu-git.1.html +++ b/data/doc/sisu/html/sisu-git.1.html @@ -48,12 +48,14 @@ document and associated parts (images, ). . <p> <h2><a name='sect4' href='#toc4'>Homepage</a></h2> -More information about <b>SiSU</b> can be found at <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> ->. - -<p> +More information about <b>SiSU</b> can be found at <<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a> +> +or <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> +>. +<p> <h2><a name='sect5' href='#toc5'>Author</a></h2> -<b>SiSU</b> was written by Ralph Amissah <<i>ralph@amissah.com</i>>. <p> +<b>SiSU</b> is written by Ralph Amissah <<i>ralph@amissah.com</i>>. +<p> <hr><p> <a name='toc'><b>Table of Contents</b></a><p> diff --git a/data/doc/sisu/html/sisu-harvest.1.html b/data/doc/sisu/html/sisu-harvest.1.html index 410c805f..37f28b46 100644 --- a/data/doc/sisu/html/sisu-harvest.1.html +++ b/data/doc/sisu/html/sisu-harvest.1.html @@ -52,12 +52,14 @@ Also</a></h2> . <p> <h2><a name='sect4' href='#toc4'>Homepage</a></h2> -More information about <b>SiSU</b> can be found at <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> ->. - -<p> +More information about <b>SiSU</b> can be found at <<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a> +> +or <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> +>. +<p> <h2><a name='sect5' href='#toc5'>Author</a></h2> -<b>SiSU</b> was written by Ralph Amissah <<i>ralph@amissah.com</i>>. <p> +<b>SiSU</b> is written by Ralph Amissah <<i>ralph@amissah.com</i>>. +<p> <hr><p> <a name='toc'><b>Table of Contents</b></a><p> diff --git a/data/doc/sisu/html/sisu-html.1.html b/data/doc/sisu/html/sisu-html.1.html index 2672f615..0af45521 100644 --- a/data/doc/sisu/html/sisu-html.1.html +++ b/data/doc/sisu/html/sisu-html.1.html @@ -50,12 +50,14 @@ The <b>sisu-html</b> command is an alias for . <p> <h2><a name='sect4' href='#toc4'>Homepage</a></h2> -More information about <b>SiSU</b> can be found at <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> ->. - -<p> +More information about <b>SiSU</b> can be found at <<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a> +> +or <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> +>. +<p> <h2><a name='sect5' href='#toc5'>Author</a></h2> -<b>SiSU</b> was written by Ralph Amissah <<i>ralph@amissah.com</i>>. <p> +<b>SiSU</b> is written by Ralph Amissah <<i>ralph@amissah.com</i>>. +<p> <hr><p> <a name='toc'><b>Table of Contents</b></a><p> diff --git a/data/doc/sisu/html/sisu-odf.1.html b/data/doc/sisu/html/sisu-odf.1.html index ef3110f8..504ed3d2 100644 --- a/data/doc/sisu/html/sisu-odf.1.html +++ b/data/doc/sisu/html/sisu-odf.1.html @@ -50,12 +50,14 @@ file. . <p> <h2><a name='sect4' href='#toc4'>Homepage</a></h2> -More information about <b>SiSU</b> can be found at <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> ->. - -<p> +More information about <b>SiSU</b> can be found at <<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a> +> +or <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> +>. +<p> <h2><a name='sect5' href='#toc5'>Author</a></h2> -<b>SiSU</b> was written by Ralph Amissah <<i>ralph@amissah.com</i>>. <p> +<b>SiSU</b> is written by Ralph Amissah <<i>ralph@amissah.com</i>>. +<p> <hr><p> <a name='toc'><b>Table of Contents</b></a><p> diff --git a/data/doc/sisu/html/sisu-pdf.1.html b/data/doc/sisu/html/sisu-pdf.1.html index bb34a771..d46f7e4f 100644 --- a/data/doc/sisu/html/sisu-pdf.1.html +++ b/data/doc/sisu/html/sisu-pdf.1.html @@ -8,22 +8,22 @@ <body bgcolor='white'> <a href='#toc'>Table of Contents</a><p> -<p> +<p> <h2><a name='sect0' href='#toc0'>Name</a></h2> <b>SiSU</b> - Structured information, Serialized Units - a document publishing -<p>system -<p> +<p>system +<p> <h2><a name='sect1' href='#toc1'>Synopsis</a></h2> -<b>sisu-pdf</b> <i>sisu_document.sst</i> | <i>sisu_document.ssm</i> -<p> +<b>sisu-pdf</b> <i>sisu_document.sst</i> | <i>sisu_document.ssm</i> +<p> <h2><a name='sect2' href='#toc2'>Description</a></h2> <b>SiSU</b> is a lightweight markup based document structuring, publishing and search framework for document collections. <p> The <b>sisu-pdf</b> command is an alias for -<b>sisu --pdf</b> (or <b>sisu -p</b>) which produces PDF output of a SiSU markup file. -<p> +<b>sisu --pdf</b> (or <b>sisu -p</b>) which produces PDF output of a SiSU markup file. +<p> <h2><a name='sect3' href='#toc3'>See Also</a></h2> <a href='http:~/bin/man2html?sisu:1'><i>sisu</i>(1)</a> @@ -50,12 +50,14 @@ Also</a></h2> . <p> <h2><a name='sect4' href='#toc4'>Homepage</a></h2> -More information about <b>SiSU</b> can be found at <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> ->. - -<p> +More information about <b>SiSU</b> can be found at <<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a> +> +or <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> +>. +<p> <h2><a name='sect5' href='#toc5'>Author</a></h2> -<b>SiSU</b> was written by Ralph Amissah <<i>ralph@amissah.com</i>>. <p> +<b>SiSU</b> is written by Ralph Amissah <<i>ralph@amissah.com</i>>. +<p> <hr><p> <a name='toc'><b>Table of Contents</b></a><p> diff --git a/data/doc/sisu/html/sisu-pg.1.html b/data/doc/sisu/html/sisu-pg.1.html index fec48e39..01e6a6ea 100644 --- a/data/doc/sisu/html/sisu-pg.1.html +++ b/data/doc/sisu/html/sisu-pg.1.html @@ -50,12 +50,14 @@ The <b>sisu-pq</b> command is an alias for <b>sisu . <p> <h2><a name='sect4' href='#toc4'>Homepage</a></h2> -More information about <b>SiSU</b> can be found at <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> ->. - -<p> +More information about <b>SiSU</b> can be found at <<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a> +> +or <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> +>. +<p> <h2><a name='sect5' href='#toc5'>Author</a></h2> -<b>SiSU</b> was written by Ralph Amissah <<i>ralph@amissah.com</i>>. <p> +<b>SiSU</b> is written by Ralph Amissah <<i>ralph@amissah.com</i>>. +<p> <hr><p> <a name='toc'><b>Table of Contents</b></a><p> diff --git a/data/doc/sisu/html/sisu-po.1.html b/data/doc/sisu/html/sisu-po.1.html index 681cda4c..acefe6a6 100644 --- a/data/doc/sisu/html/sisu-po.1.html +++ b/data/doc/sisu/html/sisu-po.1.html @@ -3,7 +3,7 @@ <html> <head> -<title>SISU\-ODF(1) manual page</title> +<title>SISU\-PO(1) manual page</title> </head> <body bgcolor='white'> <a href='#toc'>Table of Contents</a><p> @@ -15,7 +15,7 @@ <p>system <p> <h2><a name='sect1' href='#toc1'>Synopsis</a></h2> -<b>sisu-odf</b> <i>sisu_document.sst</i> | <i>sisu_document.ssm</i> +<b>sisu-po</b> <i>sisu_document.sst</i> | <i>sisu_document.ssm</i> <p> <h2><a name='sect2' href='#toc2'>Description</a></h2> <b>SiSU</b> @@ -51,12 +51,14 @@ Experimental, and under development. . <p> <h2><a name='sect4' href='#toc4'>Homepage</a></h2> -More information about <b>SiSU</b> can be found at <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> ->. - -<p> +More information about <b>SiSU</b> can be found at <<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a> +> +or <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> +>. +<p> <h2><a name='sect5' href='#toc5'>Author</a></h2> -<b>SiSU</b> was written by Ralph Amissah <<i>ralph@amissah.com</i>>. +<b>SiSU</b> is written by Ralph Amissah <<i>ralph@amissah.com</i>>. + <p> <p> <hr><p> diff --git a/data/doc/sisu/html/sisu-sqlite.1.html b/data/doc/sisu/html/sisu-sqlite.1.html index 7a09c353..d9ef7376 100644 --- a/data/doc/sisu/html/sisu-sqlite.1.html +++ b/data/doc/sisu/html/sisu-sqlite.1.html @@ -50,12 +50,14 @@ The <b>sisu-sqlite</b> command is an alias for . <p> <h2><a name='sect4' href='#toc4'>Homepage</a></h2> -More information about <b>SiSU</b> can be found at <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> ->. - -<p> +More information about <b>SiSU</b> can be found at <<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a> +> +or <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> +>. +<p> <h2><a name='sect5' href='#toc5'>Author</a></h2> -<b>SiSU</b> was written by Ralph Amissah <<i>ralph@amissah.com</i>>. <p> +<b>SiSU</b> is written by Ralph Amissah <<i>ralph@amissah.com</i>>. +<p> <hr><p> <a name='toc'><b>Table of Contents</b></a><p> diff --git a/data/doc/sisu/html/sisu-txt.1.html b/data/doc/sisu/html/sisu-txt.1.html index 3edb168f..122fa2d9 100644 --- a/data/doc/sisu/html/sisu-txt.1.html +++ b/data/doc/sisu/html/sisu-txt.1.html @@ -50,12 +50,14 @@ file. . <p> <h2><a name='sect4' href='#toc4'>Homepage</a></h2> -More information about <b>SiSU</b> can be found at <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> ->. - -<p> +More information about <b>SiSU</b> can be found at <<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a> +> +or <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> +>. +<p> <h2><a name='sect5' href='#toc5'>Author</a></h2> -<b>SiSU</b> was written by Ralph Amissah <<i>ralph@amissah.com</i>>. <p> +<b>SiSU</b> is written by Ralph Amissah <<i>ralph@amissah.com</i>>. +<p> <hr><p> <a name='toc'><b>Table of Contents</b></a><p> diff --git a/data/doc/sisu/html/sisu.1.html b/data/doc/sisu/html/sisu.1.html index b982a989..06fa3f15 100644 --- a/data/doc/sisu/html/sisu.1.html +++ b/data/doc/sisu/html/sisu.1.html @@ -163,10 +163,10 @@ in <b>SiSU</b> <h2><a name='sect6' href='#toc6'>2.1 Description</a></h2> <p> <br> -<b>SiSU</b> <b>SiSU</b> is a document publishing system, that from a simple single marked-up -document, produces multiple of output formats including: plaintext, html, +<b>SiSU</b> is a document publishing system, that from a simple single marked-up +document, produces multiple output formats including: plaintext, html, xhtml, XML, epub, odt (odf text), LaTeX, pdf, info, and SQL (PostgreSQL -and SQLite), which share numbered text objects ("object citation numbering") +and SQLite), which share text object numbers ("object citation numbering") and the same document structure information. For more see: <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> > @@ -180,40 +180,38 @@ and the same document structure information. For more see: <<a href='http://w <dd>produces plaintext with Unix linefeeds and without markup, (object numbers are omitted), has footnotes at end of each paragraph that contains them [ -A for equivalent - dos (linefeed) output file] [see -e for -A endnotes]. (Options include: --endnotes -for endnotes --footnotes for footnotes at the end of each paragraph --unix -for unix linefeed (default) --msdos for msdos linefeed) + dos (linefeed) output file] [see -e for (Options include: --endnotes for endnotes +--footnotes for footnotes at the end of each paragraph --unix for unix linefeed +(default) --msdos for msdos linefeed) <p> </dd> -<dt><b>-b [filename/wildcard]</b> -</dt> -<dd> -<p>see --xhtml +<dt><b>-b [filename/wildcard]</b> </dt> +<dd>see --xhtml <p> </dd> -<dt><b>--color-toggle [filename/wildcard]</b> </dt> -<dd>screen toggle ansi screen colour -on or off depending on default set (unless -c flag is used: if sisurc colour -default is set to ’true’, output to screen will be with colour, if sisurc -colour default is set to ’false’ or is undefined screen output will be without -colour). Alias -c +<dt><b>--color-toggle +[filename/wildcard]</b> </dt> +<dd>screen toggle ansi screen colour on or off depending +on default set (unless -c flag is used: if sisurc colour default is set +to ’true’, output to screen will be with colour, if sisurc colour default is +set to ’false’ or is undefined screen output will be without colour). Alias -c <p> </dd> <dt><b>--concordance [filename/wildcard]</b> </dt> -<dd>produces concordance (wordmap) -a rudimentary index of all the words in a document. (Concordance files are -not generated for documents of over 260,000 words unless this limit is -increased in the file sisurc.yml). Alias -w +<dd>produces concordance (wordmap) a rudimentary +index of all the words in a document. (Concordance files are not generated +for documents of over 260,000 words unless this limit is increased in the +file sisurc.yml). Alias -w <p> </dd> <dt><b>-C [--init-site]</b> </dt> -<dd>configure/initialise -shared output directory files initialize shared output directory (config -files such as css and dtd files are not updated if they already exist unless -modifier is used). -C --init-site configure/initialise site more extensive than --C on its own, shared output directory files/force update, existing shared -output config files such as css and dtd files are updated if this modifier -is used. +<dd>configure/initialise shared output +directory files initialize shared output directory (config files such as +css and dtd files are not updated if they already exist unless modifier +is used). -C --init-site configure/initialise site more extensive than -C on +its own, shared output directory files/force update, existing shared output +config files such as css and dtd files are updated if this modifier is +used. <p> </dd> <dt><b>-CC</b> </dt> @@ -255,7 +253,7 @@ for most processing flags. To skip it see -n. Alias -m <dt><b>--epub [filename/wildcard]</b> </dt> <dd>produces -an epub document, [sisu version 2 only] (filename.epub). Alias -e +an epub document, [sisu version >=2 ] (filename.epub). Alias -e <p> </dd> <dt><b>-e [filename/wildcard]</b> @@ -264,35 +262,57 @@ an epub document, [sisu version 2 only] (filename.epub). Alias <p>see --epub <p> </dd> +<dt><b>--find [optional string part of filename]</b> </dt> +<dd>without match string, +glob all .sst .ssm files in directory (including language subdirectories). +With match string, find files that match given string in directory (including +language subdirectories). Alias -f, --glob, -G +<p> </dd> + <dt><b>-F [--webserv=webrick]</b> </dt> <dd>see --sample-search-form <p> </dd> +<dt><b>-f [optional string part of filename]</b> </dt> +<dd>see --find +<p> </dd> + <dt><b>--git [filename/wildcard]</b> </dt> <dd>produces or updates markup source file structure in a git repo (experimental and subject to change). Alias -g <p> </dd> -<dt><b>-g [filename/wildcard]</b> </dt> -<dd>see --git +<dt><b>--glob [optional string part of filename]</b> +</dt> +<dd> +<p>see --find <p> </dd> -<dt><b>--harvest -*.ss[tm]</b> </dt> -<dd>makes two lists of sisu output based on the sisu markup documents -in a directory: list of author and authors works (year and titles), and; -list by topic with titles and author. Makes use of header metadata fields -(author, title, date, topic_register). Can be used with maintenance (-M) -and remote placement (-R) flags. +<dt><b>-G [optional string part of filename]</b> </dt> +<dd>see --find +<p> </dd> + +<dt><b>-g [filename/wildcard]</b> +</dt> +<dd> +<p>see --git +<p> </dd> + +<dt><b>--harvest *.ss[tm]</b> </dt> +<dd>makes two lists of sisu output based on the sisu +markup documents in a directory: list of author and authors works (year +and titles), and; list by topic with titles and author. Makes use of header +metadata fields (author, title, date, topic_register). Can be used with +maintenance (-M) and remote placement (-R) flags. <p> </dd> <dt><b>--help [topic]</b> </dt> -<dd>provides help on the selected -topic, where topics (keywords) include: list, (com)mands, short(cuts), -(mod)ifiers, (env)ironment, markup, syntax, headers, headings, endnotes, -tables, example, customise, skin, (dir)ectories, path, (lang)uage, db, -install, setup, (conf)igure, convert, termsheet, search, sql, features, +<dd>provides help +on the selected topic, where topics (keywords) include: list, (com)mands, +short(cuts), (mod)ifiers, (env)ironment, markup, syntax, headers, headings, +endnotes, tables, example, customise, skin, (dir)ectories, path, (lang)uage, +db, install, setup, (conf)igure, convert, termsheet, search, sql, features, <p>license <p> </dd> @@ -485,8 +505,7 @@ below. Alias -d files including sisu markup source files and the directories local configuration file, images and skins. Note: this only includes the configuration files or skins contained in ./_sisu not those in ~/.sisu -S [filename/wildcard] -option. Note: (this option<br> - is tested only with zsh). Alias -S +option. Note: (this option is tested only with zsh). Alias -S <p> </dd> <dt><b>--sisupod [filename/wildcard]</b> </dt> @@ -537,38 +556,34 @@ file to output directory. Alias -s </dt> <dd>produces plaintext with Unix linefeeds and without markup, (object numbers are omitted), has footnotes at end of each paragraph that contains them -[ -A for equivalent dos (linefeed) output file] [see -e for -A endnotes]. (Options -include: --endnotes for endnotes --footnotes for footnotes at the end of each -paragraph --unix for unix linefeed (default) --msdos for msdos linefeed). Alias - -<p>- -<p>t +[ -A for equivalent dos (linefeed) output file] [see -e for (Options include: +--endnotes for endnotes --footnotes for footnotes at the end of each paragraph +--unix for unix linefeed (default) --msdos for msdos linefeed). Alias -t <p> </dd> -<dt><b>-T [filename/wildcard (*.termsheet.rb)]</b> </dt> -<dd>standard form document builder, - -<p>preprocessing feature -<p> </dd> +<dt><b>-T [filename/wildcard + (*.termsheet.rb)]</b> </dt> +<dd>standard form document builder, preprocessing feature +<p> +</dd> <dt><b>-t [filename/wildcard]</b> </dt> <dd>see --txt <p> </dd> -<dt><b>--urls [filename/wildcard]</b> -</dt> -<dd>prints url output list/map for the available processing flags options and -resulting files that could be requested, (can be used to get a list of -processing options in relation to a file, together with information on -the output that would be produced), -u provides url output mapping for those -flags requested for processing. The default assumes sisu_webrick is running -and provides webrick url mappings where appropriate, but these can be switched -to file system paths in sisurc.yml. Alias -U +<dt><b>--urls [filename/wildcard]</b> </dt> +<dd>prints url output +list/map for the available processing flags options and resulting files +that could be requested, (can be used to get a list of processing options +in relation to a file, together with information on the output that would +be produced), -u provides url output mapping for those flags requested for +processing. The default assumes sisu_webrick is running and provides webrick +url mappings where appropriate, but these can be switched to file system +paths in sisurc.yml. Alias -U <p> </dd> <dt><b>-U [filename/wildcard]</b> </dt> <dd>see --urls - <p> </dd> <dt><b>-u [filename/wildcard]</b> </dt> @@ -577,9 +592,8 @@ requested for processing, also see -U <p> </dd> <dt><b>--v2 [filename/wildcard]</b> </dt> -<dd>invokes the -sisu v2 document parser/generator. This is the default and is normally omitted. - +<dd>invokes the sisu v2 document parser/generator. +This is the default and is normally omitted. <p> </dd> <dt><b>--v3 [filename/wildcard]</b> </dt> @@ -589,20 +603,17 @@ sisu3 instead. <p> </dd> <dt><b>--verbose [filename/wildcard]</b> </dt> -<dd>provides verbose output of what -is being generated, where output is placed (and error messages if any), -as with -u flag provides a url mapping of files created for each of the -processing flag requests. Alias -v +<dd>provides verbose output of what is being generated, where output is placed +(and error messages if any), as with -u flag provides a url mapping of files +created for each of the processing flag requests. Alias -v <p> </dd> <dt><b>-V</b> </dt> -<dd>on its own, provides <b>SiSU</b> version and -environment information (sisu --help env) +<dd>on its own, provides <b>SiSU</b> version and environment information (sisu --help env) <p> </dd> <dt><b>-V [filename/wildcard]</b> </dt> -<dd>even more -verbose than the -v flag. +<dd>even more verbose than the -v flag. <p> </dd> <dt><b>-v</b> </dt> @@ -615,46 +626,39 @@ verbose than the -v flag. <p> </dd> <dt><b>--webrick</b> </dt> -<dd>starts ruby’s webrick webserver -points at sisu output directories, the default port is set to 8081 and -can be changed in the resource configuration files. [tip: the webrick server - requires link suffixes, so html output should be created using the -h option - rather than -H ; also, note -F webrick ]. Alias -W +<dd>starts ruby’s webrick +webserver points at sisu output directories, the default port is set to +8081 and can be changed in the resource configuration files. [tip: the webrick + server requires link suffixes, so html output should be created using the + -h option rather than and search -H ; also, note -F webrick ]. Alias -W <p> </dd> <dt><b>-W</b> </dt> <dd>see --webrick <p> </dd> -<dt><b>--wordmap -[filename/wildcard]</b> </dt> +<dt><b>--wordmap [filename/wildcard]</b> </dt> <dd>see --concordance <p> </dd> <dt><b>-w [filename/wildcard]</b> </dt> <dd>see --concordance - <p> </dd> <dt><b>--xhtml [filename/wildcard]</b> </dt> -<dd>produces xhtml/XML output for browser viewing -(sax parsing). Alias -b +<dd>produces xhtml/XML output for browser viewing (sax parsing). Alias -b <p> </dd> <dt><b>--xml-dom [filename/wildcard]</b> </dt> -<dd>produces XML output with -deep document structure, in the nature of dom. Alias -X +<dd>produces XML output with deep document structure, in the nature of dom. Alias -X <p> </dd> -<dt><b>--xml-sax [filename/wildcard]</b> -</dt> +<dt><b>--xml-sax [filename/wildcard]</b> </dt> <dd>produces XML output shallow structure (sax parsing). Alias -x <p> </dd> -<dt><b>-X [filename/wildcard]</b> -</dt> -<dd> -<p>see --xml-dom +<dt><b>-X [filename/wildcard]</b> </dt> +<dd>see --xml-dom <p> </dd> <dt><b>-x [filename/wildcard]</b> </dt> @@ -662,26 +666,23 @@ deep document structure, in the nature of dom. Alias -X <p> </dd> <dt><b>-Y [filename/wildcard]</b> </dt> -<dd>produces -a short sitemap entry for the document, based on html output and the sisu_manifest. ---sitemaps generates/updates the sitemap index of existing sitemaps. (Experimental, -[g,y,m announcement this week]) +<dd>produces a short sitemap entry for the document, +based on html output and the sisu_manifest. --sitemaps generates/updates the +sitemap index of existing sitemaps. (Experimental, [g,y,m announcement this + week]) <p> </dd> <dt><b>-y [filename/wildcard]</b> </dt> -<dd>produces an html -summary of output generated (hyperlinked to content) and document specific -metadata (sisu_manifest.html). This step is assumed for most processing flags. - +<dd>produces an html summary of output generated +(hyperlinked to content) and document specific metadata (sisu_manifest.html). +This step is assumed for most processing flags. <p> </dd> <dt><b>--zap [filename/wildcard]</b> </dt> -<dd>Zap, if used with other processing flags deletes -output files of the type about to be processed, prior to processing. If --Z is used as the lone processing related flag (or in conjunction with a -combination of -[mMvVq]), will remove the related document output directory. - -<p>Alias -Z +<dd>Zap, if used with other processing flags deletes output files of the type +about to be processed, prior to processing. If -Z is used as the lone processing +related flag (or in conjunction with a combination of -[mMvVq]), will remove +the related document output directory. Alias -Z <p> </dd> <dt><b>-Z [filename/wildcard]</b> </dt> @@ -735,17 +736,17 @@ with --db=[database type (pgsql or sqlite)] <dd>initial step, creates required relations (tables, indexes) in existing postgresql database (a database should be created manually and given the same name as working -directory, as requested) (rb.dbi) [ -dv --createall it may be necessary to -run sisu -Dv --createdb initially NOTE: at the present time for postgresql -it may be necessary to manually create the database. The command would be -’createdb [database name]’ where database name would be SiSU_[present working - directory name (without path)]. Please use only alphanumerics and underscores. - +directory, as requested) (rb.dbi) [ -dv --createall sqlite equivalent] it may +be necessary to run sisu -Dv --createdb initially NOTE: at the present time +for postgresql it may be necessary to manually create the database. The +command would be ’createdb [database name]’ where database name would be +SiSU_[present working directory name (without path)]. Please use only alphanumerics +and underscores. <p> </dd> <dt><b>--pg -v --import</b> </dt> -<dd>[filename/wildcard] imports data specified to postgresql db -(rb.dbi) [ -dv --import sqlite equivalent] +<dd>[filename/wildcard] imports data specified +to postgresql db (rb.dbi) [ -dv --import sqlite equivalent] <p> </dd> <dt><b>--pg -v --update</b> </dt> @@ -1204,8 +1205,7 @@ level 1 heading (used where a stand-alone document may be imported into another) <p> <br> <b>:A~ [heading text]</b> Top level heading [this usually has similar content - to the title @title: ] NOTE: the heading levels described here are in 0.38 -notation, see heading + to the ] NOTE: the heading levels described here are in 0.38 notation, see heading <p> <br> <b>:B~ [heading text]</b> Second level heading [this is a heading level divider] @@ -1263,7 +1263,7 @@ html +{inserted text}+ - -{strikethrough}- + \-{strikethrough}\- #{monospace}# </pre> @@ -1937,7 +1937,8 @@ use code tags to escape code tags. They are however used in the same way as group or poem tags. <p> <br> A code-block is treated as an object and given a single object number. [an -some later time] +option to number each line of code may be considered at some later time] + <p> <br> <b>use of code tags instead of poem compared, resulting output:</b> <p> <br> diff --git a/data/doc/sisu/html/sisu_termsheet.1.html b/data/doc/sisu/html/sisu_termsheet.1.html index 061e097d..35ab209f 100644 --- a/data/doc/sisu/html/sisu_termsheet.1.html +++ b/data/doc/sisu/html/sisu_termsheet.1.html @@ -49,12 +49,14 @@ or <i><ralph.amissah@gmail.com></i> <p> <h2><a name='sect8' href='#toc8'>Homepage</a></h2> -More information about <b>SiSU</b> can be found at <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> ->. - -<p> +More information about <b>SiSU</b> can be found at <<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a> +> +or <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> +>. +<p> <h2><a name='sect9' href='#toc9'>Author</a></h2> -<b>SiSU</b> was written by Ralph Amissah <<i>ralph@amissah.com</i>>. <p> +<b>SiSU</b> is written by Ralph Amissah <<i>ralph@amissah.com</i>>. +<p> <hr><p> <a name='toc'><b>Table of Contents</b></a><p> diff --git a/data/doc/sisu/html/sisu_webrick.1.html b/data/doc/sisu/html/sisu_webrick.1.html index ddfb69ba..6b99d01e 100644 --- a/data/doc/sisu/html/sisu_webrick.1.html +++ b/data/doc/sisu/html/sisu_webrick.1.html @@ -72,12 +72,14 @@ directories, on the port provided, or if no port is provided and the defaults <p> <h2><a name='sect2' href='#toc2'>Homepage</a></h2> -More information about <b>SiSU</b> can be found at <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> ->. - -<p> +More information about <b>SiSU</b> can be found at <<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a> +> +or <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> +>. +<p> <h2><a name='sect3' href='#toc3'>Author</a></h2> -<b>SiSU</b> was written by Ralph Amissah <<i>ralph@amissah.com</i>>. <p> +<b>SiSU</b> is written by Ralph Amissah <<i>ralph@amissah.com</i>>. +<p> <hr><p> <a name='toc'><b>Table of Contents</b></a><p> diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst index 4994663c..36e1bb9c 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst @@ -49,7 +49,7 @@ 2~ Description -SiSU SiSU is a document publishing system, that from a simple single marked-up document, produces multiple of output formats including: plaintext, html, xhtml, XML, epub, odt (odf text), LaTeX, pdf, info, and SQL (PostgreSQL and SQLite), which share numbered text objects ("object citation numbering") and the same document structure information. For more see: http://www.jus.uio.no/sisu +SiSU is a document publishing system, that from a simple single marked-up document, produces multiple output formats including: plaintext, html, xhtml, XML, epub, odt (odf text), LaTeX, pdf, info, and SQL (PostgreSQL and SQLite), which share text object numbers ("object citation numbering") and the same document structure information. For more see: http://www.jus.uio.no/sisu % 2~ Summary of man page @@ -91,17 +91,29 @@ see --pg see --sqlite !_ --epub [filename/wildcard] <br> -produces an epub document, [sisu version 2 only] (filename.epub). Alias -e +produces an epub document, [sisu version >=2 ] (filename.epub). Alias -e !_ -e [filename/wildcard] <br> see --epub +!_ --find [optional string part of filename] <br> +without match string, glob all .sst .ssm files in directory (including language subdirectories). With match string, find files that match given string in directory (including language subdirectories). Alias -f, --glob, -G + !_ -F [--webserv=webrick] <br> see --sample-search-form +!_ -f [optional string part of filename] <br> +see --find + !_ --git [filename/wildcard] <br> produces or updates markup source file structure in a git repo (experimental and subject to change). Alias -g +!_ --glob [optional string part of filename] <br> +see --find + +!_ -G [optional string part of filename] <br> +see --find + !_ -g [filename/wildcard] <br> see --git diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_synopsis.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_synopsis.ssi index 722a8b29..fda4dc22 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_synopsis.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_synopsis.ssi @@ -32,9 +32,15 @@ sisu [ -CcFLSVvW ] Note: commands should be issued from within the directory that contains the marked up files, cd to markup directory. -sisu is at version 2, to use sisu version 1 +sisu is at version 2, version 3 is under development. To use sisu version 3 -sisu --v1 [and options/operations as above] +sisu --v3 [and options/operations as above] + +or + +sisu3 [and options/operations as above] + +sisu version 1 has been discontinued. for settings see sisu --help env diff --git a/data/sisu/v3/v/version.yml b/data/sisu/v3/v/version.yml index e362274d..1e3c4e22 100644 --- a/data/sisu/v3/v/version.yml +++ b/data/sisu/v3/v/version.yml @@ -1,5 +1,5 @@ --- :version: 3.0.11-beta-rb1.9.2p180 -:date_stamp: 2011w21/3 -:date: "2011-05-25" +:date_stamp: 2011w29/7 +:date: "2011-05-29" :project: SiSU diff --git a/man/man1/sisu.1 b/man/man1/sisu.1 index 9f77082d..c152d5eb 100644 --- a/man/man1/sisu.1 +++ b/man/man1/sisu.1 @@ -82,13 +82,14 @@ markup applied to a document, custom builds (to take advantage of the strengths of different ways of representing documents) various standard open output formats including plain text, HTML, XHTML, XML, EPUB, OpenDocument, LaTeX or PDF files, and populate an -SQL database with objects[^1] (equating generally to paragraph\-sized chunks) so -searches may be performed and matches returned with that degree of granularity -( e.g. your search criteria is met by these documents and at these locations -within each document). Document output formats share a common object numbering -system for locating content. This 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. +SQL database with objects[^1] (equating generally to paragraph\-sized chunks) +so searches may be performed and matches returned with that degree of +granularity ( e.g. your search criteria is met by these documents and at these +locations within each document). Document output formats share a common object +numbering system for locating content. This 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. .br In preparing a @@ -189,13 +190,11 @@ content prepared in .br .B SiSU -.B SiSU is a document publishing system, that from a simple single marked\-up -document, produces multiple of output formats including: plaintext, html, -xhtml, XML, epub, odt (odf text), LaTeX, pdf, info, and SQL (PostgreSQL and -SQLite), which share numbered text objects ("object citation numbering") and -the same document structure information. For more see: -<http://www.jus.uio.no/sisu> +document, produces multiple output formats including: plaintext, html, xhtml, +XML, epub, odt (odf text), LaTeX, pdf, info, and SQL (PostgreSQL and SQLite), +which share text object numbers ("object citation numbering") and the same +document structure information. For more see: <http://www.jus.uio.no/sisu> .SH 2.2 DOCUMENT PROCESSING COMMAND FLAGS @@ -204,9 +203,9 @@ the same document structure information. For more see: produces plaintext with Unix linefeeds and without markup, (object numbers are omitted), has footnotes at end of each paragraph that contains them [ \ \-A \ for \ equivalent \ dos \ (linefeed) \ output \ file] [see \ \-e \ for \ -endnotes]. (Options include: \-\-endnotes for endnotes \-\-footnotes for footnotes -at the end of each paragraph \-\-unix for unix linefeed (default) \-\-msdos for -msdos linefeed) +endnotes]. (Options include: \-\-endnotes for endnotes \-\-footnotes for +footnotes at the end of each paragraph \-\-unix for unix linefeed (default) +\-\-msdos for msdos linefeed) .TP .B \-b [filename/wildcard] @@ -268,7 +267,7 @@ see \-\-sqlite .TP .B \-\-epub [filename/wildcard] -produces an epub document, [sisu \ version \ 2 \ only] (filename.epub). Alias +produces an epub document, [sisu \ version \ >=2 \ ] (filename.epub). Alias \-e .TP @@ -276,15 +275,33 @@ produces an epub document, [sisu \ version \ 2 \ only] (filename.epub). Alias see \-\-epub .TP +.B \-\-find [optional \ string \ part \ of \ filename] +without match string, glob all \.sst \.ssm files in directory (including +language subdirectories). With match string, find files that match given string +in directory (including language subdirectories). Alias \-f, \-\-glob, \-G + +.TP .B \-F [\-\-webserv=webrick] see \-\-sample\-search\-form .TP +.B \-f [optional \ string \ part \ of \ filename] +see \-\-find + +.TP .B \-\-git [filename/wildcard] produces or updates markup source file structure in a git repo (experimental and subject to change). Alias \-g .TP +.B \-\-glob [optional \ string \ part \ of \ filename] +see \-\-find + +.TP +.B \-G [optional \ string \ part \ of \ filename] +see \-\-find + +.TP .B \-g [filename/wildcard] see \-\-git @@ -352,9 +369,9 @@ see \-\-dal (document abstraction level/layer) .TP .B \-\-no\-ocn -[with \ \-\-html \ \-\-pdf \ or \ \-\-epub] switches off object citation numbering. -Produce output without identifying numbers in margins of html or LaTeX/pdf -output. +[with \ \-\-html \ \-\-pdf \ or \ \-\-epub] switches off object citation +numbering. Produce output without identifying numbers in margins of html or +LaTeX/pdf output. .TP .B \-N [filename/wildcard/url] @@ -392,8 +409,9 @@ parameter, e.g. \-\-papersize\-a4 preset sizes include: 'A4', U.S. 'letter' and .TP .B \-\-pg [instruction] [filename] database postgresql ( \-\-pgsql may be used instead) possible instructions, -include: \-\-createdb; \-\-create; \-\-dropall; \-\-import [filename]; \-\-update -[filename]; \-\-remove [filename]; see database section below. Alias \-D +include: \-\-createdb; \-\-create; \-\-dropall; \-\-import [filename]; +\-\-update [filename]; \-\-remove [filename]; see database section below. Alias +\-D .TP .B \-\-po [language_directory/filename \ language_directory] @@ -430,8 +448,8 @@ copies sisu output files to remote host using rsync. This requires that sisurc.yml has been provided with information on hostname and username, and that you have your "keys" and ssh agent in place. Note the behavior of rsync different if \-R is used with other flags from if used alone. Alone the rsync -\-\-delete parameter is sent, useful for cleaning the remote directory (when \-R -is used together with other flags, it is not). Also see \-\-scp. Alias \-R +\-\-delete parameter is sent, useful for cleaning the remote directory (when +\-R is used together with other flags, it is not). Also see \-\-scp. Alias \-R .TP .B \-R [filename/wildcard] @@ -448,8 +466,8 @@ your already having used sisu to populate an sqlite and/or pgsql database, (the sqlite version scans the output directories for existing sisu_sqlite databases, so it is first necessary to create them, before generating the search form) see \-d \-D and the database section below. If the optional parameter -\-\-webserv=webrick is passed, the cgi examples created will be set up to use the -default port set for use by the webrick server, (otherwise the port is left +\-\-webserv=webrick is passed, the cgi examples created will be set up to use +the default port set for use by the webrick server, (otherwise the port is left blank and the system setting used, usually 80). The samples are dumped in the present work directory which must be writable, (with screen instructions given that they be copied to the cgi\-bin directory). \-Fv (in addition to the above) @@ -463,18 +481,19 @@ that you have your "keys" and ssh agent in place. Also see \-\-rsync. Alias \-r .TP .B \-\-sqlite \-\-[instruction] [filename] -database type default set to sqlite, (for which \-\-sqlite may be used instead) -or to specify another database \-\-db\-[pgsql, \ sqlite] (however see \-D) possible -instructions include: \-\-createdb; \-\-create; \-\-dropall; \-\-import [filename]; -\-\-update [filename]; \-\-remove [filename]; see database section below. Alias \-d +database type default set to sqlite, (for which \-\-sqlite may be used +instead) or to specify another database \-\-db\-[pgsql, \ sqlite] (however see +\-D) possible instructions include: \-\-createdb; \-\-create; \-\-dropall; +\-\-import [filename]; \-\-update [filename]; \-\-remove [filename]; see +database section below. Alias \-d .TP .B \-\-sisupod produces a sisupod a zipped sisu directory of markup files including sisu markup source files and the directories local configuration file, images and skins. Note: this only includes the configuration files or skins contained in - \./_sisu not those in ~/.sisu \-S [filename/wildcard] option. Note: (this option -is tested only with zsh). Alias \-S + \./_sisu not those in ~/.sisu \-S [filename/wildcard] option. Note: (this +option is tested only with zsh). Alias \-S .TP .B \-\-sisupod [filename/wildcard] @@ -522,9 +541,9 @@ produces texinfo and info file, (view with pinfo). Alias \-I produces plaintext with Unix linefeeds and without markup, (object numbers are omitted), has footnotes at end of each paragraph that contains them [ \ \-A \ for \ equivalent \ dos \ (linefeed) \ output \ file] [see \ \-e \ for \ -endnotes]. (Options include: \-\-endnotes for endnotes \-\-footnotes for footnotes -at the end of each paragraph \-\-unix for unix linefeed (default) \-\-msdos for -msdos linefeed). Alias \-t +endnotes]. (Options include: \-\-endnotes for endnotes \-\-footnotes for +footnotes at the end of each paragraph \-\-unix for unix linefeed (default) +\-\-msdos for msdos linefeed). Alias \-t .TP .B \-T [filename/wildcard \ (*.termsheet.rb)] @@ -658,9 +677,9 @@ see \-\-zap .TP .B \-\-no\-ocn -[with \ \-\-html \ \-\-pdf \ or \ \-\-epub] switches off object citation numbering. -Produce output without identifying numbers in margins of html or LaTeX/pdf -output. +[with \ \-\-html \ \-\-pdf \ or \ \-\-epub] switches off object citation +numbering. Produce output without identifying numbers in margins of html or +LaTeX/pdf output. .TP .B \-\-no\-annotate @@ -682,19 +701,19 @@ strips output text of editor endnotes[^+1] denoted by dagger/plus sign dbi \- database interface .br -\-D or \-\-pgsql set for postgresql \-d or \-\-sqlite default set for sqlite \-d is -modifiable with \-\-db=[database \ type \ (pgsql \ or \ sqlite)] +\-D or \-\-pgsql set for postgresql \-d or \-\-sqlite default set for sqlite +\-d is modifiable with \-\-db=[database \ type \ (pgsql \ or \ sqlite)] .TP .B \-\-pg \-v \-\-createall initial step, creates required relations (tables, indexes) in existing postgresql database (a database should be created manually and given the same name as working directory, as requested) (rb.dbi) [ \ \-dv \ \-\-createall \ -sqlite \ equivalent] it may be necessary to run sisu \-Dv \-\-createdb initially -NOTE: at the present time for postgresql it may be necessary to manually create -the database. The command would be 'createdb [database \ name]' where database -name would be SiSU_[present \ working \ directory \ name \ (without \ path)]. -Please use only alphanumerics and underscores. +sqlite \ equivalent] it may be necessary to run sisu \-Dv \-\-createdb +initially NOTE: at the present time for postgresql it may be necessary to +manually create the database. The command would be 'createdb [database \ name]' +where database name would be SiSU_[present \ working \ directory \ name \ +(without \ path)]. Please use only alphanumerics and underscores. .TP .B \-\-pg \-v \-\-import @@ -708,8 +727,8 @@ Please use only alphanumerics and underscores. .TP .B \-\-pg \-\-remove -[filename/wildcard] removes specified data to postgresql db (rb.dbi) [ \ \-d \ -\-\-remove \ sqlite \ equivalent] +[filename/wildcard] removes specified data to postgresql db (rb.dbi) [ \ \-d +\ \-\-remove \ sqlite \ equivalent] .TP .B \-\-pg \-\-dropall @@ -726,8 +745,8 @@ The \-v is for verbose output. .B \-\-update [filename/wildcard] Checks existing file output and runs the flags required to update this output. This means that if only html and pdf output was requested on previous -runs, only the \-hp files will be applied, and only these will be generated this -time, together with the summary. This can be very convenient, if you offer +runs, only the \-hp files will be applied, and only these will be generated +this time, together with the summary. This can be very convenient, if you offer different outputs of different files, and just want to do the same again. .TP @@ -770,8 +789,8 @@ consider \-u for appended url info or \-v for verbose output .SH 5.1 COMMAND LINE WITH FLAGS \- BATCH PROCESSING .br -In the data directory run sisu \-mh filename or wildcard eg. "sisu \-h cisg.sst" -or "sisu \-h *.{sst,ssm}" to produce html version of all documents. +In the data directory run sisu \-mh filename or wildcard eg. "sisu \-h +cisg.sst" or "sisu \-h *.{sst,ssm}" to produce html version of all documents. .br Running sisu (alone without any flags, filenames or wildcards) brings up the @@ -1166,9 +1185,10 @@ This is a sample header .br Heading levels are :A~ ,:B~ ,:C~ ,1~ ,2~ ,3~ \... :A \- :C being part / section -headings, followed by other heading levels, and 1 \-6 being headings followed by -substantive text or sub\-headings. :A~ usually the title :A~? conditional level -1 heading (used where a stand\-alone document may be imported into another) +headings, followed by other heading levels, and 1 \-6 being headings followed +by substantive text or sub\-headings. :A~ usually the title :A~? conditional +level 1 heading (used where a stand\-alone document may be imported into +another) .br .B :A~ [heading \ text] |