From b5c601bd8d5aabaf0c30de061af2ee5247b4be96 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Mon, 30 Jul 2007 21:02:20 +0100 Subject: -0 no longer produces output without numbering (ocn), help info updated --- data/doc/sisu/html/sisu.1.html | 339 ++++++++++++++++++++--------------------- 1 file changed, 168 insertions(+), 171 deletions(-) (limited to 'data/doc') diff --git a/data/doc/sisu/html/sisu.1.html b/data/doc/sisu/html/sisu.1.html index 968f8eb1..ff71161d 100644 --- a/data/doc/sisu/html/sisu.1.html +++ b/data/doc/sisu/html/sisu.1.html @@ -10,7 +10,7 @@

Name

SiSU - Structured information, Serialized Units - a document -publishing system +publishing system

Synopsis

sisu [ -AabcDdEeFHhIMmNnopqRrSsTtUuVvwXxYyZz0-9 ] [ filename/ wildcard ]

@@ -18,7 +18,7 @@ publishing system sisu [ -CcFLSVvW ]

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.

Description

SiSU 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: <http://www.jus.uio.no/sisu >

- +

Summary of man page

@@ -367,7 +367,7 @@ removes specified data to postgresql db (rb.dbi) [ -d --remove sqlite equ
- +

Shortcuts, Shorthand for multiple flags

@@ -398,14 +398,14 @@ default action run when no options are give, i.e. on ’sisu [filename]&rsqu

add -v for verbose mode and -c for color, e.g. sisu -2vc [filename or wildcard]

-consider -u for appended url info or -v for verbose output +consider -u for appended url info or -v for verbose output

Document Markup

SiSU Markup an incomplete summary.

Note: files should be marked up for SiSU using UTF-8 encoding.

Some interactive help on markup is available, by typing sisu -and selecting markup or sisu --help markup +and selecting markup or sisu --help markup

Sample markup files can be used @@ -451,7 +451,7 @@ which by default html segments are made)

,{ subscript },

+{ inserted text }+

--{ strikethrough }- +-{ strikethrough }-

Footnotes/Endnotes

