aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/sisu/html/sisu_markup.1.html
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2007-09-23 05:16:21 +0100
committerRalph Amissah <ralph@amissah.com>2007-09-23 05:16:21 +0100
commit50d45c6deb0afd2e4222d2e33a45487a9d1fa676 (patch)
tree100c62d678f009139999bf77c26c81653a721eeb /data/doc/sisu/html/sisu_markup.1.html
parentsisu-0.58.3 + md5s (diff)
primarily todo with sisu documentation, changelog reproduced below:
* start documenting sisu using sisu * sisu markup source files in data/doc/sisu/sisu_markup_samples/sisu_manual/ /usr/share/doc/sisu/sisu_markup_samples/sisu_manual/ * default output [sisu -3] in data/doc/manuals_generated/sisu_manual/ /usr/share/doc/manuals_generated/sisu_manual/ (adds substantially to the size of sisu package!) * help related edits * manpage, work on ability to generate manpages, improved * param, exclude footnote mark count when occurs within code block * plaintext changes made * shared_txt, line wrap visited * file:// link option introduced (in addition to existing https?:// and ftp://) a bit arbitrarily, diff here, [double check changes in sysenv and hub] * minor adjustments * html url match refinement * css added tiny_center * plaintext * endnotes fix * footnote adjustment to make more easily distinguishable from substantive text * flag -a only [flags -A -e -E dropped] controlled by modifiers --unix/msdos --footnote/endnote * defaults, homepage * renamed homepage (instead of index) implications for modifying skins, which need likewise to have any homepage entry renamed * added link to sisu_manual in homepage * css the css for the default homepage is renamed homepage.css (instead of index.css) [consider removing this and relying on html.css] * ruby version < ruby1.9 * place stop on installation and working with for now [ruby String.strip broken in ruby 1.9.0 (2007-09-10 patchlevel 0) [i486-linux], 2007-09-18:38/2] * debian/control restrict use to ruby > 1.8.4 and ruby < 1.9 * debian * debian/control restrict use to ruby > 1.8.4 and ruby < 1.9 * sisu-doc new sub-package for sisu documentation debian/control and sisu-doc.install
Diffstat (limited to 'data/doc/sisu/html/sisu_markup.1.html')
-rw-r--r--data/doc/sisu/html/sisu_markup.1.html1113
1 files changed, 1113 insertions, 0 deletions
diff --git a/data/doc/sisu/html/sisu_markup.1.html b/data/doc/sisu/html/sisu_markup.1.html
new file mode 100644
index 00000000..a0bc5072
--- /dev/null
+++ b/data/doc/sisu/html/sisu_markup.1.html
@@ -0,0 +1,1113 @@
+<!-- manual page source format generated by PolyglotMan v3.2, -->
+<!-- available at http://polyglotman.sourceforge.net/ -->
+
+<html>
+<head>
+<title>"sisu_markup"("1") manual page</title>
+</head>
+<body bgcolor='white'>
+<a href='#toc'>Table of Contents</a><p>
+SISU - MARKUP &nbsp;[0.58], RALPH AMISSAH
+<p> SISU MARKUP
+<p> 1. INTRODUCTION TO SISU
+MARKUP[^1]
+<p> 1.1 SUMMARY
+<p> <b>SiSU</b> source documents are plaintext (UTF-8)[^2]
+
+<p>files
+<p> All paragraphs are separated by an empty line.
+<p> Markup is comprised
+of:
+<p> * at the top of a document, the document header made up of semantic
+meta-data about the document and if desired additional processing instructions
+(such an instruction to automatically number headings from a particular
+level down)
+<p> * followed by the prepared substantive text of which the
+most important single characteristic is the markup of different heading
+levels, which define the primary outline of the document structure. Markup
+of substantive text includes:
+<p> * heading levels defines document structure<br>
+
+<p> * text basic attributes, italics, bold etc.<br>
+
+<p> * grouped text (objects), which are to be treated differently, such
+as code<br>
+ blocks or poems.<br>
+
+<p> * footnotes/endnotes<br>
+
+<p> * linked text and images<br>
+
+<p> * paragraph actions, such as indent, bulleted, numbered-lists, etc.<br>
+
+<p> Some interactive help on markup is available, by typing sisu and selecting
+
+<p>markup or sisu --help markup
+<p> 1.2 MARKUP EXAMPLES
+<p> 1.2.1 ONLINE
+<p> Online markup
+examples are available together with the respective outputs produced from
+&lt;<a href='http://www.jus.uio.no/sisu/SiSU/2.html'>http://www.jus.uio.no/sisu/SiSU/2.html</a>
+&gt; or from &lt;<a href='http://www.jus.uio.no/sisu/sisu_examples/'>http://www.jus.uio.no/sisu/sisu_examples/</a>
+&gt;
+
+<p> There is of course this document, which provides a cursory overview of
+sisu markup and the respective output produced: &lt;<a href='http://www.jus.uio.no/sisu/sisu_markup/'>http://www.jus.uio.no/sisu/sisu_markup/</a>
+&gt;
+
+<p> Some example marked up files are available as html with syntax highlighting
+for viewing: &lt;<a href='http://www.jus.uio.no/sisu/sample/syntax'>http://www.jus.uio.no/sisu/sample/syntax</a>
+&gt;
+<p> an alternative presentation
+of markup syntax: &lt;<a href='http://www.jus.uio.no/sisu/sample/on_markup.txt'>http://www.jus.uio.no/sisu/sample/on_markup.txt</a>
+&gt;
+<p> 1.2.2 INSTALLED
+
+<p> With <b>SiSU</b> installed sample skins may be found in: /usr/share/doc/sisu/sisu_markup_samples/dfsg
+(or equivalent directory) and if sisu-markup-samples is installed also under:
+
+<p>/usr/share/doc/sisu/sisu_markup_samples/non-free
+<p> 2. MARKUP OF HEADERS
+<p>
+ Headers consist of semantic meta-data about a document, which can be used
+by any output module of the program; and may in addition include extra
+processing instructions.
+<p> Note: the first line of a document may include
+information on the markup version used in the form of a comment. Comments
+are a percentage mark at the start of a paragraph (and as the first character
+in a line of text) followed by a space and the comment:
+<p>
+<p> <br>
+<pre> % this would be a comment
+</pre>
+<p> 2.1 SAMPLE HEADER
+<p> This current document has a header similar to this
+one (without the comments):
+<p>
+<p> <br>
+<pre> % SiSU 0.57
+ @title: SiSU
+ @subtitle: Markup &nbsp;[0.58]
+ @creator: Ralph Amissah
+ @rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation,
+License GPL 3
+ @type: information
+ @subject: ebook, epublishing, electronic book, electronic publishing,
+electronic document, electronic citation, data structure, citation systems,
+search
+ @date.created: 2002-08-28
+ @date.issued: 2002-08-28
+ @date.available: 2002-08-28
+ @date.modified: 2007-09-16
+ @date: 2007-09-16
+ @level: new=C; break=1; num_top=1
+ % 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).
+ @skin: skin_sisu_manual
+ % 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)
+ @bold: /Gnu|Debian|Ruby|SiSU/
+ @links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/
+ { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.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
+</pre>
+<p> 2.2 AVAILABLE HEADERS
+<p> 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 @headername: or 0~headername. All
+
+<p>Dublin Core meta tags are available
+<p> <b>@indentifier:</b> information or instructions
+
+<p> where the information
+<p> Note: a header where used should only be used
+once; all headers apart from @title: are optional; the @structure: header
+is used to describe document structure, and can be useful to know.
+<p> This
+
+<p>is a sample header
+<p> <b>% SiSU 0.38</b> &nbsp;[declared &nbsp;file-type &nbsp;identifier &nbsp;with &nbsp;markup
+&nbsp;version]
+<p> <b>@title:</b> &nbsp;[title &nbsp;text] This is the title of the document and used
+as such, this header is the only one that is <i>mandatory</i>
+<p> <b>@subtitle:</b> The
+
+<p>Subtitle if any
+<p> <b>@creator:</b> &nbsp;[or &nbsp;@author:] Name of Author
+<p> <b>@subject:</b> (whatever
+your subject)
+<p> <b>@description:</b>
+<p> <b>@publisher:</b>
+<p> <b>@contributor:</b>
+<p> <b>@translator:</b>
+&nbsp;[or &nbsp;@translated_by:]
+<p> <b>@illustrator:</b> &nbsp;[or &nbsp;@illustrated_by:]
+<p> <b>@prepared_by:</b>
+&nbsp;[or &nbsp;@digitized_by:]
+<p> <b>@date: 2000-08-27</b> &nbsp;[ &nbsp;also &nbsp;@date.created: &nbsp;@date.issued:
+&nbsp;@date.available: &nbsp;@date.valid: &nbsp;@date.modified: &nbsp;]
+<p> <b>@type: article</b>
+<p> <b>@format:</b>
+
+<p> <b>@identifier:</b>
+<p> <b>@source:</b>
+<p> <b>@language:</b> &nbsp;[or &nbsp;@language.document:] &nbsp;[country
+&nbsp;code &nbsp;for &nbsp;language &nbsp;if available, &nbsp;or &nbsp;language, &nbsp;English, &nbsp;en &nbsp;is &nbsp;the &nbsp;default
+&nbsp;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, &nbsp;encodings &nbsp;are &nbsp;not &nbsp;available
+&nbsp;for &nbsp;all &nbsp;of &nbsp;the languages &nbsp;listed.]
+<p> [@language.original: &nbsp;original &nbsp;language
+&nbsp;in &nbsp;which &nbsp;the &nbsp;work &nbsp;was published]
+<p> <b>@papersize:</b> (A4|US_letter|book_B5|book_A5|US_legal)
+
+<p> <b>@relation:</b>
+<p> <b>@coverage:</b>
+<p> <b>@rights:</b> Copyright (c) Name of Right Holder,
+all rights reserved, or as granted: public domain, copyleft, creative commons
+variant, etc.
+<p> <b>@owner:</b>
+<p> <b>@keywords:</b> text document generation processing
+management latex pdf structured xml citation &nbsp;[your &nbsp;keywords &nbsp;here, &nbsp;used
+&nbsp;for &nbsp;example &nbsp;by &nbsp;rss &nbsp;feeds, &nbsp;and &nbsp;in &nbsp;sql &nbsp;searches]
+<p> <b>@abstract:</b> &nbsp;[paper &nbsp;abstract,
+&nbsp;placed &nbsp;after &nbsp;table &nbsp;of &nbsp;contents]
+<p> <b>@comment:</b> &nbsp;[...]
+<p> <b>@catalogue:</b> loc=[Library
+&nbsp;of &nbsp;Congress &nbsp;classification]; dewey=[Dewey &nbsp;rss &nbsp;feeds, classification]; isbn=[ISBN];
+pg=[Project &nbsp;Gutenberg &nbsp;text &nbsp;number]
+<p> <b>@classify_loc:</b> &nbsp;[Library &nbsp;of &nbsp;Congress
+&nbsp;classification]
+<p> <b>@classify_dewey:</b> &nbsp;[Dewey &nbsp;classification]
+<p> <b>@classify_isbn:</b>
+&nbsp;[ISBN]
+<p> <b>@classify_pg:</b> &nbsp;[Project &nbsp;Gutenberg &nbsp;text &nbsp;number]
+<p> <b>@prefix:</b> &nbsp;[prefix
+&nbsp;is &nbsp;placed &nbsp;just &nbsp;after &nbsp;table &nbsp;of &nbsp;contents]
+<p> <b>@prefix_a:</b> &nbsp;[prefix &nbsp;is &nbsp;placed
+&nbsp;just &nbsp;before &nbsp;table &nbsp;of &nbsp;contents &nbsp;- &nbsp;not implemented]
+<p> <b>@prefix_b:</b>
+<p> <b>@rcs:</b> $Id:
+sisu_markup.sst,v 1.2 2007/09/08 17:12:47 ralph Exp $ &nbsp;[used &nbsp;by &nbsp;rcs &nbsp;or &nbsp;cvs
+&nbsp;to &nbsp;embed &nbsp;version &nbsp;(revision &nbsp;control) &nbsp;information &nbsp;into 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) document, &nbsp;rcs &nbsp;or &nbsp;cvs &nbsp;can &nbsp;usefully &nbsp;provide &nbsp;a &nbsp;history &nbsp;of
+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) updates &nbsp;to &nbsp;a &nbsp;document &nbsp;]
+<p> <b>@structure:</b>
+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:)
+<p> <b>@level:</b> newpage=3;
+breakpage=4 &nbsp;[paragraph &nbsp;level, &nbsp;used &nbsp;by &nbsp;latex &nbsp;to &nbsp;breakpages, &nbsp;the &nbsp;page &nbsp;in
+&nbsp;newpage]
+<p> <b>@markup:</b> information on the markup used, e.g. new=1,2,3; break=4;
+num_top=4 &nbsp;[or newpage=1,2,3; &nbsp;breakpage=4; &nbsp;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
+&nbsp;[auto-number &nbsp;document, &nbsp;starting &nbsp;at &nbsp;level &nbsp;4. &nbsp;the new default &nbsp;is &nbsp;to &nbsp;provide
+&nbsp;3 &nbsp;levels, &nbsp;as &nbsp;in &nbsp;1 &nbsp;level &nbsp;4, &nbsp;1.1 &nbsp;1.1.1 &nbsp;level &nbsp;6, &nbsp;markup &nbsp;to &nbsp;be &nbsp;merged &nbsp;within &nbsp;level]
+num_extract &nbsp;[take &nbsp;numbering &nbsp;of &nbsp;headings &nbsp;provided &nbsp;(manually &nbsp;in &nbsp;and &nbsp;use
+&nbsp;for &nbsp;numbering &nbsp;of &nbsp;Available &nbsp;where &nbsp;a &nbsp;clear &nbsp;numbering &nbsp;structure &nbsp;is &nbsp;without
+&nbsp;the &nbsp;repetition &nbsp;of &nbsp;a &nbsp;number in &nbsp;a &nbsp;header.] &nbsp;[In &nbsp;0.38 &nbsp;notation, &nbsp;you &nbsp;would &nbsp;map
+&nbsp;to &nbsp;the equivalent &nbsp;levels, &nbsp;the &nbsp;examples &nbsp;provided &nbsp;would &nbsp;map &nbsp;to &nbsp;the following
+&nbsp;new=A,B,C; &nbsp;break=1; &nbsp;num_top=1 &nbsp;&nbsp;[or &nbsp;newpage=A,B,C; breakpage=1; &nbsp;num_top=1]
+see headings]
+<p> <b>@bold:</b> &nbsp;[regular &nbsp;expression &nbsp;of &nbsp;words/phrases &nbsp;to &nbsp;be &nbsp;made
+&nbsp;bold]
+<p> <b>@italics:</b> &nbsp;[regular &nbsp;expression &nbsp;of &nbsp;words/phrases &nbsp;to &nbsp;italicise]
+<p>
+<b>@vocabulary:</b> name of taxonomy/vocabulary/wordlist to use against document
+
+<p> <b>@skin:</b> 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.
+<p> <b>@links:</b>
+{ <b>SiSU</b> }<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> <b>@promo:</b> sisu,
+ruby, search_libre_docs, open_society &nbsp;[places &nbsp;content &nbsp;in &nbsp;right &nbsp;pane &nbsp;in
+&nbsp;html, &nbsp;makes &nbsp;use &nbsp;of list.yml &nbsp;and &nbsp;promo.yml, &nbsp;commented &nbsp;out &nbsp;sample &nbsp;in &nbsp;document
+sample: and &nbsp;promo.yml, &nbsp;commented &nbsp;out &nbsp;sample &nbsp;in &nbsp;document free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst]
+
+<p> 3. MARKUP OF SUBSTANTIVE TEXT
+<p> 3.1 HEADING LEVELS
+<p> Heading levels are
+:A~ ,:B~ ,:C~ ,1~ ,2~ ,3~ ... :A - :C being part / section headings, followed
+by other heading levels, and 1 -6 being headings followed by substantive
+text or sub-headings. :A~ usually the title :A~? conditional level 1 heading
+(used where a stand-alone document may be imported into another)
+<p> <b>:A~ &nbsp;[heading
+&nbsp;text]</b> Top level heading &nbsp;[this &nbsp;usually &nbsp;has &nbsp;similar &nbsp;content &nbsp;to &nbsp;the &nbsp;] NOTE:
+the heading levels described here are in 0.38 notation, see heading
+<p> <b>:B~
+&nbsp;[heading &nbsp;text]</b> Second level heading &nbsp;[this &nbsp;is &nbsp;a &nbsp;heading &nbsp;level &nbsp;divider]
+<p>
+ <b>:C~ &nbsp;[heading &nbsp;text]</b> Third level heading &nbsp;[this &nbsp;is &nbsp;a &nbsp;heading &nbsp;level &nbsp;divider]
+
+<p> <b>1~ &nbsp;[heading &nbsp;text]</b> 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
+
+<p> <b>2~ &nbsp;[heading &nbsp;text]</b> 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.
+<p> <b>3~ &nbsp;[heading &nbsp;text]</b> 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
+<p>
+<p> <br>
+<pre> 1~filename level 1 heading,
+ % 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)
+</pre>
+<p> 3.2 FONT ATTRIBUTES
+<p> <b>markup example:</b>
+<p>
+<p> <br>
+<pre> normal text !{emphasis}! *{bold text}* _{underscore}_ /{italics}/
+ normal text
+ !{emphasis}!
+ *{bold text}*
+ _{underscore}
+ /{italics}/
+
+ ^{superscript}^
+ ,{subscript},
+ +{inserted text}+
+ -{strikethrough}-
+</pre>
+<p> <b>resulting output:</b>
+<p> normal text &lt;em&gt;emphasis&lt;/em&gt; <b>bold text</b> <i>underscore</i> <i>italics</i>
+&lt;cite&gt;citation&lt;/cite&gt; ^superscript^ &nbsp;[subscript] &lt;ins&gt;inserted text&lt;/ins&gt; &lt;del&gt;strikethrough&lt;/del&gt;
+
+<p> normal text
+<p> &lt;em&gt;emphasis&lt;/em&gt;
+<p> <b>bold text</b>
+<p> <i>underscore</i>
+<p> <i>italics</i>
+<p> &lt;cite&gt;citation&lt;/cite&gt;
+
+<p> ^superscript^
+<p> [subscript]
+<p> &lt;ins&gt;inserted text&lt;/ins&gt;
+<p> &lt;del&gt;strikethrough&lt;/del&gt;
+
+<p> 3.3 INDENTATION AND BULLETS
+<p> <b>markup example:</b>
+<p>
+<p> <br>
+<pre> ordinary paragraph
+ _1 indent paragraph one step
+ _2 indent paragraph two steps
+ _9 indent paragraph nine steps
+</pre>
+<p> <b>resulting output:</b>
+<p> ordinary paragraph
+<p> indent paragraph one step<br>
+
+<p> indent paragraph two steps<br>
+
+<p> indent paragraph nine steps<br>
+
+<p> <b>markup example:</b>
+<p>
+<p> <br>
+<pre> * bullet text
+ _1* bullet text, first indent
+ _2* bullet text, two step indent
+</pre>
+<p> <b>resulting output:</b>
+<p> * bullet text
+<p> * bullet text, first indent<br>
+
+<p> * bullet text, two step indent<br>
+
+<p> Numbered List (not to be confused with headings/titles, (document structure))
+
+<p> <b>markup example:</b>
+<p>
+<p> <br>
+<pre> # numbered list numbered list 1., 2., 3, etc.
+ _# numbered list numbered list indented a., b., c., d., etc.
+</pre>
+<p> 3.4 FOOTNOTES / ENDNOTES
+<p> Footnotes and endnotes not distinguished in
+markup. They are automatically numbered. Depending on the output file format
+(html, odf, pdf etc.), the document output selected will have either footnotes
+or endnotes.
+<p> <b>markup example:</b>
+<p>
+<p> <br>
+<pre> ~{ a footnote or endnote }~
+</pre>
+<p> <b>resulting output:</b>
+<p> [^3]
+<p> <b>markup example:</b>
+<p>
+<p> <br>
+<pre> normal text~{ self contained endnote marker &amp; endnote in one }~ continues
+</pre>
+<p> <b>resulting output:</b>
+<p> normal text[^4] continues
+<p> <b>markup example:</b>
+<p>
+<p> <br>
+<pre> normal text ~{* unnumbered asterisk footnote/endnote, insert multiple
+asterisks if required }~ continues
+ normal text ~{** another unnumbered asterisk footnote/endnote }~ continues
+</pre>
+<p> <b>resulting output:</b>
+<p> normal text &nbsp;[^*] continues
+<p> normal text &nbsp;[^**] continues
+
+<p> <b>markup example:</b>
+<p>
+<p> <br>
+<pre> normal text ~[* &nbsp;editors &nbsp;notes, &nbsp;numbered &nbsp;asterisk &nbsp;footnote/endnote &nbsp;series
+&nbsp;]~ continues
+ normal text ~[+ &nbsp;editors &nbsp;notes, &nbsp;numbered &nbsp;asterisk &nbsp;footnote/endnote &nbsp;series
+&nbsp;]~ continues
+</pre>
+<p> <b>resulting output:</b>
+<p> normal text &nbsp;[^*1] continues
+<p> normal text &nbsp;[^+1] continues
+
+<p> <b>Alternative endnote pair notation for footnotes/endnotes:</b>
+<p>
+<p> <br>
+<pre>
+ % note the endnote marker
+ normal text~^ continues
+ ^~ endnote text following the paragraph in which the marker occurs
+</pre>
+<p> the standard and pair notation cannot be mixed in the same document
+<p>
+
+<p>3.5 LINKS
+<p> 3.5.1 NAKED URLS WITHIN TEXT, DEALING WITH URLS
+<p> urls are found
+within text and marked up automatically. A url within text is automatically
+hyperlinked to itself and by default decorated with angled braces, unless
+they are contained within a code block (in which case they are passed as
+normal text), or escaped by a preceding underscore (in which case the decoration
+is omitted).
+<p> <b>markup example:</b>
+<p>
+<p> <br>
+<pre> normal text http://www.jus.uio.no/sisu continues
+</pre>
+<p> <b>resulting output:</b>
+<p> normal text &lt;<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
+&gt; continues
+<p> An
+
+<p>escaped url without decoration
+<p> <b>markup example:</b>
+<p>
+<p> <br>
+<pre> normal text http://www.jus.uio.no/sisu continues
+ deb http://www.jus.uio.no/sisu/archive unstable main non-free
+</pre>
+<p> <b>resulting output:</b>
+<p> normal text <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
+ continues
+<p> deb
+
+<p><a href='http://www.jus.uio.no/sisu/archive'>http://www.jus.uio.no/sisu/archive</a>
+ unstable main non-free
+<p> where a code block
+is used there is neither decoration nor hyperlinking, code blocks are discussed
+
+<p>later in this document
+<p> <b>resulting output:</b>
+<p>
+<p> <br>
+<pre> deb http://www.jus.uio.no/sisu/archive unstable main non-free
+ deb-src http://www.jus.uio.no/sisu/archive unstable main non-free
+</pre>
+<p> To link text or an image to a url the markup is as follows
+<p> <b>markup example:</b>
+
+<p>
+<p> <br>
+<pre> about { SiSU }http://url.org markup
+</pre>
+<p> 3.5.2 LINKING TEXT
+<p> <b>resulting output:</b>
+<p> about SiSU &lt;<a href='http://www.jus.uio.no/sisu/'>http://www.jus.uio.no/sisu/</a>
+&gt;
+
+<p>markup
+<p> A shortcut notation is available so the url link may also be provided
+
+<p>automatically as a footnote
+<p> <b>markup example:</b>
+<p>
+<p> <br>
+<pre> about {~^ SiSU }http://url.org markup
+</pre>
+<p> <b>resulting output:</b>
+<p> about SiSU &lt;<a href='http://www.jus.uio.no/sisu/'>http://www.jus.uio.no/sisu/</a>
+&gt; &nbsp;[^5] markup
+<p> 3.5.3
+
+<p>LINKING IMAGES
+<p> <b>markup example:</b>
+<p>
+<p> <br>
+<pre> [ tux.png ]
+ % various url linked images
+ [ tux.png ]
+ [ GnuDebianLinuxRubyBetterWay.png ]
+ {~^ ruby_logo.png
+</pre>
+<p> <b>resulting output:</b>
+<p> [ tux.png ]
+<p> tux.png 64x80
+<p> [ &nbsp;ruby_logo &nbsp;(png &nbsp;missing)
+&nbsp;] &nbsp;[^6]
+<p> GnuDebianLinuxRubyBetterWay.png 100x101 and Ruby
+<p> <b>linked url footnote
+
+<p>shortcut</b>
+<p>
+<p> <br>
+<pre> {~^ &nbsp;[text &nbsp;to &nbsp;link] }http://url.org
+ % maps to: { &nbsp;[text &nbsp;to &nbsp;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
+</pre>
+<p>
+<p> <br>
+<pre> text marker *~name
+</pre>
+<p> note at a heading level the same is automatically achieved by providing
+names to headings 1, 2 and 3 i.e. 2~[name] and 3~[name] or in the case of
+auto-heading numbering, without further intervention.
+<p> 3.6 GROUPED TEXT
+<p> 3.6.1
+
+<p>TABLES
+<p> Tables may be prepared in two either of two forms
+<p> <b>markup example:</b>
+
+<p>
+<p> <br>
+<pre> table{ c3; 40; 30; 30;
+ This is a table
+ this would become column two of row one
+ column three of row one is here
+ And here begins another row
+ column two of row two
+ column three of row two, and so on
+ }table
+</pre>
+<p> <b>resulting output:</b>
+<p> &nbsp;[table &nbsp;omitted, &nbsp;see &nbsp;other &nbsp;document &nbsp;formats]<br>
+
+<p> a second form may be easier to work with in cases where there is not
+
+<p>much information in each column
+<p> <b>markup example:</b> [^7]
+<p>
+<p> <br>
+<pre> !_ Table 3.1: Contributors to Wikipedia, January 2001 - June 2005
+ {table~h 24; 12; 12; 12; 12; 12; 12;}
+ |Jan. 2001|Jan. 2002|Jan. 2003|Jan. 2004|July
+2004|June 2006
+ Contributors* | 10| 472| 2,188| 9,653|
+ 25,011| 48,721
+ Active contributors** | 9| 212| 846| 3,228|
+ 8,442| 16,945
+ Very active contributors*** | 0| 31| 190| 692|
+ 1,639| 3,016
+ No. of English language articles| 25| 16,000| 101,000| 190,000|
+320,000| 630,000
+ No. of articles, all languages | 25| 19,000| 138,000| 490,000|
+862,000|1,600,000
+ Contributed at least ten times; at least 5 times in last month; ** more
+than 100 times in last month.
+</pre>
+<p> <b>resulting output:</b>
+<p> <b>Table 3.1: Contributors to Wikipedia, January 2001
+- June 2005</b>
+<p> &nbsp;[table &nbsp;omitted, &nbsp;see &nbsp;other &nbsp;document &nbsp;formats]<br>
+
+<p> * Contributed at least ten times; ** at least 5 times in last month;
+*** more than 100 times in last month.
+<p> 3.6.2 POEM
+<p> <b>basic markup:</b>
+<p>
+<p> <br>
+<pre> poem{
+ Your poem here
+ }poem
+ Each verse in a poem is given a separate object number.
+</pre>
+<p> <b>markup example:</b>
+<p>
+<p> <br>
+<pre> poem{
+ &rsquo;Fury said to a
+ mouse, That he
+ met in the
+ house,
+
+ both go to
+ law: I will
+ prosecute
+ YOU. --Come,
+ I&rsquo;ll take no
+ denial; We
+ must have a
+ trial: For
+ really this
+ morning I&rsquo;ve
+ nothing
+ to do.
+ Said the
+ mouse to the
+ cur,
+ a trial,
+ dear Sir,
+ With
+ no jury
+ or judge,
+ would be
+ wasting
+ our
+ breath.
+
+ judge, I&rsquo;ll
+ be jury,
+ Said
+ cunning
+ old Fury:
+
+ try the
+ whole
+ cause,
+ and
+ condemn
+ you
+ to
+ death.
+ }poem
+</pre>
+<p> <b>resulting output:</b>
+<p>
+<p> &rsquo;Fury said to a<br>
+ <p>
+ mouse, That he<br>
+ <p>
+ met in the<br>
+ <p>
+ house,<br>
+ <p>
+ <br>
+ <p>
+ both go to<br>
+ <p>
+ law: I will<br>
+ <p>
+ prosecute<br>
+ <p>
+ YOU. --Come,<br>
+ <p>
+ I&rsquo;ll take no<br>
+ <p>
+ denial; We<br>
+ <p>
+ must have a<br>
+ <p>
+ trial: For<br>
+ <p>
+ really this<br>
+ <p>
+ morning I&rsquo;ve<br>
+ <p>
+ nothing<br>
+ <p>
+ to do.<br>
+ <p>
+ Said the<br>
+ <p>
+ mouse to the<br>
+ <p>
+ cur,<br>
+ <p>
+ a trial,<br>
+ <p>
+ dear Sir,<br>
+ <p>
+ With<br>
+ <p>
+ no jury<br>
+ <p>
+ or judge,<br>
+ <p>
+ would be<br>
+ <p>
+ wasting<br>
+ <p>
+ our<br>
+ <p>
+ breath.<br>
+ <p>
+ <br>
+ <p>
+ judge, I&rsquo;ll<br>
+ <p>
+ be jury,<br>
+ <p>
+ Said<br>
+ <p>
+ cunning<br>
+ <p>
+ old Fury:<br>
+ <p>
+ <br>
+ <p>
+ try the<br>
+ <p>
+ whole<br>
+ <p>
+ cause,<br>
+ <p>
+ and<br>
+ <p>
+ condemn<br>
+ <p>
+ you<br>
+ <p>
+ to<br>
+ <p>
+ death.<br>
+ <p>
+
+<p> 3.6.3 GROUP
+<p> <b>basic markup:</b>
+<p>
+<p> <br>
+<pre> group{
+ Your grouped text here
+ }group
+ A group is treated as an object and given a single object number.
+</pre>
+<p> <b>markup example:</b>
+<p>
+<p> <br>
+<pre> group{
+ &rsquo;Fury said to a
+ mouse, That he
+ met in the
+ house,
+
+ both go to
+ law: I will
+ prosecute
+ YOU. --Come,
+ I&rsquo;ll take no
+ denial; We
+ must have a
+ trial: For
+ really this
+ morning I&rsquo;ve
+ nothing
+ to do.
+ Said the
+ mouse to the
+ cur,
+ a trial,
+ dear Sir,
+ With
+ no jury
+ or judge,
+ would be
+ wasting
+ our
+ breath.
+
+ judge, I&rsquo;ll
+ be jury,
+ Said
+ cunning
+ old Fury:
+
+ try the
+ whole
+ cause,
+ and
+ condemn
+ you
+ to
+ death.
+ }group
+</pre>
+<p> <b>resulting output:</b>
+<p>
+<p> &rsquo;Fury said to a<br>
+ <p>
+ mouse, That he<br>
+ <p>
+ met in the<br>
+ <p>
+ house,<br>
+ <p>
+ <br>
+ <p>
+ both go to<br>
+ <p>
+ law: I will<br>
+ <p>
+ prosecute<br>
+ <p>
+ YOU. --Come,<br>
+ <p>
+ I&rsquo;ll take no<br>
+ <p>
+ denial; We<br>
+ <p>
+ must have a<br>
+ <p>
+ trial: For<br>
+ <p>
+ really this<br>
+ <p>
+ morning I&rsquo;ve<br>
+ <p>
+ nothing<br>
+ <p>
+ to do.<br>
+ <p>
+ Said the<br>
+ <p>
+ mouse to the<br>
+ <p>
+ cur,<br>
+ <p>
+ a trial,<br>
+ <p>
+ dear Sir,<br>
+ <p>
+ With<br>
+ <p>
+ no jury<br>
+ <p>
+ or judge,<br>
+ <p>
+ would be<br>
+ <p>
+ wasting<br>
+ <p>
+ our<br>
+ <p>
+ breath.<br>
+ <p>
+ <br>
+ <p>
+ judge, I&rsquo;ll<br>
+ <p>
+ be jury,<br>
+ <p>
+ Said<br>
+ <p>
+ cunning<br>
+ <p>
+ old Fury:<br>
+ <p>
+ <br>
+ <p>
+ try the<br>
+ <p>
+ whole<br>
+ <p>
+ cause,<br>
+ <p>
+ and<br>
+ <p>
+ condemn<br>
+ <p>
+ you<br>
+ <p>
+ to<br>
+ <p>
+ death.<br>
+ <p>
+
+<p> 3.6.4 CODE
+<p> Code tags are used to escape regular sisu markup, and have
+been used extensively within this document to provide examples of <b>SiSU</b>
+markup. You cannot however use code tags to escape code tags. They are however
+used in the same way as group or poem tags.
+<p> A code-block is treated as
+an object and given a single object number. &nbsp;[an option &nbsp;to &nbsp;number &nbsp;each &nbsp;line
+&nbsp;of &nbsp;code &nbsp;may &nbsp;be &nbsp;considered &nbsp;at some &nbsp;later &nbsp;time]
+<p> <b>use of code tags instead
+of poem compared, resulting output:</b>
+<p>
+<p> <br>
+<pre> &rsquo;Fury said to a
+ mouse, That he
+ met in the
+ house,
+
+ both go to
+ law: I will
+ prosecute
+ YOU. --Come,
+ I&rsquo;ll take no
+ denial; We
+ must have a
+ trial: For
+ really this
+ morning I&rsquo;ve
+ nothing
+ to do.
+ Said the
+ mouse to the
+ cur,
+ a trial,
+ dear Sir,
+ With
+ no jury
+ or judge,
+ would be
+ wasting
+ our
+ breath.
+
+ judge, I&rsquo;ll
+ be jury,
+ Said
+ cunning
+ old Fury:
+
+ try the
+ whole
+ cause,
+ and
+ condemn
+ you
+ to
+ death.
+</pre>
+<p> 4. COMPOSITE DOCUMENTS MARKUP
+<p> It is possible to build a document by
+creating a master document that requires other documents. The documents
+required may be complete documents that could be generated 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 from other documents), it should be named with the suffix <b>.ssm</b> Within
+this document you would provide information on the other documents that
+should be included within the text. These may be other documents that would
+be processed in a regular way, or markup bits prepared only for inclusion
+within a master document <b>.sst</b> regular markup file, or <b>.ssi</b> (insert/information)
+
+<p>A secondary file of the composite document is built prior to processing
+
+<p>with the same prefix and the suffix <b>._sst</b>
+<p> basic markup for importing a
+
+<p>document into a master document
+<p>
+<p> <br>
+<pre> &lt;&lt; |filename1.sst|@|^|
+ &lt;&lt; |filename2.ssi|@|^|
+</pre>
+<p> The form described above should be relied on. Within the Vim editor it
+results in the text thus linked becoming hyperlinked to the document it
+is calling in which is convenient for editing. Alternative markup for importation
+of documents under consideration, and occasionally supported have been.
+
+<p>
+<p> <br>
+<pre> r{filename}
+ {filename.ssi}require
+ &lt;&lt; {filename.ssi}
+ % using textlink alternatives
+ |filename.ssi|@|^|require
+ &lt;&lt; |filename.ssi|@|^|
+ % using thlnk alternatives
+ &lt;url:filename.ssi&gt;require
+ &lt;&lt; &lt;url:filename.ssi&gt;
+</pre>
+<p> MARKUP SYNTAX HISTORY
+<p> 5. NOTES RELATED TO FILES-TYPES AND MARKUP SYNTAX
+
+<p> 0.38 is substantially current, depreciated 0.16 supported, though file
+
+<p>names were changed at 0.37
+<p> <b>0.52</b> (2007w14/6) declared document type identifier
+at start of text/document:
+<p> .B SiSU<br>
+ 0.52
+<p> or, backward compatible using the comment marker:
+<p> %<br>
+ <b>SiSU</b> 0.38
+<p> variations include &rsquo; <b>SiSU</b> (text|master|insert) &nbsp;[version]&rsquo; and &rsquo;sisu-[version]&rsquo;
+
+<p> <b>0.51</b> (2007w13/6) skins changed (simplified), markup unchanged
+<p> <b>0.42</b> (2006w27/4)
+* (asterisk) type endnotes, used e.g. in relation to author
+<p> <b>0.38</b> (2006w15/7)
+introduced new/alternative notation for headers, e.g. @title: (instead of
+0~title), and accompanying document structure markup, :A,:B,:C,1,2,3 (maps
+to previous 1,2,3,4,5,6)
+<p> <b>0.37</b> (2006w09/7) introduced new file naming convention,
+.sst (text), .ssm (master), .ssi (insert), markup syntax unchanged
+<p> <b>0.35</b> (2005w52/3)
+sisupod, zipped content file introduced
+<p> <b>0.23</b> (2005w36/2) utf-8 for markup
+
+<p>file
+<p> <b>0.22</b> (2005w35/3) image dimensions may be omitted if rmagick is available
+
+<p>to be relied upon
+<p> <b>0.20.4</b> (2005w33/4) header 0~links
+<p> <b>0.16</b> (2005w25/2) substantial
+changes introduced to make markup cleaner, header 0~title type, and headings
+&nbsp;[1-6]~ introduced, also percentage sign (%) at start of a text line as comment
+
+<p>marker
+<p> DOCUMENT INFORMATION (METADATA)
+<p> METADATA
+<p> Document Manifest
+@ &lt;<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_markup/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_markup/sisu_manifest.html</a>
+&gt;
+<p> <b>Dublin
+Core</b> (DC)
+<p> <i>DC</i> tags included with this document are provided here.
+<p> DC
+Title: <i>SiSU</i> - Markup &nbsp;[0.58]
+<p> DC Creator: <i>Ralph</i> Amissah
+<p> DC Rights: <i>Copyright</i>
+(C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
+<p> DC
+Type: <i>information</i>
+<p> DC Date created: <i>2002-08-28</i>
+<p> DC Date issued: <i>2002-08-28</i>
+
+<p> DC Date available: <i>2002-08-28</i>
+<p> DC Date modified: <i>2007-09-16</i>
+<p> DC Date: <i>2007-09-16</i>
+
+<p> <b>Version Information</b>
+<p> Sourcefile: <i>sisu_markup.sst</i>
+<p> Filetype: <i>SiSU</i> text
+
+<p>0.58
+<p> Sourcefile Digest, MD5(sisu_markup.sst)= <i>643738c4b96d001d107e3ea72ba17a97</i>
+
+<p> Skin_Digest: MD5(/home/ralph/grotto/theatre/dbld/sisu-dev/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)=
+
+<p><i>20fc43cf3eb6590bc3399a1aef65c5a9</i>
+<p> <b>Generated</b>
+<p> Document (metaverse) last
+generated: <i>Sun</i> Sep 23 01:13:59 +0100 2007
+<p> Generated by: <i>SiSU</i> <i>0.58.3</i> of
+2007w36/4 (2007-09-06)
+<p> Ruby version: <i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36)
+&nbsp;[i486-linux]
+<p>
+<ol>
+<b>.</b><li>From sometime after SiSU 0.58 it should be possible to describe
+SiSU markup using SiSU, which though not an original design goal is useful.
+</li><b>.</b><li>files should be prepared using UTF-8 character encoding </li><b>.</b><li>a footnote or endnote
+</li><b>.</b><li>self contained endnote marker &amp; endnote in one </dd>
+
+<dt><b>*.</b> </dt>
+<dd>unnumbered asterisk footnote/endnote,
+insert multiple asterisks if required </dd>
+
+<dt><b>**.</b> </dt>
+<dd>another unnumbered asterisk footnote/endnote
+</dd>
+
+<dt><b>*1.</b> </dt>
+<dd>editors notes, numbered asterisk footnote/endnote series </dd>
+
+<dt><b>+1.</b> </dt>
+<dd>editors
+notes, numbered asterisk footnote/endnote series </li><b>.</b><li>&lt;<a href='http://www.jus.uio.no/sisu/'>http://www.jus.uio.no/sisu/</a>
+&gt;
+</li><b>.</b><li>&lt;<a href='http://www.ruby-lang.org/en/'>http://www.ruby-lang.org/en/</a>
+&gt; </li><b>.</b><li>Table from the Wealth of Networks by Yochai Benkler
+ &lt;<a href='http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler'>http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler</a>
+&gt;<br>
+
+<p> </dd>
+
+<dt>Other versions of this document: </dt>
+<dd></dd>
+
+<dt>manifest: &lt;<a href='http://www.jus.uio.no/sisu/sisu_markup/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_markup/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_markup/sisu_manifest.html</a>
+</a>
+&gt;
+</dt>
+<dd></dd>
+
+<dt>html: &lt;<a href='http://www.jus.uio.no/sisu/sisu_markup/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_markup/toc.html'>http://www.jus.uio.no/sisu/sisu_markup/toc.html</a>
+</a>
+&gt; </dt>
+<dd></dd>
+
+<dt>pdf: &lt;<a href='http://www.jus.uio.no/sisu/sisu_markup/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_markup/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_markup/portrait.pdf</a>
+</a>
+&gt;
+</dt>
+<dd></dd>
+
+<dt>pdf: &lt;<a href='http://www.jus.uio.no/sisu/sisu_markup/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_markup/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_markup/landscape.pdf</a>
+</a>
+&gt; </dt>
+<dd> </dd>
+
+<dt>at: &lt;<a href='http://www.jus.uio.no/sisu'><a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
+</a>
+&gt;
+</dt>
+<dd></dd>
+
+<dt>* Generated by: SiSU 0.58.3 of 2007w36/4 (2007-09-06) </dt>
+<dd></dd>
+
+<dt>* Ruby version: ruby
+1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt>
+<dd></dd>
+
+<dt>* Last Generated on: Sun Sep 23
+01:14:06 +0100 2007 </dt>
+<dd></dd>
+
+<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
+ </dt>
+<dd></dd>
+</dl>
+<p>
+</body>
+</html>