documentation related sisu_5.6.0
authorRalph Amissah <ralph@amissah.com>
Fri, 8 Aug 2014 04:37:20 +0000 (00:37 -0400)
committerRalph Amissah <ralph@amissah.com>
Fri, 8 Aug 2014 04:37:20 +0000 (00:37 -0400)
README
data/doc/sisu/markup-samples/manual/_sisu/sisu_document_make
data/doc/sisu/markup-samples/manual/en/sisu_commands.sst
lib/sisu/v5/hub_options.rb
lib/sisu/v6/hub_options.rb
man/man1/sisu.1

diff --git a/README b/README
index aa51a33b9a05713beed7f3babe882c6acd4a8569..5809bc89b5bc3a446eed08ab5890610409377099 100644 (file)
--- a/README
+++ b/README
@@ -81,9 +81,9 @@ specify sisu version for sisu installed via gem
 
   gem search sisu
 
-  sisu _5.5.1_ --version
+  sisu _5.6.0_ --version
 
-  sisu _6.1.1_ --version
+  sisu _6.2.1_ --version
 
 to uninstall sisu installed via gem
 
@@ -233,12 +233,8 @@ more see: <http://sisudoc.org> or <http://www.jus.uio.no/sisu>
 DOCUMENT PROCESSING COMMAND FLAGS
 .................................
 
-*-a [filename/wildcard]*
-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)
+*-[0-9] [filename/wildcard]*
+see --act
 
 *--ao [filename/wildcard/url]*
 assumed for most other flags, creates new intermediate files for processing
@@ -246,6 +242,13 @@ assumed for most other flags, creates new intermediate files for processing
 processing of other output. This step is assumed for most processing flags. To
 skip it see -n. Alias -m.
 
+*--act[0-9] [filename/wildcard]*
+--act0 to --act9 configurable shortcuts for multiple flags, -0 to -9 synonyms,
+configure in sisurc.yml, sisu default action on a specified file where no flag
+is provided is --act0, current default setting for --act0 is --digest --qrcode
+--text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax
+--xml-dom --sqlite --manifest --verbose
+
 *--asciitext [filename/wildcard]*
 asciitext, smart text (not available)
 
@@ -263,9 +266,6 @@ 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.
 
-*-CC*
-see --configure
-
 *-c [filename/wildcard]*
 see --color-toggle
 
@@ -317,6 +317,9 @@ screen.
 *--docbook [filename/wildcard/url]*
 docbook xml
 
+*--dom [filename/wildcard/url]*
+see --xml-dom
+
 *--dump[=directory_path] [filename/wildcard]*
 places output in directory specified, if none is specified in the current
 directory (pwd). Unlike using default settings /HTML/ files have embedded css.
@@ -616,6 +619,9 @@ additional parameters: --db-user='www-data'. 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). Alias -F
 
+*--sax [filename/wildcard/url]*
+see --xml-sax
+
 *--scp [filename/wildcard]*
 copies sisu output files to remote host using scp. This requires that
 sisurc.yml has been provided with information on hostname and username, and
@@ -843,44 +849,6 @@ kills data" and drops (/PostgreSQL/ or /SQLite/) db, tables & indexes [ -d
 
 The -v is for verbose output.
 
-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.
-
-*-0 to -5 [filename or wildcard]*
-Default shorthand mappings (note that the defaults can be changed/configured in
-the sisurc.yml file):
-
-*-0*
--NQhewpotbxXyYv [this is the default action run when no options are give, i.e.
-on 'sisu [filename]']
-
-*-1*
--Qhewpoty
-
-*-2*
--NQhewpotbxXy
-
-*-3*
--NQhewpotbxXyY
-
-*-4*
--NQhewpotbxXDyY --update
-
-*-5*
--NQhewpotbxXDyYv --update
-
-add -v for verbose mode and -c to toggle color state, e.g. sisu -2vc [filename
-or wildcard]
-
-consider -u for appended url info or -v for verbose output
-
 COMMAND LINE WITH FLAGS - BATCH PROCESSING
 ..........................................
 
index 3a4c8b9f77dd88c050d7df82aabfc873db116b89..2327875e395b19ab6b0db4f5e27884009c674a74 100644 (file)
@@ -3,7 +3,7 @@
  :breaks: new=C; break=1
  :bold: /Debian|Ruby|SiSU/
  :italics: /Linux|GPL|GPLv3|LaTeX|PostgreSQL|SQLite|SQL|Vim|ascii|plaintext|UTF-?8|HTML|XHTML|XML|EPUB|OpenDocument|ODF|ODT|PDF|pgSQL|TeXinfo|YAML|YML|OCN|object citation system|object citation numbering|granular search|Dublin Core/
