From 026075321e776034a1bb5543246d55e5a0f59e83 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Thu, 8 Dec 2011 21:29:57 -0500 Subject: v3: documentation, manpage & html (man2html) --- data/doc/sisu/CHANGELOG_v3 | 3 + data/doc/sisu/html/sisu.1.html | 213 +++++++++++++++++++++++++++++------------ man/man1/sisu.1 | 112 +++++++++++++++++++--- 3 files changed, 254 insertions(+), 74 deletions(-) diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index 6c5645da..8f9c2cea 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -34,6 +34,9 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.1.7.orig.tar.xz * documentation, add --configure & use ascii characters for dir tree correction of a few typos + * manpage + * html + %% 3.1.6.orig.tar.xz (2011-12-02:48/5) http://git.sisudoc.org/?p=code/sisu.git;a=log;h=refs/tags/sisu_3.1.6 http://git.sisudoc.org/?p=code/sisu.git;a=log;h=refs/tags/debian/sisu_3.1.6-1 diff --git a/data/doc/sisu/html/sisu.1.html b/data/doc/sisu/html/sisu.1.html index e973641b..106502ee 100644 --- a/data/doc/sisu/html/sisu.1.html +++ b/data/doc/sisu/html/sisu.1.html @@ -200,6 +200,16 @@ colour default is set to ’false’ or is undefined screen output will colour). Alias -c

+

--configure
+
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. +

+
--concordance [filename/wildcard]
produces concordance (wordmap) a rudimentary index of all the words in a document. (Concordance files are @@ -207,10 +217,10 @@ not generated for documents of over 260,000 words unless this limit is increased in the file sisurc.yml). Alias -w

-
-C [--init-site]
-
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 +
-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 @@ -218,82 +228,75 @@ is used.

-CC
-
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. +
see --configure +

+ +
-c [filename/wildcard]
+
see --color-toggle

-
-c [filename/wildcard] +
--dal [filename/wildcard/url]
-
-

see --color-toggle +

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

-
--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 +
--delete [filename/wildcard]
+
see --zap

-
--delete [filename/wildcard] +
-D [instruction] [filename]
-

see --zap +

see --pg

-
-D [instruction] [filename]
-
see --pg -

- -
-d [--db-[database  type  (sqlite|pg)]] ---[instruction] [filename]
+
-d [--db-[database  type  (sqlite|pg)]] --[instruction] [filename]
see --sqlite +

--epub [filename/wildcard]
-
produces -an epub document, [sisu  version  >=2  ] (filename.epub). Alias -e +
produces an epub document, [sisu  version  >=2  ] +(filename.epub). Alias -e

-
-e [filename/wildcard] -
-
-

see --epub +

-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 +
--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

-F [--webserv=webrick]
see --sample-search-form -

-
-f [optional  string  part  of  filename]
+
-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 +
--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 +

--glob [optional  string  part  of  filename]
+
see --find

-
-G [optional  string  part  of  filename]
+
-G +[optional  string  part  of  filename]
see --find

@@ -304,19 +307,19 @@ and subject to change). Alias -g

--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. +
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.

--help [topic]
-
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, +
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

@@ -676,7 +679,8 @@ deep document structure, in the nature of dom. Alias -X

-Y [filename/wildcard]
-
produces a short sitemap entry for the document, based on html output and the sisu_manifest. +
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])

@@ -1486,7 +1490,7 @@ normal text <http://www.sisudoc.org/ markup example: 


  normal text _http://www.sisudoc.org/ continues
-  deb http://www.jus.uio.no/sisu/archive unstable main non-free
+  deb _http://www.jus.uio.no/sisu/archive unstable main non-free


resulting output: @@ -1555,6 +1559,13 @@ Debian and Ruby" }http://www.sisudoc.org/ {~^ ruby_logo.png "Ruby" }http://www.ruby-lang.org/en/ +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/


resulting output: @@ -1634,8 +1645,8 @@ Tables 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. + * Contributed at least ten times; ** at least 5 times in last month; +*** more than 100 times in last month.


resulting output: @@ -2148,7 +2159,7 @@ If multiple sub-terms appear under one paragraph, they are separated under the main term heading from each other by a pipe symbol. 


    Paragraph containing main term, second term and sub-term.