~{ a footnote @@ -466,7 +466,7 @@ alternative endnote pair notation:

~^ endnote marker

^~ endnote text following the paragraph in which the marker -occurs +occurs

Line Operations (marker placed at start of line)

!_ bold line

@@ -478,7 +478,7 @@ indent paragraph one level

# number paragraph (see headers for numbering document headings)

_# number paragraph level 2 (see headers for numbering document headings) - +

Links

{ link name }http://url.org @@ -520,7 +520,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.

Adding a fixed names in html

*~[name] @@ -528,7 +528,7 @@ manual location marker/tagging at present only in html to produce <a name="[n (use sparingly)

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

Escape object citation numbering

@@ -537,84 +537,81 @@ citation numbering

-# unnumbered paragraph, delete when not required (place marker at end of paragraph) [used in dummy headings, eg. for segmented html]

-It is convenient -to mention here that the -0 flag generates html and latex/pdf output without -visible object character numbers.

-sisu -0 [filename.sst] -

Page breaks (LaTeX/pdf)

+ +

Page breaks +(LaTeX/pdf)

-page -breaks are introduced to pdfs either as header instructions, indicating -that pages should break at given levels, and mentioned in the header section, -or manually, using the following notation

-<:pb> page break, which breaks -a page, starting a new page in single column text and a new column in double -column text

-<:pn> page new, which starts a new page, in both single and double -column text (leaving an empty column in double column text if necessary). - +page breaks are introduced to pdfs either as header instructions, +indicating that pages should break at given levels, and mentioned in the +header section, or manually, using the following notation

+<:pb> page break, +which breaks a page, starting a new page in single column text and a new +column in double column text

+<:pn> page new, which starts a new page, in +both single and double column text (leaving an empty column in double column +text if necessary).

Comment line

-% ignored by sisu in processing if placed at beginning of -line

-%% ignored by sisu in processing if placed at beginning of line, used -for folding by vim folds +% ignored by sisu in processing if placed +at beginning of line

+%% ignored by sisu in processing if placed at beginning +of line, used for folding by vim folds

Special characters

-special characters can be escaped -with a backslash { } < > are contextual special characters, (in combination -with other characters). ~ - _ / % ^ and occasionally ! # + , are special characters -in particular circumstances, see the syntax chart. [note that SiSU is not -optimised for technical writing] +special characters +can be escaped with a backslash { } < > are contextual special characters, +(in combination with other characters). ~ - _ / % ^ and occasionally ! # + +, are special characters in particular circumstances, see the syntax chart. +[note that SiSU is not optimised for technical writing]

Tables

-table{ [number of columns] [column -width %];[column width %] -

[table content, line breaks are important -see example below]
- -

}table +table{ [number +of columns] [column width %];[column width %] +

[table content, line breaks +are important see example below]
+ +

}table

sample table:
- -

table{~h c3; 26; 32; 32; + +

table{~h c3; 26; 32; 32;

This is a table, column1
this would become row one of column two
column three of row one is here
- +

column one row 2
column two of row two
column three of row two, and so on
- +

column one row three
and so on
here
- -

}table -

whole table gets an object citation number -

+ +

}table +

whole table gets an object citation number +

Other Grouped or Pre-formatted Text

-poem{ +poem{

[Text here]
- +

[Text here]
- -

}poem -

each verse is given an object citation number + +

}poem +

each verse is given an object citation number

----
- -

group{ + +

group{

[Text here]
- -

}group -

whole group gets an object citation number + +

}group +

whole group gets an object citation number

----
- -

code{ + +

code{

[Text here]
- -

}code -

whole group gets an object citation number -

+ +

}code +

whole group gets an object citation number +

Composite Documents

It @@ -631,32 +628,32 @@ file, or .ssi (insert/information) .sst A secondary file of the co document is built prior to processing with the same prefix and the suffix ._sst and ._sst 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: -

+in the vim editor. They are as follows: +

basic markup for importing a document
-

r{ filename } -

{ filename.si }require -

<< { filename.si } #for vim folds +

r{ filename } +

{ filename.si }require +

<< { filename.si } #for vim folds

importing a document with textlink syntax
-

|filename.si|@|^|require +

|filename.si|@|^|require

<< |filename.si|@|^| -

#for vim folds +

#for vim folds

importing a document with thlnk syntax

<url:filename.si>require -

<< <url:filename.si> #for vim folds +

<< <url:filename.si> #for vim folds

remote documents may be called with the @@ -671,64 +668,64 @@ thlnk syntax (or regular sisu syntax), e.g.

Document 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. +information as to how the document as a whole is to be processed.

All header instructions may take either form: @headername: [introduced in 0.38] or -

0~headername All Dublin Core meta tags are available +

0~headername All Dublin Core meta tags are available

@indentifier: information -or instructions [introduced in 0.38] -

or +or instructions [introduced in 0.38] +

or

0~indentifier information or instructions, -old equivalent, depreciated +old equivalent, depreciated

where the "identifier" is a tag recognised by the program, and the "information" or "instructions" belong to the tag/indentifier -specified. +specified.

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.

@structure: -PART; CHAPTER; SECTION; ARTICLE; none; none; +PART; CHAPTER; SECTION; ARTICLE; none; none;

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. ^)

For help see one of the following (and markup samples):
- +

* interactive help - type ’sisu --help headers’
- +

* marked up text samples
- +

* the SiSU_Markup.txt file provided with the program
- +

* an outline of headers is provided below -->
- +

Outline of header options

% SiSU 0.38 [declared file-type identifier with -markup version] +markup version]

@title: My Title - This is now the Title of the Document -

and used as such -

@subtitle: The Subtitle if any +

and used as such +

@subtitle: The Subtitle if any

@creator: [or ~author] -

Ralph Amissah -

@subject: (whatever your subject) -

@description: +

Ralph Amissah +