- :substitute: /${sisu_stable}/,'5.5.4'  /${sisu_dev}/,'6.1.4' /${debian_stable}/,'*{Wheezy}*' /${debian_testing}/,'*{Jessie}*'
+ :substitute: /${sisu_stable}/,'5.6.0'  /${sisu_dev}/,'6.2.1' /${debian_stable}/,'*{Wheezy}*' /${debian_testing}/,'*{Jessie}*'
  :home_button_text: {SiSU}http://sisudoc.org; {git}http://git.sisudoc.org
  :footer: {SiSU}http://sisudoc.org; {git}http://git.sisudoc.org
 
index 7af331615dc73b0807db7ac32cc84660b6e5097c..2de5ff43cad7313895be67df764cf4f852871807 100644 (file)
@@ -37,12 +37,15 @@ SiSU is a document publishing system, that from a simple single marked-up docume
 
 2~ Document Processing Command Flags
 
-!_ -a [filename/wildcard] \\
-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)
+!_ -[0-9] [filename/wildcard] \\
+see --act
 
 !_ --ao [filename/wildcard/url] \\
 assumed for most other flags, creates new intermediate files for processing (abstract objects, document abstraction) that is used in all subsequent processing of other output. This step is assumed for most processing flags. To skip it see -n. Alias -m.
 
+!_ --act[0-9] [filename/wildcard] \\
+--act0 to --act9 configurable shortcuts for multiple flags, -0 to -9 synonyms, configure in sisurc.yml, sisu default action on a specified file where no flag is provided is --act0, current default setting for --act0 is --digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --sqlite --manifest --verbose
+
 !_ --asciitext [filename/wildcard] \\
 asciitext, smart text (not available)
 
@@ -55,9 +58,6 @@ see --output-by-*
 !_ -C \\
 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.
 
-!_ -CC \\
-see --configure
-
 !_ -c [filename/wildcard] \\
 see --color-toggle
 
@@ -94,6 +94,9 @@ document digest or document content certificate ( DCC ) as sha digest tree of th
 !_ --docbook [filename/wildcard/url] \\
 docbook xml
 
+!_ --dom [filename/wildcard/url] \\
+see --xml-dom
+
 !_ --dump[=directory_path] [filename/wildcard] \\
 places output in directory specified, if none is specified in the current directory (pwd). Unlike using default settings HTML files have embedded css. Compare --redirect
 
@@ -324,6 +327,9 @@ see --source
 !_ --sample-search-form [--db-(pg|sqlite)] \\
 generate examples of (naive) cgi search form for SQLite or PgSQL depends on your already having used sisu to populate an SQLite 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 --sqlite & --pg and the database section below. Optional additional parameters: --db-user='www-data'. 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). Alias -F
 
+!_ --sax [filename/wildcard/url] \\
+see --xml-sax
+
 !_ --scp [filename/wildcard] \\
 copies sisu output files to remote host using scp. 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. Also see --rsync. Alias -r
 
@@ -484,36 +490,6 @@ kills data" and drops (PostgreSQL or SQLite) db, tables & indexes [ -d --dropall
 
 The -v 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.
-
-!_ -0 to -5 [filename or wildcard] \\
-Default shorthand mappings (note that the defaults can be changed/configured in the sisurc.yml file):
-
-!_ -0 \\
--NQhewpotbxXyYv [this is the default action run when no options are give, i.e. on 'sisu [filename]']
-
-!_ -1 \\
--Qhewpoty
-
-!_ -2 \\
--NQhewpotbxXy
-
-!_ -3 \\
--NQhewpotbxXyY
-
-!_ -4 \\
--NQhewpotbxXDyY --update
-
-!_ -5 \\
--NQhewpotbxXDyYv --update
-
-add -v for verbose mode and -c to toggle color state, e.g. sisu -2vc [filename or wildcard]
-
-consider -u for appended url info or -v for verbose output
-
 2~ Command Line with Flags - Batch Processing
 
 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.
