summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2008-12-16 05:32:09 +0000
committerRalph Amissah <ralph@amissah.com>2008-12-16 05:32:09 +0000
commitd5841fafda125436e9182192af4402dab6ce0938 (patch)
treeef5e0704dda30dfee22e30a8c62b76be76178985
parentsha256 for 0.70.1 (diff)
downloadsisu-d5841fafda125436e9182192af4402dab6ce0938.zip
sisu-d5841fafda125436e9182192af4402dab6ce0938.tar.xz
manpage, help include: sisu --harvest *.ss[tm]
-rw-r--r--data/doc/sisu/html/sisu.1.html231
-rw-r--r--data/doc/sisu/sisu_markup_samples/sisu_manual/sisu.ssm6
-rw-r--r--data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_commands.sst9
-rw-r--r--data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_examples.ssi23
-rw-r--r--lib/sisu/v0/help.rb42
-rw-r--r--man/man1/sisu.151
6 files changed, 205 insertions, 157 deletions
diff --git a/data/doc/sisu/html/sisu.1.html b/data/doc/sisu/html/sisu.1.html
index 25b6e7e..faf8069 100644
--- a/data/doc/sisu/html/sisu.1.html
+++ b/data/doc/sisu/html/sisu.1.html
@@ -440,102 +440,114 @@ combination of -[mMvVq]), will remove the related document output directory.
<dd>produces php (zend) [this &nbsp;feature &nbsp;is &nbsp;disabled &nbsp;for
&nbsp;the &nbsp;time being]
<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>
</dl>
-3. COMMAND LINE MODIFIERS
+3. COMMAND
+LINE MODIFIERS
<p>
<dl>
<dt><b>--no-ocn</b> </dt>
-<dd>[with &nbsp;-h &nbsp;-H &nbsp;or &nbsp;-p] switches
-off object citation numbering. Produce output without identifying numbers
-in margins of html or LaTeX/pdf output.
+<dd>[with &nbsp;-h &nbsp;-H &nbsp;or &nbsp;-p] switches off object citation numbering.
+Produce output without identifying numbers in margins of html or LaTeX/pdf
+output.
<p> </dd>
<dt><b>--no-annotate</b> </dt>
-<dd>strips output text of
-editor endnotes[^*1] denoted by asterisk or dagger/plus sign
+<dd>strips output text of editor endnotes[^*1] denoted by
+
+<p>asterisk or dagger/plus sign
<p> </dd>
-<dt><b>--no-asterisk</b>
-</dt>
-<dd>strips output text of editor endnotes[^*2] denoted by asterisk sign
+<dt><b>--no-asterisk</b> </dt>
+<dd>strips output text of editor endnotes[^*2]
+
+<p>denoted by asterisk sign
<p> </dd>
-<dt><b>--no-dagger</b>
-</dt>
-<dd>strips output text of editor endnotes[^+1] denoted by dagger/plus sign
-<p>
-</dd>
+<dt><b>--no-dagger</b> </dt>
+<dd>strips output text of editor endnotes[^+1]
+
+<p>denoted by dagger/plus sign
+<p> </dd>
</dl>
4. DATABASE COMMANDS
-<p> dbi - database interface
-<p> -D or --pgsql set for postgresql
--d or --sqlite default set for sqlite -d is modifiable with --db=[database &nbsp;type
-&nbsp;(pgsql &nbsp;or &nbsp;sqlite)]
+<p> dbi - database interface
+
+<p> -D or --pgsql set for postgresql -d or --sqlite default set for sqlite -d is
+modifiable with --db=[database &nbsp;type &nbsp;(pgsql &nbsp;or &nbsp;sqlite)]
<p>
<dl>
<dt><b>-Dv --createall</b> </dt>
-<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) [ &nbsp;-dv &nbsp;--createall sqlite &nbsp;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 &rsquo;createdb
-[database name]&rsquo; where database name would be SiSU_[present &nbsp;working &nbsp;directory
-&nbsp;name &nbsp;(without &nbsp;path)]. Please use only alphanumerics and underscores.
+<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) [ &nbsp;-dv &nbsp;--createall sqlite &nbsp;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 &rsquo;createdb [database name]&rsquo; where database name would
+be SiSU_[present &nbsp;working &nbsp;directory &nbsp;name &nbsp;(without &nbsp;path)]. Please use only
+alphanumerics and underscores.
<p> </dd>
-<dt><b>-Dv
---import</b> </dt>
-<dd>[filename/wildcard] imports data specified to postgresql db (rb.dbi)
-[ &nbsp;-dv &nbsp;--import &nbsp;sqlite &nbsp;equivalent]
+<dt><b>-Dv --import</b> </dt>
+<dd>[filename/wildcard] imports data
+specified to postgresql db (rb.dbi) [ &nbsp;-dv &nbsp;--import &nbsp;sqlite &nbsp;equivalent]
<p> </dd>
-<dt><b>-Dv --update</b> </dt>
-<dd>[filename/wildcard] updates/imports
-specified data to postgresql db (rb.dbi) [ &nbsp;-dv &nbsp;--update &nbsp;sqlite &nbsp;equivalent]
-
+<dt><b>-Dv --update</b>
+</dt>
+<dd>[filename/wildcard] updates/imports specified data to postgresql db (rb.dbi)
+[ &nbsp;-dv &nbsp;--update &nbsp;sqlite &nbsp;equivalent]
<p> </dd>
<dt><b>-D --remove</b> </dt>
-<dd>[filename/wildcard] removes specified data to postgresql db (rb.dbi)
-[ &nbsp;-d &nbsp;--remove &nbsp;sqlite &nbsp;equivalent]
+<dd>[filename/wildcard] removes specified
+data to postgresql db (rb.dbi) [ &nbsp;-d &nbsp;--remove &nbsp;sqlite &nbsp;equivalent]
<p> </dd>
-<dt><b>-D --dropall</b> </dt>
-<dd>kills data --dropall &nbsp;sqlite &nbsp;equivalent]
+<dt><b>-D --dropall</b>
+</dt>
+<dd>kills data --dropall &nbsp;sqlite &nbsp;equivalent]
+<p> The v in e.g. -Dv is for verbose output.
-<p> The v in e.g. -Dv is for verbose output.
<p> </dd>
</dl>
-5. SHORTCUTS, SHORTHAND FOR MULTIPLE
-FLAGS
+5. SHORTCUTS, SHORTHAND FOR MULTIPLE FLAGS
<p>
<dl>
-<dt><b>--update [filename/wildcard]</b> </dt>
-<dd>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 different outputs of different files,
-and just want to do the same again.
+<dt><b>--update [filename/wildcard]</b>
+</dt>
+<dd>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 different outputs of different files, and just want to do the same
+again.
<p> </dd>
<dt><b>-0 to -5 [filename &nbsp;or &nbsp;wildcard]</b> </dt>
-<dd>Default
-shorthand mappings (note that the defaults can be changed/configured in
-the sisurc.yml file):
+<dd>Default shorthand mappings (note that
+the defaults can be changed/configured in the sisurc.yml file):
<p> </dd>
<dt><b>-0</b> </dt>
-<dd>-mNhwpAobxXyYv [this &nbsp;is &nbsp;the &nbsp;default &nbsp;action &nbsp;run &nbsp;when
-&nbsp;no &nbsp;i.e. &nbsp;on &nbsp;&rsquo;sisu &nbsp;[filename]&rsquo;]
+<dd>-mNhwpAobxXyYv
+[this &nbsp;is &nbsp;the &nbsp;default &nbsp;action &nbsp;run &nbsp;when &nbsp;no &nbsp;i.e. &nbsp;on &nbsp;&rsquo;sisu &nbsp;[filename]&rsquo;]
<p> </dd>
<dt><b>-1</b> </dt>
-<dd>-mNHwpy
+<dd>-mNHwpy
+
<p> </dd>
<dt><b>-2</b> </dt>
@@ -547,33 +559,31 @@ the sisurc.yml file):
<p> </dd>
<dt><b>-4</b> </dt>
-<dd>-mNhwpAobxXDyY
-
-<p>-
-<p>-
-<p>import
+<dd>-mNhwpAobxXDyY --import
<p> </dd>
<dt><b>-5</b> </dt>
-<dd>-mNhwpAobxXDyY --update
-<p> add -v for verbose mode and -c for color,
-e.g. sisu -2vc [filename &nbsp;or
-<p> consider -u for appended url info or -v for verbose
+<dd>-mNhwpAobxXDyY --update
-<p>output
+<p> add -v for verbose mode and -c for color, e.g. sisu -2vc [filename &nbsp;or
+<p> consider
+
+<p>-
+<p>u for appended url info or -v for verbose output
<p> </dd>
</dl>
-5.1 COMMAND LINE WITH FLAGS - BATCH PROCESSING
-<p> In the data directory
-run sisu -mh filename or wildcard eg. cisg.sst documents.
-<p> Running sisu (alone
-without any flags, filenames or wildcards) brings up the interactive help,
-as does any sisu command that is not recognised. Enter to escape.
-<p> 6. HELP
-
+5.1 COMMAND LINE WITH FLAGS
+- BATCH PROCESSING
+<p> In the data directory run sisu -mh filename or wildcard
+eg. cisg.sst documents.
+<p> Running sisu (alone without any flags, filenames
+or wildcards) brings up the interactive help, as does any sisu command
+that is not recognised. Enter to escape.
+<p> 6. HELP
<p> 6.1 SISU MANUAL
-<p> The most up to date information on sisu should be contained
-in the sisu_manual, available at:
+<p> The most
+up to date information on sisu should be contained in the sisu_manual,
+available at:
<p> &lt;<a href='http://sisudoc.org/sisu/sisu_manual/'>http://sisudoc.org/sisu/sisu_manual/</a>
&gt;<br>
@@ -743,8 +753,7 @@ one (without the comments):
@title: SiSU
@subtitle: Markup
@creator: Amissah, Ralph
- % note formatting on author / creator field, surname comma then other
-names, if more than one author separate using semi-colon
+ % note formatting rules on author / creator field,
@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation,
License GPL 3
@type: information
@@ -3241,47 +3250,47 @@ html pages[^28]
<p> <b>Dublin Core</b> (DC)
<p> <i>DC</i> tags included with this document are provided here.
-<p> DC Title: <i>SiSU</i> - Manual
-<p> DC Creator: <i>Ralph</i> Amissah
-<p> DC Rights: 3
-<p> DC Type:
+<p> Title: <i>SiSU</i> - Manual
+<p> Creator: <i>Ralph</i> Amissah
+<p> Rights: <i>Copyright</i> (C) Ralph
+Amissah 2008, part of SiSU documentation, License GPL 3
+<p> Type: <i>information</i>
-<p><i>information</i>
-<p> DC Date created: <i>2002-08-28</i>
-<p> DC Date issued: <i>2002-08-28</i>
-<p> DC
-Date available: <i>2002-08-28</i>
-<p> DC Date modified: <i>2008-05-22</i>
-<p> DC Date: <i>2008-05-22</i>
+<p> Date created: <i>2002-08-28</i>
+<p> Date issued: <i>2002-08-28</i>
+<p> Date available: <i>2002-08-28</i>
+<p> Date modified: <i>2008-12-16</i>
+<p> Date: <i>2008-12-16</i>
+<p>
<p> <b>Version Information</b>
-<p> Sourcefile: <i>sisu.ssm.sst</i>
-<p> Filetype: <i>SiSU</i> text insert
+<p> Sourcefile:
-<p>0.67
-<p> Sourcefile Digest, MD5(sisu.ssm.sst)= <i>7fbab3b7c0fd0ed2e128585c2982c5c8</i>
+<p><i>sisu.ssm.sst</i>
+<p> Filetype: <i>SiSU</i> text insert 0.67
+<p> Sourcefile Digest, MD5(sisu.ssm.sst)=
-<p> Skin_Digest: MD5(skin_sisu_manual.rb)= <i>072b2584bedea82ea8a416587b9fa244</i>
+<p><i>96d1e268b43e0430a2720e67a5876e5e</i>
+<p> Skin_Digest: MD5(skin_sisu_manual.rb)=
+<p><i>072b2584bedea82ea8a416587b9fa244</i>
<p> <b>Generated</b>
-<p> Document (metaverse) last generated: <i>Mon</i> Jul 21 02:54:34
+<p> Document (metaverse) last
+generated: <i>Tue</i> Dec 16 00:16:50 -0500 2008
+<p> Generated by: <i>SiSU</i> <i>0.70.2</i> of 2008w50/2
+(2008-12-16)
+<p> Ruby version: <i>ruby</i> 1.8.7 (2008-08-11 patchlevel 72) &nbsp;[i486-linux]
-<p>-
-<p>0400 2008
-<p> Generated by: <i>SiSU</i> <i>0.68.0</i> of 2008w29/1 (2008-07-21)
-<p> Ruby version:
-<i>ruby</i> 1.8.7 (2008-06-20 patchlevel 22) &nbsp;[i486-linux]
<p>
<ol>
-<b>.</b><li>objects include: headings,
-paragraphs, verse, tables, images, but not footnotes/endnotes which are
-numbered separately and tied to the object from which they are referenced.
-</li><b>.</b><li>i.e. the html, pdf, odf outputs are each built individually and optimised
-for that form of presentation, rather than for example the html being a
-saved version of the odf, or the pdf being a saved version of the html.
-</li><b>.</b><li>the different heading levels </li><b>.</b><li>units of text, primarily paragraphs and headings,
-also any tables, poems, code-blocks </li><b>.</b><li>Specification submitted by Adobe to
-ISO to become a full open ISO specification &lt;<a href='http://www.linux-watch.com/news/NS7542722606.html'>http://www.linux-watch.com/news/NS7542722606.html</a>
+<b>.</b><li>objects include: headings, paragraphs, verse, tables, images, but not
+footnotes/endnotes which are numbered separately and tied to the object
+from which they are referenced. </li><b>.</b><li>i.e. the html, pdf, odf outputs are each built
+individually and optimised for that form of presentation, rather than for
+example the html being a saved version of the odf, or the pdf being a saved
+version of the html. </li><b>.</b><li>the different heading levels </li><b>.</b><li>units of text, primarily
+paragraphs and headings, also any tables, poems, code-blocks </li><b>.</b><li>Specification
+submitted by Adobe to ISO to become a full open ISO specification &lt;<a href='http://www.linux-watch.com/news/NS7542722606.html'>http://www.linux-watch.com/news/NS7542722606.html</a>
&gt;
</li><b>.</b><li>ISO/IEC 26300:2006 </dd>
@@ -3377,7 +3386,7 @@ of this document: </dt>
<dt>pdf: &lt;<a href='http://www.jus.uio.no/sisu/sisu/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu/landscape.pdf'>http://www.jus.uio.no/sisu/sisu/landscape.pdf</a>
</a>
&gt; </dt>
-<dd></dd>
+<dd> </dd>
<dt>at: &lt;<a href='http://www.jus.uio.no/sisu'><a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
</a>
@@ -3385,15 +3394,15 @@ of this document: </dt>
</dt>
<dd></dd>
-<dt>* Generated by: SiSU 0.70.0 of 2008w48/3 (2008-12-03) </dt>
+<dt>* Generated by: SiSU 0.70.2 of 2008w50/2 (2008-12-16) </dt>
<dd></dd>
<dt>* Ruby version: ruby
1.8.7 (2008-08-11 patchlevel 72) [i486-linux] </dt>
<dd></dd>
-<dt>* Last Generated on: Tue Dec 09
-12:24:07 -0500 2008 </dt>
+<dt>* Last Generated on: Tue Dec 16
+00:16:50 -0500 2008 </dt>
<dd></dd>
<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu.ssm b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu.ssm
index 9e891fc..1d2e34c 100644
--- a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu.ssm
+++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu.ssm
@@ -18,9 +18,9 @@
@date.available: 2002-08-28
-@date.modified: 2008-12-14
+@date.modified: 2008-12-16
-@date: 2008-12-14
+@date: 2008-12-16
@level: new=C; break=1; num_top=1
@@ -76,7 +76,7 @@ sisu [-CcFLSVvW]
% :B~? SiSU Output and Markup Examples
-<< sisu_examples.sst
+<< sisu_examples.ssi
<< sisu_search_intro.ssi
diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_commands.sst b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_commands.sst
index d8cd48c..4c53ac7 100644
--- a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_commands.sst
+++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_commands.sst
@@ -18,9 +18,9 @@
@date.available: 2002-08-28
-@date.modified: 2007-09-16
+@date.modified: 2008-12-16
-@date: 2007-09-16
+@date: 2008-12-16
@level: new=C; break=1; num_top=1
@@ -189,6 +189,9 @@ Zap, if used with other processing flags deletes output files of the type about
!_ -z [filename/wildcard] <br>
produces php (zend) [this feature is disabled for the time being]
+!_ --harvest *.ss[tm] <br>
+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.
+
1~command_modifiers command line modifiers
!_ --no-ocn <br>
@@ -203,6 +206,7 @@ strips output text of editor endnotes~[* square brackets ]~ denoted by asterisk
!_ --no-dagger <br>
strips output text of editor endnotes~[+ square brackets ]~ denoted by dagger/plus sign
+
1~commands_database database commands
dbi - database interface
@@ -228,7 +232,6 @@ The v in e.g. -Dv is for verbose output.
1~command_shorcuts Shortcuts, Shorthand for multiple flags
-
!_ --update [filename/wildcard] <br>
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 different outputs of different files, and just want to do the same again.
diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_examples.ssi b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_examples.ssi
new file mode 100644
index 0000000..06f1ec2
--- /dev/null
+++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_examples.ssi
@@ -0,0 +1,23 @@
+% SiSU 0.57
+
+@title: SiSU
+
+@subtitle: Markup Samples, Output Examples
+
+@creator: Ralph Amissah
+
+@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
+
+:A~? @title @creator
+
+:B~? SiSU Markup and Output Examples
+
+1~examples Markup and Output Examples
+
+2~ Markup examples *~markup
+
+Current markup examples and document output samples are provided at http://www.jus.uio.no/sisu/SiSU/examples.html
+
+Some markup with syntax highlighting may be found under http://www.jus.uio.no/sisu/sample/syntax but is not as up to date.
+
+For some documents hardly any markup at all is required at all, other than a header, and an indication that the levels to be taken into account by the program in generating its output are.
diff --git a/lib/sisu/v0/help.rb b/lib/sisu/v0/help.rb
index 67263b6..c3fbf39 100644
--- a/lib/sisu/v0/help.rb
+++ b/lib/sisu/v0/help.rb
@@ -246,23 +246,23 @@ WOK
def commands
print <<WOK
- #{@cX.ruby}-a#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} produces plaintext with Unix linefeeds. Without markup, (object numbers are omitted), has footnotes at end of each para‐ graph that contains them. Modifier options available: --footnotes (default) or --endnotes and for linefeeds --unix (default) or --msdos
+ #{@cX.ruby}-a#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} produces plaintext with Unix linefeeds. Without markup, (object numbers are omitted), has footnotes at end of each para‐ graph that contains them. Modifier options available: --footnotes (default) or --endnotes and for linefeeds --unix (default) or --msdos
- #{@cX.ruby}-b#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} produces xhtml/XML output for browser viewing (sax parsing)
+ #{@cX.ruby}-b#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} produces xhtml/XML output for browser viewing (sax parsing)
- #{@cX.ruby}-C#{@cX.off} initialise shared output directory (config files such as css and dtd files are not updated if they already exist unless modifier is used) #{@cX.ruby}-C --init=site#{@cX.off} 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. in a new markup document working directory should initialise the corresponding output directory, though SiSU will automatically do this, the first time it is run (for processing) in a given directory.
+ #{@cX.ruby}-C#{@cX.off} initialise shared output directory (config files such as css and dtd files are not updated if they already exist unless modifier is used) #{@cX.ruby}-C --init=site#{@cX.off} 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. in a new markup document working directory should initialise the corresponding output directory, though SiSU will automatically do this, the first time it is run (for processing) in a given directory.
- #{@cX.ruby}-c#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} 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)
+ #{@cX.ruby}-c#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} 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)
#{@cX.ruby}-D#{@cX.off} #{@cX.green}[instruction]#{@cX.off} #{@cX.green}[filename]#{@cX.off} database instruction, see database section below
#{@cX.ruby}-d#{@cX.off} #{@cX.green}[instruction]#{@cX.off} #{@cX.green}[filename]#{@cX.off} database instruction, see database section below [only -D currently available]
- #{@cX.ruby}-F#{@cX.off} generate examples of (naive) cgi search form for sqlite and pgsql depends on 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 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).
+ #{@cX.ruby}-F#{@cX.off} generate examples of (naive) cgi search form for sqlite and pgsql depends on 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 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).
#{@cX.ruby}-H#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} produces html (css version) (creates html (using css)), with url link suffixes (.html .pdf etc.) omitted ("Hide"). For web servers that are confireud so as not to require file extensions to locate and serve files. [behaviour switched see -h]
- #{@cX.ruby}-h#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} produces html (hardlinks i.e. with name suffixes in links/local urls). html, with internal document links that include the document suffix, ie whether it is .html or .pdf (required for browsing directly off a file system, and works with most web servers). [behaviour switched see -H]
+ #{@cX.ruby}-h#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} produces html (hardlinks i.e. with name suffixes in links/local urls). html, with internal document links that include the document suffix, ie whether it is .html or .pdf (required for browsing directly off a file system, and works with most web servers). [behaviour switched see -H]
#{@cX.ruby}-I#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} produces texinfo file with its myriad of possibilities
@@ -270,25 +270,25 @@ WOK
#{@cX.ruby}-M#{@cX.off} #{@cX.green}[filename/wildcard/url]#{@cX.off} maintenance mode, files created for processing are not deleted, and their locations are indicated (also see -V)
- #{@cX.ruby}-m#{@cX.off} #{@cX.green}[filename/wildcard/url]#{@cX.off} create (new)metaVerse (used in all subsequent processing). Produce a meta file, the first step in processing, and the file all subsequent processing utilize. (Should usually be run together with other commands to ensure that the lated version of markup source document is used, i.e. add -m flag to other flags required).
+ #{@cX.ruby}-m#{@cX.off} #{@cX.green}[filename/wildcard/url]#{@cX.off} create (new)metaVerse (used in all subsequent processing). Produce a meta file, the first step in processing, and the file all subsequent processing utilize. (Should usually be run together with other commands to ensure that the lated version of markup source document is used, i.e. add -m flag to other flags required).
- #{@cX.ruby}-N#{@cX.off} #{@cX.green}[filename/wildcard/url]#{@cX.off} document content certificate as md5 digest tree of document produced (as digest.txt), the digest for the document, and digests for each object contained within the document (together with information on software versions that produced it). Try -mNV for verbose digest output to screen
+ #{@cX.ruby}-N#{@cX.off} #{@cX.green}[filename/wildcard/url]#{@cX.off} document content certificate as md5 digest tree of document produced (as digest.txt), the digest for the document, and digests for each object contained within the document (together with information on software versions that produced it). Try -mNV for verbose digest output to screen
#{@cX.ruby}-n#{@cX.off} #{@cX.green}[filename/wildcard/url]#{@cX.off} skip meta-markup (building of "metaverse"), this skips the equivalent of -m
- #{@cX.ruby}-p#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} produces LaTeX pdf (portrait & landscape). Default paper size is set in config file, or document header, or provided with additional command line parameter, e.g. --papersize='a4' preset sizes include: 'A4', U.S. 'letter' and 'legal' and book sizes 'A5' and 'B5' (system defaults to A4).
+ #{@cX.ruby}-p#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} produces LaTeX pdf (portrait & landscape). Default paper size is set in config file, or document header, or provided with additional command line parameter, e.g. --papersize='a4' preset sizes include: 'A4', U.S. 'letter' and 'legal' and book sizes 'A5' and 'B5' (system defaults to A4).
#{@cX.ruby}-q#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} quiet, less output to screen
- #{@cX.ruby}-r#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} copies sisu output files to remote host using scp (default). This requires that sisurc.yml has been provided with information on hostname and user name, and that you have your "keys" and ssh agent in place.
+ #{@cX.ruby}-r#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} copies sisu output files to remote host using scp (default). This requires that sisurc.yml has been provided with information on hostname and user name, and that you have your "keys" and ssh agent in place.
- #{@cX.ruby}-S#{@cX.off} #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 The resulting tar gzip file has a .zip suffix added to the markup source directory name. To tar and gzip individual files see the -Z [filename/wildcard] option. Note: (this option is tested only with zsh)
+ #{@cX.ruby}-S#{@cX.off} #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 The resulting tar gzip file has a .zip suffix added to the markup source directory name. To tar and gzip individual files see the -Z [filename/wildcard] option. Note: (this option is tested only with zsh)
- #{@cX.ruby}-S#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} produces a sisupod a zipped sisu of the content assocated with the specified sisu markup documnt, i.e. including sisu markup source file, (and associated documents if a master file, or available in multilingual versions), together with related images and skin. The resulting zipped file has a .zip suffix added to the markup source file name by default, though a .ssp suffix is also recognised. The directory structure of the unzipped file is understood by sisu, and sisu commands can be run within it. SiSU commands can be run against a sisupod contained in a local directory, or provided as a url on a remote site. As there is a security issue with skins provided by other users, they are not applied unless the flag --trust or --trusted is added to the command instruction, it is recommended that file that are not your own are treated as untrusted. This provides a convenient way of packing documents files for sending Note: if you wish to send multiple files, it quickly becomes more space efficient to tar and gzip the sisu markup directory, (without the _sisu_processing subdirectory) rather than the individual files for sending). See the -S option without [filename/wildcard]
+ #{@cX.ruby}-S#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} produces a sisupod a zipped sisu of the content assocated with the specified sisu markup documnt, i.e. including sisu markup source file, (and associated documents if a master file, or available in multilingual versions), together with related images and skin. The resulting zipped file has a .zip suffix added to the markup source file name by default, though a .ssp suffix is also recognised. The directory structure of the unzipped file is understood by sisu, and sisu commands can be run within it. SiSU commands can be run against a sisupod contained in a local directory, or provided as a url on a remote site. As there is a security issue with skins provided by other users, they are not applied unless the flag --trust or --trusted is added to the command instruction, it is recommended that file that are not your own are treated as untrusted. This provides a convenient way of packing documents files for sending Note: if you wish to send multiple files, it quickly becomes more space efficient to tar and gzip the sisu markup directory, (without the _sisu_processing subdirectory) rather than the individual files for sending). See the -S option without [filename/wildcard]
#{@cX.ruby}-t#{@cX.off} #{@cX.green}[filename/wildcard (*.termsheet.rb)]#{@cX.off} standard form document builder, preprocessing feature
- #{@cX.ruby}-U#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} prints url 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 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
+ #{@cX.ruby}-U#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} prints url 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 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
#{@cX.ruby}-u#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} provides url mapping of output files for the flags requested for processing, also see -U
@@ -298,7 +298,7 @@ WOK
#{@cX.ruby}-v#{@cX.off} on its own, provides SiSU version information.
- #{@cX.ruby}-v#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} provides more verbose output of what is being built, where it is being built (and error messages if any), as with -u flag provides a url mapping of files created for each of the processing flag requests
+ #{@cX.ruby}-v#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} provides more verbose output of what is being built, where it is being built (and error messages if any), as with -u flag provides a url mapping of files created for each of the processing flag requests
#{@cX.ruby}-X#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} produces XML output with deep document structure, in the nature of dom
@@ -308,27 +308,29 @@ WOK
#{@cX.ruby}-w#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} produces concordance, a rudimentary index of all the words in a document
- #{@cX.ruby}-Z#{@cX.off} Zap, if used with other processing flags #{@cX.green}deletes output files#{@cX.off} 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.
+ #{@cX.ruby}-Z#{@cX.off} Zap, if used with other processing flags #{@cX.green}deletes output files#{@cX.off} 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.
#{@cX.ruby}-z#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} produces php (zend) [feature disabled, depreciated]
+ #{@cX.ruby}--harvest#{@cX.off} #{@cX.green}*.ss[tm]#{@cX.off} 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 -M and -R flags.
+
#{@cX.ruby}databases#{@cX.off}
#{@cX.ruby}dbi - database interface -D or --pgsql set for postgresql -d or --sqlite set for sqlite#{@cX.off}
- #{@cX.ruby}-D#{@cX.off} #{@cX.ruby}--create#{@cX.off} creates empty postgresql db and required tables & indexes (rb.dbi) [#{@cX.ruby}-d --create#{@cX.off} sqlite equivalent] it may be necessary to first run sisu #{@cX.ruby}-D#{@cX.off} #{@cX.ruby}--createdb#{@cX.off}
+ #{@cX.ruby}-D#{@cX.off} #{@cX.ruby}--create#{@cX.off} creates empty postgresql db and required tables & indexes (rb.dbi) [#{@cX.ruby}-d --create#{@cX.off} sqlite equivalent] it may be necessary to first run sisu #{@cX.ruby}-D#{@cX.off} #{@cX.ruby}--createdb#{@cX.off}
- #{@cX.ruby}-Di#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} or #{@cX.ruby}-D#{@cX.off} #{@cX.ruby}--import#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} imports data specified to postgresql db (rb.dbi) [#{@cX.ruby}-d --import#{@cX.off} sqlite equivalent]
+ #{@cX.ruby}-Di#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} or #{@cX.ruby}-D#{@cX.off} #{@cX.ruby}--import#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} imports data specified to postgresql db (rb.dbi) [#{@cX.ruby}-d --import#{@cX.off} sqlite equivalent]
- #{@cX.ruby}-Du#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} or #{@cX.ruby}-D#{@cX.off} #{@cX.ruby}--update#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} updates/imports specified data to postgresql db (rb.dbi) [#{@cX.ruby}-d --update#{@cX.off} sqlite equivalent]
+ #{@cX.ruby}-Du#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} or #{@cX.ruby}-D#{@cX.off} #{@cX.ruby}--update#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} updates/imports specified data to postgresql db (rb.dbi) [#{@cX.ruby}-d --update#{@cX.off} sqlite equivalent]
- #{@cX.ruby}-D#{@cX.off} #{@cX.ruby}--remove#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} removes specified data to postgresql db (rb.dbi) [#{@cX.ruby}-d --remove#{@cX.off} sqlite equivalent]
+ #{@cX.ruby}-D#{@cX.off} #{@cX.ruby}--remove#{@cX.off} #{@cX.green}[filename/wildcard]#{@cX.off} removes specified data to postgresql db (rb.dbi) [#{@cX.ruby}-d --remove#{@cX.off} sqlite equivalent]
#{@cX.ruby}-D#{@cX.off} #{@cX.ruby}--dropall#{@cX.off} kills data" and drops (postgresql) db, tables & indexes [#{@cX.ruby}-d --dropall#{@cX.off} sqlite equivalent]
#{@cX.ruby}-D#{@cX.off} #{@cX.ruby}--recreate#{@cX.off} kills data" and drops (postgresql or sqlite) db, tables & indexes, then creates an empty db with tables and indexes [#{@cX.ruby}-d --recreate#{@cX.off} sqlite equivalent]
- also see command #{@cX.green}shortcuts#{@cX.off}, and shorthand mappings for multiple flags
+ also see command #{@cX.green}shortcuts#{@cX.off}, and shorthand mappings for multiple flags
WOK
end
def shortcuts
diff --git a/man/man1/sisu.1 b/man/man1/sisu.1
index fc8f3a7..7cb0965 100644
--- a/man/man1/sisu.1
+++ b/man/man1/sisu.1
@@ -1,4 +1,4 @@
-.TH "sisu" "1" "2008-12-14" "0.70.1" "SiSU"
+.TH "sisu" "1" "2008-12-16" "0.70.2" "SiSU"
.SH NAME
sisu \- documents: markup, structuring, publishing in multiple standard formats, and search
.SH SYNOPSIS
@@ -471,6 +471,14 @@ will remove the related document output directory.
produces php (zend) [this \ feature \ is \ disabled \ for \ the \ time \
being]
+.TP
+.B \-\-harvest *.ss[tm]
+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.
+
.SH
3. COMMAND LINE MODIFIERS
.BR
@@ -4846,38 +4854,39 @@ Document Manifest @ <http://sisudoc.org/sisu_manual/sisu/sisu_manifest.html>
.BR
.I DC tags included with this document are provided here.
-DC Title:
+Title:
.I SiSU \- Manual
-DC Creator:
+Creator:
.I Ralph Amissah
-DC Rights:
-3
+Rights:
+.I Copyright (C) Ralph Amissah 2008, part of SiSU documentation, License GPL 3
.BR
-DC Type:
+Type:
.I information
.BR
-DC Date created:
+Date created:
.I 2002\-08\-28
.BR
-DC Date issued:
+Date issued:
.I 2002\-08\-28
.BR
-DC Date available:
+Date available:
.I 2002\-08\-28
.BR
-DC Date modified:
-.I 2008\-05\-22
+Date modified:
+.I 2008\-12\-16
.BR
-DC Date:
-.I 2008\-05\-22
+Date:
+.I 2008\-12\-16
+
.BR
.B Version Information
@@ -4892,7 +4901,7 @@ Filetype:
.BR
Sourcefile Digest, MD5(sisu.ssm.sst)=
-.I 7fbab3b7c0fd0ed2e128585c2982c5c8
+.I 96d1e268b43e0430a2720e67a5876e5e
.BR
Skin_Digest: MD5(skin_sisu_manual.rb)=
@@ -4903,17 +4912,17 @@ Skin_Digest: MD5(skin_sisu_manual.rb)=
.BR
Document (metaverse) last generated:
-.I Mon Jul 21 02:54:34 \-0400 2008
+.I Tue Dec 16 00:16:50 \-0500 2008
.BR
Generated by:
.I SiSU
-.I 0.68.0
-of 2008w29/1 (2008\-07\-21)
+.I 0.70.2
+of 2008w50/2 (2008\-12\-16)
.BR
Ruby version:
-.I ruby 1.8.7 (2008\-06\-20 patchlevel 22) \ [i486\-linux]
+.I ruby 1.8.7 (2008\-08\-11 patchlevel 72) \ [i486\-linux]
.TP
.BI 1.
@@ -5062,14 +5071,16 @@ html: <http://www.jus.uio.no/sisu/sisu/toc.html>
pdf: <http://www.jus.uio.no/sisu/sisu/portrait.pdf>
.TP
pdf: <http://www.jus.uio.no/sisu/sisu/landscape.pdf>
+." .TP
+." manpage: http://www.jus.uio.no/sisu/sisu/sisu.1
.TP
at: <http://www.jus.uio.no/sisu>
.TP
.TP
-* Generated by: SiSU 0.70.0 of 2008w48/3 (2008-12-03)
+* Generated by: SiSU 0.70.2 of 2008w50/2 (2008-12-16)
.TP
* Ruby version: ruby 1.8.7 (2008-08-11 patchlevel 72) [i486-linux]
.TP
-* Last Generated on: Tue Dec 09 12:24:07 -0500 2008
+* Last Generated on: Tue Dec 16 00:16:50 -0500 2008
.TP
* SiSU http://www.jus.uio.no/sisu