diff options
Diffstat (limited to 'data')
| -rw-r--r-- | data/doc/sisu/html/sisu.1.html | 318 | ||||
| -rw-r--r-- | data/doc/sisu/on_markup.txt | 136 | ||||
| -rw-r--r-- | data/sisu/image/bullet_08.png | bin | 0 -> 223 bytes | |||
| -rw-r--r-- | data/sisu/image/bullet_09.png | bin | 0 -> 230 bytes | |||
| -rw-r--r-- | data/sisu/image/bullet_10.png | bin | 0 -> 270 bytes | |||
| -rw-r--r-- | data/sisu/image/bullet_11.png | bin | 0 -> 277 bytes | |||
| -rw-r--r-- | data/sisu/image/bullet_12.png | bin | 0 -> 295 bytes |
7 files changed, 227 insertions, 227 deletions
diff --git a/data/doc/sisu/html/sisu.1.html b/data/doc/sisu/html/sisu.1.html index ff71161d..a5bbc0fc 100644 --- a/data/doc/sisu/html/sisu.1.html +++ b/data/doc/sisu/html/sisu.1.html @@ -10,7 +10,7 @@ <h2><a name='sect0' href='#toc0'>Name</a></h2> <b>SiSU</b> - Structured information, Serialized Units - a document -publishing system +publishing system <h2><a name='sect1' href='#toc1'>Synopsis</a></h2> <b>sisu</b> <b>[</b> <i>-AabcDdEeFHhIMmNnopqRrSsTtUuVvwXxYyZz0-9</i> <b>] [</b> <i>filename/</i> wildcard <b>]</b> <p> @@ -18,7 +18,7 @@ publishing system <b>sisu</b> <b>[</b> <i>-CcFLSVvW</i> <b>]</b> <p> Note: commands should be issued from within the directory that contains -the marked up files, cd to markup directory. +the marked up files, cd to markup directory. <h2><a name='sect2' href='#toc2'>Description</a></h2> <b>SiSU</b> SiSU is a document publishing system, that from a simple single marked-up document, @@ -27,7 +27,7 @@ pdf, xhtml, XML, info, and SQL (PostgreSQL and SQLite), which share numbered text objects ("object citation numbering") and the same document structure information. For more see: <i><<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> ></i> <p> - + <h2><a name='sect3' href='#toc3'>Summary of man page</a></h2> <dl> @@ -367,7 +367,7 @@ removes specified data to postgresql db (rb.dbi) [ <i>-d</i> --remove sqlite equ <dd></dd> </dl> </blockquote> - + <h2><a name='sect7' href='#toc7'>Shortcuts, Shorthand for multiple flags</a></h2> @@ -398,28 +398,34 @@ default action run when no options are give, i.e. on ’sisu [filename]&rsqu <p> add <i>-v</i> for verbose mode and <i>-c</i> for color, e.g. <i>sisu</i> -2vc [filename or wildcard] <p> -consider <i>-u</i> for appended url info or <i>-v</i> for verbose output +consider <i>-u</i> for appended url info or <i>-v</i> for verbose output <h2><a name='sect8' href='#toc8'>Document Markup</a></h2> <b>SiSU Markup</b> an incomplete summary. <p> <b>Note:</b> files should be marked up for SiSU using <i>UTF-8</i> encoding. <p> Some interactive help on markup is available, by typing <i>sisu</i> -and selecting <i>markup</i> or <i>sisu</i> --help markup +and selecting <i>markup</i> or <i>sisu</i> --help markup <dl> -<dt>Sample markup files can be used -as examples: </dt> -<dd><i><<a href='http://www.jus.uio.no/sisu/sample'>http://www.jus.uio.no/sisu/sample</a> +<dt>Online markup examples together +with the respective outputs produced are available from: </dt> +<dd><i><<a href='http://www.jus.uio.no/sisu/SiSU/2.html'>http://www.jus.uio.no/sisu/SiSU/2.html</a> +></i> +</dd> + +<dt>or from the document: </dt> +<dd><i><<a href='http://www.jus.uio.no/sisu/sisu_examples/'>http://www.jus.uio.no/sisu/sisu_examples/</a> ></i> </dd> -<dt>actual marked up plaintext -files ready for use: </dt> -<dd><i><<a href='http://www.jus.uio.no/sisu/sample/markup'>http://www.jus.uio.no/sisu/sample/markup</a> +<dt>The following +document gives a cursory overview of sisu markup and the respective output +produced: </dt> +<dd><i><<a href='http://www.jus.uio.no/sisu/sisu_markup/'>http://www.jus.uio.no/sisu/sisu_markup/</a> ></i> </dd> -<dt>as html with -syntax highlighting for viewing: </dt> +<dt>Some example marked up files +are available as html with syntax highlighting for viewing: </dt> <dd><i><<a href='http://www.jus.uio.no/sisu/sample/syntax'>http://www.jus.uio.no/sisu/sample/syntax</a> ></i> </dd> @@ -451,7 +457,7 @@ which by default html segments are made) <p> <i>,{</i> subscript <i>},</i> <p> <i>+{</i> inserted text <i>}+</i> <p> -<i>-{</i> strikethrough <i>}-</i> +<i>-{</i> strikethrough <i>}-</i> <h2><a name='sect10' href='#toc10'>Footnotes/Endnotes</a></h2> <p> <i>~{</i> a footnote @@ -466,7 +472,7 @@ alternative endnote pair notation: <p> <i>~^</i> endnote marker <p> <i>^~</i> endnote text following the paragraph in which the marker -occurs +occurs <h2><a name='sect11' href='#toc11'>Line Operations (marker placed at start of line)</a></h2> <p> <i>!_</i> bold line <p> @@ -478,7 +484,7 @@ indent paragraph one level <p> <i>#</i> number paragraph (see headers for numbering document headings) <p> <i>_#</i> number paragraph level 2 (see headers for numbering document headings) - + <h2><a name='sect12' href='#toc12'>Links</a></h2> <p> <i>{</i> link name <i>}<a href='http://url.org'>http://url.org</i></a> @@ -520,7 +526,7 @@ if a server host name has been provided/configured, will provide a list of available output types that would be generated using the shortcut command and the markup file provided, i.e. output generated using the command (as configured): "sisu -3sS markup_source_filename.sst", using server host, directory -stub, filename to compose the link. +stub, filename to compose the link. <h2><a name='sect13' href='#toc13'>Adding a fixed names in html</a></h2> <p> <i>*~[name]</i> @@ -528,7 +534,7 @@ manual location marker/tagging at present only in html to produce <a name="[n (use sparingly) <blockquote>note at a heading level the same is automatically achieved by providing names to headings 5 and 6 i.e. 5~[name] and 6~[name] or in the case of auto-heading numbering, without further intervention. </blockquote> - + <h2><a name='sect14' href='#toc14'>Escape object citation numbering</a></h2> <p> @@ -537,7 +543,7 @@ citation numbering</a></h2> <p> <i>-#</i> unnumbered paragraph, delete when not required (place marker at end of paragraph) [used in dummy headings, eg. for segmented html] <p> - + <h2><a name='sect15' href='#toc15'>Page breaks (LaTeX/pdf)</a></h2> <p> @@ -549,69 +555,69 @@ which breaks a page, starting a new page in single column text and a new column in double column text <p> <i><:pn></i> page new, which starts a new page, in both single and double column text (leaving an empty column in double column -text if necessary). +text if necessary). <h2><a name='sect16' href='#toc16'>Comment line</a></h2> <p> <i>%</i> ignored by sisu in processing if placed at beginning of line <p> <i>%%</i> ignored by sisu in processing if placed at beginning -of line, used for folding by vim folds +of line, used for folding by vim folds <h2><a name='sect17' href='#toc17'>Special characters</a></h2> special characters can be escaped with a backslash <i>{</i> } < > are contextual special characters, (in combination with other characters). <i>~</i> - _ / % ^ and occasionally <i>!</i> # + , are special characters in particular circumstances, see the syntax chart. -[note that SiSU is not optimised for technical writing] +[note that SiSU is not optimised for technical writing] <h2><a name='sect18' href='#toc18'>Tables</a></h2> <p> <i>table{</i> [number -of columns] [column width %];[column width %] +of columns] [column width %];[column width %] <p> [table content, line breaks are important see example below]<br> - -<p> <i>}table</i> + +<p> <i>}table</i> <p> sample table:<br> - -<p> <i>table{~h</i> c3; 26; 32; 32; + +<p> <i>table{~h</i> c3; 26; 32; 32; <p> This is a table, column1<br> this would become row one of column two<br> column three of row one is here<br> - + <p> column one row 2<br> column two of row two<br> column three of row two, and so on<br> - + <p> column one row three<br> and so on<br> here<br> - -<p> <i>}table</i> -<p> whole table gets an object citation number -<p> + +<p> <i>}table</i> +<p> whole table gets an object citation number +<p> <h2><a name='sect19' href='#toc19'>Other Grouped or Pre-formatted Text</a></h2> -<i>poem{</i> +<i>poem{</i> <p> [Text here]<br> - + <p> [Text here]<br> - -<p> <i>}poem</i> -<p> each verse is given an object citation number + +<p> <i>}poem</i> +<p> each verse is given an object citation number <p> ----<br> - -<p> <i>group{</i> + +<p> <i>group{</i> <p> [Text here]<br> - -<p> <i>}group</i> -<p> whole group gets an object citation number + +<p> <i>}group</i> +<p> whole group gets an object citation number <p> ----<br> - -<p> <i>code{</i> + +<p> <i>code{</i> <p> [Text here]<br> - -<p> <i>}code</i> -<p> whole group gets an object citation number -<p> + +<p> <i>}code</i> +<p> whole group gets an object citation number +<p> <h2><a name='sect20' href='#toc20'>Composite Documents</a></h2> <p> It @@ -628,32 +634,32 @@ file, or <i>.ssi</i> (insert/information) <i>.sst</i> A secondary file of the co document is built prior to processing with the same prefix and the suffix <i>._sst</i> and <i>._sst</i> There are a number of alternative syntaxes for requiring external documents in order to permit use of ascii hypertext linking available -in the vim editor. They are as follows: -<p> +in the vim editor. They are as follows: +<p> <dl> <dt>basic markup for importing a document </dt> <dd> -<p> <i>r{</i> filename <i>}</i> -<p> <i>{</i> filename.si <i>}require</i> -<p> <i><<</i> { filename.si <i>}</i> #for vim folds +<p> <i>r{</i> filename <i>}</i> +<p> <i>{</i> filename.si <i>}require</i> +<p> <i><<</i> { filename.si <i>}</i> #for vim folds <p> </dd> <dt>importing a document with textlink syntax </dt> <dd> -<p> <i>|filename.si|@|^|require</i> +<p> <i>|filename.si|@|^|require</i> <p> <i><<</i> |filename.si|@|^| -<p>#for vim folds +<p>#for vim folds <p> </dd> <dt>importing a document with thlnk syntax </dt> <dd> <p> <i><url:filename.si>require</i> -<p> <i><<</i> <url:filename.si> #for vim folds +<p> <i><<</i> <url:filename.si> #for vim folds <p> </dd> <dt>remote documents may be called with the @@ -668,64 +674,64 @@ thlnk syntax (or regular sisu syntax), e.g. </dt> <h2><a name='sect21' href='#toc21'>Document Headers</a></h2> Header tags appear at the beginning of a document and provide meta information on the document (such as the Dublin Core), or -information as to how the document as a whole is to be processed. +information as to how the document as a whole is to be processed. <p> All header instructions may take either form: <i>@headername:</i> [introduced in 0.38] or -<p><i>0~headername</i> All Dublin Core meta tags are available +<p><i>0~headername</i> All Dublin Core meta tags are available <p> <i>@indentifier:</i> information -or instructions [introduced in 0.38] -<p> or +or instructions [introduced in 0.38] +<p> or <p> <i>0~indentifier</i> information or instructions, -old equivalent, depreciated +old equivalent, depreciated <p> where the "identifier" is a tag recognised by the program, and the "information" or "instructions" belong to the tag/indentifier -specified. +specified. <p> Note: a header where used should only be used once; all headers apart from @title: (0~title) are optional; the @structure: (0~toc) header -is used to describe document structure, and can be useful to know. +is used to describe document structure, and can be useful to know. <p> @structure: -PART; CHAPTER; SECTION; ARTICLE; none; none; +PART; CHAPTER; SECTION; ARTICLE; none; none; <p> structure can be defined by a match words or regular expression (the regular expression is assumed -to start at the beginning of a line of text i.e. ^) +to start at the beginning of a line of text i.e. ^) <p> For help see one of the following (and markup samples):<br> - + <p> * interactive help - type ’sisu --help headers’<br> - + <p> * marked up text samples<br> - + <p> * the SiSU_Markup.txt file provided with the program<br> - + <p> * an outline of headers is provided below --><br> - + <h2><a name='sect22' href='#toc22'>Outline of header options</a></h2> <i>%</i> SiSU 0.38 [declared file-type identifier with -markup version] +markup version] <p> <i>@title:</i> My Title - This is now the Title of the Document -<p>and used as such -<p> <i>@subtitle:</i> The Subtitle if any +<p>and used as such +<p> <i>@subtitle:</i> The Subtitle if any <p> <i>@creator:</i> [or ~author] -<p>Ralph Amissah -<p> <i>@subject:</i> (whatever your subject) -<p> <i>@description:</i> +<p>Ralph Amissah +<p> <i>@subject:</i> (whatever your subject) +<p> <i>@description:</i> <p> <i>@publisher:</i> -<p> <i>@contributor:</i> -<p> <i>@translator:</i> [or ~translated_by] +<p> <i>@contributor:</i> +<p> <i>@translator:</i> [or ~translated_by] <p> <i>@illustrator:</i> [or ~illustrated_by] -<p> <i>@prepared_by:</i> [or ~digitized_by] +<p> <i>@prepared_by:</i> [or ~digitized_by] <p> <i>@date:</i> 2000-08-27 [ also @date.created: -@date.issued: @date.available: @date.valid: @date.modified: ] +@date.issued: @date.available: @date.valid: @date.modified: ] <p> <i>@type:</i> article -<p> <i>@format:</i> -<p> <i>@identifier:</i> -<p> <i>@source:</i> +<p> <i>@format:</i> +<p> <i>@identifier:</i> +<p> <i>@source:</i> <p> <i>@language:</i> [or @language.document:] language in which current version of document is published. Some country settings result in processing adjustments, e.g. in LaTeX hyphenation, some country @@ -735,48 +741,48 @@ es - Spanish, pt - Portuguese, sv - Swedish, da - Danish, fi - Finnish, no - Norwegian, is - Icelandic, nl - Dutch, ee - Estonian, hu - Hungarian, pl - Polish, ro - Romanian, ru - Russian, gl - Greek, uk - Ukranian, tr - Turkish, si - Slovene, sk - Slovak, hr - Croatian, cs - Czech, bg - Bulgarian ) [however, encodings -are not available for all of the languages listed.] +are not available for all of the languages listed.] <p> <i>@language.original:</i> -<p>original language in which the work was published +<p>original language in which the work was published <p> <i>@papersize:</i> (A4|US_letter|book_B5|book_A5|US_legal) -<p> <i>@relation:</i> -<p> <i>@coverage:</i> +<p> <i>@relation:</i> +<p> <i>@coverage:</i> <p> <i>@rights:</i> copyright, all rights reserved, public -domain, copyleft, creative commons variant, etc. -<p> <i>@owner:</i> +domain, copyleft, creative commons variant, etc. +<p> <i>@owner:</i> <p> <i>@keywords:</i> text document generation processing management LaTeX pdf structured XML citation [your keywords here, used for example by rss feeds, and in sql sear ches] -<p> <i>@abstract:</i> [paper abstract, placed after table of contents] +<p> <i>@abstract:</i> [paper abstract, placed after table of contents] <p> <i>@comment:</i> -[...] +[...] <p> <i>@catalogue:</i> loc=[Library of Congress classification]; dewey=[Dewey -classification]; isbn=[ISBN]; pg=[Project Gutenberg text number] +classification]; isbn=[ISBN]; pg=[Project Gutenberg text number] <p> <i>@classify_loc:</i> -<p>Library of Congress classification +<p>Library of Congress classification <p> <i>@classify_dewey:</i> Dewey classification -<p> <i>@classify_isbn:</i> ISBN -<p> <i>@classify_pg:</i> Project Gutenberg text number +<p> <i>@classify_isbn:</i> ISBN +<p> <i>@classify_pg:</i> Project Gutenberg text number <p> <i>@prefix_a:</i> -[prefix is placed just before table of contents - not implemented] +[prefix is placed just before table of contents - not implemented] <p> <i>@prefix_b:</i> -or @prefix: [prefix is placed just after table of contents] +or @prefix: [prefix is placed just after table of contents] <p> <i>@rcs:</i> $Id$ [or <i>@cvs:</i> used by rcs or cvs to embed version (revision control) information into document, rcs or cvs can usefully provide a history of updates to -a document ] +a document ] <p> <i>@structure:</i> PART; CHAPTER; SECTION; ARTICLE; none; none; optional, where document structure can be defined by a match words or regular expression (the regular expression is assumed to start at the beginning of a line of text i.e. ^) default markers :A~ to :C~ and 1~ to 6~ can be used within text instead, without this header ta g, and may be used to supplement the instructions provided in this header tag if provided (@structure: is -a synonym for @toc:) +a synonym for @toc:) <p> <i>@markup:</i> information on the markup used, e.g. <i>new=1,2,3;</i> break=4; num_top=4 [or newpage=1,2,3; breakpage=4; num_top=4] newpage and breakpage, heading level, used by LaTeX to breakpages. breakpage: starts @@ -790,18 +796,18 @@ where a clear numbering structure is provided within document, without the repetition of a number in a header.] [In 0.38 notation, you would map to the equivalent levels, the examples provided would map to the following new=A,B,C; break=1; num_top=1 [or newpage=A,B,C; breakpage=1; num_top=1] -see headings] +see headings] <p> <i>@bold:</i> [regular expression of words/phrases to be made bold] -<p> <i>@italics:</i> [regular expression of words/phrases to italicise] +<p> <i>@italics:</i> [regular expression of words/phrases to italicise] <p> <i>@vocabulary:</i> -<p>name of taxonomy/vocabulary/wordlist to use against document +<p>name of taxonomy/vocabulary/wordlist to use against document <p> <i>@skin:</i> skin_doc_[name_of_desired_document_skin] <p> <i>@links:</i> { SiSU }<a href='http://www.jus.uio.no/sisu/'>http://www.jus.uio.no/sisu/</a> { FSF }<a href='http://www.fsf.org'>http://www.fsf.org</a> - + <p> <i>@promo:</i> sisu, ruby, search_libre_docs, open_society [places content in right pane in html, makes use of list.yml and promo.yml, commented out sample in document @@ -810,33 +816,33 @@ sample: free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_willia <p> <i>:A~</i> Top level heading [this usually has similar content to the title @title: ] NOTE: the heading levels described here are in 0.38 notation, see heading -<p> <i>:B~</i> Second level heading [this is a heading level divider] +<p> <i>:B~</i> Second level heading [this is a heading level divider] <p> <i>:C~</i> Third -level heading [this is a heading level divider] +level heading [this is a heading level divider] <p> <i>1~</i> Top level heading preceding substantive text of document or sub-heading 2, the heading level that would normally be marked 1. or 2. or 3. etc. in a document, and the level on which sisu by default would break html output into named segments, names are provided automatically if none are given (a number), otherwise takes the -<p>form 1~my_filename_for_this_segment +<p>form 1~my_filename_for_this_segment <p> <i>2~</i> Second level heading preceding substantive text of document or sub-heading 3 , the heading level that would -normally be marked 1.1 or 1.2 or 1.3 or 2.1 etc. in a document. +normally be marked 1.1 or 1.2 or 1.3 or 2.1 etc. in a document. <p> <i>3~</i> Third level heading preceding substantive text of document, that would normally be -marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a document +marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a document <p> NOTE: headers and heading levels used in the description provided refer to 0.38 markup (a conversion script provided in sisu-examples, modify.rb makes conversion between 0.37 -and 0.38 markup simple) -<p> For some help on document structure try +and 0.38 markup simple) +<p> For some help on document structure try <p> <i>sisu</i> --help -<p>headings -<p> and view sample markup documents provided -<p> -<p> +<p>headings +<p> and view sample markup documents provided +<p> +<p> <h2><a name='sect23' href='#toc23'>Configuration Files</a></h2> <p> @@ -855,20 +861,20 @@ Configuration determines the output and processing directories and the database access details. <p> A sample sisurc.yml may be found in /etc/sisu/sisurc.yml -<p> +<p> <h2><a name='sect24' href='#toc24'>More HELP on Markup and headers</a></h2> type: sisu ~<br> sisu --help<br> - + <p> markup help is available on:<br> document wide instructions: headers (document structure)<br> general text markup: headings; endnotes; tables<br> - + <p> A markup table and sample marked-up files (also in html with syntax highlighting) -are available at: +are available at: <p> <i><<a href='http://www.jus.uio.no/sisu/sample'>http://www.jus.uio.no/sisu/sample</a> -></i> -<p> +></i> +<p> <h2><a name='sect25' href='#toc25'>DIRECTORY STRUCTURE & Document Output</a></h2> @@ -893,7 +899,7 @@ is not writable to <i>/tmp/sisu_processing</i> </dd> <p> Output is written to sub-directories within <i>/var/www/</i> if it exists and is writable, and otherwise to <i>~/sisu_output</i> - + <h2><a name='sect27' href='#toc27'>Markup Document Directories and File Mapping</a></h2> <dl> @@ -935,7 +941,7 @@ text <p> <i>doc.html</i> full length scrollable document <p> <i>toc.html</i> index for segmented text <p> -html segments, as many as there may be... +html segments, as many as there may be... <dl> <dt><i>portrait.pdf</i> </dt> @@ -1021,7 +1027,7 @@ the directory <i>~/ebook</i> <p> would be placed in tables within the database <p> <blockquote><i>SiSU_ebook</i> </blockquote> - + <h2><a name='sect30' href='#toc30'>SKINS - document, directory and site skins</a></h2> <p> Skins @@ -1054,7 +1060,7 @@ may be found in /etc/sisu/skin/doc and /usr/share/doc/sisu/sisu_markup_samples/d (or equivalent directory) <p> Samples of list.yml and promo.yml may be found in /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml (or equivalent -directory) +directory) <h2><a name='sect31' href='#toc31'>Document Naming Convention</a></h2> <p> SiSU documents are named with the @@ -1075,14 +1081,14 @@ created when a composite file is constructed, and when a url is provided, it is saved locally for processing, as a secondary processing file. Secondary files may be clobbered by SiSU at will, and are not a way of storing information. -<p> <i>.sxs.xml</i> simple xml sax, sisu markup representation +<p> <i>.sxs.xml</i> simple xml sax, sisu markup representation <p> <i>.sxd.xml</i> simple xml dom, -<p>sisu markup representation +<p>sisu markup representation <p> <i>.sxn.xml</i> simple xml node, sisu markup representation <p> <i>.sxs.xml.sst</i> or <i>.sxd.xml.sst</i> or <i>.sxn.xml.sst</i> auto-converted from a simple xml markup -representation (sxs, sxd, sxn) +representation (sxs, sxd, sxn) <h2><a name='sect32' href='#toc32'>Remote Operations</a></h2> <p> These may be of three @@ -1111,7 +1117,7 @@ an identical filename to another, e.g. local file, that is to be processed in the same directory. So far this has not been found to happen in practice... Alternative solutions are under consideration, but it is desired that filenames be human assigned, and meaningful, so hash keys of contents for filenames -are not amongst the options considered. +are not amongst the options considered. <h2><a name='sect33' href='#toc33'>Note</a></h2> <p> For basic use only a fraction @@ -1123,8 +1129,8 @@ to in the text <i><<a href='http://www.jus.uio.no/sisu/SiSU'>http://www.jus.u ></i> The flags to generate html and pdf for use locally would be sisu -mHp [name of file to be processed] This does assume an ok install and setup of SiSU and the associated software -it uses. -<p> +it uses. +<p> <h2><a name='sect34' href='#toc34'>Processing Examples</a></h2> <p> To initialise a new directory <b>sisu</b> <i>-C</i> <p> @@ -1172,7 +1178,7 @@ it may be necessary to first run <b>sisu</b> <i>-Dv</i> createdb <p> import all marked up files first time into a database: <b>sisu</b> <i>-Dv</i> import * <p> -<i>-c</i> toggles color +<i>-c</i> toggles color <h2><a name='sect35' href='#toc35'>Interactive Help Options</a></h2> <p> SiSU @@ -1211,69 +1217,69 @@ tables of contents) external_programs, dublincore, termsheet, search, features, external_programs, license, exit </pre> -<p> +<p> <h2><a name='sect36' href='#toc36'>SiSU VERSION CONVERSION</a></h2> <p> <i>sisu</i> --to-current [filename/wildcard] converts from -0.37 markup to current markup (0.38) +0.37 markup to current markup (0.38) <p> <i>sisu</i> --to-38 [filename/wildcard] converts -<p>from 0.37 markup to 0.38 +<p>from 0.37 markup to 0.38 <p> <i>sisu</i> --to-37 [filename/wildcard] converts from 0.38 -<p>markup to 0.37 +<p>markup to 0.37 <p> <i>sisu</i> --convert-36to37 [filename/wildcard] re-names file from -<p>pre-0.36 convention to 0.37 +<p>pre-0.36 convention to 0.37 <p> <i>sisu</i> --convert-footnotes [filename/wildcard] converts -<p>footnotes to preferred embedded footnote markup style +<p>footnotes to preferred embedded footnote markup style <p> <i>sisu</i> --convert-footnotes-force [filename/wildcard] converts footnotes to preferred embedded footnote markup style, even if there is a mismatch of footnote numbers. WARNING: there is a problem with the source document and it is necessary to manually check -where each footnotes actually should be. +where each footnotes actually should be. <p> convert from sst to simple xml -representations (sax, dom and node): +representations (sax, dom and node): <p> <i>sisu</i> --to-sax [filename/wildcard] or -<i>sisu</i> --to-sxs [filename/wildcard] +<i>sisu</i> --to-sxs [filename/wildcard] <p> <i>sisu</i> --to-dom [filename/wildcard] or <i>sisu</i> ---to-sxd [filename/wildcard] +--to-sxd [filename/wildcard] <p> <i>sisu</i> --to-node [filename/wildcard] or <i>sisu</i> --to-sxn -[filename/wildcard] +[filename/wildcard] <p> convert to sst from simple xml representations (sax, -dom and node): +dom and node): <p> <i>sisu</i> --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] -<p> or the same: +<p> or the same: <p> <i>sisu</i> --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] <p> <i>sisu</i> --from-kdi [kdissert filename] attempts to convert a kdissert file (.kdi) -<p>to sisu markup +<p>to sisu markup <p> <i>sisu</i> --identify [filename/wildcard] attempts to identify -<p>the markup version of the file +<p>the markup version of the file <p> <i>sisu</i> --query=[version number] and <i>sisu</i> --query=history -<p>provides a brief summary of changes to SiSU markup -<p> +<p>provides a brief summary of changes to SiSU markup +<p> <h2><a name='sect37' href='#toc37'>Sample Markup Documents</a></h2> <p> <p> Sample markup documents are provided in sisu-examples and are available -online. -<p> +online. +<p> <h2><a name='sect38' href='#toc38'>Home Page</a></h2> <p> <i><<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> -></i> -<p> +></i> +<p> <h2><a name='sect39' href='#toc39'>Author</a></h2> Ralph Amissah <i><ralph@amissah.com></i> -or <i><ralph.amissah@gmail.com></i> -<p> +or <i><ralph.amissah@gmail.com></i> +<p> <h2><a name='sect40' href='#toc40'>See Also</a></h2> <a href='http:~/bin/man2html?sisu:8'><b>sisu(8)</a> ,</b> <a href='http:~/bin/man2html?sisu_webrick:1'><b>sisu_webrick(1)</a> diff --git a/data/doc/sisu/on_markup.txt b/data/doc/sisu/on_markup.txt index 72aee93b..c86df967 100644 --- a/data/doc/sisu/on_markup.txt +++ b/data/doc/sisu/on_markup.txt @@ -1,11 +1,11 @@ SiSU Markup Standard * Copyright Ralph Amissah -* version 0.16.0 +* version 0.38.0 * homepage: http://www.jus.uio.no/sisu * manpages 'man sisu' * markup examples - * data/sisu-markup-samples/document_samples_sisu_markup - * /usr/share/sisu-markup-samples/document_samples_sisu_markup + * data/sisu-examples/sample/document_samples_sisu_markup + * /usr/share/sisu-examples/sample/document_samples_sisu_markup * http://www.jus.uio.no/sisu/sample/markup * http://www.jus.uio.no/sisu/sample/syntax * book samples @@ -16,7 +16,7 @@ The man pages 'man sisu' are likely to be more up to date than this document, please consult them. Examples of marked up documents are also provided, under the directory branch -data/sisu-markup-samples +sisu-examples/sample/document_samples_sisu_markup or online at SiSU Markup syntax @@ -24,9 +24,9 @@ SiSU Markup syntax sisu Data text markup (alternative to available html subset) - 1~ heading/title [levels 1 to 6 available] +:A~ heading/title [levels :A~ to :C~ available] - 4~filename heading [segmentation level] +1~filename heading [segmentation level, levels 1~ to 3~ available ] !{emphasis}! @@ -49,22 +49,24 @@ sisu ------------------------------------------ Indentation and bullets - _1 indent paragraph one level +_1 indent paragraph one level - _2 indent paragraph two steps +_2 indent paragraph two steps - _2 indent paragraph two steps + ... - _* bullet text +_9 indent paragraph nine steps - _1* bullet text, first indent +_* bullet text + +_1* bullet text, first indent ------------------------------------------ Numbered List (not to be confused with headings/titles, (document structure)) - # numbered list numbered list 1., 2., 3, etc. +# numbered list numbered list 1., 2., 3, etc. - _# numbered list numbered list indented a., b., c., d., etc. +_# numbered list numbered list indented a., b., c., d., etc. ------------------------------------------ Endnotes @@ -75,7 +77,7 @@ sisu alternative endnote pair notation ~^ endnote marker - ^~ endnote text following the paragraph in which the marker occurs +^~ endnote text following the paragraph in which the marker occurs ------------------------------------------ Links @@ -95,12 +97,12 @@ sisu { SiSU Geek Writer }http://www.jus.uio.no/sisu/ url example { tux.png 64x80 "a better way" }http://www.jus.uio.no/sisu/ image example with all options - + shortcut - hyper-linked text with endnote providing the url information {~^ [text to link] }http://url.org maps to { [text to link] }http://url.org ~{ http://url.org }~ which produces hyper-linked text within a document/paragraph, with an endnote providing the url for the text location used in the hyperlink - + manual location marker/tagging at present only in html to produce <a name="[name]"> (use sparingly) *~[name] @@ -118,7 +120,7 @@ sisu ------------------------------------------ - There are some things to be aware of <br> may be used, but urls occuring before or after a break must have a space. The vim syntax highlighter catches most of the rules... + There are some things to be aware of <br> may be used, but urls occuring before or after a break must have a space. The vim syntax highlighter catches most of the rules... ------------------------------------------ @@ -181,82 +183,74 @@ code{ HEADERS Header tags appear at the beginning of a document and provide meta information on the document (such as the Dublin Core), or information as to how the document as a whole is to be processed. -All header instructions take either the form 0~ . All Dublin Core meta tags are available -0~indentifier information +All header instructions take the form @tagname: All Dublin Core meta tags are available +@indentifier: information where the "identifier" is a tag recognised by the program, and the "information" or "instructions" belong to the tag/indentifier specified The { form was introduced to take advantage of vim folds, and its use is reserved primarily for document structural instructions: namely header and heading tags (also a footnote/endnote option). This is a sample header (Dublin Core in fuschia, other information headers in cyan, markup instructions in red): -0~title My Title - This is now the Title of the Document and used as such - -0~subtitle The Subtitle if any - -0~creator [or ~author] Ralph Amissah +@title: My Title - This is now the Title of the Document and used as such -0~subject Document production and management (or whatever your subject) +@subtitle: The Subtitle if any -0~description +@creator: [or ~author] Ralph Amissah -0~publisher +@subject: Document production and management (or whatever your subject) -0~contributor +@description: -0~date 2000-08-27 - [ also 0~date.created 0~date.issued 0~date.available 0~date.valid 0~date.modified ] +@publisher: -0~type article +@contributor: -0~format +@date: 2000-08-27 + [ also @date:.created @date:.issued @date:.available @date:.valid @date:.modified ] -0~identifier +@type: article -0~source +@format: -0~language (en|us|fr|de|es|se|dk|fi|no) +@identifier: -0~relation +@source: -0~coverage +@language: (en|us|fr|de|es|se|dk|fi|no) -0~rights copyright, all rights reserved, public domain, copyleft, creative commons variant, etc. +@relation: -0~owner +@coverage: -0~keywords text document generation processing management latex pdf structured xml citation [your keywords here, used for example by rss feeds, and in sql searches] +@rights: copyright, all rights reserved, public domain, copyleft, creative commons variant, etc. -0~abstract [paper abstract, placed after table of contents] +@owner: -0~comment [...] +@keywords: text document generation processing management latex pdf structured xml citation [your keywords here, used for example by rss feeds, and in sql searches] -0~classify_loc [Library of Congress classification] +@abstract: [paper abstract, placed after table of contents] -0~classify_dewey [Dewey classification system] +@comment: [...] -0~classify_isbn [ISBN] +@prefix_a: [prefix is placed just before table of contents - not implemented] -0~classify_pg [Project Gutenberg text number] +@prefix_b: or @prefix: [prefix is placed just after table of contents] -0~prefix_a [prefix is placed just before table of contents - not implemented] +@cvs: $Id$ [used by cvs to embed versioning (revision control) information into document, cvs can usefully provide a history of updates to a document (though I no longer use it for programming, preferring darcs and arch/tla cvs performs this function for documents quite well) ] -0~prefix_b or 0~prefix [prefix is placed just after table of contents] - -0~rcs $Id$ [or 0~cvs used by rcs or cvs to embed version (revision control) information into document, rcs or cvs can usefully provide a history of updates to a document ] - -0~toc PART; CHAPTER; SECTION; ARTICLE; none; none; +@toc: PART; CHAPTER; SECTION; ARTICLE; none; none; optional, where document structure can be defined by a match words or regular expression (the regular expression is assumed to start at the beginning of a line of text) default markers 1~ to 6~ can be used within text instead, without this header tag, and may be used to suppliment the instructions provided in this header tag if provided -0~level newpage=3; breakpage=4 [paragraph level, used by latex to breakpages, the page is optional eg. in newpage] +@level: newpage=3; breakpage=4 [paragraph level, used by latex to breakpages, the page is optional eg. in newpage] -0~markup num_top=4 [various markup instructions, eg: num_top=4 headings tobe numbered, starting at heading level 4... the default is to provide 3 levels, as in 1 level 4, 1.1 level 5, 1.1.1 level 6, markup to be merged within level] +@markup: num_top=4 [various markup instructions, eg: num_top=4 headings tobe numbered, starting at heading level 4... the default is to provide 3 levels, as in 1 level 4, 1.1 level 5, 1.1.1 level 6, markup to be merged within level] -0~vocabulary name of taxonomy/vocabulary/wordlist to use against document +@vocabulary: name of taxonomy/vocabulary/wordlist to use against document -0~skin skin_doc_[name_of_desired_document_skin] +@skin: skin_doc_[name_of_desired_document_skin] -0~links http://google.com; Google; +@links: http://google.com; Google; -1~ Top level heading [this is usually the same as the title 0~title ] +1~ Top level heading [this is usually the same as the title @title: ] 2~ Second level heading [this is a heading level divider] @@ -270,25 +264,25 @@ default markers 1~ to 6~ can be used within text instead, without this header ta SAMPLE DOCUMENT -For sample marked up documents see the directory +For sample marked up documents see the directory markup_samples -0~title Working Sample Document +@title: Working Sample Document -0~subtitle Demonstrating markup +@subtitle: Demonstrating markup -0~creator Ralph Amissah +@creator: Ralph Amissah -0~date +@date: -0~markup num_top=4 +@markup: num_top=4 -0~links +@links: 1~ A Sample Document - -2~ just for fun - + +2~ just for fun + 4~ This is Chapter One or Article One Ordinary Text follows here. The Title would be a Chapter or Article depending on the type of document you were working to produce. @@ -297,13 +291,13 @@ Ordinary Text follows here. The Title would be a Chapter or Article depending on And so on. -Assuming sisu is configured properly so it has been instructed where to put the work files and ouput files, you would generate this text once saved, with the suffix .s3 if saved as example.s3, by typing sisu -mhwxp example.s3 while in the directory in which the file is saved. +Assuming sisu is configured properly so it has been instructed where to put the work files and ouput files, you would generate this text once saved, with the suffix .s3 if saved as example.s3, by typing sisu -mhwxp example.s3 while in the directory in which the file is saved. _1 -m initial processing, -h html (css based), -w wordmap for html, -x xml, -p pdf output, generated via latex, there are of course additional options _1 for a listing type: sisu ~ commands -_1 for an outline of sisu markup type: sisu ~ markup +_1 for an outline of sisu markup type: sisu ~ markup The example ends here. @@ -313,7 +307,7 @@ Composite Documents It is possible to build a document by requiring other documents. The documents required may complete documents that could be gener ated independently, or they could be markup snippets, prepared so as to be easily available to be placed within another text. If the calling document is a master document (built mainly from other doc uments), by convention it should be named with the suffix .r1 , .r2 , or .r3 .s1 , .s2 , or .s3 , and if markup snippets .si. A tempo rary file of the composite document is built prior to processing with the same prefix and the suffix .t1 , .t2 , or .t3 -basic markup for importing a document into another, +basic markup for importing a document into another, [note placement is at start of the line, no spaces despite presentation below] r{ filename } diff --git a/data/sisu/image/bullet_08.png b/data/sisu/image/bullet_08.png Binary files differnew file mode 100644 index 00000000..9e81da10 --- /dev/null +++ b/data/sisu/image/bullet_08.png diff --git a/data/sisu/image/bullet_09.png b/data/sisu/image/bullet_09.png Binary files differnew file mode 100644 index 00000000..08c76edc --- /dev/null +++ b/data/sisu/image/bullet_09.png diff --git a/data/sisu/image/bullet_10.png b/data/sisu/image/bullet_10.png Binary files differnew file mode 100644 index 00000000..87ed61fd --- /dev/null +++ b/data/sisu/image/bullet_10.png diff --git a/data/sisu/image/bullet_11.png b/data/sisu/image/bullet_11.png Binary files differnew file mode 100644 index 00000000..8ef22aee --- /dev/null +++ b/data/sisu/image/bullet_11.png diff --git a/data/sisu/image/bullet_12.png b/data/sisu/image/bullet_12.png Binary files differnew file mode 100644 index 00000000..ebb62725 --- /dev/null +++ b/data/sisu/image/bullet_12.png |
