diff options
| author | Ralph Amissah <ralph@amissah.com> | 2012-03-21 19:57:53 -0400 |
|---|---|---|
| committer | Ralph Amissah <ralph@amissah.com> | 2012-03-21 19:57:53 -0400 |
| commit | 582f1bbd8b8a52b6198f6404cefb2763d5e5d3da (patch) | |
| tree | da9c0e4f058421a73d97ea7631e3ab7c880e593d /data/doc | |
| parent | COPYRIGHT add markup samples "Free as in Freedom" (diff) | |
v3: documentation sisu_commands, manpage, html (man2html)sisu_3.2.1
Diffstat (limited to 'data/doc')
| -rw-r--r-- | data/doc/sisu/CHANGELOG_v3 | 5 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu.1.html | 1586 |
2 files changed, 831 insertions, 760 deletions
diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index ebc81479..27e07187 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -21,6 +21,11 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.2.1.orig.tar.xz sisu_3.2.1-1.dsc sisu_3.2.1-1.debian.tar.gz +* v3, documentation sisu_commands, rearranged; update with regard to + excludes; & discreet sqlite output + * manpage + * html (man2html) + * COPYRIGHT add markup samples "Free as in Freedom" %% 3.2.0.orig.tar.xz (2012-03-19:12/1) diff --git a/data/doc/sisu/html/sisu.1.html b/data/doc/sisu/html/sisu.1.html index 106502ee..accc7ac9 100644 --- a/data/doc/sisu/html/sisu.1.html +++ b/data/doc/sisu/html/sisu.1.html @@ -188,26 +188,47 @@ 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 +<dt><b>-b [filename/wildcard]</b> +</dt> +<dd> +<p>see --xhtml +<p> </dd> + +<dt><b>-C</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. +<p> </dd> + +<dt><b>-CC</b> </dt> +<dd>see --configure +<p> </dd> + +<dt><b>-c [filename/wildcard]</b> +</dt> +<dd> +<p>see --color-toggle <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 +<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>--configure</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). -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. +<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). 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. <p> </dd> <dt><b>--concordance [filename/wildcard]</b> </dt> @@ -217,86 +238,77 @@ 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</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. +<dt><b>-D [instruction] [filename]</b> </dt> +<dd>see --pg <p> </dd> -<dt><b>-CC</b> </dt> -<dd>see --configure -<p> </dd> +<dt><b>-d [--db-[database type (sqlite|pg)]] --[instruction] [filename]</b> </dt> +<dd>see --sqlite -<dt><b>-c [filename/wildcard]</b> </dt> -<dd>see --color-toggle <p> </dd> -<dt><b>--dal [filename/wildcard/url]</b> -</dt> -<dd>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. - -<p>Alias -m +<dt><b>--dal [filename/wildcard/url]</b> </dt> +<dd>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 <p> </dd> <dt><b>--delete [filename/wildcard]</b> </dt> <dd>see --zap <p> </dd> -<dt><b>-D [instruction] [filename]</b> -</dt> -<dd> -<p>see --pg -<p> </dd> - -<dt><b>-d [--db-[database type (sqlite|pg)]] --[instruction] [filename]</b> </dt> -<dd>see --sqlite - -<p> </dd> - -<dt><b>--epub [filename/wildcard]</b> </dt> -<dd>produces an epub document, [sisu version >=2 ] -(filename.epub). Alias -e +<dt><b>--dump[=directory_path] [filename/wildcard]</b> </dt> +<dd>places output in directory +specified, if none is specified in the current directory (pwd). Compare --redirect <p> </dd> <dt><b>-e [filename/wildcard]</b> </dt> <dd>see --epub <p> </dd> -<dt><b>--find [optional - string part of 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 +<dt><b>--epub [filename/wildcard]</b> </dt> +<dd>produces +an epub document, [sisu version >=2 ] (filename.epub). Alias -e +<p> </dd> + +<dt><b>--exc-*</b> </dt> +<dd>exclude +output feature, overrides configuration settings --exc-ocn, (exclude object +citation numbering, affects html (seg, scroll), epub, xhtml, xml); --exc-toc, +(exclude table of contents, affects html (scroll), epub, pdf); --exc-links-to-manifest, +--exc-manifest-links, (exclude links to manifest, affects html (seg, scroll)); +--exc-search-form, (exclude search form, affects html (seg, scroll), manifest); +--exc-minitoc, (exclude mini table of contents, affects html (seg), concordance, +manifest); --exc-manifest-minitoc, (exclude mini table of contents, affects +manifest); --exc-html-minitoc, (exclude mini table of contents, affects html +(seg), concordance); --exc-html-navigation, (exclude navigation, affects html +(seg)); --exc-html-navigation-bar, (exclude navigation bar, affects html (seg)); +--exc-html-search-form, (exclude search form, affects html (seg, scroll)); --exc-html-right-pane, +(exclude right pane/column, affects html (seg, scroll)); --exc-html-top-band, +(exclude top band, affects html (seg, scroll), concordance (minitoc forced +on to provide seg navigation)); --exc-segsubtoc (exclude sub table of contents, +affects html (seg), epub); see also --inc-* <p> </dd> <dt><b>-F [--webserv=webrick]</b> </dt> <dd>see --sample-search-form + <p> </dd> -<dt><b>-f [optional - string part of filename]</b> </dt> +<dt><b>-f [optional string part of 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 +<dt><b>--find [optional string part + of 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>--glob [optional string part of filename]</b> </dt> -<dd>see --find -<p> </dd> - -<dt><b>-G -[optional string part of filename]</b> </dt> +<dt><b>-G [optional string part of filename]</b> </dt> <dd>see --find <p> </dd> @@ -306,22 +318,35 @@ to change). Alias -g <p>see --git <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>--glob +[optional string part of filename]</b> </dt> +<dd>see --find +<p> </dd> + +<dt><b>-h [filename/wildcard]</b> </dt> +<dd>see --html +<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. +<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, - -<p>license +<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, +license. <p> </dd> <dt><b>--html [filename/wildcard]</b> </dt> @@ -330,83 +355,113 @@ with table of contents (toc.html and index.html) and the document in a single file (scroll.html). Alias -h <p> </dd> -<dt><b>-h [filename/wildcard]</b> </dt> -<dd>see --html +<dt><b>-I [filename/wildcard]</b> </dt> +<dd>see --texinfo <p> </dd> -<dt><b>-I [filename/wildcard]</b> +<dt><b>-i [filename/wildcard]</b> </dt> <dd> -<p>see --texinfo +<p>see --manpage <p> </dd> -<dt><b>-i [filename/wildcard]</b> </dt> -<dd>see --manpage +<dt><b>--inc-*</b> </dt> +<dd>include output feature, overrides configuration settings, +(usually the default if none set), has precedence over --exc-* (exclude output +feature). Some detail provided under --exc-*, see --exc-* +<p> </dd> + +<dt><b>-j [filename/wildcard]</b> +</dt> +<dd>copies images associated with a file for use by html, xhtml & xml outputs +(automatically invoked by --dump & redirect). <p> </dd> <dt><b>--keep-processing-files [filename/wildcard/url]</b> </dt> -<dd>see --maintenance +<dd> +<p>see --maintenance <p> </dd> <dt><b>-L</b> </dt> <dd>prints license information. <p> </dd> -<dt><b>--machine [filename/wildcard/url]</b> +<dt><b>-M [filename/wildcard/url]</b> </dt> -<dd>see --dal (document abstraction level/layer) +<dd> +<p>see --maintenance <p> </dd> -<dt><b>--maintenance [filename/wildcard/url]</b></dt> -<dd>maintenance mode, interim processing files are preserved and their locations -indicated. (also see -V). Aliases -M and --keep-processing-files +<dt><b>-m [filename/wildcard/url]</b> </dt> +<dd>see --dal (document abstraction +level/layer) <p> </dd> -<dt><b>--manpage [filename/wildcard]</b></dt> -<dd>produces man page of file, not suitable for all outputs. Alias -i +<dt><b>--machine [filename/wildcard/url]</b> </dt> +<dd>see --dal (document abstraction +level/layer) <p> </dd> -<dt><b>-M [filename/wildcard/url]</b></dt> -<dd>see --maintenance +<dt><b>--maintenance [filename/wildcard/url]</b> </dt> +<dd>maintenance mode, interim +processing files are preserved and their locations indicated. (also see +-V). Aliases -M and --keep-processing-files. <p> </dd> -<dt><b>-m [filename/wildcard/url]</b> </dt> -<dd>see --dal (document abstraction -level/layer) +<dt><b>--manpage [filename/wildcard]</b> </dt> +<dd>produces +man page of file, not suitable for all outputs. Alias -i <p> </dd> -<dt><b>--no-ocn</b> </dt> -<dd>[with --html --pdf or --epub] switches off object citation -numbering. Produce output without identifying numbers in margins of html -or LaTeX/pdf output. +<dt><b>-N [filename/wildcard/url]</b> +</dt> +<dd>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. <p> </dd> -<dt><b>-N [filename/wildcard/url]</b> </dt> -<dd>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. +<dt><b>-n +[filename/wildcard/url]</b> </dt> +<dd>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. <p> </dd> -<dt><b>-n [filename/wildcard/url]</b> </dt> -<dd>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. +<dt><b>--no-*</b> </dt> +<dd>see --exc-* + +<p> </dd> + +<dt><b>--no-ocn</b> </dt> +<dd>[with --html --pdf or --epub] switches off object citation numbering. Produce +output without identifying numbers in margins of html or LaTeX/pdf output. + +<p> </dd> + +<dt><b>-o [filename/wildcard/url]</b> </dt> +<dd>see --odt <p> </dd> <dt><b>--odf [filename/wildcard/url]</b> </dt> <dd>see --odt + <p> </dd> -<dt><b>--odt [filename/wildcard/url]</b></dt> -<dd>output basic document in opendocument file format (opendocument.odt). Alias --o +<dt><b>--odt [filename/wildcard/url]</b> </dt> +<dd>output basic document in opendocument file +format (opendocument.odt). Alias -o <p> </dd> -<dt><b>-o [filename/wildcard/url]</b> </dt> -<dd>see --odt +<dt><b>-P [language_directory/filename language_directory]</b> +</dt> +<dd> +<p>see --po4a +<p> </dd> + +<dt><b>-p [filename/wildcard]</b> </dt> +<dd>see --pdf <p> </dd> <dt><b>--pdf [filename/wildcard]</b> </dt> @@ -436,13 +491,14 @@ language code, e.g. en/ fr/ es/. The sisu config file must set the output directory structure to multilingual. v3, experimental <p> </dd> -<dt><b>-P [language_directory/filename - language_directory]</b> </dt> -<dd>see --po4a +<dt><b>-Q [filename/wildcard]</b> +</dt> +<dd> +<p>see --qrcode <p> </dd> -<dt><b>-p [filename/wildcard]</b> </dt> -<dd>see --pdf +<dt><b>-q [filename/wildcard]</b> </dt> +<dd>see --quiet <p> </dd> <dt><b>--qrcode [filename/wildcard]</b> @@ -455,31 +511,45 @@ directory structure to multilingual. v3, experimental <dd>quiet less output to screen. <p> </dd> -<dt><b>-Q [filename/wildcard]</b> </dt> -<dd>see --qrcode +<dt><b>-R [filename/wildcard]</b> </dt> +<dd>see --rsync <p> </dd> -<dt><b>-q [filename/wildcard]</b> +<dt><b>-r [filename/wildcard]</b> </dt> -<dd>see --quiet +<dd> +<p>see --scp <p> </dd> -<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 +<dt><b>--redirect[=directory_path] [filename/wildcard]</b> </dt> +<dd>places output in +subdirectory under specified directory, subdirectory uses the filename +(without the suffix). If no output directory is specified places the subdirectory +under the current directory (pwd). Compare --dump <p> </dd> -<dt><b>-R [filename/wildcard]</b> </dt> -<dd>see --rsync +<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> -<dd>see --scp +<dt><b>-S</b> </dt> +<dd>see --sisupod +<p> </dd> + +<dt><b>-S [filename/wildcard]</b> </dt> +<dd>see --sisupod +<p> </dd> + +<dt><b>-s [filename/wildcard]</b> +</dt> +<dd> +<p>see --source <p> </dd> <dt><b>--sample-search-form [--webserv=webrick]</b> </dt> @@ -496,7 +566,8 @@ 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> +<dt><b>--scp [filename/wildcard]</b> +</dt> <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 @@ -504,23 +575,28 @@ have your "keys" and ssh agent in place. Also see --rsync. Alias -r <dt><b>--sqlite --[instruction] [filename]</b> </dt> -<dd>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 +<dd>database type set to sqlite, this produces one +of two possible databases, without additional database related instructions +it produces a discreet sqlite file for the document processed; with additional +instructions it produces a common sqlite database of all processed documents +that (come from the same document preparation directory and as a result) +share the same output directory base path (possible instructions include: +--createdb; --create; --dropall; --import [filename]; --update [filename]; --remove +[filename]); see database section below. Alias -d <p> </dd> <dt><b>--sisupod</b> </dt> -<dd>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 +<dd>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<br> + 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 @@ -543,115 +619,109 @@ rather than the individual files for sending). See the -S option without file to output directory. Alias -s <p> </dd> -<dt><b>-S</b> </dt> -<dd>see --sisupod -<p> </dd> - -<dt><b>-S [filename/wildcard]</b> +<dt><b>-T [filename/wildcard (*.termsheet.rb)]</b> </dt> -<dd>see --sisupod -<p> </dd> - -<dt><b>-s [filename/wildcard]</b> </dt> -<dd>see --source -<p> </dd> - -<dt><b>--texinfo [filename/wildcard]</b> -</dt> -<dd>produces texinfo and info file, (view with pinfo). Alias -I +<dd>standard form document builder, preprocessing feature <p> </dd> -<dt><b>--txt [filename/wildcard]</b> +<dt><b>-t [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 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 -<p> </dd> - -<dt><b>-T [filename/wildcard (*.termsheet.rb)]</b> </dt> -<dd>standard form document builder, preprocessing feature +<dd> +<p>see --txt <p> </dd> -<dt><b>-t [filename/wildcard]</b> </dt> -<dd>see --txt +<dt><b>--texinfo [filename/wildcard]</b> </dt> +<dd>produces texinfo and info file, (view +with pinfo). Alias -I <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>--txt [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 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 <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 -<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. - -<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. -<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 url mapping of output files for the +flags requested for processing, also see -U +<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 <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> +<dt><b>-V [filename/wildcard]</b> +</dt> <dd>even more verbose than the -v flag. <p> </dd> <dt><b>-v</b> </dt> -<dd>on its own, provides <b>SiSU</b> version information +<dd>on its own, provides <b>SiSU</b> version +<p>information <p> </dd> <dt><b>-v [filename/wildcard]</b> </dt> <dd>see --verbose <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 -H ; also, note -F webrick ]. Alias -W +<dt><b>--v2 [filename/wildcard]</b> +</dt> +<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. +<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 <p> </dd> <dt><b>-W</b> </dt> <dd>see --webrick <p> </dd> -<dt><b>--wordmap [filename/wildcard]</b> </dt> -<dd>see --concordance +<dt><b>-w [filename/wildcard]</b> +</dt> +<dd> +see --concordance <p> </dd> -<dt><b>-w [filename/wildcard]</b> </dt> +<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 +-H ; also, note -F webrick ]. Alias -W +<p> </dd> + +<dt><b>--wordmap [filename/wildcard]</b> </dt> <dd>see --concordance <p> </dd> @@ -666,12 +736,15 @@ can be changed in the resource configuration files. [tip: the webric 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>see --xml-dom +<dt><b>-X [filename/wildcard]</b> +</dt> +<dd> +see --xml-dom <p> </dd> <dt><b>-x [filename/wildcard]</b> </dt> @@ -692,17 +765,17 @@ 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 -<p> </dd> - <dt><b>-Z [filename/wildcard]</b> </dt> <dd>see --zap <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 +<p> </dd> </dl> <h2><a name='sect8' href='#toc8'>3. Command Line Modifiers</a></h2> @@ -764,14 +837,15 @@ and underscores. to postgresql db (rb.dbi) [ -dv and search --import sqlite equivalent] <p> </dd> -<dt><b>--pg -v --update</b> </dt> +<dt><b>--pg +-v --update</b> </dt> <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] +<dd>[filename/wildcard] +removes specified data to postgresql db (rb.dbi) [ -d --remove sqlite equivalent] <p> </dd> @@ -1054,7 +1128,7 @@ version used in the form of a comment. Comments are a percentage mark at the start of a paragraph (and as the first character in a line of text) followed by a space and the comment: <p> <br> -<pre> % this would be a comment +<pre>% this would be a comment </pre> <p> <h2><a name='sect22' href='#toc22'>8.1 Sample Header</a></h2> @@ -1063,50 +1137,50 @@ followed by a space and the comment: This current document is loaded by a master document that has a header similar to this one: <p> <br> -<pre> % SiSU master 2.0 - @title: SiSU - :subtitle: Manual - @creator: - :author: Amissah, Ralph - @publisher: [publisher name] - @rights: Copyright (C) Ralph Amissah 2007, License GPL 3 - @classify: - :type: information - :topic_register: SiSU:manual;electronic documents:SiSU:manual - :subject: ebook, epublishing, electronic book, electronic publishing, - electronic document, electronic citation, data structure, - citation systems, search - % used_by: manual - @date: - :published: 2008-05-22 - :created: 2002-08-28 - :issued: 2002-08-28 - :available: 2002-08-28 - :modified: 2010-03-03 - @make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - :manpage: name=sisu - documents: markup, structuring, publishing - in multiple standard formats, and search; - synopsis=sisu [-abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0-9] [filename/wildcard +<pre>% SiSU master 2.0 +@title: SiSU + :subtitle: Manual +@creator: + :author: Amissah, Ralph +@publisher: [publisher name] +@rights: Copyright (C) Ralph Amissah 2007, License GPL 3 +@classify: + :type: information + :topic_register: SiSU:manual;electronic documents:SiSU:manual + :subject: ebook, epublishing, electronic book, electronic publishing, + electronic document, electronic citation, data structure, + citation systems, search +% used_by: manual +@date: + :published: 2008-05-22 + :created: 2002-08-28 + :issued: 2002-08-28 + :available: 2002-08-28 + :modified: 2010-03-03 +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + :manpage: name=sisu - documents: markup, structuring, publishing + in multiple standard formats, and search; + synopsis=sisu [-abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0-9] [filename/wildcard ] - . sisu [-Ddcv] [instruction] - . sisu [-CcFLSVvW] - . sisu --v2 [operations] - . sisu --v3 [operations] - @links: - { SiSU Homepage }http://www.sisudoc.org/ - { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/ - { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary - { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + . sisu [-Ddcv] [instruction] + . sisu [-CcFLSVvW] + . sisu --v2 [operations] + . sisu --v3 [operations] +@links: + { SiSU Homepage }http://www.sisudoc.org/ + { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/ + { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary + { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU </pre> <p> <h2><a name='sect23' href='#toc23'>8.2 Available Headers</a></h2> @@ -1131,78 +1205,78 @@ structure, and can be useful to know. <p>This is a sample header <p> <br> -<pre> % SiSU 2.0 [declared file-type identifier with markup version] +<pre>% SiSU 2.0 [declared file-type identifier with markup version] </pre> <p> <br> -<pre> @title: [title text] [this header is the only one that is mandatory] - :subtitle: [subtitle if any] - :language: English +<pre>@title: [title text] [this header is the only one that is mandatory] + :subtitle: [subtitle if any] + :language: English </pre> <p> <br> -<pre> @creator: - :author: [Lastname, First names] - :illustrator: [Lastname, First names] - :translator: [Lastname, First names] - :prepared_by: [Lastname, First names] +<pre>@creator: + :author: [Lastname, First names] + :illustrator: [Lastname, First names] + :translator: [Lastname, First names] + :prepared_by: [Lastname, First names] </pre> <p> <br> -<pre> @date: - :published: [year or yyyy-mm-dd] - :created: [year or yyyy-mm-dd] - :issued: [year or yyyy-mm-dd] - :available: [year or yyyy-mm-dd] - :modified: [year or yyyy-mm-dd] - :valid: [year or yyyy-mm-dd] - :added_to_site: [year or yyyy-mm-dd] - :translated: [year or yyyy-mm-dd] +<pre>@date: + :published: [year or yyyy-mm-dd] + :created: [year or yyyy-mm-dd] + :issued: [year or yyyy-mm-dd] + :available: [year or yyyy-mm-dd] + :modified: [year or yyyy-mm-dd] + :valid: [year or yyyy-mm-dd] + :added_to_site: [year or yyyy-mm-dd] + :translated: [year or yyyy-mm-dd] </pre> <p> <br> -<pre> @rights: - :copyright: Copyright (C) [Year and Holder] - :license: [Use License granted] - :text: [Year and Holder] - :translation: [Name, Year] - :illustrations: [Name, Year] +<pre>@rights: + :copyright: Copyright (C) [Year and Holder] + :license: [Use License granted] + :text: [Year and Holder] + :translation: [Name, Year] + :illustrations: [Name, Year] </pre> <p> <br> -<pre> @classify: - :topic_register: SiSU:markup sample:book;book:novel:fantasy - :type: - :subject: - :description: - :keywords: - :abstract: - :isbn: [ISBN] - :loc: [Library of Congress classification] - :dewey: [Dewey classification] - :pg: [Project Gutenberg text number] +<pre>@classify: + :topic_register: SiSU:markup sample:book;book:novel:fantasy + :type: + :subject: + :description: + :keywords: + :abstract: + :isbn: [ISBN] + :loc: [Library of Congress classification] + :dewey: [Dewey classification] + :pg: [Project Gutenberg text number] </pre> <p> <br> -<pre> @links: { SiSU }http://www.sisudoc.org - { FSF }http://www.fsf.org +<pre>@links: { SiSU }http://www.sisudoc.org + { FSF }http://www.fsf.org </pre> <p> <br> -<pre> @make: - :skin: skin_name - [skins change default settings related to the appearance of documents +<pre>@make: + :skin: skin_name + [skins change default settings related to the appearance of documents generated] - :num_top: 1 - :headings: [text to match for each level - (e.g. PART; Chapter; Section; Article; - or another: none; BOOK|FIRST|SECOND; none; CHAPTER;) - :breaks: new=:C; break=1 - :promo: sisu, ruby, sisu_search_libre, open_society - :bold: [regular expression of words/phrases to be made bold] - :italics: [regular expression of words/phrases to italicise] + :num_top: 1 + :headings: [text to match for each level + (e.g. PART; Chapter; Section; Article; + or another: none; BOOK|FIRST|SECOND; none; CHAPTER;) + :breaks: new=:C; break=1 + :promo: sisu, ruby, sisu_search_libre, open_society + :bold: [regular expression of words/phrases to be made bold] + :italics: [regular expression of words/phrases to italicise] </pre> <p> <br> -<pre> @original: - :language: [language] +<pre>@original: + :language: [language] </pre> <p> <br> -<pre> @notes: - :comment: - :prefix: [prefix is placed just after table of contents] +<pre>@notes: + :comment: + :prefix: [prefix is placed just after table of contents] </pre> <p> <h2><a name='sect24' href='#toc24'>9. Markup of Substantive Text</a></h2> @@ -1243,12 +1317,12 @@ or sub-heading 3, the heading level that would normally be marked 1.1 or that would normally be marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a document <p> <br> -<pre> 1~filename level 1 heading, - % the primary division such as Chapter that is followed by substantive +<pre>1~filename level 1 heading, +% the primary division such as Chapter that is followed by substantive text, - % and may be further subdivided (this is the level on which by default +% and may be further subdivided (this is the level on which by default html - % segments are made) +% segments are made) </pre> <p> <h2><a name='sect26' href='#toc26'>9.2 Font Attributes</a></h2> @@ -1256,31 +1330,31 @@ html <p> <br> <b>markup example:</b> <p> <br> -<pre> normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, +<pre>normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}", - ^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}-, #{monospace}# - normal text +^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}-, #{monospace}# +normal text - *{emphasis}* [note: can be configured to be represented by bold, italics +*{emphasis}* [note: can be configured to be represented by bold, italics or underscore] - !{bold text}! +!{bold text}! - _{underscore}_ +_{underscore}_ - /{italics}/ +/{italics}/ - "{citation}" +"{citation}" - ^{superscript}^ +^{superscript}^ - ,{subscript}, +,{subscript}, - +{inserted text}+ ++{inserted text}+ - -{strikethrough}- +-{strikethrough}- - #{monospace}# +#{monospace}# </pre> <p> <br> <b>resulting output:</b> @@ -1321,13 +1395,13 @@ normal text, <b>emphasis,</b> <b>bold text,</b> <i>italics,</i> <i>underscore,</ <p> <br> <b>markup example:</b> <p> <br> -<pre> ordinary paragraph +<pre>ordinary paragraph - _1 indent paragraph one step +_1 indent paragraph one step - _2 indent paragraph two steps +_2 indent paragraph two steps - _9 indent paragraph nine steps +_9 indent paragraph nine steps </pre> <p> <br> <b>resulting output:</b> @@ -1346,11 +1420,11 @@ normal text, <b>emphasis,</b> <b>bold text,</b> <i>italics,</i> <i>underscore,</ <p> <br> <b>markup example:</b> <p> <br> -<pre> _* bullet text +<pre>_* bullet text - _1* bullet text, first indent +_1* bullet text, first indent - _2* bullet text, two step indent +_2* bullet text, two step indent </pre> <p> <br> <b>resulting output:</b> @@ -1368,9 +1442,9 @@ Numbered List (not to be confused with headings/titles, (document structure)) <p> <br> <b>markup example:</b> <p> <br> -<pre> # numbered list numbered list 1., 2., 3, etc. +<pre># numbered list numbered list 1., 2., 3, etc. - _# numbered list numbered list indented a., b., c., d., etc. +_# numbered list numbered list indented a., b., c., d., etc. </pre> <p> <h2><a name='sect28' href='#toc28'>9.4 Hanging Indents</a></h2> @@ -1378,11 +1452,11 @@ Numbered List (not to be confused with headings/titles, (document structure)) <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>_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> @@ -1405,7 +1479,7 @@ indicated within a text. They are automatically numbered. The output type <p> <br> <b>markup example:</b> <p> <br> -<pre> ~{ a footnote or endnote }~ +<pre>~{ a footnote or endnote }~ </pre> <p> <br> <b>resulting output:</b> @@ -1414,7 +1488,7 @@ indicated within a text. They are automatically numbered. The output type <p> <br> <b>markup example:</b> <p> <br> -<pre> normal text~{ self contained endnote marker & endnote in one }~ continues +<pre>normal text~{ self contained endnote marker & endnote in one }~ continues </pre> <p> <br> <b>resulting output:</b> @@ -1423,10 +1497,10 @@ normal text[^13] continues <p> <br> <b>markup example:</b> <p> <br> -<pre> normal text ~{* unnumbered asterisk footnote/endnote, insert multiple -asterisks if required }~ continues +<pre>normal text ~{* unnumbered asterisk footnote/endnote, insert multiple asterisks +if required }~ continues - normal text ~{** another unnumbered asterisk footnote/endnote }~ continues +normal text ~{** another unnumbered asterisk footnote/endnote }~ continues </pre> <p> <br> <b>resulting output:</b> @@ -1437,10 +1511,10 @@ normal text [^**] continues <p> <br> <b>markup example:</b> <p> <br> -<pre> normal text ~[* editors notes, numbered asterisk footnote/endnote series +<pre>normal text ~[* editors notes, numbered asterisk footnote/endnote series ]~ continues - normal text ~[+ editors notes, numbered asterisk footnote/endnote series +normal text ~[+ editors notes, numbered asterisk footnote/endnote series ]~ continues </pre> <p> <br> @@ -1452,10 +1526,10 @@ normal text [^+2] continues <p> <br> <b>Alternative endnote pair notation for footnotes/endnotes:</b> <p> <br> -<pre> % note the endnote marker "~^" - normal text~^ continues +<pre>% note the endnote marker "~^" +normal text~^ continues - ^~ endnote text following the paragraph in which the marker occurs +^~ endnote text following the paragraph in which the marker occurs </pre> <p> <br> @@ -1476,7 +1550,7 @@ case the decoration is omitted). <p> <br> <b>markup example:</b> <p> <br> -<pre> normal text http://www.sisudoc.org/ continues +<pre>normal text http://www.sisudoc.org/ continues </pre> <p> <br> <b>resulting output:</b> @@ -1489,8 +1563,8 @@ normal text <<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> <p> <br> <b>markup example:</b> <p> <br> -<pre> normal text _http://www.sisudoc.org/ continues - deb _http://www.jus.uio.no/sisu/archive unstable main non-free +<pre>normal text _http://www.sisudoc.org/ continues +deb _http://www.jus.uio.no/sisu/archive unstable main non-free </pre> <p> <br> <b>resulting output:</b> @@ -1507,9 +1581,9 @@ where a code block is used there is neither decoration nor hyperlinking, <p> <br> <b>resulting output:</b> <p> <br> -<pre> deb http://www.jus.uio.no/sisu/archive unstable main non-free +<pre>deb http://www.jus.uio.no/sisu/archive unstable main non-free - deb-src http://www.jus.uio.no/sisu/archive unstable main non-free +deb-src http://www.jus.uio.no/sisu/archive unstable main non-free </pre> <p> <h2><a name='sect32' href='#toc32'>9.6.2 Linking Text</a></h2> @@ -1520,7 +1594,7 @@ where a code block is used there is neither decoration nor hyperlinking, <p> <br> <b>markup example:</b> <p> <br> -<pre> about { SiSU }http://url.org markup +<pre>about { SiSU }http://url.org markup </pre> <p> <br> <b>resulting output:</b> @@ -1535,7 +1609,7 @@ aboutSiSU <<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> <p> <br> <b>markup example:</b> <p> <br> -<pre> about {~^ SiSU }http://url.org markup +<pre>about {~^ SiSU }http://url.org markup </pre> <p> <br> <b>resulting output:</b> @@ -1543,6 +1617,8 @@ aboutSiSU <<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> about SiSU <<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> > [^14] markup <p> <br> +Internal document links to a tagged location, including an ocn +<p> <br> <b>markup example:</b> <p> <br> <pre> { tux.png 64x80 }image @@ -1560,12 +1636,12 @@ Debian and Ruby" }http://www.sisudoc.org/ markup example: - { tux.png 64x80 }image - % various url linked images - {tux.png 64x80 "a better way" }http://www.sisudoc.org/ - {GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, -Debian and Ruby" }http://www.sisudoc.org/ - {~^ ruby_logo.png "Ruby" }http://www.ruby-lang.org/en/ +{ tux.png 64x80 }image +% various url linked images +{tux.png 64x80 "a better way" }http://www.sisudoc.org/ +{GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian +and Ruby" }http://www.sisudoc.org/ +{~^ ruby_logo.png "Ruby" }http://www.ruby-lang.org/en/ </pre> <p> <br> <b>resulting output:</b> @@ -1575,23 +1651,22 @@ Debian and Ruby" }http://www.sisudoc.org/ tux.png 64x80 "Gnu/Linux - a better way" <<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> > <p> <br> -[ ruby_logo (png missing) ] [^15] -<p> <br> GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian -and Ruby" <<a href='http://www.jus.uio.no/sisu/'>http://www.jus.uio.no/sisu/</a> +and Ruby" <<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> > <p> <br> +[ ruby_logo (png missing) ] [^15] +<p> <br> <p><b>linked url footnote shortcut</b> <p> <br> -<pre> {~^ [text to link] }http://url.org - % maps to: { [text to link] }http://url.org ~{ http://url.org }~ - % which produces hyper-linked text within a document/paragraph, - % with an endnote providing the url for the text location used in the -hyperlink +<pre>{~^ [text to link] }http://url.org +% maps to: { [text to link] }http://url.org ~{ http://url.org }~ +% which produces hyper-linked text within a document/paragraph, +% with an endnote providing the url for the text location used in the hyperlink </pre> <p> <br> -<pre> text marker *~name +<pre>text marker *~name </pre> <p> <br> note at a heading level the same is automatically achieved by providing @@ -1610,14 +1685,14 @@ Tables</a></h2> <p> <br> <b>markup example:</b> <p> <br> -<pre> table{ c3; 40; 30; 30; - This is a table - this would become column two of row one - column three of row one is here - And here begins another row - column two of row two - column three of row two, and so on - }table +<pre>table{ c3; 40; 30; 30; +This is a table +this would become column two of row one +column three of row one is here +And here begins another row +column two of row two +column three of row two, and so on +}table </pre> <p> <br> <b>resulting output:</b> @@ -1629,24 +1704,23 @@ Tables</a></h2> <p>information in each column <p> <br> -<b>markup example:</b> [^16] -<p> <br> -<pre> !_ Table 3.1: Contributors to Wikipedia, January 2001 - June 2005 - {table~h 24; 12; 12; 12; 12; 12; 12;} - |Jan. 2001|Jan. 2002|Jan. 2003|Jan. 2004|July -2004|June 2006 - Contributors* | 10| 472| 2,188| 9,653| - 25,011| 48,721 - Active contributors** | 9| 212| 846| 3,228| - 8,442| 16,945 - Very active contributors*** | 0| 31| 190| 692| - 1,639| 3,016 - No. of English language articles| 25| 16,000| 101,000| 190,000| -320,000| 630,000 - 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. +<b>markup example:</b> [^17] +<p> <br> +<pre>!_ Table 3.1: Contributors to Wikipedia, January 2001 - June 2005 +{table~h 24; 12; 12; 12; 12; 12; 12;} + |Jan. 2001|Jan. 2002|Jan. 2003|Jan. 2004|July 2004|June +2006 +Contributors* | 10| 472| 2,188| 9,653| +25,011| 48,721 +Active contributors** | 9| 212| 846| 3,228| + 8,442| 16,945 +Very active contributors*** | 0| 31| 190| 692| + 1,639| 3,016 +No. of English language articles| 25| 16,000| 101,000| 190,000| 320,000| + 630,000 +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. </pre> <p> <br> <b>resulting output:</b> @@ -1664,60 +1738,60 @@ more than 100 times in last month. <p> <br> <b>basic markup:</b> <p> <br> -<pre> poem{ - Your poem here - }poem - Each verse in a poem is given an object number. +<pre>poem{ + Your poem here +}poem +Each verse in a poem is given an object number. </pre> <p> <br> <b>markup example:</b> <p> <br> -<pre> poem{ - ‘Fury said to a - mouse, That he - met in the - house, - "Let us - both go to - law: I will - prosecute - YOU. --Come, - I’ll take no - denial; We - must have a - trial: For - really this - morning I’ve - nothing - to do." - Said the - mouse to the - cur, "Such - a trial, - dear Sir, - With - no jury - or judge, - would be - wasting - our - breath." - "I’ll be - judge, I’ll - be jury," - Said - cunning - old Fury: - "I’ll - try the - whole - cause, - and - condemn - you - to - death."’ - }poem +<pre>poem{ + ‘Fury said to a + mouse, That he + met in the + house, + "Let us + both go to + law: I will + prosecute + YOU. --Come, + I’ll take no + denial; We + must have a + trial: For + really this + morning I’ve + nothing + to do." + Said the + mouse to the + cur, "Such + a trial, + dear Sir, + With + no jury + or judge, + would be + wasting + our + breath." + "I’ll be + judge, I’ll + be jury," + Said + cunning + old Fury: + "I’ll + try the + whole + cause, + and + condemn + you + to + death."’ +}poem </pre> <p> <br> <b>resulting output:</b> @@ -1816,64 +1890,63 @@ more than 100 times in last month. <p> <br> <b>basic markup:</b> <p> <br> -<pre> group{ +<pre>group{ - Your grouped text here + Your grouped text here - }group +}group - A group is treated as an object and given a single object number. +A group is treated as an object and given a single object number. </pre> <p> <br> <b>markup example:</b> <p> <br> -<pre> group{ - - ’Fury said to a - mouse, That he - met in the - house, - "Let us - both go to - law: I will - prosecute - YOU. --Come, - I’ll take no - denial; We - must have a - trial: For - really this - morning I’ve - nothing - to do." - Said the - mouse to the - cur, "Such - a trial, - dear Sir, - With - no jury - or judge, - would be - wasting - our - breath." - "I’ll be - judge, I’ll - be jury," - Said - cunning - old Fury: - "I’ll - try the - whole - cause, - and - condemn - you - to - death."’ - }group +<pre>group{ + ’Fury said to a + mouse, That he + met in the + house, + "Let us + both go to + law: I will + prosecute + YOU. --Come, + I’ll take no + denial; We + must have a + trial: For + really this + morning I’ve + nothing + to do." + Said the + mouse to the + cur, "Such + a trial, + dear Sir, + With + no jury + or judge, + would be + wasting + our + breath." + "I’ll be + judge, I’ll + be jury," + Said + cunning + old Fury: + "I’ll + try the + whole + cause, + and + condemn + you + to + death."’ +}group </pre> <p> <br> <b>resulting output:</b> @@ -1982,99 +2055,99 @@ option to number each line of code may <p> <br> <b>use of code tags instead of poem compared, resulting output:</b> <p> <br> -<pre> ‘Fury said to a - mouse, That he - met in the - house, - "Let us - both go to - law: I will - prosecute - YOU. --Come, - I’ll take no - denial; We - must have a - trial: For - really this - morning I’ve - nothing - to do." - Said the - mouse to the - cur, "Such - a trial, - dear Sir, - With - no jury - or judge, - would be - wasting - our - breath." - "I’ll be - judge, I’ll - be jury," - Said - cunning - old Fury: - "I’ll - try the - whole - cause, - and - condemn - you - to - death."’ +<pre> ‘Fury said to a + mouse, That he + met in the + house, + "Let us + both go to + law: I will + prosecute + YOU. --Come, + I’ll take no + denial; We + must have a + trial: For + really this + morning I’ve + nothing + to do." + Said the + mouse to the + cur, "Such + a trial, + dear Sir, + With + no jury + or judge, + would be + wasting + our + breath." + "I’ll be + judge, I’ll + be jury," + Said + cunning + old Fury: + "I’ll + try the + whole + cause, + and + condemn + you + to + death."’ </pre> <p> <br> From <b>SiSU</b> 2.7.7 on you can number codeblocks by placing a hash after the opening code tag code{# as demonstrated here: <p> <br> -<pre>1 | ‘Fury said to a -2 | mouse, That he -3 | met in the -4 | house, -5 | "Let us -6 | both go to -7 | law: I will -8 | prosecute -9 | YOU. --Come, -10 | I’ll take no -11 | denial; We -12 | must have a -13 | trial: For -14 | really this -15 | morning I’ve -16 | nothing -17 | to do." -18 | Said the -19 | mouse to the -20 | cur, "Such -21 | a trial, -22 | dear Sir, -23 | With -24 | no jury -25 | or judge, -26 | would be -27 | wasting -28 | our -29 | breath." -30 | "I’ll be -31 | judge, I’ll -32 | be jury," -33 | Said -34 | cunning -35 | old Fury: -36 | "I’ll -37 | try the -38 | whole -39 | cause, -40 | and -41 | condemn -42 | you -43 | to -44 | death."’ +<pre>1 | ‘Fury said to a +2 | mouse, That he +3 | met in the +4 | house, +5 | "Let us +6 | both go to +7 | law: I will +8 | prosecute +9 | YOU. --Come, +10 | I’ll take no +11 | denial; We +12 | must have a +13 | trial: For +14 | really this +15 | morning I’ve +16 | nothing +17 | to do." +18 | Said the +19 | mouse to the +20 | cur, "Such +21 | a trial, +22 | dear Sir, +23 | With +24 | no jury +25 | or judge, +26 | would be +27 | wasting +28 | our +29 | breath." +30 | "I’ll be +31 | judge, I’ll +32 | be jury," +33 | Said +34 | cunning +35 | old Fury: +36 | "I’ll +37 | try the +38 | whole +39 | cause, +40 | and +41 | condemn +42 | you +43 | to +44 | death."’ </pre> <p> <h2><a name='sect38' href='#toc38'>9.8 Additional Breaks - Linebreaks Within Objects, Column and Page-breaks</a></h2> @@ -2087,10 +2160,10 @@ opening code tag code{# as demonstrated here: To break a line within a "paragraph object", two backslashes \\ with a space before and a space or newline after them may be used. <p> <br> -<pre> To break a line within a "paragraph object", - two backslashes \\ with a space before - and a space or newline after them \\ - may be used. +<pre>To break a line within a "paragraph object", +two backslashes \\ with a space before +and a space or newline after them \\ +may be used. </pre> <p> <br> The html break br enclosed in angle brackets (though undocumented) is available @@ -2104,13 +2177,13 @@ Page breaks are only relevant and honored in some output formats. A page break or a new page may be inserted manually using the following markup on a line on its own: <p> <br> -<pre> <:pb> +<pre><:pb> </pre> <p> <br> <p>or <p> <br> -<pre> <:pn> +<pre><:pn> </pre> <p> <br> page new <:pn> breaks the page, starts a new page. @@ -2127,8 +2200,8 @@ using an equal sign and curly braces. Currently two levels are provided, a main term and if needed a sub-term. Sub-terms are separated from the main term by a colon. <p> <br> -<pre> Paragraph containing main term and sub-term. - ={Main term:sub-term} +<pre> Paragraph containing main term and sub-term. + ={Main term:sub-term} </pre> <p> <br> The index syntax starts on a new line, but there should not be an empty @@ -2136,40 +2209,40 @@ line between paragraph and index markup. <p> <br> The structure of the resulting index would be: <p> <br> -<pre> Main term, 1 - sub-term, 1 +<pre> Main term, 1 + sub-term, 1 </pre> <p> <br> Several terms may relate to a paragraph, they are separated by a semicolon. If the term refers to more than one paragraph, indicate the number of paragraphs. <p> <br> -<pre> Paragraph containing main term, second term and sub-term. - ={first term; second term: sub-term} +<pre> Paragraph containing main term, second term and sub-term. + ={first term; second term: sub-term} </pre> <p> <br> The structure of the resulting index would be: <p> <br> -<pre> First term, 1, - Second term, 1, - sub-term, 1 +<pre> First term, 1, + Second term, 1, + sub-term, 1 </pre> <p> <br> If multiple sub-terms appear under one paragraph, they are separated under the main term heading from each other by a pipe symbol. <p> <br> -<pre> Paragraph containing main term, second term and sub-term. - ={Main term:sub-term+1|second sub-term} - A paragraph that continues discussion of the first sub-term +<pre> Paragraph containing main term, second term and sub-term. + ={Main term:sub-term+1|second sub-term} + A paragraph that continues discussion of the first sub-term </pre> <p> <br> The plus one in the example provided indicates the first sub-term spans one additional paragraph. The logical structure of the resulting index would be: <p> <br> -<pre> Main term, 1, - sub-term, 1-3, - second sub-term, 1, +<pre> Main term, 1, + sub-term, 1-3, + second sub-term, 1, </pre> <p> <h2><a name='sect42' href='#toc42'>10. Composite Documents Markup</a></h2> @@ -2193,8 +2266,8 @@ file, or <b>.ssi</b> (insert/information) A secondary file of the composite docu <p>basic markup for importing a document into a master document <p> <br> -<pre> << filename1.sst - << filename2.ssi +<pre><< filename1.sst +<< filename2.ssi </pre> <p> <br> The form described above should be relied on. Within the Vim editor it results @@ -2202,10 +2275,10 @@ in the text thus linked becoming hyperlinked to the document it is calling in which is convenient for editing. Alternative markup for importation of documents under consideration, and occasionally supported have been. <p> <br> -<pre> << filename.ssi - <<{filename.ssi} - % using textlink alternatives - << |filename.ssi|@|^| +<pre><< filename.ssi +<<{filename.ssi} +% using textlink alternatives +<< |filename.ssi|@|^| </pre> <p> <h2><a name='sect43' href='#toc43'>11. Markup Syntax History</a></h2> @@ -2232,22 +2305,22 @@ depreciated 0.16 supported, though file names were changed at 0.37 <b>SiSU 2.0</b> (2010-03-06:09/6) same as 1.0, apart from the changing of headers and the addition of a monospace tag related headers now grouped, e.g. <p> <br> -<pre> @title: - :subtitle: - @creator: - :author: - :translator: - :illustrator: - @rights: - :text: - :illustrations: +<pre>@title: + :subtitle: +@creator: + :author: + :translator: + :illustrator: +@rights: + :text: + :illustrations: </pre> <p> <br> see document markup samples, and sisu --help headers <p> <br> the monospace tag takes the form of a hash ’#’ <p> <br> -<pre> #{ this enclosed text would be monospaced }# +<pre>#{ this enclosed text would be monospaced }# </pre> <p> <br> <b>1.0</b> (2009-12-19:50/6) same as 0.69 @@ -2256,34 +2329,33 @@ the monospace tag takes the form of a hash ’#’ <p>of book index tags <p> <br> -<pre> /^={.+?}$/ +<pre>/^={.+?}$/ </pre> <p> <br> e.g. appended to a paragraph, on a new-line (without a blank line in between) logical structure produced assuming this is the first text "object" <p> <br> -<pre> ={GNU/Linux community distribution:Debian+2|Fedora|Gentoo;Free Software -Foundation+5} +<pre>={GNU/Linux community distribution:Debian+2|Fedora|Gentoo;Free Software Foundation+5} </pre> <p> <br> -<pre> Free Software Foundation, 1-6 - GNU/Linux community distribution, 1 - Debian, 1-3 - Fedora, 1 - Gentoo, +<pre>Free Software Foundation, 1-6 +GNU/Linux community distribution, 1 + Debian, 1-3 + Fedora, 1 + Gentoo, </pre> <p> <br> <b>0.66</b> (2008-02-24:07/7) same as previous, adds semantic tags, [experimental and not-used] <p> <br> -<pre> /[:;]{.+?}[:;][a-z+]/ +<pre>/[:;]{.+?}[:;][a-z+]/ </pre> <p> <br> <b>0.57</b> (2007w34/4) <b>SiSU</b> 0.57 is the same as 0.42 with the introduction of some a shortcut to use the headers @title and @creator in the first heading [expanded using the and @author:] <p> <br> -<pre> :A~ @title by @author +<pre>:A~ @title by @author </pre> <p> <br> <b>0.52</b> (2007w14/6) declared document type identifier at start of text/document: @@ -2311,8 +2383,8 @@ types, Introduces some variations on endnotes, in particular the use of the asterisk <p> <br> -<pre> ~{* for example for describing an author }~ and ~{** for describing a -second author }~ +<pre>~{* for example for describing an author }~ and ~{** for describing a second +author }~ </pre> <p> <br> * for example for describing an author @@ -2322,7 +2394,7 @@ second author }~ <p>and <p> <br> -<pre> ~[* my note ]~ or ~[+ another note ]~ +<pre>~[* my note ]~ or ~[+ another note ]~ </pre> <p> <br> @@ -2338,12 +2410,12 @@ second author }~ <b>SiSU</b> 0.38 introduced alternative experimental header and heading/structure markers, <p> <br> -<pre> @headername: and headers :A~ :B~ :C~ 1~ 2~ 3~ +<pre>@headername: and headers :A~ :B~ :C~ 1~ 2~ 3~ </pre> <p> <br> as the equivalent of: <p> <br> -<pre> 0~headername and headers 1~ 2~ 3~ 4~ 5~ 6~ +<pre>0~headername and headers 1~ 2~ 3~ 4~ 5~ 6~ </pre> <p> <br> @@ -2374,9 +2446,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 @@ -2461,7 +2533,7 @@ requiring any other documents; the .ssm marker flags that the document may contain other documents. <p> <br> Note: a secondary file of the composite document is built prior to processing -with the same prefix and the suffix ._sst [^17] +with the same prefix and the suffix ._sst [^18] <p> <br> <<a href='http://www.sisudoc.org/sisu/sisu_markup'>http://www.sisudoc.org/sisu/sisu_markup</a> > @@ -2705,7 +2777,7 @@ in the program. Documents take on a document skin, if the header of the document specifies a skin to be used. <p> <br> -<pre> @skin: skin_united_nations +<pre>@skin: skin_united_nations </pre> <p> <h2><a name='sect61' href='#toc61'>15.2 Directory Skin</a></h2> @@ -2774,9 +2846,10 @@ XHTML: xhtml.css <p> <br> Under consideration is to permit the placement of a CSS file with a different name in directory _sisu/css directory or equivalent, and change the default -CSS file that is looked for in a skin.[^18] +CSS file that is looked for in a skin.[^19] <p> -<h2><a name='sect65' href='#toc65'>17. Organising Content - Directory Structure and Mapping</a></h2> +<h2><a name='sect65' href='#toc65'>17. Organising Content - Directory +Structure and Mapping</a></h2> <br> <p> <br> @@ -2791,27 +2864,20 @@ The document source directory is the directory in which sisu processing commands are given. It contains the sisu source files (.sst .ssm .ssi), or (for sisu v3 may contain) subdirectories with language codes which contain the sisu source files, so all English files would go in subdirectory en/, -French in fr/, Spanish in es/ and so on. ISO ... codes are usedr. A list of -available languages (and possible sub-directory names) can be obtained with -the command "sisu --help lang" The list of languages is limited to langagues -supported by XeTeX polyglosia. +French in fr/, Spanish in es/ and so on. ISO 639-1 codes are used (as varied +by po4a). A list of available languages (and possible sub-directory names) +can be obtained with the command "sisu --help lang" The list of languages +is limited to langagues supported by XeTeX polyglosia. <p> <h2><a name='sect67' href='#toc67'>17.1.1 General Directories</a></h2> -<p> <br> -<pre> ./subject_name/ - % files stored at this level e.g. sisu_manual.sst or - % for sisu v3 may be under language sub-directories - % e.g. - ./subject_name/en - ./subject_name/fr - ./subject_name/es - ./subject_name/_sisu - % configuration file e.g. sisurc.yml - ./subject_name/_sisu/skin - % skins in various skin directories doc, dir, site, yml - ./subject_name/_sisu/css - ./subject_name/_sisu/image +<p> +<br> +<pre>% files stored at this level e.g. sisu_manual.sst or +% for sisu v3 may be under language sub-directories +% e.g. +% configuration file e.g. sisurc.yml +% skins in various skin directories doc, dir, site, yml </pre> <p> <h2><a name='sect68' href='#toc68'>17.2 Document Output Directory Structures</a></h2> @@ -2850,11 +2916,11 @@ appropriate different appearance. There are 3 possibile output structures described as being, by language, by filetype or by filename, the selection is made in sisurc.yml <p> <br> -<pre> #% output_dir_structure_by: language; filetype; or filename - output_dir_structure_by: language #(language & filetype, preferred?) - #output_dir_structure_by: filetype - #output_dir_structure_by: filename #(default, closest to original v1 -& v2) +<pre>#% output_dir_structure_by: language; filetype; or filename +output_dir_structure_by: language #(language & filetype, preferred?) +#output_dir_structure_by: filetype +#output_dir_structure_by: filename #(default, closest to original v1 & +v2) </pre> <p> <h2><a name='sect71' href='#toc71'>17.2.3 by Language</a></h2> @@ -2981,35 +3047,34 @@ output_dir_structure_by: filename <p> <br> -<pre> ./subject_name/ - % containing sub_directories named after the generated files from which +<pre>./subject_name/ +% containing sub_directories named after the generated files from which they are made - ./subject_name/src - % contains shared source files text and binary e.g. sisu_manual.sst and -sisu_manual.sst.zip - ./subject_name/_sisu - % configuration file e.g. sisurc.yml - ./subject_name/_sisu/skin - % skins in various skin directories doc, dir, site, yml - ./subject_name/_sisu/css - ./subject_name/_sisu/image - % images for documents contained in this directory - ./subject_name/_sisu/mm + ./subject_name/src +% contains shared source files text and binary e.g. sisu_manual.sst and sisu_manual.sst.zip + ./subject_name/_sisu +% configuration file e.g. sisurc.yml + ./subject_name/_sisu/skin +% skins in various skin directories doc, dir, site, yml + ./subject_name/_sisu/css + ./subject_name/_sisu/image +% images for documents contained in this directory + ./subject_name/_sisu/mm </pre> <p> <h2><a name='sect75' href='#toc75'>17.2.7 Sisupod</a></h2> <p> <br> -<pre> ./sisupod/ - % files stored at this level e.g. sisu_manual.sst - ./sisupod/_sisu - % configuration file e.g. sisurc.yml - ./sisupod/_sisu/skin - % skins in various skin directories doc, dir, site, yml - ./sisupod/_sisu/css - ./sisupod/_sisu/image - % images for documents contained in this directory - ./sisupod/_sisu/mm +<pre>./sisupod/ +% files stored at this level e.g. sisu_manual.sst + ./sisupod/_sisu +% configuration file e.g. sisurc.yml + ./sisupod/_sisu/skin +% skins in various skin directories doc, dir, site, yml + ./sisupod/_sisu/css + ./sisupod/_sisu/image +% images for documents contained in this directory + ./sisupod/_sisu/mm </pre> <p> <h2><a name='sect76' href='#toc76'>17.3 Organising Content</a></h2> @@ -3063,19 +3128,19 @@ have the homepage modified in skin_commercial law.rb; or the directory poems <p>in skin_poems.rb <p> <br> -<pre> class Home - def homepage - # place the html content of your homepage here, this will become +<pre> class Home + def homepage + # place the html content of your homepage here, this will become index.html - <<HOME <html> - <head></head> - <doc> - <p>this is my new homepage.</p> - </doc> - </html> - HOME - end + <<HOME <html> +<head></head> +<doc> +<p>this is my new homepage.</p> +</doc> +</html> +HOME end + end </pre> <p> <h2><a name='sect80' href='#toc80'>19. Markup and Output Examples</a></h2> @@ -3120,8 +3185,8 @@ the database directly or in various output formats. <h2><a name='sect84' href='#toc84'>21.1 Populating Sql Type Databases</a></h2> <p> <br> -<b>SiSU</b> feeds sisu markupd documents into sql type databases PostgreSQL[^19] -and/or SQLite[^20] database together with information related to document +<b>SiSU</b> feeds sisu markupd documents into sql type databases PostgreSQL[^20] +and/or SQLite[^21] database together with information related to document structure. <p> <br> This is one of the more interesting output forms, as all the structural @@ -3381,9 +3446,9 @@ INCLUDING OBJECT CITATION NUMBERING (BACKEND CURRENTLY POSTGRESQL) <p> <br> Sample search frontend <<a href='http://search.sisudoc.org'>http://search.sisudoc.org</a> -> [^21] A small database and +> [^22] A small database and sample query front-end (search from) that makes use of the citation system, -<i>object</i> citation numbering to demonstrates functionality.[^22] +<i>object</i> citation numbering to demonstrates functionality.[^23] <p> <br> <b>SiSU</b> can provide information on which documents are matched and at what locations within each document the matches are found. These results are @@ -3395,7 +3460,7 @@ the matched objects (paragraphs) in the documents matched. Note you may set results either for documents matched and object number locations within each matched document meeting the search criteria; or display the names of the documents matched along with the objects (paragraphs) -that meet the search criteria.[^23] +that meet the search criteria.[^24] <p> <dl> @@ -3410,14 +3475,14 @@ command: sisu --help sql<br> <p> <br> -<pre> Postgresql - user: ralph - current db set: SiSU_sisu - port: 5432 - dbi connect: DBI:Pg:database=SiSU_sisu;port=5432 - sqlite - current db set: /home/ralph/sisu_www/sisu/sisu_sqlite.db - dbi connect DBI:SQLite:/home/ralph/sisu_www/sisu/sisu_sqlite.db +<pre>Postgresql + user: ralph + current db set: SiSU_sisu + port: 5432 + dbi connect: DBI:Pg:database=SiSU_sisu;port=5432 +sqlite + current db set: /home/ralph/sisu_www/sisu/sisu_sqlite.db + dbi connect DBI:SQLite:/home/ralph/sisu_www/sisu/sisu_sqlite.db </pre> <p> <br> @@ -3562,7 +3627,7 @@ up files in plaintext .sst or .ssm or; zipped sisu files, sisupod.zip or filenam the processing instruction and the url. The source file and any associated parts (such as images) will be downloaded and generated locally. <p> <br> -<pre> sisu -3 http://[provide url to valid .sst or .ssm file] +<pre>sisu -3 http://[provide url to valid .sst or .ssm file] </pre> <p> <br> Any of the source documents in the sisu examples page can be used in this @@ -3585,7 +3650,7 @@ other associated parts to the document such as images. the processing instruction and the url, the sisupod will be downloaded and the documents it contains generated locally. <p> <br> -<pre> sisu -3 http://[provide url to valid sisupod.zip or .ssp file] +<pre>sisu -3 http://[provide url to valid sisupod.zip or .ssp file] </pre> <p> <br> Any of the source documents in the sisu examples page can be used in this @@ -3609,7 +3674,7 @@ tool will need to be configured. Once that is done the placement on a remote host can be done seamlessly with the -r (for scp) or -R (for rsync) flag, which may be used in conjunction with other processing flags, e.g. <p> <br> -<pre> sisu -3R sisu_remote.sst +<pre>sisu -3R sisu_remote.sst </pre> <p> <h2><a name='sect114' href='#toc114'>27.1 Commands</a></h2> @@ -3668,8 +3733,8 @@ for what it does. possibly Ubuntu), assuming your /etc/apt/sources.list is set accordingly: <p> <br> -<pre> aptitude update - aptitude install sisu-complete +<pre> aptitude update + aptitude install sisu-complete </pre> <p> <br> The following /etc/apt/sources.list setting permits the download of additional @@ -3695,16 +3760,16 @@ If there are newer versions of <b>SiSU</b> upstream of the <b>Debian</b> archive <p>will be available by adding the following to your /etc/apt/sources.list <p> <br> -<pre> #/etc/apt/sources.list - deb http://www.jus.uio.no/sisu/archive unstable main non-free - deb-src http://www.jus.uio.no/sisu/archive unstable main non-free +<pre>#/etc/apt/sources.list + deb http://www.jus.uio.no/sisu/archive unstable main non-free + deb-src http://www.jus.uio.no/sisu/archive unstable main non-free </pre> <p> <br> <p>repeat the aptitude commands <p> <br> -<pre> aptitude update - aptitude install sisu-complete sisu-markup-samples +<pre> aptitude update + aptitude install sisu-complete sisu-markup-samples </pre> <p> <br> Note however that it is not necessary to install sisu-complete if not all @@ -3751,7 +3816,7 @@ it is written <b>Ruby,</b> and <b>SiSU</b> will be able to generate html, EPUB, XMLs, including ODF (and will also produce LaTeX). Dependencies required for further actions, though it relies on the installation of additional dependencies which the source tarball does not take care of, for things -like using a database (postgresql or sqlite)[^24] or converting LaTeX to +like using a database (postgresql or sqlite)[^25] or converting LaTeX to pdf. <p> <br> @@ -3760,10 +3825,10 @@ pdf. This is a standard ruby installer, using setup.rb is a three step process. In the root directory of the unpacked <b>SiSU</b> as root type: <p> <br> -<pre> ruby setup.rb config - ruby setup.rb setup - #[and as root:] - ruby setup.rb install +<pre> ruby setup.rb config + ruby setup.rb setup + #[and as root:] + ruby setup.rb install </pre> <p> <br> further information on setup.rb is available from: @@ -3918,13 +3983,13 @@ The man pages are also available online, though not always kept as up to date as within the package itself: <p> <br> * sisu.1 <<a href='http://www.jus.uio.no/sisu/man/sisu.1.html'>http://www.jus.uio.no/sisu/man/sisu.1.html</a> -> [^25] +> [^26] <p> <br> * sisu.8 <<a href='http://www.jus.uio.no/sisu/man/sisu.8.html'>http://www.jus.uio.no/sisu/man/sisu.8.html</a> -> [^26] +> [^27] <p> <br> * man directory <<a href='http://www.jus.uio.no/sisu/man'>http://www.jus.uio.no/sisu/man</a> -> [^27] +> [^28] <p> <h2><a name='sect128' href='#toc128'>29.3.2 Built in Help</a></h2> @@ -3965,7 +4030,7 @@ Additional markup samples are packaged separately in the file: <p> <br> *** <p> <br> -On <b>Debian</b> they are available in non-free[^28] to include them it is necessary +On <b>Debian</b> they are available in non-free[^29] to include them it is necessary to include non-free in your /etc/apt/source.list or obtain them from the sisu home site. <p> @@ -4218,7 +4283,8 @@ as<br> <p> <br> * sql - population of an sql database, (at the same object level that -is used to cite text within a document)<br> +is<br> + used to cite text within a document)<br> <p> <br> Also produces: concordance files; document content certificates (md5 or @@ -4374,7 +4440,7 @@ to form a document. <p> <br> Note <b>SiSU</b> documentation is prepared in <b>SiSU</b> and output is available in multiple formats including amongst others html, pdf, odf and epub, which -may be also be accessed via the html pages[^29] +may be also be accessed via the html pages[^30] <p> <h2><a name='sect137' href='#toc137'>33.2.1 Www.sisudoc.org</a></h2> @@ -4578,11 +4644,11 @@ within each your matches are found. </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 +29. the <b>Debian</b> Free Software guidelines require that everything distributed within <b>Debian</b> can be changed - and the documents are authors’ works that while freely distributable are not freely changeable. <p> <br> -29. named index.html or more extensively through sisu_manifest.html <br> +30. named index.html or more extensively through sisu_manifest.html <br> <p> </li> </ol> |