index c079915b299db84a4f7cb480f2b9fbb1c2aebcc7..d822ebd53f2c114f0007b7a4bf8df9193253d262 100644 (file)
@@ -1117,11 +1117,11 @@ end
           { bool: false, set: :na }
         end
         act[:xml_sax]=(select_arr.inspect \
-        =~/"--xml-sax"/) \
+        =~/"--xml-sax"|"--sax"/) \
         ? { bool: true, set: :on }
         : { bool: false, set: :na }
         act[:xml_dom]=(select_arr.inspect \
-        =~/"--xml-dom"/) \
+        =~/"--xml-dom"|"--dom"/) \
         ? { bool: true, set: :on }
         : { bool: false, set: :na }
         act[:xml_docbook_book]=(select_arr.inspect \
index 09559507057dec08ef0323ac9cf7ba0ea556e881..acd95612d67cf0b6973f5ece882445d99e97c326 100644 (file)
@@ -1117,11 +1117,11 @@ end
           { bool: false, set: :na }
         end
         act[:xml_sax]=(select_arr.inspect \
-        =~/"--xml-sax"/) \
+        =~/"--xml-sax"|"--sax"/) \
         ? { bool: true, set: :on }
         : { bool: false, set: :na }
         act[:xml_dom]=(select_arr.inspect \
-        =~/"--xml-dom"/) \
+        =~/"--xml-dom"|"--dom"/) \
         ? { bool: true, set: :on }
         : { bool: false, set: :na }
         act[:xml_docbook_book]=(select_arr.inspect \
index 5cc2c7d9f76b36e02d1a94ff9a8bdf8472143014..608f69a2a92a9674bd954c64980ddcf193fd997f 100644 (file)
@@ -1,4 +1,4 @@
-.TH "sisu" "1" "2014-07-22" "5.5.2" "SiSU"
+.TH "sisu" "1" "2014-02-05" "6.2.1" "SiSU"
 .br
 .SH NAME
 .br
@@ -128,14 +128,8 @@ document structure information. For more see: <http://sisudoc.org> or
 .SH DOCUMENT PROCESSING COMMAND FLAGS
 
 .TP
-.B -a [filename/wildcard]
-produces
-.I 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)
+.B -[0-9] [filename/wildcard]
+see --act
 .TP
 .B --ao [filename/wildcard/url]
 assumed for most other flags, creates new intermediate files for processing
@@ -143,6 +137,13 @@ assumed for most other flags, creates new intermediate files for processing
 processing of other output. This step is assumed for most processing flags. To
 skip it see -n. Alias -m.
 .TP
+.B --act[0-9] [filename/wildcard]
+--act0 to --act9 configurable shortcuts for multiple flags, -0 to -9 synonyms,
+configure in sisurc.yml, sisu default action on a specified file where no flag
+is provided is --act0, current default setting for --act0 is --digest --qrcode
+--text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax
+--xml-dom --sqlite --manifest --verbose
+.TP
 .B --asciitext [filename/wildcard]
 asciitext, smart text (not available)
 .TP
@@ -160,9 +161,6 @@ 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.
 .TP
-.B -CC
-see --configure
-.TP
 .B -c [filename/wildcard]
 see --color-toggle
 .TP
@@ -214,6 +212,9 @@ screen.
 .B --docbook [filename/wildcard/url]
 docbook xml
 .TP
+.B --dom [filename/wildcard/url]
+see --xml-dom
+.TP
 .B --dump[=directory_path] [filename/wildcard]
 places output in directory specified, if none is specified in the current
 directory (pwd). Unlike using default settings
@@ -531,6 +532,9 @@ is first necessary to create them, before generating the search form) see
 which must be writable, (with screen instructions given that they be copied to
 the cgi-bin directory). Alias -F
 .TP
+.B --sax [filename/wildcard/url]
+see --xml-sax
+.TP
 .B --scp [filename/wildcard]
 copies sisu output files to remote host using scp. This requires that
 sisurc.yml has been provided with information on hostname and username, and
@@ -802,45 +806,6 @@ equivalent]
 
 .BR
 The -v is for verbose output.
-.SH SHORTCUTS, SHORTHAND FOR MULTIPLE FLAGS
-
-.TP
-.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 different
-outputs of different files, and just want to do the same again.
-.TP
-.B -0 to -5 [filename or wildcard]
-Default shorthand mappings (note that the defaults can be changed/configured in
-the sisurc.yml file):
-.TP
-.B -0
--NQhewpotbxXyYv [this is the default action run when no options are give, i.e.
-on 'sisu [filename]']
-.TP
-.B -1
--Qhewpoty
-.TP
-.B -2
--NQhewpotbxXy
-.TP
-.B -3
--NQhewpotbxXyY
-.TP
-.B -4
--NQhewpotbxXDyY --update
-.TP
-.B -5
--NQhewpotbxXDyYv --update
-
-.BR
-add -v for verbose mode and -c to toggle color state, e.g. sisu -2vc [filename
-or wildcard]
-
-.BR
-consider -u for appended url info or -v for verbose output
 .SH COMMAND LINE WITH FLAGS - BATCH PROCESSING
 
 
@@ -1926,7 +1891,7 @@ information in each column
 .BR
 
 .B markup example:
-[^10]
+[^9]
 .nf
 !_ Table 3.1: Contributors to Wikipedia, January 2001 - June 2005