diff options
Diffstat (limited to 'data/doc/sisu/html')
| -rw-r--r-- | data/doc/sisu/html/README | 4 | ||||
| l--------- | data/doc/sisu/html/_sisu | 1 | ||||
| -rw-r--r-- | data/doc/sisu/html/homepage/index.html | 264 | ||||
| l--------- | data/doc/sisu/html/index.html | 1 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu-concordance.1.html | 4 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu-epub.1.html | 4 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu-git.1.html | 2 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu-harvest.1.html | 4 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu-html.1.html | 4 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu-odf.1.html | 4 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu-pdf.1.html | 4 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu-pg.1.html | 4 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu-po.1.html | 73 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu-sqlite.1.html | 4 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu-txt.1.html | 4 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu.1.html | 1509 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu.8.html | 273 | ||||
| l--------- | data/doc/sisu/html/sisu3.1.html | 1 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu_vim.7.html | 101 |
19 files changed, 891 insertions, 1374 deletions
diff --git a/data/doc/sisu/html/README b/data/doc/sisu/html/README index a4263458..c8ebc4ad 100644 --- a/data/doc/sisu/html/README +++ b/data/doc/sisu/html/README @@ -4,7 +4,3 @@ this "html" directory contains SiSU man pages in html man pages are either created by sisu from sisu markup documents contained in the directory "sisu_markup_samples/sisu_manual" or manually crafted - -also see the contents of the directories: -* "sisu_manual" [sisu documentation in various file formats] -* "sisu_markup_samples" [sisu markup examples] diff --git a/data/doc/sisu/html/_sisu b/data/doc/sisu/html/_sisu deleted file mode 120000 index 0e977351..00000000 --- a/data/doc/sisu/html/_sisu +++ /dev/null @@ -1 +0,0 @@ -../sisu_manual/_sisu
\ No newline at end of file diff --git a/data/doc/sisu/html/homepage/index.html b/data/doc/sisu/html/homepage/index.html deleted file mode 100644 index 6c55c9c0..00000000 --- a/data/doc/sisu/html/homepage/index.html +++ /dev/null @@ -1,264 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<title>SiSU information Structuring Universe - Structured -information, Serialized Units - software for electronic texts, -documents, books, digital libraries in plaintext, html, xhtml, XML, -ODF (OpenDocument), LaTeX, pdf, SQL (PostgreSQL and SQLite), and -for search</title> -<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> -<meta name="dc.title" content= -"SiSU information Structuring Universe, Structured information Serialised Units, 2007" /> -<meta name="dc.creator" content="Ralph Amissah" /> -<meta name="dc.subject" content= -"ebook, publishing, pdf, LaTeX, XML, ODF, SQL, postgresql, sqlite, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search, digital library" /> -<meta name="dc.publisher" content= -"SiSU http://www.jus.uio.no/sisu" /> -<meta name="dc.language" content="en" /> -<meta name="dc.rights" content="Copyright Ralph Amissah" /> -<meta name="generator" content="SiSU 0.48.9 of 2007w01/1 (20070101) (n*x and Ruby!)" /> -<link rel="generator" href="http://www.jus.uio.no/sisu/SiSU" /> -<link rel="stylesheet" href="./_sisu/css/html.css" type="text/css" /> -<link rel="shortcut icon" href="./_sisu/image/rb7.ico" /> -</head> -<body> -<div id="top_band"> -<p class="top_band_image"> - <a href="http://www.jus.uio.no/sisu/SiSU" target="_top" > - <img border="0" src="./_sisu/image/sisu.png" alt="SiSU >>"> - </a> -</p> -<h1 class="top_band"> - SiSU information Structuring Universe -</h1> -<h2 class="top_band_tiny"> - Structured information, Serialized Units -</h2> -<h2 class="top_band_tiny"> -software for electronic texts, document collections, books, digital libraries, and search -</h2> -<h2 class="top_band_tiny"> - with "atomic search" and text positioning system (shared text citation numbering: "<i>ocn</i>") -</h2> -<h2 class="top_band_tiny"> -outputs include: plaintext, html, xhtml, XML, ODF (OpenDocument), LaTeX, pdf, SQL (PostgreSQL and SQLite) -</h2> -</div> -<div id="column_left"> -<p class="bold"> - <a href="http://www.jus.uio.no/sisu/SiSU" target="_top" > - SiSU - </a> -</p> -<p class="tiny"> - --- -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/SiSU/1.html#summary" target="_top" > - What does SiSU do? Summary - </a> -</p> -<p class="tiny"> - --- -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/SiSU/2.html" target="_top" > - Book Samples and Markup Examples - </a> -</p> -<p class="tiny"> - --- -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/SiSU/1.html#ocn" target="_top" > - Object Citation Numbering - <i>ocn</i> - </a> -</p> -<p class="tiny">(a text positioning system)</p> -<p class="tiny"> - --- -</p> -<p class="small"> -<p> - <a href="http://www.jus.uio.no/sisu/SiSU/1.html#search" target="_top" > - Search - "<i>Atomic</i>" - </a> -</p> -<p class="tiny"> - Of interest is the ease of streaming documents to a relational database, at an object (roughly paragraph) level and the potential for increased precision in the presentation of matches that results thereby. The ability to serialise html, LaTeX, XML, SQL, (whatever) is also inherent in / incidental to the design. For a description see the - <a href="http://www.jus.uio.no/sisu/sisu_provisional_patent_application_200408" target="_top" > - abandoned U.S. provisional patent application - </a> -</p> -<p class="tiny"> - --- -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/SiSU/download.html" target="_top" > - <b>Download</b> - </a> -</p> -<p class="tiny"> - --- -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/SiSU/changelog.html" target="_top" > - Changelog - </a> -</p> -<p class="tiny"> - --- -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/SiSU/license.html" target="_top" > - License - </a> -</p> -<p class="tiny"> - Gnu / Linux / Unix -</p> -<p class="tiny"> - ============= -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/man" target="_top" > - sisu man pages - </a> -</p> -<p class="tiny"> - --- -</p> -<p class="tiny"> - document preparation can be on any platform, in any editor: - (syntax highlight support currently for: vim, kate, write, gedit, diakonos) -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/syntax_highlight" target="_top" > - Syntax highlighting - </a> -</p> -<p class="tiny"> - ============= -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/SiSU" target="_top" > - * Composite document - </a> -</p> -<p class="tiny"> - the composite document is a superset of the following documents: -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/sisu_description" target="_top" > - SiSU description - </a> -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/sisu_examples" target="_top" > - SiSU examples - </a> -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/sisu_chronology" target="_top" > - SiSU chronology - </a> -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/sisu_technical_info" target="_top" > - SiSU technical - </a> -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/sisu_faq" target="_top" > - SiSU FAQ - </a> -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/sisu_download" target="_top" > - SiSU download - </a> -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/sisu_changelog" target="_top" > - SiSU changelog - </a> -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/sisu_license" target="_top" > - SiSU license - </a> -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/sisu_standard" target="_top" > - SiSU standard - </a> -</p> -<p class="small"> - <a href="http://www.jus.uio.no/sisu/sisu_provisional_patent_application_200408" target="_top" > - SiSU abandoned provisional patent - </a> -</p> -<p class="tiny"> - Note: the placement of SiSU documents on the Net predate the release of SiSU. -</p> -</div> -<div id="column_center"> -<p class="bold"> - For less markup than the most elementary HTML you can have so much more. -</p> -<p><a href="http://www.jus.uio.no/sisu/SiSU" target="_top" ><b>SiSU</b> - Structured information, Serialized Units</a> for Electronic Documents, is an information structuring, transforming and publishing framework with the following features:</p> -<p><b>(i)</b> markup syntax: (a) simpler than html, (b) mnemonic, influenced by mail/messaging/wiki markup practices, (c) human readable, and easily writable,</p> -<p><b>(ii)</b> (a) minimal markup requirement, (b) single file marked up for multiple outputs,</p> -<p><b>(iii)</b> (a) multiple outputs include amongst others: html; pdf via LaTeX; (structured) XML; ODF (OpenDocument); sql - currently PostgreSQL (and SQLite); ascii, (also texinfo), (b) takes advantage of the strengths implicit in these very different output types, (e.g. pdfs produced using typsetting of LaTeX, databases populated with documents at an individual object/paragraph level, with implications for search possibilities...)</p> -<p><b>(iv)</b> provides a common object positioning and citation system for all outputs, which is human relevant and machine usable: <u><i>object citation numbering</i></u>, all objects (paragraphs, headings, verse, tables etc. and images) are numbered identically, for citation purposes, in all outputs (html, pdf, sql etc.),</p> -<p><b>(v)</b> use of Dublin Core and other meta-tags to permit the addition of some semantic information on documents, and making easy integration of rdf/rss feeds etc.,</p> -<p><b>(vi)</b> creates organised directory/file structure for (file-system) output, easily mapped with its clearly defined structure, with all text objects numbered, you know in advance where in each document output type, a bit of text will be found (eg. from an sql search, you know where to go to find the prepared html output or pdf etc.)... there is more; easy directory management and document associations, the document preparation (sub-)directory may be used to determine output (sub-)directory, the skin used, and the sql database used,</p> -<p><b>(vii)</b> search of document sets, at object/paragraph level, the relational database retains information on the document structure, and citation numbering makes it possible for example to present search matches as an index of documents and locations within the document where the match is found,</p> -<p><b>(viii)</b> "Concordance file" wordmap, consisting of all the words in a document and their (text/ object) locations within the text, (and the possibility of adding vocabularies),</p> -<p><b>(ix)</b> document content certification and comparison considerations: (a) the document and each object within it stamped with an md5 hash making it possible to easily check or guarantee that the substantive content of a document is unchanged, (b) version control, documents integrated with time based source control system, default RCS or CVS with use of $Id$ tag, which SiSU checks -<p><b>(x)</b> SiSU's minimalist markup makes for meaningful "diffing" of the substantive content of markup-files,</p> -<p><b>(xi)</b> easily skinnable, document appearance on a project/site wide, directory wide, or document instance level easily controlled/changed,</p> -<p><b>(xii)</b> in many cases a regular expression may be used (once in the document header) to define all or part of a documents structure obviating or reducing the need to provide structural markup within the document,</p> -<p><b>(xiii)</b> is a batch processor for handling large document sets, ... though once generated they need not be re-generated, unless changes are made to the desired presentation of a particular output type,</p> -<p><b>(xiv)</b> possible to pre-process, which permits: the easy creation of standard form documents, and templates/term-sheets, or; building of composite documents (master documents) from other sisu marked up documents, or marked up parts, i.e. import documents or parts of text into a main document should this be desired</p> -<p><b>(xv)</b> future proofing, a framework for adding further capability or updating existing capability as required: (a) modular, (thanks in no small part to Ruby) another output format required, write another module....(b) easy to update output formats (eg html, xhtml, latex/pdf produced can be updated in program and run against whole document set), (c) easy to add, modify, or have alternative syntax rules for input, should you need to,</p> -<p><b>(xvi)</b> scalability, dependent on your file-system (in my case Reiserfs) and on the relational database used (currently Postgresql and SQLite), and your hardware,</p> -<p><b>(xvii)</b> only marked up files need be backed up, to secure the larger document set produced,</p> -<p><b>(xviii)</b> document management,</p> -<p><b>(xix)</b> use your favourite editor, syntax highlighting files for markup, primarily (g)vim so far,</p> -<p><b>(xx)</b> remote operations: (a) run SiSU on a remote server, (having prepared sisu markup documents locally or on that server, i.e. this solution where sisu is installed on the remote server, would work whatever type of machine you chose to prepare your markup documents on), (b) alternatively, (assuming sisu is available to you locally but not installed on the remote server) configure sisu to securely copy (scp) its output to your remote host and run sisu locally, (c) request a remotely located sisu markup file and process it locally by identifying it by its' url.</p> -<br /> -<p class="small"> -More information on <a href="http://www.jus.uio.no/sisu/SiSU/"><b>SiSU</b></a> provided at <a href="http://www.jus.uio.no/sisu/SiSU/">www.jus.uio.no/sisu/SiSU</a></p> -</div> -<div id="column_right"> -<p class="small"> - More information on <a href="http://www.jus.uio.no/sisu/SiSU/"><b>SiSU</b></a> provided at: - <a href="http://www.jus.uio.no/sisu/SiSU/"> - www.jus.uio.no/sisu/SiSU - </a> -<p class="tiny"> -SiSU was developed in relation to legal documents, and is strong across a wide variety of texts (law, literature...(humanities, law and part of the social sciences)). SiSU handles images but is not suitable for formulae/ statistics, or for technical writing at this time.</p> -<p class="tiny"> -SiSU has been developed and has been in use for several years. Requirements to cover a wide range of documents within its use domain have been explored.</p> -<p class="tiny"> -Some modules are more mature than others, the most mature being Html and LaTeX / pdf. PostgreSQL and search functions are useable and together with <i>ocn</i> unique (to the best of my knowledge). The XML output document set is "well formed" but largely proof of concept, as is the OpenDocument output which is a limited SiSU feature set (SiSU is interested in a very limited ODF feature set).</p> -<p class="small"> -<a href="mailto://ralph@amissah.com"> -ralph@amissah.com -</a> -</p> -<p class="small"> -<a href="mailto://ralph.amissah@gmail.com"> -ralph.amissah@gmail.com -</a> -</p> -<p class="small"> -2007 -</p> -<p class="tiny"> -w3 since October 3 1993 -</p> -</div> -</body> -</html> diff --git a/data/doc/sisu/html/index.html b/data/doc/sisu/html/index.html deleted file mode 120000 index c6513ea0..00000000 --- a/data/doc/sisu/html/index.html +++ /dev/null @@ -1 +0,0 @@ -../sisu_manual/index.html
\ No newline at end of file diff --git a/data/doc/sisu/html/sisu-concordance.1.html b/data/doc/sisu/html/sisu-concordance.1.html index 0c1f5622..f1ca71bb 100644 --- a/data/doc/sisu/html/sisu-concordance.1.html +++ b/data/doc/sisu/html/sisu-concordance.1.html @@ -30,6 +30,8 @@ for <b>sisu --concordance</b> (or <b>sisu -w</b>) which produces an HTML concord , <br> <a href='http:~/bin/man2html?sisu-epub:1'><i>sisu-epub</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-git:1'><i>sisu-git</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-harvest:1'><i>sisu-harvest</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-html:1'><i>sisu-html</i>(1)</a> @@ -40,6 +42,8 @@ for <b>sisu --concordance</b> (or <b>sisu -w</b>) which produces an HTML concord , <br> <a href='http:~/bin/man2html?sisu-pg:1'><i>sisu-pg</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-po:1'><i>sisu-po</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-sqlite:1'><i>sisu-sqlite</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-txt:1'><i>sisu-txt</i>(1)</a> diff --git a/data/doc/sisu/html/sisu-epub.1.html b/data/doc/sisu/html/sisu-epub.1.html index f3722477..747756ac 100644 --- a/data/doc/sisu/html/sisu-epub.1.html +++ b/data/doc/sisu/html/sisu-epub.1.html @@ -30,6 +30,8 @@ The <b>sisu-epub</b> command is an alias for , <br> <a href='http:~/bin/man2html?sisu-concordance:1'><i>sisu-concordance</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-git:1'><i>sisu-git</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-harvest:1'><i>sisu-harvest</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-html:1'><i>sisu-html</i>(1)</a> @@ -40,6 +42,8 @@ The <b>sisu-epub</b> command is an alias for , <br> <a href='http:~/bin/man2html?sisu-pg:1'><i>sisu-pg</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-po:1'><i>sisu-po</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-sqlite:1'><i>sisu-sqlite</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-txt:1'><i>sisu-txt</i>(1)</a> diff --git a/data/doc/sisu/html/sisu-git.1.html b/data/doc/sisu/html/sisu-git.1.html index 8df25642..6c70396f 100644 --- a/data/doc/sisu/html/sisu-git.1.html +++ b/data/doc/sisu/html/sisu-git.1.html @@ -40,6 +40,8 @@ document and associated parts (images, ). , <br> <a href='http:~/bin/man2html?sisu-pg:1'><i>sisu-pg</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-po:1'><i>sisu-po</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-sqlite:1'><i>sisu-sqlite</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-txt:1'><i>sisu-txt</i>(1)</a> diff --git a/data/doc/sisu/html/sisu-harvest.1.html b/data/doc/sisu/html/sisu-harvest.1.html index 8a542a94..410c805f 100644 --- a/data/doc/sisu/html/sisu-harvest.1.html +++ b/data/doc/sisu/html/sisu-harvest.1.html @@ -34,6 +34,8 @@ Also</a></h2> , <br> <a href='http:~/bin/man2html?sisu-epub:1'><i>sisu-epub</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-git:1'><i>sisu-git</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-html:1'><i>sisu-html</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-pdf:1'><i>sisu-pdf</i>(1)</a> @@ -42,6 +44,8 @@ Also</a></h2> , <br> <a href='http:~/bin/man2html?sisu-pg:1'><i>sisu-pg</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-po:1'><i>sisu-po</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-sqlite:1'><i>sisu-sqlite</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-txt:1'><i>sisu-txt</i>(1)</a> diff --git a/data/doc/sisu/html/sisu-html.1.html b/data/doc/sisu/html/sisu-html.1.html index 99fd959f..2672f615 100644 --- a/data/doc/sisu/html/sisu-html.1.html +++ b/data/doc/sisu/html/sisu-html.1.html @@ -32,6 +32,8 @@ The <b>sisu-html</b> command is an alias for , <br> <a href='http:~/bin/man2html?sisu-epub:1'><i>sisu-epub</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-git:1'><i>sisu-git</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-harvest:1'><i>sisu-harvest</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-pdf:1'><i>sisu-pdf</i>(1)</a> @@ -40,6 +42,8 @@ The <b>sisu-html</b> command is an alias for , <br> <a href='http:~/bin/man2html?sisu-pg:1'><i>sisu-pg</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-po:1'><i>sisu-po</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-sqlite:1'><i>sisu-sqlite</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-txt:1'><i>sisu-txt</i>(1)</a> diff --git a/data/doc/sisu/html/sisu-odf.1.html b/data/doc/sisu/html/sisu-odf.1.html index ae929917..ef3110f8 100644 --- a/data/doc/sisu/html/sisu-odf.1.html +++ b/data/doc/sisu/html/sisu-odf.1.html @@ -32,6 +32,8 @@ file. , <br> <a href='http:~/bin/man2html?sisu-epub:1'><i>sisu-epub</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-git:1'><i>sisu-git</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-harvest:1'><i>sisu-harvest</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-html:1'><i>sisu-html</i>(1)</a> @@ -40,6 +42,8 @@ file. , <br> <a href='http:~/bin/man2html?sisu-pg:1'><i>sisu-pg</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-po:1'><i>sisu-po</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-sqlite:1'><i>sisu-sqlite</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-txt:1'><i>sisu-txt</i>(1)</a> diff --git a/data/doc/sisu/html/sisu-pdf.1.html b/data/doc/sisu/html/sisu-pdf.1.html index 685e0a68..bb34a771 100644 --- a/data/doc/sisu/html/sisu-pdf.1.html +++ b/data/doc/sisu/html/sisu-pdf.1.html @@ -32,6 +32,8 @@ Also</a></h2> , <br> <a href='http:~/bin/man2html?sisu-epub:1'><i>sisu-epub</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-git:1'><i>sisu-git</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-harvest:1'><i>sisu-harvest</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-html:1'><i>sisu-html</i>(1)</a> @@ -40,6 +42,8 @@ Also</a></h2> , <br> <a href='http:~/bin/man2html?sisu-pg:1'><i>sisu-pg</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-po:1'><i>sisu-po</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-sqlite:1'><i>sisu-sqlite</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-txt:1'><i>sisu-txt</i>(1)</a> diff --git a/data/doc/sisu/html/sisu-pg.1.html b/data/doc/sisu/html/sisu-pg.1.html index c87ae7a7..fec48e39 100644 --- a/data/doc/sisu/html/sisu-pg.1.html +++ b/data/doc/sisu/html/sisu-pg.1.html @@ -32,12 +32,16 @@ The <b>sisu-pq</b> command is an alias for <b>sisu , <br> <a href='http:~/bin/man2html?sisu-epub:1'><i>sisu-epub</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-git:1'><i>sisu-git</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-harvest:1'><i>sisu-harvest</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-html:1'><i>sisu-html</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-pdf:1'><i>sisu-pdf</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-po:1'><i>sisu-po</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-odf:1'><i>sisu-odf</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-sqlite:1'><i>sisu-sqlite</i>(1)</a> diff --git a/data/doc/sisu/html/sisu-po.1.html b/data/doc/sisu/html/sisu-po.1.html new file mode 100644 index 00000000..681cda4c --- /dev/null +++ b/data/doc/sisu/html/sisu-po.1.html @@ -0,0 +1,73 @@ +<!-- manual page source format generated by PolyglotMan v3.2, --> +<!-- available at http://polyglotman.sourceforge.net/ --> + +<html> +<head> +<title>SISU\-ODF(1) manual page</title> +</head> +<body bgcolor='white'> +<a href='#toc'>Table of Contents</a><p> + +<p> +<h2><a name='sect0' href='#toc0'>Name</a></h2> +<b>SiSU</b> - Structured information, Serialized Units - a document publishing + +<p>system +<p> +<h2><a name='sect1' href='#toc1'>Synopsis</a></h2> +<b>sisu-odf</b> <i>sisu_document.sst</i> | <i>sisu_document.ssm</i> +<p> +<h2><a name='sect2' href='#toc2'>Description</a></h2> +<b>SiSU</b> +is a lightweight markup based document structuring, publishing and search +framework for document collections. <p> +The <b>sisu-po</b> command is an alias for <b>sisu +--po4a</b> (or <b>sisu -o</b>) which provided two sisu markup files of the same document +in different languages produces .pot and .po output of a SiSU markup file. +Experimental, and under development. +<p> +<h2><a name='sect3' href='#toc3'>See Also</a></h2> +<a href='http:~/bin/man2html?sisu:1'><i>sisu</i>(1)</a> +, <br> +<a href='http:~/bin/man2html?sisu-concordance:1'><i>sisu-concordance</i>(1)</a> +, <br> +<a href='http:~/bin/man2html?sisu-epub:1'><i>sisu-epub</i>(1)</a> +, <br> +<a href='http:~/bin/man2html?sisu-git:1'><i>sisu-git</i>(1)</a> +, <br> +<a href='http:~/bin/man2html?sisu-harvest:1'><i>sisu-harvest</i>(1)</a> +, <br> +<a href='http:~/bin/man2html?sisu-html:1'><i>sisu-html</i>(1)</a> +, <br> +<a href='http:~/bin/man2html?sisu-odf:1'><i>sisu-odf</i>(1)</a> +, <br> +<a href='http:~/bin/man2html?sisu-pdf:1'><i>sisu-pdf</i>(1)</a> +, <br> +<a href='http:~/bin/man2html?sisu-pg:1'><i>sisu-pg</i>(1)</a> +, <br> +<a href='http:~/bin/man2html?sisu-sqlite:1'><i>sisu-sqlite</i>(1)</a> +, <br> +<a href='http:~/bin/man2html?sisu-txt:1'><i>sisu-txt</i>(1)</a> +. +<p> +<h2><a name='sect4' href='#toc4'>Homepage</a></h2> +More information about <b>SiSU</b> can be found at <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> +>. + +<p> +<h2><a name='sect5' href='#toc5'>Author</a></h2> +<b>SiSU</b> was written by Ralph Amissah <<i>ralph@amissah.com</i>>. +<p> <p> + +<hr><p> +<a name='toc'><b>Table of Contents</b></a><p> +<ul> +<li><a name='toc0' href='#sect0'>Name</a></li> +<li><a name='toc1' href='#sect1'>Synopsis</a></li> +<li><a name='toc2' href='#sect2'>Description</a></li> +<li><a name='toc3' href='#sect3'>See Also</a></li> +<li><a name='toc4' href='#sect4'>Homepage</a></li> +<li><a name='toc5' href='#sect5'>Author</a></li> +</ul> +</body> +</html> diff --git a/data/doc/sisu/html/sisu-sqlite.1.html b/data/doc/sisu/html/sisu-sqlite.1.html index ab0997e8..7a09c353 100644 --- a/data/doc/sisu/html/sisu-sqlite.1.html +++ b/data/doc/sisu/html/sisu-sqlite.1.html @@ -32,6 +32,8 @@ The <b>sisu-sqlite</b> command is an alias for , <br> <a href='http:~/bin/man2html?sisu-epub:1'><i>sisu-epub</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-git:1'><i>sisu-git</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-harvest:1'><i>sisu-harvest</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-html:1'><i>sisu-html</i>(1)</a> @@ -42,6 +44,8 @@ The <b>sisu-sqlite</b> command is an alias for , <br> <a href='http:~/bin/man2html?sisu-pg:1'><i>sisu-pg</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-po:1'><i>sisu-po</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-txt:1'><i>sisu-txt</i>(1)</a> . <p> diff --git a/data/doc/sisu/html/sisu-txt.1.html b/data/doc/sisu/html/sisu-txt.1.html index 2479cd8e..3edb168f 100644 --- a/data/doc/sisu/html/sisu-txt.1.html +++ b/data/doc/sisu/html/sisu-txt.1.html @@ -32,6 +32,8 @@ file. , <br> <a href='http:~/bin/man2html?sisu-epub:1'><i>sisu-epub</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-git:1'><i>sisu-git</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-harvest:1'><i>sisu-harvest</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-html:1'><i>sisu-html</i>(1)</a> @@ -42,6 +44,8 @@ file. , <br> <a href='http:~/bin/man2html?sisu-pg:1'><i>sisu-pg</i>(1)</a> , <br> +<a href='http:~/bin/man2html?sisu-po:1'><i>sisu-po</i>(1)</a> +, <br> <a href='http:~/bin/man2html?sisu-sqlite:1'><i>sisu-sqlite</i>(1)</a> . <p> diff --git a/data/doc/sisu/html/sisu.1.html b/data/doc/sisu/html/sisu.1.html index 67867294..1a598784 100644 --- a/data/doc/sisu/html/sisu.1.html +++ b/data/doc/sisu/html/sisu.1.html @@ -18,20 +18,20 @@ sisu [-abcDdFehIiMmNnopqRrSsTtUuVvwXxYyZz0-9] <p> sisu [-CcFLSVvW] <p> sisu --v2 [operations] -<p> sisu --v1 [operations] SISU - MANUAL, -RALPH AMISSAH +<p> sisu --v3 [operations] +<p> sisu3 [operations] +SISU - MANUAL, RALPH AMISSAH <p> WHAT IS SISU? <p> 1. INTRODUCTION - WHAT IS SISU? -<p> <b>SiSU</b> is -a framework for document structuring, publishing (in multiple open standard -formats) and search, comprising of: (a) a lightweight document structure -and presentation markup syntax; and (b) an accompanying engine for generating -standard document format outputs from documents prepared in sisu markup -syntax, which is able to produce multiple standard outputs (including the -population of sql databases) that (can) share a common numbering system -for the citation of text within a document. -<p> <b>SiSU</b> is developed under an -open source, software libre license (GPL3). Its use case for development +<p> <b>SiSU</b> is a framework for document structuring, publishing (in multiple +open standard formats) and search, comprising of: (a) a lightweight document +structure and presentation markup syntax; and (b) an accompanying engine +for generating standard document format outputs from documents prepared +in sisu markup syntax, which is able to produce multiple standard outputs +(including the population of sql databases) that (can) share a common numbering +system for the citation of text within a document. +<p> <b>SiSU</b> is developed under +an open source, software libre license (GPL3). Its use case for development is work with medium to large document sets and cope with evolving document formats/ representation technologies. Documents are prepared once, and generated as need be to update the technical presentation or add additional output @@ -128,158 +128,159 @@ system to reliably reference its documents. <b>SiSU</b> works well in a compleme manner with such collaborative technologies as Wikis, which can take advantage of and be used to discuss the substance of content prepared in <b>SiSU</b> <p> -<<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> +<<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> +> +<p> <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> > <p> 2. COMMANDS SUMMARY -<p> 2.1 DESCRIPTION -<p> <b>SiSU</b> <b>SiSU</b> -is a document publishing system, that from a simple single marked-up document, -produces multiple of output formats including: plaintext, html, xhtml, -XML, epub, odt (odf text), LaTeX, pdf, info, and SQL (PostgreSQL and SQLite), -which share numbered text objects ("object citation numbering") and the -same document structure information. For more see: <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> +<p> 2.1 + +<p>DESCRIPTION +<p> <b>SiSU</b> <b>SiSU</b> is a document publishing system, that from a simple +single marked-up document, produces multiple of output formats including: +plaintext, html, xhtml, XML, epub, odt (odf text), LaTeX, pdf, info, and +SQL (PostgreSQL and SQLite), which share numbered text objects ("object +citation numbering") and the same document structure information. For more +see: <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> > - <p> 2.2 DOCUMENT PROCESSING COMMAND FLAGS <p> <dl> -<dt><b>-a [filename/wildcard]</b> </dt> -<dd>produces plaintext -with Unix linefeeds and without markup, (object numbers are omitted), has -footnotes at end of each paragraph that contains them [ -A for equivalent - dos (linefeed) output file] [see -e for (Options include: --endnotes for endnotes ---footnotes for footnotes at the end of each paragraph --unix for unix linefeed -(default) --msdos for msdos linefeed) +<dt><b>-a [filename/wildcard]</b> +</dt> +<dd>produces plaintext with Unix linefeeds and without markup, (object numbers +are omitted), has footnotes at end of each paragraph that contains them +[ -A for equivalent dos (linefeed) output file] [see -e for -A endnotes]. (Options +include: --endnotes for endnotes --footnotes for footnotes at the end of each +paragraph --unix for unix linefeed (default) --msdos for msdos linefeed) <p> </dd> -<dt><b>-b [filename/wildcard]</b> </dt> +<dt><b>-b +[filename/wildcard]</b> </dt> <dd>see --xhtml <p> </dd> -<dt><b>--color-toggle -[filename/wildcard]</b> </dt> -<dd>screen toggle ansi screen colour on or off depending -on default set (unless -c flag is used: if sisurc colour default is set -to ’true’, output to screen will be with colour, if sisurc colour default -is set to ’false’ or is undefined screen output will be without colour). Alias +<dt><b>--color-toggle [filename/wildcard]</b> </dt> +<dd>screen toggle +ansi screen colour on or off depending on default set (unless -c flag is +used: if sisurc colour default is set to ’true’, output to screen will be +with colour, if sisurc colour default is set to ’false’ or is undefined screen +output will be without colour). Alias -c +<p> </dd> -<p>- -<p>c +<dt><b>--concordance [filename/wildcard]</b> +</dt> +<dd>produces concordance (wordmap) a rudimentary index of all the words in +a document. (Concordance files are not generated for documents of over 260,000 +words unless this limit is increased in the file sisurc.yml). Alias -w <p> </dd> -<dt><b>--concordance [filename/wildcard]</b> </dt> -<dd>produces concordance (wordmap) a rudimentary -index of all the words in a document. (Concordance files are not generated -for documents of over 260,000 words unless this limit is increased in the -file sisurc.yml). Alias -w +<dt><b>-C +[--init-site]</b> </dt> +<dd>configure/initialise shared output directory files initialize +shared output directory (config files such as css and dtd files are not +updated if they already exist unless modifier is used). -C --init-site configure/initialise +site more extensive than -C on its own, shared output directory files/force +update, existing shared output config files such as css and dtd files are +updated if this modifier is used. <p> </dd> -<dt><b>-C [--init-site]</b> </dt> +<dt><b>-CC</b> </dt> <dd>configure/initialise shared output directory files initialize shared output directory (config files such as css and dtd files are not updated if they already exist unless modifier -is used). -C --init-site configure/initialise site more extensive than -C on -its own, shared output directory files/force update, existing shared output -config files such as css and dtd files are updated if this modifier is -used. +is used). The equivalent of: -C --init-site configure/initialise site, more +extensive than -C on its own, shared output directory files/force update, +existing shared output config files such as css and dtd files are updated +if -CC is used. <p> </dd> -<dt><b>-CC</b> </dt> -<dd>configure/initialise shared output directory files initialize -shared output directory (config files such as css and dtd files are not -updated if they already exist unless modifier is used). The equivalent of: --C --init-site configure/initialise site, more extensive than -C on its own, -shared output directory files/force update, existing shared output config -files such as css and dtd files are updated if -CC is used. +<dt><b>-c [filename/wildcard]</b> </dt> +<dd>see --color-toggle <p> </dd> -<dt><b>-c [filename/wildcard]</b> +<dt><b>--dal [filename/wildcard/url]</b> </dt> -<dd> -<p>see --color-toggle +<dd>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. + +<p>Alias -m <p> </dd> -<dt><b>--dal [filename/wildcard/url]</b> </dt> -<dd>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. Alias -m +<dt><b>--delete [filename/wildcard]</b> </dt> +<dd>see --zap <p> </dd> -<dt><b>--delete [filename/wildcard]</b> +<dt><b>-D [instruction] [filename]</b> </dt> <dd> -<p>see --zap +<p>see --pg <p> </dd> -<dt><b>-D [instruction] [filename]</b> </dt> -<dd>see --pg -<p> </dd> - -<dt><b>-d [--db-[database type (sqlite|pg)]] ---[instruction] [filename]</b> </dt> +<dt><b>-d [--db-[database type (sqlite|pg)]] --[instruction] [filename]</b> </dt> <dd>see --sqlite + <p> </dd> <dt><b>--epub [filename/wildcard]</b> </dt> -<dd>produces -an epub document, [sisu version 2 only] (filename.epub). Alias -e +<dd>produces an epub document, [sisu version 2 only] +(filename.epub). Alias -e +<p> </dd> + +<dt><b>-e [filename/wildcard]</b> </dt> +<dd>see --epub <p> </dd> -<dt><b>-e [filename/wildcard]</b> +<dt><b>-F [--webserv=webrick]</b> </dt> <dd> -<p>see --epub +<p>see --sample-search-form <p> </dd> -<dt><b>-F [--webserv=webrick]</b> </dt> -<dd>see --sample-search-form -<p> </dd> +<dt><b>--git [filename/wildcard]</b> </dt> +<dd>produces or updates markup +source file structure in a git repo (experimental and subject to change). -<dt><b>--git [filename/wildcard]</b> -</dt> -<dd>produces or updates markup source file structure in a git repo (experimental -and subject to change). Alias -g +<p>Alias -g <p> </dd> <dt><b>-g [filename/wildcard]</b> </dt> <dd>see --git <p> </dd> -<dt><b>--harvest -*.ss[tm]</b> </dt> -<dd>makes two lists of sisu output based on the sisu markup documents -in a directory: list of author and authors works (year and titles), and; -list by topic with titles and author. Makes use of header metadata fields -(author, title, date, topic_register). Can be used with maintenance (-M) -and remote placement (-R) flags. +<dt><b>--harvest *.ss[tm]</b> </dt> +<dd>makes two lists +of sisu output based on the sisu markup documents in a directory: list +of author and authors works (year and titles), and; list by topic with +titles and author. Makes use of header metadata fields (author, title, date, +topic_register). Can be used with maintenance (-M) and remote placement (-R) +flags. <p> </dd> <dt><b>--help [topic]</b> </dt> -<dd>provides help on the selected -topic, where topics (keywords) include: list, (com)mands, short(cuts), -(mod)ifiers, (env)ironment, markup, syntax, headers, headings, endnotes, -tables, example, customise, skin, (dir)ectories, path, (lang)uage, db, -install, setup, (conf)igure, convert, termsheet, search, sql, features, - -<p>license +<dd>provides help on the selected topic, where topics (keywords) +include: list, (com)mands, short(cuts), (mod)ifiers, (env)ironment, markup, +syntax, headers, headings, endnotes, tables, example, customise, skin, +(dir)ectories, path, (lang)uage, db, install, setup, (conf)igure, convert, +termsheet, search, sql, features, license <p> </dd> <dt><b>--html [filename/wildcard]</b> </dt> -<dd>produces html output, segmented text -with table of contents (toc.html and index.html) and the document in a single -file (scroll.html). Alias -h -<p> </dd> - -<dt><b>-h [filename/wildcard]</b> </dt> -<dd>see --html +<dd>produces +html output, segmented text with table of contents (toc.html and index.html) +and the document in a single file (scroll.html). Alias -h <p> </dd> -<dt><b>-I [filename/wildcard]</b> +<dt><b>-h [filename/wildcard]</b> </dt> <dd> -<p>see --texinfo +<p>see --html +<p> </dd> + +<dt><b>-I [filename/wildcard]</b> </dt> +<dd>see --texinfo <p> </dd> <dt><b>-i [filename/wildcard]</b> </dt> @@ -288,83 +289,102 @@ file (scroll.html). Alias -h <dt><b>-L</b> </dt> <dd>prints license information. - <p> </dd> -<dt><b>--machine [filename/wildcard/url]</b> </dt> +<dt><b>--machine [filename/wildcard/url]</b> +</dt> <dd>see --dal (document abstraction level/layer) - <p> </dd> -<dt><b>--maintenance [filename/wildcard/url]</b> </dt> -<dd>maintenance mode files created for -processing preserved and their locations indicated. (also see -V). Alias -M - +<dt><b>--maintenance [filename/wildcard/url]</b> +</dt> +<dd>maintenance mode files created for processing preserved and their locations +indicated. (also see -V). Alias -M <p> </dd> <dt><b>--manpage [filename/wildcard]</b> </dt> -<dd>produces man page of file, not suitable for -all outputs. Alias -i +<dd>produces man +page of file, not suitable for all outputs. Alias -i <p> </dd> -<dt><b>-M [filename/wildcard/url]</b> </dt> -<dd>see --maintenance +<dt><b>-M [filename/wildcard/url]</b> +</dt> +<dd> +<p>see --maintenance <p> </dd> -<dt><b>-m [filename/wildcard/url]</b> -</dt> -<dd>see --dal (document abstraction level/layer) +<dt><b>-m [filename/wildcard/url]</b> </dt> +<dd>see --dal (document abstraction +level/layer) <p> </dd> <dt><b>--no-ocn</b> </dt> -<dd>[with --html --pdf or --epub] -switches off object citation numbering. Produce output without identifying -numbers in margins of html or LaTeX/pdf output. +<dd>[with --html --pdf or --epub] switches off object citation +numbering. Produce output without identifying numbers in margins of html +or LaTeX/pdf output. <p> </dd> -<dt><b>-N [filename/wildcard/url]</b> -</dt> -<dd>document digest or document content certificate ( DCC ) as md5 digest tree -of the document: the digest for the document, and digests for each object -contained within the document (together with information on software versions -that produced it) (digest.txt). -NV for verbose digest output to screen. +<dt><b>-N [filename/wildcard/url]</b> </dt> +<dd>document digest or document +content certificate ( DCC ) as md5 digest tree of the document: the digest +for the document, and digests for each object contained within the document +(together with information on software versions that produced it) (digest.txt). +-NV for verbose digest output to screen. <p> </dd> -<dt><b>-n -[filename/wildcard/url]</b> </dt> -<dd>skip the creation of intermediate processing files -(document abstraction) if they already exist, this skips the equivalent -of -m which is otherwise assumed by most processing flags. +<dt><b>-n [filename/wildcard/url]</b> </dt> +<dd>skip +the creation of intermediate processing files (document abstraction) if +they already exist, this skips the equivalent of -m which is otherwise assumed +by most processing flags. <p> </dd> -<dt><b>--odf [filename/wildcard/url]</b> -</dt> -<dd> -<p>see --odt +<dt><b>--odf [filename/wildcard/url]</b> </dt> +<dd>see --odt <p> </dd> -<dt><b>--odt [filename/wildcard/url]</b> </dt> -<dd>output basic document in opendocument -file format (opendocument.odt). Alias -o +<dt><b>--odt [filename/wildcard/url]</b> +</dt> +<dd>output basic document in opendocument file format (opendocument.odt). Alias + +<p>- +<p>o <p> </dd> <dt><b>-o [filename/wildcard/url]</b> </dt> <dd>see --odt - <p> </dd> <dt><b>--pdf [filename/wildcard]</b> </dt> -<dd>produces LaTeX pdf (portrait.pdf & landscape.pdf). -Default paper size is set in config file, or document header, or provided -with additional command line parameter, e.g. --papersize-a4 preset sizes include: -’A4’, U.S. ’letter’ and +<dd>produces +LaTeX pdf (portrait.pdf & landscape.pdf). Default paper size is set in config +file, or document header, or provided with additional command line parameter, +e.g. --papersize-a4 preset sizes include: ’A4’, U.S. ’letter’ and +<p> </dd> + +<dt><b>--pg [instruction] +[filename]</b> </dt> +<dd>database postgresql ( --pgsql may be used instead) possible instructions, +include: --createdb; --create; --dropall; --import [filename]; --update [filename]; +--remove [filename]; see database section below. Alias -D <p> </dd> -<dt><b>--pg [instruction] [filename]</b> </dt> -<dd>database postgresql ( --pgsql -may be used instead) possible instructions, include: --createdb; --create; ---dropall; --import [filename]; --update [filename]; --remove [filename]; see database -section below. Alias -D +<dt><b>--po [language_directory/filename + language_directory]</b> </dt> +<dd>see --po4a +<p> </dd> + +<dt><b>--po4a [language_directory/filename language_directory]</b> +</dt> +<dd>produces .pot and po files for the file in the languages specified by the +language directory. <b>SiSU</b> markup is placed in subdirectories named with the +language code, e.g. en/ fr/ es/. The sisu config file must set the output +directory structure to multilingual. v3, experimental +<p> </dd> + +<dt><b>-P [language_directory/filename + language_directory]</b> </dt> +<dd>see --po4a <p> </dd> <dt><b>-p [filename/wildcard]</b> </dt> @@ -438,8 +458,8 @@ below. Alias -d files including sisu markup source files and the directories local configuration file, images and skins. Note: this only includes the configuration files or skins contained in ./_sisu not those in ~/.sisu -S [filename/wildcard] -option. Note: (this<br> - option is tested only with zsh). Alias -S +option. Note: (this option<br> + is tested only with zsh). Alias -S <p> </dd> <dt><b>--sisupod [filename/wildcard]</b> </dt> @@ -490,47 +510,43 @@ file to output directory. Alias -s </dt> <dd>produces plaintext with Unix linefeeds and without markup, (object numbers are omitted), has footnotes at end of each paragraph that contains them -[ -A for equivalent dos (linefeed) output file] [see -e for (Options include: ---endnotes for endnotes --footnotes for footnotes at the end of each paragraph ---unix for unix linefeed (default) --msdos for msdos linefeed). Alias -t +[ -A for equivalent dos (linefeed) output file] [see -e for -A endnotes]. (Options +include: --endnotes for endnotes --footnotes for footnotes at the end of each +paragraph --unix for unix linefeed (default) --msdos for msdos linefeed). Alias + +<p>- +<p>t <p> </dd> -<dt><b>-T [filename/wildcard - (*.termsheet.rb)]</b> </dt> -<dd>standard form document builder, preprocessing feature -<p> -</dd> +<dt><b>-T [filename/wildcard (*.termsheet.rb)]</b> </dt> +<dd>standard form document builder, + +<p>preprocessing feature +<p> </dd> <dt><b>-t [filename/wildcard]</b> </dt> <dd>see --txt <p> </dd> -<dt><b>--urls [filename/wildcard]</b> </dt> -<dd>prints url output -list/map for the available processing flags options and resulting files -that could be requested, (can be used to get a list of processing options -in relation to a file, together with information on the output that would -be produced), -u provides url output mapping for those flags requested for -processing. The default assumes sisu_webrick is running and provides webrick -url mappings where appropriate, but these can be switched to file system -paths in sisurc.yml. Alias -U +<dt><b>--urls [filename/wildcard]</b> +</dt> +<dd>prints url output list/map for the available processing flags options and +resulting files that could be requested, (can be used to get a list of +processing options in relation to a file, together with information on +the output that would be produced), -u provides url output mapping for those +flags requested for processing. The default assumes sisu_webrick is running +and provides webrick url mappings where appropriate, but these can be switched +to file system paths in sisurc.yml. Alias -U <p> </dd> <dt><b>-U [filename/wildcard]</b> </dt> <dd>see --urls -<p> </dd> - -<dt><b>-u [filename/wildcard]</b> -</dt> -<dd>provides url mapping of output files for the flags requested for processing, -<p>also see -U <p> </dd> -<dt><b>--v1 [filename/wildcard]</b> </dt> -<dd>invokes the sisu v1 document parser/generator. -For use with sisu v1 markup documents. (Markup conversion to v2 involves -the modification of document headers) +<dt><b>-u [filename/wildcard]</b> </dt> +<dd>provides url mapping of output files for the flags +requested for processing, also see -U <p> </dd> <dt><b>--v2 [filename/wildcard]</b> </dt> @@ -539,75 +555,79 @@ sisu v2 document parser/generator. This is the default and is normally omitted. <p> </dd> -<dt><b>--verbose [filename/wildcard]</b> </dt> -<dd>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. +<dt><b>--v3 [filename/wildcard]</b> </dt> +<dd>invokes the sisu v3 document parser/generator. Currently +under development and incomplete, v3 requires >= ruby1.9.2p180. You may run +sisu3 instead. +<p> </dd> -<p>Alias -v +<dt><b>--verbose [filename/wildcard]</b> </dt> +<dd>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. Alias -v <p> </dd> <dt><b>-V</b> </dt> -<dd>on its own, provides <b>SiSU</b> version and environment information -(sisu --help env) +<dd>on its own, provides <b>SiSU</b> version and +environment information (sisu --help env) <p> </dd> <dt><b>-V [filename/wildcard]</b> </dt> -<dd>even more verbose than the -v flag. - +<dd>even more +verbose than the -v flag. <p> </dd> <dt><b>-v</b> </dt> <dd>on its own, provides <b>SiSU</b> version information + <p> </dd> -<dt><b>-v [filename/wildcard]</b> -</dt> -<dd> -<p>see --verbose +<dt><b>-v [filename/wildcard]</b> </dt> +<dd>see --verbose <p> </dd> <dt><b>--webrick</b> </dt> -<dd>starts ruby’s webrick webserver points at sisu output -directories, the default port is set to 8081 and can be changed in the -resource configuration files. [tip: the webrick server requires link suffixes, - so html output should be created using the -h option rather than and search --H ; also, note -F webrick ]. Alias -W +<dd>starts ruby’s webrick webserver +points at sisu output directories, the default port is set to 8081 and +can be changed in the resource configuration files. [tip: the webrick server + requires link suffixes, so html output should be created using the -h option + rather than -H ; also, note -F webrick ]. Alias -W <p> </dd> <dt><b>-W</b> </dt> <dd>see --webrick <p> </dd> -<dt><b>--wordmap [filename/wildcard]</b> -</dt> -<dd> -<p>see --concordance +<dt><b>--wordmap +[filename/wildcard]</b> </dt> +<dd>see --concordance <p> </dd> <dt><b>-w [filename/wildcard]</b> </dt> <dd>see --concordance -<p> </dd> -<dt><b>--xhtml [filename/wildcard]</b> -</dt> -<dd>produces xhtml/XML output for browser viewing (sax parsing). Alias -b <p> </dd> -<dt><b>--xml-dom -[filename/wildcard]</b> </dt> -<dd>produces XML output with deep document structure, in -the nature of dom. Alias -X +<dt><b>--xhtml [filename/wildcard]</b> </dt> +<dd>produces xhtml/XML output for browser viewing +(sax parsing). Alias -b <p> </dd> -<dt><b>--xml-sax [filename/wildcard]</b> </dt> -<dd>produces XML output -shallow structure (sax parsing). Alias -x +<dt><b>--xml-dom [filename/wildcard]</b> </dt> +<dd>produces XML output with +deep document structure, in the nature of dom. Alias -X <p> </dd> -<dt><b>-X [filename/wildcard]</b> </dt> -<dd>see --xml-dom +<dt><b>--xml-sax [filename/wildcard]</b> +</dt> +<dd>produces XML output shallow structure (sax parsing). Alias -x +<p> </dd> +<dt><b>-X [filename/wildcard]</b> +</dt> +<dd> +<p>see --xml-dom <p> </dd> <dt><b>-x [filename/wildcard]</b> </dt> @@ -615,8 +635,8 @@ shallow structure (sax parsing). Alias -x <p> </dd> <dt><b>-Y [filename/wildcard]</b> </dt> -<dd>produces a short -sitemap entry for the document, based on html output and the sisu_manifest. +<dd>produces +a short sitemap entry for the document, based on html output and the sisu_manifest. --sitemaps generates/updates the sitemap index of existing sitemaps. (Experimental, [g,y,m announcement this week]) <p> </dd> @@ -682,60 +702,60 @@ modifiable with --db=[database type (pgsql or sqlite)] <dd>initial step, creates required relations (tables, indexes) in existing 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. +as working directory, as requested) (rb.dbi) [ -dv --createall 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. + <p> </dd> <dt><b>--pg -v --import</b> </dt> -<dd>[filename/wildcard] imports -data specified to postgresql db (rb.dbi) [ -dv --import sqlite equivalent] - +<dd>[filename/wildcard] imports data specified to postgresql db +(rb.dbi) [ -dv --import sqlite equivalent] <p> </dd> <dt><b>--pg -v --update</b> </dt> -<dd>[filename/wildcard] updates/imports specified data to postgresql -db (rb.dbi) [ -dv --update sqlite equivalent] +<dd>[filename/wildcard] +updates/imports specified data to postgresql db (rb.dbi) [ -dv --update sqlite + equivalent] <p> </dd> <dt><b>--pg --remove</b> </dt> -<dd>[filename/wildcard] -removes specified data to postgresql db (rb.dbi) [ -d --remove sqlite equivalent] - +<dd>[filename/wildcard] removes specified data to postgresql +db (rb.dbi) [ -d --remove sqlite equivalent] <p> </dd> <dt><b>--pg --dropall</b> </dt> -<dd>kills data" and drops (postgresql or sqlite) db, tables & indexes -[ -d --dropall sqlite equivalent] +<dd>kills data" and drops +(postgresql or sqlite) db, tables & indexes [ -d --dropall sqlite equivalent] + <p> The -v is for verbose output. <p> </dd> </dl> -5. SHORTCUTS, -SHORTHAND FOR MULTIPLE FLAGS +5. SHORTCUTS, SHORTHAND FOR MULTIPLE FLAGS + <p> <dl> <dt><b>--update [filename/wildcard]</b> </dt> -<dd>Checks existing -file output and runs the flags required to update this output. This means -that if only html and pdf output was requested on previous runs, only the --hp files will be applied, and only these will be generated this time, together -with the summary. This can be very convenient, if you offer different outputs -of different files, and just want to do the same again. +<dd>Checks existing file output and runs the flags +required to update this output. This means that if only html and pdf output +was requested on previous runs, only the -hp files will be applied, and +only these will be generated this time, together with the summary. This +can be very convenient, if you offer different outputs of different files, +and just want to do the same again. <p> </dd> -<dt><b>-0 to -5 [filename - or wildcard]</b> </dt> -<dd>Default shorthand mappings (note that the defaults can be -changed/configured in the sisurc.yml file): +<dt><b>-0 to -5 [filename or wildcard]</b> </dt> +<dd>Default +shorthand mappings (note that the defaults can be changed/configured in +the sisurc.yml file): <p> </dd> <dt><b>-0</b> </dt> -<dd>-mNhwpAobxXyYv [this is the - default action run when no i.e. on ’sisu [filename]’] +<dd>-mNhwpAobxXyYv [this is the default action run when + no i.e. on ’sisu [filename]’] <p> </dd> <dt><b>-1</b> </dt> @@ -744,7 +764,6 @@ changed/configured in the sisurc.yml file): <dt><b>-2</b> </dt> <dd>-mhewpaoy - <p> </dd> <dt><b>-3</b> </dt> @@ -752,38 +771,43 @@ changed/configured in the sisurc.yml file): <p> </dd> <dt><b>-4</b> </dt> -<dd>-mhewpAobxXDyY --import +<dd>-mhewpAobxXDyY + +<p>- +<p>- +<p>import <p> </dd> <dt><b>-5</b> </dt> <dd>-mhewpAobxXDyY --update -<p> add -v -for verbose mode and -c for color, e.g. sisu -2vc [filename or -<p> consider -u +<p> add -v for verbose mode and -c for color, +e.g. sisu -2vc [filename or +<p> consider -u for appended url info or -v for verbose -<p>for appended url info or -v for verbose output +<p>output <p> </dd> </dl> -5.1 COMMAND LINE WITH FLAGS -- BATCH PROCESSING -<p> In the data directory run sisu -mh filename or wildcard -eg. "sisu -h cisg.sst" or "sisu -h *.{sst,ssm}" to produce html version of all -documents. -<p> Running sisu (alone without any flags, filenames or wildcards) -brings up the interactive help, as does any sisu command that is not recognised. -Enter to escape. +5.1 COMMAND LINE WITH FLAGS - BATCH PROCESSING +<p> In the data directory +run sisu -mh filename or wildcard eg. "sisu -h cisg.sst" or "sisu -h *.{sst,ssm}" +to produce html version of all documents. +<p> Running sisu (alone without +any flags, filenames or wildcards) brings up the interactive help, as does +any sisu command that is not recognised. Enter to escape. <p> 6. HELP -<p> 6.1 SISU MANUAL -<p> The most up to date information -on sisu should be contained in the sisu_manual, available at: +<p> 6.1 SISU + +<p>MANUAL +<p> The most up to date information on sisu should be contained in +the sisu_manual, available at: <p> <<a href='http://sisudoc.org/sisu/sisu_manual/'>http://sisudoc.org/sisu/sisu_manual/</a> ><br> <p> The manual can be generated from source, found respectively, either within the <b>SiSU</b> tarball or installed locally at: -<p> ./data/doc/sisu/v2/sisu_markup_samples/sisu_manual/<br> +<p> ./data/doc/sisu/markup-samples/sisu_manual<br> -<p> /usr/share/doc/sisu/v2/sisu_markup_samples/sisu_manual/<br> +<p> /usr/share/doc/sisu/markup-samples/sisu_manual<br> <p> move to the respective directory and type e.g.: <p> sisu sisu_manual.ssm<br> @@ -800,15 +824,15 @@ should be available, try: <p> Most <b>SiSU</b> man pages are generated directly from sisu documents that are used to prepare the sisu manual, the sources files for which are located within the <b>SiSU</b> tarball at: -<p> ./data/doc/sisu/v2/sisu_markup_samples/sisu_manual/<br> +<p> ./data/doc/sisu/markup-samples/sisu_manual<br> <p> Once installed, directory equivalent to: -<p> /usr/share/doc/sisu/sisu_manual/<br> +<p> /usr/share/doc/sisu/markup-samples/sisu_manual<br> <p> Available man pages are converted back to html using man2html: -<p> /usr/share/doc/sisu/v2/html/<br> +<p> /usr/share/doc/sisu/html/<br> -<p> ./data/doc/sisu/v2/html/<br> +<p> ./data/doc/sisu/html<br> <p> An online version of the sisu man page is available here: <p> * various @@ -851,6 +875,9 @@ see: <p> <b>man2html</b> <p> /usr/share/doc/sisu/v2/html/sisu.1.html<br> +<p> <b>sisu generated html</b> +<p> /usr/share/doc/sisu/html/sisu_help_sources/index.html<br> + <p> <<a href='http://sisudoc.org/sisu/sisu_help_sources/index.html'>http://sisudoc.org/sisu/sisu_help_sources/index.html</a> ><br> @@ -982,17 +1009,18 @@ that has a header similar to this one: <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 +header instructions take the form @headername: or on the next line and +indented by once space :subheadername: All Dublin Core meta tags are available -<p>Dublin Core meta tags are available <p> <b>@indentifier:</b> information or instructions +<p> where the "identifier" is +a tag recognised by the program, and the "information" or "instructions" + +<p>belong to the tag/indentifier specified +<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> where the "identifier" is a tag recognised by the program, and the "information" -or "instructions" belong to the tag/indentifier specified -<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 is a sample header <p> <p> <br> @@ -1040,7 +1068,7 @@ and can be useful to know. :pg: [Project Gutenberg text number] </pre> <p> <br> -<pre> @links: { SiSU }http://www.jus.uio.no/sisu/ +<pre> @links: { SiSU }http://www.sisudoc.org { FSF }http://www.fsf.org </pre> <p> <br> @@ -1072,21 +1100,22 @@ 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~ [heading - text]</b> Top level heading [this usually has similar content to the ] NOTE: -the heading levels described here are in 0.38 notation, see heading -<p> <b>:B~ -[heading text]</b> Second level heading [this is a heading level divider] -<p> - <b>:C~ [heading text]</b> Third level heading [this is a heading level divider] - -<p> <b>1~ [heading 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 + text]</b> Top level heading [this usually has similar content to the title + @title: ] NOTE: the heading levels described here are in 0.38 notation, + +<p>see heading +<p> <b>:B~ [heading text]</b> Second level heading [this is a heading + level divider] +<p> <b>:C~ [heading text]</b> Third level heading [this is a heading + level divider] +<p> <b>1~ [heading 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~ [heading text]</b> Second level heading preceding substantive text of -document or sub-heading 3, the heading level that would normally be marked +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~ [heading text]</b> Third level heading preceding substantive text of document, that would normally be @@ -1106,13 +1135,14 @@ html <p> <br> <pre> normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}", - ^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}- #{monospace}# + ^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}-, #{monospace}# normal text - !{emphasis}! - *{bold text}* + *{emphasis}* [note: can be configured to be represented by bold, italics + or underscore] + !{bold text}! _{underscore}_ /{italics}/ - + "{citation}" ^{superscript}^ ,{subscript}, +{inserted text}+ @@ -1120,12 +1150,13 @@ html #{monospace}# </pre> <p> <b>resulting output:</b> -<p> normal text <b>emphasis</b> <b>bold text</b> <i>underscore</i> <i>italics</i> -"citation" ^superscript^ [subscript] ++inserted text++ --strikethrough-- monospace +<p> normal text, <b>emphasis</b> , <b>bold text</b> , <i>italics</i> , <i>underscore</i> +, "citation", ^superscript^, [subscript], ++inserted text++, --strikethrough--, +<p>monospace <p> normal text -<p> <b>emphasis</b> [note: can be configured to be represented by - bold, italics or underscore] +<p> <b>emphasis</b> [note: can be configured to be represented + by bold, italics or underscore] <p> <b>bold text</b> <p> <i>italics</i> <p> <i>underscore</i> @@ -1177,10 +1208,11 @@ html _# numbered list numbered list indented a., b., c., d., etc. </pre> <p> 9.4 FOOTNOTES / ENDNOTES -<p> Footnotes and endnotes not distinguished in -markup. They are automatically numbered. Depending on the output file format -(html, EPUB, odf, pdf etc.), the document output selected will have either -footnotes or endnotes. +<p> Footnotes and endnotes are marked up at the +location where they would be indicated within a text. They are automatically +numbered. The output type determines whether footnotes or endnotes will + +<p>be produced <p> <b>markup example:</b> <p> <p> <br> @@ -1221,7 +1253,7 @@ asterisks if required }~ continues <p> <b>Alternative endnote pair notation for footnotes/endnotes:</b> <p> <p> <br> -<pre> % note the endnote marker +<pre> % note the endnote marker "~^" normal text~^ continues ^~ endnote text following the paragraph in which the marker occurs </pre> @@ -1239,10 +1271,10 @@ is omitted). <p> <b>markup example:</b> <p> <p> <br> -<pre> normal text http://www.jus.uio.no/sisu continues +<pre> normal text http://www.sisudoc.org/ continues </pre> <p> <b>resulting output:</b> -<p> normal text <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> +<p> normal text <<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> > continues <p> An @@ -1250,70 +1282,74 @@ is omitted). <p> <b>markup example:</b> <p> <p> <br> -<pre> normal text _http://www.jus.uio.no/sisu continues +<pre> normal text _http://www.sisudoc.org/ 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> +<p> normal text <_<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> > continues -<p> -deb <_<a href='http://www.jus.uio.no/sisu/archive'>http://www.jus.uio.no/sisu/archive</a> +<p> deb +<_<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 +<p> where a code block +is used there is neither decoration nor hyperlinking, code blocks are discussed -<p>are discussed later in this document +<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> 9.5.2 LINKING TEXT +<p> To link text or an image to a url the markup is as +<p>follows +<p> <b>markup example:</b> <p> <p> <br> <pre> about { SiSU }http://url.org markup </pre> -<p> 9.5.2 LINKING TEXT <p> <b>resulting output:</b> -<p> about SiSU <<a href='http://www.jus.uio.no/sisu/'>http://www.jus.uio.no/sisu/</a> -> +<p> aboutSiSU <<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> +> markup +<p> A shortcut -<p>markup -<p> A shortcut notation is available so the url link may also be provided +<p>notation is available so the url link may also be provided automatically -<p>automatically as a footnote +<p>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> abou tSiSU <<a href='http://www.jus.uio.no/sisu/'>http://www.jus.uio.no/sisu/</a> +<p> about SiSU <<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> > [^14] markup -<p> +<p> 9.5.3 -<p>9.5.3 LINKING IMAGES +<p>LINKING IMAGES <p> <b>markup example:</b> <p> <p> <br> <pre> { tux.png 64x80 }image % various url linked images - {tux.png 64x80 - {GnuDebianLinuxRubyBetterWay.png 100x101 - {~^ ruby_logo.png + {tux.png 64x80 "a better way" }http://www.sisudoc.org/ + {GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, +Debian and Ruby" }http://www.sisudoc.org/ + {~^ ruby_logo.png "Ruby" }http://www.ruby-lang.org/en/ </pre> <p> <b>resulting output:</b> <p> [ tux.png ] -<p> tux.png 64x80 -<p> [ ruby_logo (png missing) - ] [^15] -<p> GnuDebianLinuxRubyBetterWay.png 100x101 and Ruby -<p> <b>linked url footnote +<p> tux.png 64x80 "Gnu/Linux - a better way" +<<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> +> +<p> [ ruby_logo (png missing) ] [^15] +<p> GnuDebianLinuxRubyBetterWay.png +100x101 "Way Better - with Gnu/Linux, Debian and Ruby" <<a href='http://www.jus.uio.no/sisu/'>http://www.jus.uio.no/sisu/</a> +> -<p>shortcut</b> +<p> <b>linked url footnote shortcut</b> <p> <p> <br> <pre> {~^ [text to link] }http://url.org @@ -1347,7 +1383,7 @@ auto-heading numbering, without further intervention. }table </pre> <p> <b>resulting output:</b> -<p> [table omitted, see other document formats]<br> +<p> [table omitted, see other document formats]<br> <p> a second form may be easier to work with in cases where there is not @@ -1375,7 +1411,7 @@ auto-heading numbering, without further intervention. <p> <b>resulting output:</b> <p> <b>Table 3.1: Contributors to Wikipedia, January 2001 - June 2005</b> -<p> [table omitted, see other document formats]<br> +<p> [table omitted, see other document formats]<br> <p> * Contributed at least ten times; ** at least 5 times in last month; *** more than 100 times in last month. @@ -1386,7 +1422,7 @@ auto-heading numbering, without further intervention. <pre> poem{ Your poem here }poem - Each verse in a poem is given a separate object number. + Each verse in a poem is given an object number. </pre> <p> <b>markup example:</b> <p> @@ -1396,7 +1432,7 @@ auto-heading numbering, without further intervention. mouse, That he met in the house, - + "Let us both go to law: I will prosecute @@ -1408,10 +1444,10 @@ auto-heading numbering, without further intervention. really this morning I’ve nothing - to do. + to do." Said the mouse to the - cur, + cur, "Such a trial, dear Sir, With @@ -1420,14 +1456,14 @@ auto-heading numbering, without further intervention. would be wasting our - breath. - + breath." + "I’ll be judge, I’ll - be jury, + be jury," Said cunning old Fury: - + "I’ll try the whole cause, @@ -1435,15 +1471,15 @@ auto-heading numbering, without further intervention. condemn you to - death. + death."’ }poem </pre> <p> <b>resulting output:</b> -<p> ’Fury said to a<br> +<p> ‘Fury said to a<br> mouse, That he<br> met in the<br> house,<br> - <br> + "Let us<br> both go to<br> law: I will<br> prosecute<br> @@ -1455,10 +1491,10 @@ auto-heading numbering, without further intervention. really this<br> morning I’ve<br> nothing<br> - to do.<br> + to do."<br> Said the<br> mouse to the<br> - cur,<br> + cur, "Such<br> a trial,<br> dear Sir,<br> With<br> @@ -1467,14 +1503,14 @@ auto-heading numbering, without further intervention. would be<br> wasting<br> our<br> - breath.<br> - <br> + breath."<br> + "I’ll be<br> judge, I’ll<br> - be jury,<br> + be jury,"<br> Said<br> cunning<br> old Fury:<br> - <br> + "I’ll<br> try the<br> whole<br> cause,<br> @@ -1482,7 +1518,7 @@ auto-heading numbering, without further intervention. condemn<br> you<br> to<br> - death.<br> + death."’<br> <p> 9.6.3 GROUP <p> <b>basic markup:</b> @@ -1501,7 +1537,7 @@ auto-heading numbering, without further intervention. mouse, That he met in the house, - + "Let us both go to law: I will prosecute @@ -1513,10 +1549,10 @@ auto-heading numbering, without further intervention. really this morning I’ve nothing - to do. + to do." Said the mouse to the - cur, + cur, "Such a trial, dear Sir, With @@ -1525,14 +1561,14 @@ auto-heading numbering, without further intervention. would be wasting our - breath. - + breath." + "I’ll be judge, I’ll - be jury, + be jury," Said cunning old Fury: - + "I’ll try the whole cause, @@ -1540,15 +1576,15 @@ auto-heading numbering, without further intervention. condemn you to - death. + death."’ }group </pre> <p> <b>resulting output:</b> -<p> ’Fury said to a<br> +<p> ‘Fury said to a<br> mouse, That he<br> met in the<br> house,<br> - <br> + "Let us<br> both go to<br> law: I will<br> prosecute<br> @@ -1560,10 +1596,10 @@ auto-heading numbering, without further intervention. really this<br> morning I’ve<br> nothing<br> - to do.<br> + to do."<br> Said the<br> mouse to the<br> - cur,<br> + cur, "Such<br> a trial,<br> dear Sir,<br> With<br> @@ -1572,14 +1608,14 @@ auto-heading numbering, without further intervention. would be<br> wasting<br> our<br> - breath.<br> - <br> + breath."<br> + "I’ll be<br> judge, I’ll<br> - be jury,<br> + be jury,"<br> Said<br> cunning<br> old Fury:<br> - <br> + "I’ll<br> try the<br> whole<br> cause,<br> @@ -1587,26 +1623,25 @@ auto-heading numbering, without further intervention. condemn<br> you<br> to<br> - death.<br> + death."’<br> <p> 9.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. [an more than 100 times in last -month. option to number each line of code may be considered at more than -100 times in last month. some later time] +<p> Code tags code{ ... }code (used as with other group tags described +above) 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. [an some later time] <p> <b>use of code tags instead of poem compared, resulting output:</b> <p> <p> <br> -<pre> ’Fury said to a +<pre> ‘Fury said to a mouse, That he met in the house, - + "Let us both go to law: I will prosecute @@ -1618,10 +1653,10 @@ poem compared, resulting output:</b> really this morning I’ve nothing - to do. + to do." Said the mouse to the - cur, + cur, "Such a trial, dear Sir, With @@ -1630,14 +1665,14 @@ poem compared, resulting output:</b> would be wasting our - breath. - + breath." + "I’ll be judge, I’ll - be jury, + be jury," Said cunning old Fury: - + "I’ll try the whole cause, @@ -1645,7 +1680,56 @@ poem compared, resulting output:</b> condemn you to - death. + death."’ +</pre> +<p> From <b>SiSU</b> 2.7.7 on you can number codeblocks by placing a hash after the +opening code tag code{# as demonstrated here: +<p> +<p> <br> +<pre>1 | ‘Fury said to a +2 | mouse, That he +3 | met in the +4 | house, +5 | "Let us +6 | both go to +7 | law: I will +8 | prosecute +9 | YOU. --Come, +10 | I’ll take no +11 | denial; We +12 | must have a +13 | trial: For +14 | really this +15 | morning I’ve +16 | nothing +17 | to do." +18 | Said the +19 | mouse to the +20 | cur, "Such +21 | a trial, +22 | dear Sir, +23 | With +24 | no jury +25 | or judge, +26 | would be +27 | wasting +28 | our +29 | breath." +30 | "I’ll be +31 | judge, I’ll +32 | be jury," +33 | Said +34 | cunning +35 | old Fury: +36 | "I’ll +37 | try the +38 | whole +39 | cause, +40 | and +41 | condemn +42 | you +43 | to +44 | death."’ </pre> <p> 9.7 BOOK INDEX <p> To make an index append to paragraph the book index term @@ -1737,16 +1821,17 @@ of documents under consideration, and occasionally supported have been. <p> MARKUP SYNTAX HISTORY <p> 11. 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> * sisu --query=[sisu version [0.38] or ’history] +<p> 2.0 introduced new headers and is therefore incompatible with 1.0 though +otherwise the same with the addition of a couple of tags (i.e. a superset) +<p> 0.38 is substantially current for version 1.0 +<p> * sisu --query=[sisu version + [0.38] or ’history] <p> provides a short history of changes to <b>SiSU</b> markup -<p> <b>0.57</b> (2007w34/4) -<b>SiSU</b> 0.57 is the same as 0.42 with the introduction of some a shortcut to -use the headers @title and @creator in the first heading [expanded using - the and @author:] + +<p> <b>0.57</b> (2007w34/4) <b>SiSU</b> 0.57 is the same as 0.42 with the introduction of +some a shortcut to use the headers @title and @creator in the first heading +[expanded using the and @author:] <p> <p> <br> <pre> :A~ @title by @author @@ -1876,30 +1961,30 @@ may be located locally or on a remote server for which a url is provided. <p> 12.1.1 SISU TEXT - REGULAR FILES (.SST) <p> The most common form of document in <b>SiSU</b> , see the section on <b>SiSU</b> markup. -<p> <<a href='http://www.jus.uio.no/sisu/sisu_markup'>http://www.jus.uio.no/sisu/sisu_markup</a> +<p> <<a href='http://www.sisudoc.org/sisu/sisu_markup'>http://www.sisudoc.org/sisu/sisu_markup</a> > -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual'>http://www.jus.uio.no/sisu/sisu_manual</a> +<p> <<a href='http://www.sisudoc.org/sisu/sisu_manual'>http://www.sisudoc.org/sisu/sisu_manual</a> > <p> 12.1.2 SISU MASTER FILES (.SSM) -<p> Composite -documents which incorporate other <b>SiSU</b> documents which may be either regular -<b>SiSU</b> text .sst which may be generated independently, or inserts prepared -solely for the purpose of being incorporated into one or more master documents. - -<p> The mechanism by which master files incorporate other documents is described -as one of the headings under under <b>SiSU</b> markup in the <b>SiSU</b> manual. -<p> Note: -Master documents may be prepared in a similar way to regular documents, -and processing will occur normally if a .sst file is renamed .ssm without -requiring any other documents; the .ssm marker flags that the document may -contain other documents. -<p> Note: a secondary file of the composite document -is built prior to processing with the same prefix and the suffix ._sst [^17] - -<p> <<a href='http://www.jus.uio.no/sisu/sisu_markup'>http://www.jus.uio.no/sisu/sisu_markup</a> +<p> + Composite documents which incorporate other <b>SiSU</b> documents which may be +either regular <b>SiSU</b> text .sst which may be generated independently, or inserts +prepared solely for the purpose of being incorporated into one or more +master documents. +<p> The mechanism by which master files incorporate other +documents is described as one of the headings under under <b>SiSU</b> markup in +the <b>SiSU</b> manual. +<p> Note: Master documents may be prepared in a similar way +to regular documents, and processing will occur normally if a .sst file +is renamed .ssm without requiring any other documents; the .ssm marker flags +that the document may contain other documents. +<p> Note: a secondary file +of the composite document is built prior to processing with the same prefix +and the suffix ._sst [^17] +<p> <<a href='http://www.sisudoc.org/sisu/sisu_markup'>http://www.sisudoc.org/sisu/sisu_markup</a> > -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual'>http://www.jus.uio.no/sisu/sisu_manual</a> +<p> <<a href='http://www.sisudoc.org/sisu/sisu_manual'>http://www.sisudoc.org/sisu/sisu_manual</a> > <p> 12.1.3 SISU INSERT FILES (.SSI) @@ -1935,10 +2020,10 @@ sisu -S<br> <p> <b>SiSU</b> processing can be done directly against a sisupod; which may be located locally or on a remote server for which a url is provided. -<p> <<a href='http://www.jus.uio.no/sisu/sisu_commands'>http://www.jus.uio.no/sisu/sisu_commands</a> +<p> <<a href='http://www.sisudoc.org/sisu/sisu_commands'>http://www.sisudoc.org/sisu/sisu_commands</a> > -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual'>http://www.jus.uio.no/sisu/sisu_manual</a> +<p> <<a href='http://www.sisudoc.org/sisu/sisu_manual'>http://www.sisudoc.org/sisu/sisu_manual</a> > <p> 13. EXPERIMENTAL ALTERNATIVE INPUT REPRESENTATIONS @@ -2082,17 +2167,17 @@ and symbolic links as needed from the site, or dir directories as required. <p> With <b>SiSU</b> installed sample skins may be found in: <p> /etc/sisu/skin/doc and<br> - /usr/share/doc/sisu/v2/sisu_markup_samples/samples/_sisu/skin/doc<br> + /usr/share/doc/sisu/markup-samples/samples/_sisu/skin/doc<br> <p> (or equivalent directory) and if sisu-markup-samples is installed also under: -<p> /usr/share/doc/sisu-markup-samples/v2/samples/_sisu/skin/doc<br> +<p> /usr/share/doc/sisu/markup-samples-non-free/samples/_sisu/skin/doc<br> <p> Samples of list.yml and promo.yml (which are used to create the right column list) may be found in: -<p> /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml -(or equivalent<br> - directory)<br> +<p> /usr/share/doc/sisu/markup-samples-non-free/samples/_sisu/skin/yml +(or<br> + equivalent directory)<br> <p> 16. CSS - CASCADING STYLE SHEETS (FOR HTML, XHTML AND XML) <p> CSS files @@ -2201,47 +2286,42 @@ index.html and document output samples are provided at <<a href='http://www.jus.uio.no/sisu/SiSU/examples.html'>http://www.jus.uio.no/sisu/SiSU/examples.html</a> > -<p> Some markup with syntax highlighting may be found under <<a href='http://www.jus.uio.no/sisu/sample/syntax'>http://www.jus.uio.no/sisu/sample/syntax</a> -> -but is not as up to date. -<p> For some documents hardly any markup at all -is required at all, other than a header, and an indication that the levels -to be taken into account by the program in generating its output are. -<p> 20. -SISU SEARCH - INTRODUCTION -<p> <b>SiSU</b> output can easily and conveniently be -indexed by a number of standalone indexing tools, such as Lucene, Hyperestraier. - -<p> Because the document structure of sites created is clearly defined, and -the text object citation system is available hypothetically at least, for -all forms of output, it is possible to search the sql database, and either -read results from that database, or just as simply map the results to the -html output, which has richer text markup. -<p> In addition to this <b>SiSU</b> has -the ability to populate a relational sql type database with documents at -an object level, with objects numbers that are shared across different -output types, which make them searchable with that degree of granularity. -Basically, your match criteria is met by these documents and at these locations -within each document, which can be viewed within the database directly -or in various output formats. -<p> 21. SQL +<p> For some documents hardly any markup at all is required at all, other +than a header, and an indication that the levels to be taken into account +by the program in generating its output are. +<p> 20. SISU SEARCH - INTRODUCTION + +<p> <b>SiSU</b> output can easily and conveniently be indexed by a number of standalone +indexing tools, such as Lucene, Hyperestraier. +<p> Because the document structure +of sites created is clearly defined, and the text object citation system +is available hypothetically at least, for all forms of output, it is possible +to search the sql database, and either read results from that database, +or just as simply map the results to the html output, which has richer +text markup. +<p> In addition to this <b>SiSU</b> has the ability to populate a relational +sql type database with documents at an object level, with objects numbers +that are shared across different output types, which make them searchable +with that degree of granularity. Basically, your match criteria is met by +these documents and at these locations within each document, which can +be viewed within the database directly or in various output formats. +<p> 21. +SQL <p> 21.1 POPULATING SQL TYPE DATABASES - -<p> <b>SiSU</b> feeds sisu markupd documents into sql type databases PostgreSQL[^19] -and/or SQLite[^20] database together with information related to document -structure. -<p> This is one of the more interesting output forms, as all the -structural data of the documents are retained (though can be ignored by -the user of the database should they so choose). All site texts/documents -are (currently) streamed to four tables: -<p> * one containing semantic -(and other) headers, including, title, author,<br> +<p> <b>SiSU</b> feeds sisu markupd documents +into sql type databases PostgreSQL[^19] and/or SQLite[^20] database together +with information related to document structure. +<p> This is one of the more +interesting output forms, as all the structural data of the documents are +retained (though can be ignored by the user of the database should they +so choose). All site texts/documents are (currently) streamed to four tables: + +<p> * one containing semantic (and other) headers, including, title, author,<br> subject, (the Dublin Core...);<br> <p> * another the substantive texts by individual "paragraph" (or object) --<br> - along with structural information, each paragraph being identifiable -by its<br> +- along<br> + with structural information, each paragraph being identifiable by its<br> paragraph number (if it has one which almost all of them do), and the<br> substantive text of each paragraph quite naturally being searchable (both in<br> @@ -2371,8 +2451,7 @@ to populate an sqlite database, this being part of <b>SiSU</b> - man sisu). <p>SYNOPSIS <p> sisu -d [instruction] [filename/wildcard if required]<br> -<p> sisu -d --(sqlite|pg) --[instruction] [filename/wildcard if <br> - required]<br> +<p> sisu -d --(sqlite|pg) --[instruction] [filename/wildcard if required]<br> <p> 23.4 COMMANDS <p> Mappings to two databases are provided by default, postgresql @@ -2560,8 +2639,8 @@ be desirable to exclude files ’plain.txt’, ’toc.html’ an these duplicate information held in other html output e.g. <p> find /home/ralph/sisu_www -type f | egrep<br> - ’/sisu_www/(sisu|bookmarks)/.+?.html$’ | egrep -v<br> - ’(doc|concordance).html$’ |estcmd gather -sd casket -<br> + ’/sisu_www/(sisu|bookmarks)/.+?.html$’ | egrep -v ’(doc|concordance).html$’<br> + |estcmd gather -sd casket -<br> <p> from your current document preparation/markup directory, you would construct a rune along the following lines: @@ -2585,7 +2664,7 @@ and set file permissions to 755: <p> [see estraier documentation for paths]<br> <p> (ii) edit estseek.conf, with attention to the lines starting ’indexname:’ -and ’replace:’: +and <p> indexname: /home/ralph/sisu_www/casket<br> <p> replace: ^file:///home/ralph/sisu_www{{!}}<a href='http://localhost'>http://localhost</a> @@ -2611,37 +2690,38 @@ and ’replace:’: <p> 26.3 DESCRIPTION <p> sisu_webrick is part of <b>SiSU</b> (man sisu) sisu_webrick -starts <b>Ruby</b> ’s Webrick web-server and points it to the directories to which -<b>SiSU</b> output is written, providing a list of these directories (assuming -<b>SiSU</b> is in use and they exist). -<p> The default port for sisu_webrick is set -to 8081, this may be modified in the yaml file: ~/.sisu/sisurc.yml a sample -of which is provided as /etc/sisu/sisurc.yml (or in the equivalent directory -on your system). +starts <b>Ruby</b> <b>SiSU</b> output is written, providing a list of these directories +(assuming <b>SiSU</b> is in use and they exist). +<p> The default port for sisu_webrick +is set to 8081, this may be modified in the yaml file: ~/.sisu/sisurc.yml +a sample of which is provided as /etc/sisu/sisurc.yml (or in the equivalent +directory on your system). <p> 26.4 SUMMARY OF MAN PAGE -<p> sisu_webrick, may be started -on it’s own with the command: sisu_webrick [port] or using the sisu command -with the -W flag: sisu -W [port] -<p> where no port is given and settings are +<p> sisu_webrick, may +be started on it’s own with the command: sisu_webrick [port] or using the +sisu command with the -W flag: sisu -W [port] +<p> where no port is given and -<p>unchanged the default port is 8081 -<p> 26.5 DOCUMENT PROCESSING COMMAND FLAGS +<p>settings are unchanged the default port is 8081 +<p> 26.5 DOCUMENT PROCESSING -<p> sisu -W [port] starts <b>Ruby</b> Webrick web-server, serving <b>SiSU</b> output directories, -on the port provided, or if no port is provided and the defaults have not +<p>COMMAND FLAGS +<p> sisu -W [port] starts <b>Ruby</b> Webrick web-server, serving <b>SiSU</b> +output directories, on the port provided, or if no port is provided and -<p>been changed in ~/.sisu/sisurc.yaml then on port 8081 -<p> 26.6 FURTHER INFORMATION +<p>the defaults have not been changed in ~/.sisu/sisurc.yaml then on port 8081 -<p> For more information on <b>SiSU</b> see: <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> +<p> 26.6 FURTHER INFORMATION +<p> For more information on <b>SiSU</b> see: <<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> +> +or <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> > <p> or man sisu - <p> 26.7 AUTHOR -<p> Ralph Amissah ralph@amissah.com or ralph.amissah@gmail.com -<p> +<p> Ralph Amissah ralph@amissah.com -<p>26.8 SEE ALSO +<p>or ralph.amissah@gmail.com +<p> 26.8 SEE ALSO <p> <a href='http:~/bin/man2html?sisu:1'>sisu(1)</a> <br> @@ -2669,19 +2749,19 @@ parts (such as images) will be downloaded and generated locally. <p> Any of the source documents in the sisu examples page can be used in this way, see <<a href='http://www.jus.uio.no/sisu/SiSU/examples.html'>http://www.jus.uio.no/sisu/SiSU/examples.html</a> > and use the url -for the desired document. -<p> NOTE: to set up a remote machine to serve <b>SiSU</b> -documents in this way, images should be in the directory relative to the +to the .sst for the desired document.<br> + +<p> NOTE: to set up a remote machine to serve <b>SiSU</b> documents in this way, + +<p>images should be in the directory relative to the document source ../_sisu/image -<p>document source ../_sisu/image <p> <b>sisupod - zipped sisu files</b> -<p> A sisupod is -the zipped content of a sisu marked up text or texts and any other associated -parts to the document such as images. -<p> <b>SiSU</b> can be run against a sisupod -on a (local or) remote machine, provide the processing instruction and -the url, the sisupod will be downloaded and the documents it contains generated -locally. +<p> A sisupod is the zipped content of a sisu +marked up text or texts and any other associated parts to the document +such as images. +<p> <b>SiSU</b> can be run against a sisupod on a (local or) remote +machine, provide the processing instruction and the url, the sisupod will +be downloaded and the documents it contains generated locally. <p> <p> <br> <pre> sisu -3 http://[provide url to valid sisupod.zip or .ssp file] @@ -2711,40 +2791,40 @@ may be used in conjunction with other processing flags, e.g. <dt><b>-R [filename/wildcard]</b> </dt> <dd>copies sisu output files to remote host using rsync. This requires that sisurc.yml has been provided with information -on hostname and username, and that you have your different if -R is used -with other flags from if used alone. Alone the rsync --delete parameter is -sent, useful for cleaning the remote directory (when -R is used together -with other flags, it is not). Also see -r +on hostname and username, and that you have your "keys" and ssh agent in +place. Note the behavior of rsync different if -R is used with other flags +from if used alone. Alone the rsync --delete parameter is sent, useful for +cleaning the remote directory (when -R is used together with other flags, +it is not). Also see -r <p> </dd> <dt><b>-r [filename/wildcard]</b> </dt> -<dd>copies sisu -output files to remote host using scp. This requires that sisurc.yml has -been provided with information on hostname and username, and that you have - -<p>your +<dd>copies sisu output files to +remote host using scp. This requires that sisurc.yml has been provided with +information on hostname and username, and that you have your "keys" and +ssh agent in place. Also see -R <p> </dd> </dl> 28.2 CONFIGURATION -<p> [expand on the setting up of an ssh-agent / keychain] - +<p> [expand on the setting + up of an ssh-agent / keychain] <p> 29. REMOTE SERVERS -<p> As <b>SiSU</b> is generally operated using the command line, -and works within a Unix type environment, <b>SiSU</b> the program and all documents -can just as easily be on a remote server, to which you are logged on using -a terminal, and commands and operations would be pretty much the same as -they would be on your local machine. -<p> 30. QUICKSTART - GETTING STARTED HOWTO - +<p> As <b>SiSU</b> is generally +operated using the command line, and works within a Unix type environment, +<b>SiSU</b> the program and all documents can just as easily be on a remote server, +to which you are logged on using a terminal, and commands and operations +would be pretty much the same as they would be on your local machine. +<p> 30. +QUICKSTART - GETTING STARTED HOWTO <p> 30.1 INSTALLATION -<p> Installation is currently most straightforward and -tested on the <b>Debian</b> platform, as there are packages for the installation -of sisu and all requirements for what it does. +<p> Installation is +currently most straightforward and tested on the <b>Debian</b> platform, as there +are packages for the installation of sisu and all requirements for what +it does. <p> 30.1.1 DEBIAN INSTALLATION - -<p> <b>SiSU</b> is available directly from the <b>Debian</b> Sid and testing archives (and -possibly Ubuntu), assuming your /etc/apt/sources.list is set accordingly: - +<p> <b>SiSU</b> is available directly from the +<b>Debian</b> Sid and testing archives (and possibly Ubuntu), assuming your /etc/apt/sources.list +is set accordingly: <p> <p> <br> <pre> aptitude update @@ -2757,7 +2837,6 @@ markup samples: <pre> #/etc/apt/sources.list deb http://ftp.fi.debian.org/debian/ unstable main non-free contrib deb-src http://ftp.fi.debian.org/debian/ unstable main non-free contrib - d </pre> <p> The aptitude commands become: <p> @@ -2832,10 +2911,11 @@ the root directory of the unpacked <b>SiSU</b> as root type: <p> <<a href='http://i.loveruby.net/en/projects/setup/doc/usage.html'>http://i.loveruby.net/en/projects/setup/doc/usage.html</a> ><br> -<p> <b></b> -<p> The root directory of the unpacked <b>SiSU</b> as root type: -<p> ruby install -base<br> +<p> <b>install</b> +<p> The "install" file provided is an installer prepared using +"rant". In the root directory of the unpacked <b>SiSU</b> as root type: +<p> ruby +install base<br> <p> or for a more complete installation: <p> ruby install<br> @@ -2848,8 +2928,7 @@ has been configured to do post installation setup setup configuration and generation of first test file. Note however, that additional external package dependencies, such as tetex-extra are not taken care of for you. <p> Further - -<p>information on +information on "rant" is available from: <p> <<a href='http://make.rubyforge.org/'>http://make.rubyforge.org/</a> ><br> @@ -2921,10 +3000,10 @@ create the database and write to it when you run sisu. <p> The man pages are also available online, though not always kept as up to date as within the package itself: -<p> * sisu.1 <<a href='http://www.jus.uio.no/sisu/man/sisu.1'>http://www.jus.uio.no/sisu/man/sisu.1</a> +<p> * sisu.1 <<a href='http://www.jus.uio.no/sisu/man/sisu.1.html'>http://www.jus.uio.no/sisu/man/sisu.1.html</a> > [^25] -<p> * sisu.8 <<a href='http://www.jus.uio.no/sisu/man/sisu.8'>http://www.jus.uio.no/sisu/man/sisu.8</a> +<p> * sisu.8 <<a href='http://www.jus.uio.no/sisu/man/sisu.8.html'>http://www.jus.uio.no/sisu/man/sisu.8.html</a> > [^26] <p> * man directory <<a href='http://www.jus.uio.no/sisu/man'>http://www.jus.uio.no/sisu/man</a> @@ -2940,29 +3019,35 @@ to date as within the package itself: <p> sisu --help --markup <p> 30.3.3 THE HOME PAGE <p> -<<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> +<<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> +> +<p> <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> > <p> <<a href='http://www.jus.uio.no/sisu/SiSU'>http://www.jus.uio.no/sisu/SiSU</a> > -<p> 30.4 MARKUP SAMPLES -<p> A number of markup samples (along with output) are available off: +<p> 30.4 MARKUP SAMPLES +<p> A number of markup samples (along with output) are +available off: <p> <<a href='http://www.jus.uio.no/sisu/SiSU/examples.html'>http://www.jus.uio.no/sisu/SiSU/examples.html</a> > - -<p> Additional markup samples are packaged separately in the file: +<p> Additional +markup samples are packaged separately in the file: <p> <b>*</b> -<p> -On <b>Debian</b> they are available in non-free[^28] to include them it is necessary -to include non-free in your /etc/apt/source.list or obtain them from the -sisu home site. +<p> On <b>Debian</b> they +are available in non-free[^28] to include them it is necessary to include +non-free in your /etc/apt/source.list or obtain them from the sisu home site. + <p> 31. EDITOR FILES, SYNTAX HIGHLIGHTING <p> The directory: - <p> ./data/sisu/v2/conf/editor-syntax-etc/<br> +<p> ./data/sisu/v3/conf/editor-syntax-etc/<br> + <p> /usr/share/sisu/v2/conf/editor-syntax-etc<br> +<p> /usr/share/sisu/v3/conf/editor-syntax-etc<br> + <p> contains rudimentary sisu syntax highlighting files for: <p> * (g)vim <<a href='http://www.vim.org'>http://www.vim.org</a> @@ -3047,6 +3132,7 @@ breaks<br> <p> to file ~/.emacs add the following 2 lines:<br> <p> (add-to-list ’load-path<br> + "/usr/share/sisu/v2/conf/editor-syntax-etc/emacs")<br> <p> (require ’sisu-mode.el)<br> @@ -3092,29 +3178,29 @@ create new ones). <p> 33. SUMMARY OF FEATURES <p> * sparse/minimal markup (clean utf-8 source texts). Documents are prepared in a single UTF-8 file using a -minimalistic mnemonic syntax. Typical literature, documents like headers -are optional. -<p> * markup is easily readable/parsable by the human eye, (basic -markup is simpler and more sparse than the most basic HTML), [this may - also be converted to XML representations of the same input/source document]. - -<p> * markup defines document structure (this may be done once in a header -pattern-match description, or for heading levels individually); basic text -attributes (bold, italics, underscore, strike-through etc.) as required; -and semantic information related to the document (header information, extended -beyond the Dublin core and easily further extended as required); the headers -may also contain processing instructions. <b>SiSU</b> markup is primarily an abstraction -of document structure and document metadata to permit taking advantage -of the basic strengths of existing alternative practical standard ways -of representing documents [be that paper publication, sql search etc.] (html, -epub, xml, odf, latex, pdf, sql) -<p> * for output produces reasonably elegant -output of established industry and institutionally accepted open standard -formats.[3] takes advantage of the different strengths of various standard -formats for representing documents, amongst the output formats currently -supported are: -<p> * html - both as a single scrollable text and a segmented -document<br> +minimalistic mnemonic syntax. Typical literature, documents like "War and +Peace" require almost no markup, and most of the headers are optional. +<p> + * markup is easily readable/parsable by the human eye, (basic markup is +simpler and more sparse than the most basic HTML), [this may also be converted + to XML representations of the same input/source document]. +<p> * markup defines +document structure (this may be done once in a header pattern-match description, +or for heading levels individually); basic text attributes (bold, italics, +underscore, strike-through etc.) as required; and semantic information related +to the document (header information, extended beyond the Dublin core and +easily further extended as required); the headers may also contain processing +instructions. <b>SiSU</b> markup is primarily an abstraction of document structure +and document metadata to permit taking advantage of the basic strengths +of existing alternative practical standard ways of representing documents +[be that paper publication, sql search etc.] (html, epub, xml, odf, latex, +pdf, sql) +<p> * for output produces reasonably elegant output of established +industry and institutionally accepted open standard formats.[3] takes advantage +of the different strengths of various standard formats for representing +documents, amongst the output formats currently supported are: +<p> * html +- both as a single scrollable text and a segmented document<br> <p> * xhtml<br> @@ -3131,8 +3217,8 @@ as<br> <p> * pdf (via LaTeX)<br> <p> * sql - population of an sql database, (at the same object level that -is<br> - used to cite text within a document)<br> +is used<br> + to cite text within a document)<br> <p> Also produces: concordance files; document content certificates (md5 or sha256 digests of headings, paragraphs, images etc.) and html manifests @@ -3158,62 +3244,66 @@ the output information provides the object/paragraph numbers which are relevant across all generated outputs; it is also possible to look at just the matching paragraphs of the documents in the database; [output indexing also work well with search indexing tools like hyperestraier]. -<p> <b>*</b>long<b>term</b>maintainability<b>of</b>document<b>collections</b>in<b>a</b>world<b>of</b>changing -formats, having a very sparsely marked-up source document base. there is -a considerable degree of future-proofing, output representations are upgradeable -(open document text) module in 2006, epub in 2009 and in future html5 output -sometime in future, without modification of existing prepared texts -<p> * -SQL search aside, documents are generated as required and static once generated. - -<p> * documents produced are static files, and may be batch processed, this -needs to be done only once but may be repeated for various reasons as desired -(updated content, addition of new output formats, updated technology document -presentations/representations) -<p> * document source (plaintext utf-8) if - -<p>shared on the net may be used as input and processed locally to produce - -<p>the different document outputs -<p> * document source may be bundled together -(automatically) with associated documents (multiple language versions or -master document with inclusions) and images and sent as a zip file called -a sisupod, if shared on the net these too may be processed locally to produce - -<p>the desired document outputs -<p> * generated document outputs may automatically -be posted to remote sites. -<p> * for basic document generation, the only software -dependency is <b>Ruby</b> , and a few standard Unix tools (this covers plaintext, -HTML, EPUB, XML, ODF, LaTeX). To use a database you of course need that, -and to convert the LaTeX generated to pdf, a latex processor like tetex -or texlive. -<p> * as a developers tool it is flexible and extensible -<p> Syntax -highlighting for <b>SiSU</b> markup is available for a number of text editors. - -<p> <b>SiSU</b> is less about document layout than about finding a way with little -markup to be able to construct an abstract representation of a document -that makes it possible to produce multiple representations of it which -may be rather different from each other and used for different purposes, -whether layout and publishing, or search of content -<p> i.e. to be able to -take advantage from this minimal preparation starting point of some of -the strengths of rather different established ways of representing documents -for different purposes, whether for search (relational database, or indexed -flat files generated for that purpose whether of complete documents, or -say of files made up of objects), online viewing (e.g. html, xml, pdf), or -paper publication (e.g. pdf)... -<p> the solution arrived at is by extracting structural -information about the document (about headings within the document) and -by tracking objects (which are serialized and also given hash values) in -the manner described. It makes possible representations that are quite different -from those offered at present. For example objects could be saved individually -and identified by their hashes, with an index of how the objects relate -to each other to form a document. +<p> * long +term maintainability of document collections in a world of changing formats, +having a very sparsely marked-up source document base. there is a considerable +degree of future-proofing, output representations are "upgradeable", and +new document formats may be added. e.g. addition of odf (open document text) +module in 2006, epub in 2009 and in future html5 output sometime in future, + +<p>without modification of existing prepared texts +<p> * SQL search aside, documents +are generated as required and static once generated. +<p> * documents produced +are static files, and may be batch processed, this needs to be done only +once but may be repeated for various reasons as desired (updated content, +addition of new output formats, updated technology document presentations/representations) + +<p> * document source (plaintext utf-8) if shared on the net may be used as + +<p>input and processed locally to produce the different document outputs +<p> + * document source may be bundled together (automatically) with associated +documents (multiple language versions or master document with inclusions) +and images and sent as a zip file called a sisupod, if shared on the net + +<p>these too may be processed locally to produce the desired document outputs + +<p> * generated document outputs may automatically be posted to remote sites. + +<p> * for basic document generation, the only software dependency is <b>Ruby</b> +, and a few standard Unix tools (this covers plaintext, HTML, EPUB, XML, +ODF, LaTeX). To use a database you of course need that, and to convert the +LaTeX generated to pdf, a latex processor like tetex or texlive. +<p> * as + +<p>a developers tool it is flexible and extensible +<p> Syntax highlighting for +<b>SiSU</b> markup is available for a number of text editors. +<p> <b>SiSU</b> is less about +document layout than about finding a way with little markup to be able +to construct an abstract representation of a document that makes it possible +to produce multiple representations of it which may be rather different +from each other and used for different purposes, whether layout and publishing, + +<p>or search of content +<p> i.e. to be able to take advantage from this minimal +preparation starting point of some of the strengths of rather different +established ways of representing documents for different purposes, whether +for search (relational database, or indexed flat files generated for that +purpose whether of complete documents, or say of files made up of objects), +online viewing (e.g. html, xml, pdf), or paper publication (e.g. pdf)... +<p> the +solution arrived at is by extracting structural information about the document +(about headings within the document) and by tracking objects (which are +serialized and also given hash values) in the manner described. It makes +possible representations that are quite different from those offered at +present. For example objects could be saved individually and identified +by their hashes, with an index of how the objects relate to each other +to form a document. <p> 34. HELP SOURCES -<p> For a summary of alternative -ways to get help on <b>SiSU</b> try one of the following: +<p> For a summary of alternative ways +to get help on <b>SiSU</b> try one of the following: <p> <b>man page</b> <p> man sisu_help<br> @@ -3237,6 +3327,28 @@ listed here: <p> 34.1.1 MAN <p> man sisu<br> +<p> man sisu-concordance<br> + +<p> man sisu-epub<br> + +<p> man sisu-git<br> + +<p> man sisu-harvest<br> + +<p> man sisu-html<br> + +<p> man sisu-odf<br> + +<p> man sisu-pdf<br> + +<p> man sisu-pg<br> + +<p> man sisu-po<br> + +<p> man sisu-sqlite<br> + +<p> man sisu-txt<br> + <p> man 7 sisu_complete<br> <p> man 7 sisu_pdf<br> @@ -3252,8 +3364,8 @@ listed here: <p> 34.2 SISU GENERATED OUTPUT - LINKS TO HTML <p> Note <b>SiSU</b> documentation is prepared in <b>SiSU</b> and output is available in multiple formats including -amongst others html, pdf, odf and epub which may be also be accessed via -the html pages[^28] +amongst others html, pdf, odf and epub, which may be also be accessed via +the html pages[^29] <p> 34.2.1 WWW.SISUDOC.ORG <p> <<a href='http://sisudoc.org/sisu/sisu_manual/index.html'>http://sisudoc.org/sisu/sisu_manual/index.html</a> > @@ -3261,94 +3373,19 @@ the html pages[^28] <p> <<a href='http://sisudoc.org/sisu/sisu_manual/index.html'>http://sisudoc.org/sisu/sisu_manual/index.html</a> ><br> -<p> <<a href='http://sisudoc.org/sisu/sisu_commands/index.html'>http://sisudoc.org/sisu/sisu_commands/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_complete/index.html'>http://sisudoc.org/sisu/sisu_complete/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_configuration/index.html'>http://sisudoc.org/sisu/sisu_configuration/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_description/index.html'>http://sisudoc.org/sisu/sisu_description/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_examples/index.html'>http://sisudoc.org/sisu/sisu_examples/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_faq/index.html'>http://sisudoc.org/sisu/sisu_faq/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_filetypes/index.html'>http://sisudoc.org/sisu/sisu_filetypes/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_help/index.html'>http://sisudoc.org/sisu/sisu_help/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_help_sources/index.html'>http://sisudoc.org/sisu/sisu_help_sources/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_howto/index.html'>http://sisudoc.org/sisu/sisu_howto/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_introduction/index.html'>http://sisudoc.org/sisu/sisu_introduction/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_manual/index.html'>http://sisudoc.org/sisu/sisu_manual/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_markup/index.html'>http://sisudoc.org/sisu/sisu_markup/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_output_overview/index.html'>http://sisudoc.org/sisu/sisu_output_overview/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_pdf/index.html'>http://sisudoc.org/sisu/sisu_pdf/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_postgresql/index.html'>http://sisudoc.org/sisu/sisu_postgresql/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_quickstart/index.html'>http://sisudoc.org/sisu/sisu_quickstart/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_remote/index.html'>http://sisudoc.org/sisu/sisu_remote/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_search/index.html'>http://sisudoc.org/sisu/sisu_search/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_skin/index.html'>http://sisudoc.org/sisu/sisu_skin/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_sqlite/index.html'>http://sisudoc.org/sisu/sisu_sqlite/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_syntax_highlighting/index.html'>http://sisudoc.org/sisu/sisu_syntax_highlighting/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_vim/index.html'>http://sisudoc.org/sisu/sisu_vim/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu/sisu_webrick/index.html'>http://sisudoc.org/sisu/sisu_webrick/index.html</a> -><br> - <p> 34.3 MAN2HTML <p> 34.3.1 LOCALLY INSTALLED -<p> <file:///usr/share/doc/sisu/v2/html/sisu.1.html> - -<p> <file:///usr/share/doc/sisu/v2/html/sisu_help.1.html> -<p> <file:///usr/share/doc/sisu/v2/html/sisu_help_sources.1.html> +<p> file:///usr/share/doc/sisu/html/sisu.1.html -<p> /usr/share/doc/sisu/v2/html/sisu.1.html<br> +<p> file:///usr/share/doc/sisu/html/sisu.1.html<br> -<p> /usr/share/doc/sisu/v2/html/sisu_pdf.7.html<br> +<p> file:///usr/share/doc/sisu/html/sisu_pdf.7.html<br> -<p> /usr/share/doc/sisu/v2/html/sisu_postgresql.7.html<br> +<p> file:///usr/share/doc/sisu/html/sisu_postgresql.7.html<br> -<p> /usr/share/doc/sisu/v2/html/sisu_sqlite.7.html<br> +<p> file:///usr/share/doc/sisu/html/sisu_sqlite.7.html<br> -<p> /usr/share/doc/sisu/v2/html/sisu_webrick.1.html<br> +<p> file:///usr/share/doc/sisu/html/sisu_webrick.1.html<br> <p> 34.3.2 WWW.JUS.UIO.NO/SISU <p> <<a href='http://www.jus.uio.no/sisu/man/sisu.1.html'>http://www.jus.uio.no/sisu/man/sisu.1.html</a> @@ -3417,47 +3454,51 @@ insert multiple asterisks if required </dd> <dt><b>+2.</b> </dt> <dd>editors -notes, numbered asterisk footnote/endnote series </li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/'>http://www.jus.uio.no/sisu/</a> +notes, numbered asterisk footnote/endnote series </li><b>.</b><li><<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> > -</li><b>.</b><li><<a href='http://www.ruby-lang.org/en/'>http://www.ruby-lang.org/en/</a> -> </li><b>.</b><li>Table from the Wealth of Networks by Yochai Benkler -<<a href='http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler'>http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler</a> -> </li><b>.</b><li>.ssc (for composite) -is under consideration but ._sst makes clear that this is not a regular -file to be worked on, and thus less likely that people will have processing. -It may be however that when the resulting file is shared .ssc is an appropriate -suffix to use. </li><b>.</b><li><<a href='http://www.postgresql.org/'>http://www.postgresql.org/</a> + +<p> </li><b>.</b><li><<a href='http://www.ruby-lang.org/en/'>http://www.ruby-lang.org/en/</a> +> </li><b>.</b><li>Table from the Wealth of Networks by Yochai +Benkler <<a href='http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler'>http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler</a> +> </li><b>.</b><li>.ssc +(for composite) is under consideration but ._sst makes clear that this is +not a regular file to be worked on, and thus less likely that people will +have "accidents", working on a .ssc file that is overwritten by subsequent +processing. It may be however that when the resulting file is shared .ssc +is an appropriate suffix to use. </li><b>.</b><li><<a href='http://www.postgresql.org/'>http://www.postgresql.org/</a> > <<a href='http://advocacy.postgresql.org/'>http://advocacy.postgresql.org/</a> -> <<a href='http://en.wikipedia.org/wiki/Postgresql'>http://en.wikipedia.org/wiki/Postgresql</a> > -</li><b>.</b><li><<a href='http://www.hwaci.com/sw/sqlite/'>http://www.hwaci.com/sw/sqlite/</a> +<<a href='http://en.wikipedia.org/wiki/Postgresql'>http://en.wikipedia.org/wiki/Postgresql</a> +> </li><b>.</b><li><<a href='http://www.hwaci.com/sw/sqlite/'>http://www.hwaci.com/sw/sqlite/</a> > <<a href='http://en.wikipedia.org/wiki/Sqlite'>http://en.wikipedia.org/wiki/Sqlite</a> -> </li><b>.</b><li><<a href='http://search.sisudoc.org'>http://search.sisudoc.org</a> > -</li><b>.</b><li>(which could be extended further with current back-end). As regards scaling -of the database, it is as scalable as the database (here Postgresql) and -hardware allow. </li><b>.</b><li>of this feature when demonstrated to an IBM software innovations -evaluator in 2004 he said to paraphrase: this could be of interest to us. -We have large document management systems, you can search hundreds of thousands -of documents and we can tell you which documents meet your search criteria, -but there is no way we can tell you without opening each document where -within each your matches are found. </li><b>.</b><li>There is nothing to stop MySQL support -being added in future. </li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man/sisu.1'>http://www.jus.uio.no/sisu/man/sisu.1</a> -> </li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man/sisu.8'>http://www.jus.uio.no/sisu/man/sisu.8</a> +</li><b>.</b><li><<a href='http://search.sisudoc.org'>http://search.sisudoc.org</a> +> </li><b>.</b><li>(which could be extended further with current back-end). +As regards scaling of the database, it is as scalable as the database (here +Postgresql) and hardware allow. </li><b>.</b><li>of this feature when demonstrated to an +IBM software innovations evaluator in 2004 he said to paraphrase: this +could be of interest to us. We have large document management systems, you +can search hundreds of thousands of documents and we can tell you which +documents meet your search criteria, but there is no way we can tell you +without opening each document where within each your matches are found. +</li><b>.</b><li>There is nothing to stop MySQL support being added in future. </li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man/sisu.1.html'>http://www.jus.uio.no/sisu/man/sisu.1.html</a> +> + +<p> </li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man/sisu.8.html'>http://www.jus.uio.no/sisu/man/sisu.8.html</a> > -</li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man'>http://www.jus.uio.no/sisu/man</a> -> </li><b>.</b><li>the <b>Debian</b> Free Software guidelines require -that everything distributed within <b>Debian</b> can be changed - and the documents -are authors’ works that while freely distributable are not freely changeable. -</li><b>.</b><li> -<p>named index.html or more extensively through sisu_manifest.html +<p> </li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man'>http://www.jus.uio.no/sisu/man</a> +> </li><b>.</b> +<li>the <b>Debian</b> Free Software guidelines require that everything distributed +within <b>Debian</b> can be changed - and the documents are authors’ works that +while freely distributable are not freely changeable. </li><b>.</b><li>named index.html or + +<p>more extensively through sisu_manifest.html <p> </li> </ol> <h2><a name='sect2' href='#toc2'>See Also</a></h2> <a href='http:~/bin/man2html?sisu:1'><i>sisu</i>(1)</a> -, -<br> +, <br> <a href='http:~/bin/man2html?sisu-epub:1'><i>sisu-epub</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-harvest:1'><i>sisu-harvest</i>(1)</a> @@ -3475,12 +3516,10 @@ are authors’ works that while freely distributable are not freely changeab <a href='http:~/bin/man2html?sisu-txt:1'><i>sisu-txt</i>(1)</a> . <br> <a href='http:~/bin/man2html?sisu_vim:7'><i>sisu_vim</i>(7)</a> - <br> -<a href='http:~/bin/man2html?sisu:8'><i>sisu</i>(8)</a> <p> <h2><a name='sect3' href='#toc3'>Homepage</a></h2> -More information about <b>SiSU</b> can be found at <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> +More information about <b>SiSU</b> can be found at <<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a> >. <p> diff --git a/data/doc/sisu/html/sisu.8.html b/data/doc/sisu/html/sisu.8.html deleted file mode 100644 index 4c81d9c3..00000000 --- a/data/doc/sisu/html/sisu.8.html +++ /dev/null @@ -1,273 +0,0 @@ - <!-- manual page source format generated by PolyglotMan v3.2, --> -<!-- available at http://polyglotman.sourceforge.net/ --> - -<html> -<head> -<title>sisu(8) manual page</title> -</head> -<body bgcolor='white'> -<a href='#toc'>Table of Contents</a><p> - -<h2><a name='sect0' href='#toc0'>Name</a></h2> -<b>SiSU</b> - Structured information, Serialized Units - a document -publishing system -<h2><a name='sect1' href='#toc1'>Synopsis</a></h2> -<b>sisu</b> <b>[-mhwpxXv...] [</b> <i>filename/wildcard</i> <b>]</b> -<h2><a name='sect2' href='#toc2'>Description</a></h2> -A -document publishing system, that from a simple single marked-up document, -produces a multitude of output formats including: html, latex, pdf, info, -and sql output, which can be cross referenced as having the same document -structure and text object numbering, "object citation numbering". Features -include its’ simple syntax; the semantic tagging of documents; document -management; built to be associated with a revision control system; text -object numbering for the identification of a texts location in any of the -output formats, easy skinning on a site wide, or per document basis; granular -search; a degree of future proofing ... for more see <i>man</i> 1 sisu or <i><<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> -></i> -<p> -<b>SiSU is a way of preparing, publishing, managing and searching documents.</b> - -<h2><a name='sect3' href='#toc3'>Installation</a></h2> -<p> -Up to date information on SiSU downloads, and their installation -should be available from: <i><<a href='http://www.jus.uio.no/sisu/SiSU/download.html'>http://www.jus.uio.no/sisu/SiSU/download.html</a> -></i> or -at: <i><<a href='http://www.jus.uio.no/sisu/sisu_download/download.html'>http://www.jus.uio.no/sisu/sisu_download/download.html</a> -></i> <p> -There you should -find links to the latest source tarball, and instructions on how to install -SiSU. <p> -Sample marked up documents are are available at <i>/usr/share/doc/sisu/sisu_markup_samples/dfsg</i> -or equivalent directory, or online, see <i><<a href='http://www.jus.uio.no/sisu/SiSU/2.html'>http://www.jus.uio.no/sisu/SiSU/2.html</a> -></i> -<p> -<i>man</i> 1 sisu has a syntax table along with processing commands. <p> -SiSU also -provides some help via the command: <i>sisu</i> --help and selecting an appropriate -subject, e.g. <p> -<i>sisu</i> --help commands <p> -<i>sisu</i> --help markup <p> -<i>sisu</i> --help headers <p> -<i>sisu</i> ---help env <p> -The rest of this note is on post installation setup -<h2><a name='sect4' href='#toc4'>Post Installation -Setup - Quick start</a></h2> -<p> - -<p> After installation of sisu-complete, move to the document -samples directory, <p> - cd /usr/share/doc/sisu/sisu_markup_samples/dfsg<br> - <p> -[this is not where you would normally work but provides sample documents -for testing, you may prefer instead to copy the contents of that directory -to a local directory before proceeding] <p> -and in that directory, initialise -the output directory with the command <p> -<i>sisu</i> -CC <p> -then run: <p> -<i>sisu</i> -1 free_as_in_freedom.rms_and_free_software.sam_williams.sst -<p> -or the same: <p> -<i>sisu</i> -NhwpoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst -<p> -look at output results, see the "sisu_manifest" page created for the document -<p> -for an overview of your current sisu setup, type: <p> -<i>sisu</i> --help env <p> -or <p> -<i>sisu</i> --V <p> -To generate a document from a remote url accessible location move to -a writable directory, (create a work directory and cd into it) as the file -will be downloaded there and e.g. <p> -<i>sisu</i> -1 <a href='http://www.jus.uio.no/sisu/gpl3.fsf/gpl3.fsf.sst'>http://www.jus.uio.no/sisu/gpl3.fsf/gpl3.fsf.sst</a> - -<p> -<i>sisu</i> -3 <a href='http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst'>http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst</a> - -<p> -examine source document, vim has syntax highlighting support <p> -gvim free_as_in_freedom.rms_and_free_software.sam_williams.sst -<p> -additional markup samples in <i><<a href='http://www.jus.uio.no/sisu/SiSU/2.html'>http://www.jus.uio.no/sisu/SiSU/2.html</a> -></i> <p> -it should -also be possible to run sisu against sisupods (prepared zip files, created -by running the command sisu -S [filename]), whether stored locally or remotely. -<p> -<i>sisu</i> -3 <a href='http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip'>http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip</a> - <p> -there -is a security issue associated with the running of document skins that -are not your own, so these are turned of by default, and the use of the -following command, which switches on the associated skin is not recommended: -<p> -<i>sisu</i> -3 --trust <a href='http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip'>http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip</a> - -<p> -For help <i>man</i> sisu <p> -<i>sisu</i> --help <p> -<i>sisu</i> --help env for the way sisu "sees/maps" -your system <p> -<i>sisu</i> --help commands for list of commands and so on <p> - <b>Document -markup directory</b> <p> -Perhaps the easiest way to begin is to create a directory -for sisu marked up documents within your home directory, and copy the file -structure (and document samples) provided in the document sample directory: -<i>mkdir</i> ~/sisu_test <p> -<i>cd</i> ~/sisu_test <p> -<i>cp</i> -a /usr/share/doc/sisu/sisu_markup_samples/dfsg/* -~/sisu_test/. <p> -<b>----------</b> <p> -<b>Tip:</b> the markup syntax examples may be of interest <i><<a href='http://www.jus.uio.no/sisu/sample/'>http://www.jus.uio.no/sisu/sample/</a> -></i> -<p> -<b>Tip:</b> <i>sisu</i> -U [sisu markup filename] should printout the different possible -outputs and where sisu would place them. <p> -<b>Tip:</b> if you want to toggle ansi -color add <i>c</i> to your flags. <p> -<b>----------</b> <p> - <b>SiSU configuration file search path is:</b> <p> -<i>./_sisu/sisurc.yaml</i> -<p> -<i>~/.sisu/sisurc.yaml</i> <p> -<i>/etc/sisu/sisurc.yaml</i> <p> - -<h2><a name='sect5' href='#toc5'>Debian INSTALLATION Note</a></h2> -<p> -It is best -you see <i><<a href='http://www.jus.uio.no/sisu/SiSU/download.html#debian'>http://www.jus.uio.no/sisu/SiSU/download.html#debian</a> -></i> for up the most -up to date information. <p> -notes taken from the Debian control file (end edited), -gives an idea of additional packages that SiSU can make use of if available, -(the use/requirement of some of which are interdependent for specific actions -by SiSU): <p> -Package: sisu <p> -Depends: ruby (>= 1.8.2), libwebrick-ruby, unzip, zip -<p> -Conflicts: vim-sisu, sisu-vim, sisu-remote <p> -Replaces: vim-sisu, sisu-vim <p> -Recommends: -sisu-pdf, sisu-sqlite, sisu-postgresql, librmagick-ruby, trang, tidy, librexml-ruby, -openssl, rsync, openssh-client lsh-client, keychain, hyperestraier, kdissert -Suggests: rcs cvs, lv, texinfo, pinfo <p> -Package: sisu-complete <p> -Depends: ruby -(>= 1.8.2), sisu, sisu-pdf, sisu-postgresql, sisu-sqlite <p> -Recommends: hyperestraier -<p> -Package: sisu-pdf <p> -Depends: sisu, texlive-latex-base, texlive-fonts-recommended, -texlive-latex-recommended, texlive-latex-extra <p> -Suggests: evince, xpdf <p> -Package: -sisu-postgresql <p> -Depends: sisu, libdbd-pg-ruby, libdbi-ruby, libdbm-ruby, postgresql -<p> -Recommends: libfcgi-ruby <p> -Package: sisu-sqlite <p> -Depends: sisu, sqlite, libdbd-sqlite-ruby, -libdbi-ruby, libdbm-ruby <p> -Recommends: libfcgi-ruby <p> -Package: sisu-markup-samples -<p> -Depends: sisu <p> - -<h2><a name='sect6' href='#toc6'>Package Description</a></h2> -<b>sisu</b> <p> -Description: documents - structuring, -publishing in multiple formats and search <p> -SiSU is a lightweight markup -based, command line oriented, document structuring, publishing and search -framework for document collections. <p> -With minimal preparation of a plain-text, -(UTF-8) file, using its native markup syntax in your text editor of choice, -SiSU can generate various document formats (most of which share a common -object numbering system for locating content), including plain text, HTML, -XHTML, XML, OpenDocument text (ODF:ODT), LaTeX, PDF files, and populate -an SQL database with objects (roughly paragraph-sized chunks) so searches -may be performed and matches returned with that degree of granularity: -your search criteria is met by these documents and at these locations within -each document. Object numbering is particularly suitable for "published" -works (finalized texts as opposed to works that are frequently changed -or updated) for which it provides a fixed means of reference of content. -Document outputs also share semantic meta-data provided. <p> -SiSU also provides -concordance files, document content certificates and manifests of generated -output. <p> -A vim syntax highlighting file and an ftplugin with folds for sisu -markup is provided, as are syntax highlighting files for kate, kwrite, -gedit and diakonos. Vim 7 includes syntax highlighting for SiSU. <p> -man pages, -and interactive help are provided. <p> -Dependencies for various features are -taken care of in sisu related packages. The package sisu-complete installs -the whole of SiSU. <p> -Additional document markup samples are provided in the -package sisu-markup-samples which is found in the non-free archive the licenses -for the substantive content of the marked up documents provided is that -provided by the author or original publisher. <p> -Homepage: <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> -> -</pre> -<h2><a name='sect7' href='#toc7'>Document Resource Configuration</a></h2> -<b>sisu</b> resource configuration information -is obtained from sources (where they exist): <br> -<pre>~/.sisu/sisurc.yaml/etc/sisu/[sisu version]/sisurc.yamlsisu program defaults</pre><p> - -<b>Skins</b> <p> -default document appearance may be modified using skins contained -in sub-directories located at the following paths: <br> -<pre>./_sisu/skin~/.sisu/skin/etc/sisu/skin</pre><p> -more specifically, the following locations -(or their /etc/sisu equivalent) should be used: <p> -<i>~/.sisu/skin/doc</i> skins for -individual documents; <p> -<i>~/.sisu/skin/dir</i> skins for directories of matching -names; <p> -<i>~/.sisu/skin/site</i> site-wide skin modifying the site-wide appearance -of documents. <p> -Usually all skin files are placed in the document skin directory: -<i>~/.sisu/skin/doc</i> with softlinks being made to the skins contained there -from other skin directories as required. -<h2><a name='sect8' href='#toc8'>Further Information</a></h2> -<p> -For more information -on <i>SiSU</i> see: <i><<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> -></i> <p> -or <i>man</i> sisu -<h2><a name='sect9' href='#toc9'>Author</a></h2> -Ralph Amissah <i><ralph@amissah.com></i> -or <i><ralph.amissah@gmail.com></i> -<h2><a name='sect10' href='#toc10'>See Also</a></h2> -<a href='http:~/bin/man2html?sisu:1'><b>sisu(1)</a> -,</b> <a href='http:~/bin/man2html?sisu_examples:1'><b>sisu_examples(1)</a> -,</b> <a href='http:~/bin/man2html?sisu_webrick:1'><b>sisu_webrick(1)</a> -,</b> -<a href='http:~/bin/man2html?sisu_pdf:1'><b>sisu_pdf(1)</b></a> - <a href='http:~/bin/man2html?sisu_sqlite:1'><b>sisu_sqlite(1)</b></a> - <a href='http:~/bin/man2html?sisu_postgresql:1'><b>sisu_postgresql(1)</b></a> - <a href='http:~/bin/man2html?sisu_termsheet:1'><b>sisu_termsheet(1)</a> -,</b> <p> - -<hr><p> -<a name='toc'><b>Table of Contents</b></a><p> -<ul> -<li><a name='toc0' href='#sect0'>Name</a></li> -<li><a name='toc1' href='#sect1'>Synopsis</a></li> -<li><a name='toc2' href='#sect2'>Description</a></li> -<li><a name='toc3' href='#sect3'>Installation</a></li> -<li><a name='toc4' href='#sect4'>Post Installation Setup - Quick start</a></li> -<li><a name='toc5' href='#sect5'>Debian INSTALLATION Note</a></li> -<li><a name='toc6' href='#sect6'>Package Description</a></li> -<li><a name='toc7' href='#sect7'>Document Resource Configuration</a></li> -<li><a name='toc8' href='#sect8'>Further Information</a></li> -<li><a name='toc9' href='#sect9'>Author</a></li> -<li><a name='toc10' href='#sect10'>See Also</a></li> -</ul> -</body> -</html> diff --git a/data/doc/sisu/html/sisu3.1.html b/data/doc/sisu/html/sisu3.1.html new file mode 120000 index 00000000..4b34bf93 --- /dev/null +++ b/data/doc/sisu/html/sisu3.1.html @@ -0,0 +1 @@ +sisu.1.html
\ No newline at end of file diff --git a/data/doc/sisu/html/sisu_vim.7.html b/data/doc/sisu/html/sisu_vim.7.html index f9e18237..b7ee2028 100644 --- a/data/doc/sisu/html/sisu_vim.7.html +++ b/data/doc/sisu/html/sisu_vim.7.html @@ -18,14 +18,9 @@ publishing in multiple standard formats, and search<br> <p> <b>SiSU</b> has syntax highlighting for a number of editors including vim which are documented under: -<p> man sisu_syntax_highlighting<br> +<p> /usr/share/doc/sisu/markup-samples/sisu_manual/sisu_syntax_highlighting.sst<br> -<p> /usr/share/doc/sisu/sisu_manual/sisu_syntax_highlighting/index.html<br> - -<p> <<a href='http://sisudoc.org/sisu_manual/sisu_syntax_highlighting/index.html'>http://sisudoc.org/sisu_manual/sisu_syntax_highlighting/index.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_syntax_highlighting/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_syntax_highlighting/index.html</a> +<p> <<a href='http://www.sisudoc.org/sisu/sisu_manual/sisu_syntax_highlighting/index.html'>http://www.sisudoc.org/sisu/sisu_manual/sisu_syntax_highlighting/index.html</a> ><br> <p> <b>SiSU</b> also provides an ftplugin to provide vim folds for <b>SiSU</b> markup, @@ -51,98 +46,12 @@ on files with the suffix .sst .ssm .ssi .-sst ._sst (and the same with a furthe </pre> <p> FURTHER INFORMATION <p> For more information on <b>SiSU</b> see: -<p> <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> +<p> <<a href='http://sisudoc.org/'>http://sisudoc.org/</a> > -<p> or man sisu -<p> DOCUMENT INFORMATION (METADATA) -<p> METADATA -<p> Document Manifest -@ <<a href='http://sisudoc.org/sisu_manual/sisu_vim/sisu_manifest.html'>http://sisudoc.org/sisu_manual/sisu_vim/sisu_manifest.html</a> -> -<p> <b>Dublin Core</b> -(DC) -<p> <i>DC</i> tags included with this document are provided here. -<p> DC Title: -<i>SiSU</i> - Vim -<p> DC Creator: <i>Ralph</i> Amissah -<p> DC Rights: <i>Copyright</i> (C) Ralph -Amissah 2008, part of SiSU documentation, License GPL 3 -<p> DC Type: <i>information</i> - -<p> DC Date created: <i>2002-11-12</i> -<p> DC Date issued: <i>2002-11-12</i> -<p> DC Date available: - -<p><i>2002-11-12</i> -<p> DC Date modified: <i>2008-02-12</i> -<p> DC Date: <i>2008-02-12</i> -<p> <b>Version Information</b> - -<p> Sourcefile: <i>sisu_vim.sst</i> -<p> Filetype: <i>SiSU</i> text insert 0.58 -<p> Sourcefile -Digest, MD5(sisu_vim.sst)= <i>b5028f957b128162f7653bbd940042ca</i> -<p> Skin_Digest: -MD5(skin_sisu_manual.rb)= <i>072b2584bedea82ea8a416587b9fa244</i> -<p> <b>Generated</b> -<p> - Document (metaverse) last generated: <i>Thu</i> Feb 14 02:44:14 +0000 2008 -<p> -Generated by: <i>SiSU</i> <i>0.64.4</i> of 2008w06/4 (2008-02-14) -<p> Ruby version: <i>ruby</i> 1.8.6 -(2007-09-24 patchlevel 111) [i486-linux] -<p> -<p> -<dl> - -<dt>Other versions of this document: -</dt> -<dd></dd> - -<dt>manifest: <<a href='http://www.jus.uio.no/sisu/sisu_vim/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_vim/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_vim/sisu_manifest.html</a> -</a> -> </dt> -<dd></dd> - -<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_vim/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_vim/toc.html'>http://www.jus.uio.no/sisu/sisu_vim/toc.html</a> -</a> -> -</dt> -<dd></dd> - -<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_vim/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_vim/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_vim/portrait.pdf</a> -</a> -> </dt> -<dd></dd> - -<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_vim/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_vim/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_vim/landscape.pdf</a> -</a> +<p> <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> > -</dt> -<dd></dd> - -<dt>at: <<a href='http://www.jus.uio.no/sisu'><a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> -</a> -> </dt> -<dd></dd> - -<dt>* Generated by: SiSU 0.64.4 of 2008w06/4 (2008-02-14) -</dt> -<dd></dd> - -<dt>* Ruby version: ruby 1.8.6 (2007-09-24 patchlevel 111) [i486-linux] </dt> -<dd></dd> - -<dt>* Last Generated -on: Thu Feb 14 02:44:14 +0000 2008 </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> +<p> or man sisu <p> <hr><p> <a name='toc'><b>Table of Contents</b></a><p> |