diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 54 |
1 files changed, 29 insertions, 25 deletions
@@ -297,11 +297,8 @@ 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 @@ -310,6 +307,13 @@ 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 @@ -444,12 +448,17 @@ see --dal (document abstraction level/layer) 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-* @@ -457,10 +466,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 @@ -542,10 +548,10 @@ 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]* +*--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 +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 @@ -621,15 +627,15 @@ set hash digest where used to sha256 *--sha512* set hash digest where used to sha512 -*--sqlite --[instruction] [filename]* +*--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 +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 @@ -773,9 +779,7 @@ 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 @@ -808,8 +812,8 @@ DATABASE COMMANDS *dbi - database interface* -*-D or --pgsql* set for /PostgreSQL/ *-d or --sqlite* default set for /SQLite/ --d is modifiable with --db=[database type (PgSQL or /SQLite/) ] +*--pg or --pgsql* set for /PostgreSQL/ *--sqlite* default set for /SQLite/ -d +is modifiable with --db=[database type (PgSQL or /SQLite/) ] *--pg -v --createall* initial step, creates required relations (tables, indexes) in existing @@ -1626,7 +1630,7 @@ This is a table┆this would become column two of row one┆column three of row a second form may be easier to work with in cases where there is not much information in each column -*markup example:*[^10] +*markup example:*[^9] !_ Table 3.1: Contributors to Wikipedia, January 2001 - June 2005 @@ -2168,6 +2172,6 @@ Configure substitution in _sisu/sisu_document_make [8]: <http://www.ruby-lang.org/en/> - [10]: Table from the Wealth of Networks by Yochai Benkler + [9]: Table from the Wealth of Networks by Yochai Benkler <http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler> |