diff options
Diffstat (limited to 'data/doc/sisu/markup-samples/manual/en')
6 files changed, 26 insertions, 26 deletions
diff --git a/data/doc/sisu/markup-samples/manual/en/sisu_commands.sst b/data/doc/sisu/markup-samples/manual/en/sisu_commands.sst index 356f38e1..016ef7ea 100644 --- a/data/doc/sisu/markup-samples/manual/en/sisu_commands.sst +++ b/data/doc/sisu/markup-samples/manual/en/sisu_commands.sst @@ -286,7 +286,7 @@ see --qrcode see --quiet !_ --qrcode [filename/wildcard] \\ -generate QR code image of metadata (used in manifest). v3 only. +generate QR code image of metadata (used in manifest). !_ --quiet [filename/wildcard] \\ quiet less output to screen. @@ -315,8 +315,8 @@ see --sisupod !_ -s [filename/wildcard] \\ see --source -!_ --sample-search-form [--db=(pgsql|sqlite)] [--webserv=webrick] \\ -generate examples of (naive) cgi search form for SQLite or PgSQL depends on your already having used sisu to populate an SQLite or PgSQL database, (the SQLite version scans the output directories for existing sisu_sqlite databases, so it is first necessary to create them, before generating the search form) see --sqlite & --pg and the database section below. Optional additional parameters include: url location of webserver search form and db: --webserv-search='[url]'; location of webserver output: --webserv-output='[url]'; cgi search form link name: --cgi-search-form-name='[name.cgi]'; for pgsql, database user: --db-user='[username]'. 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 +!_ --sample-search-form [--db-(pg|sqlite)] \\ +generate examples of (naive) cgi search form for SQLite or PgSQL depends on your already having used sisu to populate an SQLite or PgSQL database, (the SQLite version scans the output directories for existing sisu_sqlite databases, so it is first necessary to create them, before generating the search form) see --sqlite & --pg and the database section below. Optional additional parameters: --db-user='www-data'. The samples are dumped in the present work directory which must be writable, (with screen instructions given that they be copied to the cgi-bin directory). Alias -F !_ --scp [filename/wildcard] \\ copies sisu output files to remote host using scp. This requires that sisurc.yml has been provided with information on hostname and username, and that you have your "keys" and ssh agent in place. Also see --rsync. Alias -r @@ -484,7 +484,7 @@ The -v is for verbose output. Checks existing file output and runs the flags required to update this output. This means that if only html and pdf output was requested on previous runs, only the -hp files will be applied, and only these will be generated this time, together with the summary. This can be very convenient, if you offer different outputs of different files, and just want to do the same again. !_ -0 to -5 [filename or wildcard] \\ -Default shorthand mappings (for v3, note that the defaults can be changed/configured in the sisurc.yml file): +Default shorthand mappings (note that the defaults can be changed/configured in the sisurc.yml file): !_ -0 \\ -NQhewpotbxXyYv [this is the default action run when no options are give, i.e. on 'sisu [filename]'] diff --git a/data/doc/sisu/markup-samples/manual/en/sisu_config.ssi b/data/doc/sisu/markup-samples/manual/en/sisu_config.ssi index 3c29f995..a53d5cc6 100644 --- a/data/doc/sisu/markup-samples/manual/en/sisu_config.ssi +++ b/data/doc/sisu/markup-samples/manual/en/sisu_config.ssi @@ -33,15 +33,15 @@ The SiSU configuration file is a yaml file, which means indentation is significa SiSU resource configuration is determined by looking at the following files if they exist: -_1 ./_sisu/v4/sisurc.yml +_1 ./_sisu/v5/sisurc.yml _1 ./_sisu/sisurc.yml -_1 ~/.sisu/v4/sisurc.yml +_1 ~/.sisu/v5/sisurc.yml _1 ~/.sisu/sisurc.yml -_1 /etc/sisu/v4/sisurc.yml +_1 /etc/sisu/v5/sisurc.yml _1 /etc/sisu/sisurc.yml @@ -59,15 +59,15 @@ Most sisu document headers relate to metadata, the exception is the @make: heade The search order is as for resource configuration: -_1 ./_sisu/v4/sisu_document_make +_1 ./_sisu/v5/sisu_document_make _1 ./_sisu/sisu_document_make -_1 ~/.sisu/v4/sisu_document_make +_1 ~/.sisu/v5/sisu_document_make _1 ~/.sisu/sisu_document_make -_1 /etc/sisu/v4/sisu_document_make +_1 /etc/sisu/v5/sisu_document_make _1 /etc/sisu/sisu_document_make diff --git a/data/doc/sisu/markup-samples/manual/en/sisu_howto.sst b/data/doc/sisu/markup-samples/manual/en/sisu_howto.sst index afba3e48..050c91b7 100644 --- a/data/doc/sisu/markup-samples/manual/en/sisu_howto.sst +++ b/data/doc/sisu/markup-samples/manual/en/sisu_howto.sst @@ -253,27 +253,27 @@ _1 sisu -vR[and processing flags] [filename/wildcard] Sample provided, on untarring the source tarball: -_1 conf/sisu/v4/sisurc.yml - _1 conf/sisu/v5/sisurc.yml -and on installation under: +_1 conf/sisu/v6/sisurc.yml -_1 /etc/sisu/v4/sisurc.yml +and on installation under: _1 /etc/sisu/v5/sisurc.yml +_1 /etc/sisu/v6/sisurc.yml + The following paths are searched: -_1 ./_sisu/v4/sisurc.yml or ./_sisu/v5/sisurc.yml +_1 ./_sisu/v5/sisurc.yml or ./_sisu/v6/sisurc.yml _1 ./_sisu/sisurc.yml -_1 ~/.sisu/v4/sisurc.yml or ~/.sisu/v5/sisurc.yml +_1 ~/.sisu/v5/sisurc.yml or ~/.sisu/v6/sisurc.yml _1 ~/.sisu/sisurc.yml -_1 /etc/sisu/v4/sisurc.yml /etc/sisu/v5/sisurc.yml +_1 /etc/sisu/v5/sisurc.yml /etc/sisu/v6/sisurc.yml _1 /etc/sisu/sisurc.yml @@ -564,7 +564,7 @@ To import another document, the master document or importing document should be 2~ Skins -"Skins" are gone in v4 replaced by @make: :header: within a document, and a common shared _sisu/sisu_document_make file (which uses identical parameters to the individual documents @make: :header:) +"Skins" are gone since v4 replaced by @make: :header: within a document, and a common shared _sisu/sisu_document_make file (which uses identical parameters to the individual documents @make: :header:) 2~ CSS @@ -1130,11 +1130,11 @@ _1 http://www.jus.uio.no/sisu/SiSU/examples.html There is syntax support for some editors provided (together with a README file) in -_1 ./data/sisu/v4/conf/editor-syntax-etc +_1 ./data/sisu/v5/conf/editor-syntax-etc usually installed to: -_1 /usr/share/sisu/v4/conf/editor-syntax-etc +_1 /usr/share/sisu/v5/conf/editor-syntax-etc 2~ License diff --git a/data/doc/sisu/markup-samples/manual/en/sisu_install_run.sst b/data/doc/sisu/markup-samples/manual/en/sisu_install_run.sst index cadcde61..667a6459 100644 --- a/data/doc/sisu/markup-samples/manual/en/sisu_install_run.sst +++ b/data/doc/sisu/markup-samples/manual/en/sisu_install_run.sst @@ -23,7 +23,7 @@ 2~ run off source package directory tree (without installing) -1. Download the latest source (information available) from: http://www.jus.uio.no/sisu/SiSU/download.html#current +1. Download the latest source 2. Unpack the source diff --git a/data/doc/sisu/markup-samples/manual/en/sisu_markup.sst b/data/doc/sisu/markup-samples/manual/en/sisu_markup.sst index e3eefbac..08128821 100644 --- a/data/doc/sisu/markup-samples/manual/en/sisu_markup.sst +++ b/data/doc/sisu/markup-samples/manual/en/sisu_markup.sst @@ -210,8 +210,8 @@ code{ synopsis=sisu [-abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0-9] [filename/wildcard ] . sisu [-Ddcv] [instruction] . sisu [-CcFLSVvW] - . sisu --v4 [operations] - . sisu --v3 [operations] + . sisu --v5 [operations] + . sisu --v6 [operations] @links: { SiSU Homepage }http://www.sisudoc.org/ diff --git a/data/doc/sisu/markup-samples/manual/en/sisu_synopsis.ssi b/data/doc/sisu/markup-samples/manual/en/sisu_synopsis.ssi index 98e5d4f3..81644d76 100644 --- a/data/doc/sisu/markup-samples/manual/en/sisu_synopsis.ssi +++ b/data/doc/sisu/markup-samples/manual/en/sisu_synopsis.ssi @@ -33,13 +33,13 @@ sisu [ -CcFLSVvW ] Note: commands should be issued from within the directory that contains the marked up files, cd to markup directory. -sisu is at version 2, version 3 is under development. To use sisu version 3 +sisu ships with version5 and version 6 (which is under development). -sisu --v3 [and options/operations as above] +sisu --v6 [and options/operations as above] or -sisu3 [and options/operations as above] +sisu6 [and options/operations as above] sisu version 1 has been discontinued. |