-    ={Main term:sub-term+1|second sub-term
+    ={Main term:sub-term+1|second sub-term}
     A paragraph that continues discussion of the first sub-term


@@ -2773,6 +2784,7 @@ CSS file that is looked for in a skin.[^18] structures of which there are 3 alternatives.

17.1 Document Source Directory

+


The document source directory is the directory in which sisu processing @@ -2860,6 +2872,34 @@ by filetype.


output_dir_structure_by: language


+

    |-- en
+    |-- epub
+    |-- hashes
+    |-- html
+    | |-- viral_spiral.david_bollier
+    | |-- manifest
+    | |-- qrcode
+    | |-- odt
+    | |-- pdf
+    | |-- sitemaps
+    | |-- txt
+    | |-- xhtml
+    | ‘-- xml
+    |-- po4a
+    | ‘-- live-manual
+    |     |-- po
+    |     |-- fr
+    |     ‘-- pot
+    ‘-- _sisu
+        |-- css
+        |-- image
+        |-- image_sys -> ../../_sisu/image_sys
+        ‘-- xml
+            |-- rnc
+            |-- rng
+            ‘-- xsd
+
+


#by: language subject_dir/en/manifest/filename.html

17.2.4 by Filetype

@@ -2874,6 +2914,33 @@ given a language extension.


output_dir_structure_by: filetype


+

    |-- epub
+    |-- hashes
+    |-- html
+    |-- viral_spiral.david_bollier
+    |-- manifest
+    |-- qrcode
+    |-- odt
+    |-- pdf
+    |-- po4a
+    |-- live-manual
+    |     |-- po
+    |     |-- fr
+    |     ‘-- pot
+    |-- _sisu
+    | |-- css
+    | |-- image
+    | |-- image_sys -> ../../_sisu/image_sys
+    | ‘-- xml
+    |     |-- rnc
+    |     |-- rng
+    |     ‘-- xsd
+    |-- sitemaps
+    |-- txt
+    |-- xhtml
+    ‘-- xml
+
+


#by: filetype subject_dir/html/filename/manifest.en.html

17.2.5 by Filename

@@ -2888,6 +2955,26 @@ file (the different filetypes) in a common directory.


output_dir_structure_by: filename


+

    |-- epub
+    |-- po4a
+    |-- live-manual
+    |     |-- po
+    |     |-- fr
+    |     ‘-- pot
+    |-- _sisu
+    | |-- css
+    | |-- image
+    | |-- image_sys -> ../../_sisu/image_sys
+    | ‘-- xml
+    |     |-- rnc
+    |     |-- rng
+    |     ‘-- xsd
+    |-- sitemaps
+    |-- src
+    |-- pod
+    ‘-- viral_spiral.david_bollier
+
+


#by: filename subject_dir/filename/manifest.en.html

17.2.6 Remote Directories

diff --git a/man/man1/sisu.1 b/man/man1/sisu.1 index 9a3e5535..1d4d280b 100644 --- a/man/man1/sisu.1 +++ b/man/man1/sisu.1 @@ -1,4 +1,4 @@ -.TH "sisu" "1" "2011-10-03" "3.1.0" "SiSU" +.TH "sisu" "1" "2011-12-08" "3.1.7" "SiSU" .br .SH NAME .br @@ -220,6 +220,15 @@ 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 +.TP +.B \-\-configure +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. + .TP .B \-\-concordance [filename/wildcard] produces concordance (wordmap) a rudimentary index of all the words in a @@ -227,7 +236,7 @@ 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 .TP -.B \-C [\-\-init\-site] +.B \-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 @@ -237,12 +246,7 @@ updated if this modifier is used. .TP .B \-CC -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. +see \-\-configure .TP .B \-c [filename/wildcard] @@ -1520,7 +1524,7 @@ An escaped url without decoration .nf normal text _http://www.sisudoc.org/ continues - deb http://www.jus.uio.no/sisu/archive unstable main non\-free + deb _http://www.jus.uio.no/sisu/archive unstable main non\-free .fi .br @@ -1597,6 +1601,14 @@ about SiSU [^14] markup {~^ ruby_logo.png "Ruby" }http://www.ruby\-lang.org/en/ .br .br +.B markup example: + +.nf + { 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/ .fi .br @@ -1677,7 +1689,7 @@ information in each column 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 - \e* Contributed at least ten times; \e** at least 5 times in last month; \e*\e** more than 100 times in last month. + * Contributed at least ten times; ** at least 5 times in last month; *** more than 100 times in last month. .fi .br @@ -2223,7 +2235,7 @@ main term heading from each other by a pipe symbol. .nf Paragraph containing main term, second term and sub\-term. - ={Main term:sub\-term+1|second sub\-term + ={Main term:sub\-term+1|second sub\-term} A paragraph that continues discussion of the first sub\-term .fi @@ -3076,6 +3088,35 @@ Its selection is configured in sisurc.yml .br output_dir_structure_by: language +.nf + |\-\- en + |\-\- epub + |\-\- hashes + |\-\- html + | |\-\- viral_spiral.david_bollier + | |\-\- manifest + | |\-\- qrcode + | |\-\- odt + | |\-\- pdf + | |\-\- sitemaps + | |\-\- txt + | |\-\- xhtml + | `\-\- xml + |\-\- po4a + | `\-\- live\-manual + | |\-\- po + | |\-\- fr + | `\-\- pot + `\-\- _sisu + |\-\- css + |\-\- image + |\-\- image_sys \-> \../../_sisu/image_sys + `\-\- xml + |\-\- rnc + |\-\- rng + `\-\- xsd +.fi + .br #by: language subject_dir/en/manifest/filename.html @@ -3092,6 +3133,34 @@ Its selection is configured in sisurc.yml .br output_dir_structure_by: filetype +.nf + |\-\- epub + |\-\- hashes + |\-\- html + |\-\- viral_spiral.david_bollier + |\-\- manifest + |\-\- qrcode + |\-\- odt + |\-\- pdf + |\-\- po4a + |\-\- live\-manual + | |\-\- po + | |\-\- fr + | `\-\- pot + |\-\- _sisu + | |\-\- css + | |\-\- image + | |\-\- image_sys \-> \../../_sisu/image_sys + | `\-\- xml + | |\-\- rnc + | |\-\- rng + | `\-\- xsd + |\-\- sitemaps + |\-\- txt + |\-\- xhtml + `\-\- xml +.fi + .br #by: filetype subject_dir/html/filename/manifest.en.html @@ -3107,6 +3176,27 @@ Its selection is configured in sisurc.yml .br output_dir_structure_by: filename +.nf + |\-\- epub + |\-\- po4a + |\-\- live\-manual + | |\-\- po + | |\-\- fr + | `\-\- pot + |\-\- _sisu + | |\-\- css + | |\-\- image + | |\-\- image_sys \-> \../../_sisu/image_sys + | `\-\- xml + | |\-\- rnc + | |\-\- rng + | `\-\- xsd + |\-\- sitemaps + |\-\- src + |\-\- pod + `\-\- viral_spiral.david_bollier +.fi + .br #by: filename subject_dir/filename/manifest.en.html -- cgit v1.2.3