@subject: (whatever your subject) +

@description:

@publisher: -

@contributor: -

@translator: [or ~translated_by] +

@contributor: +

@translator: [or ~translated_by]

@illustrator: [or ~illustrated_by] -

@prepared_by: [or ~digitized_by] +

@prepared_by: [or ~digitized_by]

@date: 2000-08-27 [ also @date.created: -@date.issued: @date.available: @date.valid: @date.modified: ] +@date.issued: @date.available: @date.valid: @date.modified: ]

@type: article -

@format: -

@identifier: -

@source: +

@format: +

@identifier: +

@source:

@language: [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 @@ -738,48 +735,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.]

@language.original: -

original language in which the work was published +

original language in which the work was published

@papersize: (A4|US_letter|book_B5|book_A5|US_legal) -

@relation: -

@coverage: +

@relation: +

@coverage:

@rights: copyright, all rights reserved, public -domain, copyleft, creative commons variant, etc. -

@owner: +domain, copyleft, creative commons variant, etc. +

@owner:

@keywords: text document generation processing management LaTeX pdf structured XML citation [your keywords here, used for example by rss feeds, and in sql sear ches] -

@abstract: [paper abstract, placed after table of contents] +

@abstract: [paper abstract, placed after table of contents]

@comment: -[...] +[...]

@catalogue: loc=[Library of Congress classification]; dewey=[Dewey -classification]; isbn=[ISBN]; pg=[Project Gutenberg text number] +classification]; isbn=[ISBN]; pg=[Project Gutenberg text number]

@classify_loc: -

Library of Congress classification +

Library of Congress classification

@classify_dewey: Dewey classification -

@classify_isbn: ISBN -

@classify_pg: Project Gutenberg text number +

@classify_isbn: ISBN +

@classify_pg: Project Gutenberg text number

@prefix_a: -[prefix is placed just before table of contents - not implemented] +[prefix is placed just before table of contents - not implemented]

@prefix_b: -or @prefix: [prefix is placed just after table of contents] +or @prefix: [prefix is placed just after table of contents]

@rcs: $Id$ [or @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 ] +a document ]

@structure: 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:)

@markup: information on the markup used, e.g. new=1,2,3; 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 @@ -793,18 +790,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]

@bold: [regular expression of words/phrases to be made bold] -

@italics: [regular expression of words/phrases to italicise] +

@italics: [regular expression of words/phrases to italicise]

@vocabulary: -

name of taxonomy/vocabulary/wordlist to use against document +

name of taxonomy/vocabulary/wordlist to use against document

@skin: skin_doc_[name_of_desired_document_skin]

@links: { SiSU }http://www.jus.uio.no/sisu/ { FSF }http://www.fsf.org - +

@promo: 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 @@ -813,33 +810,33 @@ sample: free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_willia

:A~ 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 -

:B~ Second level heading [this is a heading level divider] +

:B~ Second level heading [this is a heading level divider]

:C~ Third -level heading [this is a heading level divider] +level heading [this is a heading level divider]

1~ 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 -

form 1~my_filename_for_this_segment +

form 1~my_filename_for_this_segment

2~ 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.

3~ 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

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

For some help on document structure try +and 0.38 markup simple) +

For some help on document structure try

sisu --help -

headings -

and view sample markup documents provided -

-

+

headings +

and view sample markup documents provided +

+

Configuration Files

@@ -858,20 +855,20 @@ Configuration determines the output and processing directories and the database access details.

A sample sisurc.yml may be found in /etc/sisu/sisurc.yml -

+

More HELP on Markup and headers

type: sisu ~
sisu --help
- +

markup help is available on:
document wide instructions: headers (document structure)
general text markup: headings; endnotes; tables
- +

A markup table and sample marked-up files (also in html with syntax highlighting) -are available at: +are available at:

<http://www.jus.uio.no/sisu/sample -> -

+> +

DIRECTORY STRUCTURE & Document Output

@@ -896,7 +893,7 @@ is not writable to /tmp/sisu_processing

