From d5841fafda125436e9182192af4402dab6ce0938 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 16 Dec 2008 00:32:09 -0500 Subject: manpage, help include: sisu --harvest *.ss[tm] --- data/doc/sisu/html/sisu.1.html | 231 +++++++++++---------- .../sisu/sisu_markup_samples/sisu_manual/sisu.ssm | 6 +- .../sisu_manual/sisu_commands.sst | 9 +- .../sisu_manual/sisu_examples.ssi | 23 ++ lib/sisu/v0/help.rb | 42 ++-- man/man1/sisu.1 | 51 +++-- 6 files changed, 205 insertions(+), 157 deletions(-) create mode 100644 data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_examples.ssi diff --git a/data/doc/sisu/html/sisu.1.html b/data/doc/sisu/html/sisu.1.html index 25b6e7e4..faf8069c 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.
produces php (zend) [this  feature  is  disabled  for  the  time being]

+ +
--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. +

-3. COMMAND LINE MODIFIERS +3. COMMAND +LINE MODIFIERS

--no-ocn
-
[with  -h  -H  or  -p] switches -off object citation numbering. Produce output without identifying numbers -in margins of html or LaTeX/pdf output. +
[with  -h  -H  or  -p] switches off object citation numbering. +Produce output without identifying numbers in margins of html or LaTeX/pdf +output.

--no-annotate
-
strips output text of -editor endnotes[^*1] denoted by asterisk or dagger/plus sign +
strips output text of editor endnotes[^*1] denoted by + +

asterisk or dagger/plus sign

-
--no-asterisk -
-
strips output text of editor endnotes[^*2] denoted by asterisk sign +
--no-asterisk
+
strips output text of editor endnotes[^*2] + +

denoted by asterisk sign

-
--no-dagger -
-
strips output text of editor endnotes[^+1] denoted by dagger/plus sign -

-

+
--no-dagger
+
strips output text of editor endnotes[^+1] + +

denoted by dagger/plus sign +

4. DATABASE COMMANDS -

dbi - database interface -

-D or --pgsql set for postgresql --d or --sqlite default set for sqlite -d is modifiable with --db=[database  type - (pgsql  or  sqlite)] +

dbi - database interface + +

-D or --pgsql set for postgresql -d or --sqlite default set for sqlite -d is +modifiable with --db=[database  type  (pgsql  or  sqlite)]

-Dv --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. +
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.

-
-Dv ---import
-
[filename/wildcard] imports data specified to postgresql db (rb.dbi) -[  -dv  --import  sqlite  equivalent] +
-Dv --import
+
[filename/wildcard] imports data +specified to postgresql db (rb.dbi) [  -dv  --import  sqlite  equivalent]

-
-Dv --update
-
[filename/wildcard] updates/imports -specified data to postgresql db (rb.dbi) [  -dv  --update  sqlite  equivalent] - +
-Dv --update +
+
[filename/wildcard] updates/imports specified data to postgresql db (rb.dbi) +[  -dv  --update  sqlite  equivalent]

-D --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]

-
-D --dropall
-
kills data --dropall  sqlite  equivalent] +
-D --dropall +
+
kills data --dropall  sqlite  equivalent] +

The v in e.g. -Dv is for verbose output. -

The v in e.g. -Dv is for verbose output.

-5. SHORTCUTS, SHORTHAND FOR MULTIPLE -FLAGS +5. SHORTCUTS, SHORTHAND FOR MULTIPLE FLAGS

-
--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 different outputs of different files, -and just want to do the same again. +
--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 different outputs of different files, and just want to do the same +again.

-0 to -5 [filename  or  wildcard]
-
Default -shorthand mappings (note that the defaults can be changed/configured in -the sisurc.yml file): +
Default shorthand mappings (note that +the defaults can be changed/configured in the sisurc.yml file):

-0
-
-mNhwpAobxXyYv [this  is  the  default  action  run  when - no  i.e.  on  ’sisu  [filename]’] +
-mNhwpAobxXyYv +[this  is  the  default  action  run  when  no  i.e.  on  ’sisu  [filename]’]

-1
-
-mNHwpy +
-mNHwpy +

-2
@@ -547,33 +559,31 @@ the sisurc.yml file):

-4
-
-mNhwpAobxXDyY - -

- -

- -

import +

-mNhwpAobxXDyY --import

-5
-
-mNhwpAobxXDyY --update -

