aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/sisu/html/sisu.1.html
diff options
context:
space:
mode:
Diffstat (limited to 'data/doc/sisu/html/sisu.1.html')
-rw-r--r--data/doc/sisu/html/sisu.1.html241
1 files changed, 121 insertions, 120 deletions
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: &lt;<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
&gt;
@@ -180,40 +180,38 @@ and the same document structure information. For more see: &lt;<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 [ &nbsp;-A &nbsp;for &nbsp;equivalent
-&nbsp;dos &nbsp;(linefeed) &nbsp;output &nbsp;file] [see &nbsp;-e &nbsp;for &nbsp;-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)
+&nbsp;dos &nbsp;(linefeed) &nbsp;output &nbsp;file] [see &nbsp;-e &nbsp;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 &rsquo;true&rsquo;, output to screen will be with colour, if sisurc
-colour default is set to &rsquo;false&rsquo; 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 &rsquo;true&rsquo;, output to screen will be with colour, if sisurc colour default is
+set to &rsquo;false&rsquo; 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 &nbsp;version &nbsp;2 &nbsp;only] (filename.epub). Alias -e
+an epub document, [sisu &nbsp;version &nbsp;&gt;=2 &nbsp;] (filename.epub). Alias -e
<p> </dd>
<dt><b>-e [filename/wildcard]</b>
@@ -264,35 +262,57 @@ an epub document, [sisu &nbsp;version &nbsp;2 &nbsp;only] (filename.epub). Alias
<p>see --epub
<p> </dd>
+<dt><b>--find [optional &nbsp;string &nbsp;part &nbsp;of &nbsp;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 &nbsp;string &nbsp;part &nbsp;of &nbsp;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 &nbsp;string &nbsp;part &nbsp;of &nbsp;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 &nbsp;string &nbsp;part &nbsp;of &nbsp;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
-[ &nbsp;-A &nbsp;for &nbsp;equivalent &nbsp;dos &nbsp;(linefeed) &nbsp;output &nbsp;file] [see &nbsp;-e &nbsp;for &nbsp;-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
+[ &nbsp;-A &nbsp;for &nbsp;equivalent &nbsp;dos &nbsp;(linefeed) &nbsp;output &nbsp;file] [see &nbsp;-e &nbsp;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 &nbsp;(*.termsheet.rb)]</b> </dt>
-<dd>standard form document builder,
-
-<p>preprocessing feature
-<p> </dd>
+<dt><b>-T [filename/wildcard
+&nbsp;(*.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&rsquo;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: &nbsp;the &nbsp;webrick &nbsp;server
-&nbsp;requires &nbsp;link &nbsp;suffixes, &nbsp;so &nbsp;html &nbsp;output &nbsp;should &nbsp;be &nbsp;created &nbsp;using &nbsp;the &nbsp;-h &nbsp;option
-&nbsp;rather &nbsp;than -H &nbsp;; &nbsp;also, &nbsp;note &nbsp;-F &nbsp;webrick &nbsp;]. Alias -W
+<dd>starts ruby&rsquo;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: &nbsp;the &nbsp;webrick
+&nbsp;server &nbsp;requires &nbsp;link &nbsp;suffixes, &nbsp;so &nbsp;html &nbsp;output &nbsp;should &nbsp;be &nbsp;created &nbsp;using &nbsp;the
+&nbsp;-h &nbsp;option &nbsp;rather &nbsp;than and search -H &nbsp;; &nbsp;also, &nbsp;note &nbsp;-F &nbsp;webrick &nbsp;]. 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 &nbsp;announcement &nbsp;this &nbsp;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 &nbsp;announcement &nbsp;this
+&nbsp;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 &nbsp;type &nbsp;(pgsql &nbsp;or &nbsp;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) [ &nbsp;-dv &nbsp;--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
-&rsquo;createdb [database &nbsp;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.
-
+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 &nbsp;name]&rsquo; where database name would be
+SiSU_[present &nbsp;working &nbsp;directory &nbsp;name (without &nbsp;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) [ &nbsp;-dv &nbsp;--import &nbsp;sqlite &nbsp;equivalent]
+<dd>[filename/wildcard] imports data specified
+to postgresql db (rb.dbi) [ &nbsp;-dv &nbsp;--import &nbsp;sqlite &nbsp;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 &nbsp;text]</b> Top level heading [this &nbsp;usually &nbsp;has &nbsp;similar &nbsp;content
-&nbsp;to &nbsp;the title &nbsp;@title: &nbsp;] NOTE: the heading levels described here are in 0.38
-notation, see heading
+&nbsp;to &nbsp;the &nbsp;] NOTE: the heading levels described here are in 0.38 notation, see heading
<p> <br>
<b>:B~ [heading &nbsp;text]</b> Second level heading [this &nbsp;is &nbsp;a &nbsp;heading &nbsp;level &nbsp;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 &nbsp;later &nbsp;time]
+option &nbsp;to &nbsp;number &nbsp;each &nbsp;line &nbsp;of &nbsp;code &nbsp;may &nbsp;be &nbsp;considered &nbsp;at some &nbsp;later &nbsp;time]
+
<p> <br>
<b>use of code tags instead of poem compared, resulting output:</b>
<p> <br>