Output is written to sub-directories within /var/www/ if it exists and is writable, and otherwise to ~/sisu_output - +

Markup Document Directories and File Mapping

@@ -938,7 +935,7 @@ text

doc.html full length scrollable document

toc.html index for segmented text

-html segments, as many as there may be... +html segments, as many as there may be...

portrait.pdf
@@ -1024,7 +1021,7 @@ the directory ~/ebook

would be placed in tables within the database

SiSU_ebook
- +

SKINS - document, directory and site skins

Skins @@ -1057,7 +1054,7 @@ may be found in /etc/sisu/skin/doc and /usr/share/doc/sisu/sisu_markup_samples/d (or equivalent directory)

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)

Document Naming Convention

SiSU documents are named with the @@ -1078,14 +1075,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. -

.sxs.xml simple xml sax, sisu markup representation +

.sxs.xml simple xml sax, sisu markup representation

.sxd.xml simple xml dom, -

sisu markup representation +

sisu markup representation

.sxn.xml simple xml node, sisu markup representation

.sxs.xml.sst or .sxd.xml.sst or .sxn.xml.sst auto-converted from a simple xml markup -representation (sxs, sxd, sxn) +representation (sxs, sxd, sxn)

Remote Operations

These may be of three @@ -1114,7 +1111,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.

Note

For basic use only a fraction @@ -1126,8 +1123,8 @@ to in the text <http://www.jus.u > 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. -

+it uses. +

Processing Examples

To initialise a new directory sisu -C

@@ -1175,7 +1172,7 @@ it may be necessary to first run sisu -Dv createdb

import all marked up files first time into a database: sisu -Dv import *

--c toggles color +-c toggles color

Interactive Help Options

SiSU @@ -1214,69 +1211,69 @@ tables of contents) external_programs, dublincore, termsheet, search, features, external_programs, license, exit -

+

SiSU VERSION CONVERSION

sisu --to-current [filename/wildcard] converts from -0.37 markup to current markup (0.38) +0.37 markup to current markup (0.38)

sisu --to-38 [filename/wildcard] converts -

from 0.37 markup to 0.38 +

from 0.37 markup to 0.38

sisu --to-37 [filename/wildcard] converts from 0.38 -

markup to 0.37 +

markup to 0.37

sisu --convert-36to37 [filename/wildcard] re-names file from -

pre-0.36 convention to 0.37 +

pre-0.36 convention to 0.37

sisu --convert-footnotes [filename/wildcard] converts -

footnotes to preferred embedded footnote markup style +

footnotes to preferred embedded footnote markup style

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

convert from sst to simple xml -representations (sax, dom and node): +representations (sax, dom and node):

sisu --to-sax [filename/wildcard] or -sisu --to-sxs [filename/wildcard] +sisu --to-sxs [filename/wildcard]

sisu --to-dom [filename/wildcard] or sisu ---to-sxd [filename/wildcard] +--to-sxd [filename/wildcard]

sisu --to-node [filename/wildcard] or sisu --to-sxn -[filename/wildcard] +[filename/wildcard]

convert to sst from simple xml representations (sax, -dom and node): +dom and node):

sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] -

or the same: +

or the same:

sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]

sisu --from-kdi [kdissert filename] attempts to convert a kdissert file (.kdi) -

to sisu markup +

to sisu markup

sisu --identify [filename/wildcard] attempts to identify -

the markup version of the file +

the markup version of the file

sisu --query=[version number] and sisu --query=history -

provides a brief summary of changes to SiSU markup -

+

provides a brief summary of changes to SiSU markup +

Sample Markup Documents

Sample markup documents are provided in sisu-examples and are available -online. -

+online. +

Home Page

<http://www.jus.uio.no/sisu -> -

+> +

Author

Ralph Amissah <ralph@amissah.com> -or <ralph.amissah@gmail.com> -

+or <ralph.amissah@gmail.com> +

See Also

sisu(8) , sisu_webrick(1) -- cgit v1.2.3