add -v for verbose mode and -c for color, -e.g. sisu -2vc [filename  or -

consider -u for appended url info or -v for verbose +

-mNhwpAobxXDyY --update -

output +

add -v for verbose mode and -c for color, e.g. sisu -2vc [filename  or +

consider + +

- +

u for appended url info or -v for verbose output

-5.1 COMMAND LINE WITH FLAGS - BATCH PROCESSING -

In the data directory -run sisu -mh filename or wildcard eg. cisg.sst documents. -

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. -

6. HELP - +5.1 COMMAND LINE WITH FLAGS +- BATCH PROCESSING +

In the data directory run sisu -mh filename or wildcard +eg. cisg.sst documents. +

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. +

6. HELP

6.1 SISU MANUAL -

The most up to date information on sisu should be contained -in the sisu_manual, available at: +

The most +up to date information on sisu should be contained in the sisu_manual, +available at:

<http://sisudoc.org/sisu/sisu_manual/ >
@@ -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]

Dublin Core (DC)

DC tags included with this document are provided here. -

DC Title: SiSU - Manual -

DC Creator: Ralph Amissah -

DC Rights: 3 -

DC Type: +

Title: SiSU - Manual +

Creator: Ralph Amissah +

Rights: Copyright (C) Ralph +Amissah 2008, part of SiSU documentation, License GPL 3 +

Type: information -

information -

DC Date created: 2002-08-28 -

DC Date issued: 2002-08-28 -

DC -Date available: 2002-08-28 -

DC Date modified: 2008-05-22 -

DC Date: 2008-05-22 +

Date created: 2002-08-28 +

Date issued: 2002-08-28 +

Date available: 2002-08-28 +

Date modified: 2008-12-16 +

Date: 2008-12-16 +

Version Information -

Sourcefile: sisu.ssm.sst -

Filetype: SiSU text insert +

Sourcefile: -

0.67 -

Sourcefile Digest, MD5(sisu.ssm.sst)= 7fbab3b7c0fd0ed2e128585c2982c5c8 +

sisu.ssm.sst +

Filetype: SiSU text insert 0.67 +

Sourcefile Digest, MD5(sisu.ssm.sst)= -

Skin_Digest: MD5(skin_sisu_manual.rb)= 072b2584bedea82ea8a416587b9fa244 +

96d1e268b43e0430a2720e67a5876e5e +

Skin_Digest: MD5(skin_sisu_manual.rb)= +

072b2584bedea82ea8a416587b9fa244

Generated -

Document (metaverse) last generated: Mon Jul 21 02:54:34 +

Document (metaverse) last +generated: Tue Dec 16 00:16:50 -0500 2008 +

Generated by: SiSU 0.70.2 of 2008w50/2 +(2008-12-16) +

Ruby version: ruby 1.8.7 (2008-08-11 patchlevel 72)  [i486-linux] -

- -

0400 2008 -

Generated by: SiSU 0.68.0 of 2008w29/1 (2008-07-21) -

Ruby version: -ruby 1.8.7 (2008-06-20 patchlevel 22)  [i486-linux]

    -.
  1. 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. -
    2. .
  2. 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. -
    3. .
  3. the different heading levels
    4. .
  4. units of text, primarily paragraphs and headings, -also any tables, poems, code-blocks
    5. .
  5. Specification submitted by Adobe to -ISO to become a full open ISO specification <http://www.linux-watch.com/news/NS7542722606.html +.
  6. 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.
    7. .
  7. 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.
    8. .
  8. the different heading levels
    9. .
  9. units of text, primarily +paragraphs and headings, also any tables, poems, code-blocks
    10. .
  10. Specification +submitted by Adobe to ISO to become a full open ISO specification <http://www.linux-watch.com/news/NS7542722606.html >
    11. .
  11. ISO/IEC 26300:2006 @@ -3377,7 +3386,7 @@ of this document:
    pdf: <http://www.jus.uio.no/sisu/sisu/landscape.pdf >
    -
    +
    at: <http://www.jus.uio.no/sisu @@ -3385,15 +3394,15 @@ of this document:
    -
    * Generated by: SiSU 0.70.0 of 2008w48/3 (2008-12-03)
    +
    * Generated by: SiSU 0.70.2 of 2008w50/2 (2008-12-16)
    * Ruby version: ruby 1.8.7 (2008-08-11 patchlevel 72) [i486-linux]
    -
    * Last Generated on: Tue Dec 09 -12:24:07 -0500 2008
    +
    * Last Generated on: Tue Dec 16 +00:16:50 -0500 2008
    * SiSU http://www.jus.uio.no/sisu 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 9e891fcb..1d2e34c6 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 d8cd48cb..4c53ac74 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]
    produces php (zend) [this feature is disabled for the time being] +!_ --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. + 1~command_modifiers command line modifiers !_ --no-ocn
    @@ -203,6 +206,7 @@ strips output text of editor endnotes~[* square brackets ]~ denoted by asterisk !_ --no-dagger
    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]
    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 00000000..06f1ec23 --- /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 67263b68..c3fbf399 100644 --- a/lib/sisu/v0/help.rb +++ b/lib/sisu/v0/help.rb @@ -246,23 +246,23 @@ WOK def commands print < .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: pdf: .TP pdf: +." .TP +." manpage: http://www.jus.uio.no/sisu/sisu/sisu.1 .TP at: .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 -- cgit v1.2.3