diff options
| author | Ralph Amissah <ralph@amissah.com> | 2009-12-19 16:17:09 -0500 |
|---|---|---|
| committer | Ralph Amissah <ralph@amissah.com> | 2009-12-19 16:17:09 -0500 |
| commit | 51e583aac065ba15b7ece31f1d5339ac2dc53254 (patch) | |
| tree | 2683e1cdeed2af57a2a9dce91c968ff6f1e6c723 /data/doc/sisu/v1/html | |
| parent | sisu.vim adjustments (diff) | |
directory structure changes to accommodate the introduction of sisu v2
Diffstat (limited to 'data/doc/sisu/v1/html')
| -rw-r--r-- | data/doc/sisu/v1/html/README | 10 | ||||
| -rw-r--r-- | data/doc/sisu/v1/html/homepage/index.html | 264 | ||||
| -rw-r--r-- | data/doc/sisu/v1/html/sisu.1.html | 3421 | ||||
| -rw-r--r-- | data/doc/sisu/v1/html/sisu.8.html | 273 | ||||
| -rw-r--r-- | data/doc/sisu/v1/html/sisu_complete.7.html | 54 | ||||
| -rw-r--r-- | data/doc/sisu/v1/html/sisu_pdf.7.html | 171 | ||||
| -rw-r--r-- | data/doc/sisu/v1/html/sisu_postgresql.7.html | 198 | ||||
| -rw-r--r-- | data/doc/sisu/v1/html/sisu_sqlite.7.html | 196 | ||||
| -rw-r--r-- | data/doc/sisu/v1/html/sisu_termsheet.1.html | 63 | ||||
| -rw-r--r-- | data/doc/sisu/v1/html/sisu_vim.7.html | 153 | ||||
| -rw-r--r-- | data/doc/sisu/v1/html/sisu_webrick.1.html | 169 |
11 files changed, 4972 insertions, 0 deletions
diff --git a/data/doc/sisu/v1/html/README b/data/doc/sisu/v1/html/README new file mode 100644 index 00000000..a4263458 --- /dev/null +++ b/data/doc/sisu/v1/html/README @@ -0,0 +1,10 @@ +this "html" directory contains SiSU man pages in html +- generated from man pages using man2html + +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/v1/html/homepage/index.html b/data/doc/sisu/v1/html/homepage/index.html new file mode 100644 index 00000000..8493cffd --- /dev/null +++ b/data/doc/sisu/v1/html/homepage/index.html @@ -0,0 +1,264 @@ +<!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/v1/html/sisu.1.html b/data/doc/sisu/v1/html/sisu.1.html new file mode 100644 index 00000000..faf8069c --- /dev/null +++ b/data/doc/sisu/v1/html/sisu.1.html @@ -0,0 +1,3421 @@ +<!-- manual page source format generated by PolyglotMan v3.2, --> +<!-- available at http://polyglotman.sourceforge.net/ --> + +<html> +<head> +<title>"sisu"("1") manual page</title> +</head> +<body bgcolor='white'> +<a href='#toc'>Table of Contents</a><p> + +<h2><a name='sect0' href='#toc0'>Name</a></h2> +sisu - documents: markup, structuring, publishing in multiple standard +formats, and search +<h2><a name='sect1' href='#toc1'>Synopsis</a></h2> +sisu [-abcDdFHhIiMmNnopqRrSsTtUuVvwXxYyZz0-9] +[filename/wildcard ] sisu [-Ddcv] [instruction] sisu [-CcFLSVvW] 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 +is to cope with medium to large document sets with evolving markup related +technologies, which should be prepared once, and for which you want multiple +output formats that can be updated and a common mechanism for cross-output-format +citation, and search. +<p> <b>SiSU</b> both defines a markup syntax and provides an +engine that produces open standards format outputs from documents prepared +with <b>SiSU</b> markup. From a single lightly prepared document sisu custom builds +several standard output formats which share a common (text object) numbering +system for citation of content within a document (that also has implications +for search). The sisu engine works with an abstraction of the document’s +structure and content from which it is possible to generate different forms +of representation of the document. Significantly <b>SiSU</b> markup is more sparse +than html and outputs which include html, LaTeX, landscape and portrait +pdfs, Open Document Format (ODF), all of which can be added to and updated. +<b>SiSU</b> is also able to populate SQL type databases at an object level, which +means that searches can be made with that degree of granularity. +<p> Source +document preparation and output generation is a two step process: (i) document +source is prepared, that is, marked up in sisu markup syntax and (ii) the +desired output subsequently generated by running the sisu engine against +document source. Output representations if updated (in the sisu engine) +can be generated by re-running the engine against the prepared source. Using +<b>SiSU</b> markup applied to a document, <b>SiSU</b> custom builds (to take advantage +of the strengths of different ways of representing documents) various standard +open output formats including plain text, HTML, XHTML, XML, OpenDocument, +LaTeX or PDF files, and populate an SQL database with objects[^1] (equating +generally to paragraph-sized chunks) so searches may be performed and matches +returned with that degree of granularity ( e.g. your search criteria is met +by these documents and at these locations within each document). Document +output formats share a common object numbering system for locating content. +This is particularly suitable for works (finalized texts as opposed to +works that are frequently changed or updated) for which it provides a fixed +means of reference of content. +<p> In preparing a <b>SiSU</b> document you optionally +provide semantic information related to the document in a document header, +and in marking up the substantive text provide information on the structure +of the document, primarily indicating heading levels and footnotes. You +also provide information on basic text attributes where used. The rest is +automatic, sisu from this information custom builds[^2] the different forms +of output requested. +<p> <b>SiSU</b> works with an abstraction of the document based +on its structure which is comprised of its structure (or frame)[^3] and +the objects[^4] it contains, which enables <b>SiSU</b> to represent the document +in many different ways, and to take advantage of the strengths of different +ways of presenting documents. The objects are numbered, and these numbers +can be used to provide a common base for citing material within a document +across the different output format types. This is significant as page numbers +are not well suited to the digital age, in web publishing, changing a browser’s +default font or using a different browser means that text appears on different +pages; and in publishing in different formats, html, landscape and portrait +pdf etc. again page numbers are of no use to cite text in a manner that +is relevant against the different output types. Dealing with documents at +an object level together with object numbering also has implications for +search. +<p> One of the challenges of maintaining documents is to keep them +in a format that would allow users to use them without depending on a proprietary +software popular at the time. Consider the ease of dealing with legacy proprietary +formats today and what guarantee you have that old proprietary formats +will remain (or can be read without proprietary software/equipment) in +15 years time, or the way the way in which html has evolved over its relatively +short span of existence. <b>SiSU</b> provides the flexibility of outputing documents +in multiple non-proprietary open formats including html, pdf[^5] and the +ISO standard ODF.[^6] Whilst <b>SiSU</b> relies on software, the markup is uncomplicated +and minimalistic which guarantees that future engines can be written to +run against it. It is also easily converted to other formats, which means +documents prepared in <b>SiSU</b> can be migrated to other document formats. Further +security is provided by the fact that the software itself, <b>SiSU</b> is available +under GPL3 a licence that guarantees that the source code will always be +open, and free as in libre which means that that code base can be used, +updated and further developed as required under the terms of its license. +Another challenge is to keep up with a moving target. <b>SiSU</b> permits new forms +of output to be added as they become important, (Open Document Format text +was added in 2006 when it became an ISO standard for office applications +and the archival of documents), and existing output to be updated (html +has evolved and the related module has been updated repeatedly over the +years, presumably when the World Wide Web Consortium (w3c) finalises html +5 which is currently under development, the html module will again be updated +allowing all existing documents to be regenerated as html 5). +<p> The document +formats are written to the file-system and available for indexing by independent +indexing tools, whether off the web like Google and Yahoo or on the site +like Lucene and Hyperestraier. +<p> <b>SiSU</b> also provides other features such +as concordance files and document content certificates, and the working +against an abstraction of document structure has further possibilities +for the research and development of other document representations, the +availability of objects is useful for example for topic maps and the commercial +law thesaurus by Vikki Rogers and Al Krtizer, together with the flexibility +of <b>SiSU</b> offers great possibilities. +<p> <b>SiSU</b> is primarily for published works, +which can take advantage of the citation system to reliably reference its +documents. <b>SiSU</b> works well in a complementary 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> +> +<p> 2. +COMMANDS SUMMARY +<p> 2.1 SYNOPSIS +<p> <b>SiSU</b> - Structured information, Serialized +Units - a document publishing system +<p> sisu [ -abcDdFHhIiMmNnopqRrSsTtUuVvwXxYyZz0-9 + ] [ filename/ wildcard ] +<p> sisu [ -Ddcv ] [ instruction ] +<p> sisu [ -CcFLSVvW + ] +<p> Note: commands should be issued from within the directory that contains +the marked up files, cd to markup directory. +<p> 2.2 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, LaTeX, +pdf, xhtml, XML, info, and SQL (PostgreSQL and SQLite), which share numbered +text objects ( structure information. For more see: <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> +> + +<p> 2.3 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) +<p> </dd> + +<dt><b>-b [filename/wildcard]</b> </dt> +<dd>produces xhtml/XML +output for browser viewing (sax parsing). +<p> </dd> + +<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>-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. +<p> </dd> + +<dt><b>-c [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). +<p> </dd> + +<dt><b>-D [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. +<p> </dd> + +<dt><b>-d [--db-[database type (sqlite|pg)]] +--[instruction] [filename]</b> </dt> +<dd>database type default set to sqlite, (for which +--sqlite may be used instead) or to specify another database --db-[pgsql, sqlite] +(however see -D) possible instructions include: --createdb; --create; --dropall; +--import [filename]; --update [filename]; --remove [filename]; see database section +below. +<p> </dd> + +<dt><b>-F [--webserv=webrick]</b> </dt> +<dd>generate examples of (naive) cgi search form +for sqlite and pgsql depends on your already having used sisu to populate +an sqlite and/or pgsql database, (the sqlite version scans the output directories +for existing sisu_sqlite databases, so it is first necessary to create +them, before generating the search form) see -d -D and the database section +below. If the optional parameter --webserv=webrick is passed, the cgi examples +created will be set up to use the default port set for use by the webrick +server, (otherwise the port is left blank and the system setting used, +usually 80). The samples are dumped in the present work directory which +must be writable, (with screen instructions given that they be copied to +the cgi-bin directory). -Fv (in addition to the above) provides some information + +<p>on setting up hyperestraier for sisu +<p> </dd> + +<dt><b>-H [filename/wildcard]</b> </dt> +<dd>produces html +without link suffixes (.html .pdf etc.) ( an appropriately configured web +server. [behaviour switched after 0.35 see -h]. +<p> </dd> + +<dt><b>-h [filename/wildcard]</b> </dt> +<dd>produces +html (with hardlinks i.e. with name suffixes in links/local urls). html, with +internal document links that include the document suffix, i.e. whether it +is .html or .pdf (required for browsing directly off a file system, and works +with most web servers). [behaviour switched after 0.35 see -H]. +<p> </dd> + +<dt><b>-I [filename/wildcard]</b> +</dt> +<dd>produces texinfo and info file, (view with pinfo). +<p> </dd> + +<dt><b>-i [filename/wildcard]</b> +</dt> +<dd>produces man page of file, not suitable for all outputs. +<p> </dd> + +<dt><b>-L</b> </dt> +<dd>prints license +information. +<p> </dd> + +<dt><b>-M [filename/wildcard/url]</b> </dt> +<dd>maintenance mode files created for +processing preserved and their locations indicated. (also see -V) +<p> </dd> + +<dt><b>-m [filename/wildcard/url]</b> +</dt> +<dd>assumed for most other flags, creates new meta-markup file, (the metaverse +) that is used in all subsequent processing of other output. This step is +assumed for most processing flags. To skip it see -n +<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. +<p> </dd> + +<dt><b>-n +[filename/wildcard/url]</b> </dt> +<dd>skip meta-markup (building of -m which is otherwise +assumed by most processing flags. +<p> </dd> + +<dt><b>-o [filename/wildcard/url]</b> </dt> +<dd>output basic +document in opendocument file format (opendocument.odt). +<p> </dd> + +<dt><b>-p [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 +’legal’ and book sizes ’A5’ and ’B5’ (system defaults to A4). +<p> </dd> + +<dt><b>-q [filename/wildcard]</b> +</dt> +<dd>quiet less output to screen. +<p> </dd> + +<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 +<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 + +<p>have your +<p> </dd> + +<dt><b>-S</b> </dt> +<dd>produces a sisupod a zipped sisu directory of markup 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). +<p> </dd> + +<dt><b>-S [filename/wildcard]</b> </dt> +<dd>produces a zipped +file of the prepared document specified along with associated images, by +default named sisupod.zip they may alternatively be named with the filename +extension .ssp This provides a quick way of gathering the relevant parts +of a sisu document which can then for example be emailed. A sisupod includes +sisu markup source file, (along with associated documents if a master file, +or available in multilingual versions), together with related images and +skin. <b>SiSU</b> commands can be run directly against a sisupod contained in a +local directory, or provided as a url on a remote site. As there is a security +issue with skins provided by other users, they are not applied unless the +flag --trust or --trusted is added to the command instruction, it is recommended +that file that are not your own are treated as untrusted. The directory +structure of the unzipped file is understood by sisu, and sisu commands +can be run within it. Note: if you wish to send multiple files, it quickly +becomes more space efficient to zip the sisu markup directory, rather than +the individual files for sending). See the -S option without [filename/wildcard]. + +<p> </dd> + +<dt><b>-s [filename/wildcard]</b> </dt> +<dd>copies sisu markup file to output directory. +<p> </dd> + +<dt><b>-t [filename/wildcard + (*.termsheet.rb)]</b> </dt> +<dd>standard form document builder, preprocessing feature +<p> +</dd> + +<dt><b>-U [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 + +<p>can be switched to file system paths in sisurc.yml +<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>-V</b> </dt> +<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. +(also see -M) +<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>provides verbose output of what is being built, where it is being built +(and error messages if any), as with -u flag provides a url mapping of files +created for each of the processing flag requests. See also -V +<p> </dd> + +<dt><b>-W</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 ]. +<p> </dd> + +<dt><b>-w +[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) +<p> </dd> + +<dt><b>-X [filename/wildcard]</b> </dt> +<dd>produces XML output with deep document +structure, in the nature of dom. +<p> </dd> + +<dt><b>-x [filename/wildcard]</b> </dt> +<dd>produces XML output +shallow structure (sax parsing). +<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. +--sitemaps generates/updates the sitemap index of existing sitemaps. (Experimental, +[g,y,m announcement this week]) +<p> </dd> + +<dt><b>-y [filename/wildcard]</b> </dt> +<dd>produces an html +summary of output generated (hyperlinked to content) and document specific +metadata (sisu_manifest.html). This step is assumed for most processing flags. + +<p> </dd> + +<dt><b>-Z [filename/wildcard]</b> </dt> +<dd>Zap, if used with other processing flags deletes +output files of the type about to be processed, prior to processing. If +-Z is used as the lone processing related flag (or in conjunction with a +combination of -[mMvVq]), will remove the related document output directory. + +<p> </dd> + +<dt><b>-z [filename/wildcard]</b> </dt> +<dd>produces php (zend) [this feature is disabled for + the time being] +<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. +<p> </dd> +</dl> +3. COMMAND +LINE MODIFIERS +<p> +<dl> + +<dt><b>--no-ocn</b> </dt> +<dd>[with -h -H or -p] switches off object citation numbering. +Produce output without identifying numbers in margins of html or LaTeX/pdf +output. +<p> </dd> + +<dt><b>--no-annotate</b> </dt> +<dd>strips output text of editor endnotes[^*1] denoted by + +<p>asterisk or dagger/plus sign +<p> </dd> + +<dt><b>--no-asterisk</b> </dt> +<dd>strips output text of editor endnotes[^*2] + +<p>denoted by asterisk sign +<p> </dd> + +<dt><b>--no-dagger</b> </dt> +<dd>strips output text of editor endnotes[^+1] + +<p>denoted by dagger/plus sign +<p> </dd> +</dl> +4. DATABASE COMMANDS +<p> dbi - database interface + +<p> -D or --pgsql set for postgresql -d or --sqlite default set for sqlite -d is +modifiable with --db=[database type (pgsql or sqlite)] +<p> +<dl> + +<dt><b>-Dv --createall</b> </dt> +<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. +<p> </dd> + +<dt><b>-Dv --import</b> </dt> +<dd>[filename/wildcard] imports data +specified to postgresql db (rb.dbi) [ -dv --import sqlite equivalent] +<p> </dd> + +<dt><b>-Dv --update</b> +</dt> +<dd>[filename/wildcard] updates/imports specified data to postgresql db (rb.dbi) +[ -dv --update sqlite equivalent] +<p> </dd> + +<dt><b>-D --remove</b> </dt> +<dd>[filename/wildcard] removes specified +data to postgresql db (rb.dbi) [ -d --remove sqlite equivalent] +<p> </dd> + +<dt><b>-D --dropall</b> +</dt> +<dd>kills data --dropall sqlite equivalent] +<p> The v in e.g. -Dv is for verbose output. + +<p> </dd> +</dl> +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. +<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): +<p> </dd> + +<dt><b>-0</b> </dt> +<dd>-mNhwpAobxXyYv +[this is the default action run when no i.e. on ’sisu [filename]’] +<p> </dd> + +<dt><b>-1</b> </dt> +<dd>-mNHwpy + +<p> </dd> + +<dt><b>-2</b> </dt> +<dd>-mNHwpaoy +<p> </dd> + +<dt><b>-3</b> </dt> +<dd>-mNhwpAobxXyY +<p> </dd> + +<dt><b>-4</b> </dt> +<dd>-mNhwpAobxXDyY --import +<p> </dd> + +<dt><b>-5</b> </dt> +<dd>-mNhwpAobxXDyY --update + +<p> add -v for verbose mode and -c for color, e.g. sisu -2vc [filename or +<p> consider + +<p>- +<p>u for appended url info or -v for verbose output +<p> </dd> +</dl> +5.1 COMMAND LINE WITH FLAGS +- BATCH PROCESSING +<p> In the data directory run sisu -mh filename or wildcard +eg. cisg.sst 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> <<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/sisu_markup_samples/sisu_manual/<br> + +<p> /usr/share/doc/sisu/sisu_markup_samples/sisu_manual/<br> + +<p> move to the respective directory and type e.g.: +<p> sisu sisu_manual.ssm<br> + +<p> 6.2 SISU MAN PAGES +<p> If <b>SiSU</b> is installed on your system usual man commands +should be available, try: +<p> man sisu<br> + +<p> man sisu_markup<br> + +<p> man sisu_commands<br> + +<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/sisu_manual/<br> + +<p> Once installed, directory equivalent to: +<p> /usr/share/doc/sisu/sisu_manual/<br> + +<p> Available man pages are converted back to html using man2html: +<p> /usr/share/doc/sisu/html/<br> + +<p> ./data/doc/sisu/html/<br> + +<p> An online version of the sisu man page is available here: +<p> * various +sisu man pages <<a href='http://www.jus.uio.no/sisu/man/'>http://www.jus.uio.no/sisu/man/</a> +> [^7] +<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> +> +[^8] +<p> 6.3 SISU BUILT-IN INTERACTIVE HELP +<p> This is particularly useful for +getting the current sisu setup/environment information: +<p> sisu --help<br> + +<p> sisu --help [subject]<br> + +<p> sisu --help commands<br> + +<p> sisu --help markup<br> + +<p> sisu --help env [for feedback on the way your system is <br> + setup with regard to sisu]<br> + +<p> sisu -V [environment information, same as above command]<br> + +<p> sisu (on its own provides version and some help information)<br> + +<p> Apart from real-time information on your current configuration the <b>SiSU</b> +manual and man pages are likely to contain more up-to-date information than +the sisu interactive help (for example on commands and markup). +<p> NOTE: +Running the command 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.4 HELP SOURCES +<p> For lists of alternative help sources, +see: +<p> <b>man page</b> +<p> man sisu_help_sources<br> + +<p> <b>man2html</b> +<p> /usr/share/doc/sisu/sisu_manual/sisu_help_sources/index.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> + +<p> 7. INTRODUCTION TO SISU MARKUP[^9] +<p> 7.1 SUMMARY +<p> <b>SiSU</b> source documents +are plaintext (UTF-8)[^10] files +<p> All paragraphs are separated by an empty +line. +<p> Markup is comprised of: +<p> * at the top of a document, the document +header made up of semantic meta-data about the document and if desired additional +processing instructions (such an instruction to automatically number headings +from a particular level down) +<p> * followed by the prepared substantive +text of which the most important single characteristic is the markup of +different heading levels, which define the primary outline of the document +structure. Markup of substantive text includes: +<p> * heading levels defines +document structure<br> + +<p> * text basic attributes, italics, bold etc.<br> + +<p> * grouped text (objects), which are to be treated differently, such +as code<br> + blocks or poems.<br> + +<p> * footnotes/endnotes<br> + +<p> * linked text and images<br> + +<p> * paragraph actions, such as indent, bulleted, numbered-lists, etc.<br> + +<p> Some interactive help on markup is available, by typing sisu and selecting + +<p>markup or sisu --help markup +<p> To check the markup in a file: +<p> sisu --identify +[filename].sst<br> + +<p> For brief descriptive summary of markup history +<p> sisu --query-history<br> + +<p> or if for a particular version: +<p> sisu --query-0.38<br> + +<p> 7.2 MARKUP EXAMPLES +<p> 7.2.1 ONLINE +<p> Online markup examples are available +together with the respective outputs produced from <<a href='http://www.jus.uio.no/sisu/SiSU/examples.html'>http://www.jus.uio.no/sisu/SiSU/examples.html</a> +> +or from <<a href='http://www.jus.uio.no/sisu/sisu_examples/'>http://www.jus.uio.no/sisu/sisu_examples/</a> +> +<p> There is of course this +document, which provides a cursory overview of sisu markup and the respective +output produced: <<a href='http://www.jus.uio.no/sisu/sisu_markup/'>http://www.jus.uio.no/sisu/sisu_markup/</a> +> +<p> Some example marked +up files are available as html with syntax highlighting for viewing: <<a href='http://www.jus.uio.no/sisu/sample/syntax'>http://www.jus.uio.no/sisu/sample/syntax</a> +> + +<p> an alternative presentation of markup syntax: <<a href='http://www.jus.uio.no/sisu/sample/on_markup.txt'>http://www.jus.uio.no/sisu/sample/on_markup.txt</a> +> + +<p> 7.2.2 INSTALLED +<p> With <b>SiSU</b> installed sample skins may be found in: /usr/share/doc/sisu/sisu_markup_samples/dfsg +(or equivalent directory) and if sisu-markup-samples is installed also under: + +<p>/usr/share/doc/sisu/sisu_markup_samples/non-free +<p> 8. MARKUP OF HEADERS +<p> + Headers contain either: semantic meta-data about a document, which can +be used by any output module of the program, or; processing instructions. + +<p> Note: the first line of a document may include information on the markup +version used in the form of a comment. Comments are a percentage mark at +the start of a paragraph (and as the first character in a line of text) +followed by a space and the comment: +<p> +<p> <br> +<pre> % this would be a comment +</pre> +<p> 8.1 SAMPLE HEADER +<p> This current document has a header similar to this +one (without the comments): +<p> +<p> <br> +<pre> % SiSU 0.57 + @title: SiSU + @subtitle: Markup + @creator: Amissah, Ralph + % note formatting rules on author / creator field, + @rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, +License GPL 3 + @type: information + @subject: ebook, epublishing, electronic book, electronic publishing, +electronic document, electronic citation, data structure, citation systems, +search + @topic_register: text markup language; application:text processing;output:html|xml|latex|pdf|sql + % note formatting for topic_register topic levels are separated by a +colon, a semi-colon separates main topics + @date: 2007-09-16 + % original publication date unless the substantive text is updated/modified, +then date of update + @date.created: 2002-08-28 + @date.issued: 2002-08-28 + @date.available: 2002-08-28 + @date.modified: 2007-09-16 + @level: new=C; break=1; num_top=1 + % comment: in this @level header num_top=1 starts automatic heading numbering +at heading level 1 (numbering continues 3 levels down); the new and break +instructions are used by the LaTeX/pdf and odf output to determine where +to put page breaks (that are not used by html output or say sql database +population). + @skin: skin_sisu_manual + % skins modify the appearance of a document and are placed in a sub-directory +under ./_sisu/skin ~/.sisu/skin or /etc/sisu/skin. A skin may affect single +documents that request them, all documents in a directory, or be site-wide. +(A document is affected by a single skin) + @bold: /Gnu|Debian|Ruby|SiSU/ + @links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +</pre> +<p> 8.2 AVAILABLE HEADERS +<p> Header tags appear at the beginning of a document +and provide meta information on the document (such as the Dublin Core), +or information as to how the document as a whole is to be processed. All +header instructions take either the form @headername: or 0~headername. All + +<p>Dublin Core meta tags are available +<p> <b>@indentifier:</b> information or instructions + +<p> where the information +<p> Note: a header where used should only be used +once; all headers apart from @title: are optional; the @structure: header +is used to describe document structure, and can be useful to know. +<p> This + +<p>is a sample header +<p> <b>% SiSU 0.38</b> [declared file-type identifier with markup + version] +<p> +<p> <b>@title:</b> [title text] This is the title of the document and +used as such, this header is the only one that is<br> + <i>mandatory</i> +<p> <b>@subtitle:</b> The Subtitle if any +<p> <b>@creator:</b> [or @author:] Name + +<p>of Author +<p> <b>@subject:</b> (whatever your subject) +<p> <b>@description:</b> +<p> <b>@publisher:</b> + +<p> <b>@contributor:</b> +<p> <b>@translator:</b> [or @translated_by:] +<p> <b>@illustrator:</b> [or + @illustrated_by:] +<p> <b>@prepared_by:</b> [or @digitized_by:] +<p> <b>@date: 2000-08-27</b> +[ also @date.created: @date.issued: @date.available: @date.valid: ] +<p> +<p> <b>@type: + +<p>article</b> +<p> <b>@format:</b> +<p> <b>@identifier:</b> +<p> <b>@source:</b> +<p> <b>@language:</b> [or @language.document:] +[country code for language if available, or language, English, en is the + default setting] (en - English, fr - French, de - German, it - Italian, es +- Spanish, pt - Portuguese, sv - Swedish, da - Danish, fi - Finnish, no - Norwegian, +is - Icelandic, nl - Dutch, et - Estonian, hu - Hungarian, pl - Polish, ro - +Romanian, ru - Russian, el - Greek, uk - Ukranian, tr - Turkish, sk - Slovak, +sl - Slovenian, hr - Croatian, cs - Czech, bg - Bul garian ) [however, encodings + are not available for all of the languages listed.] +<p> [@language.original: + original language in which the work was published] +<p> <b>@papersize:</b> (A4|US_letter|book_B5|book_A5|US_legal) + +<p> <b>@relation:</b> +<p> <b>@coverage:</b> +<p> <b>@rights:</b> Copyright (c) Name of Right Holder, +all rights reserved, or as granted: public domain, copyleft, creative commons +variant, etc. +<p> <b>@owner:</b> +<p> <b>@keywords:</b> text document generation processing +management latex pdf structured xml citation [your keywords here, used + for example by rss feeds, +<p> <b>@abstract:</b> [paper abstract, placed after table + of contents] +<p> <b>@comment:</b> [...] +<p> <b>@catalogue:</b> loc=[Library of Congress classification]; +dewey=[Dewey rss feeds, isbn=[ISBN]; pg=[Project Gutenberg text number] + +<p> <b>@classify_loc:</b> [Library of Congress classification] +<p> <b>@classify_dewey:</b> +[Dewey classification] +<p> <b>@classify_isbn:</b> [ISBN] +<p> <b>@classify_pg:</b> [Project + Gutenberg text number] +<p> <b>@prefix:</b> [prefix is placed just after table of + contents] +<p> <b>@prefix_a:</b> [prefix is placed just before table of contents + - not +<p> <b>@prefix_b:</b> +<p> <b>@rcs:</b> $Id: sisu_markup.sst,v 1.2 2007/09/08 17:12:47 +ralph Exp $ [used by rcs or cvs to embed version (revision control) information + into document, rcs or cvs can usefully provide a history of updates to + a document ] +<p> <b>@structure:</b> PART; CHAPTER; SECTION; ARTICLE; none; none; +optional, document structure can be defined by words to match or regular +expression (the regular expression is assumed to start at the beginning +of a line of text i.e. ^) default markers :A~ to :C~ and 1~ to 6~ can be used +within text instead, without this header tag, and may be used to supplement +the instructions provided in this header tag if provided (@structure: is +a synonym for @toc:) +<p> <b>@level:</b> newpage=3; breakpage=4 [paragraph level, + used by latex to breakpages, the page is optional eg. in newpage] +<p> <b>@markup:</b> +information on the markup used, e.g. new=1,2,3; break=4; num_top=4 [or is +newpage=1,2,3; breakpage=4; num_top=4] newpage and breakpage, heading level, +used by LaTeX to breakpages. breakpage: starts on a new page in single column +text and on a new column in double column text; newpage: starts on a new +page for both single and double column texts. num_top=4 [auto-number document, + starting at level 4. the a new default is to provide 3 levels, as in 1 level + 4, 1.1 1.1.1 level 6, markup to be merged within level] num_extract [take + numbering of headings provided (manually in marked up source document), + and use for numbering of segments. Available where a clear numbering structure + is provided within document, without the repetition of a number in a header.] +[In 0.38 notation, you would map to the equivalent levels, the examples + provided would map to the following new=A,B,C; break=1; num_top=1 [or newpage=A,B,C; +breakpage=1; num_top=1] see headings] +<p> <b>@bold:</b> [regular expression of words/phrases + to be made bold] +<p> <b>@italics:</b> [regular expression of words/phrases to italicise] + +<p> <b>@vocabulary:</b> name of taxonomy/vocabulary/wordlist to use against document + +<p> <b>@skin:</b> skin_doc_[name_of_desired_document_skin] skins change default +settings related to the appearance of documents generated, such as the +urls of the home site, and the icon/logo for the document or site. +<p> +<dl> + +<dt><b>@man: +8;</b> </dt> +<dd>name=sisu - documents: markup, structuring, publishing in multiple standard +formats, and search; synopsis=sisu [-abcDdFHhIiMmNnopqRrSsTtUuVvwXxYyZz0-9] +[filename/wildcard ] sisu [-Ddcv] [instruction] sisu [-CcFLSVvW] the man +page category number (default 1) and special tags used in preparing man + +<p>page headings +<p> <b>@links:</b> { <b>SiSU</b> }<a href='http://www.jus.uio.no/sisu/;'>http://www.jus.uio.no/sisu/;</a> + { FSF }<a href='http://www.fsf.org'>http://www.fsf.org</a> + + +<p> <b>@promo:</b> sisu, ruby, search_libre_docs, open_society [places content in + right pane in html, makes use of commented out sample in document and promo.yml, + commented out sample in document +<p> </dd> +</dl> +9. MARKUP OF SUBSTANTIVE TEXT +<p> 9.1 HEADING + +<p>LEVELS +<p> Heading levels are :A~ ,:B~ ,:C~ ,1~ ,2~ ,3~ ... :A - :C being part +/ section headings, followed by other heading levels, and 1 -6 being headings +followed by substantive text or sub-headings. :A~ usually the title :A~? +conditional level 1 heading (used where a stand-alone document may be imported +into another) +<p> <b>:A~ [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 + +<p>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 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 marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a document + +<p> +<p> <br> +<pre> 1~filename level 1 heading, + % the primary division such as Chapter that is followed by substantive +text, and may be further subdivided (this is the level on which by default +html segments are made) +</pre> +<p> 9.2 FONT ATTRIBUTES +<p> <b>markup example:</b> +<p> +<p> <br> +<pre> normal text !{emphasis}! *{bold text}* _{underscore}_ /{italics}/ + normal text + !{emphasis}! + *{bold text}* + _{underscore}_ + /{italics}/ + + ^{superscript}^ + ,{subscript}, + +{inserted text}+ + -{strikethrough}- +</pre> +<p> <b>resulting output:</b> +<p> normal text <b>emphasis</b> <b>bold text</b> <i>underscore</i> <i>italics</i> +<cite>citation</cite> ^superscript^ [subscript] <ins>inserted text</ins> <del>strikethrough</del> + +<p> normal text +<p> +<p> <b>bold text</b> +<p> <i>underscore</i> +<p> <i>italics</i> +<p> <cite>citation</cite> +<p> + ^superscript^ +<p> [subscript] +<p> <ins>inserted text</ins> +<p> <del>strikethrough</del> + +<p> 9.3 INDENTATION AND BULLETS +<p> <b>markup example:</b> +<p> +<p> <br> +<pre> ordinary paragraph + _1 indent paragraph one step + _2 indent paragraph two steps + _9 indent paragraph nine steps +</pre> +<p> +<p> <b>resulting output:</b> +<p> ordinary paragraph +<p> indent paragraph one step<br> + +<p> indent paragraph two steps<br> + +<p> indent paragraph nine steps<br> + +<p> <b>markup example:</b> +<p> +<p> <br> +<pre> _* bullet text + _1* bullet text, first indent + _2* bullet text, two step indent +</pre> +<p> <b>resulting output:</b> +<p> * bullet text +<p> * bullet text, first indent<br> + +<p> * bullet text, two step indent<br> + +<p> Numbered List (not to be confused with headings/titles, (document structure)) + +<p> <b>markup example:</b> +<p> +<p> <br> +<pre> # numbered list numbered list 1., 2., 3, etc. + _# numbered list numbered list indented a., b., c., d., etc. +</pre> +<p> 9.4 FOOTNOTES / ENDNOTES +<p> Footnotes and endnotes not distinguished in +markup. They are automatically numbered. Depending on the output file format +(html, odf, pdf etc.), the document output selected will have either footnotes +or endnotes. +<p> <b>markup example:</b> +<p> +<p> <br> +<pre> ~{ a footnote or endnote }~ +</pre> +<p> <b>resulting output:</b> +<p> [^11] +<p> <b>markup example:</b> +<p> +<p> <br> +<pre> normal text~{ self contained endnote marker & endnote in one }~ continues +</pre> +<p> <b>resulting output:</b> +<p> normal text[^12] continues +<p> <b>markup example:</b> +<p> +<p> <br> +<pre> normal text ~{* unnumbered asterisk footnote/endnote, insert multiple +asterisks if required }~ continues + normal text ~{** another unnumbered asterisk footnote/endnote }~ continues +</pre> +<p> <b>resulting output:</b> +<p> normal text [^*] continues +<p> normal text [^**] continues + +<p> +<p> <b>markup example:</b> +<p> +<p> <br> +<pre> normal text ~[* editors notes, numbered asterisk footnote/endnote series + ]~ continues + normal text ~[+ editors notes, numbered asterisk footnote/endnote series + ]~ continues +</pre> +<p> <b>resulting output:</b> +<p> normal text [^*3] continues +<p> normal text [^+2] continues + +<p> +<p> <b>Alternative endnote pair notation for footnotes/endnotes:</b> +<p> +<p> <br> +<pre> % note the endnote marker + normal text~^ continues + ^~ endnote text following the paragraph in which the marker occurs +</pre> +<p> the standard and pair notation cannot be mixed in the same document +<p> + +<p>9.5 LINKS +<p> 9.5.1 NAKED URLS WITHIN TEXT, DEALING WITH URLS +<p> urls are found +within text and marked up automatically. A url within text is automatically +hyperlinked to itself and by default decorated with angled braces, unless +they are contained within a code block (in which case they are passed as +normal text), or escaped by a preceding underscore (in which case the decoration +is omitted). +<p> <b>markup example:</b> +<p> +<p> <br> +<pre> normal text http://www.jus.uio.no/sisu continues +</pre> +<p> <b>resulting output:</b> +<p> normal text <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> +> continues +<p> An + +<p>escaped url without decoration +<p> <b>markup example:</b> +<p> +<p> <br> +<pre> normal text http://www.jus.uio.no/sisu continues + deb http://www.jus.uio.no/sisu/archive unstable main non-free +</pre> +<p> <b>resulting output:</b> +<p> normal text <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> + continues +<p> deb + +<p><a href='http://www.jus.uio.no/sisu/archive'>http://www.jus.uio.no/sisu/archive</a> + unstable main non-free +<p> where a code block +is used there is neither decoration nor hyperlinking, code blocks are discussed + +<p>later in this document +<p> <b>resulting output:</b> +<p> +<p> <br> +<pre> deb http://www.jus.uio.no/sisu/archive unstable main non-free + deb-src http://www.jus.uio.no/sisu/archive unstable main non-free +</pre> +<p> To link text or an image to a url the markup is as follows +<p> <b>markup example:</b> + +<p> +<p> <br> +<pre> about { SiSU }http://url.org markup +</pre> +<p> 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>markup +<p> A shortcut notation is available so the url link may also be provided + +<p>automatically as a footnote +<p> <b>markup example:</b> +<p> +<p> <br> +<pre> about {~^ SiSU }http://url.org markup +</pre> +<p> <b>resulting output:</b> +<p> about SiSU <<a href='http://www.jus.uio.no/sisu/'>http://www.jus.uio.no/sisu/</a> +> [^13] markup +<p> + +<p>9.5.3 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 +</pre> +<p> <b>resulting output:</b> +<p> [ tux.png ] +<p> tux.png 64x80 +<p> [ ruby_logo (png missing) + ] [^14] +<p> GnuDebianLinuxRubyBetterWay.png 100x101 and Ruby +<p> <b>linked url footnote + +<p>shortcut</b> +<p> +<p> <br> +<pre> {~^ [text to link] }http://url.org + % maps to: { [text to link] }http://url.org ~{ http://url.org }~ + % which produces hyper-linked text within a document/paragraph, with an +endnote providing the url for the text location used in the hyperlink +</pre> +<p> +<p> <br> +<pre> text marker *~name +</pre> +<p> note at a heading level the same is automatically achieved by providing +names to headings 1, 2 and 3 i.e. 2~[name] and 3~[name] or in the case of +auto-heading numbering, without further intervention. +<p> 9.6 GROUPED TEXT +<p> 9.6.1 + +<p>TABLES +<p> Tables may be prepared in two either of two forms +<p> <b>markup example:</b> + +<p> +<p> <br> +<pre> table{ c3; 40; 30; 30; + This is a table + this would become column two of row one + column three of row one is here + And here begins another row + column two of row two + column three of row two, and so on + }table +</pre> +<p> <b>resulting output:</b> +<p> [table omitted, see other document formats]<br> + +<p> a second form may be easier to work with in cases where there is not + +<p>much information in each column +<p> <b>markup example:</b> [^15] +<p> +<p> <br> +<pre> !_ Table 3.1: Contributors to Wikipedia, January 2001 - June 2005 + {table~h 24; 12; 12; 12; 12; 12; 12;} + |Jan. 2001|Jan. 2002|Jan. 2003|Jan. 2004|July +2004|June 2006 + Contributors* | 10| 472| 2,188| 9,653| + 25,011| 48,721 + Active contributors** | 9| 212| 846| 3,228| + 8,442| 16,945 + Very active contributors*** | 0| 31| 190| 692| + 1,639| 3,016 + No. of English language articles| 25| 16,000| 101,000| 190,000| +320,000| 630,000 + No. of articles, all languages | 25| 19,000| 138,000| 490,000| +862,000|1,600,000 + \* Contributed at least ten times; \** at least 5 times in last month; +\* more than 100 times in last month. +</pre> +<p> <b>resulting output:</b> +<p> <b>Table 3.1: Contributors to Wikipedia, January 2001 +- June 2005</b> +<p> [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. +<p> 9.6.2 POEM +<p> <b>basic markup:</b> +<p> +<p> <br> +<pre> poem{ + Your poem here + }poem + Each verse in a poem is given a separate object number. +</pre> +<p> <b>markup example:</b> +<p> +<p> <br> +<pre> poem{ + ’Fury said to a + mouse, That he + met in the + house, + + both go to + law: I will + prosecute + YOU. --Come, + I’ll take no + denial; We + must have a + trial: For + really this + morning I’ve + nothing + to do. + Said the + mouse to the + cur, + a trial, + dear Sir, + With + no jury + or judge, + would be + wasting + our + breath. + + judge, I’ll + be jury, + Said + cunning + old Fury: + + try the + whole + cause, + and + condemn + you + to + death. + }poem +</pre> +<p> <b>resulting output:</b> +<p> +<p> ’Fury said to a<br> + mouse, That he<br> + met in the<br> + house,<br> + <br> + both go to<br> + law: I will<br> + prosecute<br> + YOU. --Come,<br> + I’ll take no<br> + denial; We<br> + must have a<br> + trial: For<br> + really this<br> + morning I’ve<br> + nothing<br> + to do.<br> + Said the<br> + mouse to the<br> + cur,<br> + a trial,<br> + dear Sir,<br> + With<br> + no jury<br> + or judge,<br> + would be<br> + wasting<br> + our<br> + breath.<br> + <br> + judge, I’ll<br> + be jury,<br> + Said<br> + cunning<br> + old Fury:<br> + <br> + try the<br> + whole<br> + cause,<br> + and<br> + condemn<br> + you<br> + to<br> + death.<br> + +<p> 9.6.3 GROUP +<p> <b>basic markup:</b> +<p> +<p> <br> +<pre> group{ + Your grouped text here + }group + A group is treated as an object and given a single object number. +</pre> +<p> <b>markup example:</b> +<p> +<p> <br> +<pre> group{ + ’Fury said to a + mouse, That he + met in the + house, + + both go to + law: I will + prosecute + YOU. --Come, + I’ll take no + denial; We + must have a + trial: For + really this + morning I’ve + nothing + to do. + Said the + mouse to the + cur, + a trial, + dear Sir, + With + no jury + or judge, + would be + wasting + our + breath. + + judge, I’ll + be jury, + Said + cunning + old Fury: + + try the + whole + cause, + and + condemn + you + to + death. + }group +</pre> +<p> <b>resulting output:</b> +<p> +<p> ’Fury said to a<br> + mouse, That he<br> + met in the<br> + house,<br> + <br> + both go to<br> + law: I will<br> + prosecute<br> + YOU. --Come,<br> + I’ll take no<br> + denial; We<br> + must have a<br> + trial: For<br> + really this<br> + morning I’ve<br> + nothing<br> + to do.<br> + Said the<br> + mouse to the<br> + cur,<br> + a trial,<br> + dear Sir,<br> + With<br> + no jury<br> + or judge,<br> + would be<br> + wasting<br> + our<br> + breath.<br> + <br> + judge, I’ll<br> + be jury,<br> + Said<br> + cunning<br> + old Fury:<br> + <br> + try the<br> + whole<br> + cause,<br> + and<br> + condemn<br> + you<br> + to<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> <b>use of code tags instead of +poem compared, resulting output:</b> +<p> +<p> <br> +<pre> ’Fury said to a + mouse, That he + met in the + house, + + both go to + law: I will + prosecute + YOU. --Come, + I’ll take no + denial; We + must have a + trial: For + really this + morning I’ve + nothing + to do. + Said the + mouse to the + cur, + a trial, + dear Sir, + With + no jury + or judge, + would be + wasting + our + breath. + + judge, I’ll + be jury, + Said + cunning + old Fury: + + try the + whole + cause, + and + condemn + you + to + death. +</pre> +<p> 9.7 BOOK INDEX +<p> To make an index append to paragraph the book index term +relates to it, using an equal sign and curly braces. +<p> Currently two levels +are provided, a main term and if needed a sub-term. Sub-terms are separated +from the main term by a colon. +<p> +<p> <br> +<pre> Paragraph containing main term and sub-term. + ={Main term:sub-term} +</pre> +<p> The index syntax starts on a new line, but there should not be an empty +line between paragraph and index markup. +<p> The structure of the resulting +index would be: +<p> +<p> <br> +<pre> Main term, 1 + sub-term, 1 +</pre> +<p> Several terms may relate to a paragraph, they are separated by a semicolon. +If the term refers to more than one paragraph, indicate the number of paragraphs. + +<p> +<p> <br> +<pre> Paragraph containing main term, second term and sub-term. + ={first term; second term: sub-term} +</pre> +<p> The structure of the resulting index would be: +<p> +<p> <br> +<pre> First term, 1, + Second term, 1, + sub-term, 1 +</pre> +<p> If multiple sub-terms appear under one paragraph, they are separated under +the main term heading from each other by a pipe symbol. +<p> +<p> <br> +<pre> Paragraph containing main term, second term and sub-term. + ={Main term:sub-term+1|second sub-term + A paragraph that continues discussion of the first sub-term +</pre> +<p> The plus one in the example provided indicates the first sub-term spans +one additional paragraph. The logical structure of the resulting index would +be: +<p> +<p> <br> +<pre> Main term, 1, + sub-term, 1-3, + second sub-term, 1, +</pre> +<p> 10. COMPOSITE DOCUMENTS MARKUP +<p> It is possible to build a document by +creating a master document that requires other documents. The documents +required may be complete documents that could be generated independently, +or they could be markup snippets, prepared so as to be easily available +to be placed within another text. If the calling document is a master document +(built from other documents), it should be named with the suffix <b>.ssm</b> Within +this document you would provide information on the other documents that +should be included within the text. These may be other documents that would +be processed in a regular way, or markup bits prepared only for inclusion +within a master document <b>.sst</b> regular markup file, or <b>.ssi</b> (insert/information) + +<p>A secondary file of the composite document is built prior to processing + +<p>with the same prefix and the suffix <b>._sst</b> +<p> basic markup for importing a + +<p>document into a master document +<p> +<p> <br> +<pre> << filename1.sst + << filename2.ssi +</pre> +<p> The form described above should be relied on. Within the Vim editor it +results in the text thus linked becoming hyperlinked to the document it +is calling in which is convenient for editing. Alternative markup for importation +of documents under consideration, and occasionally supported have been. + +<p> +<p> <br> +<pre> << filename.ssi + <<{filename.ssi} + % using textlink alternatives + << |filename.ssi|@|^| +</pre> +<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> 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> +<p> <br> +<pre> :A~ @title by @author +</pre> +<p> <b>0.52</b> (2007w14/6) declared document type identifier at start of text/document: + +<p> .B SiSU<br> + 0.52 +<p> or, backward compatible using the comment marker: +<p> %<br> + <b>SiSU</b> 0.38 +<p> variations include ’ <b>SiSU</b> (text|master|insert) [version]’ and ’sisu-[version]’ + +<p> <b>0.51</b> (2007w13/6) skins changed (simplified), markup unchanged +<p> <b>0.42</b> (2006w27/4) +* (asterisk) type endnotes, used e.g. in relation to author +<p> <b>SiSU</b> 0.42 is +the same as 0.38 with the introduction of some additional endnote types, + +<p> Introduces some variations on endnotes, in particular the use of the + +<p>asterisk +<p> +<p> <br> +<pre> ~{* for example for describing an author }~ and ~{** for describing a +second author }~ +</pre> +<p> * for example for describing an author +<p> ** for describing a second author + +<p> and +<p> +<p> <br> +<pre> ~[* my note ]~ or ~[+ another note ]~ +</pre> +<p> which numerically increments an asterisk and plus respectively +<p> *1 my + +<p>note +1 another note +<p> <b>0.38</b> (2006w15/7) introduced new/alternative notation +for headers, e.g. @title: (instead of 0~title), and accompanying document +structure markup, :A,:B,:C,1,2,3 (maps to previous 1,2,3,4,5,6) +<p> <b>SiSU</b> +0.38 introduced alternative experimental header and heading/structure markers, + +<p> +<p> <br> +<pre> @headername: and headers :A~ :B~ :C~ 1~ 2~ 3~ +</pre> +<p> as the equivalent of: +<p> +<p> <br> +<pre> 0~headername and headers 1~ 2~ 3~ 4~ 5~ 6~ +</pre> +<p> The internal document markup of <b>SiSU</b> 0.16 remains valid and standard Though + +<p>note that <b>SiSU</b> 0.37 introduced a new file naming convention +<p> <b>SiSU</b> has in +effect two sets of levels to be considered, using 0.38 notation A-C headings/levels, +pre-ordinary paragraphs /pre-substantive text, and 1-3 headings/levels, levels +which are followed by ordinary text. This may be conceptualised as levels +A,B,C, 1,2,3, and using such letter number notation, in effect: A must +exist, optional B and C may follow in sequence (not strict) 1 must exist, +optional 2 and 3 may follow in sequence i.e. there are two independent heading +level sequences A,B,C and 1,2,3 (using the 0.16 standard notation 1,2,3 +and 4,5,6) on the positive side: the 0.38 A,B,C,1,2,3 alternative makes +explicit an aspect of structuring documents in <b>SiSU</b> that is not otherwise +obvious to the newcomer (though it appears more complicated, is more in +your face and likely to be understood fairly quickly); the substantive +text follows levels 1,2,3 and it is ’nice’ to do most work in those levels + +<p> <b>0.37</b> (2006w09/7) introduced new file naming convention, .sst (text), .ssm +(master), .ssi (insert), markup syntax unchanged +<p> <b>SiSU</b> 0.37 introduced new +file naming convention, using the file extensions .sst .ssm and .ssi to replace +.s1 .s2 .s3 .r1 .r2 .r3 and .si<br> + +<p> this is captured by the following file ’rename’ instruction: +<p> +<p> <br> +<pre> rename ’s/.s[123]$/.sst/’ *.s{1,2,3} + rename ’s/.r[123]$/.ssm/’ *.r{1,2,3} + rename ’s/.si$/.ssi/’ *.si +</pre> +<p> The internal document markup remains unchanged, from <b>SiSU</b> 0.16 +<p> <b>0.35</b> (2005w52/3) +sisupod, zipped content file introduced +<p> <b>0.23</b> (2005w36/2) utf-8 for markup + +<p>file +<p> <b>0.22</b> (2005w35/3) image dimensions may be omitted if rmagick is available + +<p>to be relied upon +<p> <b>0.20.4</b> (2005w33/4) header 0~links +<p> <b>0.16</b> (2005w25/2) substantial +changes introduced to make markup cleaner, header 0~title type, and headings +[1-6]~ introduced, also percentage sign (%) at start of a text line as comment + +<p>marker +<p> <b>SiSU</b> 0.16 (0.15 development branch) introduced the use of +<p> the +header 0~ and headings/structure 1~ 2~ 3~ 4~ 5~ 6~ +<p> in place of the 0.1 +header, heading/structure notation +<p> <b>SiSU</b> 0.1 headers and headings structure +represented by header 0{~ and headings/structure 1{ 2{ 3{ 4{~ 5{ 6{ +<p> 12. +SISU FILETYPES +<p> <b>SiSU</b> has plaintext and binary filetypes, and can process +either type of document. +<p> 12.1 .SST .SSM .SSI MARKED UP PLAIN TEXT +<p> <b>SiSU</b> documents +are prepared as plain-text (utf-8) files with <b>SiSU</b> markup. They may make reference +to and contain images (for example), which are stored in the directory +beneath them _sisu/image. <b>SiSU</b> plaintext markup files are of three types +that may be distinguished by the file extension used: regular text .sst; +master documents, composite documents that incorporate other text, which +can be any regular text or text insert; and inserts the contents of which +are like regular text except these are marked .ssi and are not processed.<br> + +<p> <b>SiSU</b> processing can be done directly against a sisu documents; which +may be located locally or on a remote server for which a url is provided. + +<p> <b>SiSU</b> source markup can be shared with the command: +<p> sisu -s [filename]<br> + +<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.jus.uio.no/sisu/sisu_manual'>http://www.jus.uio.no/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 [^16] + +<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.jus.uio.no/sisu/sisu_manual'>http://www.jus.uio.no/sisu/sisu_manual</a> +> + +<p> 12.1.3 SISU INSERT FILES (.SSI) +<p> Inserts are documents prepared solely for +the purpose of being incorporated into one or more master documents. They +resemble regular <b>SiSU</b> text files except they are ignored by the <b>SiSU</b> processor. +Making a file a .ssi file is a quick and convenient way of flagging that +it is not intended that the file should be processed on its own. +<p> 12.2 SISUPOD, +ZIPPED BINARY CONTAINER (SISUPOD.ZIP, .SSP) +<p> A sisupod is a zipped <b>SiSU</b> +text file or set of <b>SiSU</b> text files and any associated images that they +contain (this will be extended to include sound and multimedia-files) +<p> +<b>SiSU</b> plaintext files rely on a recognised directory structure to find contents +such as images associated with documents, but all images for example for +all documents contained in a directory are located in the sub-directory +_sisu/image. Without the ability to create a sisupod it can be inconvenient +to manually identify all other files associated with a document. A sisupod +automatically bundles all associated files with the document that is turned +into a pod. +<p> The structure of the sisupod is such that it may for example +contain a single document and its associated images; a master document +and its associated documents and anything else; or the zipped contents +of a whole directory of prepared <b>SiSU</b> documents. +<p> The command to create +a sisupod is: +<p> sisu -S [filename]<br> + +<p> Alternatively, make a pod of the contents of a whole directory: +<p> +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.jus.uio.no/sisu/sisu_manual'>http://www.jus.uio.no/sisu/sisu_manual</a> +> +<p> 13. EXPERIMENTAL ALTERNATIVE INPUT +REPRESENTATIONS +<p> 13.1 ALTERNATIVE XML +<p> <b>SiSU</b> offers alternative XML input +representations of documents as a proof of concept, experimental feature. +They are however not strictly maintained, and incomplete and should be +handled with care. +<p> <b>convert from sst to simple xml representations (sax, +dom and node):</b> +<p> sisu --to-sax [filename/wildcard] or sisu --to-sxs [filename/wildcard]<br> + +<p> sisu --to-dom [filename/wildcard] or sisu --to-sxd [filename/wildcard]<br> + +<p> sisu --to-node [filename/wildcard] or sisu --to-sxn [filename/wildcard]<br> + +<p> +<p> <b>convert to sst from any sisu xml representation (sax, dom and node):</b> + +<p> sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]<br> + +<p> or the same: +<p> sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]<br> + +<p> 13.1.1 XML SAX REPRESENTATION +<p> To convert from sst to simple xml (sax) +representation: +<p> sisu --to-sax [filename/wildcard] or sisu --to-sxs [filename/wildcard]<br> + +<p> To convert from any sisu xml representation back to sst +<p> sisu --from-xml2sst +[filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]<br> + +<p> or the same: +<p> sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]<br> + +<p> 13.1.2 XML DOM REPRESENTATION +<p> To convert from sst to simple xml (dom) +representation: +<p> sisu --to-dom [filename/wildcard] or sisu --to-sxd [filename/wildcard]<br> + +<p> To convert from any sisu xml representation back to sst +<p> sisu --from-xml2sst +[filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]<br> + +<p> or the same: +<p> sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]<br> + +<p> 13.1.3 XML NODE REPRESENTATION +<p> To convert from sst to simple xml (node) +representation: +<p> sisu --to-node [filename/wildcard] or sisu --to-sxn [filename/wildcard]<br> + +<p> To convert from any sisu xml representation back to sst +<p> sisu --from-xml2sst +[filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]<br> + +<p> or the same: +<p> sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]<br> + +<p> 14. CONFIGURATION +<p> 14.1 DETERMINING THE CURRENT CONFIGURATION +<p> Information +on the current configuration of <b>SiSU</b> should be available with the help +command: +<p> sisu -v<br> + +<p> which is an alias for: +<p> sisu --help env<br> + +<p> Either of these should be executed from within a directory that contains +sisu markup source documents. +<p> 14.2 CONFIGURATION FILES (CONFIG.YML) +<p> <b>SiSU</b> +configration parameters are adjusted in the configuration file, which can +be used to override the defaults set. This includes such things as which +directory interim processing should be done in and where the generated +output should be placed. +<p> The <b>SiSU</b> configuration file is a yaml file, which +means indentation is significant. +<p> <b>SiSU</b> resource configuration is determined +by looking at the following files if they exist: +<p> ./_sisu/sisurc.yml<br> + +<p> ~/.sisu/sisurc.yml<br> + +<p> /etc/sisu/sisurc.yml<br> + +<p> The search is in the order listed, and the first one found is used. +<p> + In the absence of instructions in any of these it falls back to the internal +program defaults. +<p> Configuration determines the output and processing directories +and the database access details. +<p> If <b>SiSU</b> is installed a sample sisurc.yml + +<p>may be found in /etc/sisu/sisurc.yml +<p> 15. SKINS +<p> Skins modify the default +appearance of document output on a document, directory, or site wide basis. +Skins are looked for in the following locations: +<p> ./_sisu/skin<br> + +<p> ~/.sisu/skin<br> + +<p> /etc/sisu/skin<br> + +<p> <b>Within the skin directory</b> are the following the default sub-directories +for document skins: +<p> ./skin/doc<br> + +<p> ./skin/dir<br> + +<p> ./skin/site<br> + +<p> A skin is placed in the appropriate directory and the file named skin_[name].rb + +<p> The skin itself is a ruby file which modifies the default appearances +set in the program. +<p> 15.1 DOCUMENT SKIN +<p> Documents take on a document skin, +if the header of the document specifies a skin to be used. +<p> +<p> <br> +<pre> @skin: skin_united_nations +</pre> +<p> 15.2 DIRECTORY SKIN +<p> A directory may be mapped on to a particular skin, +so all documents within that directory take on a particular appearance. +If a skin exists in the skin/dir with the same name as the document directory, +it will automatically be used for each of the documents in that directory, +(except where a document specifies the use of another skin, in the skin/doc +directory). +<p> A personal habit is to place all skins within the doc directory, +and symbolic links as needed from the site, or dir directories as required. + +<p> 15.3 SITE SKIN +<p> A site skin, modifies the program default skin. +<p> 15.4 SAMPLE + +<p>SKINS +<p> With <b>SiSU</b> installed sample skins may be found in: +<p> /etc/sisu/skin/doc +and<br> + /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc<br> + +<p> (or equivalent directory) and if sisu-markup-samples is installed also +under: +<p> /usr/share/doc/sisu/sisu_markup_samples/non-free/_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> 16. CSS - CASCADING STYLE SHEETS (FOR HTML, XHTML AND XML) +<p> CSS files +to modify the appearance of <b>SiSU</b> html, XHTML or XML may be placed in the +configuration directory: ./_sisu/css; ~/.sisu/css or; /etc/sisu/css and +these will be copied to the<br> + output directories with the command sisu -CC. +<p> The basic CSS file for html +output is html.css, placing a file of that name in directory _sisu/css or +equivalent will result in the default file of that name being overwritten. + +<p> HTML: html.css +<p> XML DOM: dom.css +<p> XML SAX: sax.css +<p> XHTML: xhtml.css +<p> + The default homepage may use homepage.css or html.css +<p> Under consideration +is to permit the placement of a CSS file with a different name in directory +_sisu/css directory or equivalent, and change the default CSS file that +is looked for in a skin.[^17] +<p> 17. ORGANISING CONTENT +<p> 17.1 DIRECTORY STRUCTURE + +<p>AND MAPPING +<p> The output directory root can be set in the sisurc.yml file. +Under the root, subdirectories are made for each directory in which a document +set resides. If you have a directory named poems or conventions, that directory +will be created under the output directory root and the output for all +documents contained in the directory of a particular name will be generated +to subdirectories beneath that directory (poem or conventions). A document +will be placed in a subdirectory of the same name as the document with +the filetype identifier stripped (.sst .ssm) +<p> The last part of a directory +path, representing the sub-directory in which a document set resides, is +the directory name that will be used for the output directory. This has +implications for the organisation of document collections as it could make +sense to place documents of a particular subject, or type within a directory +identifying them. This grouping as suggested could be by subject (sales_law, +english_literature); or just as conveniently by some other classification +(X University). The mapping means it is also possible to place in the same +output directory documents that are for organisational purposes kept separately, +for example documents on a given subject of two different institutions +may be kept in two different directories of the same name, under a directory +named after each institution, and these would be output to the same output +directory. Skins could be associated with each institution on a directory +basis and resulting documents will take on the appropriate different appearance. + +<p> 17.2 ORGANISING CONTENT +<p> 18. HOMEPAGES +<p> <b>SiSU</b> is about the ability to auto-generate +documents. Home pages are regarded as custom built items, and are not created +by <b>SiSU</b> <b>SiSU</b> has a default home page, which will not be appropriate for +use with other sites, and the means to provide your own home page instead +in one of two ways as part of a site’s configuration, these being: +<p> 1. through +placing your home page and other custom built documents in the subdirectory +_sisu/home/ (this probably being the easier and more convenient option) + +<p> 2. through providing what you want as the home page in a skin, +<p> Document +sets are contained in directories, usually organised by site or subject. +Each directory can/should have its own homepage. See the section on directory +structure and organisation of content. +<p> 18.1 HOME PAGE AND OTHER CUSTOM BUILT + +<p>PAGES IN A SUB-DIRECTORY +<p> Custom built pages, including the home page index.html +may be placed within the configuration directory _sisu/home/ in any of +the locations that is searched for the configuration directory, namely +./_sisu; ~/_sisu; /etc/sisu From there they are copied to the root of the +output directory with the command: +<p> sisu -CC<br> + +<p> 18.2 HOME PAGE WITHIN A SKIN +<p> Skins are described in a separate section, +but basically are a file written in the programming language <b>Ruby</b> that +may be provided to change the defaults that are provided with sisu with +respect to individual documents, a directories contents or for a site. +<p> + If you wish to provide a homepage within a skin the skin should be in +the directory _sisu/skin/dir and have the name of the directory for which +it is to become the home page. Documents in the directory commercial_law +would have the homepage modified in skin_commercial law.rb; or the directory + +<p>poems in skin_poems.rb +<p> +<p> <br> +<pre> class Home + def homepage + # place the html content of your homepage here, this will become +index.html + <<HOME <html> + <head></head> + <doc> + <p>this is my new homepage.</p> + </doc> + </html> + HOME + end + end +</pre> +<p> 19. MARKUP AND OUTPUT EXAMPLES +<p> 19.1 MARKUP EXAMPLES +<p> Current markup examples +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> 21.1 POPULATING SQL TYPE DATABASES + +<p> <b>SiSU</b> feeds sisu markupd documents into sql type databases PostgreSQL[^18] +and/or SQLite[^19] 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<br> + along 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> + formatted and clean text versions for searching); and<br> + +<p> * a third containing endnotes cross-referenced back to the paragraph +from<br> + which they are referenced (both in formatted and clean text versions +for<br> + searching).<br> + +<p> * a fourth table with a one to one relation with the headers table +contains<br> + full text versions of output, eg. pdf, html, xml, and ascii.<br> + +<p> There is of course the possibility to add further structures. +<p> At this +level <b>SiSU</b> loads a relational database with documents chunked into objects, +their smallest logical structurally constituent parts, as text objects, +with their object citation number and all other structural information +needed to construct the document. Text is stored (at this text object level) +with and without elementary markup tagging, the stripped version being +so as to facilitate ease of searching. +<p> Being able to search a relational +database at an object level with the <b>SiSU</b> citation system is an effective +way of locating content generated by <b>SiSU</b> object numbers, and all versions +of the document have the same numbering, complex searches can be tailored +to return just the locations of the search results relevant for all available +output formats, with live links to the precise locations in the database +or in html/xml documents; or, the structural information provided makes +it possible to search the full contents of the database and have headings +in which search content appears, or to search only headings etc. (as the +Dublin Core is incorporated it is easy to make use of that as well). +<p> 22. +POSTGRESQL +<p> 22.1 NAME +<p> <b>SiSU</b> - Structured information, Serialized Units +- a document publishing system, postgresql dependency package +<p> 22.2 DESCRIPTION + +<p> Information related to using postgresql with sisu (and related to the +sisu_postgresql dependency package, which is a dummy package to install +dependencies needed for <b>SiSU</b> to populate a postgresql database, this being +part of <b>SiSU</b> - man sisu). +<p> 22.3 SYNOPSIS +<p> sisu -D [instruction] [filename/wildcard + if required]<br> + +<p> sisu -D --pg --[instruction] [filename/wildcard if required]<br> + +<p> 22.4 COMMANDS +<p> Mappings to two databases are provided by default, postgresql +and sqlite, the same commands are used within sisu to construct and populate +databases however -d (lowercase) denotes sqlite and -D (uppercase) denotes +postgresql, alternatively --sqlite or --pgsql may be used +<p> <b>-D or --pgsql</b> may +be used interchangeably. +<p> 22.4.1 CREATE AND DESTROY DATABASE +<p> +<dl> + +<dt><b>--pgsql --createall</b> +</dt> +<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) +<p> </dd> + +<dt><b>sisu -D --createdb</b> +</dt> +<dd> +<p>creates database where no database existed before +<p> </dd> + +<dt><b>sisu -D --create</b> </dt> +<dd>creates + +<p>database tables where no database tables existed before +<p> </dd> + +<dt><b>sisu -D --Dropall</b> +</dt> +<dd>destroys database (including all its content)! kills data and drops tables, +indexes and database associated with a given directory (and directories +of the same name). +<p> </dd> + +<dt><b>sisu -D --recreate</b> </dt> +<dd>destroys existing database and builds + +<p>a new empty database structure +<p> </dd> +</dl> +22.4.2 IMPORT AND REMOVE DOCUMENTS +<p> +<dl> + +<dt><b>sisu +-D --import -v [filename/wildcard]</b> </dt> +<dd>populates database with the contents of +the file. Imports documents(s) specified to a postgresql database (at an +object level). +<p> </dd> + +<dt><b>sisu -D --update -v [filename/wildcard]</b> </dt> +<dd>updates file contents + +<p>in database +<p> </dd> + +<dt><b>sisu -D --remove -v [filename/wildcard]</b> </dt> +<dd>removes specified document +from postgresql database. +<p> </dd> +</dl> +23. SQLITE +<p> 23.1 NAME +<p> <b>SiSU</b> - Structured information, +Serialized Units - a document publishing system. +<p> 23.2 DESCRIPTION +<p> Information +related to using sqlite with sisu (and related to the sisu_sqlite dependency +package, which is a dummy package to install dependencies needed for <b>SiSU</b> +to populate an sqlite database, this being part of <b>SiSU</b> - man sisu). +<p> 23.3 + +<p>SYNOPSIS +<p> sisu -d [instruction] [filename/wildcard if required]<br> + +<p> sisu -d --(sqlite|pg) --[instruction] [filename/wildcard if <br> + required]<br> + +<p> 23.4 COMMANDS +<p> Mappings to two databases are provided by default, postgresql +and sqlite, the same commands are used within sisu to construct and populate +databases however -d (lowercase) denotes sqlite and -D (uppercase) denotes +postgresql, alternatively --sqlite or --pgsql may be used +<p> <b>-d or --sqlite</b> may +be used interchangeably. +<p> 23.4.1 CREATE AND DESTROY DATABASE +<p> +<dl> + +<dt><b>--sqlite --createall</b> +</dt> +<dd>initial step, creates required relations (tables, indexes) in existing +(sqlite) database (a database should be created manually and given the +same name as working directory, as requested) (rb.dbi) +<p> </dd> + +<dt><b>sisu -d --createdb</b> +</dt> +<dd> +<p>creates database where no database existed before +<p> </dd> + +<dt><b>sisu -d --create</b> </dt> +<dd>creates + +<p>database tables where no database tables existed before +<p> </dd> + +<dt><b>sisu -d --dropall</b> +</dt> +<dd>destroys database (including all its content)! kills data and drops tables, +indexes and database associated with a given directory (and directories +of the same name). +<p> </dd> + +<dt><b>sisu -d --recreate</b> </dt> +<dd>destroys existing database and builds + +<p>a new empty database structure +<p> </dd> +</dl> +23.4.2 IMPORT AND REMOVE DOCUMENTS +<p> +<dl> + +<dt><b>sisu +-d --import -v [filename/wildcard]</b> </dt> +<dd>populates database with the contents of +the file. Imports documents(s) specified to an sqlite database (at an object +level). +<p> </dd> + +<dt><b>sisu -d --update -v [filename/wildcard]</b> </dt> +<dd>updates file contents in database + +<p> </dd> + +<dt><b>sisu -d --remove -v [filename/wildcard]</b> </dt> +<dd>removes specified document from sqlite +database. +<p> </dd> +</dl> +24. INTRODUCTION +<p> 24.1 SEARCH - DATABASE FRONTEND SAMPLE, UTILISING +DATABASE AND SISU FEATURES, INCLUDING OBJECT CITATION NUMBERING (BACKEND +CURRENTLY POSTGRESQL) +<p> Sample search frontend <<a href='http://search.sisudoc.org'>http://search.sisudoc.org</a> +> +[^20] A small database and sample query front-end (search from) that makes +use of the citation system, <i>object</i> citation numbering to demonstrates functionality.[^21] + +<p> <b>SiSU</b> can provide information on which documents are matched and at what +locations within each document the matches are found. These results are +relevant across all outputs using object citation numbering, which includes +html, XML, LaTeX, PDF and indeed the SQL database. You can then refer to +one of the other outputs or in the SQL database expand the text within +the matched objects (paragraphs) in the documents matched. +<p> Note you may +set results either for documents matched and object number locations within +each matched document meeting the search criteria; or display the names +of the documents matched along with the objects (paragraphs) that meet +the search criteria.[^22] +<p> +<dl> + +<dt><b>sisu -F --webserv-webrick</b> </dt> +<dd>builds a cgi web search + +<p>frontend for the database created +<p> The following is feedback on the setup +on a machine provided by the help command: +<p> sisu --help sql<br> + +<p> +<p> <br> +<pre> Postgresql + user: ralph + current db set: SiSU_sisu + port: 5432 + dbi connect: DBI:Pg:database=SiSU_sisu;port=5432 + sqlite + current db set: /home/ralph/sisu_www/sisu/sisu_sqlite.db + dbi connect DBI:SQLite:/home/ralph/sisu_www/sisu/sisu_sqlite.db +</pre> +<p> Note on databases built +<p> By default, [unless otherwise specified] databases +are built on a directory basis, from collections of documents within that +directory. The name of the directory you choose to work from is used as +the database name, i.e. if you are working in a directory called /home/ralph/ebook +the database SiSU_ebook is used. [otherwise a manual mapping for the collection + is +<p> </dd> +</dl> +24.2 SEARCH FORM +<p> +<dl> + +<dt><b>sisu -F</b> </dt> +<dd>generates a sample search form, which must + +<p>be copied to the web-server cgi directory +<p> </dd> + +<dt><b>sisu -F --webserv-webrick</b> </dt> +<dd>generates +a sample search form for use with the webrick server, which must be copied + +<p>to the web-server cgi directory +<p> </dd> + +<dt><b>sisu -Fv</b> </dt> +<dd>as above, and provides some information + +<p>on setting up hyperestraier +<p> </dd> + +<dt><b>sisu -W</b> </dt> +<dd>starts the webrick server which should + +<p>be available wherever sisu is properly installed +<p> The generated search + +<p>form must be copied manually to the webserver directory as instructed +<p> +</dd> +</dl> +25. HYPERESTRAIER +<p> See the documentation for hyperestraier: +<p> <<a href='http://hyperestraier.sourceforge.net/'>http://hyperestraier.sourceforge.net/</a> +><br> + +<p> /usr/share/doc/hyperestraier/index.html<br> + +<p> man estcmd<br> + +<p> on sisu_hyperestraier: +<p> man sisu_hyperestraier<br> + +<p> /usr/share/doc/sisu/sisu_markup/sisu_hyperestraier/index.html<br> + +<p> NOTE: the examples that follow assume that sisu output is placed in + +<p>the directory /home/ralph/sisu_www +<p> (A) to generate the index within the +webserver directory to be indexed: +<p> estcmd gather -sd [index name] [directory + path to index]<br> + +<p> the following are examples that will need to be tailored according to +your needs: +<p> cd /home/ralph/sisu_www<br> + +<p> estcmd gather -sd casket /home/ralph/sisu_www<br> + +<p> you may use the ’find’ command together with ’egrep’ to limit indexing to +particular document collection directories within the web server directory: + +<p> find /home/ralph/sisu_www -type f | egrep<br> + ’/home/ralph/sisu_www/sisu/.+?.html$’ |estcmd gather -sd casket -<br> + +<p> Check which directories in the webserver/output directory (~/sisu_www +or elsewhere depending on configuration) you wish to include in the search +index. +<p> As sisu duplicates output in multiple file formats, it it is probably +preferable to limit the estraier index to html output, and as it may also +be desirable to exclude files ’plain.txt’, ’toc.html’ and ’concordance.html’, as +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> + +<p> from your current document preparation/markup directory, you would construct +a rune along the following lines: +<p> find /home/ralph/sisu_www -type f +| egrep ’/home/ralph/sisu_www/([specify <br> + first directory for inclusion]|[specify second directory for <br> + inclusion]|[another directory for inclusion? ...])/.+?.html$’ |<br> + egrep -v ’(doc|concordance).html$’ |estcmd gather -sd<br> + /home/ralph/sisu_www/casket -<br> + +<p> (B) to set up the search form +<p> (i) copy estseek.cgi to your cgi directory +and set file permissions to 755: +<p> sudo cp -vi /usr/lib/estraier/estseek.cgi +/usr/lib/cgi-bin<br> + +<p> sudo chmod -v 755 /usr/lib/cgi-bin/estseek.cgi<br> + +<p> sudo cp -v /usr/share/hyperestraier/estseek.* /usr/lib/cgi-bin<br> + +<p> [see estraier documentation for paths]<br> + +<p> (ii) edit estseek.conf, with attention to the lines starting ’indexname:’ +and ’replace:’: +<p> indexname: /home/ralph/sisu_www/casket<br> + +<p> replace: ^file:///home/ralph/sisu_www{{!}}<a href='http://localhost'>http://localhost</a> +<br> + +<p> replace: /index.html?${{!}}/<br> + +<p> (C) to test using webrick, start webrick: +<p> sisu -W<br> + +<p> and try open the url: <<a href='http://localhost:8081/cgi-bin/estseek.cgi'>http://localhost:8081/cgi-bin/estseek.cgi</a> +> +<p> 26. SISU_WEBRICK + +<p> 26.1 NAME +<p> <b>SiSU</b> - Structured information, Serialized Units - a document + +<p>publishing system +<p> 26.2 SYNOPSIS +<p> sisu_webrick [port] +<p> or +<p> sisu -W [port] + +<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). +<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>unchanged the default port is 8081 +<p> 26.5 DOCUMENT PROCESSING 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 the defaults have not + +<p>been changed in ~/.sisu/sisurc.yaml then on port 8081 +<p> 26.6 FURTHER INFORMATION + +<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> or man sisu + +<p> 26.7 AUTHOR +<p> Ralph Amissah ralph@amissah.com or ralph.amissah@gmail.com +<p> + +<p>26.8 SEE ALSO +<p> <a href='http:~/bin/man2html?sisu:1'>sisu(1)</a> +<br> + +<p> <a href='http:~/bin/man2html?sisu_vim:7'>sisu_vim(7)</a> +<br> + +<p> <a href='http:~/bin/man2html?sisu:8'>sisu(8)</a> +<br> + +<p> 27. REMOTE SOURCE DOCUMENTS +<p> <b>SiSU</b> processing instructions can be run +against remote source documents by providing the url of the documents against +which the processing instructions are to be carried out. The remote <b>SiSU</b> +documents can either be sisu marked up files in plaintext .sst or .ssm or; +zipped sisu files, sisupod.zip or filename.ssp +<p> <b>.sst / .ssm - sisu text files</b> + +<p> <b>SiSU</b> can be run against source text files on a remote machine, provide +the processing instruction and the url. The source file and any associated +parts (such as images) will be downloaded and generated locally. +<p> +<p> <br> +<pre> sisu -3 http://[provide url to valid .sst or .ssm file] +</pre> +<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 + +<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> +<p> <br> +<pre> sisu -3 http://[provide url to valid sisupod.zip or .ssp file] +</pre> +<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> REMOTE DOCUMENT OUTPUT +<p> 28. REMOTE OUTPUT +<p> +Once properly configured <b>SiSU</b> output can be automatically posted once generated +to a designated remote machine using either rsync, or scp. +<p> In order to +do this some ssh authentication agent and keychain or similar tool will +need to be configured. Once that is done the placement on a remote host +can be done seamlessly with the -r (for scp) or -R (for rsync) flag, which +may be used in conjunction with other processing flags, e.g. +<p> +<p> <br> +<pre> sisu -3R sisu_remote.sst +</pre> +<p> 28.1 COMMANDS +<p> +<dl> + +<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 +<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 +<p> </dd> +</dl> +28.2 CONFIGURATION +<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> 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> 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> +<p> <br> +<pre> aptitude update + aptitude install sisu-complete +</pre> +<p> The following /etc/apt/sources.list setting permits the download of additional +markup samples: +<p> +<p> <br> +<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> +<p> <br> +<pre> aptitude update + aptitude install sisu-complete sisu-markup-samples +</pre> +<p> If there are newer versions of <b>SiSU</b> upstream of the <b>Debian</b> archives, + +<p>they will be available by adding the following to your /etc/apt/sources.list + +<p> +<p> <br> +<pre> #/etc/apt/sources.list + 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> repeat the aptitude commands +<p> +<p> <br> +<pre> aptitude update + aptitude install sisu-complete sisu-markup-samples +</pre> +<p> Note however that it is not necessary to install sisu-complete if not +all components of sisu are to be used. Installing just the package sisu +will provide basic functionality. +<p> 30.1.2 RPM INSTALLATION +<p> RPMs are provided +though untested, they are prepared by running alien against the source +package, and against the debs. +<p> They may be downloaded from: +<p> <<a href='http://www.jus.uio.no/sisu/SiSU/download.html#rpm'>http://www.jus.uio.no/sisu/SiSU/download.html#rpm</a> +><br> + +<p> as root type: +<p> rpm -i [rpm package name]<br> + +<p> 30.1.3 INSTALLATION FROM SOURCE +<p> To install <b>SiSU</b> from source check information +at: +<p> <<a href='http://www.jus.uio.no/sisu/SiSU/download.html#current'>http://www.jus.uio.no/sisu/SiSU/download.html#current</a> +><br> + +<p> * download the source package +<p> * Unpack the source +<p> Two alternative +modes of installation from source are provided, setup.rb (by Minero Aoki) +and a rant(by Stefan Lang) built install file, in either case: the first +steps are the same, download and unpack the source file: +<p> For basic use +<b>SiSU</b> is only dependent on the programming language in which it is written +<b>Ruby</b> , and <b>SiSU</b> will be able to generate html, various XMLs, including +ODF (and will also produce LaTeX). Dependencies required for further actions, +though it relies on the installation of additional dependencies which the +source tarball does not take care of, for things like using a database +(postgresql or sqlite)[^23] or converting LaTeX to pdf. +<p> <b>setup.rb</b> +<p> This +is a standard ruby installer, using setup.rb is a three step process. In +the root directory of the unpacked <b>SiSU</b> as root type: +<p> +<p> <br> +<pre> ruby setup.rb config + ruby setup.rb setup + #[and as root:] + ruby setup.rb install +</pre> +<p> further information on setup.rb is available from: +<p> <<a href='http://i.loveruby.net/en/projects/setup/'>http://i.loveruby.net/en/projects/setup/</a> +><br> + +<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> or for a more complete installation: +<p> ruby install<br> + +<p> or +<p> ruby install base<br> + +<p> This makes use of Rant (by Stefan Lang) and the provided Rantfile. It +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 +<p> <<a href='http://make.rubyforge.org/'>http://make.rubyforge.org/</a> +><br> + +<p> <<a href='http://rubyforge.org/frs/?group_id=615'>http://rubyforge.org/frs/?group_id=615</a> +><br> + +<p> For a list of alternative actions you may type: +<p> ruby install help<br> + +<p> ruby install -T<br> + +<p> 30.2 TESTING SISU, GENERATING OUTPUT +<p> To check which version of sisu +is installed: +<p> sisu -v +<p> Depending on your mode of installation one or +a number of markup sample files may be found either in the directory: +<p> + +<p> or +<p> +<p> change directory to the appropriate one: +<p> cd /usr/share/doc/sisu/sisu_markup_samples/dfsg + +<p> 30.2.1 BASIC TEXT, PLAINTEXT, HTML, XML, ODF +<p> Having moved to the directory +that contains the markup samples (see instructions above if necessary), + +<p>choose a file and run sisu against it +<p> sisu -NhwoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst + +<p> this will generate html including a concordance file, opendocument text +format, plaintext, XHTML and various forms of XML, and OpenDocument text + +<p> 30.2.2 LATEX / PDF +<p> Assuming a LaTeX engine such as tetex or texlive is +installed with the required modules (done automatically on selection of +sisu-pdf in <b>Debian</b> ) +<p> Having moved to the directory that contains the markup +samples (see instructions above if necessary), choose a file and run sisu + +<p>against it +<p> sisu -pv free_as_in_freedom.rms_and_free_software.sam_williams.sst + +<p> sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst +<p> should +generate most available output formats: html including a concordance file, +opendocument text format, plaintext, XHTML and various forms of XML, and + +<p>OpenDocument text and pdf +<p> 30.2.3 RELATIONAL DATABASE - POSTGRESQL, SQLITE + +<p> Relational databases need some setting up - you must have permission to +create the database and write to it when you run sisu. +<p> Assuming you have + +<p>the database installed and the requisite permissions +<p> sisu --sqlite --recreate + +<p> sisu --sqlite -v --import free_as_in_freedom.rms_and_free_software.sam_williams.sst + +<p> sisu --pgsql --recreate +<p> sisu --pgsql -v --import free_as_in_freedom.rms_and_free_software.sam_williams.sst + +<p> 30.3 GETTING HELP +<p> 30.3.1 THE MAN PAGES +<p> Type: +<p> man sisu<br> + +<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> +> +[^24] +<p> * sisu.8 <<a href='http://www.jus.uio.no/sisu/man/sisu.8'>http://www.jus.uio.no/sisu/man/sisu.8</a> +> [^25] +<p> * man directory +<<a href='http://www.jus.uio.no/sisu/man'>http://www.jus.uio.no/sisu/man</a> +> [^26] +<p> 30.3.2 BUILT IN HELP +<p> sisu --help +<p> sisu + +<p>- +<p>- +<p>help --env +<p> sisu --help --commands +<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> +> +<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> <<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> <b>*</b> +<p> +On <b>Debian</b> they are available in non-free[^27] 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/conf/editor-syntax-etc/<br> + +<p> /usr/share/sisu/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> +> +<p> package: sisu-vim<br> + +<p> status: largely done +<p> there is a vim syntax highlighting and folds +component<br> + +<p> * gedit <<a href='http://www.gnome.org/projects/gedit'>http://www.gnome.org/projects/gedit</a> +> +<p> * gobby <<a href='http://gobby.0x539.de/'>http://gobby.0x539.de/</a> +> + +<p> file: sisu.lang<br> + +<p> place in: +<p> /usr/share/gtksourceview-1.0/language-specs<br> + +<p> or +<p> ~/.gnome2/gtksourceview-1.0/language-specs<br> + +<p> status: very basic syntax highlighting<br> + +<p> comments: this editor features display line wrap and is used by Goby!<br> + +<p> * nano <<a href='http://www.nano-editor.org'>http://www.nano-editor.org</a> +> +<p> file: nanorc<br> + +<p> save as: +<p> ~/.nanorc<br> + +<p> status: basic syntax highlighting<br> + +<p> comments: assumes dark background; no display line-wrap; does line +breaks<br> + +<p> * diakonos (an editor written in ruby) <<a href='http://purepistos.net/diakonos'>http://purepistos.net/diakonos</a> +> + +<p> file: diakonos.conf +<p> save as: +<p> ~/.diakonos/diakonos.conf<br> + +<p> includes: +<p> status: basic syntax highlighting<br> + +<p> comments: assumes dark background; no display line-wrap +<p> * kate & kwrite +<<a href='http://kate.kde.org'>http://kate.kde.org</a> +> +<p> file: sisu.xml<br> + +<p> place in:<br> + +<p> /usr/share/apps/katepart/syntax<br> + +<p> or<br> + +<p> ~/.kde/share/apps/katepart/syntax<br> + +<p> [settings::configure kate::{highlighting,filetypes}]<br> + +<p> [tools::highlighting::{markup,scripts}:: .B SiSU ]<br> + +<p> * nedit <<a href='http://www.nedit.org'>http://www.nedit.org</a> +> +<p> file: sisu_nedit.pats<br> + +<p> nedit -import sisu_nedit.pats<br> + +<p> status: a very clumsy first attempt [not really done]<br> + +<p> comments: this editor features display line wrap<br> + +<p> * emacs <<a href='http://www.gnu.org/software/emacs/emacs.html'>http://www.gnu.org/software/emacs/emacs.html</a> +> +<p> files: sisu-mode.el<br> + +<p> to file ~/.emacs add the following 2 lines:<br> + +<p> (add-to-list ’load-path<br> + +<p> (require ’sisu-mode.el)<br> + +<p> [not done / not yet included]<br> + +<p> * vim & gvim <<a href='http://www.vim.org'>http://www.vim.org</a> +> +<p> files:<br> + +<p> package is the most comprehensive sisu syntax highlighting and editor<br> + environment provided to date (is for vim/ gvim, and is separate from +the<br> + contents of this directory)<br> + +<p> status: this includes: syntax highlighting; vim folds; some error +checking<br> + +<p> comments: this editor features display line wrap<br> + +<p> NOTE: +<p> [ .B SiSU parses files with long lines or line breaks, but, display + linewrap (without line-breaks) is a convenient editor feature to have for + sisu markup] +<p> 32. HOW DOES SISU WORK? +<p> <b>SiSU</b> markup is fairly minimalistic, +it consists of: a (largely optional) document header, made up of information +about the document (such as when it was published, who authored it, and +granting what rights) and any processing instructions; and markup within +the substantive text of the document, which is related to document structure +and typeface. <b>SiSU</b> must be able to discern the structure of a document, +(text headings and their levels in relation to each other), either from +information provided in the document header or from markup within the text +(or from a combination of both). Processing is done against an abstraction +of the document comprising of information on the document’s structure and +its objects,[2] which the program serializes (providing the object numbers) +and which are assigned hash sum values based on their content. This abstraction +of information about document structure, objects, (and hash sums), provides +considerable flexibility in representing documents different ways and for +different purposes (e.g. search, document layout, publishing, content certification, +concordance etc.), and makes it possible to take advantage of some of the +strengths of established ways of representing documents, (or indeed to +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, +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> + +<p> * XML - both in sax and dom style xml structures for further development +as<br> + required<br> + +<p> * ODF - open document format, the iso standard for document storage<br> + +<p> * LaTeX - used to generate pdf<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> + +<p> Also produces: concordance files; document content certificates (md5 +or sha256 digests of headings, paragraphs, images etc.) and html manifests +(and sitemaps of content). (b) takes advantage of the strengths implicit +in these very different output types, (e.g. PDFs produced using typesetting +of LaTeX, databases populated with documents at an individual object/paragraph +level, making possible granular search (and related possibilities)) +<p> * +ensuring content can be cited in a meaningful way regardless of selected +output format. Online publishing (and publishing in multiple document formats) +lacks a useful way of citing text internally within documents (important +to academics generally and to lawyers) as page numbers are meaningless +across browsers and formats. sisu seeks to provide a common way of pinpoint +the text within a document, (which can be utilized for citation and by +search engines). The outputs share a common numbering system that is meaningful +(to man and machine) across all digital outputs whether paper, screen, +or database oriented, (pdf, HTML, xml, sqlite, postgresql), this numbering +system can be used to reference content. +<p> * Granular search within documents. +SQL databases are populated at an object level (roughly headings, paragraphs, +verse, tables) and become searchable with that degree of granularity, 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> * 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 (open document text) module in 2006 +and in future html5 output sometime in future, without modification of + +<p>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, 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 + +<p>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 + +<p>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> <b>man page</b> +<p> man sisu_help<br> + +<p> <b>man2html</b> +<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_help.1.html'>http://www.jus.uio.no/sisu/man/sisu_help.1.html</a> +><br> + +<p> <b>sisu generated output - links to html</b> +<p> <<a href='http://sisudoc.org/sisu/sisu_help/index.html'>http://sisudoc.org/sisu/sisu_help/index.html</a> +><br> + +<p> <b>help sources lists</b> +<p> Alternative sources for this help sources page +listed here: +<p> man sisu_help_sources<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> 34.1 MAN PAGES +<p> 34.1.1 MAN +<p> man sisu<br> + +<p> man 7 sisu_complete<br> + +<p> man 7 sisu_pdf<br> + +<p> man 7 sisu_postgresql<br> + +<p> man 7 sisu_sqlite<br> + +<p> man sisu_termsheet<br> + +<p> man sisu_webrick<br> + +<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, and odf which may be also be accessed via the +html pages[^28] +<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> +> + +<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/html/sisu.1.html> + +<p> <file:///usr/share/doc/sisu/html/sisu_help.1.html> +<p> <file:///usr/share/doc/sisu/html/sisu_help_sources.1.html> + +<p> /usr/share/doc/sisu/html/sisu.1.html<br> + +<p> /usr/share/doc/sisu/html/sisu_pdf.7.html<br> + +<p> /usr/share/doc/sisu/html/sisu_postgresql.7.html<br> + +<p> /usr/share/doc/sisu/html/sisu_sqlite.7.html<br> + +<p> /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> +> +<p> <<a href='http://www.jus.uio.no/sisu/man/sisu.1.html'>http://www.jus.uio.no/sisu/man/sisu.1.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_complete.7.html'>http://www.jus.uio.no/sisu/man/sisu_complete.7.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_pdf.7.html'>http://www.jus.uio.no/sisu/man/sisu_pdf.7.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_postgresql.7.html'>http://www.jus.uio.no/sisu/man/sisu_postgresql.7.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_sqlite.7.html'>http://www.jus.uio.no/sisu/man/sisu_sqlite.7.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_webrick.1.html'>http://www.jus.uio.no/sisu/man/sisu_webrick.1.html</a> +><br> + +<p> DOCUMENT INFORMATION (METADATA) +<p> METADATA +<p> Document Manifest @ <<a href='http://sisudoc.org/sisu_manual/sisu/sisu_manifest.html'>http://sisudoc.org/sisu_manual/sisu/sisu_manifest.html</a> +> + +<p> <b>Dublin Core</b> (DC) +<p> <i>DC</i> tags included with this document are provided here. + +<p> Title: <i>SiSU</i> - Manual +<p> Creator: <i>Ralph</i> Amissah +<p> Rights: <i>Copyright</i> (C) Ralph +Amissah 2008, part of SiSU documentation, License GPL 3 +<p> Type: <i>information</i> + +<p> Date created: <i>2002-08-28</i> +<p> Date issued: <i>2002-08-28</i> +<p> Date available: <i>2002-08-28</i> + +<p> Date modified: <i>2008-12-16</i> +<p> Date: <i>2008-12-16</i> +<p> +<p> <b>Version Information</b> +<p> Sourcefile: + +<p><i>sisu.ssm.sst</i> +<p> Filetype: <i>SiSU</i> text insert 0.67 +<p> Sourcefile Digest, MD5(sisu.ssm.sst)= + +<p><i>96d1e268b43e0430a2720e67a5876e5e</i> +<p> Skin_Digest: MD5(skin_sisu_manual.rb)= + +<p><i>072b2584bedea82ea8a416587b9fa244</i> +<p> <b>Generated</b> +<p> Document (metaverse) last +generated: <i>Tue</i> Dec 16 00:16:50 -0500 2008 +<p> Generated by: <i>SiSU</i> <i>0.70.2</i> of 2008w50/2 +(2008-12-16) +<p> Ruby version: <i>ruby</i> 1.8.7 (2008-08-11 patchlevel 72) [i486-linux] + +<p> +<ol> +<b>.</b><li>objects include: headings, paragraphs, verse, tables, images, but not +footnotes/endnotes which are numbered separately and tied to the object +from which they are referenced. </li><b>.</b><li>i.e. the html, pdf, odf outputs are each built +individually and optimised for that form of presentation, rather than for +example the html being a saved version of the odf, or the pdf being a saved +version of the html. </li><b>.</b><li>the different heading levels </li><b>.</b><li>units of text, primarily +paragraphs and headings, also any tables, poems, code-blocks </li><b>.</b><li>Specification +submitted by Adobe to ISO to become a full open ISO specification <<a href='http://www.linux-watch.com/news/NS7542722606.html'>http://www.linux-watch.com/news/NS7542722606.html</a> +> +</li><b>.</b><li>ISO/IEC 26300:2006 </dd> + +<dt><b>*1.</b> </dt> +<dd>square brackets </dd> + +<dt><b>*2.</b> </dt> +<dd>square brackets </dd> + +<dt><b>+1.</b> </dt> +<dd>square brackets +</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><<a href='http://www.jus.uio.no/sisu/man/sisu.1.html'>http://www.jus.uio.no/sisu/man/sisu.1.html</a> +> </li><b>.</b><li>From +sometime after SiSU 0.58 it should be possible to describe SiSU markup using +SiSU, which though not an original design goal is useful. </li><b>.</b><li>files should be +prepared using UTF-8 character encoding </li><b>.</b><li>a footnote or endnote </li><b>.</b><li>self contained +endnote marker & endnote in one </dd> + +<dt><b>*.</b> </dt> +<dd>unnumbered asterisk footnote/endnote, +insert multiple asterisks if required </dd> + +<dt><b>**.</b> </dt> +<dd>another unnumbered asterisk footnote/endnote +</dd> + +<dt><b>*3.</b> </dt> +<dd>editors notes, numbered asterisk footnote/endnote series </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> +> +</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>.B SiSU has worked this way in the past, though this was dropped +as it was thought the complexity outweighed the flexibility, however, the +balance was rather fine and this behaviour could be reinstated. </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/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://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> </dd> + +<dt>Other versions +of this document: </dt> +<dd></dd> + +<dt>manifest: <<a href='http://www.jus.uio.no/sisu/sisu/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu/sisu_manifest.html</a> +</a> +> +</dt> +<dd></dd> + +<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu/toc.html'><a href='http://www.jus.uio.no/sisu/sisu/toc.html'>http://www.jus.uio.no/sisu/sisu/toc.html</a> +</a> +> </dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu/portrait.pdf'>http://www.jus.uio.no/sisu/sisu/portrait.pdf</a> +</a> +> +</dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu/landscape.pdf'>http://www.jus.uio.no/sisu/sisu/landscape.pdf</a> +</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.70.2 of 2008w50/2 (2008-12-16) </dt> +<dd></dd> + +<dt>* Ruby version: ruby +1.8.7 (2008-08-11 patchlevel 72) [i486-linux] </dt> +<dd></dd> + +<dt>* Last Generated on: Tue Dec 16 +00:16:50 -0500 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> + +<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> +</ul> +</body> +</html> diff --git a/data/doc/sisu/v1/html/sisu.8.html b/data/doc/sisu/v1/html/sisu.8.html new file mode 100644 index 00000000..c6134b33 --- /dev/null +++ b/data/doc/sisu/v1/html/sisu.8.html @@ -0,0 +1,273 @@ + <!-- 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/v1/html/sisu_complete.7.html b/data/doc/sisu/v1/html/sisu_complete.7.html new file mode 100644 index 00000000..51afaa87 --- /dev/null +++ b/data/doc/sisu/v1/html/sisu_complete.7.html @@ -0,0 +1,54 @@ + <!-- manual page source format generated by PolyglotMan v3.2, --> +<!-- available at http://polyglotman.sourceforge.net/ --> + +<html> +<head> +<title>sisu_complete(7) 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, complete dependency package <p> + +<h2><a name='sect1' href='#toc1'>Synopsis</a></h2> +Dummy package installs +the whole of SiSU, excluding sisu-examples <p> +sisu-complete together with sisu-examples +is the whole of sisu +<h2><a name='sect2' href='#toc2'>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='sect3' href='#toc3'>Author</a></h2> +Ralph Amissah <i><ralph@amissah.com></i> +or <i><ralph.amissah@gmail.com></i> +<h2><a name='sect4' href='#toc4'>See</a></h2> +<a href='http:~/bin/man2html?sisu:1'><b>sisu(1)</a> +,</b> <a href='http:~/bin/man2html?sisu:8'><b>sisu(8)</a> +,</b> +<h2><a name='sect5' href='#toc5'>Also</a></h2> +<a href='http:~/bin/man2html?sisu_webrick:1'><b>sisu_webrick(1)</a> +,</b> <a href='http:~/bin/man2html?sisu_pdf:7'><b>sisu_pdf(7)</b></a> + +<a href='http:~/bin/man2html?sisu_sqlite:7'><b>sisu_sqlite(7)</b></a> + <a href='http:~/bin/man2html?sisu_postgresql:7'><b>sisu_postgresql(7)</b></a> + <a href='http:~/bin/man2html?sisu_vim:7'><b>sisu_vim(7)</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'>Further Information</a></li> +<li><a name='toc3' href='#sect3'>Author</a></li> +<li><a name='toc4' href='#sect4'>See</a></li> +<li><a name='toc5' href='#sect5'>Also</a></li> +</ul> +</body> +</html> diff --git a/data/doc/sisu/v1/html/sisu_pdf.7.html b/data/doc/sisu/v1/html/sisu_pdf.7.html new file mode 100644 index 00000000..4c2f884e --- /dev/null +++ b/data/doc/sisu/v1/html/sisu_pdf.7.html @@ -0,0 +1,171 @@ +<!-- manual page source format generated by PolyglotMan v3.2, --> +<!-- available at http://polyglotman.sourceforge.net/ --> + +<html> +<head> +<title>"sisu_pdf"("1") manual page</title> +</head> +<body bgcolor='white'> +<a href='#toc'>Table of Contents</a><p> + +<h2><a name='sect0' href='#toc0'>Name</a></h2> +sisu - package to install what sisu needs to generate pdf (latex to +pdf dependency component) +<h2><a name='sect1' href='#toc1'>Synopsis</a></h2> +sisu -pv [filename/wildcard ] SISU - PDF, +RALPH AMISSAH +<p> 1. SISU PDF +<p> 1.1 NAME +<p> <b>SiSU</b> - Structured information, Serialized +Units - a document publishing system. +<p> 1.2 DESCRIPTION +<p> Information creating +pdf output with sisu (and related to the sisu_pdf dependency package, which +is a dummy package to install dependencies needed for <b>SiSU</b> to generate +pdfs (primarily related to LaTeX), sisu_pdf being part of <b>SiSU</b> - man sisu). + +<p> <b>SiSU</b> generates LaTeX which is converted by LaTeX tools to pdf. +<p> 1.3 SYNOPSIS + +<p> sisu -pv [filename/wildcard]<br> + +<p> 1.4 COMMANDS +<p> +<dl> + +<dt><b> sisu -pv [filename/wildcard]</b> </dt> +<dd>creates two pdf documents: vertical +(portrait.pdf) and; horizontal (landscape.pdf). <b>SiSU</b> generates LaTeX output +which is converted to pdf if the appropriate LaTeX dependencies are met +on the system. +<p> </dd> + +<dt><b> sisu -pv --papersize-a4 [filename/wildcard]</b> </dt> +<dd>overrides the default +papersize set to A4. Preset alternative sizes include: ’A4’, U.S. ’letter’ and +’legal’ and book sizes ’A5’ and ’B5’ (system defaults to A4). +<p> </dd> +</dl> +1.5 SETTING PAPER + +<p>SIZE +<p> The paper-size may be set to any of the following sizes: ’A4’, U.S. ’letter’ +and ’legal’ and book sizes: ’A5’ and ’B5’ +<p> 1. The preset default if not otherwise +given in the configuration file or elsewhere is A4. +<p> 2. The default paper +size may be set in the configuration file sisurc.yml. See sisu_configuration: + +<p> +<p> <br> +<pre> #% papersize, (LaTeX/pdf) current values A4, US_letter, book_b5, book_a5, +US_legal + default: + papersize: ’A4’ +</pre> +<p> 3. Paper size may be set in a document header: +<p> +<p> <br> +<pre> @papersize: (A4|US_letter|book_B5|book_A5|US_legal) +</pre> +<p> 4. or provided with additional command line parameter, e.g. +<p> sisu -pv +--papersize-a4 [filename/wildcard]<br> + +<p> DOCUMENT INFORMATION (METADATA) +<p> METADATA +<p> Document Manifest @ <<a href='http://sisudoc.org/sisu_manual/sisu_pdf/sisu_manifest.html'>http://sisudoc.org/sisu_manual/sisu_pdf/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> - PDF +<p> DC Creator: <i>Ralph</i> Amissah +<p> DC Rights: <i>Copyright</i> +(C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +<p> DC +Type: <i>information</i> +<p> DC Date created: <i>2002-08-28</i> +<p> DC Date issued: <i>2002-08-28</i> + +<p> DC Date available: <i>2002-08-28</i> +<p> DC Date modified: <i>2007-09-16</i> +<p> DC Date: <i>2007-09-16</i> + +<p> <b>Version Information</b> +<p> Sourcefile: <i>sisu_pdf.sst</i> +<p> Filetype: <i>SiSU</i> text 0.58 + +<p> Sourcefile Digest, MD5(sisu_pdf.sst)= <i>bed13854370b5daf1b1541527e8946b7</i> + +<p> Skin_Digest: MD5(skin_sisu_manual.rb)= <i>20fc43cf3eb6590bc3399a1aef65c5a9</i> + +<p> <b>Generated</b> +<p> Document (metaverse) last generated: <i>Sat</i> Sep 29 17:05:37 + +<p>+0100 2007 +<p> Generated by: <i>SiSU</i> <i>0.59.1</i> of 2007w39/2 (2007-09-25) +<p> Ruby version: +<i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36) [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_pdf/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_pdf/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_pdf/sisu_manifest.html</a> +</a> +> +</dt> +<dd></dd> + +<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_pdf/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_pdf/toc.html'>http://www.jus.uio.no/sisu/sisu_pdf/toc.html</a> +</a> +> </dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_pdf/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_pdf/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_pdf/portrait.pdf</a> +</a> +> +</dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_pdf/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_pdf/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_pdf/landscape.pdf</a> +</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.59.1 of 2007w39/2 (2007-09-25) </dt> +<dd></dd> + +<dt>* Ruby version: ruby +1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt> +<dd></dd> + +<dt>* Last Generated on: Sat Sep 29 +17:05:39 +0100 2007 </dt> +<dd></dd> + +<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> + </dt> +<dd></dd> +</dl> +<p> + +<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> +</ul> +</body> +</html> diff --git a/data/doc/sisu/v1/html/sisu_postgresql.7.html b/data/doc/sisu/v1/html/sisu_postgresql.7.html new file mode 100644 index 00000000..73cbabf3 --- /dev/null +++ b/data/doc/sisu/v1/html/sisu_postgresql.7.html @@ -0,0 +1,198 @@ +<!-- manual page source format generated by PolyglotMan v3.2, --> +<!-- available at http://polyglotman.sourceforge.net/ --> + +<html> +<head> +<title>"sisu_postgresql"("1") manual page</title> +</head> +<body bgcolor='white'> +<a href='#toc'>Table of Contents</a><p> + +<h2><a name='sect0' href='#toc0'>Name</a></h2> +sisu - package to install what sisu needs to to populate a postgresql +database (postgresql dependency component) +<h2><a name='sect1' href='#toc1'>Synopsis</a></h2> +sisu -Dv [filename/wildcard +] sisu -Dv [instruction] SISU - SEARCH, RALPH AMISSAH +<p> 1. POSTGRESQL +<p> 1.1 + +<p>NAME +<p> <b>SiSU</b> - Structured information, Serialized Units - a document publishing +system, postgresql dependency package +<p> 1.2 DESCRIPTION +<p> Information related +to using postgresql with sisu (and related to the sisu_postgresql dependency +package, which is a dummy package to install dependencies needed for <b>SiSU</b> +to populate a postgresql database, this being part of <b>SiSU</b> - man sisu). +<p> + +<p>1.3 SYNOPSIS +<p> sisu -D [instruction] [filename/wildcard if required]<br> + +<p> sisu -D --pg --[instruction] [filename/wildcard if required]<br> + +<p> 1.4 COMMANDS +<p> Mappings to two databases are provided by default, postgresql +and sqlite, the same commands are used within sisu to construct and populate +databases however -d (lowercase) denotes sqlite and -D (uppercase) denotes +postgresql, alternatively --sqlite or --pgsql may be used +<p> <b>-D or --pgsql</b> may +be used interchangeably. +<p> 1.4.1 CREATE AND DESTROY DATABASE +<p> +<dl> + +<dt><b> --pgsql --createall</b> +</dt> +<dd> initial step, creates required relations (tables, indexes) in existing + (postgresql) database (a database should be created (postgresql dependency +component) manually and given the same name as working directory, as requested) + (rb.dbi) the same name as working directory, as +<p> </dd> + +<dt><b> sisu -D --createdb</b> </dt> +<dd> creates + database where no database existed before as +<p> </dd> + +<dt><b> sisu -D --create</b> </dt> +<dd> creates database + tables where no database tables existed before database tables where no + database tables existed +<p> </dd> + +<dt><b> sisu -D --Dropall</b> </dt> +<dd> destroys database (including all + its content)! kills data and drops tables, indexes and database associated + with a given directory (and directories of the same name). a +<p> </dd> + +<dt><b> sisu -D --recreate</b> +</dt> +<dd> +<p> destroys existing database and builds a new empty database structure +<p> </dd> +</dl> +1.4.2 + +<p>IMPORT AND REMOVE DOCUMENTS +<p> +<dl> + +<dt><b> sisu -D --import -v [filename/wildcard]</b> </dt> +<dd>populates +database with the contents of the file. Imports documents(s) specified to +a postgresql database (at an object level). +<p> </dd> + +<dt><b> sisu -D --update -v [filename/wildcard]</b> +</dt> +<dd> +<p>updates file contents in database +<p> </dd> + +<dt><b> sisu -D --remove -v [filename/wildcard]</b> +</dt> +<dd>removes specified document from postgresql database. +<p> </dd> +</dl> +DOCUMENT INFORMATION +(METADATA) +<p> METADATA +<p> Document Manifest @ <<a href='http://sisudoc.org/sisu_manual/sisu_postgresql/sisu_manifest.html'>http://sisudoc.org/sisu_manual/sisu_postgresql/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> - Search +<p> DC Creator: <i>Ralph</i> Amissah +<p> DC Rights: <i>Copyright</i> +(C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +<p> DC +Type: <i>information</i> +<p> DC Date created: <i>2002-08-28</i> +<p> DC Date issued: <i>2002-08-28</i> + +<p> DC Date available: <i>2002-08-28</i> +<p> DC Date modified: <i>2007-09-16</i> +<p> DC Date: <i>2007-09-16</i> + +<p> <b>Version Information</b> +<p> Sourcefile: <i>sisu_postgresql.sst</i> +<p> Filetype: <i>SiSU</i> + +<p>text 0.58 +<p> Sourcefile Digest, MD5(sisu_postgresql.sst)= <i>9010e85001c50e30ba2ab69f9097825a</i> + +<p> Skin_Digest: MD5(skin_sisu_manual.rb)= <i>20fc43cf3eb6590bc3399a1aef65c5a9</i> + +<p> <b>Generated</b> +<p> Document (metaverse) last generated: <i>Sat</i> Sep 29 17:05:38 + +<p>+0100 2007 +<p> Generated by: <i>SiSU</i> <i>0.59.1</i> of 2007w39/2 (2007-09-25) +<p> Ruby version: +<i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36) [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_postgresql/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_postgresql/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_postgresql/sisu_manifest.html</a> +</a> +> +</dt> +<dd></dd> + +<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_postgresql/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_postgresql/toc.html'>http://www.jus.uio.no/sisu/sisu_postgresql/toc.html</a> +</a> +> </dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_postgresql/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_postgresql/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_postgresql/portrait.pdf</a> +</a> +> +</dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_postgresql/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_postgresql/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_postgresql/landscape.pdf</a> +</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.59.1 of 2007w39/2 (2007-09-25) </dt> +<dd></dd> + +<dt>* Ruby version: ruby +1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt> +<dd></dd> + +<dt>* Last Generated on: Sat Sep 29 +17:05:39 +0100 2007 </dt> +<dd></dd> + +<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> + </dt> +<dd></dd> +</dl> +<p> + +<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> +</ul> +</body> +</html> diff --git a/data/doc/sisu/v1/html/sisu_sqlite.7.html b/data/doc/sisu/v1/html/sisu_sqlite.7.html new file mode 100644 index 00000000..7559ff17 --- /dev/null +++ b/data/doc/sisu/v1/html/sisu_sqlite.7.html @@ -0,0 +1,196 @@ +<!-- manual page source format generated by PolyglotMan v3.2, --> +<!-- available at http://polyglotman.sourceforge.net/ --> + +<html> +<head> +<title>"sisu_sqlite"("1") manual page</title> +</head> +<body bgcolor='white'> +<a href='#toc'>Table of Contents</a><p> + +<h2><a name='sect0' href='#toc0'>Name</a></h2> +sisu - package to install what sisu needs to to populate a postgresql +database (postgresql dependency component) +<h2><a name='sect1' href='#toc1'>Synopsis</a></h2> +sisu -dv [filename/wildcard +] sisu -dv [instruction] SISU - SEARCH, RALPH AMISSAH +<p> 1. SQLITE +<p> 1.1 NAME + +<p> <b>SiSU</b> - Structured information, Serialized Units - a document publishing +system. +<p> 1.2 DESCRIPTION +<p> Information related to using sqlite with sisu +(and related to the sisu_sqlite dependency package, which is a dummy package +to install dependencies needed for <b>SiSU</b> to populate an sqlite database, +this being part of <b>SiSU</b> - man sisu). +<p> 1.3 SYNOPSIS +<p> sisu -d [instruction] + [filename/wildcard if required]<br> + +<p> sisu -d --(sqlite|pg) --[instruction] [filename/wildcard if <br> + required]<br> + +<p> 1.4 COMMANDS +<p> Mappings to two databases are provided by default, postgresql +and sqlite, the same commands are used within sisu to construct and populate +databases however -d (lowercase) denotes sqlite and -D (uppercase) denotes +postgresql, alternatively --sqlite or --pgsql may be used +<p> <b>-d or --sqlite</b> may +be used interchangeably. +<p> 1.4.1 CREATE AND DESTROY DATABASE +<p> +<dl> + +<dt><b> --sqlite --createall</b> +</dt> +<dd> initial step, creates required relations (tables, indexes) in existing + (sqlite) database (a database should be created as requested) (rb.dbi) the + same name as working directory, as +<p> </dd> + +<dt><b> sisu -d --createdb</b> </dt> +<dd> creates database where + no database existed before as +<p> </dd> + +<dt><b> sisu -d --create</b> </dt> +<dd> creates database tables where + no database tables existed before database tables where no database tables + existed +<p> </dd> + +<dt><b> sisu -d --dropall</b> </dt> +<dd> destroys database (including all its content)! + kills data and drops tables, indexes and database associated with a given + directory (and directories of the same name). a +<p> </dd> + +<dt><b> sisu -d --recreate</b> </dt> +<dd> destroys + +<p> existing database and builds a new empty database structure +<p> </dd> +</dl> +1.4.2 IMPORT + +<p>AND REMOVE DOCUMENTS +<p> +<dl> + +<dt><b> sisu -d --import -v [filename/wildcard]</b> </dt> +<dd>populates database +with the contents of the file. Imports documents(s) specified to an sqlite +database (at an object level). +<p> </dd> + +<dt><b> sisu -d --update -v [filename/wildcard]</b> </dt> +<dd>updates + +<p>file contents in database +<p> </dd> + +<dt><b> sisu -d --remove -v [filename/wildcard]</b> </dt> +<dd>removes +specified document from sqlite database. +<p> </dd> +</dl> +DOCUMENT INFORMATION (METADATA) + +<p> METADATA +<p> Document Manifest @ <<a href='http://sisudoc.org/sisu_manual/sisu_sqlite/sisu_manifest.html'>http://sisudoc.org/sisu_manual/sisu_sqlite/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> - Search +<p> DC Creator: <i>Ralph</i> Amissah +<p> DC Rights: <i>Copyright</i> +(C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +<p> DC +Type: <i>information</i> +<p> DC Date created: <i>2002-08-28</i> +<p> DC Date issued: <i>2002-08-28</i> + +<p> DC Date available: <i>2002-08-28</i> +<p> DC Date modified: <i>2007-09-16</i> +<p> DC Date: <i>2007-09-16</i> + +<p> <b>Version Information</b> +<p> Sourcefile: <i>sisu_sqlite.sst</i> +<p> Filetype: <i>SiSU</i> text + +<p>0.58 +<p> Sourcefile Digest, MD5(sisu_sqlite.sst)= <i>c4717fcab8a43de498d41a916bb99551</i> + +<p> Skin_Digest: MD5(skin_sisu_manual.rb)= <i>20fc43cf3eb6590bc3399a1aef65c5a9</i> + +<p> <b>Generated</b> +<p> Document (metaverse) last generated: <i>Sat</i> Sep 29 17:05:38 + +<p>+0100 2007 +<p> Generated by: <i>SiSU</i> <i>0.59.1</i> of 2007w39/2 (2007-09-25) +<p> Ruby version: +<i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36) [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_sqlite/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_sqlite/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_sqlite/sisu_manifest.html</a> +</a> +> +</dt> +<dd></dd> + +<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_sqlite/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_sqlite/toc.html'>http://www.jus.uio.no/sisu/sisu_sqlite/toc.html</a> +</a> +> </dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_sqlite/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_sqlite/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_sqlite/portrait.pdf</a> +</a> +> +</dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_sqlite/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_sqlite/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_sqlite/landscape.pdf</a> +</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.59.1 of 2007w39/2 (2007-09-25) </dt> +<dd></dd> + +<dt>* Ruby version: ruby +1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt> +<dd></dd> + +<dt>* Last Generated on: Sat Sep 29 +17:05:39 +0100 2007 </dt> +<dd></dd> + +<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> + </dt> +<dd></dd> +</dl> +<p> + +<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> +</ul> +</body> +</html> diff --git a/data/doc/sisu/v1/html/sisu_termsheet.1.html b/data/doc/sisu/v1/html/sisu_termsheet.1.html new file mode 100644 index 00000000..e91cd9d7 --- /dev/null +++ b/data/doc/sisu/v1/html/sisu_termsheet.1.html @@ -0,0 +1,63 @@ + <!-- manual page source format generated by PolyglotMan v3.2, --> +<!-- available at http://polyglotman.sourceforge.net/ --> + +<html> +<head> +<title>sisu_termsheet(1) 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> +<p> +<b>sisu</b> <b>-t</b> <i>[termsheet-name(s)]</i> +<h2><a name='sect2' href='#toc2'>Description</a></h2> +<b>sisu_termsheet</b> +<i>is</i> part of SiSU is <b>invoked</b> <i>through</i> the sisu command (man sisu) <p> + +<h2><a name='sect3' href='#toc3'>Summary +of man page</a></h2> +<p> +sisu_termsheet, is started with the command: <b>sisu -t</b> <i>[termsheet-name(s)]</i> + +<h2><a name='sect4' href='#toc4'>Document Processing Command Flags</a></h2> +<p> +<b>sisu</b><i> -t</i><b> [termsheet-name(s)]</b> (runs sisu_termsheet) +merges the termsheet(s) specified on the commandline with the documents +it is instructed to merge in the termsheet(s), and produces regular <i>SiSU</i> +output documents from the merged results. <p> +[further documentation on termsheets +required] +<h2><a name='sect5' href='#toc5'>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='sect6' href='#toc6'>Author</a></h2> +Ralph Amissah <i><ralph@amissah.com></i> or <i><ralph.amissah@gmail.com></i> + +<h2><a name='sect7' href='#toc7'>See Also</a></h2> +<a href='http:~/bin/man2html?sisu:1'><b>sisu(1)</a> +,</b> <a href='http:~/bin/man2html?sisu:8'><b>sisu(8)</a> +,</b> <a href='http:~/bin/man2html?sisu_webrick:1'><b>sisu_webrick(1)</a> +,</b> <a href='http:~/bin/man2html?sisu_vim:7'><b>sisu_vim(7)</b></a> + <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'>Summary of man page</a></li> +<li><a name='toc4' href='#sect4'>Document Processing Command Flags</a></li> +<li><a name='toc5' href='#sect5'>Further Information</a></li> +<li><a name='toc6' href='#sect6'>Author</a></li> +<li><a name='toc7' href='#sect7'>See Also</a></li> +</ul> +</body> +</html> diff --git a/data/doc/sisu/v1/html/sisu_vim.7.html b/data/doc/sisu/v1/html/sisu_vim.7.html new file mode 100644 index 00000000..cb4a347b --- /dev/null +++ b/data/doc/sisu/v1/html/sisu_vim.7.html @@ -0,0 +1,153 @@ +<!-- manual page source format generated by PolyglotMan v3.2, --> +<!-- available at http://polyglotman.sourceforge.net/ --> + +<html> +<head> +<title>"sisu_vim"("1") manual page</title> +</head> +<body bgcolor='white'> +<a href='#toc'>Table of Contents</a><p> + +<h2><a name='sect0' href='#toc0'>Name</a></h2> + sisu_vim - vim syntax and folds file for sisu: markup, structuring, +publishing in multiple standard formats, and search<br> + SISU - VIM, RALPH AMISSAH +<p> SISU VIM +<p> 1. SISU VIM +<p> <b>Synopsis</b> +<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/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> +><br> + +<p> <b>SiSU</b> also provides an ftplugin to provide vim folds for <b>SiSU</b> markup, +and to set some defaults for <b>SiSU</b> markup in installed by sisu. +<p> Vim 7 includes +sisu markup syntax highlighting. +<p> Vim related files are included in: /usr/share/sisu/conf/editor-syntax-etc/vim +(including the syntax highlighter, together with an ftplugin which may +be sourced if so desired from your vimrc). +<p> sisu-vim actions are activated +on files with the suffix .sst .ssm .ssi .-sst ._sst (and the same with a further +.meta extension)<br> + +<p> +<p> <br> +<pre> <ctrl>F activate folds on headings matched in a document + (also provides folds when sourced on a ruby program file), + also :F + <ctrl>S search and replace down + <ctrl>G search and replace globally within file + <ctrl>X ruby regex global search and replace within file + <ctrl>C set color scheme to slate which is provided +</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> 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> +> +</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> + +<hr><p> +<a name='toc'><b>Table of Contents</b></a><p> +<ul> +<li><a name='toc0' href='#sect0'>Name</a></li> +</ul> +</body> +</html> diff --git a/data/doc/sisu/v1/html/sisu_webrick.1.html b/data/doc/sisu/v1/html/sisu_webrick.1.html new file mode 100644 index 00000000..8250affe --- /dev/null +++ b/data/doc/sisu/v1/html/sisu_webrick.1.html @@ -0,0 +1,169 @@ +<!-- manual page source format generated by PolyglotMan v3.2, --> +<!-- available at http://polyglotman.sourceforge.net/ --> + +<html> +<head> +<title>"sisu_webrick"("1") manual page</title> +</head> +<body bgcolor='white'> +<a href='#toc'>Table of Contents</a><p> + +<h2><a name='sect0' href='#toc0'>Name</a></h2> +sisu - documents: structuring, publishing in multiple formats, and search + +<h2><a name='sect1' href='#toc1'>Synopsis</a></h2> +sisu -W SISU - SISU_WEBRICK, RALPH AMISSAH +<p> SISU WEBRICK +<p> 1. SISU_WEBRICK + +<p> 1.1 NAME +<p> <b>SiSU</b> - Structured information, Serialized Units - a document + +<p>publishing system +<p> 1.2 SYNOPSIS +<p> sisu_webrick [port] +<p> or +<p> sisu -W [port] + +<p> 1.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). +<p> 1.4 SUMMARY OF MAN PAGE +<p> sisu_webrick, may be started +on it’s own with the command: sisu_webrick or using the sisu command with +the -W flag: sisu -W [port] +<p> where no port is given and settings are unchanged + +<p>the default port is 8081 +<p> 1.5 DOCUMENT PROCESSING 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 the defaults have not + +<p>been changed in ~/.sisu/sisurc.yaml then on port 8081 +<p> 1.6 FURTHER INFORMATION + +<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> or man sisu + +<p> 1.7 AUTHOR +<p> Ralph Amissah ralph@amissah.com or ralph.amissah@gmail.com +<p> 1.8 + +<p>SEE ALSO +<p> <a href='http:~/bin/man2html?sisu:1'>sisu(1)</a> +<br> + +<p> <a href='http:~/bin/man2html?sisu_vim:7'>sisu_vim(7)</a> +<br> + +<p> <a href='http:~/bin/man2html?sisu:8'>sisu(8)</a> +<br> + +<p> DOCUMENT INFORMATION (METADATA) +<p> METADATA +<p> Document Manifest @ <<a href='http://sisudoc.org/sisu_manual/sisu_webrick/sisu_manifest.html'>http://sisudoc.org/sisu_manual/sisu_webrick/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> - sisu_webrick +<p> DC Creator: <i>Ralph</i> Amissah +<p> DC Rights: +<i>Copyright</i> (C) Ralph Amissah 2007, part of SiSU documentation, License GPL + +<p>3 +<p> DC Type: <i>information</i> +<p> DC Date created: <i>2002-08-28</i> +<p> DC Date issued: + +<p><i>2002-08-28</i> +<p> DC Date available: <i>2007-08-28</i> +<p> DC Date modified: <i>2007-09-16</i> +<p> DC +Date: <i>2007-09-16</i> +<p> <b>Version Information</b> +<p> Sourcefile: <i>sisu_webrick.sst</i> +<p> Filetype: + +<p><i>SiSU</i> text 0.58 +<p> Sourcefile Digest, MD5(sisu_webrick.sst)= <i>11fb0494766a9b6d3ce091bf41241973</i> + +<p> Skin_Digest: MD5(/etc/sisu/skin/doc/skin_sisu.rb)= <i>c4b3c21ba1ed0d491bfe14cd0fcd075e</i> + +<p> <b>Generated</b> +<p> Document (metaverse) last generated: <i>Sat</i> Sep 29 15:49:36 + +<p>+0100 2007 +<p> Generated by: <i>SiSU</i> <i>0.59.1</i> of 2007w39/2 (2007-09-25) +<p> Ruby version: +<i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36) [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_webrick/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_webrick/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_webrick/sisu_manifest.html</a> +</a> +> +</dt> +<dd></dd> + +<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_webrick/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_webrick/toc.html'>http://www.jus.uio.no/sisu/sisu_webrick/toc.html</a> +</a> +> </dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_webrick/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_webrick/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_webrick/portrait.pdf</a> +</a> +> +</dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_webrick/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_webrick/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_webrick/landscape.pdf</a> +</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.59.1 of 2007w39/2 (2007-09-25) </dt> +<dd></dd> + +<dt>* Ruby version: ruby +1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt> +<dd></dd> + +<dt>* Last Generated on: Sat Sep 29 +15:49:36 +0100 2007 </dt> +<dd></dd> + +<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> + </dt> +<dd></dd> +</dl> +<p> + +<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> +</ul> +</body> +</html> |