diff options
Diffstat (limited to 'data/doc/sisu')
| -rw-r--r-- | data/doc/sisu/CHANGELOG_v3 | 67 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu.1.html | 515 | ||||
| -rw-r--r-- | data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst | 230 | ||||
| -rw-r--r-- | data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst | 29 |
4 files changed, 499 insertions, 342 deletions
diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index 7f2093b0..7978dc09 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -13,12 +13,73 @@ Reverse Chronological: %% Development branch UNSTABLE v3 branch once stable will supersede & replace current stable v2 branch +%% 3.0.14.orig.tar.gz (2011-07-26:30/2) +http://git.sisudoc.org/?p=code/sisu.git;a=log;h=refs/tags/debian/3.0.14-1 +http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.14.orig.tar.gz + sisu_3.0.14.orig.tar.gz + sisu_3.0.14-1.dsc + sisu_3.0.14-1.debian.tar.gz + + * hanging indent partially implemented, added markup possibilities + + __[1-9] hanging indent (initial indent 0); paragraph text indent [1-9] + + _[0-9]?_[1-9] initial indent; paragraph text indent + + * done: dal, plaintext, css, html, epub, xhtml, xml sax, xml dom, pdf, sql; + not done: odf, man, info + check: po4a, html_lite (used in sql search results) + * syntax highlighting done: vim (sisu.vim), emacs (sisu-mode.el) + + * indent added bold words markup syntax (_[1-9]!) (_[0-9]?_[1-9]!) + for indents + + __[1-9]! bold words + part of hanging indent paragraph text + + __[1-9]! bold words \\ part of hanging indent paragraph text + + * param, manifest, qrcode, epub, added creator.editor field + + * sql db, constants, cgi-sql, structure changed, creator editor field added + + * sisu_manual, manpage, manpage html (man2html) + * sisu_commands: --qrcode -Q; update shortcut options; line-breaks use \\ + * sisu_markup.sst: indent update; publisher + + * vim sisu syntax highlighting + * markers for hanging indent added + * added header for @creator: :editor: + * minor comments added + * deletion of an unused tag + + * emacs sisu-mode.el + * markers for hanging indent added + * line-break + + * qrcode, sysenv, manifest, generate & add QR code images of metadata to + manifest (using qrencode) (consider where and how else to use images) + + * epub, opf fixes + + * sysenv, avoid creation of spurious directories in output tree + (an image copy section removed, re-implement correctly later) + + * param, cleanup setting of auto endnotes + + * texpdf, XeTeX language settings ((setmainlanguage setotherlanguage) from + directory or filename) if @make: :language: header not set + + * xmls (sax, dom, xhtml) use of xml tidy, correct output file location + + * urls, --concordance + %% 3.0.13.orig.tar.gz (2011-06-26:25/7) http://git.sisudoc.org/?p=code/sisu.git;a=log;h=refs/tags/debian/3.0.13-1 http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.13.orig.tar.gz - sisu_3.0.13.orig.tar.gz - sisu_3.0.13-1.dsc - sisu_3.0.13-1.debian.tar.gz + 33d2358a39a69c1be4403b06b52eaeca604e851ee4e32c6f1625399944362fea 1943441 sisu_3.0.13.orig.tar.gz + c741399aa3da6189854f7a532eae6db27370646a2b86b7427bf330401369bc13 1223 sisu_3.0.13-1.dsc + 0fe5173e4973a4af7fba79dcf5ae3c702f34b5ac89e02f4be9e014641e7514d0 289790 sisu_3.0.13-1.debian.tar.gz * dal_syntax, linebreak within regular objects is \\ (<br> depreciated) [test, affects downstream outputs, there is the potential for breakage] diff --git a/data/doc/sisu/html/sisu.1.html b/data/doc/sisu/html/sisu.1.html index fb74b10d..33529bfc 100644 --- a/data/doc/sisu/html/sisu.1.html +++ b/data/doc/sisu/html/sisu.1.html @@ -179,39 +179,39 @@ and the same document structure information. For more see: <<a href='http://w <dt><b>-a [filename/wildcard]</b> </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 (Options include: --endnotes for endnotes ---footnotes for footnotes at the end of each paragraph --unix for unix linefeed -(default) --msdos for msdos linefeed) +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) <p> </dd> <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> @@ -271,6 +271,7 @@ language subdirectories). Alias -f, --glob, -G <dt><b>-F [--webserv=webrick]</b> </dt> <dd>see --sample-search-form + <p> </dd> <dt><b>-f [optional string part of filename]</b> </dt> @@ -339,8 +340,7 @@ file (scroll.html). Alias -h <dt><b>--keep-processing-files [filename/wildcard/url]</b> </dt> -<dd> -<p>see --maintenance +<dd>see --maintenance <p> </dd> <dt><b>-L</b> </dt> @@ -362,8 +362,7 @@ indicated. (also see -V). Aliases -M and --keep-processing-files <p> </dd> <dt><b>-M [filename/wildcard/url]</b> </dt> -<dd> -<p>see --maintenance +<dd>see --maintenance <p> </dd> <dt><b>-m [filename/wildcard/url]</b> </dt> @@ -440,26 +439,33 @@ directory structure to multilingual. v3, experimental <dd>see --pdf <p> </dd> +<dt><b>--qrcode [filename/wildcard]</b> +</dt> +<dd>generate QR code image of metadata (used in manifest). v3 only. +<p> </dd> + <dt><b>--quiet [filename/wildcard]</b> </dt> <dd>quiet less output to screen. <p> </dd> -<dt><b>-q [filename/wildcard]</b> </dt> -<dd>see --quiet +<dt><b>-Q [filename/wildcard]</b> </dt> +<dd>see --qrcode <p> </dd> -<dt><b>--rsync [filename/wildcard]</b> +<dt><b>-q [filename/wildcard]</b> </dt> -<dd>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 +<dd>see --quiet +<p> </dd> -<p>- -<p>R +<dt><b>--rsync [filename/wildcard]</b> </dt> +<dd>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 <p> </dd> <dt><b>-R [filename/wildcard]</b> </dt> @@ -470,25 +476,22 @@ the rsync --delete parameter is sent, useful for cleaning the remote directory <dd>see --scp <p> </dd> -<dt><b>--sample-search-form -[--webserv=webrick]</b> </dt> -<dd>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 --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) provides some information -on setting up hyperestraier for sisu. Alias -F +<dt><b>--sample-search-form [--webserv=webrick]</b> </dt> +<dd>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 --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). Alias -F <p> </dd> <dt><b>--scp [filename/wildcard]</b> </dt> -<dd>copies -sisu output files to remote host using scp. This requires that sisurc.yml +<dd>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 <p> </dd> @@ -511,8 +514,7 @@ option. Note: (this option is tested only with zsh). Alias -S <p> </dd> <dt><b>--sisupod [filename/wildcard]</b> </dt> -<dd>produces -a zipped file of the prepared document specified along with associated +<dd>produces a zipped file of the prepared document specified along with associated images, by default named sisupod.zip they may alternatively be named with the filename extension .ssp This provides a quick way of gathering the relevant parts of a sisu document which can then for example be emailed. A sisupod @@ -541,8 +543,7 @@ file to output directory. Alias -s <dt><b>-S [filename/wildcard]</b> </dt> -<dd> -<p>see --sisupod +<dd>see --sisupod <p> </dd> <dt><b>-s [filename/wildcard]</b> </dt> @@ -563,56 +564,56 @@ are omitted), has footnotes at end of each paragraph that contains them --unix for unix linefeed (default) --msdos for msdos linefeed). Alias -t <p> </dd> -<dt><b>-T [filename/wildcard - (*.termsheet.rb)]</b> </dt> +<dt><b>-T [filename/wildcard (*.termsheet.rb)]</b> </dt> <dd>standard form document builder, preprocessing feature -<p> -</dd> +<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 +<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> -<dd>provides url mapping of output files for the flags requested for processing, -also see -U +<dd>provides url mapping of output files for the flags +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> -<dd>invokes -the sisu v3 document parser/generator. Currently under development and incomplete, -v3 requires >= ruby1.9.2p180. You may run sisu3 instead. +<dd>invokes the sisu v3 document parser/generator. Currently +under development and incomplete, v3 requires >= ruby1.9.2p180. You may run +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> @@ -621,6 +622,7 @@ provides <b>SiSU</b> version and environment information (sisu --help env) <dt><b>-v</b> </dt> <dd>on its own, provides <b>SiSU</b> version information + <p> </dd> <dt><b>-v [filename/wildcard]</b> </dt> @@ -628,11 +630,11 @@ provides <b>SiSU</b> version and environment information (sisu --help env) <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 and search -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 -H ; also, note -F webrick ]. Alias -W <p> </dd> <dt><b>-W</b> </dt> @@ -645,16 +647,17 @@ webserver points at sisu output directories, the default port is set to <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> @@ -670,23 +673,24 @@ XML output with 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. 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> @@ -750,24 +754,23 @@ and underscores. <dt><b>--pg -v --import</b> </dt> <dd>[filename/wildcard] imports data specified -to postgresql db (rb.dbi) [ -dv --import sqlite equivalent] +to postgresql db (rb.dbi) [ -dv and search --import sqlite equivalent] <p> </dd> <dt><b>--pg -v --update</b> </dt> -<dd>[filename/wildcard] -updates/imports specified data to postgresql db (rb.dbi) [ -dv --update sqlite - equivalent] +<dd>[filename/wildcard] updates/imports specified data to postgresql +db (rb.dbi) [ -dv --update sqlite equivalent] <p> </dd> <dt><b>--pg --remove</b> </dt> <dd>[filename/wildcard] removes specified data to postgresql -db (rb.dbi) [ -d --remove sqlite equivalent] +db (rb.dbi) [ -d --remove sqlite equivalent] + <p> </dd> <dt><b>--pg --dropall</b> </dt> -<dd>kills data" and drops -(postgresql or sqlite) db, tables & indexes [ -d --dropall sqlite equivalent] - +<dd>kills data" and drops (postgresql or sqlite) db, tables & indexes +[ -d --dropall sqlite equivalent] <p> <br> The -v is for verbose output. <p> </dd> @@ -790,39 +793,37 @@ and just want to do the same again. <dt><b>-0 to -5 [filename or wildcard]</b> </dt> <dd>Default -shorthand mappings (note that the defaults can be changed/configured in -the sisurc.yml file): +shorthand mappings (for v3, note that the defaults can be changed/configured +in the sisurc.yml file): <p> </dd> <dt><b>-0</b> </dt> -<dd>-mNhwpAobxXyYv [this is the default action run when - no i.e. on ’sisu [filename]’] +<dd>-NQhewpotbxXyYv [this is the default action run + when no options are give, i.e. on ’sisu [filename]’] <p> </dd> <dt><b>-1</b> </dt> -<dd>-mhewpy +<dd>-Qhewpoty <p> </dd> <dt><b>-2</b> </dt> -<dd>-mhewpaoy +<dd>-NQhewpotbxXy + <p> </dd> <dt><b>-3</b> </dt> -<dd>-mhewpAobxXyY +<dd>-NQhewpotbxXyY <p> </dd> <dt><b>-4</b> </dt> -<dd>-mhewpAobxXDyY - -<p>- -<p>- -<p>import +<dd>-NQhewpotbxXDyY --update <p> </dd> <dt><b>-5</b> </dt> -<dd>-mhewpAobxXDyY --update +<dd>-NQhewpotbxXDyYv --update <p> <br> -add -v for verbose mode and -c for color, e.g. sisu -2vc [filename or +add -v for verbose mode and -c to toggle color state, e.g. sisu -2vc [filename + or wildcard] <p> <br> <p>consider -u for appended url info or -v for verbose output @@ -1058,7 +1059,9 @@ similar to this one: <pre> % SiSU master 2.0 @title: SiSU :subtitle: Manual - @creator: :author: Amissah, Ralph + @creator: + :author: Amissah, Ralph + @publisher: [publisher name] @rights: Copyright (C) Ralph Amissah 2007, License GPL 3 @classify: :type: information @@ -1209,7 +1212,8 @@ 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 ] NOTE: the heading levels described here are in 0.38 notation, see heading + to the title @title: ] 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] @@ -1225,7 +1229,7 @@ are given (a number), otherwise takes the form 1~my_filename_for_this_segment <p> <br> <b>2~ [heading text]</b> Second level heading preceding substantive text of document -or sub-heading 3 , the heading level that would normally be marked 1.1 or +or sub-heading 3, the heading level that would normally be marked 1.1 or 1.2 or 1.3 or 2.1 etc. in a document. <p> <br> <b>3~ [heading text]</b> Third level heading preceding substantive text of document, @@ -1267,21 +1271,21 @@ html +{inserted text}+ - \-{strikethrough}\- + -{strikethrough}- #{monospace}# </pre> <p> <br> <b>resulting output:</b> <p> <br> -normal text, <b>emphasis,</b> <b>bold text,</b> <i>italics,</i> <i>underscore</i> , "citation", ^superscript^, +normal text, <b>emphasis,</b> <b>bold text,</b> <i>italics,</i> <i>underscore,</i> "citation", ^superscript^, [subscript], ++inserted text++, --strikethrough--, monospace <p> <br> <p>normal text <p> <br> -<b>emphasis</b> [note: can be configured to be represented by bold, italics or - underscore] +<b>emphasis</b> [note: can be configured to be represented by bold, italics italics + or underscore] or underscore] <p> <br> <p><b>bold text</b> @@ -1362,7 +1366,29 @@ Numbered List (not to be confused with headings/titles, (document structure)) _# numbered list numbered list indented a., b., c., d., etc. </pre> <p> -<h2><a name='sect28' href='#toc28'>9.4 Footnotes / Endnotes</a></h2> +<h2><a name='sect28' href='#toc28'>9.4 Hanging Indents</a></h2> + +<p> <br> +<b>markup example:</b> +<p> <br> +<pre> _0_1 first line no indent, + rest of paragraph indented one step + _1_0 first line indented, + rest of paragraph no indent + in each case level may be 0-9 +</pre> +<p> <br> +<b>resulting output:</b> +<p> <br> + first line no indent, rest of paragraph indented one step<br> + +<p> <br> +first line indented, rest of paragraph no indent +<p> <br> + +<p>in each case level may be 0-9 +<p> +<h2><a name='sect29' href='#toc29'>9.5 Footnotes / Endnotes</a></h2> <p> <br> Footnotes and endnotes are marked up at the location where they would be @@ -1428,11 +1454,11 @@ normal text [^+2] continues <p>the standard and pair notation cannot be mixed in the same document <p> -<h2><a name='sect29' href='#toc29'>9.5 +<h2><a name='sect30' href='#toc30'>9.6 Links</a></h2> <p> -<h2><a name='sect30' href='#toc30'>9.5.1 Naked Urls Within Text, Dealing with Urls</a></h2> +<h2><a name='sect31' href='#toc31'>9.6.1 Naked Urls Within Text, Dealing with Urls</a></h2> <p> <br> urls found within text are marked up automatically. A url within text is @@ -1479,7 +1505,7 @@ where a code block is used there is neither decoration nor hyperlinking, deb-src http://www.jus.uio.no/sisu/archive unstable main non-free </pre> <p> -<h2><a name='sect31' href='#toc31'>9.5.2 Linking Text</a></h2> +<h2><a name='sect32' href='#toc32'>9.6.2 Linking Text</a></h2> <p> <br> @@ -1509,9 +1535,6 @@ aboutSiSU <<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> <p> <br> about SiSU <<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> > [^14] markup -<p> -<h2><a name='sect32' href='#toc32'>9.5.3 Linking Images</a></h2> - <p> <br> <b>markup example:</b> <p> <br> @@ -1561,10 +1584,10 @@ note at a heading level the same is automatically achieved by providing names to headings 1, 2 and 3 i.e. 2~[name] and 3~[name] or in the case of auto-heading numbering, without further intervention. <p> -<h2><a name='sect33' href='#toc33'>9.6 Grouped Text</a></h2> +<h2><a name='sect33' href='#toc33'>9.7 Grouped Text</a></h2> <p> -<h2><a name='sect34' href='#toc34'>9.6.1 +<h2><a name='sect34' href='#toc34'>9.7.1 Tables</a></h2> <p> <br> @@ -1609,7 +1632,7 @@ Tables</a></h2> No. of articles, all languages | 25| 19,000| 138,000| 490,000| 862,000|1,600,000 \* Contributed at least ten times; \** at least 5 times in last month; -\* more than 100 times in last month. +\*\** more than 100 times in last month. </pre> <p> <br> <b>resulting output:</b> @@ -1622,7 +1645,7 @@ Tables</a></h2> * Contributed at least ten times; ** at least 5 times in last month; *** more than 100 times in last month. <p> -<h2><a name='sect35' href='#toc35'>9.6.2 Poem</a></h2> +<h2><a name='sect35' href='#toc35'>9.7.2 Poem</a></h2> <p> <br> <b>basic markup:</b> @@ -1774,7 +1797,7 @@ more than 100 times in last month. <br> <p> -<h2><a name='sect36' href='#toc36'>9.6.3 Group</a></h2> +<h2><a name='sect36' href='#toc36'>9.7.3 Group</a></h2> <p> <br> <b>basic markup:</b> @@ -1930,7 +1953,7 @@ more than 100 times in last month. <br> <p> -<h2><a name='sect37' href='#toc37'>9.6.4 Code</a></h2> +<h2><a name='sect37' href='#toc37'>9.7.4 Code</a></h2> <p> <br> Code tags code{ ... }code (used as with other group tags described above) @@ -2040,11 +2063,11 @@ opening code tag code{# as demonstrated here: 44 | death."’ </pre> <p> -<h2><a name='sect38' href='#toc38'>9.7 Additional Breaks - Linebreaks Within Objects, Column and Page-breaks</a></h2> +<h2><a name='sect38' href='#toc38'>9.8 Additional Breaks - Linebreaks Within Objects, Column and Page-breaks</a></h2> <p> -<h2><a name='sect39' href='#toc39'>9.7.1 Line-breaks</a></h2> +<h2><a name='sect39' href='#toc39'>9.8.1 Line-breaks</a></h2> <p> <br> To break a line within a "paragraph object", two backslashes \\ with a space @@ -2060,7 +2083,7 @@ The html break br enclosed in angle brackets (though undocumented) is available in versions prior to 3.0.13 and 2.9.7 (it remains available for the time being, but is depreciated). <p> -<h2><a name='sect40' href='#toc40'>9.7.2 Page Breaks</a></h2> +<h2><a name='sect40' href='#toc40'>9.8.2 Page Breaks</a></h2> <p> <br> Page breaks are only relevant and honored in some output formats. A page @@ -2081,7 +2104,7 @@ page new <:pn> breaks the page, starts a new page. page break <:pb> breaks a column, starts a new column, if using columns, else breaks the page, starts a new page. <p> -<h2><a name='sect41' href='#toc41'>9.8 Book Index</a></h2> +<h2><a name='sect41' href='#toc41'>9.9 Book Index</a></h2> <p> <br> To make an index append to paragraph the book index term relates to it, @@ -2337,9 +2360,9 @@ text follows levels 1,2,3 and it is ’nice’ to do most work in those <p> <br> this is captured by the following file ’rename’ instruction: <p> <br> -<pre> rename ’s/.s[123]$/.sst/’ *.s{1,2,3} - rename ’s/.r[123]$/.ssm/’ *.r{1,2,3} - rename ’s/.si$/.ssi/’ *.si +<pre> rename ’s/\.s[123]$/\.sst/’ *.s{1,2,3} + rename ’s/\.r[123]$/\.ssm/’ *.r{1,2,3} + rename ’s/\.si$/\.ssi/’ *.si </pre> <p> <br> The internal document markup remains unchanged, from <b>SiSU</b> 0.16 @@ -2398,7 +2421,7 @@ be located locally or on a remote server for which a url is provided. <h2><a name='sect47' href='#toc47'>12.1.1 Sisu Text - Regular Files (.sst)</a></h2> <p> <br> -The most common form of document in <b>SiSU</b> , see the section on <b>SiSU</b> markup. +The most common form of document in <b>SiSU,</b> see the section on <b>SiSU</b> markup. <p> <br> <<a href='http://www.sisudoc.org/sisu/sisu_markup'>http://www.sisudoc.org/sisu/sisu_markup</a> @@ -2716,7 +2739,7 @@ list) may be found in: <p> <br> CSS files to modify the appearance of <b>SiSU</b> html, XHTML or XML may be placed -in the configuration directory: ./_sisu/css ; ~/.sisu/css or; /etc/sisu/css +in the configuration directory: ./_sisu/css; ~/.sisu/css or; /etc/sisu/css and these will be copied to the output directories with the command sisu -CC. <p> <br> @@ -2889,8 +2912,9 @@ streamed to four tables: <p> <br> * another the substantive texts by individual "paragraph" (or object) -- along<br> - with structural information, each paragraph being identifiable by its<br> +-<br> + along with structural information, each paragraph being identifiable +by its<br> paragraph number (if it has one which almost all of them do), and the<br> substantive text of each paragraph quite naturally being searchable (both in<br> @@ -2918,14 +2942,15 @@ so as to facilitate ease of searching. <p> <br> Being able to search a relational database at an object level with the <b>SiSU</b> citation system is an effective way of locating content generated -by <b>SiSU</b> object numbers, and all versions of the document have the same -numbering, complex searches can be tailored to return just the locations -of the search results relevant for all available output formats, with live -links to the precise locations in the database or in html/xml documents; -or, the structural information provided makes it possible to search the -full contents of the database and have headings in which search content -appears, or to search only headings etc. (as the Dublin Core is incorporated -it is easy to make use of that as well). +by <b>SiSU.</b> As individual text objects of a document stored (and indexed) together +with object numbers, and all versions of the document have the same numbering, +complex searches can be tailored to return just the locations of the search +results relevant for all available output formats, with live links to the +precise locations in the database or in html/xml documents; or, the structural +information provided makes it possible to search the full contents of the +database and have headings in which search content appears, or to search +only headings etc. (as the Dublin Core is incorporated it is easy to make +use of that as well). <p> <h2><a name='sect75' href='#toc75'>22. Postgresql</a></h2> <br> @@ -3050,7 +3075,8 @@ for <b>SiSU</b> to populate an sqlite database, this being part of <b>SiSU</b> - sisu -d [instruction] [filename/wildcard if required]<br> <p> <br> - sisu -d --(sqlite|pg) --[instruction] [filename/wildcard if required]<br> + sisu -d --(sqlite|pg) --[instruction] [filename/wildcard if <br> + required]<br> <p> <h2><a name='sect86' href='#toc86'>23.4 Commands</a></h2> @@ -3890,8 +3916,9 @@ the<br> <p> <br> NOTE: <p> <br> -[ .B SiSU parses files with long lines or line breaks, display linewrap - (without line-breaks) is a convenient +[ .B SiSU parses files with long lines or line breaks, but, display linewrap + (without line-breaks) is a convenient editor feature to have for sisu markup] + <p> <h2><a name='sect122' href='#toc122'>31. How Does Sisu Work?</a></h2> <br> @@ -3937,8 +3964,8 @@ beyond the Dublin core and easily further extended as required); the headers may also contain processing instructions. <b>SiSU</b> markup is primarily an abstraction of document structure and document metadata to permit taking advantage of the basic strengths of existing alternative practical standard ways -of representing documents [be that paper publication, sql search etc.] (html, -epub, xml, odf, latex, pdf, sql) +of representing documents [be that browser viewing, paper publication, + sql search etc.] (html, epub, xml, odf, latex, pdf, sql) <p> <br> * for output produces reasonably elegant output of established industry and institutionally accepted open standard formats.[3] takes advantage of @@ -3969,8 +3996,7 @@ as<br> <p> <br> * sql - population of an sql database, (at the same object level that -is used<br> - to cite text within a document)<br> +is used to cite text within a document)<br> <p> <br> Also produces: concordance files; document content certificates (md5 or @@ -4029,7 +4055,7 @@ and images and sent as a zip file called a sisupod, if shared on the net * generated document outputs may automatically be posted to remote sites. <p> <br> -* for basic document generation, the only software dependency is <b>Ruby</b> , +* for basic document generation, the only software dependency is <b>Ruby,</b> and a few standard Unix tools (this covers plaintext, HTML, EPUB, XML, ODF, LaTeX). To use a database you of course need that, and to convert the LaTeX generated to pdf, a latex processor like tetex or texlive. @@ -4191,108 +4217,143 @@ may be also be accessed via the html pages[^29] <<a href='http://www.jus.uio.no/sisu/man/sisu_webrick.1.html'>http://www.jus.uio.no/sisu/man/sisu_webrick.1.html</a> ><br> -<p> 1. objects include: headings, paragraphs, verse, tables, images, but not +<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. <p> <br> -2. i.e. the html, pdf, epub, odf outputs are each built individually and optimised +</li><b>.</b><li>i.e. the html, pdf, epub, 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. <p> <br> -3. the different heading levels +</li><b>.</b><li> +<p>the different heading levels <p> <br> -4. units of text, primarily paragraphs and headings, also any tables, poems, +</li><b>.</b><li>units of text, primarily paragraphs and headings, also any tables, poems, <p>code-blocks <p> <br> -5. Specification submitted by Adobe to ISO to become a full open ISO specification +</li><b>.</b><li> +<p>Specification submitted by Adobe to ISO to become a full open ISO specification + +<p> <br> <<a href='http://www.linux-watch.com/news/NS7542722606.html'>http://www.linux-watch.com/news/NS7542722606.html</a> > <p> <br> -6. ISO standard ISO/IEC 26300:2006 +</li><b>.</b><li> +<p>ISO standard ISO/IEC 26300:2006 <p> <br> -7. An open standard format for e-books +</li><b>.</b><li> +<p>An open standard format for e-books <p> <br> -*1. square brackets +</dd> + +<dt><b>*1.</b> </dt> +<dd>square brackets <p> <br> -*2. square brackets +</dd> + +<dt><b>*2.</b> </dt> +<dd>square brackets <p> <br> -+1. square brackets +</dd> + +<dt><b>+1.</b> </dt> +<dd>square brackets <p> <br> -8. <<a href='http://www.jus.uio.no/sisu/man/'>http://www.jus.uio.no/sisu/man/</a> +</li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man/'>http://www.jus.uio.no/sisu/man/</a> > <p> <br> -9. <<a href='http://www.jus.uio.no/sisu/man/sisu.1.html'>http://www.jus.uio.no/sisu/man/sisu.1.html</a> +</li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man/sisu.1.html'>http://www.jus.uio.no/sisu/man/sisu.1.html</a> > <p> <br> -10. From sometime after SiSU 0.58 it should be possible to describe SiSU -markup using SiSU, which though not an original design goal is useful. -<p> -<br> -11. files should be prepared using UTF-8 character encoding +</li><b>.</b><li>From sometime after SiSU 0.58 it should be possible to describe SiSU markup +using SiSU, which though not an original design goal is useful. <p> <br> -12. a footnote or endnote +</li><b>.</b><li> +<p>files should be prepared using UTF-8 character encoding <p> <br> -13. self contained endnote marker & endnote in one +</li><b>.</b><li> +<p>a footnote or endnote <p> <br> -* unnumbered asterisk footnote/endnote, insert multiple asterisks if required +</li><b>.</b><li>self contained endnote marker & endnote in one +<p> <br> +</dd> + +<dt><b>*.</b> </dt> +<dd>unnumbered asterisk footnote/endnote, insert multiple asterisks if required <p> <br> -** another unnumbered asterisk footnote/endnote +</dd> + +<dt><b>**.</b> </dt> +<dd>another unnumbered asterisk footnote/endnote <p> <br> -*3. editors notes, numbered asterisk footnote/endnote series +</dd> + +<dt><b>*3.</b> </dt> +<dd>editors notes, numbered asterisk footnote/endnote series <p> <br> -+2. editors notes, numbered asterisk footnote/endnote series +</dd> + +<dt><b>+2.</b> </dt> +<dd>editors notes, numbered asterisk footnote/endnote series <p> <br> -14 <<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> +</li><b>.</b><li><<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> > <p> <br> -15. <<a href='http://www.ruby-lang.org/en/'>http://www.ruby-lang.org/en/</a> +</li><b>.</b><li><<a href='http://www.ruby-lang.org/en/'>http://www.ruby-lang.org/en/</a> > <p> <br> -16. Table from the Wealth of Networks by Yochai Benkler <<a href='http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler'>http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler</a> +</li><b>.</b><li> +<p>Table from the Wealth of Networks by Yochai Benkler +<p> <br> +<<a href='http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler'>http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler</a> > - <p> <br> -17. .ssc (for composite) is under consideration but ._sst makes clear that -this is not a regular file to be worked on, and thus less likely that people -will have subsequent processing. It may be however that when the resulting -file is shared +</li><b>.</b><li>.ssc (for composite) is under consideration but ._sst makes clear that this +is not a regular file to be worked on, and thus less likely that people +will have "accidents", working on a .ssc file that is overwritten by subsequent +processing. It may be however that when the resulting file is shared .ssc +is an appropriate suffix to use. +<p> <br> +</li><b>.</b><li><<a href='http://www.postgresql.org/'>http://www.postgresql.org/</a> +> <p> <br> -19. <<a href='http://www.postgresql.org/'>http://www.postgresql.org/</a> -> <br> <<a href='http://advocacy.postgresql.org/'>http://advocacy.postgresql.org/</a> > <br> <<a href='http://en.wikipedia.org/wiki/Postgresql'>http://en.wikipedia.org/wiki/Postgresql</a> > <br> -20. <<a href='http://www.hwaci.com/sw/sqlite/'>http://www.hwaci.com/sw/sqlite/</a> -> <br> +</li><b>.</b><li><<a href='http://www.hwaci.com/sw/sqlite/'>http://www.hwaci.com/sw/sqlite/</a> +> +<p> <br> <<a href='http://en.wikipedia.org/wiki/Sqlite'>http://en.wikipedia.org/wiki/Sqlite</a> > <br> -21. <<a href='http://search.sisudoc.org'>http://search.sisudoc.org</a> +</li><b>.</b><li><<a href='http://search.sisudoc.org'>http://search.sisudoc.org</a> > <p> <br> -22. (which could be extended further with current back-end). As regards scaling +</li><b>.</b><li>(which could be extended further with current back-end). As regards scaling of the database, it is as scalable as the database (here Postgresql) and hardware allow. <p> <br> -23. of this feature when demonstrated to an IBM software innovations evaluator +</li><b>.</b><li>of this feature when demonstrated to an IBM software innovations evaluator in 2004 he said to paraphrase: this could be of interest to us. We have large document management systems, you can search hundreds of thousands of documents and we can tell you which documents meet your search criteria, but there is no way we can tell you without opening each document where within each your matches are found. <p> <br> -24. There is nothing to stop MySQL support being added in future. +</li><b>.</b><li>There is nothing to stop MySQL support being added in future. <p> <br> -25. <<a href='http://www.jus.uio.no/sisu/man/sisu.1.html'>http://www.jus.uio.no/sisu/man/sisu.1.html</a> +</li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man/sisu.1.html'>http://www.jus.uio.no/sisu/man/sisu.1.html</a> > <p> <br> -26. <<a href='http://www.jus.uio.no/sisu/man/sisu.8.html'>http://www.jus.uio.no/sisu/man/sisu.8.html</a> +</li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man/sisu.8.html'>http://www.jus.uio.no/sisu/man/sisu.8.html</a> > <p> <br> -27. <<a href='http://www.jus.uio.no/sisu/man'>http://www.jus.uio.no/sisu/man</a> +</li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man'>http://www.jus.uio.no/sisu/man</a> > <p> <br> 28. the <b>Debian</b> Free Software guidelines require that everything distributed @@ -4301,7 +4362,9 @@ while freely distributable are not freely changeable. <p> <br> 29. named index.html or more extensively through sisu_manifest.html <br> -<p> +<p> </li> +</ol> + <h2><a name='sect131' href='#toc131'>See Also</a></h2> <br> <a href='http:~/bin/man2html?sisu:1'><i>sisu</i>(1)</a> @@ -4366,20 +4429,20 @@ More information about <b>SiSU</b> can be found at <<a href='http://www.sisud <li><a name='toc25' href='#sect25'>9.1 Heading Levels</a></li> <li><a name='toc26' href='#sect26'>9.2 Font Attributes</a></li> <li><a name='toc27' href='#sect27'>9.3 Indentation and Bullets</a></li> -<li><a name='toc28' href='#sect28'>9.4 Footnotes / Endnotes</a></li> -<li><a name='toc29' href='#sect29'>9.5 Links</a></li> -<li><a name='toc30' href='#sect30'>9.5.1 Naked Urls Within Text, Dealing with Urls</a></li> -<li><a name='toc31' href='#sect31'>9.5.2 Linking Text</a></li> -<li><a name='toc32' href='#sect32'>9.5.3 Linking Images</a></li> -<li><a name='toc33' href='#sect33'>9.6 Grouped Text</a></li> -<li><a name='toc34' href='#sect34'>9.6.1 Tables</a></li> -<li><a name='toc35' href='#sect35'>9.6.2 Poem</a></li> -<li><a name='toc36' href='#sect36'>9.6.3 Group</a></li> -<li><a name='toc37' href='#sect37'>9.6.4 Code</a></li> -<li><a name='toc38' href='#sect38'>9.7 Additional Breaks - Linebreaks Within Objects, Column and Page-breaks</a></li> -<li><a name='toc39' href='#sect39'>9.7.1 Line-breaks</a></li> -<li><a name='toc40' href='#sect40'>9.7.2 Page Breaks</a></li> -<li><a name='toc41' href='#sect41'>9.8 Book Index</a></li> +<li><a name='toc28' href='#sect28'>9.4 Hanging Indents</a></li> +<li><a name='toc29' href='#sect29'>9.5 Footnotes / Endnotes</a></li> +<li><a name='toc30' href='#sect30'>9.6 Links</a></li> +<li><a name='toc31' href='#sect31'>9.6.1 Naked Urls Within Text, Dealing with Urls</a></li> +<li><a name='toc32' href='#sect32'>9.6.2 Linking Text</a></li> +<li><a name='toc33' href='#sect33'>9.7 Grouped Text</a></li> +<li><a name='toc34' href='#sect34'>9.7.1 Tables</a></li> +<li><a name='toc35' href='#sect35'>9.7.2 Poem</a></li> +<li><a name='toc36' href='#sect36'>9.7.3 Group</a></li> +<li><a name='toc37' href='#sect37'>9.7.4 Code</a></li> +<li><a name='toc38' href='#sect38'>9.8 Additional Breaks - Linebreaks Within Objects, Column and Page-breaks</a></li> +<li><a name='toc39' href='#sect39'>9.8.1 Line-breaks</a></li> +<li><a name='toc40' href='#sect40'>9.8.2 Page Breaks</a></li> +<li><a name='toc41' href='#sect41'>9.9 Book Index</a></li> <li><a name='toc42' href='#sect42'>10. Composite Documents Markup</a></li> <li><a name='toc43' href='#sect43'>Markup Syntax History</a></li> <li><a name='toc44' href='#sect44'>11. Notes Related to Files-types and Markup Syntax</a></li> 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 a5f380a9..86ac41cf 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst @@ -1,4 +1,4 @@ -% SiSU 2.0 +% SiSU 3.0 @title: SiSU :subtitle: Commands @@ -57,276 +57,282 @@ SiSU is a document publishing system, that from a simple single marked-up docume 2~ Document Processing Command Flags -!_ -a [filename/wildcard] <br> +!_ -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) -!_ -b [filename/wildcard] <br> +!_ -b [filename/wildcard] \\ see --xhtml -!_ --color-toggle [filename/wildcard] <br> +!_ --color-toggle [filename/wildcard] \\ 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 -!_ --concordance [filename/wildcard] <br> +!_ --concordance [filename/wildcard] \\ 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 -!_ -C [--init-site] <br> +!_ -C [--init-site] \\ 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 <br> +!_ -CC \\ 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). The equivalent of: -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 -CC is used. -!_ -c [filename/wildcard] <br> +!_ -c [filename/wildcard] \\ see --color-toggle -!_ --dal [filename/wildcard/url] <br> +!_ --dal [filename/wildcard/url] \\ assumed for most other flags, creates new intermediate files for processing (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 -!_ --delete [filename/wildcard] <br> +!_ --delete [filename/wildcard] \\ see --zap -!_ -D [instruction] [filename] <br> +!_ -D [instruction] [filename] \\ see --pg -!_ -d [--db-[database type (sqlite|pg)]] --[instruction] [filename] <br> +!_ -d [--db-[database type (sqlite|pg)]] --[instruction] [filename] \\ see --sqlite -!_ --epub [filename/wildcard] <br> +!_ --epub [filename/wildcard] \\ produces an epub document, [sisu version >=2 ] (filename.epub). Alias -e -!_ -e [filename/wildcard] <br> +!_ -e [filename/wildcard] \\ see --epub -!_ --find [optional string part of filename] <br> +!_ --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 -!_ -F [--webserv=webrick] <br> +!_ -F [--webserv=webrick] \\ see --sample-search-form -!_ -f [optional string part of filename] <br> +!_ -f [optional string part of filename] \\ see --find -!_ --git [filename/wildcard] <br> +!_ --git [filename/wildcard] \\ 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> +!_ --glob [optional string part of filename] \\ see --find -!_ -G [optional string part of filename] <br> +!_ -G [optional string part of filename] \\ see --find -!_ -g [filename/wildcard] <br> +!_ -g [filename/wildcard] \\ see --git -!_ --harvest *.ss[tm] <br> +!_ --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. -!_ --help [topic] <br> +!_ --help [topic] \\ 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, license -!_ --html [filename/wildcard] <br> +!_ --html [filename/wildcard] \\ produces html output, segmented text with table of contents (toc.html and index.html) and the document in a single file (scroll.html). Alias -h -!_ -h [filename/wildcard] <br> +!_ -h [filename/wildcard] \\ see --html -!_ -I [filename/wildcard] <br> +!_ -I [filename/wildcard] \\ see --texinfo -!_ -i [filename/wildcard] <br> +!_ -i [filename/wildcard] \\ see --manpage -!_ --keep-processing-files [filename/wildcard/url] <br> +!_ --keep-processing-files [filename/wildcard/url] \\ see --maintenance -!_ -L <br> +!_ -L \\ prints license information. -!_ --machine [filename/wildcard/url] <br> +!_ --machine [filename/wildcard/url] \\ see --dal (document abstraction level/layer) -!_ --maintenance [filename/wildcard/url] <br> +!_ --maintenance [filename/wildcard/url] \\ maintenance mode, interim processing files are preserved and their locations indicated. (also see -V). Aliases -M and --keep-processing-files -!_ --manpage [filename/wildcard] <br> +!_ --manpage [filename/wildcard] \\ produces man page of file, not suitable for all outputs. Alias -i -!_ -M [filename/wildcard/url] <br> +!_ -M [filename/wildcard/url] \\ see --maintenance -!_ -m [filename/wildcard/url] <br> +!_ -m [filename/wildcard/url] \\ see --dal (document abstraction level/layer) -!_ --no-ocn <br> +!_ --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. -!_ -N [filename/wildcard/url] <br> +!_ -N [filename/wildcard/url] \\ document digest or document content certificate ( DCC ) as md5 digest tree of the document: the digest for the document, and digests for each object contained within the document (together with information on software versions that produced it) (digest.txt). -NV for verbose digest output to screen. -!_ -n [filename/wildcard/url] <br> +!_ -n [filename/wildcard/url] \\ skip the creation of intermediate processing files (document abstraction) if they already exist, this skips the equivalent of -m which is otherwise assumed by most processing flags. -!_ --odf [filename/wildcard/url] <br> +!_ --odf [filename/wildcard/url] \\ see --odt -!_ --odt [filename/wildcard/url] <br> +!_ --odt [filename/wildcard/url] \\ output basic document in opendocument file format (opendocument.odt). Alias -o -!_ -o [filename/wildcard/url] <br> +!_ -o [filename/wildcard/url] \\ see --odt -!_ --pdf [filename/wildcard] <br> +!_ --pdf [filename/wildcard] \\ produces LaTeX pdf (portrait.pdf & landscape.pdf). 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). Alias -p -!_ --pg [instruction] [filename] <br> +!_ --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 -!_ --po [language_directory/filename language_directory] <br> +!_ --po [language_directory/filename language_directory] \\ see --po4a -!_ --po4a [language_directory/filename language_directory] <br> +!_ --po4a [language_directory/filename language_directory] \\ produces .pot and po files for the file in the languages specified by the language directory. SiSU markup is placed in subdirectories named with the language code, e.g. en/ fr/ es/. The sisu config file must set the output directory structure to multilingual. v3, experimental -!_ -P [language_directory/filename language_directory] <br> +!_ -P [language_directory/filename language_directory] \\ see --po4a -!_ -p [filename/wildcard] <br> +!_ -p [filename/wildcard] \\ see --pdf -!_ --quiet [filename/wildcard] <br> +!_ --qrcode [filename/wildcard] \\ +generate QR code image of metadata (used in manifest). v3 only. + +!_ --quiet [filename/wildcard] \\ quiet less output to screen. -!_ -q [filename/wildcard] <br> +!_ -Q [filename/wildcard] \\ +see --qrcode + +!_ -q [filename/wildcard] \\ see --quiet -!_ --rsync [filename/wildcard] <br> +!_ --rsync [filename/wildcard] \\ 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 -!_ -R [filename/wildcard] <br> +!_ -R [filename/wildcard] \\ see --rsync -!_ -r [filename/wildcard] <br> +!_ -r [filename/wildcard] \\ see --scp -!_ --sample-search-form [--webserv=webrick] <br> +!_ --sample-search-form [--webserv=webrick] \\ 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 --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). Alias -F -!_ --scp [filename/wildcard] <br> +!_ --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 -!_ --sqlite --[instruction] [filename] <br> +!_ --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 -!_ --sisupod <br> +!_ --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 -!_ --sisupod [filename/wildcard] <br> +!_ --sisupod [filename/wildcard] \\ produces a zipped file of the prepared document specified along with associated images, by default named sisupod.zip they may alternatively be named with the filename extension .ssp This provides a quick way of gathering the relevant parts of a sisu document which can then for example be emailed. A sisupod includes sisu markup source file, (along with associated documents if a master file, or available in multilingual versions), together with related images and skin. SiSU commands can be run directly 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. The directory structure of the unzipped file is understood by sisu, and sisu commands can be run within it. Note: if you wish to send multiple files, it quickly becomes more space efficient to zip the sisu markup directory, rather than the individual files for sending). See the -S option without [filename/wildcard]. Alias -S -!_ --source [filename/wildcard] <br> +!_ --source [filename/wildcard] \\ copies sisu markup file to output directory. Alias -s -!_ -S <br> +!_ -S \\ see --sisupod -!_ -S [filename/wildcard] <br> +!_ -S [filename/wildcard] \\ see --sisupod -!_ -s [filename/wildcard] <br> +!_ -s [filename/wildcard] \\ see --source -!_ --texinfo [filename/wildcard] <br> +!_ --texinfo [filename/wildcard] \\ produces texinfo and info file, (view with pinfo). Alias -I -!_ --txt [filename/wildcard] <br> +!_ --txt [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). Alias -t -!_ -T [filename/wildcard (*.termsheet.rb)] <br> +!_ -T [filename/wildcard (*.termsheet.rb)] \\ standard form document builder, preprocessing feature -!_ -t [filename/wildcard] <br> +!_ -t [filename/wildcard] \\ see --txt -!_ --urls [filename/wildcard] <br> +!_ --urls [filename/wildcard] \\ 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 -!_ -U [filename/wildcard] <br> +!_ -U [filename/wildcard] \\ see --urls -!_ -u [filename/wildcard] <br> +!_ -u [filename/wildcard] \\ provides url mapping of output files for the flags requested for processing, also see -U -!_ --v2 [filename/wildcard] <br> +!_ --v2 [filename/wildcard] \\ invokes the sisu v2 document parser/generator. This is the default and is normally omitted. -!_ --v3 [filename/wildcard] <br> +!_ --v3 [filename/wildcard] \\ invokes the sisu v3 document parser/generator. Currently under development and incomplete, v3 requires >= ruby1.9.2p180. You may run sisu3 instead. -!_ --verbose [filename/wildcard] <br> +!_ --verbose [filename/wildcard] \\ 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 -!_ -V <br> +!_ -V \\ on its own, provides SiSU version and environment information (sisu --help env) -!_ -V [filename/wildcard] <br> +!_ -V [filename/wildcard] \\ even more verbose than the -v flag. -!_ -v <br> +!_ -v \\ on its own, provides SiSU version information -!_ -v [filename/wildcard] <br> +!_ -v [filename/wildcard] \\ see --verbose -!_ --webrick <br> +!_ --webrick \\ 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 -!_ -W <br> +!_ -W \\ see --webrick -!_ --wordmap [filename/wildcard] <br> +!_ --wordmap [filename/wildcard] \\ see --concordance -!_ -w [filename/wildcard] <br> +!_ -w [filename/wildcard] \\ see --concordance -!_ --xhtml [filename/wildcard] <br> +!_ --xhtml [filename/wildcard] \\ produces xhtml/XML output for browser viewing (sax parsing). Alias -b -!_ --xml-dom [filename/wildcard] <br> +!_ --xml-dom [filename/wildcard] \\ produces XML output with deep document structure, in the nature of dom. Alias -X -!_ --xml-sax [filename/wildcard] <br> +!_ --xml-sax [filename/wildcard] \\ produces XML output shallow structure (sax parsing). Alias -x -!_ -X [filename/wildcard] <br> +!_ -X [filename/wildcard] \\ see --xml-dom -!_ -x [filename/wildcard] <br> +!_ -x [filename/wildcard] \\ see --xml-sax -!_ -Y [filename/wildcard] <br> +!_ -Y [filename/wildcard] \\ 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]) -!_ -y [filename/wildcard] <br> +!_ -y [filename/wildcard] \\ 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. -!_ --zap [filename/wildcard] <br> +!_ --zap [filename/wildcard] \\ 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 -!_ -Z [filename/wildcard] <br> +!_ -Z [filename/wildcard] \\ see --zap 1~command_modifiers command line modifiers -!_ --no-ocn <br> +!_ --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. -!_ --no-annotate <br> +!_ --no-annotate \\ strips output text of editor endnotes~[* square brackets ]~ denoted by asterisk or dagger/plus sign -!_ --no-asterisk <br> +!_ --no-asterisk \\ strips output text of editor endnotes~[* square brackets ]~ denoted by asterisk sign -!_ --no-dagger <br> +!_ --no-dagger \\ strips output text of editor endnotes~[+ square brackets ]~ denoted by dagger/plus sign 1~commands_database database commands @@ -335,50 +341,50 @@ 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)] -!_ --pg -v --createall <br> +!_ --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. -!_ --pg -v --import <br> +!_ --pg -v --import \\ [filename/wildcard] imports data specified to postgresql db (rb.dbi) [ -dv --import sqlite equivalent] -!_ --pg -v --update <br> +!_ --pg -v --update \\ [filename/wildcard] updates/imports specified data to postgresql db (rb.dbi) [ -dv --update sqlite equivalent] -!_ --pg --remove <br> +!_ --pg --remove \\ [filename/wildcard] removes specified data to postgresql db (rb.dbi) [ -d --remove sqlite equivalent] -!_ --pg --dropall <br> +!_ --pg --dropall \\ kills data" and drops (postgresql or sqlite) db, tables & indexes [ -d --dropall sqlite equivalent] The -v is for verbose output. 1~command_shorcuts Shortcuts, Shorthand for multiple flags -!_ --update [filename/wildcard] <br> +!_ --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] <br> -Default shorthand mappings (note that the defaults can be changed/configured in the sisurc.yml file): +!_ -0 to -5 [filename or wildcard] \\ +Default shorthand mappings (for v3, note that the defaults can be changed/configured in the sisurc.yml file): -!_ -0 <br> --mNhwpAobxXyYv [this is the default action run when no options are give, i.e. on 'sisu [filename]'] +!_ -0 \\ +-NQhewpotbxXyYv [this is the default action run when no options are give, i.e. on 'sisu [filename]'] -!_ -1 <br> --mhewpy +!_ -1 \\ +-Qhewpoty -!_ -2 <br> --mhewpaoy +!_ -2 \\ +-NQhewpotbxXy -!_ -3 <br> --mhewpAobxXyY +!_ -3 \\ +-NQhewpotbxXyY -!_ -4 <br> --mhewpAobxXDyY --import +!_ -4 \\ +-NQhewpotbxXDyY --update -!_ -5 <br> --mhewpAobxXDyY --update +!_ -5 \\ +-NQhewpotbxXDyYv --update -add -v for verbose mode and -c for color, e.g. sisu -2vc [filename or wildcard] +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 diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst index a246d160..735f00ea 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst @@ -123,7 +123,10 @@ code{ @title: SiSU :subtitle: Manual -@creator: :author: Amissah, Ralph +@creator: + :author: Amissah, Ralph + +@publisher: [publisher name] @rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 @@ -440,6 +443,30 @@ _# numbered list numbered list indented a., b., c., d., etc. }code +2~ Hanging Indents + +!_ markup example: + +code{ + +_0_1 first line no indent, +rest of paragraph indented one step + +_1_0 first line indented, +rest of paragraph no indent + +in each case level may be 0-9 + +}code + +!_ resulting output: + +_0_1 first line no indent, rest of paragraph indented one step + +_1_0 first line indented, rest of paragraph no indent + +in each case level may be 0-9 + 2~ Footnotes / Endnotes Footnotes and endnotes are marked up at the location where they would be indicated within a text. They are automatically numbered. The output type determines whether footnotes or endnotes will be produced |