aboutsummaryrefslogtreecommitdiffhomepage
path: root/man/man1/sisu.1
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2010-03-06 09:47:55 -0500
committerRalph Amissah <ralph@amissah.com>2010-03-06 09:47:55 -0500
commit306aed5b8a559aad2fb944a946ffdda9713f07ec (patch)
treecf627bc6438dba6103d4e05a1d5cff678f78df6f /man/man1/sisu.1
parentskin_sisu utf-8 marker (diff)
introducing version 2, major patch, (version 1 libraries retained)sisu_2.0.0
Diffstat (limited to 'man/man1/sisu.1')
-rw-r--r--man/man1/sisu.1849
1 files changed, 227 insertions, 622 deletions
diff --git a/man/man1/sisu.1 b/man/man1/sisu.1
index 982b2adb..98e83ed7 100644
--- a/man/man1/sisu.1
+++ b/man/man1/sisu.1
@@ -1,12 +1,16 @@
-.TH "sisu" "1" "2009-12-21" "1.0.0" "SiSU"
+.TH "sisu" "1" "2010-03-03" "2.0.0" "SiSU"
.SH NAME
sisu \- documents: markup, structuring, publishing in multiple standard formats, and search
.SH SYNOPSIS
-sisu [\-abcDdFHhIiMmNnopqRrSsTtUuVvwXxYyZz0\-9] [filename/wildcard ]
+sisu [\-abcDdFehIiMmNnopqRrSsTtUuVvwXxYyZz0\-9] [filename/wildcard ]
.BR
sisu [\-Ddcv] [instruction]
.BR
sisu [\-CcFLSVvW]
+.BR
+sisu \-\-v2 [operations]
+.BR
+sisu \-\-v1 [operations]
.SH
SISU \- MANUAL,
RALPH AMISSAH
@@ -148,8 +152,7 @@ also provides other features such as concordance files and document content
certificates, and the working against an abstraction of document structure has
further possibilities for the research and development of other document
representations, the availability of objects is useful for example for topic
-maps and the commercial law thesaurus by Vikki Rogers and Al Krtizer, together
-with the flexibility of
+maps and thesauri, together with the flexibility of
.B SiSU
offers great possibilities.
@@ -179,7 +182,7 @@ content prepared in
\- Structured information, Serialized Units \- a document publishing system
.BR
-sisu [ \ \-abcDdFHhIiMmNnopqRrSsTtUuVvwXxYyZz0\-9 \ ] [ \ filename/ \ wildcard
+sisu [ \ \-abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0\-9 \ ] [ \ filename/ \ wildcard
\ ]
.BR
@@ -260,6 +263,10 @@ instead) or to specify another database \-\-db\-[pgsql, \ sqlite] (however see
database section below.
.TP
+.B \-e [filename/wildcard]
+produces an epub document, [sisu \ version \ 2 \ only] (filename.epub)
+
+.TP
.B \-F [\-\-webserv=webrick]
generate examples of (naive) cgi search form for sqlite and pgsql depends on
your already having used sisu to populate an sqlite and/or pgsql database, (the
@@ -274,18 +281,9 @@ that they be copied to the cgi\-bin directory). \-Fv (in addition to the above)
provides some information on setting up hyperestraier for sisu
.TP
-.B \-H [filename/wildcard]
-produces html without link suffixes (.html \.pdf etc.) (\"Hide\"). Requires
-an appropriately configured web server. [behaviour \ switched \ after \ 0.35 \
-see \ \-h].
-
-.TP
.B \-h [filename/wildcard]
-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].
+produces html output, segmented text with table of contents (toc.html and
+index.html) and the document in a single file (scroll.html)
.TP
.B \-I [filename/wildcard]
@@ -306,7 +304,6 @@ indicated. (also see \-V)
.TP
.B \-m [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
@@ -423,8 +420,8 @@ version information
.TP
.B \-v [filename/wildcard]
-provides verbose output of what is being built, where it is being built (and
-error messages if any), as with \-u flag provides a url mapping of files
+provides verbose output of what is being generated, where output is placed
+(and error messages if any), as with \-u flag provides a url mapping of files
created for each of the processing flag requests. See also \-V
.TP
@@ -521,9 +518,9 @@ postgresql database (a database should be created manually and given the same
name as working directory, as requested) (rb.dbi) [ \ \-dv \ \-\-createall \
sqlite \ equivalent] it may be necessary to run sisu \-Dv \-\-createdb
initially NOTE: at the present time for postgresql it may be necessary to
-manually create the database. The command would be \'createdb [database \
-name]\' where database name would be SiSU_[present \ working \ directory \ name
-\ (without \ path)]. Please use only alphanumerics and underscores.
+manually create the database. The command would be 'createdb [database \ name]'
+where database name would be SiSU_[present \ working \ directory \ name \
+(without \ path)]. Please use only alphanumerics and underscores.
.TP
.B \-Dv \-\-import
@@ -572,23 +569,23 @@ options \ are \ give, \ i.e. \ on \ \'sisu \ [filename]\']
.TP
.B \-1
-\-mNHwpy
+\-mhewpy
.TP
.B \-2
-\-mNHwpaoy
+\-mhewpaoy
.TP
.B \-3
-\-mNhwpAobxXyY
+\-mhewpAobxXyY
.TP
.B \-4
-\-mNhwpAobxXDyY \-\-import
+\-mhewpAobxXDyY \-\-import
.TP
.B \-5
-\-mNhwpAobxXDyY \-\-update
+\-mhewpAobxXDyY \-\-update
.BR
add \-v for verbose mode and \-c for color, e.g. sisu \-2vc [filename \ or \
@@ -630,10 +627,10 @@ The manual can be generated from source, found respectively, either within the
tarball or installed locally at:
.BR
- ./data/doc/sisu/v1/sisu_markup_samples/sisu_manual/
+ ./data/doc/sisu/v2/sisu_markup_samples/sisu_manual/
.BR
- /usr/share/doc/sisu/v1/sisu_markup_samples/sisu_manual/
+ /usr/share/doc/sisu/v2/sisu_markup_samples/sisu_manual/
.BR
move to the respective directory and type e.g.:
@@ -667,22 +664,22 @@ the sisu manual, the sources files for which are located within the
tarball at:
.BR
- ./data/doc/sisu/v1/sisu_markup_samples/sisu_manual/
+ ./data/doc/sisu/v2/sisu_markup_samples/sisu_manual/
.BR
Once installed, directory equivalent to:
.BR
- /usr/share/doc/sisu/v1/sisu_manual/
+ /usr/share/doc/sisu/sisu_manual/
.BR
Available man pages are converted back to html using man2html:
.BR
- /usr/share/doc/sisu/v1/html/
+ /usr/share/doc/sisu/v2/html/
.BR
- ./data/doc/sisu/v1/html/
+ ./data/doc/sisu/v2/html/
.BR
An online version of the sisu man page is available here:
@@ -749,7 +746,7 @@ For lists of alternative help sources, see:
.B man2html
.BR
- /usr/share/doc/sisu/v1/html/sisu.1.html
+ /usr/share/doc/sisu/v2/html/sisu.1.html
.BR
<http://sisudoc.org/sisu/sisu_help_sources/index.html>
@@ -853,9 +850,9 @@ an alternative presentation of markup syntax:
With
.B SiSU
installed sample skins may be found in:
-/usr/share/doc/sisu/v1/sisu_markup_samples/dfsg (or equivalent directory) and if
+/usr/share/doc/sisu/sisu_markup_samples/dfsg (or equivalent directory) and if
sisu\-markup\-samples is installed also under:
-/usr/share/doc/sisu/v1/sisu_markup_samples/non\-free
+/usr/share/doc/sisu/sisu_markup_samples/non\-free
.SH
8. MARKUP OF HEADERS
@@ -884,65 +881,44 @@ This current document has a header similar to this one (without the comments):
.nf
- % SiSU 0.57
-.BR
+ % SiSU master 2.0
@title: SiSU
-.BR
- @subtitle: Markup
-.BR
- @creator: Amissah, Ralph
-.BR
- % note formatting rules on author / creator field, \"Surname, Other names\", if more than one author separate by semi\-colon (if name is of an institution just write name or the name contains a comma enclose in quotation marks)
-.BR
- @rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
-.BR
- @type: information
-.BR
- @subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search
-.BR
- @topic_register: text markup language; application:text processing;output:html|xml|latex|pdf|sql
-.BR
- % note formatting for topic_register topic levels are separated by a colon, a semi\-colon separates main topics
-.BR
- @date: 2007\-09\-16
-.BR
- % original publication date unless the substantive text is updated/modified, then date of update
-.BR
- @date.created: 2002\-08\-28
-.BR
- @date.issued: 2002\-08\-28
-.BR
- @date.available: 2002\-08\-28
-.BR
- @date.modified: 2007\-09\-16
-.BR
- @level: new=C; break=1; num_top=1
-.BR
- % comment: in this @level header num_top=1 starts automatic heading numbering at heading level 1 (numbering continues 3 levels down); the new and break instructions are used by the LaTeX/pdf and odf output to determine where to put page breaks (that are not used by html output or say sql database population).
-.BR
- @skin: skin_sisu_manual
-.BR
- % skins modify the appearance of a document and are placed in a sub\-directory under \./_sisu/skin ~/.sisu/skin or /etc/sisu/skin. A skin may affect single documents that request them, all documents in a directory, or be site\-wide. (A document is affected by a single skin)
-.BR
- @bold: /Gnu|Debian|Ruby|SiSU/
-.BR
+ :subtitle: Manual
+ @creator: :author: Amissah, Ralph
+ @rights: Copyright (C) Ralph Amissah 2007, License GPL 3
+ @classify:
+ :type: information
+ :topic_register: SiSU:manual;electronic documents:SiSU:manual
+ :subject: ebook, epublishing, electronic book, electronic publishing,
+ electronic document, electronic citation, data structure,
+ citation systems, search
+ % used_by: manual
+ @date: :published: 2008\-05\-22
+ :created: 2002\-08\-28
+ :issued: 2002\-08\-28
+ :available: 2002\-08\-28
+ :modified: 2010\-03\-03
+ @make: :num_top: 1
+ :breaks: new=C; break=1
+ :skin: skin_sisu_manual
+ :bold: /Gnu|Debian|Ruby|SiSU/
+ :manpage: name=sisu \- documents: markup, structuring, publishing
+ in multiple standard formats, and search;
+ synopsis=sisu \ [\-abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0\-9] \ [filename/wildcard \ ]
+ . sisu \ [\-Ddcv] \ [instruction]
+ . sisu \ [\-CcFLSVvW]
+ . sisu \-\-v2 \ [operations]
+ . sisu \-\-v1 \ [operations]
@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/
-.BR
- { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html
-.BR
- { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU
-.BR
- { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/
-.BR
- { SiSU @ Ruby Application Archive }http://raa.ruby\-lang.org/project/sisu/
-.BR
- { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html
-.BR
- { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html
-.BR
- { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html
-.BR
-.BR
+ { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html
+ { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU
+ { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/
+ { SiSU @ Ruby Application Archive }http://raa.ruby\-lang.org/project/sisu/
+ { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html
+ { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html
+ { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html
+ { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/
+ { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/
.fi
.SH
@@ -959,8 +935,8 @@ form @headername: or 0~headername. All Dublin Core meta tags are available
information or instructions
.BR
-where the \"identifier\" is a tag recognised by the program, and the
-\"information\" or \"instructions\" belong to the tag/indentifier specified
+where the "identifier" is a tag recognised by the program, and the
+"information" or "instructions" belong to the tag/indentifier specified
.BR
Note: a header where used should only be used once; all headers apart from
@@ -970,234 +946,84 @@ structure, and can be useful to know.
.BR
This is a sample header
-.BR
-.B % SiSU 0.38
-[declared \ file\-type \ identifier \ with \ markup \ version]
-
-
-.BR
-.B @title:
- \ [title \ text] This is the title of the document and used as such, this header is the only one that is
-.I mandatory
-
-.BR
-.B @subtitle:
-The Subtitle if any
-
-.BR
-.B @creator:
-[or \ @author:] Name of Author
-
-.BR
-.B @subject:
-(whatever your subject)
-
-.BR
-.B @description:
-
-.BR
-.B @publisher:
-
-.BR
-.B @contributor:
-
-.BR
-.B @translator:
-\ [or \ @translated_by:]
-
-.BR
-.B @illustrator:
-\ [or \ @illustrated_by:]
-.BR
-.B @prepared_by:
-\ [or \ @digitized_by:]
-
-.BR
-.B @date: 2000\-08\-27
-[ \ also \ @date.created: \ @date.issued: \ @date.available: \ @date.valid: \
-@date.modified: \ ]
-
-
-.BR
-.B @type: article
-
-.BR
-.B @format:
-
-.BR
-.B @identifier:
-
-.BR
-.B @source:
-
-.BR
-.B @language:
-[or \ @language.document:] [country \ code \ for \ language \ if \ available,
-\ or \ language, \ English, \ en \ is \ the \ default \ setting] (en \-
-English, fr \- French, de \- German, it \- Italian, es \- Spanish, pt \-
-Portuguese, sv \- Swedish, da \- Danish, fi \- Finnish, no \- Norwegian, is \-
-Icelandic, nl \- Dutch, et \- Estonian, hu \- Hungarian, pl \- Polish, ro \-
-Romanian, ru \- Russian, el \- Greek, uk \- Ukranian, tr \- Turkish, sk \-
-Slovak, sl \- Slovenian, hr \- Croatian, cs \- Czech, bg \- Bul garian )
-[however, \ encodings \ are \ not \ available \ for \ all \ of \ the \
-languages \ listed.]
-
-.BR
-[@language.original: \ original \ language \ in \ which \ the \ work \ was \
-published]
-
-.BR
-.B @papersize:
-(A4|US_letter|book_B5|book_A5|US_legal)
-
-.BR
-.B @relation:
-
-.BR
-.B @coverage:
-
-.BR
-.B @rights:
-Copyright (c) Name of Right Holder, all rights reserved, or as granted:
-public domain, copyleft, creative commons variant, etc.
-
-.BR
-.B @owner:
-
-.BR
-.B @keywords:
-text document generation processing management latex pdf structured xml
-citation [your \ keywords \ here, \ used \ for \ example \ by \ rss \ feeds, \
-and \ in \ sql \ searches]
-
-.BR
-.B @abstract:
-[paper \ abstract, \ placed \ after \ table \ of \ contents]
-
-.BR
-.B @comment:
-[...]
-
-.BR
-.B @catalogue:
-loc=[Library \ of \ Congress \ classification]; dewey=[Dewey \
-classification]; isbn=[ISBN]; pg=[Project \ Gutenberg \ text \ number]
-
-.BR
-.B @classify_loc:
-[Library \ of \ Congress \ classification]
-
-.BR
-.B @classify_dewey:
-[Dewey \ classification]
-
-.BR
-.B @classify_isbn:
-[ISBN]
-
-.BR
-.B @classify_pg:
-[Project \ Gutenberg \ text \ number]
-
-.BR
-.B @prefix:
-[prefix \ is \ placed \ just \ after \ table \ of \ contents]
-
-.BR
-.B @prefix_a:
-[prefix \ is \ placed \ just \ before \ table \ of \ contents \ \- \ not \
-implemented]
-
-.BR
-.B @prefix_b:
-
-.BR
-.B @rcs:
-$Id: sisu_markup.sst,v 1.2 2007/09/08 17:12:47 ralph Exp $ [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 \ ]
-
-.BR
-.B @structure:
-PART; CHAPTER; SECTION; ARTICLE; none; none;
-optional, document structure can be defined by words to match 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 tag, and may be used to supplement the
-instructions provided in this header tag if provided (@structure: is a synonym
-for @toc:)
+.nf
+ % SiSU 2.0 \ [declared \ file\-type \ identifier \ with \ markup \ version]
+.fi
-.BR
-.B @level:
-newpage=3; breakpage=4
-[paragraph \ level, \ used \ by \ latex \ to \ breakpages, \ the \ page \ is
-\ optional \ eg. \ in \ newpage]
+.nf
+ @title: \ [title \ text] \ [this \ header \ is \ the \ only \ one \ that \ is \ mandatory]
+ :subtitle: \ [subtitle \ if \ any]
+ :language: English
+.fi
-.BR
-.B @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 on a new page in single
-column text and on a new column in double column text; newpage: starts on a new
-page for both single and double column texts.
-num_top=4 [auto\-number \ document, \ starting \ at \ 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]
-num_extract [take \ numbering \ of \ headings \ provided \ (manually \ in \
-marked \ up \ source \ document), \ and \ use \ for \ numbering \ of \
-segments. \ Available \ 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]
+.nf
+ @creator: :author: \ [Lastname, \ First \ names]
+ :illustrator: \ [Lastname, \ First \ names]
+ :translator: \ [Lastname, \ First \ names]
+ :prepared_by: \ [Lastname, \ First \ names]
+.fi
-.BR
-.B @bold:
-[regular \ expression \ of \ words/phrases \ to \ be \ made \ bold]
+.nf
+ @date: :published: \ [year \ or \ yyyy\-mm\-dd]
+ :created: \ [year \ or \ yyyy\-mm\-dd]
+ :issued: \ [year \ or \ yyyy\-mm\-dd]
+ :available: \ [year \ or \ yyyy\-mm\-dd]
+ :modified: \ [year \ or \ yyyy\-mm\-dd]
+ :valid: \ [year \ or \ yyyy\-mm\-dd]
+ :added_to_site: \ [year \ or \ yyyy\-mm\-dd]
+ :translated: \ [year \ or \ yyyy\-mm\-dd]
+.fi
-.BR
-.B @italics:
-[regular \ expression \ of \ words/phrases \ to \ italicise]
+.nf
+ @rights: :copyright: Copyright (C) \ [Year \ and \ Holder]
+ :license: \ [Use \ License \ granted]
+ :text: \ [Year \ and \ Holder]
+ :translation: \ [Name, \ Year]
+ :illustrations: \ [Name, \ Year]
+.fi
-.BR
-.B @vocabulary:
-name of taxonomy/vocabulary/wordlist to use against document
+.nf
+ @classify:
+ :topic_register: SiSU:markup sample:book;book:novel:fantasy
+ :type:
+ :subject:
+ :description:
+ :keywords:
+ :abstract:
+ :isbn: \ [ISBN]
+ :loc: \ [Library \ of \ Congress \ classification]
+ :dewey: \ [Dewey \ classification
+ :pg: \ [Project \ Gutenberg \ text \ number]
+.fi
-.BR
-.B @skin:
-skin_doc_[name_of_desired_document_skin]
-skins change default settings related to the appearance of documents
-generated, such as the urls of the home site, and the icon/logo for the
-document or site.
+.nf
+ @links: { SiSU }http://www.jus.uio.no/sisu/
+ { FSF }http://www.fsf.org
+.fi
-.TP
-.B @man: 8;
-name=sisu \- documents: markup, structuring, publishing in multiple standard
-formats, and search;
-synopsis=sisu [\-abcDdFHhIiMmNnopqRrSsTtUuVvwXxYyZz0\-9] [filename/wildcard \
-]
-sisu [\-Ddcv] [instruction]
-sisu [\-CcFLSVvW]
-the man page category number (default 1) and special tags used in preparing
-man page headings
+.nf
+ @make:
+ :skin: skin_name
+ [skins change default settings related to the appearance of documents generated]
+ :num_top: 1
+ :headings: \ [text \ to \ match \ for \ each \ level
+ (e.g. PART; Chapter; Section; Article;
+ or another: none; BOOK|FIRST|SECOND; none; CHAPTER;)
+ :breaks: new=:C; break=1
+ :promo: sisu, ruby, sisu_search_libre, open_society
+ :bold: [regular expression of words/phrases to be made bold]
+ :italics: \ [regular \ expression \ of \ words/phrases \ to \ italicise]
+.fi
-.BR
-.B @links:
-{
-.B SiSU
-}http://www.jus.uio.no/sisu/;
-{ FSF }http://www.fsf.org
+.nf
+ @original: :language: \ [language]
+.fi
-.BR
-.B @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 \
-sample: \
-free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst]
+.nf
+ @notes: :comment:
+ :prefix: \ [prefix \ is \ placed \ just \ after \ table \ of \ contents]
+.fi
.SH
9. MARKUP OF SUBSTANTIVE TEXT
@@ -1249,8 +1075,9 @@ normally be marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a document
.nf
1~filename level 1 heading,
-.BR
- % the primary division such as Chapter that is followed by substantive text, and may be further subdivided (this is the level on which by default html segments are made)
+ % the primary division such as Chapter that is followed by substantive text,
+ % and may be further subdivided (this is the level on which by default html
+ % segments are made)
.fi
.SH
@@ -1293,12 +1120,13 @@ normal text
.B bold text
.I underscore
.I italics
-<cite>citation</cite> ^superscript^ \ [subscript] <ins>inserted text</ins>
-<del>strikethrough</del>
+"citation" ^superscript^ [subscript] ++inserted text++ \-\-strikethrough\-\-
.BR
normal text
+.BR
+.B emphasis
.BR
.B bold text
@@ -1310,7 +1138,7 @@ normal text
.I italics
.BR
-<cite>citation</cite>
+"citation"
.BR
^superscript^
@@ -1319,10 +1147,10 @@ normal text
[subscript]
.BR
-<ins>inserted text</ins>
+++inserted text++
.BR
-<del>strikethrough</del>
+\-\-strikethrough\-\-
.SH
9.3 INDENTATION AND BULLETS
@@ -1448,7 +1276,6 @@ normal text [^*] continues
.BR
normal text [^**] continues
-
.BR
.B markup example:
@@ -1519,8 +1346,7 @@ An escaped url without decoration
.nf
- normal text http://www.jus.uio.no/sisu continues
-.BR
+ normal text _http://www.jus.uio.no/sisu continues
deb http://www.jus.uio.no/sisu/archive unstable main non\-free
.fi
@@ -1528,10 +1354,10 @@ An escaped url without decoration
.B resulting output:
.BR
-normal text http://www.jus.uio.no/sisu continues
+normal text <_http://www.jus.uio.no/sisu> continues
.BR
-deb http://www.jus.uio.no/sisu/archive unstable main non\-free
+deb <_http://www.jus.uio.no/sisu/archive> unstable main non\-free
.BR
where a code block is used there is neither decoration nor hyperlinking, code
@@ -1630,11 +1456,9 @@ and Ruby\" <http://www.jus.uio.no/sisu/>
.nf
{~^ \ [text \ to \ link] }http://url.org
-.BR
-.BR
% maps to: { \ [text \ to \ link] }http://url.org ~{ http://url.org }~
-.BR
- % which produces hyper\-linked text within a document/paragraph, with an endnote providing the url for the text location used in the hyperlink
+ % which produces hyper\-linked text within a document/paragraph,
+ with an endnote providing the url for the text location used in the hyperlink
.fi
@@ -1662,19 +1486,12 @@ Tables may be prepared in two either of two forms
.nf
table{ c3; 40; 30; 30;
-.BR
This is a table
-.BR
this would become column two of row one
-.BR
column three of row one is here
-.BR
And here begins another row
-.BR
column two of row two
-.BR
column three of row two, and so on
-.BR
}table
.fi
@@ -1694,21 +1511,13 @@ information in each column
.nf
!_ Table 3.1: Contributors to Wikipedia, January 2001 \- June 2005
-.BR
{table~h 24; 12; 12; 12; 12; 12; 12;}
-.BR
|Jan. 2001|Jan. 2002|Jan. 2003|Jan. 2004|July 2004|June 2006
-.BR
Contributors* | 10| 472| 2,188| 9,653| 25,011| 48,721
-.BR
Active contributors** | 9| 212| 846| 3,228| 8,442| 16,945
-.BR
Very active contributors*** | 0| 31| 190| 692| 1,639| 3,016
-.BR
No. of English language articles| 25| 16,000| 101,000| 190,000| 320,000| 630,000
-.BR
No. of articles, all languages | 25| 19,000| 138,000| 490,000| 862,000|1,600,000
-.BR
\\* Contributed at least ten times; \\** at least 5 times in last month; \\*\** more than 100 times in last month.
.fi
@@ -1733,11 +1542,8 @@ than 100 times in last month.
.nf
poem{
-.BR
Your poem here
-.BR
}poem
-.BR
Each verse in a poem is given a separate object number.
.fi
@@ -1747,102 +1553,56 @@ than 100 times in last month.
.nf
poem{
-.BR
- \'Fury said to a
-.BR
+ \`Fury said to a
mouse, That he
-.BR
met in the
-.BR
house,
-.BR
\"Let us
-.BR
both go to
-.BR
law: I will
-.BR
prosecute
-.BR
YOU. \-\-Come,
-.BR
I\'ll take no
-.BR
denial; We
-.BR
must have a
-.BR
trial: For
-.BR
really this
-.BR
morning I\'ve
-.BR
nothing
-.BR
to do.\"
-.BR
Said the
-.BR
mouse to the
-.BR
cur, \"Such
-.BR
a trial,
-.BR
dear Sir,
-.BR
With
-.BR
no jury
-.BR
or judge,
-.BR
would be
-.BR
wasting
-.BR
our
-.BR
breath.\"
-.BR
\"I\'ll be
-.BR
judge, I\'ll
-.BR
be jury,\"
-.BR
Said
-.BR
cunning
-.BR
old Fury:
-.BR
\"I\'ll
-.BR
try the
-.BR
whole
-.BR
cause,
-.BR
and
-.BR
condemn
-.BR
you
-.BR
to
-.BR
death.\"\'
-.BR
}poem
.fi
.BR
.B resulting output:
-
\'Fury said to a
.BR
mouse, That he
@@ -1957,100 +1717,55 @@ than 100 times in last month.
group{
.BR
\'Fury said to a
-.BR
mouse, That he
-.BR
met in the
-.BR
house,
-.BR
\"Let us
-.BR
both go to
-.BR
law: I will
-.BR
prosecute
-.BR
YOU. \-\-Come,
-.BR
I\'ll take no
-.BR
denial; We
-.BR
must have a
-.BR
trial: For
-.BR
really this
-.BR
morning I\'ve
-.BR
nothing
-.BR
to do.\"
-.BR
Said the
-.BR
mouse to the
-.BR
cur, \"Such
-.BR
a trial,
-.BR
dear Sir,
-.BR
With
-.BR
no jury
-.BR
or judge,
-.BR
would be
-.BR
wasting
-.BR
our
-.BR
breath.\"
-.BR
\"I\'ll be
-.BR
judge, I\'ll
-.BR
be jury,\"
-.BR
Said
-.BR
cunning
-.BR
old Fury:
-.BR
\"I\'ll
-.BR
try the
-.BR
whole
-.BR
cause,
-.BR
and
-.BR
condemn
-.BR
you
-.BR
to
-.BR
death.\"\'
-.BR
}group
.fi
.BR
.B resulting output:
-
\'Fury said to a
.BR
mouse, That he
@@ -2161,91 +1876,48 @@ some \ later \ time]
.nf
\'Fury said to a
-.BR
mouse, That he
-.BR
met in the
-.BR
house,
-.BR
\"Let us
-.BR
both go to
-.BR
law: I will
-.BR
prosecute
-.BR
YOU. \-\-Come,
-.BR
I\'ll take no
-.BR
denial; We
-.BR
must have a
-.BR
trial: For
-.BR
really this
-.BR
morning I\'ve
-.BR
nothing
-.BR
to do.\"
-.BR
Said the
-.BR
mouse to the
-.BR
cur, \"Such
-.BR
a trial,
-.BR
dear Sir,
-.BR
With
-.BR
no jury
-.BR
or judge,
-.BR
would be
-.BR
wasting
-.BR
our
-.BR
breath.\"
-.BR
\"I\'ll be
-.BR
judge, I\'ll
-.BR
be jury,\"
-.BR
Said
-.BR
cunning
-.BR
old Fury:
-.BR
\"I\'ll
-.BR
try the
-.BR
whole
-.BR
cause,
-.BR
and
-.BR
condemn
-.BR
you
-.BR
to
-.BR
death.\"\'
.fi
@@ -2263,7 +1935,6 @@ Sub\-terms are separated from the main term by a colon.
.nf
Paragraph containing main term and sub\-term.
-.BR
={Main term:sub\-term}
.fi
@@ -2277,7 +1948,6 @@ The structure of the resulting index would be:
.nf
Main term, 1
-.BR
sub\-term, 1
.fi
@@ -2288,7 +1958,6 @@ the term refers to more than one paragraph, indicate the number of paragraphs.
.nf
Paragraph containing main term, second term and sub\-term.
-.BR
={first term; second term: sub\-term}
.fi
@@ -2298,9 +1967,7 @@ The structure of the resulting index would be:
.nf
First term, 1,
-.BR
Second term, 1,
-.BR
sub\-term, 1
.fi
@@ -2311,9 +1978,7 @@ main term heading from each other by a pipe symbol.
.nf
Paragraph containing main term, second term and sub\-term.
-.BR
={Main term:sub\-term+1|second sub\-term
-.BR
A paragraph that continues discussion of the first sub\-term
.fi
@@ -2324,9 +1989,7 @@ additional paragraph. The logical structure of the resulting index would be:
.nf
Main term, 1,
-.BR
sub\-term, 1\-3,
-.BR
second sub\-term, 1,
.fi
@@ -2359,7 +2022,6 @@ basic markup for importing a document into a master document
.nf
<< filename1.sst
-.BR
<< filename2.ssi
.fi
@@ -2372,11 +2034,8 @@ documents under consideration, and occasionally supported have been.
.nf
<< filename.ssi
-.BR
<<{filename.ssi}
-.BR
% using textlink alternatives
-.BR
<< |filename.ssi|@|^|
.fi
@@ -2539,9 +2198,7 @@ this is captured by the following file \'rename\' instruction:
.nf
rename \'s/\.s[123]$/\.sst/\' *.s{1,2,3}
-.BR
rename \'s/\.r[123]$/\.ssm/\' *.r{1,2,3}
-.BR
rename \'s/\.si$/\.ssi/\' *.si
.fi
@@ -2764,7 +2421,6 @@ incomplete and should be handled with care.
.BR
sisu \-\-to\-node [filename/wildcard] or sisu \-\-to\-sxn [filename/wildcard]
-
.BR
.B convert to sst from any sisu xml representation (sax, dom and node):
@@ -3075,7 +2731,6 @@ directory basis and resulting documents will take on the appropriate different
appearance.
.SH
-17.2 ORGANISING CONTENT
.SH
18. HOMEPAGES
@@ -3137,27 +2792,16 @@ skin_poems.rb
.nf
class Home
-.BR
def homepage
-.BR
# place the html content of your homepage here, this will become index.html
-.BR
<<HOME <html>
-.BR
<head></head>
-.BR
<doc>
-.BR
<p>this is my new homepage.</p>
-.BR
</doc>
-.BR
</html>
-.BR
HOME
-.BR
end
-.BR
end
.fi
@@ -3493,19 +3137,12 @@ command:
.nf
Postgresql
-.BR
user: ralph
-.BR
current db set: SiSU_sisu
-.BR
port: 5432
-.BR
dbi connect: DBI:Pg:database=SiSU_sisu;port=5432
-.BR
sqlite
-.BR
current db set: /home/ralph/sisu_www/sisu/sisu_sqlite.db
-.BR
dbi connect DBI:SQLite:/home/ralph/sisu_www/sisu/sisu_sqlite.db
.fi
@@ -3939,9 +3576,7 @@ archives, they will be available by adding the following to your
.nf
#/etc/apt/sources.list
-.BR
deb http://www.jus.uio.no/sisu/archive unstable main non\-free
-.BR
deb\-src http://www.jus.uio.no/sisu/archive unstable main non\-free
.fi
@@ -3951,7 +3586,6 @@ repeat the aptitude commands
.nf
aptitude update
-.BR
aptitude install sisu\-complete sisu\-markup\-samples
.fi
@@ -4026,11 +3660,8 @@ as root type:
.nf
ruby setup.rb config
-.BR
ruby setup.rb setup
-.BR
#[and \ as \ root:]
-.BR
ruby setup.rb install
.fi
@@ -4117,7 +3748,7 @@ or
change directory to the appropriate one:
.BR
-cd /usr/share/doc/sisu/v1/sisu_markup_samples/dfsg
+cd /usr/share/doc/sisu/sisu_markup_samples/dfsg
.SH
30.2.1 BASIC TEXT, PLAINTEXT, HTML, XML, ODF
@@ -4260,10 +3891,10 @@ home site.
The directory:
.BR
- \./data/sisu/v1/conf/editor\-syntax\-etc/
+ \./data/sisu/v2/conf/editor\-syntax\-etc/
.BR
- /usr/share/sisu/v1/conf/editor\-syntax\-etc
+ /usr/share/sisu/v2/conf/editor\-syntax\-etc
.BR
contains rudimentary sisu syntax highlighting files for:
@@ -4776,28 +4407,28 @@ pdf, and odf which may be also be accessed via the html pages[^28]
34.3.1 LOCALLY INSTALLED
.BR
-<file:///usr/share/doc/sisu/v1/html/sisu.1.html>
+<file:///usr/share/doc/sisu/v2/html/sisu.1.html>
.BR
-<file:///usr/share/doc/sisu/v1/html/sisu_help.1.html>
+<file:///usr/share/doc/sisu/v2/html/sisu_help.1.html>
.BR
-<file:///usr/share/doc/sisu/v1/html/sisu_help_sources.1.html>
+<file:///usr/share/doc/sisu/v2/html/sisu_help_sources.1.html>
.BR
- /usr/share/doc/sisu/html/v1/sisu.1.html
+ /usr/share/doc/sisu/html/v2/sisu.1.html
.BR
- /usr/share/doc/sisu/html/v1/sisu_pdf.7.html
+ /usr/share/doc/sisu/html/v2/sisu_pdf.7.html
.BR
- /usr/share/doc/sisu/html/v1/sisu_postgresql.7.html
+ /usr/share/doc/sisu/html/v2/sisu_postgresql.7.html
.BR
- /usr/share/doc/sisu/html/v1/sisu_sqlite.7.html
+ /usr/share/doc/sisu/html/v2/sisu_sqlite.7.html
.BR
- /usr/share/doc/sisu/html/v1/sisu_webrick.1.html
+ /usr/share/doc/sisu/html/v2/sisu_webrick.1.html
.SH
34.3.2 WWW.JUS.UIO.NO/SISU
@@ -4823,94 +4454,6 @@ pdf, and odf which may be also be accessed via the html pages[^28]
.BR
<http://www.jus.uio.no/sisu/man/sisu_webrick.1.html>
-.SH
-DOCUMENT INFORMATION (METADATA)
-.BR
-
-.SH
-METADATA
-.BR
-
-.BR
-Document Manifest @ <http://sisudoc.org/sisu_manual/sisu/sisu_manifest.html>
-
-.BR
-.B Dublin Core
-(DC)
-
-.BR
-.I DC tags included with this document are provided here.
-
-Title:
-.I SiSU \- Manual
-
-Creator:
-.I Ralph Amissah
-
-Rights:
-.I Copyright (C) Ralph Amissah 2008, part of SiSU documentation, License GPL 3
-
-.BR
-Type:
-.I information
-
-.BR
-Date created:
-.I 2002\-08\-28
-
-.BR
-Date issued:
-.I 2002\-08\-28
-
-.BR
-Date available:
-.I 2002\-08\-28
-
-.BR
-Date modified:
-.I 2008\-12\-16
-
-.BR
-Date:
-.I 2008\-12\-16
-
-
-.BR
-.B Version Information
-
-.BR
-Sourcefile:
-.I sisu.ssm.sst
-
-.BR
-Filetype:
-.I SiSU text insert 0.67
-
-.BR
-Sourcefile Digest, MD5(sisu.ssm.sst)=
-.I 96d1e268b43e0430a2720e67a5876e5e
-
-.BR
-Skin_Digest: MD5(skin_sisu_manual.rb)=
-.I 072b2584bedea82ea8a416587b9fa244
-
-.BR
-.B Generated
-
-.BR
-Document (metaverse) last generated:
-.I Tue Dec 16 00:16:50 \-0500 2008
-
-.BR
-Generated by:
-.I SiSU
-.I 0.70.2
-of 2008w50/2 (2008\-12\-16)
-
-.BR
-Ruby version:
-.I ruby 1.8.7 (2008\-08\-11 patchlevel 72) \ [i486\-linux]
-
.TP
.BI 1.
objects include: headings, paragraphs, verse, tables, images, but not
@@ -5048,6 +4591,68 @@ distributable are not freely changeable.
.BI 28.
named index.html or more extensively through sisu_manifest.html
+.BR
+
+.TP
+Title:
+.I SiSU - Manual
+
+.TP
+Creator:
+.I Ralph Amissah
+
+.TP
+Rights:
+.I Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3;
+
+.TP
+Publisher:
+.I SiSU http://www.jus.uio.no/sisu (this copy)
+
+.TP
+Date created:
+.I 2002-08-28
+
+.TP
+Date issued:
+.I 2002-08-28
+
+.TP
+Date available:
+.I 2002-08-28
+
+.TP
+Date modified:
+.I 2010-03-03
+
+.TP
+Date:
+.I 2008-05-22
+
+.TP
+Sourcefile:
+.I sisu.ssm.sst
+
+.TP
+Filetype:
+.I SiSU text insert 2.0
+
+.TP
+Source digest:
+.I MD5(sisu.ssm.sst)= 2a794c5f8a7df8d6a216025243d432d6
+
+.TP
+Generated by:
+.I Generated by: SiSU 2.0.0 of 2010w09/6 (2010-03-06)
+
+.TP
+Ruby version:
+.I ruby 1.8.7 (2010-01-10 patchlevel 249) [i486-linux]
+
+.TP
+Document (dal) last generated:
+.I Fri Mar 05 20:04:20 -0500 2010
+
.TP
Other versions of this document:
.TP