From cda92b55c50be7ae6a8c237fc9c4b2b4e4cea28b Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Thu, 8 Dec 2011 21:27:10 -0500 Subject: v3: documentation, add --configure, use ascii chars for dir tree, correct typos --- data/doc/sisu/CHANGELOG_v3 | 2 + .../markup-samples/sisu_manual/sisu_commands.sst | 7 +- .../sisu_manual/sisu_content_directories.ssi | 138 ++++++++++----------- .../markup-samples/sisu_manual/sisu_markup.sst | 8 +- 4 files changed, 80 insertions(+), 75 deletions(-) (limited to 'data/doc') diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index 95e0e906..6c5645da 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -32,6 +32,8 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.1.7.orig.tar.xz * sysenv, external images directory copied only if it exists + * documentation, add --configure & use ascii characters for dir tree + correction of a few typos %% 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/markup-samples/sisu_manual/sisu_commands.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst index b24abde7..201b927e 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst @@ -66,14 +66,17 @@ see --xhtml !_ --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 +!_ --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 not generated for documents of over 260,000 words unless this limit is increased in the file sisurc.yml). Alias -w -!_ -C [--init-site] \\ +!_ -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 \\ -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 diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_content_directories.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_content_directories.ssi index b7e09434..5784c03d 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_content_directories.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_content_directories.ssi @@ -95,32 +95,32 @@ output_dir_structure_by: language code{ - ├── 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 + |-- 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 }code @@ -139,31 +139,31 @@ output_dir_structure_by: filetype code{ - ├── 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 + |-- 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 }code @@ -182,24 +182,24 @@ output_dir_structure_by: filename code{ - ├── 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 + |-- 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 }code diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst index 62cf013e..000d3e4c 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst @@ -567,7 +567,7 @@ code{ 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 }code @@ -765,7 +765,7 @@ Very active contributors*** | 0| 31| 190| 692| 1,6 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 -\* 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. }code @@ -782,7 +782,7 @@ Very active contributors*** | 0| 31| 190| 692| 1,6 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 -\* 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. % code{ @@ -1239,7 +1239,7 @@ If multiple sub-terms appear under one paragraph, they are separated under the m code{ 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 -- cgit v1.2.3