diff options
| author | Ralph Amissah <ralph@amissah.com> | 2007-09-24 15:43:13 +0100 |
|---|---|---|
| committer | Ralph Amissah <ralph@amissah.com> | 2007-09-24 15:43:46 +0100 |
| commit | a6d72d829e5fda70528759c6de8dc3e141278fb4 (patch) | |
| tree | ea12a53041d4cb69be0aad3dc0af7bf827efbcd6 /data/doc/sisu/html/sisu.1.html | |
| parent | changelog update (diff) | |
documentation regenerated, large diff
Diffstat (limited to 'data/doc/sisu/html/sisu.1.html')
| -rw-r--r-- | data/doc/sisu/html/sisu.1.html | 176 |
1 files changed, 90 insertions, 86 deletions
diff --git a/data/doc/sisu/html/sisu.1.html b/data/doc/sisu/html/sisu.1.html index 7a46a1ac..93840b9f 100644 --- a/data/doc/sisu/html/sisu.1.html +++ b/data/doc/sisu/html/sisu.1.html @@ -7,43 +7,42 @@ </head> <body bgcolor='white'> <a href='#toc'>Table of Contents</a><p> -SISU - SISU INFORMATION STRUCTURING UNIVERSE - MANUAL [0.58], RALPH AMISSAH - +SISU - MANUAL, RALPH AMISSAH <p> WHAT IS SISU? -<p> 1. INTRODUCTION - WHAT IS SISU? -<p> <b>SiSU</b> is a system for -document markup, publishing (in multiple open standard formats) and search - -<p> <b>SiSU</b> [^1] is a[^2] framework for document structuring, publishing and search, -comprising of (a) a lightweight document structure and presentation markup -syntax and (b) an accompanying engine for generating standard document -format outputs from documents prepared in sisu markup syntax, which is -able to produce multiple standard outputs that (can) share a common numbering -system for the citation of text within a document. -<p> <b>SiSU</b> is developed under -an open source, software libre license (GPL3). It has been developed in -the context of coping with large document sets with evolving markup related -technologies, for which you want multiple output formats, a common mechanism -for cross-output-format citation, and search. -<p> <b>SiSU</b> both defines a markup -syntax and provides an engine that produces open standards format outputs -from documents prepared with <b>SiSU</b> markup. From a single lightly prepared -document sisu custom builds several standard output formats which share -a common (text object) numbering system for citation of content within -a document (that also has implications for search). The sisu engine works -with an abstraction of the document’s structure and content from which it -is possible to generate different forms of representation of the document. -Significantly <b>SiSU</b> markup is more sparse than html and outputs which include -html, LaTeX, landscape and portrait pdfs, Open Document Format (ODF), all -of which can be added to and updated. <b>SiSU</b> is also able to populate SQL -type databases at an object level, which means that searches can be made -with that degree of granularity. Results of objects (primarily paragraphs -and headings) can be viewed directly in the database, or just the object -numbers shown - your search criteria is met in these documents and at these -locations within each document. -<p> Source document preparation and output -generation is a two step process: (i) document source is prepared, that -is, marked up in sisu markup syntax and (ii) the desired output subsequently +<p> 1. INTRODUCTION - WHAT IS SISU? + +<p> <b>SiSU</b> is a system for document markup, publishing (in multiple open standard +formats) and search +<p> <b>SiSU</b> [^1] is a[^2] framework for document structuring, +publishing and search, comprising of (a) a lightweight document structure +and presentation markup syntax and (b) an accompanying engine for generating +standard document format outputs from documents prepared in sisu markup +syntax, which is able to produce multiple standard outputs that (can) share +a common numbering system for the citation of text within a document. +<p> +<b>SiSU</b> is developed under an open source, software libre license (GPL3). It +has been developed in the context of coping with large document sets with +evolving markup related technologies, for which you want multiple output +formats, a common mechanism for cross-output-format citation, and search. + +<p> <b>SiSU</b> both defines a markup syntax and provides an engine that produces +open standards format outputs from documents prepared with <b>SiSU</b> markup. +From a single lightly prepared document sisu custom builds several standard +output formats which share a common (text object) numbering system for +citation of content within a document (that also has implications for search). +The sisu engine works with an abstraction of the document’s structure and +content from which it is possible to generate different forms of representation +of the document. Significantly <b>SiSU</b> markup is more sparse than html and +outputs which include html, LaTeX, landscape and portrait pdfs, Open Document +Format (ODF), all of which can be added to and updated. <b>SiSU</b> is also able +to populate SQL type databases at an object level, which means that searches +can be made with that degree of granularity. Results of objects (primarily +paragraphs and headings) can be viewed directly in the database, or just +the object numbers shown - your search criteria is met in these documents +and at these locations within each document. +<p> Source document preparation +and output generation is a two step process: (i) document source is prepared, +that is, marked up in sisu markup syntax and (ii) the desired output subsequently generated by running the sisu engine against document source. Output representations if updated (in the sisu engine) can be generated by re-running the engine against the prepared source. Using <b>SiSU</b> markup applied to a document, <b>SiSU</b> @@ -455,16 +454,16 @@ the cgi-bin directory). -Fv (in addition to the above) provides some information <dt><b> -H [filename/wildcard]</b> </dt> <dd>produces html -without link suffixes (.html .pdf etc.) ( appropriately configured web server. - [behaviour switched after 0.35 see -h]. +without link suffixes (.html .pdf etc.) ( an appropriately configured web +server. [behaviour switched after 0.35 see -h]. <p> </dd> <dt><b> -h [filename/wildcard]</b> </dt> -<dd>produces html -(with hardlinks i.e. with name suffixes in links/local urls). html, with internal -document links that include the document suffix, i.e. whether it is .html -or .pdf (required for browsing directly off a file system, and works with -most web servers). [behaviour switched after 0.35 see -H]. +<dd>produces +html (with hardlinks i.e. with name suffixes in links/local urls). html, with +internal document links that include the document suffix, i.e. whether it +is .html or .pdf (required for browsing directly off a file system, and works +with most web servers). [behaviour switched after <p> </dd> <dt><b> -I [filename/wildcard]</b> @@ -870,7 +869,7 @@ one (without the comments): <p> <br> <pre> % SiSU 0.57 @title: SiSU - @subtitle: Markup [0.58] + @subtitle: Markup @creator: Ralph Amissah @rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 @@ -1332,8 +1331,8 @@ example:</b> 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. </pre> <p> <b>resulting output:</b> <p> <b>Table 3.1: Contributors to Wikipedia, January 2001 @@ -1648,10 +1647,11 @@ been used extensively within this document to provide examples of <b>SiSU</b> markup. You cannot however use code tags to escape code tags. They are however used in the same way as group or poem tags. <p> A code-block is treated as -an object and given a single object number. [an option to number each line - of code may be considered at some later time] -<p> <b>use of code tags instead -of poem compared, resulting output:</b> +an object and given a single object number. [an more than 100 times in last +month. option to number each line of code may be considered at more than +100 times in last month. some later time] +<p> <b>use of code tags instead of +poem compared, resulting output:</b> <p> <p> <br> <pre> ’Fury said to a @@ -1788,12 +1788,13 @@ stored in the directory beneath them _sisu/image. <b>SiSU</b> plaintext markup files are of three types that may be distinguished by the file extension used: regular text .sst; master documents, composite documents that incorporate other text, which can be any regular text or text insert; and inserts the -contents of which are like regular text except these are marked -<p> <b>SiSU</b> -processing can be done directly against a sisu documents; which may be -located locally or on a remote server for which a url is provided. -<p> <b>SiSU</b> -source markup can be shared with the command: +contents of which are like regular text except these are marked .ssi and +are not processed. +<p> <b>SiSU</b> processing can be done directly against a sisu +documents; which may be located locally or on a remote server for which +a url is provided. +<p> <b>SiSU</b> source markup can be shared with the command: + <p> sisu -s [filename]<br> <p> 14.1.1 SISU TEXT - REGULAR FILES (.SST) @@ -3486,40 +3487,41 @@ html pages[^34] <p> <b>Dublin Core</b> (DC) <p> <i>DC</i> tags included with this document are provided here. -<p> DC Title: <i>SiSU</i> - SiSU information Structuring Universe - Manual [0.58] -<p> - DC Creator: <i>Ralph</i> Amissah -<p> DC Rights: <i>Copyright</i> (C) Ralph Amissah 2007, -part of SiSU documentation, License GPL 3 -<p> DC Type: <i>information</i> -<p> DC Date -created: <i>2002-08-28</i> -<p> DC Date issued: <i>2002-08-28</i> -<p> DC Date available: <i>2002-08-28</i> +<p> DC Title: <i>SiSU</i> - Manual +<p> DC Creator: <i>Ralph</i> Amissah +<p> DC Rights: <i>Copyright</i> +(C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +<p> DC +Type: <i>information</i> +<p> DC Date created: <i>2002-08-28</i> +<p> DC Date issued: <i>2002-08-28</i> +<p> DC Date available: <i>2002-08-28</i> <p> DC Date modified: <i>2007-08-30</i> -<p> DC Date: <i>2007-08-30</i> -<p> <b>Version Information</b> +<p> DC Date: <i>2007-08-30</i> +<p> <b>Version Information</b> <p> Sourcefile: <i>sisu._sst</i> -<p> Filetype: <i>SiSU</i> text insert 0.58 -<p> Sourcefile Digest, -MD5(sisu._sst)= <i>850b4b4b2da877667488ddfa325b6581</i> +<p> Filetype: <i>SiSU</i> text insert + +<p>0.58 +<p> Sourcefile Digest, MD5(sisu._sst)= <i>4c33c586109800b635ffe667a0cf217f</i> + <p> Skin_Digest: MD5(/home/ralph/grotto/theatre/dbld/sisu-dev/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)= <p><i>20fc43cf3eb6590bc3399a1aef65c5a9</i> <p> <b>Generated</b> <p> Document (metaverse) last -generated: <i>Sun</i> Sep 23 01:13:56 +0100 2007 -<p> Generated by: <i>SiSU</i> <i>0.58.3</i> of -2007w36/4 (2007-09-06) +generated: <i>Mon</i> Sep 24 15:36:12 +0100 2007 +<p> Generated by: <i>SiSU</i> <i>0.59.0</i> of +2007w38/0 (2007-09-23) <p> Ruby version: <i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36) [i486-linux] <p> <ol> -<b>.</b><li> -<p> <b>SiSU</b> information Structuring Universe Units also chosen -for the meaning of the Finnish term "sisu".<br> +<b>.</b><li> .B SiSU<br> + information Structuring Universe Units also chosen for the meaning of +the Finnish term "sisu".<br> </li><b>.</b><li>Unix command line oriented </li><b>.</b><li>objects include: headings, paragraphs, verse, tables, images, but not footnotes/endnotes which are numbered separately and tied to the object from which they are referenced. </li><b>.</b><li>i.e. the html, pdf, @@ -3576,9 +3578,10 @@ numbered asterisk footnote/endnote series </li><b>.</b><li><<a href='http://w > </li><b>.</b><li>Table from the Wealth of Networks by Yochai Benkler <<a href='http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler'>http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler</a> ><br> - </li><b>.</b><li> is not a regular file to be worked on, and thus less likely that people + </li><b>.</b><li>.ssc (for composite) is under consideration but ._sst makes clear that this +is not a regular file to be worked on, and thus less likely that people will have processing. It may be however that when the resulting file is -shared .ssc is an appropriate suffix to use. </li><b>.</b><li><b>SiSU</b> has worked this way in +shared .ssc is an appropriate suffix to use. </li><b>.</b><li>.B SiSU has worked this way in the past, though this was dropped as it was thought the complexity outweighed the flexibility, however, the balance was rather fine and this behaviour could be reinstated. </li><b>.</b><li><<a href='http://www.postgresql.org/'>http://www.postgresql.org/</a> @@ -3602,11 +3605,12 @@ without opening each document where within each your matches are found. > </li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man/sisu.8'>http://www.jus.uio.no/sisu/man/sisu.8</a> > </li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man'>http://www.jus.uio.no/sisu/man</a> -> </li><b>.</b><li>the <b>Debian</b> -Free Software guidelines require that everything distributed within <b>Debian</b> -can be changed - and the documents are authors’ works that while freely distributable -are not freely changeable. </li><b>.</b><li>named index.html or more extensively through sisu_manifest.html +> </li><b>.</b><li>the .B Debian +Free Software guidelines require that everything distributed within .B +Debian can be changed - and the documents are authors’ works that while freely +distributable are not freely changeable. </li><b>.</b><li>named index.html or more extensively +<p>through sisu_manifest.html <p> </dd> <dt>Other versions of this document: </dt> @@ -3640,15 +3644,15 @@ are not freely changeable. </li><b>.</b><li>named index.html or more extensively </dt> <dd></dd> -<dt>* Generated by: SiSU 0.58.3 of 2007w36/4 (2007-09-06) </dt> +<dt>* Generated by: SiSU 0.59.0 of 2007w38/0 (2007-09-23) </dt> <dd></dd> <dt>* Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt> <dd></dd> -<dt>* Last Generated on: Sun Sep 23 -01:14:04 +0100 2007 </dt> +<dt>* Last Generated on: Mon Sep 24 +15:36:29 +0100 2007 </dt> <dd></dd> <dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> |