From 743e040727792bb3aa07434aae26b14b67a24d42 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 22 Jul 2014 21:53:02 -0400 Subject: documentation related --- .../markup-samples/manual/en/sisu_commands.sst | 33 ++++++++++++---------- 1 file changed, 18 insertions(+), 15 deletions(-) (limited to 'data/doc') 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 16661dd6..7af33161 100644 --- a/data/doc/sisu/markup-samples/manual/en/sisu_commands.sst +++ b/data/doc/sisu/markup-samples/manual/en/sisu_commands.sst @@ -79,11 +79,8 @@ 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 -!_ -D [instruction] [filename] \\ -see --pg - -!_ -d [--db-[database type (sqlite|pg)]] --[instruction] [filename] \\ -see --sqlite +!_ -d [filename/wildcard/url] \\ +see --docbook !_ --dal [filename/wildcard/url] \\ (abstract objects, document abstraction renamed abstract objects in sisu5) see --ao @@ -91,6 +88,9 @@ see --sqlite !_ --delete [filename/wildcard] \\ see --zap +!_ --digests [filename/wildcard/url] \\ +document digest or document content certificate ( DCC ) as sha 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). --digests -V for verbose digest output to screen. + !_ --docbook [filename/wildcard/url] \\ docbook xml @@ -203,12 +203,15 @@ see --dal (document abstraction level/layer) !_ --maintenance [filename/wildcard/url] \\ maintenance mode, interim processing files are preserved and their locations indicated. (also see -V). Aliases -M and --keep-processing-files. -!_ --markdown [filename/wildcard/url] \\ -markdown smart text (not available) +!_ --manifest [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. !_ --manpage [filename/wildcard] \\ produces man page of file, not suitable for all outputs. Alias -i +!_ --markdown [filename/wildcard/url] \\ +markdown smart text (not available) + !_ --monolingual \\ see --i18n-* @@ -216,7 +219,7 @@ see --i18n-* see --i18n-* !_ -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. +see --digests !_ -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. @@ -273,8 +276,8 @@ See --pdf-portrait !_ --pdf-portrait [filename/wildcard] \\ sets orientation, produces LaTeX pdf portrait.pdf.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). Related options --pdf --pdf-landscape. See also --papersize-* or --papersize=[list]. Alias --pdf-p or in conjunction with --pdf --portrait -!_ --pg [instruction] [filename] \\ -database PostgreSQL ( --pgsql may be used instead) possible instructions, include: --createdb; --create; --dropall; --import [filename]; --update [filename]; --remove [filename]; see database section below. Alias -D +!_ --pg-[instruction] [filename] \\ +database PostgreSQL ( --pgsql may be used instead) possible instructions, include: --pg-createdb; --pg-create; --pg-dropall; --pg-import [filename]; --pg-update [filename]; --pg-remove [filename]; see database section below. !_ --po [language_directory/filename language_directory] \\ see --po4a @@ -330,8 +333,8 @@ set hash digest where used to sha256 !_ --sha512 \\ set hash digest where used to sha512 -!_ --sqlite --[instruction] [filename] \\ -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 +!_ --sqlite-[instruction] [filename] \\ +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: --sqlite-createdb; --sqlite-create; --sqlite-dropall; --sqlite-import [filename]; --sqlite-update [filename]; --sqlite-remove [filename]); see database section below. !_ --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 @@ -433,7 +436,7 @@ see --xml-sax produces a short sitemap entry for the document, based on html output and the sisu_manifest. --sitemaps generates/updates the sitemap index of existing sitemaps. (Experimental, [g,y,m announcement this week]) !_ -y [filename/wildcard] \\ -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. +see --manifest !_ -Z [filename/wildcard] \\ see --zap @@ -459,9 +462,9 @@ strips output text of editor endnotes~[+ square brackets ]~ denoted by dagger/pl !_ dbi - database interface -!_ -D or --pgsql +!_ --pg or --pgsql set for PostgreSQL -!_ -d or --sqlite +!_ --sqlite default set for SQLite -d is modifiable with --db=[database type (PgSQL or SQLite)] !_ --pg -v --createall \\ -- cgit v1.2.3