diff options
Diffstat (limited to 'data/doc/sisu')
| -rw-r--r-- | data/doc/sisu/CHANGELOG_v3 | 2 | ||||
| -rw-r--r-- | data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst | 184 |
2 files changed, 106 insertions, 80 deletions
diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index 8018e0c5..b432aab8 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -71,6 +71,8 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.1.15.orig.tar.xz * v3dv, vim syntax highlighting, document header added :omit: (under @make:) for document output features to be omitted if any +* v3dv, documentation sisu_commands, rearranged & update with regard to excludes + * texinfo, fix (break holding back 3.2 merge) [proposed next version starts 3.2, (merge dev branch after 3.1.15)] 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 253553a0..13682dce 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst @@ -63,6 +63,15 @@ produces plaintext with Unix linefeeds and without markup, (object numbers are o !_ -b [filename/wildcard] \\ see --xhtml +!_ -C \\ +configure/initialise shared output directory files initialize shared output directory (config files such as css and dtd files are not updated if they already exist unless modifier is used). -C --init-site configure/initialise site more extensive than -C on its own, shared output directory files/force update, existing shared output config files such as css and dtd files are updated if this modifier is used. + +!_ -CC \\ +see --configure + +!_ -c [filename/wildcard] \\ +see --color-toggle + !_ --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 @@ -72,14 +81,11 @@ configure/initialise shared output directory files initialize shared output dire !_ --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 \\ -configure/initialise shared output directory files initialize shared output directory (config files such as css and dtd files are not updated if they already exist unless modifier is used). -C --init-site configure/initialise site more extensive than -C on its own, shared output directory files/force update, existing shared output config files such as css and dtd files are updated if this modifier is used. - -!_ -CC \\ -see --configure +!_ -D [instruction] [filename] \\ +see --pg -!_ -c [filename/wildcard] \\ -see --color-toggle +!_ -d [--db-[database type (sqlite|pg)]] --[instruction] [filename] \\ +see --sqlite !_ --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 @@ -90,20 +96,28 @@ see --zap !_ --dump[=directory_path] [filename/wildcard] \\ places output in directory specified, if none is specified in the current directory (pwd). Compare --redirect -!_ -D [instruction] [filename] \\ -see --pg - -!_ -d [--db-[database type (sqlite|pg)]] --[instruction] [filename] \\ -see --sqlite +!_ -e [filename/wildcard] \\ +see --epub !_ --epub [filename/wildcard] \\ produces an epub document, [sisu version >=2 ] (filename.epub). Alias -e -!_ -e [filename/wildcard] \\ -see --epub - -!_ --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 +!_ --exc-* \\ +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-* !_ -F [--webserv=webrick] \\ see --sample-search-form @@ -111,11 +125,8 @@ see --sample-search-form !_ -f [optional string part of filename] \\ see --find -!_ --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] \\ -see --find +!_ --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 !_ -G [optional string part of filename] \\ see --find @@ -123,6 +134,15 @@ see --find !_ -g [filename/wildcard] \\ see --git +!_ --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] \\ +see --find + +!_ -h [filename/wildcard] \\ +see --html + !_ --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. @@ -132,15 +152,16 @@ provides help on the selected topic, where topics (keywords) include: list, (com !_ --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] \\ -see --html - !_ -I [filename/wildcard] \\ see --texinfo !_ -i [filename/wildcard] \\ see --manpage +!_ --inc-* \\ +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-* + !_ -j [filename/wildcard] \\ copies images associated with a file for use by html, xhtml & xml outputs (automatically invoked by --dump & redirect). @@ -150,6 +171,12 @@ see --maintenance !_ -L \\ prints license information. +!_ -M [filename/wildcard/url] \\ +see --maintenance + +!_ -m [filename/wildcard/url] \\ +see --dal (document abstraction level/layer) + !_ --machine [filename/wildcard/url] \\ see --dal (document abstraction level/layer) @@ -159,29 +186,32 @@ maintenance mode, interim processing files are preserved and their locations ind !_ --manpage [filename/wildcard] \\ produces man page of file, not suitable for all outputs. Alias -i -!_ -M [filename/wildcard/url] \\ -see --maintenance - -!_ -m [filename/wildcard/url] \\ -see --dal (document abstraction level/layer) - -!_ --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] \\ 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] \\ 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. +!_ --no-* \\ +see --exc-* + +!_ --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. + +!_ -o [filename/wildcard/url] \\ +see --odt + !_ --odf [filename/wildcard/url] \\ see --odt !_ --odt [filename/wildcard/url] \\ output basic document in opendocument file format (opendocument.odt). Alias -o -!_ -o [filename/wildcard/url] \\ -see --odt +!_ -P [language_directory/filename language_directory] \\ +see --po4a + +!_ -p [filename/wildcard] \\ +see --pdf !_ --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 @@ -195,11 +225,11 @@ see --po4a !_ --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] \\ -see --po4a +!_ -Q [filename/wildcard] \\ +see --qrcode -!_ -p [filename/wildcard] \\ -see --pdf +!_ -q [filename/wildcard] \\ +see --quiet !_ --qrcode [filename/wildcard] \\ generate QR code image of metadata (used in manifest). v3 only. @@ -207,11 +237,11 @@ generate QR code image of metadata (used in manifest). v3 only. !_ --quiet [filename/wildcard] \\ quiet less output to screen. -!_ -Q [filename/wildcard] \\ -see --qrcode +!_ -R [filename/wildcard] \\ +see --rsync -!_ -q [filename/wildcard] \\ -see --quiet +!_ -r [filename/wildcard] \\ +see --scp !_ --redirect[=directory_path] [filename/wildcard] \\ 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 @@ -219,11 +249,14 @@ places output in subdirectory under specified directory, subdirectory uses the f !_ --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] \\ -see --rsync +!_ -S \\ +see --sisupod -!_ -r [filename/wildcard] \\ -see --scp +!_ -S [filename/wildcard] \\ +see --sisupod + +!_ -s [filename/wildcard] \\ +see --source !_ --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 @@ -232,7 +265,7 @@ generate examples of (naive) cgi search form for sqlite and pgsql depends on you 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] \\ -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 +database type set to sqlite, 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 !_ --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 @@ -243,14 +276,11 @@ produces a zipped file of the prepared document specified along with associated !_ --source [filename/wildcard] \\ copies sisu markup file to output directory. Alias -s -!_ -S \\ -see --sisupod - -!_ -S [filename/wildcard] \\ -see --sisupod +!_ -T [filename/wildcard (*.termsheet.rb)] \\ +standard form document builder, preprocessing feature -!_ -s [filename/wildcard] \\ -see --source +!_ -t [filename/wildcard] \\ +see --txt !_ --texinfo [filename/wildcard] \\ produces texinfo and info file, (view with pinfo). Alias -I @@ -258,29 +288,14 @@ produces texinfo and info file, (view with pinfo). Alias -I !_ --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)] \\ -standard form document builder, preprocessing feature - -!_ -t [filename/wildcard] \\ -see --txt - -!_ --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] \\ see --urls !_ -u [filename/wildcard] \\ provides url mapping of output files for the flags requested for processing, also see -U -!_ --v2 [filename/wildcard] \\ -invokes the sisu v2 document parser/generator. This is the default and is normally omitted. - -!_ --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] \\ -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 +!_ --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 !_ -V \\ on its own, provides SiSU version and environment information (sisu --help env) @@ -294,16 +309,25 @@ on its own, provides SiSU version information !_ -v [filename/wildcard] \\ see --verbose -!_ --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 +!_ --v2 [filename/wildcard] \\ +invokes the sisu v2 document parser/generator. This is the default and is normally omitted. + +!_ --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] \\ +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 !_ -W \\ see --webrick -!_ --wordmap [filename/wildcard] \\ +!_ -w [filename/wildcard] \\ see --concordance -!_ -w [filename/wildcard] \\ +!_ --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 + +!_ --wordmap [filename/wildcard] \\ see --concordance !_ --xhtml [filename/wildcard] \\ @@ -327,12 +351,12 @@ produces a short sitemap entry for the document, based on html output and the si !_ -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] \\ -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] \\ see --zap +!_ --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 + 1~command_modifiers command line modifiers !_ --no-ocn \\ |