diff options
| author | Ralph Amissah <ralph@amissah.com> | 2007-09-23 05:16:21 +0100 |
|---|---|---|
| committer | Ralph Amissah <ralph@amissah.com> | 2007-09-23 05:16:21 +0100 |
| commit | 50d45c6deb0afd2e4222d2e33a45487a9d1fa676 (patch) | |
| tree | 100c62d678f009139999bf77c26c81653a721eeb /data/doc/sisu | |
| parent | sisu-0.58.3 + md5s (diff) | |
primarily todo with sisu documentation, changelog reproduced below:
* start documenting sisu using sisu
* sisu markup source files in
data/doc/sisu/sisu_markup_samples/sisu_manual/
/usr/share/doc/sisu/sisu_markup_samples/sisu_manual/
* default output [sisu -3] in
data/doc/manuals_generated/sisu_manual/
/usr/share/doc/manuals_generated/sisu_manual/
(adds substantially to the size of sisu package!)
* help related edits
* manpage, work on ability to generate manpages, improved
* param, exclude footnote mark count when occurs within code block
* plaintext changes made
* shared_txt, line wrap visited
* file:// link option introduced (in addition to existing https?:// and
ftp://) a bit arbitrarily, diff here, [double check changes in sysenv and
hub]
* minor adjustments
* html url match refinement
* css added tiny_center
* plaintext
* endnotes fix
* footnote adjustment to make more easily distinguishable from substantive
text
* flag -a only [flags -A -e -E dropped]
controlled by modifiers --unix/msdos --footnote/endnote
* defaults, homepage
* renamed homepage (instead of index) implications for modifying skins,
which need likewise to have any homepage entry renamed
* added link to sisu_manual in homepage
* css the css for the default homepage is renamed homepage.css (instead of
index.css) [consider removing this and relying on html.css]
* ruby version < ruby1.9
* place stop on installation and working with for now [ruby String.strip
broken in ruby 1.9.0 (2007-09-10 patchlevel 0) [i486-linux],
2007-09-18:38/2]
* debian/control restrict use to ruby > 1.8.4 and ruby < 1.9
* debian
* debian/control restrict use to ruby > 1.8.4 and ruby < 1.9
* sisu-doc new sub-package for sisu documentation
debian/control and sisu-doc.install
Diffstat (limited to 'data/doc/sisu')
72 files changed, 19047 insertions, 1490 deletions
diff --git a/data/doc/sisu/html/README b/data/doc/sisu/html/README index 1c320ced..a4263458 100644 --- a/data/doc/sisu/html/README +++ b/data/doc/sisu/html/README @@ -1 +1,10 @@ -SiSU man pages 0.48 (last major syntax additions 0.38) +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/html/sisu.1.html b/data/doc/sisu/html/sisu.1.html index a5bbc0fc..7a46a1ac 100644 --- a/data/doc/sisu/html/sisu.1.html +++ b/data/doc/sisu/html/sisu.1.html @@ -1,4 +1,4 @@ - <!-- manual page source format generated by PolyglotMan v3.2, --> +<!-- manual page source format generated by PolyglotMan v3.2, --> <!-- available at http://polyglotman.sourceforge.net/ --> <html> @@ -7,1334 +7,3654 @@ </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>[</b> <i>-AabcDdEeFHhIMmNnopqRrSsTtUuVvwXxYyZz0-9</i> -<b>] [</b> <i>filename/</i> wildcard <b>]</b> <p> -<b>sisu</b> <b>[</b> <i>-Ddcv</i> <b>] [</b> <i>instruction</i> <b>]</b> <p> -<b>sisu</b> <b>[</b> <i>-CcFLSVvW</i> -<b>]</b> <p> -Note: commands should be issued from within the directory that contains -the marked up files, cd to markup directory. -<h2><a name='sect2' href='#toc2'>Description</a></h2> -<b>SiSU</b> SiSU 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 ("object citation numbering") and the same document structure -information. For more see: <i><<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> -></i> <p> - -<h2><a name='sect3' href='#toc3'>Summary of man page</a></h2> - +SISU - SISU INFORMATION STRUCTURING UNIVERSE - MANUAL [0.58], RALPH AMISSAH + +<p> WHAT IS SISU? +<p> 1. INTRODUCTION - WHAT IS SISU? +<p> <b>SiSU</b> is a system for +document markup, publishing (in multiple open standard formats) and search + +<p> <b>SiSU</b> [^1] is a[^2] framework for document structuring, publishing 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 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). It has been developed in +the context of coping with large document sets with evolving markup related +technologies, for which you want multiple output formats, 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. Results of objects (primarily paragraphs +and headings) can be viewed directly in the database, or just the object +numbers shown - your search criteria is met in these documents and at these +locations within each document. +<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 various standard open output formats including plain text, +HTML, XHTML, XML, OpenDocument, LaTeX or PDF files, and populate an SQL +database with objects[^3] (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[^4] 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 frame[^5] +and the objects[^6] 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 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[^7] and the +ISO standard ODF.[^8] 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), 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. 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> 3. 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 simpler converted to XML representations of the + same input/source +<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 browser viewing, 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> 4. HELP +<p> 4.1 + +<p>SISU MANUAL +<p> The most up to date information on sisu should be contained +in the sisu_manual, available at: +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/'>http://www.jus.uio.no/sisu/sisu_manual/</a> +><br> + +<p> and (from <b>SiSU</b> 0.59 onwards) installed locally at: +<p> /usr/share/doc/sisu/sisu_manual/<br> + +<p> or equivalent directory +<p> Within the <b>SiSU</b> tarball at: +<p> ./data/doc/sisu/sisu_manual/<br> + +<p> 4.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> The <b>SiSU</b> man pages can be viewed online at:[^9] +<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> +> + [^10] +<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> +> [^11] +<p> * sisu.8 <<a href='http://www.jus.uio.no/sisu/man/sisu.8.html'>http://www.jus.uio.no/sisu/man/sisu.8.html</a> +> + [^12] +<p> * sisu_examples.1 <<a href='http://www.jus.uio.no/sisu/man/sisu_examples.1.html'>http://www.jus.uio.no/sisu/man/sisu_examples.1.html</a> +> + [^13] +<p> * sisu_webrick.1 <<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> +> [^14] + +<p> 4.3 SISU BUILT-IN INTERACTIVE HELP +<p> This is particularly useful when current +installation information is obtained as the interactive help is able to +provide information on your sisu configuration and setup. +<p> sisu --help<br> + +<p> sisu --help [subject]<br> + +<p> sisu --help env [for feedback on the way your system is <br> + setup with regard to sisu]<br> + +<p> sisu -V [same as above command]<br> + +<p> sisu --help commands<br> + +<p> sisu --help markup<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> 4.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_manual/sisu_help_sources/index.html'>http://sisudoc.org/sisu_manual/sisu_help_sources/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html</a> +><br> + +<p> 5. COMMANDS SUMMARY +<p> 5.1 SYNOPSIS +<p> <b>SiSU</b> - Structured information, Serialized +Units - a document publishing system +<p> sisu [ -abcDdFHhIiMmNnopqRrSsTtUuVvwXxYyZz0-9 + ] [ filename/ +<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> 5.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> 5.3 DOCUMENT + +<p>PROCESSING COMMAND FLAGS +<p> <dl> -<dt>This -man page covers a number of subjects in brief, including: document processing -command flags; document markup (basic markup and headers); configuration -files; directory structure; skins; document naming; interactive help and -other information. </dt> -<dd> </dd> -</dl> - -<h2><a name='sect4' href='#toc4'>Document Processing Command Flags</a></h2> +<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 [ output file] [see -e for endnotes]. +(Options include: --endnotes for endnotes --footnotes for footnotes at the +end of each paragraph --unix for unix linefeed (default) --msdos for msdos +linefeed) +<p> </dd> -<dl> +<dt><b> -b [filename/wildcard]</b> </dt> +<dd>produces xhtml/XML output for browser +viewing (sax parsing). +<p> </dd> -<dt><b>-A</b><i> [filename/wildcard]</i> -</dt> -<dd>produces <i>plaintext</i> with <i>dos</i> linefeeds and without markup, (object numbers -are omitted), has footnotes at end of each paragraph that contains them -[ <i>-a</i> for equivalent Unix (linefeed) output file] [see <i>-E</i> for endnotes]. </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>-a</b><i> [filename/wildcard]</i> -</dt> -<dd>produces <i>plaintext</i> with <i>Unix</i> linefeeds and without markup, (object numbers -are omitted), has footnotes at end of each paragraph that contains them -[ <i>-A</i> for equivalent dos (linefeed) output file] [see <i>-e</i> for endnotes]. </dd> +<dt><b> -CC</b> </dt> +<dd> configure/initialise shared output directory files initialize +shared output directory (config files such as css and dtd 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. +such as css and dtd files are updated +<p> </dd> -<dt><b>-b</b><i> [filename/wildcard]</i> -</dt> -<dd>produces <i>xhtml/XML</i> output for browser viewing (sax parsing). </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>-C</b><i> [--init=site]</i> -</dt> -<dd><i>configure/initialise</i> 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). <b>-C</b><i> --init=site</i> <i>configure/initialise</i> -site more extensive than <i>-C</i> 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. </dd> - -<dt><b>-c</b><i> [filename/wildcard]</i> </dt> -<dd>screen <i>toggle</i> 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). </dd> - -<dt><b>-D</b><i> [instruction]</i><b> [filename]</b> </dt> +<dt><b> -D [instruction] [filename]</b> </dt> <dd>database postgresql -( <i>--pgsql</i> may be used instead) possible instructions, include: <i>--createdb;</i> -<i>--create;</i> <i>--dropall;</i> <i>--import</i> [filename]; <i>--update</i> [filename]; <i>--remove</i> [filename]; -see database section below. </dd> +( --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</b><i> [--db-[database</i><b> type</b><i> (sqlite|pg)]]</i><b> --[instruction]</b><i> [filename]</i> +<dt><b> -d [--db-[database type (sqlite|pg)]] --[instruction] </dt> -<dd>database type default set to sqlite, (for which <i>--sqlite</i> may be used instead) -or to specify another database <i>--db-[pgsql,</i> sqlite] (however see -D) possible -instructions include: <i>--createdb;</i> <i>--create;</i> <i>--dropall;</i> <i>--import</i> [filename]; <i>--update</i> - [filename]; <i>--remove</i> [filename]; see database section below. </dd> +<dd>[filename] 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>-E</b><i> [filename/wildcard]</i> -</dt> -<dd>produces <i>plaintext</i> with <i>dos</i> linefeeds, and without markup, endnotes follow -the main text (in <i>-a</i> endnotes follow the paragraphs that contain them). There -are no object numbers [see <i>-e</i> for Unix (linefeed) output file] [see <i>-A</i> for -footnotes]. </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>-e</b><i> [filename/wildcard]</i> </dt> -<dd>produces <i>plaintext</i> with <i>Unix</i> linefeeds, -and without markup, endnotes follow the main text. Object numbers are omitted. -[ <i>-E</i> for equivalent dos (linefeed) output file] [ <i>-a</i> for footnotes]. </dd> +<dt><b> -H [filename/wildcard]</b> </dt> +<dd>produces html +without link suffixes (.html .pdf etc.) ( appropriately configured web server. + [behaviour switched after 0.35 see -h]. +<p> </dd> -<dt><b>-F</b><i> [--webserv=webrick]</i> -</dt> -<dd>generate examples of (naive) <i>cgi</i> search form for <i>sqlite</i> and <i>pgsql</i> 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 <i>-d</i> <i>-D</i> and the <i>database</i> section below. If the optional parameter -<i>--webserv=webrick</i> 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 <i>cgi-bin</i> directory). <i>-Fv</i> (in -addition to the above) provides some information on setting up <i>hyperestraier</i> -for sisu </dd> - -<dt> <b>-H</b><i> [filename/wildcard]</i> </dt> -<dd>produces <i>html</i> without link suffixes -(.html .pdf etc.) ("Hide"). Requires an appropriately configured web server. -[behaviour switched after 0.35 see -h]. </dd> - -<dt><b>-h</b><i> [filename/wildcard]</i> </dt> -<dd>produces <i>html</i> +<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]. </dd> +most web servers). [behaviour switched after 0.35 see -H]. +<p> </dd> -<dt><b>-I</b><i> [filename/wildcard]</i> +<dt><b> -I [filename/wildcard]</b> </dt> -<dd>produces <i>texinfo</i> and <i>info</i> file, (view with pinfo). </dd> +<dd>produces texinfo and info file, (view with pinfo). +<p> </dd> -<dt><b>-L</b> </dt> -<dd>prints license information. -</dd> +<dt><b> -L</b> </dt> +<dd> prints license information. + +<p> </dd> -<dt><b>-M</b><i> [filename/wildcard/url]</i> </dt> -<dd><i>maintenance</i> mode files created for processing -preserved and their locations indicated. (also see -V) </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</b><i> [filename/wildcard/url]</i> +<dt><b> -m [filename/wildcard/url]</b> </dt> -<dd>assumed for most other flags, creates new meta-markup file, (the <i>metaverse</i> +<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 <i>-n</i> </dd> +assumed for most processing flags. To skip it see -n +<p> </dd> -<dt><b>-N</b><i> [filename/wildcard/url]</i> +<dt><b> -N [filename/wildcard/url]</b> </dt> -<dd>document <i>digest</i> or <i>document</i> content certificate ( <i>DCC</i> ) as <i>md5</i> digest tree +<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). <i>-NV</i> for verbose digest output to screen. </dd> +that produced it) (digest.txt). -NV for verbose digest output to screen. +<p> </dd> -<dt><b>-n</b><i> [filename/wildcard/url]</i> -</dt> -<dd>skip meta-markup (building of "metaverse"), this skips the equivalent of -<i>-m</i> which is otherwise assumed by most processing flags. </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</b><i> [filename/wildcard/url]</i> -</dt> -<dd>output basic document in <i>opendocument</i> file format (opendocument.odt). </dd> +<dt><b> -o [filename/wildcard/url]</b> </dt> +<dd>output basic +document in opendocument file format (opendocument.odt). +<p> </dd> -<dt><b>-p</b><i> [filename/wildcard]</i> +<dt><b> -p [filename/wildcard]</b> </dt> -<dd>produces <i>LaTeX</i> pdf (portrait.pdf & landscape.pdf). Default paper size is set +<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. <i>--papersize-a4</i> preset sizes include: ’A4’, U.S. ’letter’ and -’legal’ and book sizes ’A5’ and ’B5’ (system defaults to A4). </dd> +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</b><i> [filename/wildcard]</i> +<dt><b> -q [filename/wildcard]</b> </dt> -<dd><i>quiet</i> less output to screen. </dd> +<dd>quiet less output to screen. +<p> </dd> -<dt><b>-R</b><i> [filename/wildcard]</i> </dt> -<dd><i>copies</i> sisu output files -to <i>remote</i> host using rsync. This requires that sisurc.yml has been provided -with information on hostname and username, and that you have your "keys" -and ssh agent in place. Note the behavior of rsync different if -R is used -with other flags from if used alone. Alone the rsync --delete parameter is -sent, useful for cleaning the remote directory (when -R is used together -with other flags, it is not). Also see <i>-r</i> </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</b><i> [filename/wildcard]</i> </dt> -<dd><i>copies</i> sisu -output files to <i>remote</i> host using scp. This requires that sisurc.yml has -been provided with information on hostname and username, and that you have -your "keys" and ssh agent in place. Also see <i>-R</i> </dd> - -<dt><b>-S</b> </dt> -<dd>produces a <i>sisupod</i> a zipped -sisu directory of markup files including <i>sisu</i> markup source files and the -directories local <i>configuration</i> file, <i>images</i> and <i>skins.</i> <b>Note:</b> this only -includes the configuration files or skins contained in <i>./_sisu</i> not those -in <i>~/.sisu</i> <i>-S</i> [filename/wildcard] option. <b>Note:</b> (this option is tested only -with zsh). </dd> - -<dt><b>-S</b><i> [filename/wildcard]</i> </dt> -<dd>produces a zipped file of the prepared document -specified along with associated images, by default named <i>sisupod.zip</i> they -may alternatively be named with the filename extension <i>.ssp</i> This provides -a quick way of gathering the relevant parts of a sisu document which can -then for example be emailed. A sisupod includes <i>sisu</i> markup source file, -(along with associated documents if a master file, or available in multilingual -versions), together with related <i>images</i> and <i>skin.</i> SiSU 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. <b>Note:</b> -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 <i>-S</i> option without [filename/wildcard]. </dd> - -<dt><b>-s</b><i> [filename/wildcard]</i> +<dt><b> -r [filename/wildcard]</b> </dt> -<dd>copies sisu markup file to output directory. </dd> +<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 -<dt><b>-t</b><i> [filename/wildcard</i><b> (*.termsheet.rb)]</b> -</dt> -<dd>standard form document builder, preprocessing feature </dd> +<p>have your +<p> </dd> -<dt><b>-U</b><i> [filename/wildcard]</i> +<dt><b> -S</b> </dt> +<dd> produces a sisupod a zipped sisu directory of markup 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 option is tested only with zsh). +<p> </dd> + +<dt><b> -S [filename/wildcard]</b> </dt> -<dd>prints <i>url</i> 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), <i>-u</i> provides <i>url</i> output mapping for those -flags requested for processing. The default assumes sisu_webrick is running -and provides webrick url mappings where appropriate, but these can be switched -to file system paths in sisurc.yml </dd> - -<dt><b>-u</b><i> [filename/wildcard]</i> </dt> -<dd>provides <i>url</i> mapping -of output files for the flags requested for processing, also see <i>-U</i> </dd> - -<dt><b>-V</b> </dt> -<dd>on -its own, provides SiSU <i>version</i> and <i>environment</i> information (sisu --help env) -</dd> +<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 + +<p> </dd> -<dt><b>-V</b><i> [filename/wildcard]</i> </dt> -<dd>even more <i>verbose</i> than the <i>-v</i> flag. (also see -M) </dd> +<dt><b> -s [filename/wildcard]</b> </dt> +<dd>copies sisu markup file to output directory. +<p> </dd> -<dt><b>-v</b> </dt> -<dd>on -its own, provides SiSU <i>version</i> information </dd> +<dt><b> -t [filename/wildcard + (*.termsheet.rb)]</b> </dt> +<dd>standard form document builder, preprocessing feature +<p> +</dd> -<dt><b>-v</b><i> [filename/wildcard]</i> </dt> -<dd>provides -<i>verbose</i> output of what is being built, where it is being built (and error -messages if any), as with <i>-u</i> flag provides a url mapping of files created -for each of the processing flag requests. See also <b>-V</b> </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 -<dt><b>-W</b> </dt> -<dd>starts ruby’s <i>webrick</i> -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 -<i>-h</i> option rather than <i>-H</i> ; also, note <i>-F</i> webrick ]. </dd> +<p>can be switched to file system paths in sisurc.yml +<p> </dd> -<dt><b>-w</b><i> [filename/wildcard]</i> +<dt><b> -u [filename/wildcard]</b> </dt> -<dd>produces <i>concordance</i> (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) </dd> +<dd>provides url mapping of output files for the flags requested for processing, -<dt><b>-X</b><i> [filename/wildcard]</i> -</dt> -<dd>produces <i>XML</i> output with deep document structure, in the nature of dom. -</dd> +<p>also see -U +<p> </dd> -<dt><b>-x</b><i> [filename/wildcard]</i> </dt> -<dd>produces <i>XML</i> output shallow structure (sax parsing). -</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>-Y</b><i> [filename/wildcard]</i> </dt> -<dd>produces a short sitemap entry for the document, based -on html output and the sisu_manifest. <i>--sitemaps</i> generates/updates the sitemap -index of existing sitemaps. (Experimental, [g,y,m announcement this week]) -</dd> +<dt><b> -V [filename/wildcard]</b> </dt> +<dd>even more verbose than the -v flag. +(also see -M) +<p> </dd> -<dt><b>-y</b><i> [filename/wildcard]</i> </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. </dd> - -<dt><b>-Z</b><i> [filename/wildcard]</i> </dt> -<dd>Zap, if used -with other processing flags <i>deletes</i> 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. </dd> - -<dt><b>-z</b><i> [filename/wildcard]</i> </dt> -<dd>produces <i>php</i> (zend) -[this feature is disabled for the time being] </dd> -</dl> +<dt><b> -v</b> </dt> +<dd> on its own, provides <b> SiSU</b> version information +<p> </dd> -<h2><a name='sect5' href='#toc5'>modifiers</a></h2> +<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> -<dl> +<dt><b> -W</b> </dt> +<dd> starts ruby’s + webrick webserver points at sisu output the default port is set to 8081 + and can be [tip: the so html output should be created using the -h option + rather than -H; also, note -F webrick ]. +<p> </dd> -<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. </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>--no-annotate</b> </dt> -<dd>strips output -text of editor endnotes~[* square brackets ]~ denoted by asterisk or dagger/plus -sign </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>--no-asterisk</b> </dt> -<dd>strips output text of editor endnotes~[* square brackets -]~ denoted by asterisk sign </dd> +<dt><b> -x [filename/wildcard]</b> +</dt> +<dd>produces XML output shallow structure (sax parsing). +<p> </dd> -<dt><b>--no-dagger</b> </dt> -<dd>strips output text of editor endnotes~[+ -square brackets ]~ denoted by dagger/plus sign </dd> -</dl> +<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> -<h2><a name='sect6' href='#toc6'>databases</a></h2> +<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> +</dl> +6. COMMAND LINE MODIFIERS +<p> <dl> -<dt>dbi - database -interface </dt> -<dd><b>-D</b> or <b>--pgsql</b> set for <i>postgresql</i> <b>-d</b> or <b>--sqlite</b> default set for <i>sqlite</i> --d is modifiable with --db=[database type (pgsql or sqlite)] </dd> +<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 asterisk or dagger/plus sign +<p> </dd> + +<dt><b> --no-asterisk</b> +</dt> +<dd> strips output text of editor endnotes[^*2] denoted by asterisk sign +<p> </dd> -<dt><b>-Dv --createall</b> +<dt><b> --no-dagger</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) [ <i>-dv</i> --createall sqlite -equivalent] it may be necessary to run sisu <i>-Dv</i> --createdb initially </dd> - -<dt>NOTE: -at the present time for postgresql it may be necessary to manually create -the database. The command would be </dt> -<dd><i>’createdb</i> [database name]’ where database -name would be SiSU_[present working directory name (without path)]. Please -use only alphanumerics and underscores. </dd> - -<dt><b>-Dv --import</b> </dt> -<dd><i>[filename/wildcard]</i> imports -data specified to postgresql db (rb.dbi) [ <i>-dv</i> --import sqlite equivalent] +<dd> strips output text of editor endnotes[^+1] denoted by dagger/plus sign +<p> </dd> +</dl> +7. 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 --update</b> </dt> -<dd><i>[filename/wildcard]</i> updates/imports specified data to postgresql -db (rb.dbi) [ <i>-dv</i> --update sqlite equivalent] </dd> +<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>-D --remove</b> </dt> -<dd><i>[filename/wildcard]</i> -removes specified data to postgresql db (rb.dbi) [ <i>-d</i> --remove sqlite equivalent] -</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>-D --dropall</b> </dt> -<dd>kills data" and drops (postgresql or sqlite) db, tables & indexes -[ <i>-d</i> --dropall sqlite equivalent] </dd> +<dt><b> -Dv --update</b> </dt> +<dd> [filename/wildcard] updates/imports +specified data to postgresql db (rb.dbi) [ -dv --update sqlite equivalent] -<dt>The v in e.g. -Dv is for verbose output. </dt> -<dd></dd> -</dl> -</blockquote> - -<h2><a name='sect7' href='#toc7'>Shortcuts, -Shorthand for multiple flags</a></h2> +<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 & indexes [ -d --dropall + sqlite equivalent] +<p> The v in e.g. -Dv is for verbose output. +<p> </dd> +</dl> +8. SHORTCUTS, +SHORTHAND FOR MULTIPLE FLAGS +<p> <dl> -<dt><b>--update</b><i> [filename/wildcard]</i> </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 +<dt><b> --update [filename/wildcard]</b> </dt> +<dd>Checks existing +file output and runs the flags required to update this output. This means +that if only html and pdf output was requested on previous runs, only the +-hp files will be applied, and only these will be generated this time, together with the summary. This can be very convenient, if you offer different outputs -of different files, and just want to do the same again. </dd> +of different files, and just want to do the same again. +<p> </dd> -<dt>-0 to -5 [filename -or wildcard] </dt> +<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): </dd> -</dl> -<p> -<i>-0</i> -mNhwpAobxXyYv [this is the -default action run when no options are give, i.e. on ’sisu [filename]’] <p> -<i>-1</i> -mNHwpy -<p> -<i>-2</i> -mNHwpaoy <p> -<i>-3</i> -mNhwpAobxXyY <p> -<i>-4</i> -mNhwpAobxXDyY --import <p> -<i>-5</i> -mNhwpAobxXDyY --update -<p> -add <i>-v</i> for verbose mode and <i>-c</i> for color, e.g. <i>sisu</i> -2vc [filename or wildcard] -<p> -consider <i>-u</i> for appended url info or <i>-v</i> for verbose output -<h2><a name='sect8' href='#toc8'>Document Markup</a></h2> -<b>SiSU -Markup</b> an incomplete summary. <p> -<b>Note:</b> files should be marked up for SiSU using -<i>UTF-8</i> encoding. <p> -Some interactive help on markup is available, by typing <i>sisu</i> -and selecting <i>markup</i> or <i>sisu</i> --help markup -<dl> +changed/configured in the sisurc.yml file): +<p> </dd> -<dt>Online markup examples together -with the respective outputs produced are available from: </dt> -<dd><i><<a href='http://www.jus.uio.no/sisu/SiSU/2.html'>http://www.jus.uio.no/sisu/SiSU/2.html</a> -></i> -</dd> +<dt><b> -0</b> </dt> +<dd> -mNhwpAobxXyYv [this is the + default action run when no i.e. on ’sisu [filename]’] +<p> </dd> -<dt>or from the document: </dt> -<dd><i><<a href='http://www.jus.uio.no/sisu/sisu_examples/'>http://www.jus.uio.no/sisu/sisu_examples/</a> -></i> </dd> +<dt><b> -1</b> </dt> +<dd> -mNHwpy give, i.e. on + ’sisu [filename]’] +<p> </dd> -<dt>The following -document gives a cursory overview of sisu markup and the respective output -produced: </dt> -<dd><i><<a href='http://www.jus.uio.no/sisu/sisu_markup/'>http://www.jus.uio.no/sisu/sisu_markup/</a> -></i> </dd> +<dt><b> -2</b> </dt> +<dd> -mNHwpaoy give, i.e. on ’sisu [filename]’] +<p> </dd> -<dt>Some example marked up files -are available as html with syntax highlighting for viewing: </dt> -<dd><i><<a href='http://www.jus.uio.no/sisu/sample/syntax'>http://www.jus.uio.no/sisu/sample/syntax</a> -></i> -</dd> +<dt><b> -3</b> </dt> +<dd> -mNhwpAobxXyY + i.e. on ’sisu [filename]’] +<p> </dd> + +<dt><b> -4</b> </dt> +<dd> -mNhwpAobxXDyY --import ’sisu [filename]’] +<p> </dd> + +<dt><b> -5</b> </dt> +<dd> -mNhwpAobxXDyY + --update ’sisu [filename]’] +<p> add -v for verbose mode and -c for color, e.g. sisu +-2vc [filename or wildcard] +<p> consider -u for appended url info or -v for -<dt>an alternative presentation of markup syntax: </dt> -<dd><i><<a href='http://www.jus.uio.no/sisu/sample/on_markup.txt'>http://www.jus.uio.no/sisu/sample/on_markup.txt</a> -></i> - </dd> +<p>verbose output +<p> </dd> </dl> +8.0.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> 9. INTRODUCTION TO SISU MARKUP[^15] +<p> 9.1 SUMMARY +<p> <b>SiSU</b> source +documents are plaintext (UTF-8)[^16] 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> 9.2 MARKUP EXAMPLES +<p> 9.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/2.html'>http://www.jus.uio.no/sisu/SiSU/2.html</a> +> or from <<a href='http://www.jus.uio.no/sisu/sisu_examples/'>http://www.jus.uio.no/sisu/sisu_examples/</a> +> -<h2><a name='sect9' href='#toc9'>Basic Markup</a></h2> -Data text markup (alternative to available html subset) <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. <i>:A~</i> usually the title <i>:A~?</i> conditional level 1 heading -(used where a stand-alone document may be imported into another) <p> -<i>1~filename</i> -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) <p> -<i>!{</i> emphasis <i>}!</i> <p> -<i>*{</i> bold text <i>}*</i> -<p> -<i>_{</i> underscore <i>}_</i> <p> -<i>/{</i> italics <i>}/</i> <p> -<i>’"{</i> citation <i>}"</i> <p> -<i>^{</i> superscript <i>}^</i> <p> -<i>,{</i> subscript -<i>},</i> <p> -<i>+{</i> inserted text <i>}+</i> <p> -<i>-{</i> strikethrough <i>}-</i> -<h2><a name='sect10' href='#toc10'>Footnotes/Endnotes</a></h2> -<p> -<i>~{</i> a footnote -or endnote <i>}~</i> <p> -footnote/endnote <i>~{</i> self contained endnote marker & endnote -in one <i>}~</i> <p> -<i>~{*</i> unnumbered asterisk footnote/endnote, insert multiple asterisks -if required <i>}~</i> <p> -<i>~[*</i> editors notes, numbered asterisk footnote/endnote series -<i>]~</i> (+ the plus sign may be used as well) <p> -alternative endnote pair notation: +<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> 9.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> 10. MARKUP OF HEADERS + +<p> Headers consist of semantic meta-data about a document, which can be used +by any output module of the program; and may in addition include extra +processing instructions. +<p> Note: the first line of a document may include +information on the markup version used in the form of a comment. Comments +are a percentage mark at the start of a paragraph (and as the first character +in a line of text) followed by a space and the comment: +<p> +<p> <br> +<pre> % this would be a comment +</pre> +<p> 10.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 [0.58] + @creator: Ralph Amissah + @rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, +License GPL 3 + @type: information + @subject: ebook, epublishing, electronic book, electronic publishing, +electronic document, electronic citation, data structure, citation systems, +search + @date.created: 2002-08-28 + @date.issued: 2002-08-28 + @date.available: 2002-08-28 + @date.modified: 2007-09-16 + @date: 2007-09-16 + @level: new=C; break=1; num_top=1 + % comment: in this @level header num_top=1 starts automatic heading numbering +at heading level 1 (numbering continues 3 levels down); the new and break +instructions are used by the LaTeX/pdf and odf output to determine where +to put page breaks (that are not used by html output or say sql database +population). + @skin: skin_sisu_manual + % skins modify the appearance of a document and are placed in a sub-directory +under ./_sisu/skin ~/.sisu/skin or /etc/sisu/skin. A skin may affect single +documents that request them, all documents in a directory, or be site-wide. +(A document is affected by a single skin) + @bold: /Gnu|Debian|Ruby|SiSU/ + @links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +</pre> +<p> 10.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> <b>@title:</b> [title text] This is the title of the document and used +as such, this header is the only one that is <i>mandatory</i> +<p> <b>@subtitle:</b> The + +<p>Subtitle if any +<p> <b>@creator:</b> [or @author:] Name of Author +<p> <b>@subject:</b> (whatever +your subject) +<p> <b>@description:</b> +<p> <b>@publisher:</b> +<p> <b>@contributor:</b> +<p> <b>@translator:</b> + [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: @date.modified: ] +<p> <b>@type: 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, and in sql searches] +<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, classification]; 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 implemented] +<p> <b>@prefix_b:</b> +<p> <b>@rcs:</b> $Id: +sisu_markup.sst,v 1.2 2007/09/08 17:12:47 ralph Exp $ [used by rcs or cvs + to embed version (revision control) information into under ./_sisu/skin +~/.sisu/skin or /etc/sisu/skin. A skin may affect single documents that request +them, all documents in a directory, or be site-wide. (A document is affected +by a single skin) document, rcs or cvs can usefully provide a history of +under ./_sisu/skin ~/.sisu/skin or /etc/sisu/skin. A skin may affect single +documents that request them, all documents in a directory, or be site-wide. +(A document is affected by a single skin) updates 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 in + newpage] +<p> <b>@markup:</b> information on the markup used, e.g. new=1,2,3; break=4; +num_top=4 [or newpage=1,2,3; breakpage=4; num_top=4] newpage and breakpage, +heading level, used by LaTeX to breakpages. breakpage: starts on a new page +in single column text and on a new column in double column text; newpage: +starts on a new page for both single and double column texts. num_top=4 + [auto-number document, starting at level 4. the 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 and use + for numbering of Available where a clear numbering structure is 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> <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 list.yml and promo.yml, commented out sample in document +sample: and promo.yml, commented out sample in document free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst] + +<p> 11. MARKUP OF SUBSTANTIVE TEXT +<p> 11.1 HEADING LEVELS +<p> Heading levels are +:A~ ,:B~ ,:C~ ,1~ ,2~ ,3~ ... :A - :C being part / section headings, followed +by other heading levels, and 1 -6 being headings followed by substantive +text or sub-headings. :A~ usually the title :A~? conditional level 1 heading +(used where a stand-alone document may be imported into another) +<p> <b>:A~ [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> -<i>~^</i> endnote marker <p> -<i>^~</i> endnote text following the paragraph in which the marker -occurs -<h2><a name='sect11' href='#toc11'>Line Operations (marker placed at start of line)</a></h2> + <b>:C~ [heading text]</b> Third level heading [this is a heading level divider] + +<p> <b>1~ [heading text]</b> Top level heading preceding substantive text of document +or sub-heading 2, the heading level that would normally be marked 1. or 2. +or 3. etc. in a document, and the level on which sisu by default would break +html output into named segments, names are provided automatically if none +are given (a number), otherwise takes the form 1~my_filename_for_this_segment + +<p> <b>2~ [heading text]</b> Second level heading preceding substantive text of +document or sub-heading 3, the heading level that would normally be marked +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> 11.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 <em>emphasis</em> <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> <em>emphasis</em> +<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> 11.3 INDENTATION AND BULLETS +<p> <b>markup example:</b> +<p> +<p> <br> +<pre> ordinary paragraph + _1 indent paragraph one step + _2 indent paragraph two steps + _9 indent paragraph nine steps +</pre> +<p> <b>resulting output:</b> +<p> ordinary paragraph +<p> indent paragraph one step<br> + +<p> indent paragraph two steps<br> + +<p> indent paragraph nine steps<br> + +<p> <b>markup example:</b> +<p> +<p> <br> +<pre> * bullet text + _1* bullet text, first indent + _2* bullet text, two step indent +</pre> +<p> <b>resulting output:</b> +<p> * bullet text +<p> * bullet text, first indent<br> + +<p> * bullet text, two step indent<br> + +<p> Numbered List (not to be confused with headings/titles, (document structure)) + +<p> <b>markup example:</b> +<p> +<p> <br> +<pre> # numbered list numbered list 1., 2., 3, etc. + _# numbered list numbered list indented a., b., c., d., etc. +</pre> +<p> 11.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> [^17] +<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[^18] 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> <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> <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> -<i>!_</i> bold line <p> -<i>_1</i> -indent paragraph one level <p> -<i>_2</i> indent paragraph two steps <p> -<i>_*</i> bullet paragraph + +<p>11.5 LINKS +<p> 11.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> 11.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> +> [^19] markup <p> -<i>#</i> number paragraph (see headers for numbering document headings) + +<p>11.5.3 LINKING IMAGES +<p> <b>markup example:</b> +<p> +<p> <br> +<pre> [ tux.png ] + % various url linked images + [ tux.png ] + [ GnuDebianLinuxRubyBetterWay.png ] + {~^ ruby_logo.png +</pre> +<p> <b>resulting output:</b> +<p> [ tux.png ] +<p> tux.png 64x80 +<p> [ ruby_logo (png missing) + ] [^20] +<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> 11.6 GROUPED TEXT <p> -<i>_#</i> number paragraph level 2 (see headers for numbering document headings) + +<p>11.6.1 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> -<h2><a name='sect12' href='#toc12'>Links</a></h2> -<p> -<i>{</i> link name <i>}<a href='http://url.org'>http://url.org</i></a> +<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> [^21] +<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> 11.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> <p> -<i>{</i> image.png <i>}<a href='http://url.org'>http://url.org</i></a> + mouse, That he<br> + <p> + met in the<br> + <p> + house,<br> + <p> + <br> + <p> + both go to<br> + <p> + law: I will<br> + <p> + prosecute<br> + <p> + YOU. --Come,<br> + <p> + I’ll take no<br> + <p> + denial; We<br> + <p> + must have a<br> + <p> + trial: For<br> + <p> + really this<br> + <p> + morning I’ve<br> + <p> + nothing<br> + <p> + to do.<br> + <p> + Said the<br> + <p> + mouse to the<br> + <p> + cur,<br> + <p> + a trial,<br> + <p> + dear Sir,<br> + <p> + With<br> + <p> + no jury<br> + <p> + or judge,<br> + <p> + would be<br> + <p> + wasting<br> + <p> + our<br> + <p> + breath.<br> + <p> + <br> + <p> + judge, I’ll<br> + <p> + be jury,<br> + <p> + Said<br> + <p> + cunning<br> + <p> + old Fury:<br> + <p> + <br> + <p> + try the<br> + <p> + whole<br> + <p> + cause,<br> + <p> + and<br> + <p> + condemn<br> + <p> + you<br> + <p> + to<br> + <p> + death.<br> <p> -<i>{</i> image.png <i>}image</i> -<p> -<i>{</i> tux.png 64x80 <i>}image</i> <p> -NOTE: (a) png and jpg support only (no gif) (b) width -x height, not required if imagemagick is installed, (where provided, dimensions -may be smaller than the actual image), [images should be no larger than -width: 480 and height: 640] <p> -the shortcut: <p> -<i>{~^</i> [text to link] <i>}<a href='http://url.org'>http://url.org</i></a> -<p> -is equivalent to: <p> -<i>{</i> [text to link] <i>}<a href='http://url.org'>http://url.org</i></a> - <i>~{</i> <a href='http://url.org'>http://url.org</a> - <i>}~</i> <p> -(which -produces hyper-linked text within a document/paragraph, with an endnote -providing the url for the text location used in the hyperlink) <p> -url example: -<p> -<i>{</i> SiSU Geek Writer <i>}<a href='http://www.jus.uio.no/sisu/'>http://www.jus.uio.no/sisu/</i></a> +<p> 11.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> <p> -linked image: <p> -<i>{</i> tux.png 64x80 -"a better way" <i>}<a href='http://www.jus.uio.no/sisu/'>http://www.jus.uio.no/sisu/</i></a> - image example with all options -<p> -note width x height <p> -the shortcut: <p> -<i>{</i> [text to link] <i>[3sS]}markup_source_filename.sst</i> -<p> -if a server host name has been provided/configured, will provide a list -of available output types that would be generated using the shortcut command -and the markup file provided, i.e. output generated using the command (as -configured): "sisu -3sS markup_source_filename.sst", using server host, directory -stub, filename to compose the link. -<h2><a name='sect13' href='#toc13'>Adding a fixed names in html</a></h2> -<p> -<i>*~[name]</i> -manual location marker/tagging at present only in html to produce <a name="[name]"></a> -(use sparingly) <blockquote>note at a heading level the same is automatically achieved -by providing names to headings 5 and 6 i.e. 5~[name] and 6~[name] or in the -case of auto-heading numbering, without further intervention. </blockquote> - -<h2><a name='sect14' href='#toc14'>Escape object -citation numbering</a></h2> -<p> -(place marker at end of paragraph) <p> -<i>~#</i> unnumbered paragraph -<p> -<i>-#</i> unnumbered paragraph, delete when not required (place marker at end of -paragraph) [used in dummy headings, eg. for segmented html] <p> + mouse, That he<br> + <p> + met in the<br> + <p> + house,<br> + <p> + <br> + <p> + both go to<br> + <p> + law: I will<br> + <p> + prosecute<br> + <p> + YOU. --Come,<br> + <p> + I’ll take no<br> + <p> + denial; We<br> + <p> + must have a<br> + <p> + trial: For<br> + <p> + really this<br> + <p> + morning I’ve<br> + <p> + nothing<br> + <p> + to do.<br> + <p> + Said the<br> + <p> + mouse to the<br> + <p> + cur,<br> + <p> + a trial,<br> + <p> + dear Sir,<br> + <p> + With<br> + <p> + no jury<br> + <p> + or judge,<br> + <p> + would be<br> + <p> + wasting<br> + <p> + our<br> + <p> + breath.<br> + <p> + <br> + <p> + judge, I’ll<br> + <p> + be jury,<br> + <p> + Said<br> + <p> + cunning<br> + <p> + old Fury:<br> + <p> + <br> + <p> + try the<br> + <p> + whole<br> + <p> + cause,<br> + <p> + and<br> + <p> + condemn<br> + <p> + you<br> + <p> + to<br> + <p> + death.<br> + <p> + +<p> 11.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 option to number each line + of code may be considered at 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, -<h2><a name='sect15' href='#toc15'>Page breaks -(LaTeX/pdf)</a></h2> -<p> -page breaks are introduced to pdfs either as header instructions, -indicating that pages should break at given levels, and mentioned in the -header section, or manually, using the following notation <p> -<i><:pb></i> page break, -which breaks a page, starting a new page in single column text and a new -column in double column text <p> -<i><:pn></i> page new, which starts a new page, in -both single and double column text (leaving an empty column in double column -text if necessary). -<h2><a name='sect16' href='#toc16'>Comment line</a></h2> -<p> -<i>%</i> ignored by sisu in processing if placed -at beginning of line <p> -<i>%%</i> ignored by sisu in processing if placed at beginning -of line, used for folding by vim folds -<h2><a name='sect17' href='#toc17'>Special characters</a></h2> -special characters -can be escaped with a backslash <i>{</i> } < > are contextual special characters, -(in combination with other characters). <i>~</i> - _ / % ^ and occasionally <i>!</i> # + -, are special characters in particular circumstances, see the syntax chart. -[note that SiSU is not optimised for technical writing] -<h2><a name='sect18' href='#toc18'>Tables</a></h2> + 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> 12. 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> r{filename} + {filename.ssi}require + << {filename.ssi} + % using textlink alternatives + |filename.ssi|@|^|require + << |filename.ssi|@|^| + % using thlnk alternatives + <url:filename.ssi>require + << <url:filename.ssi> +</pre> +<p> MARKUP SYNTAX HISTORY +<p> 13. NOTES RELATED TO FILES-TYPES AND MARKUP SYNTAX + +<p> 0.38 is substantially current, depreciated 0.16 supported, though file + +<p>names were changed at 0.37 +<p> <b>0.52</b> (2007w14/6) declared document type identifier +at start of text/document: +<p> .B SiSU<br> + 0.52 +<p> or, backward compatible using the comment marker: +<p> %<br> + <b>SiSU</b> 0.38 +<p> variations include ’ <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>0.38</b> (2006w15/7) +introduced new/alternative notation for headers, e.g. @title: (instead of +0~title), and accompanying document structure markup, :A,:B,:C,1,2,3 (maps +to previous 1,2,3,4,5,6) +<p> <b>0.37</b> (2006w09/7) introduced new file naming convention, +.sst (text), .ssm (master), .ssi (insert), markup syntax unchanged +<p> <b>0.35</b> (2005w52/3) +sisupod, zipped content file introduced +<p> <b>0.23</b> (2005w36/2) utf-8 for markup + +<p>file +<p> <b>0.22</b> (2005w35/3) image dimensions may be omitted if rmagick is available + +<p>to be relied upon +<p> <b>0.20.4</b> (2005w33/4) header 0~links +<p> <b>0.16</b> (2005w25/2) substantial +changes introduced to make markup cleaner, header 0~title type, and headings + [1-6]~ introduced, also percentage sign (%) at start of a text line as comment + +<p>marker +<p> 14. SISU FILETYPES +<p> <b>SiSU</b> has plaintext and binary filetypes, and +can process either type of document. +<p> 14.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 +<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> 14.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> 14.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 [^22] + +<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> 14.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> 14.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> 15. EXPERIMENTAL ALTERNATIVE INPUT +REPRESENTATIONS +<p> 15.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 node):<br> + [filename/wildcard]<br> + +<p> sisu --to-dom [filename/wildcard] or sisu --to-sxd node):<br> + [filename/wildcard]<br> + +<p> sisu --to-node [filename/wildcard] or sisu --to-sxn <br> + [filename/wildcard]<br> + +<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> 15.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 <br> + [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> 15.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 <br> + [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> 15.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 <br> + [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> 16. CONFIGURATION +<p> 16.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> 16.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> -<i>table{</i> [number -of columns] [column width %];[column width %] -<p> [table content, line breaks -are important see example below]<br> + 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> 17. 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> <i>}table</i> -<p> sample table:<br> +<p> ~/.sisu/skin<br> -<p> <i>table{~h</i> c3; 26; 32; 32; -<p> This is a table, column1<br> - this would become row one of column two<br> - column three of row one is here<br> +<p> /etc/sisu/skin<br> -<p> column one row 2<br> - column two of row two<br> - column three of row two, and so on<br> +<p> <b>Within the skin directory</b> are the following the default sub-directories +for document skins: +<p> ./skin/doc<br> -<p> column one row three<br> - and so on<br> - here<br> +<p> ./skin/dir<br> -<p> <i>}table</i> -<p> whole table gets an object citation number -<p> -<h2><a name='sect19' href='#toc19'>Other Grouped or -Pre-formatted Text</a></h2> -<i>poem{</i> -<p> [Text here]<br> +<p> ./skin/site<br> -<p> [Text here]<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> 17.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> 17.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> 17.3 SITE SKIN +<p> A site skin, modifies the program default skin. +<p> 17.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> <i>}poem</i> -<p> each verse is given an object citation number -<p> ----<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> <i>group{</i> -<p> [Text here]<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> <i>}group</i> -<p> whole group gets an object citation number -<p> ----<br> +<p> 18. 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 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: + +<p>sax.css +<p> XHTML: xhtml.css +<p> The default homepage may use homepage.css or + +<p>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.[^23] +<p> 19. ORGANISING +CONTENT +<p> 19.1 DIRECTORY STRUCTURE 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> 19.2 ORGANISING CONTENT +<p> 20. HOMEPAGES -<p> <i>code{</i> -<p> [Text here]<br> +<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> 20.1 HOME PAGE AND OTHER CUSTOM BUILT 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> <i>}code</i> -<p> whole group gets an object citation number -<p> -<h2><a name='sect20' href='#toc20'>Composite Documents</a></h2> +<p> 20.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> -It -is possible to build a document by requiring other documents. The documents -required may 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 mainly from other documents), by convention it should be named with -the suffix <i>.ssm</i> (master) 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 <i>.sst</i> regular markup -file, or <i>.ssi</i> (insert/information) <i>.sst</i> A secondary file of the composite -document is built prior to processing with the same prefix and the suffix -<i>._sst</i> and <i>._sst</i> There are a number of alternative syntaxes for requiring -external documents in order to permit use of ascii hypertext linking available -in the vim editor. They are as follows: + 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> 21. MARKUP AND OUTPUT EXAMPLES +<p> 21.1 MARKUP EXAMPLES +<p> Current markup examples +and document output samples are provided at <<a href='http://www.jus.uio.no/sisu/SiSU/2.html'>http://www.jus.uio.no/sisu/SiSU/2.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> 22. +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> 23. SQL +<p> 23.1 POPULATING SQL TYPE DATABASES + +<p> <b>SiSU</b> feeds sisu markupd documents into sql type databases PostgreSQL[^24] +and/or SQLite[^25] 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> 24. +POSTGRESQL +<p> 24.1 NAME +<p> <b>SiSU</b> - Structured information, Serialized Units +- a document publishing system, postgresql dependency package +<p> 24.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> 24.3 SYNOPSIS +<p> sisu -D [instruction] [filename/wildcard + if required]<br> + +<p> sisu -D --pg --[instruction] [filename/wildcard if required]<br> + +<p> 24.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> 24.4.1 CREATE AND DESTROY DATABASE <p> <dl> -<dt>basic markup for importing a document +<dt><b> --pgsql --createall</b> </dt> -<dd> -<p> <i>r{</i> filename <i>}</i> -<p> <i>{</i> filename.si <i>}require</i> -<p> <i><<</i> { filename.si <i>}</i> #for vim folds -<p> -</dd> - -<dt>importing a document with textlink syntax </dt> -<dd> -<p> <i>|filename.si|@|^|require</i> -<p> <i><<</i> |filename.si|@|^| +<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) the same name + as working directory, as +<p> </dd> -<p>#for vim folds +<dt><b> sisu -D --createdb</b> </dt> +<dd> creates database where no database + existed before as <p> </dd> -<dt>importing a document with thlnk syntax </dt> -<dd> -<p> <i><url:filename.si>require</i> +<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> <i><<</i> <url:filename.si> #for vim folds <p> </dd> -<dt>remote documents may be called with the -thlnk syntax (or regular sisu syntax), e.g. </dt> -<dd> -<p> <i><<</i> <url:<a href='http://www.url.com/filename.si'>http://www.url.com/filename.si</a> -> +<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> -<p> </dd> -</dl> +<dt><b> sisu -D --recreate</b> </dt> +<dd> destroys existing -<h2><a name='sect21' href='#toc21'>Document Headers</a></h2> -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. -<p> All header -instructions may take either form: <i>@headername:</i> [introduced in 0.38] or - -<p><i>0~headername</i> All Dublin Core meta tags are available -<p> <i>@indentifier:</i> information -or instructions [introduced in 0.38] -<p> or -<p> <i>0~indentifier</i> information or instructions, -old equivalent, depreciated -<p> where the "identifier" is a tag recognised -by the program, and the "information" or "instructions" belong to the tag/indentifier -specified. -<p> Note: a header where used should only be used once; all headers -apart from @title: (0~title) are optional; the @structure: (0~toc) header -is used to describe document structure, and can be useful to know. -<p> @structure: -PART; CHAPTER; SECTION; ARTICLE; none; none; -<p> structure can be defined -by a match words or regular expression (the regular expression is assumed -to start at the beginning of a line of text i.e. ^) -<p> For help see one of -the following (and markup samples):<br> - -<p> * interactive help - type ’sisu --help headers’<br> - -<p> * marked up text samples<br> - -<p> * the SiSU_Markup.txt file provided with the program<br> - -<p> * an outline of headers is provided below --><br> - -<h2><a name='sect22' href='#toc22'>Outline of header options</a></h2> -<i>%</i> SiSU 0.38 [declared file-type identifier with -markup version] -<p> <i>@title:</i> My Title - This is now the Title of the Document - -<p>and used as such -<p> <i>@subtitle:</i> The Subtitle if any -<p> <i>@creator:</i> [or ~author] - -<p>Ralph Amissah -<p> <i>@subject:</i> (whatever your subject) -<p> <i>@description:</i> -<p> <i>@publisher:</i> - -<p> <i>@contributor:</i> -<p> <i>@translator:</i> [or ~translated_by] -<p> <i>@illustrator:</i> [or ~illustrated_by] - -<p> <i>@prepared_by:</i> [or ~digitized_by] -<p> <i>@date:</i> 2000-08-27 [ also @date.created: -@date.issued: @date.available: @date.valid: @date.modified: ] -<p> <i>@type:</i> article - -<p> <i>@format:</i> -<p> <i>@identifier:</i> -<p> <i>@source:</i> -<p> <i>@language:</i> [or @language.document:] language -in which current version of document is published. Some country settings -result in processing adjustments, e.g. in LaTeX hyphenation, some country -codes are recognized, but the language name in Engish is preferred. English -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, ee - Estonian, hu - Hungarian, pl - Polish, -ro - Romanian, ru - Russian, gl - Greek, uk - Ukranian, tr - Turkish, si - Slovene, -sk - Slovak, hr - Croatian, cs - Czech, bg - Bulgarian ) [however, encodings -are not available for all of the languages listed.] -<p> <i>@language.original:</i> - -<p>original language in which the work was published -<p> <i>@papersize:</i> (A4|US_letter|book_B5|book_A5|US_legal) - -<p> <i>@relation:</i> -<p> <i>@coverage:</i> -<p> <i>@rights:</i> copyright, all rights reserved, public -domain, copyleft, creative commons variant, etc. -<p> <i>@owner:</i> -<p> <i>@keywords:</i> text -document generation processing management LaTeX pdf structured XML citation -[your keywords here, used for example by rss feeds, and in sql sear ches] - -<p> <i>@abstract:</i> [paper abstract, placed after table of contents] -<p> <i>@comment:</i> -[...] -<p> <i>@catalogue:</i> loc=[Library of Congress classification]; dewey=[Dewey -classification]; isbn=[ISBN]; pg=[Project Gutenberg text number] -<p> <i>@classify_loc:</i> - -<p>Library of Congress classification -<p> <i>@classify_dewey:</i> Dewey classification - -<p> <i>@classify_isbn:</i> ISBN -<p> <i>@classify_pg:</i> Project Gutenberg text number -<p> <i>@prefix_a:</i> -[prefix is placed just before table of contents - not implemented] -<p> <i>@prefix_b:</i> -or @prefix: [prefix is placed just after table of contents] -<p> <i>@rcs:</i> $Id$ -[or <i>@cvs:</i> 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> <i>@structure:</i> PART; CHAPTER; SECTION; ARTICLE; none; none; -optional, where document structure can be defined by a match words or regular -expression (the regular expression is assumed to start at the beginning -of a line of text i.e. ^) default markers :A~ to :C~ and 1~ to 6~ can be used -within text instead, without this header ta g, and may be used to supplement -the instructions provided in this header tag if provided (@structure: is -a synonym for @toc:) -<p> <i>@markup:</i> information on the markup used, e.g. <i>new=1,2,3;</i> -break=4; num_top=4 [or newpage=1,2,3; breakpage=4; num_top=4] newpage and -breakpage, heading level, used by LaTeX to breakpages. breakpage: starts -on a new page in single column text and on a new column in double column -text; newpage: starts on a new page for both single and double column texts. -<i>num_top=4</i> [auto-number document, starting at level 4. the default is to provide -3 levels, as in 1 level 4, 1.1 level 5, 1.1.1 level 6, markup to be merged -within level] <i>num_extract</i> [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> <i>@bold:</i> [regular expression of words/phrases to be made bold] +<p> database and builds a new empty database structure +<p> </dd> +</dl> +24.4.2 IMPORT AND REMOVE -<p> <i>@italics:</i> [regular expression of words/phrases to italicise] -<p> <i>@vocabulary:</i> +<p>DOCUMENTS +<p> +<dl> -<p>name of taxonomy/vocabulary/wordlist to use against document -<p> <i>@skin:</i> skin_doc_[name_of_desired_document_skin] +<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> -<p> <i>@links:</i> { SiSU }<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> <i>@promo:</i> -sisu, ruby, search_libre_docs, open_society [places content in right pane -in html, makes use of list.yml and promo.yml, commented out sample in document -sample: free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst] - -<p> <i>:A~</i> Top level heading [this usually has similar content to the title @title: -] NOTE: the heading levels described here are in 0.38 notation, see heading - -<p> <i>:B~</i> Second level heading [this is a heading level divider] -<p> <i>:C~</i> Third -level heading [this is a heading level divider] -<p> <i>1~</i> 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> <i>2~</i> 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> <i>3~</i> 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> NOTE: headers and heading -levels used in the description provided refer to 0.38 markup (a conversion -script provided in sisu-examples, modify.rb makes conversion between 0.37 -and 0.38 markup simple) -<p> For some help on document structure try -<p> <i>sisu</i> --help - -<p>headings -<p> and view sample markup documents provided -<p> -<p> -<h2><a name='sect23' href='#toc23'>Configuration -Files</a></h2> -<p> -Some configuration is required for SiSU, specifying in which directory -processing should be done, and where the generated output should be placed. -<p> -SiSU resource configuration is determined by looking at the following files -if they exist: <p> -<i>./_sisu/sisurc.yml</i> <p> -<i>~/.sisu/sisurc.yml</i> <p> -<i>/etc/sisu/sisurc.yml</i> <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> -A sample sisurc.yml may be found in /etc/sisu/sisurc.yml +<dt><b> sisu -D --update -v [filename/wildcard]</b> </dt> +<dd>updates -<p> -<h2><a name='sect24' href='#toc24'>More HELP on Markup and headers</a></h2> -type: sisu ~<br> - sisu --help<br> - -<p> markup help is available on:<br> - document wide instructions: headers (document structure)<br> - general text markup: headings; endnotes; tables<br> - -<p> A markup table and sample marked-up files (also in html with syntax highlighting) -are available at: -<p> <i><<a href='http://www.jus.uio.no/sisu/sample'>http://www.jus.uio.no/sisu/sample</a> -></i> -<p> -<h2><a name='sect25' href='#toc25'>DIRECTORY STRUCTURE -& Document Output</a></h2> +<p>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> +25. SQLITE +<p> 25.1 NAME +<p> <b>SiSU</b> +- Structured information, Serialized Units - a document publishing system. + +<p> 25.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> 25.3 SYNOPSIS +<p> sisu -d [instruction] [filename/wildcard + if required]<br> + +<p> sisu -d --(sqlite|pg) --[instruction] [filename/wildcard if <br> + required]<br> + +<p> 25.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> 25.4.1 CREATE AND DESTROY DATABASE +<p> <dl> -<dt>SiSU determines output directories by looking at the resource -configuration files, and in their absence the programs internal defaults. +<dt><b> --sqlite --createall</b> </dt> -<dd> </dd> -</dl> +<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> -<h2><a name='sect26' href='#toc26'>Default Directories</a></h2> +<dt><b> sisu -d --createdb</b> </dt> +<dd> creates database where + no database existed before as +<p> </dd> -<dl> +<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>In the absence of other specifications in </dt> -<dd><i>~/.sisu/sisurc.yml</i> -in <i>/etc/sisu/sisurc.yml</i> SiSU writes to the following directories, processing -files are placed in sub-directories within <i>./_sisu/processing</i> and if that -is not writable to <i>/tmp/sisu_processing</i> </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> -<p> -Output is written to sub-directories -within <i>/var/www/</i> if it exists and is writable, and otherwise to <i>~/sisu_output</i> - -<h2><a name='sect27' href='#toc27'>Markup Document Directories and File Mapping</a></h2> +25.4.2 IMPORT +<p>AND REMOVE DOCUMENTS +<p> <dl> -<dt>Ideally documents should be -placed as collections sub-directories of their own, with a common denominator, -such as subject or author. </dt> -<dd></dd> +<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>The last part of a directory path is used to -create a sub-directory into which generated documents are placed, in (sub-sub)directories -of their own. </dt> -<dd></dd> +<dt><b> sisu -d --update -v [filename/wildcard]</b> </dt> +<dd>updates -<dt>the document </dt> -<dd></dd> +<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> -<p> -<blockquote><i>~/ebook/free_culture.sst</i> </blockquote> +26. INTRODUCTION +<p> 26.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> +> [^26] 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.[^27] +<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.[^28] +<p> +<dl> +<dt><b> sisu -F --webserv-webrick</b> +</dt> +<dd> +<p> builds a cgi web search 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> +26.2 SEARCH FORM +<p> <dl> -<dt>would map to </dt> -<dd></dd> +<dt><b> sisu -F</b> </dt> +<dd> generates a sample search form, which must + be copied to which must be copied to +<p> </dd> + +<dt><b> sisu -F --webserv-webrick</b> </dt> +<dd> generates a + sample search form for use with the webrick which must be copied to the + web-server cgi directory which must be copied to the web-server cgi directory + +<p> </dd> + +<dt><b> sisu -Fv</b> </dt> +<dd> as above, and provides some information on setting up +<p> </dd> + +<dt><b> sisu -W</b> +</dt> +<dd> +<p> starts the webrick server which should be available +<p> The generated search + +<p>form must be copied manually to the webserver directory as instructed +<p> +</dd> </dl> +27. 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> 28. SISU_WEBRICK + +<p> 28.1 NAME +<p> <b>SiSU</b> - Structured information, Serialized Units - a document + +<p>publishing system +<p> 28.2 SYNOPSIS +<p> sisu_webrick [port] +<p> or +<p> sisu -W [port] + +<p> 28.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> 28.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> 28.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> 28.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> 28.7 AUTHOR +<p> Ralph Amissah <ralph@amissah.com> or <ralph.amissah@gmail.com> <p> -<blockquote><i>~[configured</i> -output path]/ebook/free_culture </blockquote> +<p>28.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> 29. 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/2.html'>http://www.jus.uio.no/sisu/SiSU/2.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 document + +<p>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/2.html'>http://www.jus.uio.no/sisu/SiSU/2.html</a> +> and use the url for the +desired document. +<p> REMOTE DOCUMENT OUTPUT +<p> 30. 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> 30.1 COMMANDS +<p> <dl> -<dt>within which would be placed all html, -XML, pdf output, typically under the names: </dt> -<dd></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 have + +<p>your +<p> </dd> </dl> +30.2 CONFIGURATION +<p> [expand on the setting up of an ssh-agent / keychain] + +<p> 31. 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> 32. QUICKSTART - GETTING STARTED HOWTO + +<p> 32.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> 32.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> 32.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> 32.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)[^29] 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> 32.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> -<blockquote><i>index.html</i> index for segmented -text <p> -<i>doc.html</i> full length scrollable document <p> -<i>toc.html</i> index for segmented -text <p> -html segments, as many as there may be... -<dl> + +<p> or +<p> +<p> change directory to the appropriate one: +<p> cd /usr/share/doc/sisu/sisu_markup_samples/dfsg -<dt><i>portrait.pdf</i> </dt> -<dd></dd> -</dl> +<p> 32.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> 32.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> 32.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> 32.3 GETTING HELP +<p> 32.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> +> + [^30] +<p> * sisu.8 <<a href='http://www.jus.uio.no/sisu/man/sisu.8'>http://www.jus.uio.no/sisu/man/sisu.8</a> +> [^31] +<p> * man directory +<<a href='http://www.jus.uio.no/sisu/man'>http://www.jus.uio.no/sisu/man</a> +> [^32] +<p> 32.3.2 BUILT IN HELP +<p> sisu --help +<p> sisu + +<p>- +<p>- +<p>help --env +<p> sisu --help --commands +<p> sisu --help --markup +<p> 32.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> 32.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/2.html'>http://www.jus.uio.no/sisu/SiSU/2.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[^33] 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> 33. 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}::<br> + <b> SiSU</b> ] +<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</b> 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> 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> <file:///usr/share/doc/sisu/html/sisu_help.1.html><br> + +<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> <file:///usr/share/doc/sisu/sisu_manual/sisu_help/index.html><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_help/index.html'>http://sisudoc.org/sisu_manual/sisu_help/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_help/index.html'>http://www.jus.uio.no/sisu/sisu_manual/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> <file:///usr/share/doc/sisu/sisu_manual/sisu_help_sources/index.html><br> + +<p> <file:///usr/share/doc/sisu/html/sisu_help_sources/index.html><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_help_sources/index.html'>http://sisudoc.org/sisu_manual/sisu_help_sources/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html</a> +><br> + +<p> 34.1 MAN PAGES +<p> 34.1.1 MAN +<p> man sisu<br> + +<p> man sisu_commands<br> + +<p> man 7 sisu_complete<br> + +<p> man sisu_configuration<br> + +<p> man 8 sisu_faq<br> + +<p> man sisu_filetypes<br> + +<p> man sisu_help<br> + +<p> man sisu_help_sources<br> + +<p> man 8 sisu_howto<br> + +<p> man sisu_introduction<br> + +<p> man sisu_markup<br> + +<p> man sisu_output_overview<br> + +<p> man 7 sisu_pdf<br> + +<p> man 7 sisu_postgresql<br> + +<p> man 8 sisu_quickstart<br> + +<p> man 8 sisu_remote<br> + +<p> man 8 sisu_search<br> + +<p> man sisu_skin<br> + +<p> man 7 sisu_sqlite<br> + +<p> man 8 sisu_syntax_highlighting<br> + +<p> man 7 sisu_vim<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[^34] +<p> 34.2.1 LOCALLY INSTALLED +<p> <file:///usr/share/doc/sisu/sisu_manual/sisu_manual/index.html> + +<p> <file:///usr/share/doc/sisu/sisu_manual/sisu_help/index.html> +<p> <file:///usr/share/doc/sisu/sisu_manual/sisu_help_sources/index.html> + +<p> /usr/share/doc/sisu/sisu_manual/sisu/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_commands/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_complete/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_configuration/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_description/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_examples/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_faq/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_filetypes/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_help/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_help_sources/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_howto/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_introduction/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_manual/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_markup/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_output_overview/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_pdf/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_postgresql/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_quickstart/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_remote/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_search/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_skin/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_sqlite/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_syntax_highlighting/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_vim/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_webrick/index.html<br> + +<p> 34.2.2 WWW.SISUDOC.ORG +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_manual/index.html'>http://sisudoc.org/sisu_manual/sisu_manual/index.html</a> +> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu/index.html'>http://sisudoc.org/sisu_manual/sisu/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_commands/index.html'>http://sisudoc.org/sisu_manual/sisu_commands/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_complete/index.html'>http://sisudoc.org/sisu_manual/sisu_complete/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_configuration/index.html'>http://sisudoc.org/sisu_manual/sisu_configuration/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_description/index.html'>http://sisudoc.org/sisu_manual/sisu_description/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_examples/index.html'>http://sisudoc.org/sisu_manual/sisu_examples/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_faq/index.html'>http://sisudoc.org/sisu_manual/sisu_faq/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_filetypes/index.html'>http://sisudoc.org/sisu_manual/sisu_filetypes/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_help/index.html'>http://sisudoc.org/sisu_manual/sisu_help/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_help_sources/index.html'>http://sisudoc.org/sisu_manual/sisu_help_sources/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_howto/index.html'>http://sisudoc.org/sisu_manual/sisu_howto/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_introduction/index.html'>http://sisudoc.org/sisu_manual/sisu_introduction/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_manual/index.html'>http://sisudoc.org/sisu_manual/sisu_manual/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_markup/index.html'>http://sisudoc.org/sisu_manual/sisu_markup/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_output_overview/index.html'>http://sisudoc.org/sisu_manual/sisu_output_overview/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_pdf/index.html'>http://sisudoc.org/sisu_manual/sisu_pdf/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_postgresql/index.html'>http://sisudoc.org/sisu_manual/sisu_postgresql/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_quickstart/index.html'>http://sisudoc.org/sisu_manual/sisu_quickstart/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_remote/index.html'>http://sisudoc.org/sisu_manual/sisu_remote/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_search/index.html'>http://sisudoc.org/sisu_manual/sisu_search/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_skin/index.html'>http://sisudoc.org/sisu_manual/sisu_skin/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_sqlite/index.html'>http://sisudoc.org/sisu_manual/sisu_sqlite/index.html</a> +><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://sisudoc.org/sisu_manual/sisu_vim/index.html'>http://sisudoc.org/sisu_manual/sisu_vim/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_webrick/index.html'>http://sisudoc.org/sisu_manual/sisu_webrick/index.html</a> +><br> + +<p> 34.2.3 WWW.JUS.UIO.NO/SISU +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_manual/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_manual/index.html</a> +> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_commands/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_commands/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_complete/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_complete/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_description/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_description/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_examples/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_examples/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_faq/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_faq/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_filetypes/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_filetypes/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_help/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_help/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_howto/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_howto/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_introduction/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_introduction/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_manual/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_manual/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_markup/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_markup/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_output_overview/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_output_overview/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_pdf/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_pdf/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_postgresql/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_postgresql/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_remote/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_remote/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_search/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_search/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_skin/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_skin/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_sqlite/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_sqlite/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> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_vim/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_vim/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_webrick/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_webrick/index.html</a> +><br> + +<p> 34.2.4 MAN2HTML +<p> 34.2.5 LOCALLY INSTALLED +<p> <file:///usr/share/doc/sisu/html/sisu_manual.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_commands.1.html<br> + +<p> /usr/share/doc/sisu/html/sisu_complete.7.html<br> + +<p> /usr/share/doc/sisu/html/sisu_configuration.1.html<br> + +<p> /usr/share/doc/sisu/html/sisu_faq.8.html<br> + +<p> /usr/share/doc/sisu/html/sisu_help.1.html<br> + +<p> /usr/share/doc/sisu/html/sisu_help_sources.1.html<br> + +<p> /usr/share/doc/sisu/html/sisu_howto.8.html<br> + +<p> /usr/share/doc/sisu/html/sisu_markup.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_quickstart.8.html<br> + +<p> /usr/share/doc/sisu/html/sisu_remote.8.html<br> + +<p> /usr/share/doc/sisu/html/sisu_search.8.html<br> + +<p> /usr/share/doc/sisu/html/sisu_skin.1.html<br> + +<p> /usr/share/doc/sisu/html/sisu_sqlite.7.html<br> + +<p> /usr/share/doc/sisu/html/sisu_syntax_highlighting.8.html<br> + +<p> /usr/share/doc/sisu/html/sisu_vim.7.html<br> + +<p> /usr/share/doc/sisu/html/sisu_webrick.1.html<br> + +<p> 34.2.6 WWW.SISUDOC.ORG +<p> <<a href='http:///sisudoc.org/man/sisu_manual.1.html'>http:///sisudoc.org/man/sisu_manual.1.html</a> +> +<p> <<a href='http:///sisudoc.org/man/sisu_help.1.html'>http:///sisudoc.org/man/sisu_help.1.html</a> +> + +<p> <<a href='http:///sisudoc.org/man/sisu_help_sources.1.html'>http:///sisudoc.org/man/sisu_help_sources.1.html</a> +> +<p> <<a href='http://sisudoc.org/man/sisu.1.html'>http://sisudoc.org/man/sisu.1.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_commands.1.html'>http://sisudoc.org/man/sisu_commands.1.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_complete.7.html'>http://sisudoc.org/man/sisu_complete.7.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_configuration.1.html'>http://sisudoc.org/man/sisu_configuration.1.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_faq.8.html'>http://sisudoc.org/man/sisu_faq.8.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_help.1.html'>http://sisudoc.org/man/sisu_help.1.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_help_sources.1.html'>http://sisudoc.org/man/sisu_help_sources.1.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_howto.8.html'>http://sisudoc.org/man/sisu_howto.8.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_markup.1.html'>http://sisudoc.org/man/sisu_markup.1.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_pdf.7.html'>http://sisudoc.org/man/sisu_pdf.7.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_postgresql.7.html'>http://sisudoc.org/man/sisu_postgresql.7.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_quickstart.8.html'>http://sisudoc.org/man/sisu_quickstart.8.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_remote.8.html'>http://sisudoc.org/man/sisu_remote.8.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_search.8.html'>http://sisudoc.org/man/sisu_search.8.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_skin.1.html'>http://sisudoc.org/man/sisu_skin.1.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_sqlite.7.html'>http://sisudoc.org/man/sisu_sqlite.7.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_syntax_highlighting.8.html'>http://sisudoc.org/man/sisu_syntax_highlighting.8.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_vim.7.html'>http://sisudoc.org/man/sisu_vim.7.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_webrick.1.html'>http://sisudoc.org/man/sisu_webrick.1.html</a> +><br> + +<p> 34.2.7 WWW.JUS.UIO.NO/SISU +<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_manual.1.html'>http://www.jus.uio.no/sisu/man/sisu_manual.1.html</a> +> + +<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> +> +<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_help_sources.1.html'>http://www.jus.uio.no/sisu/man/sisu_help_sources.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_commands.1.html'>http://www.jus.uio.no/sisu/man/sisu_commands.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_configuration.1.html'>http://www.jus.uio.no/sisu/man/sisu_configuration.1.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_faq.8.html'>http://www.jus.uio.no/sisu/man/sisu_faq.8.html</a> +><br> + +<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> <<a href='http://www.jus.uio.no/sisu/man/sisu_help_sources.1.html'>http://www.jus.uio.no/sisu/man/sisu_help_sources.1.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_howto.8.html'>http://www.jus.uio.no/sisu/man/sisu_howto.8.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_markup.1.html'>http://www.jus.uio.no/sisu/man/sisu_markup.1.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_quickstart.8.html'>http://www.jus.uio.no/sisu/man/sisu_quickstart.8.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_remote.8.html'>http://www.jus.uio.no/sisu/man/sisu_remote.8.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_search.8.html'>http://www.jus.uio.no/sisu/man/sisu_search.8.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_skin.1.html'>http://www.jus.uio.no/sisu/man/sisu_skin.1.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_syntax_highlighting.8.html'>http://www.jus.uio.no/sisu/man/sisu_syntax_highlighting.8.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_vim.7.html'>http://www.jus.uio.no/sisu/man/sisu_vim.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://www.jus.uio.no/sisu/sisu_manual/sisu/sisu_manifest.html'>http://www.jus.uio.no/sisu/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> DC Title: <i>SiSU</i> - SiSU information Structuring Universe - Manual [0.58] <p> -<i>landscape.pdf</i> <p> -<i>sax.xml</i> -XML shallow structure, sax type parsing <p> -<i>dom.xml</i> XML deeper structure, dom -type parsing <p> -<i>scroll.xhtml</i> xhtml <p> -<i>plain.txt</i> plain text </blockquote> + 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-08-30</i> +<p> DC Date: <i>2007-08-30</i> +<p> <b>Version Information</b> + +<p> Sourcefile: <i>sisu._sst</i> +<p> Filetype: <i>SiSU</i> text insert 0.58 +<p> Sourcefile Digest, +MD5(sisu._sst)= <i>850b4b4b2da877667488ddfa325b6581</i> +<p> Skin_Digest: MD5(/home/ralph/grotto/theatre/dbld/sisu-dev/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)= + +<p><i>20fc43cf3eb6590bc3399a1aef65c5a9</i> +<p> <b>Generated</b> +<p> Document (metaverse) last +generated: <i>Sun</i> Sep 23 01:13:56 +0100 2007 +<p> Generated by: <i>SiSU</i> <i>0.58.3</i> of +2007w36/4 (2007-09-06) +<p> Ruby version: <i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36) + [i486-linux] +<p> +<ol> +<b>.</b><li> +<p> <b>SiSU</b> information Structuring Universe Units also chosen +for the meaning of the Finnish term "sisu".<br> + </li><b>.</b><li>Unix command line oriented </li><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> +><br> + </li><b>.</b><li>ISO/IEC 26300:2006 </li><b>.</b><li>generated from source using rman <<a href='http://polyglotman.sourceforge.net/rman.html'>http://polyglotman.sourceforge.net/rman.html</a> +><br> + With regard to<br> + <b>SiSU</b> man pages the formatting generated for markup syntax is not quite +right, for that you might prefer the links under: <<a href='http://www.jus.uio.no/sample'>http://www.jus.uio.no/sample</a> +><br> + </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><<a href='http://www.jus.uio.no/sisu/man/sisu.8.html'>http://www.jus.uio.no/sisu/man/sisu.8.html</a> +> +</li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man/sisu_examples.1.html'>http://www.jus.uio.no/sisu/man/sisu_examples.1.html</a> +> </li><b>.</b><li><<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> +> +</dd> -<h2><a name='sect28' href='#toc28'>Multi-language Document -File Naming and Directory Mapping</a></h2> +<dt><b>*1.</b> </dt> +<dd>square brackets </dd> -<dl> +<dt><b>*2.</b> </dt> +<dd>square brackets </dd> -<dt>If the same document exists in different -language versions, and it is desired that the published language versions -should reside in the same output directory, the following filenaming convention -should be observed, using Spannish as the sample language code (es) [it -is very likley the use of country codes as language codes will be changed -or extended in future] [filename]~[language code].sst </dt> -<dd></dd> +<dt><b>+1.</b> </dt> +<dd>square brackets </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>filename~es.sst </dt> -<dd></dd> +<dt><b>*.</b> </dt> +<dd>unnumbered asterisk footnote/endnote, insert multiple +asterisks if required </dd> -<dt>within -sisurc.yml under the heading default the setting of language file: at 1, -2 or 3 determines the output filenaming convention used, as follows: </dt> -<dd></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>(1) -[output directory path]/filename/es.index.html </dt> +<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> +><br> + </li><b>.</b><li> 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</b> 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> +><br> + <<a href='http://en.wikipedia.org/wiki/Postgresql'>http://en.wikipedia.org/wiki/Postgresql</a> +><br> + </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> +><br> + </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>named index.html or more extensively through sisu_manifest.html + +<p> </dd> + +<dt>Other versions of this document: </dt> <dd></dd> -<dt>(2) [output directory path]/filename/index.es.html +<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>(3) [output directory path]/filename/index.html.es (which Apache for example -can be configured to use to automatically serve each users preference) -</dt> +<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>filename~fr.sst </dt> +<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>filename~de.sst </dt> +<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>etc. would be placed in the same directory -using the same convention as indeed would: </dt> +<dt>* Generated by: SiSU 0.58.3 of 2007w36/4 (2007-09-06) </dt> <dd></dd> -<dt>filename.sst </dt> +<dt>* Ruby version: ruby +1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt> <dd></dd> -<dt>using the default -convention mapping convention. </dt> +<dt>* Last Generated on: Sun Sep 23 +01:14:04 +0100 2007 </dt> <dd></dd> -<dt>Selecting this form of filename will overide -other language settings including the language header within a document. -</dt> -<dd> </dd> +<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> + </dt> +<dd></dd> </dl> - -<h2><a name='sect29' href='#toc29'>Markup Document Directories and Database Mapping</a></h2> -<p> -Similarly there is a mapping -to the database into which documents are placed. <p> -The last part of a directory -path is used to create a sub-directory into which generated documents are -placed, in a database of the same name, unless overridden. <p> -Documents within -the directory <i>~/ebook</i> <p> -<blockquote><i>~/ebook/free_culture.sst</i> </blockquote> <p> -would be placed in tables -within the database <p> -<blockquote><i>SiSU_ebook</i> </blockquote> - -<h2><a name='sect30' href='#toc30'>SKINS - document, directory and site skins</a></h2> -<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> -<i>./_sisu/skin</i> -<p> -<i>~/.sisu/skin</i> <p> -<i>/etc/sisu/skin</i> <p> -Within the skin directory are the following -the default sub-directories for document skins: <p> -<i>./skin/doc</i> <p> -<i>./skin/dir</i> <p> -<i>./skin/site</i> -<p> -Documents take on a document skin, if the header of the document specifies -a skin to be used. <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). when end <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> -A site skin, modifies the program default skin. <p> -Sample skins -may be found in /etc/sisu/skin/doc and /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc -(or equivalent directory) <p> -Samples of list.yml and promo.yml may be found -in /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml (or equivalent -directory) -<h2><a name='sect31' href='#toc31'>Document Naming Convention</a></h2> -<p> -SiSU documents are named with the -suffix <i>ss</i> followed by a third distinguishing letter, usually t for ordinary -text files. <p> -<i>.sst</i> is used by regular documents, and for most purposes is all -you need to be aware of <p> -<i>.ssm</i> suffix indicates a master or composite document, -i.e. a document which requests other documents, which may have the file extension -.sst or .ssi. See section on Composite Documents for information on how these -are prepared. <p> -<i>.ssi</i> indicates some prepared sisu markup information that is -to be requested within master or composite document(s) and is not to be -processed as a stand-alone document. <p> -<i>._sst</i> and <i>.-sst</i> suffix are reserved for -SiSU processing, and indicate a secondary file. Such secondary files are -created when a composite file is constructed, and when a url is provided, -it is saved locally for processing, as a secondary processing file. Secondary -files may be clobbered by SiSU at will, and are not a way of storing information. - -<p> <i>.sxs.xml</i> simple xml sax, sisu markup representation -<p> <i>.sxd.xml</i> simple xml dom, - -<p>sisu markup representation -<p> <i>.sxn.xml</i> simple xml node, sisu markup representation - -<p> <i>.sxs.xml.sst</i> or <i>.sxd.xml.sst</i> or <i>.sxn.xml.sst</i> auto-converted from a simple xml markup -representation (sxs, sxd, sxn) -<h2><a name='sect32' href='#toc32'>Remote Operations</a></h2> -<p> -These may be of three -basic types. <p> -Instruction that processed files are to be copied to a remote -server, using the -r or -R flag as part of the processing instruction. This -requires previous setting up/configuration of the method to be used (eg -scp assumed for -r and rsync for -R) and url to which these files are to -be sent. * <p> -The downloading of a remote file for processing using SiSU locally, -which is achieved in one of two ways: <p> -A processing instruction may include -the url to the a remote file that is to be processed - this will be downloaded -and given a temporary file .t extension, and will be processed using SiSU -locally. <p> -A file may request the inclusion of a remote document within it, -see comments on "Composite Documents" for the request syntax. <p> -Finally SiSU -may be run on a remote server, which you download marked up files to for -processing. This is not really a function of the operation of SiSU, just -an available possibility given that not much bandwidth is required. <p> -* with -regard to remote files processed locally, the -r option, a limitation is -that it is up to the user to ensure that the remote file does not have -an identical filename to another, e.g. local file, that is to be processed -in the same directory. So far this has not been found to happen in practice... -Alternative solutions are under consideration, but it is desired that filenames -be human assigned, and meaningful, so hash keys of contents for filenames -are not amongst the options considered. -<h2><a name='sect33' href='#toc33'>Note</a></h2> -<p> -For basic use only a fraction -of the information provided here is required. There may be a bit of an information -management problem in determining what though. For the markup of a book -see the samples provided in <i><<a href='http://www.jus.uio.no/sisu/sample'>http://www.jus.uio.no/sisu/sample</a> -></i> and referred -to in the text <i><<a href='http://www.jus.uio.no/sisu/SiSU'>http://www.jus.uio.no/sisu/SiSU</a> -></i> The flags to generate html -and pdf for use locally would be sisu -mHp [name of file to be processed] -This does assume an ok install and setup of SiSU and the associated software -it uses. -<p> -<h2><a name='sect34' href='#toc34'>Processing Examples</a></h2> -<p> -To initialise a new directory <b>sisu</b> <i>-C</i> <p> -Note: -this create a corresponding output subdirectory and this copies css stylesheet -files and basic image files to the output directory. The output directory -is created in the output path/directory as a subdirectory with its name -corresponding to that of the directory you are currently initialising. <p> -generate -the metafile used in subsequent processing only (note changes made to the -markup file will not appear in subsequently generated text unless this -flag is used: <b>sisu</b> <i>-m</i> [filename or wildcard] <p> -to create html and pdf output, -with verbose output of samplefile1.sst and samplefile2.sst <b>sisu</b> <i>-mhpv</i> samplefile1.sst -samplefile2.sst <blockquote>Note: <i>-m</i> does initial processing, and <i>-H</i> omits filename suffixes -and requires a properly configured web server. <i>-h</i> is used to include filename -suffixes for file system viewing </blockquote> -<p> -generate html, a word map and pdf with -verbose output for all marked up documents in a directory: <b>sisu</b> <i>-mhwpv</i> * -<p> -generate html, word map, pdf, plaintext, xhtml, xml sax and xml dom versions -with verbose output for all marked up documents in a directory: <b>sisu</b> <i>-mhwpabxXv</i> -* <p> -to create html, pdf, xml, plaintext and a concordance file (wordmap) -as output, with verbose output of all marked up files in a directory <b>sisu</b> -<i>-mhpxXawv</i> *.{r,s}? <p> -generate html, word map and pdf and place on remote server -with verbose output 2 named example files in a directory (assumes has been -set up, and first time must be run without other flags ie sisu <i>-mrv</i> [filenames/wildcard]): -<b>sisu</b> <i>-mhwprv</i> example_file.sst other_example_file.sst <p> -to process a remote sisu -marked up file (html,pdf,concordance), provide the url(s) (works for text -only files, will be downloaded and processed locally): <b>sisu</b> <i>-mhwpv</i> <a href='http://www.jus.uio.no/sisu/sample/markup/gpl3.fsf.sst'>http://www.jus.uio.no/sisu/sample/markup/gpl3.fsf.sst</a> - -http://www.jus.uio.no/sisu/sample/markup/autonomy_markup0.sst <p> -one file is local -the other remote process (html,pdf,concordance,plaintext and place on pre-set -remote destination): <b>sisu</b> <i>-mhwparv</i> gpl3.fsf.sst <a href='http://www.jus.uio.no/sisu/sample/markup/autonomy_markup0.sst'>http://www.jus.uio.no/sisu/sample/markup/autonomy_markup0.sst</a> - -<p> -initialize database, create relations (first manually create database with -same name as working directory): <b>sisu</b> <i>-Dv</i> createall <p> -it may be necessary -to first run <b>sisu</b> <i>-Dv</i> createdb <p> -import all marked up files first time into -a database: <b>sisu</b> <i>-Dv</i> import * <p> -<i>-c</i> toggles color -<h2><a name='sect35' href='#toc35'>Interactive Help Options</a></h2> -<p> -SiSU -has an interactive help, which is accessed by typing just "sisu" at the -command line, or as described below: <b>sisu</b> commands, document preparation, -customisation, installation etc. <br> -<pre>try: -sisu --help sisu help - help sisu --help - commands sisu --help commands - environment sisu --help env - ------------------------------------------ - Using SiSU - commands: sisu --help commands - ------------------------------------------ - Preparing Documents for SiSU - markup: sisu --help markup (an incomplete overview) - headers: sisu --help headers (document-wide instructions, meta-data) - structure sisu --help structure (document structure, headings, -tables of contents) - endnotes: sisu --help endnotes - tables: sisu --help tables - an example 0.37: sisu --help example37 - an example 0.38: sisu --help example38 - ------------------------------------------ - search sisu --help search - ------------------------------------------ - customise: sisu --help customise - ------------------------------------------ - SiSU’s License - license: sisu --help license - sisu interactive help topics include: - keywords include: list, commands, shortcuts, markup, syntax, headers, - headings, endnotes, tables, example, customise, skin, environment, - directories, path, language, db, install, setup, configure, - external_programs, dublincore, termsheet, search, features, - external_programs, license, exit -</pre> -<p> -<h2><a name='sect36' href='#toc36'>SiSU VERSION CONVERSION</a></h2> -<p> -<i>sisu</i> --to-current [filename/wildcard] converts from -0.37 markup to current markup (0.38) -<p> <i>sisu</i> --to-38 [filename/wildcard] converts - -<p>from 0.37 markup to 0.38 -<p> <i>sisu</i> --to-37 [filename/wildcard] converts from 0.38 - -<p>markup to 0.37 -<p> <i>sisu</i> --convert-36to37 [filename/wildcard] re-names file from - -<p>pre-0.36 convention to 0.37 -<p> <i>sisu</i> --convert-footnotes [filename/wildcard] converts - -<p>footnotes to preferred embedded footnote markup style -<p> <i>sisu</i> --convert-footnotes-force -[filename/wildcard] converts footnotes to preferred embedded footnote markup -style, even if there is a mismatch of footnote numbers. WARNING: there is -a problem with the source document and it is necessary to manually check -where each footnotes actually should be. -<p> convert from sst to simple xml -representations (sax, dom and node): -<p> <i>sisu</i> --to-sax [filename/wildcard] or -<i>sisu</i> --to-sxs [filename/wildcard] -<p> <i>sisu</i> --to-dom [filename/wildcard] or <i>sisu</i> ---to-sxd [filename/wildcard] -<p> <i>sisu</i> --to-node [filename/wildcard] or <i>sisu</i> --to-sxn -[filename/wildcard] -<p> convert to sst from simple xml representations (sax, -dom and node): -<p> <i>sisu</i> --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] - -<p> or the same: -<p> <i>sisu</i> --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] - -<p> <i>sisu</i> --from-kdi [kdissert filename] attempts to convert a kdissert file (.kdi) - -<p>to sisu markup -<p> <i>sisu</i> --identify [filename/wildcard] attempts to identify - -<p>the markup version of the file -<p> <i>sisu</i> --query=[version number] and <i>sisu</i> --query=history - -<p>provides a brief summary of changes to SiSU markup -<p> -<h2><a name='sect37' href='#toc37'>Sample Markup Documents</a></h2> -<p> - -<p> -Sample markup documents are provided in sisu-examples and are available -online. -<p> -<h2><a name='sect38' href='#toc38'>Home Page</a></h2> -<p> -<i><<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> -></i> -<p> -<h2><a name='sect39' href='#toc39'>Author</a></h2> -Ralph Amissah <i><ralph@amissah.com></i> -or <i><ralph.amissah@gmail.com></i> -<p> -<h2><a name='sect40' href='#toc40'>See Also</a></h2> -<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_termsheet:1'><b>sisu_termsheet(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_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'>modifiers</a></li> -<li><a name='toc6' href='#sect6'>databases</a></li> -<li><a name='toc7' href='#sect7'>Shortcuts, Shorthand for multiple flags</a></li> -<li><a name='toc8' href='#sect8'>Document Markup</a></li> -<li><a name='toc9' href='#sect9'>Basic Markup</a></li> -<li><a name='toc10' href='#sect10'>Footnotes/Endnotes</a></li> -<li><a name='toc11' href='#sect11'>Line Operations (marker placed at start of line)</a></li> -<li><a name='toc12' href='#sect12'>Links</a></li> -<li><a name='toc13' href='#sect13'>Adding a fixed names in html</a></li> -<li><a name='toc14' href='#sect14'>Escape object citation numbering</a></li> -<li><a name='toc15' href='#sect15'>Page breaks (LaTeX/pdf)</a></li> -<li><a name='toc16' href='#sect16'>Comment line</a></li> -<li><a name='toc17' href='#sect17'>Special characters</a></li> -<li><a name='toc18' href='#sect18'>Tables</a></li> -<li><a name='toc19' href='#sect19'>Other Grouped or Pre-formatted Text</a></li> -<li><a name='toc20' href='#sect20'>Composite Documents</a></li> -<li><a name='toc21' href='#sect21'>Document Headers</a></li> -<li><a name='toc22' href='#sect22'>Outline of header options</a></li> -<li><a name='toc23' href='#sect23'>Configuration Files</a></li> -<li><a name='toc24' href='#sect24'>More HELP on Markup and headers</a></li> -<li><a name='toc25' href='#sect25'>DIRECTORY STRUCTURE & Document Output</a></li> -<li><a name='toc26' href='#sect26'>Default Directories</a></li> -<li><a name='toc27' href='#sect27'>Markup Document Directories and File Mapping</a></li> -<li><a name='toc28' href='#sect28'>Multi-language Document File Naming and Directory Mapping</a></li> -<li><a name='toc29' href='#sect29'>Markup Document Directories and Database Mapping</a></li> -<li><a name='toc30' href='#sect30'>SKINS - document, directory and site skins</a></li> -<li><a name='toc31' href='#sect31'>Document Naming Convention</a></li> -<li><a name='toc32' href='#sect32'>Remote Operations</a></li> -<li><a name='toc33' href='#sect33'>Note</a></li> -<li><a name='toc34' href='#sect34'>Processing Examples</a></li> -<li><a name='toc35' href='#sect35'>Interactive Help Options</a></li> -<li><a name='toc36' href='#sect36'>SiSU VERSION CONVERSION</a></li> -<li><a name='toc37' href='#sect37'>Sample Markup Documents</a></li> -<li><a name='toc38' href='#sect38'>Home Page</a></li> -<li><a name='toc39' href='#sect39'>Author</a></li> -<li><a name='toc40' href='#sect40'>See Also</a></li> -</ul> </body> </html> diff --git a/data/doc/sisu/html/sisu_commands.1.html b/data/doc/sisu/html/sisu_commands.1.html new file mode 100644 index 00000000..ed2c45e2 --- /dev/null +++ b/data/doc/sisu/html/sisu_commands.1.html @@ -0,0 +1,554 @@ +<!-- manual page source format generated by PolyglotMan v3.2, --> +<!-- available at http://polyglotman.sourceforge.net/ --> + +<html> +<head> +<title>"sisu_commands"("1") manual page</title> +</head> +<body bgcolor='white'> +<a href='#toc'>Table of Contents</a><p> +SISU - COMMANDS [0.58], RALPH AMISSAH +<p> SISU COMMANDS +<p> 1. COMMANDS SUMMARY + +<p> 1.1 SYNOPSIS +<p> <b>SiSU</b> - Structured information, Serialized Units - a document + +<p>publishing system +<p> sisu [ -abcDdFHhIiMmNnopqRrSsTtUuVvwXxYyZz0-9 ] [ filename/ + +<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> 1.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> 1.3 DOCUMENT PROCESSING + +<p>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 endnotes]. (Options include: --endnotes for endnotes +--footnotes for footnotes at the end of each paragraph --unix for unix linefeed +(default) --msdos for msdos linefeed) +<p> </dd> + +<dt><b> -b [filename/wildcard]</b> </dt> +<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 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. +such as css and dtd files are updated +<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] +</dt> +<dd>[filename] 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.) ( 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> -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 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 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 + +<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 the default port is set to 8081 + and can be [tip: the so html output should be created using the -h option + rather than -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> +</dl> +2. 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 asterisk or dagger/plus sign +<p> </dd> + +<dt><b> --no-asterisk</b> +</dt> +<dd> strips output text of editor endnotes[^*2] denoted by asterisk sign +<p> </dd> + +<dt><b> --no-dagger</b> +</dt> +<dd> strips output text of editor endnotes[^+1] denoted by dagger/plus sign +<p> +</dd> +</dl> +3. 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 & indexes [ -d --dropall + sqlite equivalent] +<p> The v in e.g. -Dv is for verbose output. +<p> </dd> +</dl> +4. 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 give, i.e. on + ’sisu [filename]’] +<p> </dd> + +<dt><b> -2</b> </dt> +<dd> -mNHwpaoy give, i.e. on ’sisu [filename]’] +<p> </dd> + +<dt><b> -3</b> </dt> +<dd> -mNhwpAobxXyY + i.e. on ’sisu [filename]’] +<p> </dd> + +<dt><b> -4</b> </dt> +<dd> -mNhwpAobxXDyY --import ’sisu [filename]’] +<p> </dd> + +<dt><b> -5</b> </dt> +<dd> -mNhwpAobxXDyY + --update ’sisu [filename]’] +<p> add -v for verbose mode and -c for color, e.g. sisu +-2vc [filename or wildcard] +<p> consider -u for appended url info or -v for + +<p>verbose output +<p> </dd> +</dl> +4.0.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> DOCUMENT INFORMATION (METADATA) +<p> METADATA +<p> Document Manifest +@ <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_commands/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_commands/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> - Commands [0.58] +<p> DC Creator: <i>Ralph</i> Amissah +<p> DC Rights: +<i>Copyright</i> (C) Ralph Amissah 2007, part of SiSU documentation, License GPL + +<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>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_commands.sst</i> +<p> Filetype: + +<p><i>SiSU</i> text 0.58 +<p> Sourcefile Digest, MD5(sisu_commands.sst)= <i>8101d9e72f3de2510ef887202f8db3f9</i> + +<p> Skin_Digest: MD5(/home/ralph/grotto/theatre/dbld/sisu-dev/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)= + +<p><i>20fc43cf3eb6590bc3399a1aef65c5a9</i> +<p> <b>Generated</b> +<p> Document (metaverse) last +generated: <i>Sun</i> Sep 23 01:13:58 +0100 2007 +<p> Generated by: <i>SiSU</i> <i>0.58.3</i> of +2007w36/4 (2007-09-06) +<p> Ruby version: <i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36) + [i486-linux] +<p> +<dl> + +<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 +<p> +</dd> + +<dt>Other versions of this document: </dt> +<dd></dd> + +<dt>manifest: <<a href='http://www.jus.uio.no/sisu/sisu_commands/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_commands/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_commands/sisu_manifest.html</a> +</a> +> +</dt> +<dd></dd> + +<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_commands/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_commands/toc.html'>http://www.jus.uio.no/sisu/sisu_commands/toc.html</a> +</a> +> </dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_commands/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_commands/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_commands/portrait.pdf</a> +</a> +> +</dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_commands/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_commands/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_commands/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.58.3 of 2007w36/4 (2007-09-06) </dt> +<dd></dd> + +<dt>* Ruby version: ruby +1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt> +<dd></dd> + +<dt>* Last Generated on: Sun Sep 23 +01:14:05 +0100 2007 </dt> +<dd></dd> + +<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> + </dt> +<dd></dd> +</dl> +<p> +</body> +</html> diff --git a/data/doc/sisu/html/sisu_complete.7.html b/data/doc/sisu/html/sisu_complete.7.html index b4ab749e..0292e6c1 100644 --- a/data/doc/sisu/html/sisu_complete.7.html +++ b/data/doc/sisu/html/sisu_complete.7.html @@ -1,54 +1,137 @@ - <!-- manual page source format generated by PolyglotMan v3.2, --> +<!-- manual page source format generated by PolyglotMan v3.2, --> <!-- available at http://polyglotman.sourceforge.net/ --> <html> <head> -<title>sisu_complete(7) manual page</title> +<title>"sisu_complete"("1") manual page</title> </head> <body bgcolor='white'> <a href='#toc'>Table of Contents</a><p> +SISU - COMPLETE PACKAGE [0.58], RALPH AMISSAH +<p> 1. SISU_COMPLETE +<p> 1.1 NAME -<h2><a name='sect0' href='#toc0'>Name</a></h2> -<b>SiSU</b> - Structured information, Serialized Units - a document -publishing system, complete dependency package <p> +<p> <b>SiSU</b> - Structured information, Serialized Units - a document publishing +system, complete dependency package +<p> 1.2 SYNOPSIS +<p> <b>Debian</b> dummy package +installs the whole of <b>SiSU</b> , excluding sisu-examples. +<p> sisu-complete together -<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>with sisu-examples is the whole of <b>SiSU</b> +<p> 1.3 FURTHER INFORMATION +<p> For more +information on <b>SiSU</b> see: +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual'>http://www.jus.uio.no/sisu/sisu_manual</a> +> +<p> <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> +> + +<p> 1.4 AUTHOR +<p> Ralph Amissah ralph@amissah.com or ralph.amissah@gmail.com +<p> 1.5 + +<p>SEE +<p> <a href='http:~/bin/man2html?sisu:1'>sisu(1)</a> + +<p> 1.6 ALSO SEE +<p> <a href='http:~/bin/man2html?sisu_webrick:1'>sisu_webrick(1)</a> +, <a href='http:~/bin/man2html?sisu_pdf:7'>sisu_pdf(7)</a> + <a href='http:~/bin/man2html?sisu_sqlite:7'>sisu_sqlite(7)</a> + +<a href='http:~/bin/man2html?sisu_postgresql:7'>sisu_postgresql(7)</a> + <a href='http:~/bin/man2html?sisu_vim:7'>sisu_vim(7)</a> + <a href='http:~/bin/man2html?sisu_termsheet:1'>sisu_termsheet(1)</a> + +<p> DOCUMENT INFORMATION +(METADATA) +<p> METADATA +<p> Document Manifest @ <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_complete/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_complete/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> - Complete Package [0.58] +<p> DC Creator: <i>Ralph</i> Amissah +<p> +DC Rights: <i>Copyright</i> (C) Ralph Amissah 2007, part of SiSU documentation, + +<p>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_complete.sst</i> + +<p> Filetype: <i>SiSU</i> text 0.58 +<p> Sourcefile Digest, MD5(sisu_complete.sst)= <i>42003f9cf59fd7e4ddffae864e2c4179</i> + +<p> Skin_Digest: MD5(/home/ralph/grotto/theatre/dbld/sisu-dev/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)= + +<p><i>20fc43cf3eb6590bc3399a1aef65c5a9</i> +<p> <b>Generated</b> +<p> Document (metaverse) last +generated: <i>Sun</i> Sep 23 01:14:02 +0100 2007 +<p> Generated by: <i>SiSU</i> <i>0.58.3</i> of +2007w36/4 (2007-09-06) +<p> Ruby version: <i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36) + [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_complete/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_complete/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_complete/sisu_manifest.html</a> +</a> +> +</dt> +<dd></dd> + +<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_complete/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_complete/toc.html'>http://www.jus.uio.no/sisu/sisu_complete/toc.html</a> +</a> +> </dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_complete/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_complete/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_complete/portrait.pdf</a> +</a> +> +</dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_complete/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_complete/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_complete/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.58.3 of 2007w36/4 (2007-09-06) </dt> +<dd></dd> + +<dt>* Ruby version: ruby +1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt> +<dd></dd> + +<dt>* Last Generated on: Sun Sep 23 +01:14:07 +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> -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/html/sisu_configuration.1.html b/data/doc/sisu/html/sisu_configuration.1.html new file mode 100644 index 00000000..ad8f13fc --- /dev/null +++ b/data/doc/sisu/html/sisu_configuration.1.html @@ -0,0 +1,254 @@ +<!-- manual page source format generated by PolyglotMan v3.2, --> +<!-- available at http://polyglotman.sourceforge.net/ --> + +<html> +<head> +<title>"sisu_configuration"("1") manual page</title> +</head> +<body bgcolor='white'> +<a href='#toc'>Table of Contents</a><p> +SISU - CONFIGURATION [0.58], RALPH AMISSAH +<p> CONFIGURATION OF ENVIRONMENT + +<p> 1. CONFIGURATION +<p> 1.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> 1.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> CONFIGURATION OF DOCUMENTS +<p> 2. 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> 2.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> 2.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> 2.3 SITE SKIN +<p> A site skin, modifies the program default skin. +<p> 2.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> 3. 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> 3.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> 3.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> DOCUMENT INFORMATION (METADATA) +<p> METADATA +<p> Document Manifest @ <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/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> - Configuration [0.58] +<p> DC Creator: <i>Ralph</i> Amissah +<p> DC +Rights: <i>Ralph</i> Amissah +<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>2007-08-28</i> +<p> DC Date modified: + +<p><i>2007-08-30</i> +<p> DC Date: <i>2007-08-30</i> +<p> <b>Version Information</b> +<p> Sourcefile: <i>sisu_configuration._sst</i> + +<p> Filetype: <i>SiSU</i> text insert 0.58 +<p> Sourcefile Digest, MD5(sisu_configuration._sst)= + +<p><i>2a18ae8bbfec534c6e064d666ffbe20d</i> +<p> Skin_Digest: MD5(/home/ralph/grotto/theatre/dbld/sisu-dev/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)= + +<p><i>20fc43cf3eb6590bc3399a1aef65c5a9</i> +<p> <b>Generated</b> +<p> Document (metaverse) last +generated: <i>Sun</i> Sep 23 01:14:02 +0100 2007 +<p> Generated by: <i>SiSU</i> <i>0.58.3</i> of +2007w36/4 (2007-09-06) +<p> Ruby version: <i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36) + [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_configuration/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_configuration/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_configuration/sisu_manifest.html</a> +</a> +> +</dt> +<dd></dd> + +<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_configuration/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_configuration/toc.html'>http://www.jus.uio.no/sisu/sisu_configuration/toc.html</a> +</a> +> </dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_configuration/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_configuration/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_configuration/portrait.pdf</a> +</a> +> +</dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_configuration/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_configuration/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_configuration/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.58.3 of 2007w36/4 (2007-09-06) </dt> +<dd></dd> + +<dt>* Ruby version: ruby +1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt> +<dd></dd> + +<dt>* Last Generated on: Sun Sep 23 +01:14:07 +0100 2007 </dt> +<dd></dd> + +<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> + </dt> +<dd></dd> +</dl> +<p> +</body> +</html> diff --git a/data/doc/sisu/html/sisu_faq.8.html b/data/doc/sisu/html/sisu_faq.8.html new file mode 100644 index 00000000..d480b195 --- /dev/null +++ b/data/doc/sisu/html/sisu_faq.8.html @@ -0,0 +1,275 @@ +<!-- manual page source format generated by PolyglotMan v3.2, --> +<!-- available at http://polyglotman.sourceforge.net/ --> + +<html> +<head> +<title>"sisu_faq"("1") manual page</title> +</head> +<body bgcolor='white'> +<a href='#toc'>Table of Contents</a><p> +SISU - SISU INFORMATION STRUCTURING UNIVERSE / STRUCTURED INFORMATION, SERIALIZED +UNITS - FAQ - FREQUENTLY ASKED/ANSWERED QUESTIONS, RALPH AMISSAH +<p> 1. FAQ +- FREQUENTLY ASKED/ANSWERED QUESTIONS +<p> 1.1 WHY ARE URLS PRODUCED WITH THE +-V (AND -U) FLAG THAT POINT TO A WEB SERVER ON PORT 8081? +<p> Try the following +rune: +<p> * sisu -W +<p> This should start the ruby webserver. It should be done +after having produced some output as it scans the output directory for +what to serve. +<p> 1.2 I CANNOT FIND MY OUTPUT, WHERE IS IT? +<p> The following +should provide help on output paths: +<p> * sisu --help env +<p> * sisu -V [same + as the previous command] +<p> * sisu --help directory +<p> * sisu --help path +<p> * +sisu -U [filename] +<p> * man sisu +<p> 1.3 I DO NOT GET ANY PDF OUTPUT, WHY? +<p> +<b>SiSU</b> produces LaTeX and pdflatex is run against that to generate pdf files. + +<p> If you use <b>Debian</b> the following will install the required dependencies + +<p> * aptitude install sisu-pdf +<p> the following packages are required: tetex-bin, +tetex-extra, latex-ucs +<p> 1.4 WHERE IS THE LATEX (OR SOME OTHER INTERIM) OUTPUT? + +<p> Try adding -M (for maintenance) to your command flags, e.g.: +<p> * sisu -HpMv + [filename] +<p> this should result in the interim processing output being +retained, and information being provided on where to find it. +<p> * sisu --help + +<p>directory +<p> * sisu --help path +<p> should also provide some relevant information +as to where it is placed. +<p> 1.5 WHY ISN’T SISU MARKUP XML +<p> I worked with text +and (though I find XML immensely valuable) disliked noise +<p> <b>SiSU</b> currently +accurately, converts from three forms of XML to native <b>SiSU</b> markup for +processing. The three types correspond to SAX (structure described), DOM +(structure embedded, whole document must be read before structure is correctly +discernable) and node based (a tree) forms of XML document structure representation. +Problem is I use them very seldom and check that all is as it should be +with them seldom, so I would not be surprised if something breaks there, +but as far as I know they are working. I will check and add an XML markup +help page before the next release. There already is a bit of information + +<p>in the man page under the title <b>SiSU</b> VERSION CONVERSION +<p> sisu --to-sax + [filename/wildcard]<br> + +<p> sisu --to-dom [filename/wildcard]<br> + +<p> sisu --to-node [filename/wildcard]<br> + +<p> The XML should be well formed... must check, but lacks sensible headers. +Suggestions welcome as to what to make of them. [For the present time Structured +information, Serialized Units" I am satisfied that I can convert (both + ways) between 3 Structured information, Serialized Units" forms of XML + representation and <b> SiSU</b> markup]. +<p> sisu --from-xml2sst [filename/wildcard]<br> + +<p> 1.6 LATEX CLAIMS TO BE A DOCUMENT PREPARATION SYSTEM FOR HIGH-QUALITY TYPESETTING. +CAN THE SAME BE SAID ABOUT SISU? +<p> <b>SiSU</b> is not really about type-setting. + +<p> LaTeX is the ultimate computer instruction type-setting language for paper +based publication. +<p> LaTeX is able to control just about everything that +happens on page and pixel, position letters kerning, space variation between +characters, words, paragraphs etc. formula. +<p> <b>SiSU</b> is not really about type-setting +at all. It is about a lightweight markup instruction that provides enough +information for an abstraction of the documents structure and objects, +from which different forms of representation of the document can be generated. + +<p> <b>SiSU</b> with very little markup instruction is able to produce relatively +high quality pdf by virtue of being able to generate usable default LaTeX; +it produces populates an SQL database in a useful way with the document +in object sized chunks and its meta-data. But <b>SiSU</b> works on an abstraction +of the document’s structure and content and custom builds suitable uniform +output. The html for browser viewing and pdf for paper viewing/publishing +are rather different things with different needs for layout - as indeed +is what is needed to store information in a database in searchable objects. + +<p> The pdfs or html produced for example by open office based on open document +format and other office/word processor suits usually attempt to have similar +looking outputs - your document rendered in html looks much the same, or +in pdf... sisu is less this way, it seeks to have a starting point with as +little information about appearance as possible, and to come up with the +best possible appearance for each output that can be derived based on this +minimal information. +<p> Where there are large document sets, it provides +consistency in appearance in each output format for the documents. +<p> The +excuse for going this way is, it is a waste of time to think much about +appearance when working on substantive content, it is the substantive content +that is relevant, not the way it looks beyond the basic informational tags +- and yet you want to be able to take advantage of as many useful different +ways of representing documents as are available, and for various types +of output to to be/look as good as it can for each medium/format in which +it is presented, (with different mediums having different focuses) and +<b>SiSU</b> tries to achieve this from minimal markup. +<p> 1.7 HOW DO I CREATE GIN + +<p>OR GIST INDEX IN POSTGRESQL FOR USE IN SISU +<p> This at present needs to +be done alter the sample search form. The following is a helpful response +from one of the contributors of GiN to Postgresql Oleg Bartunov 2006-12-06: + +<p> I have tsearch2 slides which introduces tsearch2 <<a href='http://www.sai.msu.su/~megera/wiki/tsearch2slides'>http://www.sai.msu.su/~megera/wiki/tsearch2slides</a> +> + +<p> FTS in PostgreSQL is provided by tsearch2, which should works without +any indices (GiST or GIN) ! Indices provide performance, not functionality. + +<p> In your example I’d do ( simple way, just for demo): +<p> <b>0.</b> compile, install + +<p>tsearch2 and load tsearch2 into your database +<p> cd contrib/tsearch2; +make&&make&&install&&make installcheck; psql DB &lt;<br> + tsearch2.sql<br> + +<p> <b>1.</b> Add column fts, which holds tsvector +<p> alter table documents add +column fts tsvector;<br> + +<p> <b>2.</b> Fill fts column +<p> update document set fts = to_tsvector(clean);<br> + +<p> <b>3.</b> create index - just for performance ! +<p> create index fts_gin_idx +on document using gin(fts);<br> + +<p> <b>4.</b> Run vacuum +<p> vacuum analyze document;<br> + +<p> That’s all. +<p> Now you can search: +<p> select lid, metadata_tid, rank_cd(fts, +q,2)as rank from document, plainto_tsquery(’markup syntax’) q where q @@ +fts order by rank desc limit 10; +<p> 1.8 WHERE IS VERSION 1.0? +<p> <b>SiSU</b> works +pretty well as it is supposed to. Version 1.0 will have the current markup, +and directory structure. At this point it is largely a matter of choice +as to when the name change is made. +<p> The feature set for html,[^1] LaTeX/pdf +and opendocument is in place. XML, and plaintext are in order. +<p> html and + +<p>LaTeX/pdf may be regarded as reference copy outputs +<p> With regard to the +populating of sql databases (postgresql and sqlite), there is a bit to +be done. +<p> We are still almost there. +<p> DOCUMENT INFORMATION (METADATA) +<p> +METADATA +<p> Document Manifest @ <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_faq/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_faq/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 information Structuring Universe / Structured information, +Serialized Units - FAQ - Frequently Asked/Answered Questions +<p> DC Creator: + +<p><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: + +<p><i>2006-09-06</i> +<p> DC Date available: <i>2006-09-06</i> +<p> DC Date issued: <i>2006-09-06</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: + +<p><i>sisu_faq.sst</i> +<p> Filetype: <i>SiSU</i> text 0.57 +<p> Sourcefile Digest, MD5(sisu_faq.sst)= + +<p><i>4ba78b1270b9d994054c1ff06d58765d</i> +<p> Skin_Digest: MD5(/home/ralph/grotto/theatre/dbld/sisu-dev/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)= + +<p><i>20fc43cf3eb6590bc3399a1aef65c5a9</i> +<p> <b>Generated</b> +<p> Document (metaverse) last +generated: <i>Sun</i> Sep 23 01:14:01 +0100 2007 +<p> Generated by: <i>SiSU</i> <i>0.58.3</i> of +2007w36/4 (2007-09-06) +<p> Ruby version: <i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36) + [i486-linux] +<p> +<ol> +<b>.</b><li>html w3c compliance has been largely met. +<p> </dd> + +<dt>Other versions of +this document: </dt> +<dd></dd> + +<dt>manifest: <<a href='http://www.jus.uio.no/sisu/sisu_faq/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_faq/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_faq/sisu_manifest.html</a> +</a> +> +</dt> +<dd></dd> + +<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_faq/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_faq/toc.html'>http://www.jus.uio.no/sisu/sisu_faq/toc.html</a> +</a> +> </dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_faq/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_faq/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_faq/portrait.pdf</a> +</a> +> +</dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_faq/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_faq/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_faq/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.58.3 of 2007w36/4 (2007-09-06) </dt> +<dd></dd> + +<dt>* Ruby version: ruby +1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt> +<dd></dd> + +<dt>* Last Generated on: Sun Sep 23 +01:14:07 +0100 2007 </dt> +<dd></dd> + +<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> + </dt> +<dd></dd> +</dl> +<p> +</body> +</html> diff --git a/data/doc/sisu/html/sisu_help.1.html b/data/doc/sisu/html/sisu_help.1.html new file mode 100644 index 00000000..98167e65 --- /dev/null +++ b/data/doc/sisu/html/sisu_help.1.html @@ -0,0 +1,212 @@ +<!-- manual page source format generated by PolyglotMan v3.2, --> +<!-- available at http://polyglotman.sourceforge.net/ --> + +<html> +<head> +<title>"sisu_help"("1") manual page</title> +</head> +<body bgcolor='white'> +<a href='#toc'>Table of Contents</a><p> +SISU - SISU INFORMATION STRUCTURING UNIVERSE - MANUAL [0.58], RALPH AMISSAH + +<p> SISU HELP +<p> 1. HELP +<p> 1.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://www.jus.uio.no/sisu/sisu_manual/'>http://www.jus.uio.no/sisu/sisu_manual/</a> +><br> + +<p> and (from <b>SiSU</b> 0.59 onwards) installed locally at: +<p> /usr/share/doc/sisu/sisu_manual/<br> + +<p> or equivalent directory +<p> Within the <b>SiSU</b> tarball at: +<p> ./data/doc/sisu/sisu_manual/<br> + +<p> 1.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> The <b>SiSU</b> man pages can be viewed online at:[^1] +<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> +> + [^2] +<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> +> [^3] +<p> * sisu.8 <<a href='http://www.jus.uio.no/sisu/man/sisu.8.html'>http://www.jus.uio.no/sisu/man/sisu.8.html</a> +> + [^4] +<p> * sisu_examples.1 <<a href='http://www.jus.uio.no/sisu/man/sisu_examples.1.html'>http://www.jus.uio.no/sisu/man/sisu_examples.1.html</a> +> [^5] + +<p> * sisu_webrick.1 <<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> +> [^6] +<p> 1.3 + +<p>SISU BUILT-IN INTERACTIVE HELP +<p> This is particularly useful when current +installation information is obtained as the interactive help is able to +provide information on your sisu configuration and setup. +<p> sisu --help<br> + +<p> sisu --help [subject]<br> + +<p> sisu --help env [for feedback on the way your system is <br> + setup with regard to sisu]<br> + +<p> sisu -V [same as above command]<br> + +<p> sisu --help commands<br> + +<p> sisu --help markup<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> 1.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_manual/sisu_help_sources/index.html'>http://sisudoc.org/sisu_manual/sisu_help_sources/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html</a> +><br> + +<p> DOCUMENT INFORMATION (METADATA) +<p> METADATA +<p> Document Manifest @ <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_help/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_help/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 information Structuring Universe - Manual [0.58] +<p> + DC Creator: <i>Ralph</i> Amissah +<p> DC Rights: <i>Copyright</i> (C) Ralph Amissah 2007, +part of SiSU documentation, License GPL 3 +<p> DC Type: <i>information</i> +<p> DC Date +created: <i>2002-08-28</i> +<p> DC Date issued: <i>2002-08-28</i> +<p> DC Date available: <i>2002-08-28</i> + +<p> DC Date modified: <i>2007-08-30</i> +<p> DC Date: <i>2007-08-30</i> +<p> <b>Version Information</b> + +<p> Sourcefile: <i>sisu_help.sst</i> +<p> Filetype: <i>SiSU</i> text 0.58 +<p> Sourcefile Digest, +MD5(sisu_help.sst)= <i>387208846e53080b55b39cf92b70aaa9</i> +<p> Skin_Digest: MD5(/home/ralph/grotto/theatre/dbld/sisu-dev/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)= + +<p><i>20fc43cf3eb6590bc3399a1aef65c5a9</i> +<p> <b>Generated</b> +<p> Document (metaverse) last +generated: <i>Sun</i> Sep 23 01:13:57 +0100 2007 +<p> Generated by: <i>SiSU</i> <i>0.58.3</i> of +2007w36/4 (2007-09-06) +<p> Ruby version: <i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36) + [i486-linux] +<p> +<ol> +<b>.</b><li>generated from source using rman <<a href='http://polyglotman.sourceforge.net/rman.html'>http://polyglotman.sourceforge.net/rman.html</a> +><br> + With regard to<br> + <b>SiSU</b> man pages the formatting generated for markup syntax is not quite +right, for that you might prefer the links under: <<a href='http://www.jus.uio.no/sample'>http://www.jus.uio.no/sample</a> +><br> + </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><<a href='http://www.jus.uio.no/sisu/man/sisu.8.html'>http://www.jus.uio.no/sisu/man/sisu.8.html</a> +> +</li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man/sisu_examples.1.html'>http://www.jus.uio.no/sisu/man/sisu_examples.1.html</a> +> </li><b>.</b><li><<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> +> + +<p> </dd> + +<dt>Other versions of this document: </dt> +<dd></dd> + +<dt>manifest: <<a href='http://www.jus.uio.no/sisu/sisu_help/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_help/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_help/sisu_manifest.html</a> +</a> +> +</dt> +<dd></dd> + +<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_help/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_help/toc.html'>http://www.jus.uio.no/sisu/sisu_help/toc.html</a> +</a> +> </dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_help/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_help/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_help/portrait.pdf</a> +</a> +> +</dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_help/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_help/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_help/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.58.3 of 2007w36/4 (2007-09-06) </dt> +<dd></dd> + +<dt>* Ruby version: ruby +1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt> +<dd></dd> + +<dt>* Last Generated on: Sun Sep 23 +01:14:05 +0100 2007 </dt> +<dd></dd> + +<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> + </dt> +<dd></dd> +</dl> +<p> +</body> +</html> diff --git a/data/doc/sisu/html/sisu_help_sources.1.html b/data/doc/sisu/html/sisu_help_sources.1.html new file mode 100644 index 00000000..2eb83827 --- /dev/null +++ b/data/doc/sisu/html/sisu_help_sources.1.html @@ -0,0 +1,582 @@ +<!-- manual page source format generated by PolyglotMan v3.2, --> +<!-- available at http://polyglotman.sourceforge.net/ --> + +<html> +<head> +<title>"sisu_help_sources"("1") manual page</title> +</head> +<body bgcolor='white'> +<a href='#toc'>Table of Contents</a><p> +SISU - REFERENCES, RALPH AMISSAH +<p> SISU HELP SOURCES +<p> 1. 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> <file:///usr/share/doc/sisu/html/sisu_help.1.html><br> + +<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> <file:///usr/share/doc/sisu/sisu_manual/sisu_help/index.html><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_help/index.html'>http://sisudoc.org/sisu_manual/sisu_help/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_help/index.html'>http://www.jus.uio.no/sisu/sisu_manual/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> <file:///usr/share/doc/sisu/sisu_manual/sisu_help_sources/index.html><br> + +<p> <file:///usr/share/doc/sisu/html/sisu_help_sources/index.html><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_help_sources/index.html'>http://sisudoc.org/sisu_manual/sisu_help_sources/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html</a> +><br> + +<p> 1.1 MAN PAGES +<p> 1.1.1 MAN +<p> man sisu<br> + +<p> man sisu_commands<br> + +<p> man 7 sisu_complete<br> + +<p> man sisu_configuration<br> + +<p> man 8 sisu_faq<br> + +<p> man sisu_filetypes<br> + +<p> man sisu_help<br> + +<p> man sisu_help_sources<br> + +<p> man 8 sisu_howto<br> + +<p> man sisu_introduction<br> + +<p> man sisu_markup<br> + +<p> man sisu_output_overview<br> + +<p> man 7 sisu_pdf<br> + +<p> man 7 sisu_postgresql<br> + +<p> man 8 sisu_quickstart<br> + +<p> man 8 sisu_remote<br> + +<p> man 8 sisu_search<br> + +<p> man sisu_skin<br> + +<p> man 7 sisu_sqlite<br> + +<p> man 8 sisu_syntax_highlighting<br> + +<p> man 7 sisu_vim<br> + +<p> man sisu_webrick<br> + +<p> 1.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[^1] +<p> 1.2.1 LOCALLY INSTALLED +<p> <file:///usr/share/doc/sisu/sisu_manual/sisu_manual/index.html> + +<p> <file:///usr/share/doc/sisu/sisu_manual/sisu_help/index.html> +<p> <file:///usr/share/doc/sisu/sisu_manual/sisu_help_sources/index.html> + +<p> /usr/share/doc/sisu/sisu_manual/sisu/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_commands/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_complete/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_configuration/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_description/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_examples/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_faq/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_filetypes/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_help/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_help_sources/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_howto/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_introduction/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_manual/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_markup/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_output_overview/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_pdf/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_postgresql/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_quickstart/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_remote/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_search/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_skin/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_sqlite/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_syntax_highlighting/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_vim/index.html<br> + +<p> /usr/share/doc/sisu/sisu_manual/sisu_webrick/index.html<br> + +<p> 1.2.2 WWW.SISUDOC.ORG +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_manual/index.html'>http://sisudoc.org/sisu_manual/sisu_manual/index.html</a> +> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu/index.html'>http://sisudoc.org/sisu_manual/sisu/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_commands/index.html'>http://sisudoc.org/sisu_manual/sisu_commands/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_complete/index.html'>http://sisudoc.org/sisu_manual/sisu_complete/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_configuration/index.html'>http://sisudoc.org/sisu_manual/sisu_configuration/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_description/index.html'>http://sisudoc.org/sisu_manual/sisu_description/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_examples/index.html'>http://sisudoc.org/sisu_manual/sisu_examples/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_faq/index.html'>http://sisudoc.org/sisu_manual/sisu_faq/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_filetypes/index.html'>http://sisudoc.org/sisu_manual/sisu_filetypes/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_help/index.html'>http://sisudoc.org/sisu_manual/sisu_help/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_help_sources/index.html'>http://sisudoc.org/sisu_manual/sisu_help_sources/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_howto/index.html'>http://sisudoc.org/sisu_manual/sisu_howto/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_introduction/index.html'>http://sisudoc.org/sisu_manual/sisu_introduction/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_manual/index.html'>http://sisudoc.org/sisu_manual/sisu_manual/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_markup/index.html'>http://sisudoc.org/sisu_manual/sisu_markup/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_output_overview/index.html'>http://sisudoc.org/sisu_manual/sisu_output_overview/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_pdf/index.html'>http://sisudoc.org/sisu_manual/sisu_pdf/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_postgresql/index.html'>http://sisudoc.org/sisu_manual/sisu_postgresql/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_quickstart/index.html'>http://sisudoc.org/sisu_manual/sisu_quickstart/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_remote/index.html'>http://sisudoc.org/sisu_manual/sisu_remote/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_search/index.html'>http://sisudoc.org/sisu_manual/sisu_search/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_skin/index.html'>http://sisudoc.org/sisu_manual/sisu_skin/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_sqlite/index.html'>http://sisudoc.org/sisu_manual/sisu_sqlite/index.html</a> +><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://sisudoc.org/sisu_manual/sisu_vim/index.html'>http://sisudoc.org/sisu_manual/sisu_vim/index.html</a> +><br> + +<p> <<a href='http://sisudoc.org/sisu_manual/sisu_webrick/index.html'>http://sisudoc.org/sisu_manual/sisu_webrick/index.html</a> +><br> + +<p> 1.2.3 WWW.JUS.UIO.NO/SISU +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_manual/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_manual/index.html</a> +> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_commands/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_commands/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_complete/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_complete/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_description/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_description/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_examples/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_examples/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_faq/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_faq/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_filetypes/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_filetypes/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_help/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_help/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_howto/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_howto/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_introduction/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_introduction/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_manual/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_manual/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_markup/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_markup/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_output_overview/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_output_overview/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_pdf/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_pdf/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_postgresql/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_postgresql/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_remote/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_remote/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_search/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_search/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_skin/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_skin/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_sqlite/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_sqlite/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> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_vim/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_vim/index.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_webrick/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_webrick/index.html</a> +><br> + +<p> 1.2.4 MAN2HTML +<p> 1.2.5 LOCALLY INSTALLED +<p> <file:///usr/share/doc/sisu/html/sisu_manual.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_commands.1.html<br> + +<p> /usr/share/doc/sisu/html/sisu_complete.7.html<br> + +<p> /usr/share/doc/sisu/html/sisu_configuration.1.html<br> + +<p> /usr/share/doc/sisu/html/sisu_faq.8.html<br> + +<p> /usr/share/doc/sisu/html/sisu_help.1.html<br> + +<p> /usr/share/doc/sisu/html/sisu_help_sources.1.html<br> + +<p> /usr/share/doc/sisu/html/sisu_howto.8.html<br> + +<p> /usr/share/doc/sisu/html/sisu_markup.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_quickstart.8.html<br> + +<p> /usr/share/doc/sisu/html/sisu_remote.8.html<br> + +<p> /usr/share/doc/sisu/html/sisu_search.8.html<br> + +<p> /usr/share/doc/sisu/html/sisu_skin.1.html<br> + +<p> /usr/share/doc/sisu/html/sisu_sqlite.7.html<br> + +<p> /usr/share/doc/sisu/html/sisu_syntax_highlighting.8.html<br> + +<p> /usr/share/doc/sisu/html/sisu_vim.7.html<br> + +<p> /usr/share/doc/sisu/html/sisu_webrick.1.html<br> + +<p> 1.2.6 WWW.SISUDOC.ORG +<p> <<a href='http:///sisudoc.org/man/sisu_manual.1.html'>http:///sisudoc.org/man/sisu_manual.1.html</a> +> +<p> <<a href='http:///sisudoc.org/man/sisu_help.1.html'>http:///sisudoc.org/man/sisu_help.1.html</a> +> + +<p> <<a href='http:///sisudoc.org/man/sisu_help_sources.1.html'>http:///sisudoc.org/man/sisu_help_sources.1.html</a> +> +<p> <<a href='http://sisudoc.org/man/sisu.1.html'>http://sisudoc.org/man/sisu.1.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_commands.1.html'>http://sisudoc.org/man/sisu_commands.1.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_complete.7.html'>http://sisudoc.org/man/sisu_complete.7.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_configuration.1.html'>http://sisudoc.org/man/sisu_configuration.1.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_faq.8.html'>http://sisudoc.org/man/sisu_faq.8.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_help.1.html'>http://sisudoc.org/man/sisu_help.1.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_help_sources.1.html'>http://sisudoc.org/man/sisu_help_sources.1.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_howto.8.html'>http://sisudoc.org/man/sisu_howto.8.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_markup.1.html'>http://sisudoc.org/man/sisu_markup.1.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_pdf.7.html'>http://sisudoc.org/man/sisu_pdf.7.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_postgresql.7.html'>http://sisudoc.org/man/sisu_postgresql.7.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_quickstart.8.html'>http://sisudoc.org/man/sisu_quickstart.8.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_remote.8.html'>http://sisudoc.org/man/sisu_remote.8.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_search.8.html'>http://sisudoc.org/man/sisu_search.8.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_skin.1.html'>http://sisudoc.org/man/sisu_skin.1.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_sqlite.7.html'>http://sisudoc.org/man/sisu_sqlite.7.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_syntax_highlighting.8.html'>http://sisudoc.org/man/sisu_syntax_highlighting.8.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_vim.7.html'>http://sisudoc.org/man/sisu_vim.7.html</a> +><br> + +<p> <<a href='http://sisudoc.org/man/sisu_webrick.1.html'>http://sisudoc.org/man/sisu_webrick.1.html</a> +><br> + +<p> 1.2.7 WWW.JUS.UIO.NO/SISU +<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_manual.1.html'>http://www.jus.uio.no/sisu/man/sisu_manual.1.html</a> +> +<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> +> +<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_help_sources.1.html'>http://www.jus.uio.no/sisu/man/sisu_help_sources.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_commands.1.html'>http://www.jus.uio.no/sisu/man/sisu_commands.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_configuration.1.html'>http://www.jus.uio.no/sisu/man/sisu_configuration.1.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_faq.8.html'>http://www.jus.uio.no/sisu/man/sisu_faq.8.html</a> +><br> + +<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> <<a href='http://www.jus.uio.no/sisu/man/sisu_help_sources.1.html'>http://www.jus.uio.no/sisu/man/sisu_help_sources.1.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_howto.8.html'>http://www.jus.uio.no/sisu/man/sisu_howto.8.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_markup.1.html'>http://www.jus.uio.no/sisu/man/sisu_markup.1.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_quickstart.8.html'>http://www.jus.uio.no/sisu/man/sisu_quickstart.8.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_remote.8.html'>http://www.jus.uio.no/sisu/man/sisu_remote.8.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_search.8.html'>http://www.jus.uio.no/sisu/man/sisu_search.8.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_skin.1.html'>http://www.jus.uio.no/sisu/man/sisu_skin.1.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_syntax_highlighting.8.html'>http://www.jus.uio.no/sisu/man/sisu_syntax_highlighting.8.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_vim.7.html'>http://www.jus.uio.no/sisu/man/sisu_vim.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://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/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> - References +<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-11-12</i> +<p> DC Date issued: <i>2002-11-12</i> + +<p> DC Date available: <i>2002-11-12</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_help_sources.sst</i> +<p> Filetype: <i>SiSU</i> + +<p>text insert 0.58 +<p> Sourcefile Digest, MD5(sisu_help_sources.sst)= <i>ff6812b3008391d7a20d777bbbeb3ec1</i> + +<p> Skin_Digest: MD5(/home/ralph/grotto/theatre/dbld/sisu-dev/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)= + +<p><i>20fc43cf3eb6590bc3399a1aef65c5a9</i> +<p> <b>Generated</b> +<p> Document (metaverse) last +generated: <i>Sun</i> Sep 23 01:13:58 +0100 2007 +<p> Generated by: <i>SiSU</i> <i>0.58.3</i> of +2007w36/4 (2007-09-06) +<p> Ruby version: <i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36) + [i486-linux] +<p> +<ol> +<b>.</b><li>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_help_sources/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_help_sources/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_help_sources/sisu_manifest.html</a> +</a> +> +</dt> +<dd></dd> + +<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_help_sources/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_help_sources/toc.html'>http://www.jus.uio.no/sisu/sisu_help_sources/toc.html</a> +</a> +> </dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_help_sources/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_help_sources/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_help_sources/portrait.pdf</a> +</a> +> +</dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_help_sources/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_help_sources/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_help_sources/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.58.3 of 2007w36/4 (2007-09-06) </dt> +<dd></dd> + +<dt>* Ruby version: ruby +1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt> +<dd></dd> + +<dt>* Last Generated on: Sun Sep 23 +01:14:05 +0100 2007 </dt> +<dd></dd> + +<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> + </dt> +<dd></dd> +</dl> +<p> +</body> +</html> diff --git a/data/doc/sisu/html/sisu_howto.8.html b/data/doc/sisu/html/sisu_howto.8.html new file mode 100644 index 00000000..16711200 --- /dev/null +++ b/data/doc/sisu/html/sisu_howto.8.html @@ -0,0 +1,1451 @@ +<!-- manual page source format generated by PolyglotMan v3.2, --> +<!-- available at http://polyglotman.sourceforge.net/ --> + +<html> +<head> +<title>"sisu_howto"("1") manual page</title> +</head> +<body bgcolor='white'> +<a href='#toc'>Table of Contents</a><p> +SISU - SISU INFORMATION STRUCTURING UNIVERSE / STRUCTURED INFORMATION, SERIALIZED +UNITS - TECHNICAL, HOWTO, RALPH AMISSAH +<p> SISU SOME TECHNICAL INFORMATION + +<p> HOWTO +<p> 1. GETTING HELP +<p> An online manual of sorts should be available +at: +<p> <<a href='http://www.jus.uio.no/sisu_manual/'>http://www.jus.uio.no/sisu_manual/</a> +> +<p> The manual pages provided with +<b>SiSU</b> are also available online, and there is an interactive help, which +is being superseded by the man page, and possibly some document which contains +this component. +<p> 1.1 SISU +<p> If <b>SiSU</b> is installed on your system usual man +commands should be available, try: +<p> man sisu +<p> The <b>SiSU</b> man pages can +be viewed online at:[^1] +<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> +> [^2] +<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> +> [^3] +<p> * sisu.8 <<a href='http://www.jus.uio.no/sisu/man/sisu.8.html'>http://www.jus.uio.no/sisu/man/sisu.8.html</a> +> + [^4] +<p> * sisu_examples.1 <<a href='http://www.jus.uio.no/sisu/man/sisu_examples.1.html'>http://www.jus.uio.no/sisu/man/sisu_examples.1.html</a> +> [^5] + +<p> * sisu_webrick.1 <<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> +> [^6] +<p> 1.2 + +<p>SISU BUILT-IN HELP +<p> sisu --help<br> + +<p> sisu --help [subject]<br> + +<p> sisu --help env [for feedback on the way your system is Structured +information, Serialized Units"<br> + setup with regard to sisu]<br> + +<p> sisu -V [same as above command]<br> + +<p> sisu --help commands<br> + +<p> sisu --help markup<br> + +<p> 1.3 COMMAND LINE WITH FLAGS - BATCH PROCESSING +<p> Running sisu (alone without +any flags, filenames or wildcards) brings up the interactive help, as does +any sisu command that is not recognised. +<p> In the data directory run sisu +-mh filename or wildcard eg. cisg.sst documents. +<p> 2. SETUP, INITIALISATION + +<p> 2.1 INITIALISE OUTPUT DIRECTORY +<p> Images, css files for a document directory +are copied to their respective locations in the output directory. +<p> while +within your document markup/preparation directory, issue the following + +<p>command +<p> sisu -CC<br> + +<p> 2.1.1 USE OF SEARCH FUNCTIONALITY, AN EXAMPLE USING SQLITE +<p> <b>SiSU</b> can populate +PostgreSQL and Sqlite databases and provides a sample search form for querying +these databases. +<p> This note provides an example to get you started and + +<p>will use sqlite +<p> It is necessary to: +<p> (1) make sure the required dependencies + +<p>have been installed +<p> (2) have a directory with sisu markup samples that + +<p>is writable +<p> (3) use sisu to create a database +<p> (4) use sisu tp populate + +<p>a database +<p> (5) use sisu to start the webrick (httpd) server +<p> (6) use + +<p>sisu to create a search form +<p> (7) copy the search form to the cgi directory + +<p> (8) open up the form in your browser +<p> (9) query the database using the + +<p>search form +<p> <b>(1) make sure the required dependencies have been installed</b> + +<p> if you use <b>Debian</b> , the following command will install the required dependencies + +<p> aptitude install sisu-sqlite +<p> <b>(2) have a directory with sisu markup samples + +<p>that is writable</b> +<p> ideally copy the sisu-examples directory to your home +directory (because the directory in which you run this example should be +writable) +<p> cp -rv /usr/share/sisu-examples/sample/document_samples_sisu_markup +~/. +<p> <b>(3) use sisu to create an sqlite database</b> +<p> within the sisu-examples + +<p>directory +<p> sisu -dv createall +<p> <b>(4) use sisu tp populate a database with + +<p>some text</b> +<p> within the sisu-examples directory +<p> sisu -div free_*.sst +<p> or + +<p> sisu -dv import free_*.sst debian_constitution_v1.2.sst debian_social_contract_v1.1.sst + +<p>gpl2.fsf.sst +<p> <b>(5) use sisu to start the webrick (httpd) server (if it has +not already</b> been started): +<p> sisu -W +<p> <b>(6) use sisu to create a search form +(for use with the webrick server, and</b> your sample documents) +<p> within the + +<p>sisu-examples directory +<p> sisu -F webrick +<p> #here i run into a problem, you +are working from a read only #directory..., not my usual mode of operation, + +<p>to complete the example #the following is necessary sudo touch sisu_sqlite.cgi + +<p>sisu_pgsql.cgi sudo -P chown $USER sisu_sqlite.cgi sisu_pgsql.cgi +<p> #now this +should be possible: sisu -F webrick +<p> <b>(7) copy the search form to the cgi + +<p>directory</b> +<p> the string should be provided as output from the previous command + +<p> sudo cp -vi /usr/share/sisu-examples/sample/document_samples_sisu_markup/sisu_sqlite.cgi + +<p>/usr/lib/cgi-bin +<p> sudo chmod -v 755 /usr/lib/cgi-bin/sisu_sqlite.cgi +<p> <b>(8) + +<p>open up the form in your browser and query it</b> +<p> url: +<p> <<a href='http://localhost:8081/cgi-bin/sisu_sqlite.cgi'>http://localhost:8081/cgi-bin/sisu_sqlite.cgi</a> +> + +<p> or as instructed by command sisu -F webrick +<p> <b>(9) query the database using + +<p>the search form</b> +<p> if there are other options in the dropdown menu select + +<p> document_samples_sisu_markup +<p> and search for some text, e.g.: +<p> aim OR + +<p>project +<p> * selecting the <b>index</b> radio button gives an index of results + +<p>using the object numbers +<p> * selecting the <b>text</b> radio button gives the + +<p>content of the matched paragraphs with the match highlighted +<p> <b>(10) to + +<p>start again with a new database</b> +<p> to start from scratch you can drop the + +<p>database with the command +<p> sisu -dv dropall +<p> and go to step 3 +<p> to get + +<p>to step 3 in one step with a single command +<p> sisu -dv recreate +<p> continue + +<p>subsequent steps +<p> 2.2 MISC +<p> 2.2.1 URL FOR OUTPUT FILES -U -U +<p> sisu -uv[and + other flags] [filename/wildcard]<br> + +<p> sisu -Uv [filename/wildcard]<br> + +<p> 2.2.2 TOGGLE SCREEN COLOR +<p> sisu -cv[and processing flags] [filename/wildcard]<br> + +<p> 2.2.3 VERBOSE MODE +<p> sisu -v[and processing flags] [filename/wildcard]<br> + +<p> sisu -V[and processing flags] [filename/wildcard]<br> + +<p> 2.2.4 QUIET MODE +<p> sisu -q[and processing flags] [filename/wildcard]<br> + +<p> 2.2.5 MAINTENANCE MODE INTERMEDIATE FILES KEPT -M +<p> sisu -Mv[and other + flags] [filename/wildcard]<br> + +<p> 2.2.6 START THE WEBRICK SERVER +<p> sisu -W<br> + +<p> 2.3 REMOTE PLACEMENT OF OUTPUT +<p> configuration is necessary +<p> scp +<p> +sisu -vr[and processing flags] [filename/wildcard]<br> + +<p> rsync +<p> sisu -vR[and processing flags] [filename/wildcard]<br> + +<p> 3. CONFIGURATION FILES +<p> Sample provided, on untarring the source tarball: + +<p> conf/sisu/sisurc.yaml<br> + +<p> and on installation under: +<p> /etc/sisu/sisurc.yaml<br> + +<p> The following paths are searched: +<p> ./_sisu/sisurc.yaml<br> + +<p> ~/.sisu/sisurc.yaml<br> + +<p> ./etc/sisu/sisurc.yaml<br> + +<p> 4. MARKUP +<p> See sample markup provided on +<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_markup'>http://www.jus.uio.no/sisu_markup</a> +> +<p> <<a href='http://www.jus.uio.no/sisu/SiSU'>http://www.jus.uio.no/sisu/SiSU</a> +> +<p> in particular +for each of the document output samples provided, the source document is + +<p>provided as well +<p> <<a href='http://www.jus.uio.no/sisu/SiSU/2#books'>http://www.jus.uio.no/sisu/SiSU/2#books</a> +> +<p> on untarring +the source tarball: +<p> data/sisu-examples/sample/document_samples_sisu_markup/<br> + +<p> or the same once source is installed (or sisu-examples) under: +<p> /usr/share/sisu-examples/sample/document_samples_sisu_markup/<br> + +<p> Some notes are contained within the man page, <b>man sisu</b> and within sisu + +<p>help via the commands <b>sisu help markup</b> and <b>sisu help headers</b> +<p> <b>SiSU</b> is +for literary and legal text, also for some social science material. In particular +it does not do formula, and is not particularly suited to technical documentation. +Despite the latter caveat, some notes will be provided here and added to +over time: +<p> 4.1 HEADERS +<p> Headers @headername: provide information related +to the document, this may relate to +<p> 1. how it is to be processed, such +as whether headings are to be numbered, what skin is to be used and markup +instructions, such as the document structure, or words to be made bold + +<p>within the document +<p> 2. semantic information about the document including + +<p>the dublin core +<p> 4.2 FONT FACE +<p> Defaults are set. You may change the face +to: bold, italics, underscore, strikethrough, ... +<p> 4.2.1 BOLD +<p> @bold: [list + of words that should be made bold within or document] +<p> <b>bold line</b> +<p> !_ + +<p>bold line +<p> <b>bold word or sentence</b> +<p> !{ bold word or sentence }! +<p> *{ bold +word or sentence }* +<p> <b>boldword</b> or <b>boldword</b> +<p> *boldword* or !boldword! +<p> + +<p>4.2.2 ITALICS +<p> @italics: [list of words that should be italicised within + +<p> <i>italicise</i> word or sentence +<p> /{ italicise word or sentence }/ +<p> <i>italicisedword</i> + +<p> /italicisedword/ +<p> 4.2.3 UNDERSCORE +<p> <i>underscore</i> word or sentence +<p> _{ underscore +word or sentence }_ +<p> <i>underscoreword</i> +<p> 4.2.4 STRIKETHROUGH +<p> <del> strikethrough +word or sentence </del> +<p> -{ strikethrough word or sentence }- +<p> <del>strikeword</del> + +<p> -strikeword- +<p> 4.3 ENDNOTES +<p> There are two forms of markup for endnotes, + +<p>they cannot be mixed within the same document +<p> here[^7] +<p> 1. preferred endnote + +<p>markup +<p> here~{ this is an endnote }~ +<p> 2. alternative markup equivalent, + +<p>kept because it is possible to search and replace to get markup in existing + +<p>texts such as Project Gutenberg +<p> here~^ +<p> ^~ this is an endote +<p> 4.4 LINKS + +<p> SiSU <<a href='http://sisudoc.org'>http://sisudoc.org</a> +> +<p> { <b>SiSU</b> }<a href='http://sisudoc.org'>http://sisudoc.org</a> + +<p> sisu.png 120x39 <<a href='http://sisudoc.org'>http://sisudoc.org</a> +> + +<p> {sisu.png }<a href='http://sisudoc.org'>http://sisudoc.org</a> + +<p> [ tux.png ] +<p> { tux.png 64x80 }image +<p> SiSU +<<a href='http://sisudoc.org'>http://sisudoc.org</a> +> [^8] +<p> { <b>SiSU</b> }<a href='http://sisudoc.org'>http://sisudoc.org</a> + +<p> is equivalent to: +<p> + { <b>SiSU</b> }<a href='http://sisudoc.org'>http://sisudoc.org</a> + ~{ <<a href='http://sisudoc.org'>http://sisudoc.org</a> +> }~ +<p> the same can be done +with an image: +<p> sisu.png 120x39 +<p> { sisu.png <b>SiSU</b> }<a href='http://sisudoc.org'>http://sisudoc.org</a> +<br> + +<p> 4.5 NUMBER TITLES +<p> Set with the header @markup: +<p> 4.6 LINE OPERATIONS +<p> + Line Operations (marker placed at start of line) +<p> !_ bold line +<p> <b>bold + +<p>line</b> +<p> _1 indent paragraph one level +<p> indent paragraph one level<br> + +<p> _2 indent paragraph two steps +<p> indent paragraph two steps<br> + +<p> _* bullet paragraph +<p> * bullet paragraph +<p> # number paragraph (see headers +for numbering document headings) +<p> 1. number paragraph (see headers for +numbering document headings) +<p> _# number paragraph level 2 (see headers +for numbering document headings) +<p> a. number paragraph level 2 (see headers +for numbering document headings)<br> + +<p> 4.7 TABLES +<p> Table markup sample +<p> +<p> table{~h c3; 26; 32; 32; <p> + +<p> +<p> This is +a table, column1 <p> +this would become row one of column two <p> +column three of +row one is here <p> + +<p> +<p> column one row 2 <p> +column two of row two <p> +column three of +row two, and so on <p> + +<p> +<p> column one row three <p> +and so on <p> +here <p> + +<p> +<p> }table <p> + +<p> Alternative + +<p>form of table markup +<p> +<p> <br> +<pre> {t~h} + |Mon|Tue|Wed|Thu|Fri|Sat|Sun + 0 | * | * | * | * | * | * | * + 1 | * | * | * | * | | | + 2 | - | * | * | * | * | * | + 3 | - | * | * | * | * | * | * + 4 | - | | | * | * | * | + 5 | * | * | * | * | * | * | * +</pre> +<p> 4.8 GROUPED TEXT +<p> +<p> <br> +<pre> 5.times { puts ’Ruby’ } +</pre> +<p> code{ +<p> +<p> <br> +<pre> 5.times { puts ’Ruby’ } +</pre> +<p> }code +<p> +<p> A Limerick <p> + +<p> +<p> There was a young lady from Clyde, <p> +who ate a green +apple and died, <p> +but the apple fermented inside the lamented, <p> +and made cider +inside her inside. <p> + +<p> +<p> poem{ <p> + +<p> +<p> There was a young lady from Clyde, <p> +who ate +a green apple and died, <p> +but the apple fermented inside the lamented, <p> +and +made cider inside her inside. <p> + +<p> +<p> }poem <p> + +<p> 4.9 COMPOSITE DOCUMENT +<p> To import +another document, the master document or importing document should be named +filename.r3 (r for require) +<p> &lt;&lt; { filename.sst } +<p> &lt;&lt; { filename.ssi +} +<p> 5. CHANGE APPEARANCE +<p> 5.1 SKINS +<p> Skins appearance, including such things +as the url for the home page on which the material will be published, information +on the credit band, and for html documents colours and icons used in navigation +bars. Skins are ruby files which permit changing of the default values set +within the program for <b>SiSU</b> output. +<p> There are a few examples provided, +on untarring the source tarball: +<p> conf/sisu/skin/doc/<br> + +<p> data/sisu-examples/sample/document_samples_sisu_markup/_sisu/skin/doc<br> + +<p> and on installation under: +<p> /etc/sisu/skin/doc/<br> + +<p> /usr/share/sisu-examples/sample/document_samples_sisu_markup/_sisu/skin/doc<br> + +<p> The following paths are searched: +<p> ./_sisu/skin<br> + +<p> ~/.sisu/skin<br> + +<p> /etc/sisu/skin<br> + +<p> Skins under the searched paths in a per document directory, a per directory +directory, or a site directory, named: +<p> doc [may be specified individually + in each document] +<p> dir [used if identifier part of name matches markup + directory name] +<p> site +<p> It is usual to place all skins in the document +directory, with symbolic links as required from dir or site directories. + +<p> 5.2 CSS +<p> The appearance of html and XML related output can be changed +for an ouput collection directory by prepareing and placing a new css file +in one of the sisu css directories searched in the sisu configuration path. +These are located at: +<p> _./_sisu/css +<p> ~/.sisu/css +<p> and +<p> /etc/sisu/css + +<p> The contents of the first directory found in the search path are copied +to the corresponding sisu output directory with the commnd: +<p> sisu -CC +<p> + The <b>SiSU</b> standard css files for <b>SiSU</b> output are: +<p> dom.css html.css html_tables.css + +<p>index.css sax.css xhtml.css +<p> A document may specify its own/bespoke css file +using the css header. +<p> @css: +<p> [expand] +<p> EXTRACTS FROM THE README +<p> 6. README + +<p> <b>SiSU</b> 0.55 2007w27/6 2007-07-07 +<p> Homepage: <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> +> +<p> <b>Description</b> + +<p> <b>SiSU</b> is lightweight markup based document creation and publishing framework +that is controlled from the command line. Prepare documents for <b>SiSU</b> using +your text editor of choice, then use <b>SiSU</b> to generate various output document +formats. +<p> With minimal preparation of a plain-text (UTF-8) file using its +native markup-syntax, <b>SiSU</b> produces: plain-text, HTML, XHTML, XML, ODF:ODT +(Opendocument), LaTeX, PDF, and populates an SQL database (PostgreSQL or +SQLite) in paragraph sized chunks so that document searches are done at + +<p>this +<p> Outputs share a common citation numbering system, and any semantic +meta-data provided about the document. +<p> <b>SiSU</b> also provides concordance files, +document content certificates and manifests of generated output. +<p> <b>SiSU</b> +takes advantage of well established open standard ways of representing +text, and provides a bridge to take advantage of the strengths of each, +while remaining simple. <b>SiSU</b> implements across document formats a from a + humanities, law, and possibly social sciences rather than technical or + scientific writing] ... focus is primarily on content and data integrity rather +than appearance, (though outputs in the various formats are respectable). + +<p> A vim syntax highlighting file and an ftplugin with folds for sisu markup +is provided. Vim 7 includes syntax highlighting for <b>SiSU</b> +<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 <b>SiSU</b> +<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> +> + +<p> <b>SiSU</b> - simple information structuring universe, is a publishing tool, +document generation and management, (and search enabling) tool primarily +for literary, academic and legal published works. +<p> <b>SiSU</b> can be used for +Internet, Intranet, local filesystem or cd publishing. +<p> <b>SiSU</b> can be used +directly off the filesystem, or from a database. +<p> <b>SiSU</b> ’s scalability, is +be dependent on your hardware, and filesystem (in my case Reiserfs), and/or +database Postgresql. +<p> Amongst it’s characteristics are: +<p> * simple mnemonoic +markup style, +<p> * the ability to produce multiple output formats, including +html, structured XML, LaTeX, pdf (via LaTeX), stream to a relational database +whilst retaining document structure - Postgresql and Sqlite, +<p> * that all +share a common citation system (a simple idea from which much good), possibly +most exciting, the following: if fed into a relational database (as it +can be automatically), the document set is searchable, with results displayed +at a paragraph level, or the possibility of an indexed display of documents +in which the match is found together with a hyperlinked listing for each +of each paragraph in which the match is found. In any event citations using +this system (with or without the relational database) are relevant for +all output formats. +<p> * it is command line driven, and can be set up on + +<p>a remote server +<p> * Documents are marked up in <b>SiSU</b> syntax in your favourite +editor. <b>SiSU</b> syntax may be regarded as a type of smart ascii - which in its +basic form is simpler than the most elementary html. There is currently +a syntax highlighter, and folding for Vim. Syntax highlighters for other +editors are welcome. +<p> Input files should be UTF-8 +<p> Once set up it is simple +to use. +<p> 6.1 ONLINE INFORMATION, PLACES TO LOOK +<p> <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> +> + +<p> Download Sources: +<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> <<a href='http://www.jus.uio.no/sisu/SiSU/download.html#debian'>http://www.jus.uio.no/sisu/SiSU/download.html#debian</a> +><br> + +<p> 6.2 INSTALLATION +<p> NB. Platform is Unix / Linux. +<p> 6.2.1 DEBIAN +<p> If you use +<b>Debian</b> use the <b>Debian</b> packages, check the information at: +<p> <<a href='http://www.jus.uio.no/sisu/SiSU/download.html#debian'>http://www.jus.uio.no/sisu/SiSU/download.html#debian</a> +><br> + +<p> (A) <b>SiSU</b> is available directly off the <b>Debian</b> archives for Sid and testing. +It should necessary only to run as root: +<p> aptitude update<br> + +<p> aptitude install sisu-complete<br> + +<p> (B) 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> deb <<a href='http://www.jus.uio.no/sisu/archive'>http://www.jus.uio.no/sisu/archive</a> +> unstable main non-free<br> + +<p> deb-src <<a href='http://www.jus.uio.no/sisu/archive'>http://www.jus.uio.no/sisu/archive</a> +> unstable main non-free<br> + +<p> [the non-free line is for document markup samples, for which the substantive + text is provided under the author or which original publisher’s license + and which in most cases will +<p> Then as root run: +<p> aptitude update<br> + +<p> aptitude install sisu-complete<br> + +<p> 6.2.2 RPM +<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> 6.2.3 SOURCE PACKAGE .TGZ +<p> Otherwise 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> alternative modes of installation from source are provided, setup.rb +(by Minero Aoki), rake (by Jim Weirich) built install file, rant (by Stefan +Lang) built install file, +<p> <b>Ruby</b> is the essential dependency for the basic + +<p>operation of <b>SiSU</b> +<p> 1. Download the latest source (information available) +from: +<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> 2. Unpack the source +<p> Note however, that additional external package +dependencies, such as texlive or postgresql should you desire to use it +are not taken care of for you. +<p> 6.2.4 TO USE SETUP.RB +<p> this is a three step +process, in the root directory of the unpacked <b>SiSU</b> as root type: +<p> ruby +setup.rb config<br> + +<p> ruby setup.rb setup<br> + +<p> as root: +<p> ruby setup.rb install<br> + +<p> further information: +<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> 6.2.5 TO USE INSTALL (PRAPARED WITH +<p> Rake must be installed on your system: + +<p> <<a href='http://rake.rubyforge.org/'>http://rake.rubyforge.org/</a> +><br> + +<p> <<a href='http://rubyforge.org/frs/?group_id=50'>http://rubyforge.org/frs/?group_id=50</a> +><br> + +<p> in the root directory of the unpacked <b>SiSU</b> as root type: +<p> rake<br> + +<p> or +<p> rake base<br> + +<p> This makes use of Rake (by Jim Weirich) and the provided Rakefile +<p> +For a list of alternative actions you may type: +<p> rake help<br> + +<p> rake -T<br> + +<p> 6.2.6 TO USE INSTALL (PRAPARED WITH +<p> (you may use the instructions above +for rake substituting rant if rant is installed on your system, or you +may use an independent installer created using rant as follows:) +<p> in the +root directory of the unpacked <b>SiSU</b> as root type: +<p> ruby ./sisu-install<br> + +<p> or +<p> ruby ./sisu-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 +information: +<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 ./sisu-install +help<br> + +<p> ruby ./sisu-install -T<br> + +<p> 6.3 DEPENDENCIES +<p> Once installed see ’man 8 sisu’ for some information +on additional programs that sisu makes use of, and that you may need or +wish to install. (this will depend on such factors as whether you want to +generate pdf, whether you will be using <b>SiSU</b> with or without a database, +...) ’man sisu_markup-samples’ may also be of interest if the sisu-markup-samples +package has also been installed. +<p> The information in man 8 may not be most +up to date, and it is possible that more useful information can be gleaned +from the following notes taken from the <b>Debian</b> control file (end edited), +gives an idea of additional packages that <b>SiSU</b> can make use of if available, +(the use/requirement of some of which are interdependent for specific actions +by <b>SiSU</b> ). +<p> The following is from the debian/control file of sisu-0.58.2, +which amongst other things provides the dependencies of sisu within <b>Debian</b> + +<p> +<p> <br> +<pre> Package: sisu + Architecture: all + Depends: ruby (>= 1.8.2), libwebrick-ruby, unzip, zip + Conflicts: vim-sisu, sisu-vim, sisu-remote + Replaces: vim-sisu, sisu-vim + Recommends: sisu-pdf, sisu-sqlite, sisu-postgresql, librmagick-ruby, trang, + tidy, librexml-ruby, openssl, rsync, openssh-client | lsh-client, keychain, + hyperestraier, kdissert, vim-addon-manager + Suggests: rcs | cvs, lv, texinfo, pinfo + Package: sisu-complete + Depends: ruby (>= 1.8.4), sisu, sisu-pdf, sisu-postgresql, sisu-sqlite + Recommends: hyperestraier + Package: sisu-pdf + Architecture: all + Depends: sisu, texlive-latex-base, texlive-fonts-recommended, + texlive-latex-recommended, texlive-latex-extra + Suggests: evince, xpdf + Package: sisu-postgresql + Depends: sisu, postgresql-8.1, libdbi-ruby, libdbm-ruby, libdbd-pg-ruby + Suggests: pgaccess, libdbd-pgsql, postgresql-contrib-8.1 + Package: sisu-sqlite + Depends: sisu, sqlite, libdbi-ruby, libdbm-ruby, libdbd-sqlite-ruby + Suggests: libdbd-sqlite + Package: sisu-markup-samples + Depends: sisu +</pre> +<p> +<p> <br> +<pre> Source: sisu + Section: text + Priority: optional + Maintainer: Ralph Amissah <ralph@amissah.com> + Build-Depends: debhelper (>= 5) + Standards-Version: 3.7.2 + Package: sisu + Architecture: all + Depends: ruby (>= 1.8.2), libwebrick-ruby, unzip, zip + Conflicts: vim-sisu, sisu-vim, sisu-remote + Replaces: vim-sisu, sisu-vim + Recommends: sisu-pdf, sisu-sqlite, sisu-postgresql, hyperestraier, keychain, +librmagick-ruby, librexml-ruby, openssl, openssh-client | lsh-client, rsync, +tidy, vim-addon-manager + Suggests: kdissert, lv, rcs | cvs, pinfo, texinfo, trang + Description: documents - structuring, publishing in multiple formats and +search + SiSU is a lightweight markup based, command line oriented, document + structuring, publishing and search framework for document collections. + . + 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 + 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. + . + SiSU also provides concordance files, document content certificates +and + manifests of generated output. + . + 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. + . + man pages, and interactive help are provided. + . + Dependencies for various features are taken care of in sisu related +packages. + The package sisu-complete installs the whole of SiSU. + . + 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. + . + Homepage: <http://www.jus.uio.no/sisu> +</pre> +<p> +<p> <br> +<pre> Package: sisu-complete + Architecture: all + Depends: ruby (>= 1.8.2), sisu, sisu-pdf, sisu-postgresql, sisu-sqlite + Recommends: hyperestraier + Description: installs all SiSU related packages + This package installs SiSU and related packages that enable sisu to +produce + pdf and to populate postgresql and sqlite databases. + . + SiSU is a lightweight markup based document publishing framework. + . + See sisu for a description of the package. + . + Homepage: <http://www.jus.uio.no/sisu> +</pre> +<p> +<p> <br> +<pre> Package: sisu-pdf + Architecture: all + Depends: sisu, texlive-latex-base, texlive-fonts-recommended, texlive-latex-recommended, +texlive-latex-extra + #Suggests: evince, xpdf + Description: dependencies to convert SiSU LaTeX output to pdf + This package enables the conversion of SiSU LaTeX output to pdf. + . + SiSU is a lightweight markup based document publishing framework. + . + Homepage: <http://www.jus.uio.no/sisu> +</pre> +<p> +<p> <br> +<pre> Package: sisu-postgresql + Architecture: all + Depends: sisu, libdbd-pg-ruby, libdbi-ruby, libdbm-ruby, postgresql + Recommends: libfcgi-ruby + Suggests: postgresql-contrib + Description: SiSU dependencies for use with postgresql database + This package enables SiSU to populate a postgresql database. This is +done at + an object/paragraph level, making granular searches of documents possible. + . + This relational database feature of SiSU is not required but provides + interesting possibilities, including that of granular searches of documents + for matching units of text, primarily paragraphs that can be displayed +or + identified by object citation number, from which an index of documents + matched and each matched paragraph within them can be displayed. + . + SiSU is a lightweight markup based document publishing framework. + . + Homepage: <http://www.jus.uio.no/sisu> +</pre> +<p> +<p> <br> +<pre> Package: sisu-sqlite + Architecture: all + Depends: sisu, sqlite, libdbd-sqlite-ruby, libdbi-ruby, libdbm-ruby + Recommends: libfcgi-ruby + Description: SiSU dependencies for use with sqlite database + This package enables SiSU to populate an sqlite database. This is done +at an + object/paragraph level, making granular searches of documents possible. + . + This relational database feature of SiSU is not required but provides + interesting possibilities, including that of granular searches of documents + for matching units of text, primarily paragraphs that can be displayed +or + identified by object citation number, from which an index of documents + matched and each matched paragraph within them can be displayed. + . + SiSU is a lightweight markup based document publishing framework. + . + Homepage: <http://www.jus.uio.no/sisu> +</pre> +<p> 6.4 QUICK START +<p> Most of the installation should be taken care of by the +aptitude or rant install. (The rant install if run in full will also test +run the generation of the first document). +<p> After installation of sisu-complete, + +<p>move to the document samples directory +<p> cd /usr/share/doc/sisu/sisu_markup_samples/dfsg<br> + +<p> and run +<p> sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst<br> + +<p> or the same: +<p> sisu -NhwpoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst<br> + +<p> look at output results, see the +<p> or to generate an online document +move to a writable directory, as the file will be downloaded there and +e.g. +<p> sisu -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> the database stuff is extra perhaps, the latex stuff could be considered + +<p>extra perhaps but neither needs to be installed for most of sisu output + +<p>to work +<p> examine source document, vim has syntax support +<p> gvim free_as_in_freedom.rms_and_free_software.sam_williams.sst + +<p> additional markup samples in +<p> <<a href='http://www.jus.uio.no/sisu/SiSU/2.html'>http://www.jus.uio.no/sisu/SiSU/2.html</a> +><br> + +<p> For help +<p> man sisu<br> + +<p> or +<p> sisu --help<br> + +<p> e.g. +<p> for the way sisu +<p> sisu --help env<br> + +<p> for list of commands and so on +<p> sisu --help commands<br> + +<p> 6.5 CONFIGURATION FILES +<p> The default configuration/setup is contained + +<p>within the program and is altered by configuration settings in <i>etc</i> [sisu + +<p> version]/sisurc.yml or in ~/.sisu/sisurc.yml +<p> * configuration file - a yaml + +<p>file +<p> /etc/sisu/[sisu version]/sisurc.yml<br> + +<p> ~/.sisu/sisurc.yml<br> + +<p> * directory structure - setting up of output and working directory. +<p> +* skins - changing the appearance of a project, directory or individual + +<p>documents within ~/.sisu/skin +<p> ~/.sisu/skin/doc contains individual skins, +with symbolic links from<br> + +<p> ~/.sisu/skin/dir if the contents of a directory are to take a particular<br> + document skin.<br> + +<p> * additional software - eg. Tex and LaTeX (tetex, tetex-base, tetex-extra +on <b>Debian</b> ), Postgresql, [sqlite], trang, tidy, makeinfo, ... none of which +are required for basic html or XML processing. +<p> * if you use Vim as editor +there is a syntax highlighter and fold resource config file for <b>SiSU</b> <i>hope</i> +more syntax highlighters follow. +<p> There are post installation steps (which +are really part of the overall installation) +<p> sisu -C in your marked up +document directory, should do some auto-configuring provided you have the +right permissions for the output directories. (and provided the output directories +have already been specified if you are not using the defaults). +<p> 6.6 USE + +<p>GENERAL OVERVIEW +<p> Documents are marked up in <b>SiSU</b> syntax and kept in an +ordinary text editable file, named with the suffix +<p> Marked up <b>SiSU</b> documents + +<p>are usually kept in a sub-directory of your choosing +<p> use the interactive + +<p>help and man pages +<p> sisu --help<br> + +<p> man sisu<br> + +<p> 6.7 HELP +<p> interactive help described below, or man page: +<p> man sisu<br> + +<p> man 8 sisu<br> + +<p> ’man sisu_markup-samples’ [if the sisu-markup-samples package is also installed] + +<p> Once installed an interactive help is available typing ’sisu’ (without) +any flags, and select an option: +<p> sisu<br> + +<p> alternatively, you could type e.g. +<p> sisu --help commands<br> + +<p> sisu --help env<br> + +<p> sisu --help headers<br> + +<p> sisu --help markup<br> + +<p> sisu --help headings<br> + +<p> etc. +<p> for questions about mappings, output paths etc. +<p> sisu --help env<br> + +<p> sisu --help path<br> + +<p> sisu --help directory<br> + +<p> 6.8 DIRECTORY STRUCTURE +<p> Once installed, type: +<p> sisu --help env<br> + +<p> or +<p> sisu -V<br> + +<p> 6.9 CONFIGURATION FILE +<p> The defaults can be changed via <b>SiSU</b> ’s configure +file sisurc.yml which the program expects to find in ./_sisu ~/.sisu or /etc/sisu +(searched in that order, stopping on the first one found) +<p> 6.10 MARKUP +<p> + See man pages. +<p> man sisu<br> + +<p> man 8 sisu<br> + +<p> Once installed there is some information on <b>SiSU</b> Markup in its help: + +<p> sisu --help markup<br> + +<p> and +<p> sisu --help headers<br> + +<p> Sample marked up document are provided with the download tarball in +the directory: +<p> ./data/doc/sisu/sisu_markup_samples/dfsg<br> + +<p> These are installed on the system usually at: +<p> /usr/share/doc/sisu/sisu_markup_samples/dfsg<br> + +<p> More markup samples are available in the package sisu-markup-samples +<p> + <<a href='http://www.jus.uio.no/sisu/SiSU/download.html#sisu-markup-samples'>http://www.jus.uio.no/sisu/SiSU/download.html#sisu-markup-samples</a> +><br> + +<p> Many more are available online off: +<p> <<a href='http://www.jus.uio.no/sisu/SiSU/2.html'>http://www.jus.uio.no/sisu/SiSU/2.html</a> +><br> + +<p> 6.11 ADDITIONAL THINGS +<p> There is syntax support for some editors provided +(together with a README file) in +<p> ./data/sisu/conf/syntax<br> + +<p> usually installed to: +<p> /usr/share/sisu/conf/syntax<br> + +<p> 6.12 LICENSE +<p> License: GPL 3 or later see the copyright file in +<p> ./data/doc/sisu<br> + +<p> usually installed to: +<p> /usr/share/doc/sisu<br> + +<p> 6.13 SISU STANDARD +<p> <b>SiSU</b> uses: +<p> * Standard <b>SiSU</b> markup syntax, +<p> * Standard +<b>SiSU</b> meta-markup syntax, and the +<p> * Standard <b>SiSU</b> object citation numbering + +<p>and system +<p> © Ralph Amissah 1997, current 2006 All Rights Reserved. +<p> * + +<p>however note the License section +<p> CHANGELOG +<p> ./CHANGELOG<br> + +<p> and see +<p> <<a href='http://www.jus.uio.no/sisu/SiSU/changelog.html'>http://www.jus.uio.no/sisu/SiSU/changelog.html</a> +><br> + +<p> <<a href='http://www.jus.uio.no/sisu/SiSU/changelog_markup_samples.html'>http://www.jus.uio.no/sisu/SiSU/changelog_markup_samples.html</a> +><br> + +<p> EXTRACTS FROM MAN 8 SISU +<p> 7. POST INSTALLATION SETUP +<p> 7.1 POST INSTALLATION +SETUP - QUICK START +<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 + +<p>the output directory with the command +<p> sisu -CC<br> + +<p> then run: +<p> sisu -1 free_as_in_freedom.rms_and_free_software.sam_williams.sst<br> + +<p> or the same: +<p> sisu -NhwpoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst<br> + +<p> look at output results, see the +<p> for an overview of your current sisu +setup, type: +<p> sisu --help env<br> + +<p> or +<p> sisu -V<br> + +<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> sisu -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> +><br> + +<p> sisu -3<br> + <<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> +><br> + +<p> examine source document, vim has syntax highlighting support +<p> gvim + +<p>free_as_in_freedom.rms_and_free_software.sam_williams.sst +<p> additional markup + +<p>samples in +<p> <<a href='http://www.jus.uio.no/sisu/SiSU/2.html'>http://www.jus.uio.no/sisu/SiSU/2.html</a> +><br> + +<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> sisu -3<br> + <<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> +><br> + +<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> sisu -3 --trust<br> + <<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> +><br> + +<p> For help +<p> man sisu<br> + +<p> sisu --help<br> + +<p> sisu --help env for the way sisu<br> + +<p> sisu --help commands for list of commands and so on<br> + +<p> 7.2 DOCUMENT MARKUP DIRECTORY +<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: +<p> mkdir ~/sisu_test<br> + +<p> cd ~/sisu_test<br> + +<p> cp -a /usr/share/doc/sisu/sisu_markup_samples/dfsg/* ~/sisu_test/.<br> + +<p> <b>Tip:</b> the markup syntax examples may be of interest +<p> <<a href='http://www.jus.uio.no/sisu/sample/'>http://www.jus.uio.no/sisu/sample/</a> +><br> + +<p> <b>Tip:</b> +<p> sisu -U [sisu markup filename]<br> + +<p> should printout the different possible outputs and where sisu would +place them. +<p> <b>Tip:</b> if you want to toggle ansi color add +<p> c<br> + +<p> to your flags. +<p> 7.2.1 CONFIGURATION FILES +<p> <b>SiSU</b> configuration file search +path is: +<p> ./_sisu/sisurc.yaml<br> + +<p> ~/.sisu/sisurc.yaml<br> + +<p> /etc/sisu/sisurc.yaml<br> + +<p> <b>Debian</b> Installation Note +<p> 7.2.2 DEBIAN INSTALLATION NOTE +<p> It is best + +<p>you see +<p> <<a href='http://www.jus.uio.no/sisu/SiSU/download.html#debian'>http://www.jus.uio.no/sisu/SiSU/download.html#debian</a> +><br> + +<p> for up the most up to date information. +<p> notes taken from the <b>Debian</b> +control file (end edited), gives an idea of additional packages that <b>SiSU</b> +can make use of if available, (the use/requirement of some of which are +interdependent for specific actions by <b>SiSU</b> ): +<p> Package: sisu +<p> <b>SiSU</b> 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, <b>SiSU</b> 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 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> <b>SiSU</b> 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 <b>SiSU</b> +<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 <b>SiSU</b> +<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> +> + +<p> 7.2.3 DOCUMENT RESOURCE CONFIGURATION +<p> <b>sisu</b> resource configuration information +is obtained from sources (where they exist): +<p> ~/.sisu/sisurc.yaml<br> + +<p> /etc/sisu/[sisu version]/sisurc.yaml<br> + +<p> sisu program defaults<br> + +<p> 7.2.4 SKINS +<p> <b>Skins</b> default document appearance may be modified using skins +contained in sub-directories located at the following paths: +<p> ./_sisu/skin<br> + +<p> ~/.sisu/skin<br> + +<p> /etc/sisu/skin<br> + +<p> more specifically, the following locations (or their /etc/sisu equivalent) +should be used: +<p> ~/.sisu/skin/doc<br> + +<p> skins for individual documents; +<p> ~/.sisu/skin/dir<br> + +<p> skins for directories of matching names; +<p> ~/.sisu/skin/site<br> + +<p> site-wide skin modifying the site-wide appearance of documents. +<p> Usually +all skin files are placed in the document skin directory: +<p> ~/.sisu/skin/doc<br> + +<p> with softlinks being made to the skins contained there from other skin +directories as required. +<p> DOCUMENT INFORMATION (METADATA) +<p> METADATA +<p> +Document Manifest @ <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_howto/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_howto/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 information Structuring Universe / Structured information, +Serialized Units - Technical, Howto +<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-11-12</i> +<p> DC Date issued: + +<p><i>2002-11-12</i> +<p> DC Date available: <i>2002-11-12</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_howto.sst</i> +<p> Filetype: + +<p><i>SiSU</i> text insert 0.57 +<p> Sourcefile Digest, MD5(sisu_howto.sst)= <i>82c606e66689bcb5d190edf8fc7227a0</i> + +<p> Skin_Digest: MD5(/home/ralph/grotto/theatre/dbld/sisu-dev/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)= + +<p><i>20fc43cf3eb6590bc3399a1aef65c5a9</i> +<p> <b>Generated</b> +<p> Document (metaverse) last +generated: <i>Sun</i> Sep 23 01:14:01 +0100 2007 +<p> Generated by: <i>SiSU</i> <i>0.58.3</i> of +2007w36/4 (2007-09-06) +<p> Ruby version: <i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36) + [i486-linux] +<p> +<ol> +<b>.</b><li>generated from source using rman <<a href='http://polyglotman.sourceforge.net/rman.html'>http://polyglotman.sourceforge.net/rman.html</a> +><br> + With regard to<br> + <b>SiSU</b> man pages the formatting generated for markup syntax is not quite +right, for that you might prefer the links under: <<a href='http://www.jus.uio.no/sample'>http://www.jus.uio.no/sample</a> +><br> + </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><<a href='http://www.jus.uio.no/sisu/man/sisu.8.html'>http://www.jus.uio.no/sisu/man/sisu.8.html</a> +> +</li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man/sisu_examples.1.html'>http://www.jus.uio.no/sisu/man/sisu_examples.1.html</a> +> </li><b>.</b><li><<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> +> +</li><b>.</b><li>this is an endnote </li><b>.</b><li><<a href='http://sisudoc.org'>http://sisudoc.org</a> +> </li><b>.</b><li><<a href='http://sisudoc.org'>http://sisudoc.org</a> +> +<p> </dd> + +<dt>Other versions +of this document: </dt> +<dd></dd> + +<dt>manifest: <<a href='http://www.jus.uio.no/sisu/sisu_howto/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_howto/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_howto/sisu_manifest.html</a> +</a> +> +</dt> +<dd></dd> + +<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_howto/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_howto/toc.html'>http://www.jus.uio.no/sisu/sisu_howto/toc.html</a> +</a> +> </dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_howto/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_howto/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_howto/portrait.pdf</a> +</a> +> +</dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_howto/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_howto/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_howto/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.58.3 of 2007w36/4 (2007-09-06) </dt> +<dd></dd> + +<dt>* Ruby version: ruby +1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt> +<dd></dd> + +<dt>* Last Generated on: Sun Sep 23 +01:14:06 +0100 2007 </dt> +<dd></dd> + +<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> + </dt> +<dd></dd> +</dl> +<p> +</body> +</html> diff --git a/data/doc/sisu/html/sisu_markup.1.html b/data/doc/sisu/html/sisu_markup.1.html new file mode 100644 index 00000000..a0bc5072 --- /dev/null +++ b/data/doc/sisu/html/sisu_markup.1.html @@ -0,0 +1,1113 @@ +<!-- manual page source format generated by PolyglotMan v3.2, --> +<!-- available at http://polyglotman.sourceforge.net/ --> + +<html> +<head> +<title>"sisu_markup"("1") manual page</title> +</head> +<body bgcolor='white'> +<a href='#toc'>Table of Contents</a><p> +SISU - MARKUP [0.58], RALPH AMISSAH +<p> SISU MARKUP +<p> 1. INTRODUCTION TO SISU +MARKUP[^1] +<p> 1.1 SUMMARY +<p> <b>SiSU</b> source documents are plaintext (UTF-8)[^2] + +<p>files +<p> All paragraphs are separated by an empty line. +<p> Markup is comprised +of: +<p> * at the top of a document, the document header made up of semantic +meta-data about the document and if desired additional processing instructions +(such an instruction to automatically number headings from a particular +level down) +<p> * followed by the prepared substantive text of which the +most important single characteristic is the markup of different heading +levels, which define the primary outline of the document structure. Markup +of substantive text includes: +<p> * heading levels defines document structure<br> + +<p> * text basic attributes, italics, bold etc.<br> + +<p> * grouped text (objects), which are to be treated differently, such +as code<br> + blocks or poems.<br> + +<p> * footnotes/endnotes<br> + +<p> * linked text and images<br> + +<p> * paragraph actions, such as indent, bulleted, numbered-lists, etc.<br> + +<p> Some interactive help on markup is available, by typing sisu and selecting + +<p>markup or sisu --help markup +<p> 1.2 MARKUP EXAMPLES +<p> 1.2.1 ONLINE +<p> Online markup +examples are available together with the respective outputs produced from +<<a href='http://www.jus.uio.no/sisu/SiSU/2.html'>http://www.jus.uio.no/sisu/SiSU/2.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> 1.2.2 INSTALLED + +<p> With <b>SiSU</b> installed sample skins may be found in: /usr/share/doc/sisu/sisu_markup_samples/dfsg +(or equivalent directory) and if sisu-markup-samples is installed also under: + +<p>/usr/share/doc/sisu/sisu_markup_samples/non-free +<p> 2. MARKUP OF HEADERS +<p> + Headers consist of semantic meta-data about a document, which can be used +by any output module of the program; and may in addition include extra +processing instructions. +<p> Note: the first line of a document may include +information on the markup version used in the form of a comment. Comments +are a percentage mark at the start of a paragraph (and as the first character +in a line of text) followed by a space and the comment: +<p> +<p> <br> +<pre> % this would be a comment +</pre> +<p> 2.1 SAMPLE HEADER +<p> This current document has a header similar to this +one (without the comments): +<p> +<p> <br> +<pre> % SiSU 0.57 + @title: SiSU + @subtitle: Markup [0.58] + @creator: Ralph Amissah + @rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, +License GPL 3 + @type: information + @subject: ebook, epublishing, electronic book, electronic publishing, +electronic document, electronic citation, data structure, citation systems, +search + @date.created: 2002-08-28 + @date.issued: 2002-08-28 + @date.available: 2002-08-28 + @date.modified: 2007-09-16 + @date: 2007-09-16 + @level: new=C; break=1; num_top=1 + % comment: in this @level header num_top=1 starts automatic heading numbering +at heading level 1 (numbering continues 3 levels down); the new and break +instructions are used by the LaTeX/pdf and odf output to determine where +to put page breaks (that are not used by html output or say sql database +population). + @skin: skin_sisu_manual + % skins modify the appearance of a document and are placed in a sub-directory +under ./_sisu/skin ~/.sisu/skin or /etc/sisu/skin. A skin may affect single +documents that request them, all documents in a directory, or be site-wide. +(A document is affected by a single skin) + @bold: /Gnu|Debian|Ruby|SiSU/ + @links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +</pre> +<p> 2.2 AVAILABLE HEADERS +<p> Header tags appear at the beginning of a document +and provide meta information on the document (such as the Dublin Core), +or information as to how the document as a whole is to be processed. All +header instructions take either the form @headername: or 0~headername. All + +<p>Dublin Core meta tags are available +<p> <b>@indentifier:</b> information or instructions + +<p> where the information +<p> Note: a header where used should only be used +once; all headers apart from @title: are optional; the @structure: header +is used to describe document structure, and can be useful to know. +<p> This + +<p>is a sample header +<p> <b>% SiSU 0.38</b> [declared file-type identifier with markup + version] +<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 <i>mandatory</i> +<p> <b>@subtitle:</b> The + +<p>Subtitle if any +<p> <b>@creator:</b> [or @author:] Name of Author +<p> <b>@subject:</b> (whatever +your subject) +<p> <b>@description:</b> +<p> <b>@publisher:</b> +<p> <b>@contributor:</b> +<p> <b>@translator:</b> + [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: @date.modified: ] +<p> <b>@type: 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, and in sql searches] +<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, classification]; 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 implemented] +<p> <b>@prefix_b:</b> +<p> <b>@rcs:</b> $Id: +sisu_markup.sst,v 1.2 2007/09/08 17:12:47 ralph Exp $ [used by rcs or cvs + to embed version (revision control) information into under ./_sisu/skin +~/.sisu/skin or /etc/sisu/skin. A skin may affect single documents that request +them, all documents in a directory, or be site-wide. (A document is affected +by a single skin) document, rcs or cvs can usefully provide a history of +under ./_sisu/skin ~/.sisu/skin or /etc/sisu/skin. A skin may affect single +documents that request them, all documents in a directory, or be site-wide. +(A document is affected by a single skin) updates 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 in + newpage] +<p> <b>@markup:</b> information on the markup used, e.g. new=1,2,3; break=4; +num_top=4 [or newpage=1,2,3; breakpage=4; num_top=4] newpage and breakpage, +heading level, used by LaTeX to breakpages. breakpage: starts on a new page +in single column text and on a new column in double column text; newpage: +starts on a new page for both single and double column texts. num_top=4 + [auto-number document, starting at level 4. the 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 and use + for numbering of Available where a clear numbering structure is 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> <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 list.yml and promo.yml, commented out sample in document +sample: and promo.yml, commented out sample in document free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst] + +<p> 3. MARKUP OF SUBSTANTIVE TEXT +<p> 3.1 HEADING LEVELS +<p> Heading levels are +:A~ ,:B~ ,:C~ ,1~ ,2~ ,3~ ... :A - :C being part / section headings, followed +by other heading levels, and 1 -6 being headings followed by substantive +text or sub-headings. :A~ usually the title :A~? conditional level 1 heading +(used where a stand-alone document may be imported into another) +<p> <b>:A~ [heading + text]</b> Top level heading [this usually has similar content to the ] NOTE: +the heading levels described here are in 0.38 notation, see heading +<p> <b>:B~ + [heading text]</b> Second level heading [this is a heading level divider] +<p> + <b>:C~ [heading text]</b> Third level heading [this is a heading level divider] + +<p> <b>1~ [heading text]</b> Top level heading preceding substantive text of document +or sub-heading 2, the heading level that would normally be marked 1. or 2. +or 3. etc. in a document, and the level on which sisu by default would break +html output into named segments, names are provided automatically if none +are given (a number), otherwise takes the form 1~my_filename_for_this_segment + +<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> 3.2 FONT ATTRIBUTES +<p> <b>markup example:</b> +<p> +<p> <br> +<pre> normal text !{emphasis}! *{bold text}* _{underscore}_ /{italics}/ + normal text + !{emphasis}! + *{bold text}* + _{underscore} + /{italics}/ + + ^{superscript}^ + ,{subscript}, + +{inserted text}+ + -{strikethrough}- +</pre> +<p> <b>resulting output:</b> +<p> normal text <em>emphasis</em> <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> <em>emphasis</em> +<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> 3.3 INDENTATION AND BULLETS +<p> <b>markup example:</b> +<p> +<p> <br> +<pre> ordinary paragraph + _1 indent paragraph one step + _2 indent paragraph two steps + _9 indent paragraph nine steps +</pre> +<p> <b>resulting output:</b> +<p> ordinary paragraph +<p> indent paragraph one step<br> + +<p> indent paragraph two steps<br> + +<p> indent paragraph nine steps<br> + +<p> <b>markup example:</b> +<p> +<p> <br> +<pre> * bullet text + _1* bullet text, first indent + _2* bullet text, two step indent +</pre> +<p> <b>resulting output:</b> +<p> * bullet text +<p> * bullet text, first indent<br> + +<p> * bullet text, two step indent<br> + +<p> Numbered List (not to be confused with headings/titles, (document structure)) + +<p> <b>markup example:</b> +<p> +<p> <br> +<pre> # numbered list numbered list 1., 2., 3, etc. + _# numbered list numbered list indented a., b., c., d., etc. +</pre> +<p> 3.4 FOOTNOTES / ENDNOTES +<p> Footnotes and endnotes not distinguished in +markup. They are automatically numbered. Depending on the output file format +(html, odf, pdf etc.), the document output selected will have either footnotes +or endnotes. +<p> <b>markup example:</b> +<p> +<p> <br> +<pre> ~{ a footnote or endnote }~ +</pre> +<p> <b>resulting output:</b> +<p> [^3] +<p> <b>markup example:</b> +<p> +<p> <br> +<pre> normal text~{ self contained endnote marker & endnote in one }~ continues +</pre> +<p> <b>resulting output:</b> +<p> normal text[^4] continues +<p> <b>markup example:</b> +<p> +<p> <br> +<pre> normal text ~{* unnumbered asterisk footnote/endnote, insert multiple +asterisks if required }~ continues + normal text ~{** another unnumbered asterisk footnote/endnote }~ continues +</pre> +<p> <b>resulting output:</b> +<p> normal text [^*] continues +<p> normal text [^**] continues + +<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 [^*1] continues +<p> normal text [^+1] continues + +<p> <b>Alternative endnote pair notation for footnotes/endnotes:</b> +<p> +<p> <br> +<pre> + % note the endnote marker + normal text~^ continues + ^~ endnote text following the paragraph in which the marker occurs +</pre> +<p> the standard and pair notation cannot be mixed in the same document +<p> + +<p>3.5 LINKS +<p> 3.5.1 NAKED URLS WITHIN TEXT, DEALING WITH URLS +<p> urls are found +within text and marked up automatically. A url within text is automatically +hyperlinked to itself and by default decorated with angled braces, unless +they are contained within a code block (in which case they are passed as +normal text), or escaped by a preceding underscore (in which case the decoration +is omitted). +<p> <b>markup example:</b> +<p> +<p> <br> +<pre> normal text http://www.jus.uio.no/sisu continues +</pre> +<p> <b>resulting output:</b> +<p> normal text <<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> 3.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> +> [^5] markup +<p> 3.5.3 + +<p>LINKING IMAGES +<p> <b>markup example:</b> +<p> +<p> <br> +<pre> [ tux.png ] + % various url linked images + [ tux.png ] + [ GnuDebianLinuxRubyBetterWay.png ] + {~^ ruby_logo.png +</pre> +<p> <b>resulting output:</b> +<p> [ tux.png ] +<p> tux.png 64x80 +<p> [ ruby_logo (png missing) + ] [^6] +<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> 3.6 GROUPED TEXT +<p> 3.6.1 + +<p>TABLES +<p> Tables may be prepared in two either of two forms +<p> <b>markup example:</b> + +<p> +<p> <br> +<pre> table{ c3; 40; 30; 30; + This is a table + this would become column two of row one + column three of row one is here + And here begins another row + column two of row two + column three of row two, and so on + }table +</pre> +<p> <b>resulting output:</b> +<p> [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> [^7] +<p> +<p> <br> +<pre> !_ Table 3.1: Contributors to Wikipedia, January 2001 - June 2005 + {table~h 24; 12; 12; 12; 12; 12; 12;} + |Jan. 2001|Jan. 2002|Jan. 2003|Jan. 2004|July +2004|June 2006 + Contributors* | 10| 472| 2,188| 9,653| + 25,011| 48,721 + Active contributors** | 9| 212| 846| 3,228| + 8,442| 16,945 + Very active contributors*** | 0| 31| 190| 692| + 1,639| 3,016 + No. of English language articles| 25| 16,000| 101,000| 190,000| +320,000| 630,000 + No. of articles, all languages | 25| 19,000| 138,000| 490,000| +862,000|1,600,000 + Contributed at least ten times; at least 5 times in last month; ** more +than 100 times in last month. +</pre> +<p> <b>resulting output:</b> +<p> <b>Table 3.1: Contributors to Wikipedia, January 2001 +- June 2005</b> +<p> [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> 3.6.2 POEM +<p> <b>basic markup:</b> +<p> +<p> <br> +<pre> poem{ + Your poem here + }poem + Each verse in a poem is given a separate object number. +</pre> +<p> <b>markup example:</b> +<p> +<p> <br> +<pre> poem{ + ’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> + <p> + mouse, That he<br> + <p> + met in the<br> + <p> + house,<br> + <p> + <br> + <p> + both go to<br> + <p> + law: I will<br> + <p> + prosecute<br> + <p> + YOU. --Come,<br> + <p> + I’ll take no<br> + <p> + denial; We<br> + <p> + must have a<br> + <p> + trial: For<br> + <p> + really this<br> + <p> + morning I’ve<br> + <p> + nothing<br> + <p> + to do.<br> + <p> + Said the<br> + <p> + mouse to the<br> + <p> + cur,<br> + <p> + a trial,<br> + <p> + dear Sir,<br> + <p> + With<br> + <p> + no jury<br> + <p> + or judge,<br> + <p> + would be<br> + <p> + wasting<br> + <p> + our<br> + <p> + breath.<br> + <p> + <br> + <p> + judge, I’ll<br> + <p> + be jury,<br> + <p> + Said<br> + <p> + cunning<br> + <p> + old Fury:<br> + <p> + <br> + <p> + try the<br> + <p> + whole<br> + <p> + cause,<br> + <p> + and<br> + <p> + condemn<br> + <p> + you<br> + <p> + to<br> + <p> + death.<br> + <p> + +<p> 3.6.3 GROUP +<p> <b>basic markup:</b> +<p> +<p> <br> +<pre> group{ + Your grouped text here + }group + A group is treated as an object and given a single object number. +</pre> +<p> <b>markup example:</b> +<p> +<p> <br> +<pre> group{ + ’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> + <p> + mouse, That he<br> + <p> + met in the<br> + <p> + house,<br> + <p> + <br> + <p> + both go to<br> + <p> + law: I will<br> + <p> + prosecute<br> + <p> + YOU. --Come,<br> + <p> + I’ll take no<br> + <p> + denial; We<br> + <p> + must have a<br> + <p> + trial: For<br> + <p> + really this<br> + <p> + morning I’ve<br> + <p> + nothing<br> + <p> + to do.<br> + <p> + Said the<br> + <p> + mouse to the<br> + <p> + cur,<br> + <p> + a trial,<br> + <p> + dear Sir,<br> + <p> + With<br> + <p> + no jury<br> + <p> + or judge,<br> + <p> + would be<br> + <p> + wasting<br> + <p> + our<br> + <p> + breath.<br> + <p> + <br> + <p> + judge, I’ll<br> + <p> + be jury,<br> + <p> + Said<br> + <p> + cunning<br> + <p> + old Fury:<br> + <p> + <br> + <p> + try the<br> + <p> + whole<br> + <p> + cause,<br> + <p> + and<br> + <p> + condemn<br> + <p> + you<br> + <p> + to<br> + <p> + death.<br> + <p> + +<p> 3.6.4 CODE +<p> Code tags are used to escape regular sisu markup, and have +been used extensively within this document to provide examples of <b>SiSU</b> +markup. You cannot however use code tags to escape code tags. They are however +used in the same way as group or poem tags. +<p> A code-block is treated as +an object and given a single object number. [an option to number each line + of code may be considered at 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> 4. COMPOSITE DOCUMENTS MARKUP +<p> It is possible to build a document by +creating a master document that requires other documents. The documents +required may be complete documents that could be generated independently, +or they could be markup snippets, prepared so as to be easily available +to be placed within another text. If the calling document is a master document +(built from other documents), it should be named with the suffix <b>.ssm</b> Within +this document you would provide information on the other documents that +should be included within the text. These may be other documents that would +be processed in a regular way, or markup bits prepared only for inclusion +within a master document <b>.sst</b> regular markup file, or <b>.ssi</b> (insert/information) + +<p>A secondary file of the composite document is built prior to processing + +<p>with the same prefix and the suffix <b>._sst</b> +<p> basic markup for importing a + +<p>document into a master document +<p> +<p> <br> +<pre> << |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> r{filename} + {filename.ssi}require + << {filename.ssi} + % using textlink alternatives + |filename.ssi|@|^|require + << |filename.ssi|@|^| + % using thlnk alternatives + <url:filename.ssi>require + << <url:filename.ssi> +</pre> +<p> MARKUP SYNTAX HISTORY +<p> 5. NOTES RELATED TO FILES-TYPES AND MARKUP SYNTAX + +<p> 0.38 is substantially current, depreciated 0.16 supported, though file + +<p>names were changed at 0.37 +<p> <b>0.52</b> (2007w14/6) declared document type identifier +at start of text/document: +<p> .B SiSU<br> + 0.52 +<p> or, backward compatible using the comment marker: +<p> %<br> + <b>SiSU</b> 0.38 +<p> variations include ’ <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>0.38</b> (2006w15/7) +introduced new/alternative notation for headers, e.g. @title: (instead of +0~title), and accompanying document structure markup, :A,:B,:C,1,2,3 (maps +to previous 1,2,3,4,5,6) +<p> <b>0.37</b> (2006w09/7) introduced new file naming convention, +.sst (text), .ssm (master), .ssi (insert), markup syntax unchanged +<p> <b>0.35</b> (2005w52/3) +sisupod, zipped content file introduced +<p> <b>0.23</b> (2005w36/2) utf-8 for markup + +<p>file +<p> <b>0.22</b> (2005w35/3) image dimensions may be omitted if rmagick is available + +<p>to be relied upon +<p> <b>0.20.4</b> (2005w33/4) header 0~links +<p> <b>0.16</b> (2005w25/2) substantial +changes introduced to make markup cleaner, header 0~title type, and headings + [1-6]~ introduced, also percentage sign (%) at start of a text line as comment + +<p>marker +<p> DOCUMENT INFORMATION (METADATA) +<p> METADATA +<p> Document Manifest +@ <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_markup/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_markup/sisu_manifest.html</a> +> +<p> <b>Dublin +Core</b> (DC) +<p> <i>DC</i> tags included with this document are provided here. +<p> DC +Title: <i>SiSU</i> - Markup [0.58] +<p> DC Creator: <i>Ralph</i> Amissah +<p> DC Rights: <i>Copyright</i> +(C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +<p> DC +Type: <i>information</i> +<p> DC Date created: <i>2002-08-28</i> +<p> DC Date issued: <i>2002-08-28</i> + +<p> DC Date available: <i>2002-08-28</i> +<p> DC Date modified: <i>2007-09-16</i> +<p> DC Date: <i>2007-09-16</i> + +<p> <b>Version Information</b> +<p> Sourcefile: <i>sisu_markup.sst</i> +<p> Filetype: <i>SiSU</i> text + +<p>0.58 +<p> Sourcefile Digest, MD5(sisu_markup.sst)= <i>643738c4b96d001d107e3ea72ba17a97</i> + +<p> Skin_Digest: MD5(/home/ralph/grotto/theatre/dbld/sisu-dev/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)= + +<p><i>20fc43cf3eb6590bc3399a1aef65c5a9</i> +<p> <b>Generated</b> +<p> Document (metaverse) last +generated: <i>Sun</i> Sep 23 01:13:59 +0100 2007 +<p> Generated by: <i>SiSU</i> <i>0.58.3</i> of +2007w36/4 (2007-09-06) +<p> Ruby version: <i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36) + [i486-linux] +<p> +<ol> +<b>.</b><li>From sometime after SiSU 0.58 it should be possible to describe +SiSU markup using SiSU, which though not an original design goal is useful. +</li><b>.</b><li>files should be prepared using UTF-8 character encoding </li><b>.</b><li>a footnote or endnote +</li><b>.</b><li>self contained endnote marker & endnote in one </dd> + +<dt><b>*.</b> </dt> +<dd>unnumbered asterisk footnote/endnote, +insert multiple asterisks if required </dd> + +<dt><b>**.</b> </dt> +<dd>another unnumbered asterisk footnote/endnote +</dd> + +<dt><b>*1.</b> </dt> +<dd>editors notes, numbered asterisk footnote/endnote series </dd> + +<dt><b>+1.</b> </dt> +<dd>editors +notes, numbered asterisk footnote/endnote series </li><b>.</b><li><<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> +><br> + +<p> </dd> + +<dt>Other versions of this document: </dt> +<dd></dd> + +<dt>manifest: <<a href='http://www.jus.uio.no/sisu/sisu_markup/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_markup/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_markup/sisu_manifest.html</a> +</a> +> +</dt> +<dd></dd> + +<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_markup/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_markup/toc.html'>http://www.jus.uio.no/sisu/sisu_markup/toc.html</a> +</a> +> </dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_markup/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_markup/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_markup/portrait.pdf</a> +</a> +> +</dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_markup/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_markup/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_markup/landscape.pdf</a> +</a> +> </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.58.3 of 2007w36/4 (2007-09-06) </dt> +<dd></dd> + +<dt>* Ruby version: ruby +1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt> +<dd></dd> + +<dt>* Last Generated on: Sun Sep 23 +01:14:06 +0100 2007 </dt> +<dd></dd> + +<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> + </dt> +<dd></dd> +</dl> +<p> +</body> +</html> diff --git a/data/doc/sisu/html/sisu_pdf.7.html b/data/doc/sisu/html/sisu_pdf.7.html index 6f0cd214..693d3892 100644 --- a/data/doc/sisu/html/sisu_pdf.7.html +++ b/data/doc/sisu/html/sisu_pdf.7.html @@ -1,48 +1,161 @@ - <!-- manual page source format generated by PolyglotMan v3.2, --> +<!-- manual page source format generated by PolyglotMan v3.2, --> <!-- available at http://polyglotman.sourceforge.net/ --> <html> <head> -<title>sisu_pdf(7) manual page</title> +<title>"sisu_pdf"("1") manual page</title> </head> <body bgcolor='white'> <a href='#toc'>Table of Contents</a><p> +SISU - SISU INFORMATION STRUCTURING UNIVERSE - SEARCH [0.58], RALPH AMISSAH + +<p> SISU SEARCH +<p> SISU SQLITE +<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 +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). -<h2><a name='sect0' href='#toc0'>Name</a></h2> -<b>SiSU</b> - Structured information, Serialized Units - a document -publishing system <p> -Dummy package installs the dependencies required to convert -LaTeX output from SiSU to pdf -<h2><a name='sect1' href='#toc1'>Synopsis</a></h2> -<b>sisu</b> <b>-p</b> [filename/wildcard] -<h2><a name='sect2' href='#toc2'>Description</a></h2> -<b>sisu_pdf</b> -<i>is</i> part of SiSU (man sisu) sisu_pdf is a dummy package to install dependencies -needed for sisu to make rudimentary info files output, documented in man -sisu -<h2><a name='sect3' href='#toc3'>Further Information</a></h2> +<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://www.jus.uio.no/sisu/sisu_manual/sisu_pdf/sisu_manifest.html'>http://www.jus.uio.no/sisu/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> - SiSU information Structuring Universe - Search [0.58] <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> + 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>161d3f57a0c3b9e816474243229cb423</i> +<p> Skin_Digest: MD5(/home/ralph/grotto/theatre/dbld/sisu-dev/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)= + +<p><i>20fc43cf3eb6590bc3399a1aef65c5a9</i> +<p> <b>Generated</b> +<p> Document (metaverse) last +generated: <i>Sun</i> Sep 23 01:14:03 +0100 2007 +<p> Generated by: <i>SiSU</i> <i>0.58.3</i> of +2007w36/4 (2007-09-06) +<p> Ruby version: <i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36) + [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.58.3 of 2007w36/4 (2007-09-06) </dt> +<dd></dd> + +<dt>* Ruby version: ruby +1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt> +<dd></dd> + +<dt>* Last Generated on: Sun Sep 23 +01:14:07 +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> -or <i>man</i> sisu -<h2><a name='sect4' href='#toc4'>Author</a></h2> -Ralph Amissah <i><ralph@amissah.com></i> or <i><ralph.amissah@gmail.com></i> - -<h2><a name='sect5' href='#toc5'>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> <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'>Further Information</a></li> -<li><a name='toc4' href='#sect4'>Author</a></li> -<li><a name='toc5' href='#sect5'>See Also</a></li> -</ul> </body> </html> diff --git a/data/doc/sisu/html/sisu_postgresql.7.html b/data/doc/sisu/html/sisu_postgresql.7.html index 90f04be4..5d50eaa3 100644 --- a/data/doc/sisu/html/sisu_postgresql.7.html +++ b/data/doc/sisu/html/sisu_postgresql.7.html @@ -1,95 +1,187 @@ - Universe . Description: sisu postgresql package manpage . arch-tag: sisu -manpage . later . -man -Tascii sisu.1 . most . sisu_postgresql 7 "September 09, -2006" "version 0.46" "sisu -I" <!-- manual page source format generated by PolyglotMan v3.2, --> +<!-- manual page source format generated by PolyglotMan v3.2, --> <!-- available at http://polyglotman.sourceforge.net/ --> <html> <head> -<title>sisu_postgresql(7) manual page</title> +<title>"sisu_postgresql"("1") manual page</title> </head> <body bgcolor='white'> <a href='#toc'>Table of Contents</a><p> +SISU - SISU INFORMATION STRUCTURING UNIVERSE - SEARCH [0.58], RALPH AMISSAH + +<p> SISU SEARCH +<p> SISU POSTGRESQL +<p> 1. POSTGRESQL +<p> 1.1 NAME +<p> <b>SiSU</b> - Structured +information, Serialized Units - a document publishing system, postgresql -<h2><a name='sect0' href='#toc0'>Name</a></h2> -<b>SiSU</b> - Structured information, Serialized -Units - a document publishing system, postgresql dependency package <p> -Dummy -package to install the dependencies required by SiSU to populate a postgresql -database -<h2><a name='sect1' href='#toc1'>Synopsis</a></h2> -<b>sisu</b> <i>-D</i> [instruction] <p> -<i>-d</i> --(sqlite|pg) --[instruction] [filename/wildcard -if required] <p> -<b>sisu</b> <i>--pgsql</i> --[instruction] [filename/wildcard if required] <p> - - -<h2><a name='sect2' href='#toc2'>Description</a></h2> -<b>sisu_postgresql</b> <i>is</i> part of SiSU (man sisu) sisu_postgresql is -a dummy dummy package to install dependencies needed for sisu to populate -a postgresql database, documented in man sisu -<h2><a name='sect3' href='#toc3'>databases</a></h2> +<p>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> 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>dbi - database interface +<dt><b> --pgsql --createall</b> </dt> -<dd><b>-D</b> set for <i>postgresql</i> </dd> +<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) 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 existing -<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) </dd> +<p> database and builds a new empty database structure +<p> </dd> +</dl> +1.4.2 IMPORT AND REMOVE -<dt><b>--pgsql --import -v </b> </dt> -<dd><i>[filename/wildcard]</i> imports data specified to postgresql -db (rb.dbi) </dd> +<p>DOCUMENTS +<p> +<dl> -<dt><b>--pgsql --update -v </b> </dt> -<dd><i>[filename/wildcard]</i> updates/imports specified -data to (postgresql) db (rb.dbi) </dd> +<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>--pgsql --remove -v </b> </dt> -<dd><i>[filename/wildcard]</i> removes -specified data to (postgresql) db (rb.dbi) </dd> +<dt><b> sisu -D --update -v [filename/wildcard]</b> </dt> +<dd>updates -<dt><b>--pgsql --dropall </b> </dt> -<dd>kills data" and -drops (postgresql) db, tables & indexes </dd> +<p>file contents in database +<p> </dd> -<dt><b>--pgsql --recreate </b> </dt> -<dd>kills data" and -drops and rebuilds empty (postgresql) db, tables & </dd> +<dt><b> sisu -D --remove -v [filename/wildcard]</b> </dt> +<dd>removes +specified document from postgresql database. +<p> </dd> </dl> -indexes </blockquote> +DOCUMENT INFORMATION (METADATA) -<h2><a name='sect4' href='#toc4'>Further Information</a></h2> +<p> METADATA +<p> Document Manifest @ <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_postgresql/sisu_manifest.html'>http://www.jus.uio.no/sisu/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> - SiSU information Structuring Universe - Search [0.58] +<p> + DC Creator: <i>Ralph</i> Amissah +<p> DC Rights: <i>Copyright</i> (C) Ralph Amissah 2007, +part of SiSU documentation, License GPL 3 +<p> DC Type: <i>information</i> +<p> DC Date +created: <i>2002-08-28</i> +<p> DC Date issued: <i>2002-08-28</i> +<p> DC Date available: <i>2002-08-28</i> + +<p> DC Date modified: <i>2007-09-16</i> +<p> DC Date: <i>2007-09-16</i> +<p> <b>Version Information</b> + +<p> Sourcefile: <i>sisu_postgresql.sst</i> +<p> Filetype: <i>SiSU</i> text 0.58 +<p> Sourcefile +Digest, MD5(sisu_postgresql.sst)= <i>b81ba44e7946dfaf03d26f0dc5d749ab</i> +<p> Skin_Digest: +MD5(/home/ralph/grotto/theatre/dbld/sisu-dev/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)= + +<p><i>20fc43cf3eb6590bc3399a1aef65c5a9</i> +<p> <b>Generated</b> +<p> Document (metaverse) last +generated: <i>Sun</i> Sep 23 01:14:03 +0100 2007 +<p> Generated by: <i>SiSU</i> <i>0.58.3</i> of +2007w36/4 (2007-09-06) +<p> Ruby version: <i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36) + [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.58.3 of 2007w36/4 (2007-09-06) </dt> +<dd></dd> + +<dt>* Ruby version: ruby +1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt> +<dd></dd> + +<dt>* Last Generated on: Sun Sep 23 +01:14:07 +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> -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='sect5' href='#toc5'>Author</a></h2> -Ralph -Amissah <i><ralph@amissah.com></i> or <i><ralph.amissah@gmail.com></i> -<h2><a name='sect6' href='#toc6'>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_sqlite:7'><b>sisu_sqlite(7)</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'>databases</a></li> -<li><a name='toc4' href='#sect4'>Further Information</a></li> -<li><a name='toc5' href='#sect5'>Author</a></li> -<li><a name='toc6' href='#sect6'>See Also</a></li> -</ul> </body> </html> diff --git a/data/doc/sisu/html/sisu_quickstart.8.html b/data/doc/sisu/html/sisu_quickstart.8.html new file mode 100644 index 00000000..1f657af8 --- /dev/null +++ b/data/doc/sisu/html/sisu_quickstart.8.html @@ -0,0 +1,334 @@ +<!-- manual page source format generated by PolyglotMan v3.2, --> +<!-- available at http://polyglotman.sourceforge.net/ --> + +<html> +<head> +<title>"sisu_quickstart"("1") manual page</title> +</head> +<body bgcolor='white'> +<a href='#toc'>Table of Contents</a><p> +SISU - SISU INFORMATION STRUCTURING UNIVERSE / STRUCTURED INFORMATION, SERIALIZED +UNITS - QUICKSTART, INSTALLATION AND USE, RALPH AMISSAH +<p> QUICKSTART - SISU +INSTALLATION AND USE +<p> 1. QUICKSTART - GETTING STARTED HOWTO +<p> 1.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> 1.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> 1.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> 1.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)[^1] 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> 1.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> 1.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> 1.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> 1.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> 1.3 GETTING HELP +<p> 1.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> +> + [^2] +<p> * sisu.8 <<a href='http://www.jus.uio.no/sisu/man/sisu.8'>http://www.jus.uio.no/sisu/man/sisu.8</a> +> [^3] +<p> * man directory <<a href='http://www.jus.uio.no/sisu/man'>http://www.jus.uio.no/sisu/man</a> +> + [^4] +<p> 1.3.2 BUILT IN HELP +<p> sisu --help +<p> sisu --help --env +<p> sisu --help --commands + +<p> sisu --help --markup +<p> 1.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> 1.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/2.html'>http://www.jus.uio.no/sisu/SiSU/2.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[^5] 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> DOCUMENT INFORMATION +(METADATA) +<p> METADATA +<p> Document Manifest @ <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/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 information Structuring Universe / Structured information, +Serialized Units - Quickstart, installation and use +<p> DC Creator: <i>Ralph</i> + +<p>Amissah +<p> DC Rights: <i>Copyright</i> (C) Ralph Amissah 2007, part of SiSU documentation, + +<p>License GPL 3 +<p> DC Type: <i>information</i> +<p> DC Date created: <i>2006-09-06</i> +<p> DC Date +available: <i>2006-09-06</i> +<p> DC Date issued: <i>2006-09-06</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_quickstart.sst</i> + +<p> Filetype: <i>SiSU</i> text 0.57 +<p> Sourcefile Digest, MD5(sisu_quickstart.sst)= + +<p><i>05a047fd659fbbeaa3cdb982b5911bcd</i> +<p> Skin_Digest: MD5(/home/ralph/grotto/theatre/dbld/sisu-dev/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)= + +<p><i>20fc43cf3eb6590bc3399a1aef65c5a9</i> +<p> <b>Generated</b> +<p> Document (metaverse) last +generated: <i>Sun</i> Sep 23 01:14:00 +0100 2007 +<p> Generated by: <i>SiSU</i> <i>0.58.3</i> of +2007w36/4 (2007-09-06) +<p> Ruby version: <i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36) + [i486-linux] +<p> +<ol> +<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. +<p> </dd> + +<dt>Other versions of +this document: </dt> +<dd></dd> + +<dt>manifest: <<a href='http://www.jus.uio.no/sisu/sisu_quickstart/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_quickstart/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_quickstart/sisu_manifest.html</a> +</a> +> +</dt> +<dd></dd> + +<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_quickstart/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_quickstart/toc.html'>http://www.jus.uio.no/sisu/sisu_quickstart/toc.html</a> +</a> +> </dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_quickstart/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_quickstart/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_quickstart/portrait.pdf</a> +</a> +> +</dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_quickstart/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_quickstart/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_quickstart/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.58.3 of 2007w36/4 (2007-09-06) </dt> +<dd></dd> + +<dt>* Ruby version: ruby +1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt> +<dd></dd> + +<dt>* Last Generated on: Sun Sep 23 +01:14:06 +0100 2007 </dt> +<dd></dd> + +<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> + </dt> +<dd></dd> +</dl> +<p> +</body> +</html> diff --git a/data/doc/sisu/html/sisu_remote.8.html b/data/doc/sisu/html/sisu_remote.8.html new file mode 100644 index 00000000..3f731762 --- /dev/null +++ b/data/doc/sisu/html/sisu_remote.8.html @@ -0,0 +1,187 @@ +<!-- manual page source format generated by PolyglotMan v3.2, --> +<!-- available at http://polyglotman.sourceforge.net/ --> + +<html> +<head> +<title>"sisu_remote"("1") manual page</title> +</head> +<body bgcolor='white'> +<a href='#toc'>Table of Contents</a><p> +SISU - REMOTE OPERATIONS [0.58], RALPH AMISSAH +<p> SISU REMOTE OPERATIONS + +<p> 1. 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/2.html'>http://www.jus.uio.no/sisu/SiSU/2.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 document + +<p>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/2.html'>http://www.jus.uio.no/sisu/SiSU/2.html</a> +> and use the url for the +desired document. +<p> REMOTE DOCUMENT OUTPUT +<p> 2. 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> 2.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> +2.2 CONFIGURATION +<p> [expand on the setting up of an ssh-agent / keychain] + +<p> 3. 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> DOCUMENT INFORMATION (METADATA) +<p> +METADATA +<p> Document Manifest @ <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_remote/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_remote/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> - Remote Operations [0.58] +<p> DC Creator: <i>Ralph</i> Amissah +<p> + DC Rights: <i>Copyright</i> (C) Ralph Amissah 2007, part of SiSU documentation, + +<p>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_remote.sst</i> + +<p> Filetype: <i>SiSU</i> text 0.58 +<p> Sourcefile Digest, MD5(sisu_remote.sst)= <i>5fe0c81eddcd7e3e18608b8e48b3ccad</i> + +<p> Skin_Digest: MD5(/home/ralph/grotto/theatre/dbld/sisu-dev/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)= + +<p><i>20fc43cf3eb6590bc3399a1aef65c5a9</i> +<p> <b>Generated</b> +<p> Document (metaverse) last +generated: <i>Sun</i> Sep 23 01:14:02 +0100 2007 +<p> Generated by: <i>SiSU</i> <i>0.58.3</i> of +2007w36/4 (2007-09-06) +<p> Ruby version: <i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36) + [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_remote/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_remote/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_remote/sisu_manifest.html</a> +</a> +> +</dt> +<dd></dd> + +<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_remote/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_remote/toc.html'>http://www.jus.uio.no/sisu/sisu_remote/toc.html</a> +</a> +> </dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_remote/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_remote/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_remote/portrait.pdf</a> +</a> +> +</dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_remote/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_remote/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_remote/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.58.3 of 2007w36/4 (2007-09-06) </dt> +<dd></dd> + +<dt>* Ruby version: ruby +1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt> +<dd></dd> + +<dt>* Last Generated on: Sun Sep 23 +01:14:07 +0100 2007 </dt> +<dd></dd> + +<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> + </dt> +<dd></dd> +</dl> +<p> +</body> +</html> diff --git a/data/doc/sisu/html/sisu_search.8.html b/data/doc/sisu/html/sisu_search.8.html new file mode 100644 index 00000000..e7ec9e8a --- /dev/null +++ b/data/doc/sisu/html/sisu_search.8.html @@ -0,0 +1,513 @@ +<!-- manual page source format generated by PolyglotMan v3.2, --> +<!-- available at http://polyglotman.sourceforge.net/ --> + +<html> +<head> +<title>"sisu_search"("1") manual page</title> +</head> +<body bgcolor='white'> +<a href='#toc'>Table of Contents</a><p> +SISU - SISU INFORMATION STRUCTURING UNIVERSE - SEARCH [0.58], RALPH AMISSAH + +<p> SISU SEARCH +<p> 1. 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> 2. SQL +<p> 2.1 POPULATING SQL TYPE DATABASES + +<p> <b>SiSU</b> feeds sisu markupd documents into sql type databases PostgreSQL[^1] +and/or SQLite[^2] 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> 3. +POSTGRESQL +<p> 3.1 NAME +<p> <b>SiSU</b> - Structured information, Serialized Units - +a document publishing system, postgresql dependency package +<p> 3.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> 3.3 SYNOPSIS +<p> sisu -D [instruction] [filename/wildcard + if required]<br> + +<p> sisu -D --pg --[instruction] [filename/wildcard if required]<br> + +<p> 3.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> 3.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) 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 existing + +<p> database and builds a new empty database structure +<p> </dd> +</dl> +3.4.2 IMPORT AND REMOVE + +<p>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 + +<p>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> +4. SQLITE +<p> 4.1 NAME +<p> <b>SiSU</b> +- Structured information, Serialized Units - a document publishing system. + +<p> 4.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> 4.3 SYNOPSIS +<p> sisu -d [instruction] [filename/wildcard + if required]<br> + +<p> sisu -d --(sqlite|pg) --[instruction] [filename/wildcard if <br> + required]<br> + +<p> 4.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> 4.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> +4.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> +5. INTRODUCTION +<p> 5.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> +> [^3] 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.[^4] +<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.[^5] +<p> +<dl> + +<dt><b> sisu -F --webserv-webrick</b> </dt> +<dd> builds a cgi web + +<p> search 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> +5.2 SEARCH FORM +<p> +<dl> + +<dt><b> sisu -F</b> </dt> +<dd> generates a sample search form, which must be + copied to which must be copied to +<p> </dd> + +<dt><b> sisu -F --webserv-webrick</b> </dt> +<dd> generates a sample + search form for use with the webrick which must be copied to the web-server + cgi directory which must be copied to the web-server cgi directory +<p> </dd> + +<dt><b> sisu + -Fv</b> </dt> +<dd> as above, and provides some information on setting up +<p> </dd> + +<dt><b> sisu -W</b> </dt> +<dd> starts + +<p> the webrick server which should be available +<p> The generated search form + +<p>must be copied manually to the webserver directory as instructed +<p> </dd> +</dl> +6. 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 Universe"<br> + first directory for inclusion]|[specify second directory for Universe"<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> DOCUMENT +INFORMATION (METADATA) +<p> METADATA +<p> Document Manifest @ <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_search/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_search/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 information Structuring Universe - Search [0.58] +<p> + DC Creator: <i>Ralph</i> Amissah +<p> DC Rights: <i>Copyright</i> (C) Ralph Amissah 2007, +part of SiSU documentation, License GPL 3 +<p> DC Type: <i>information</i> +<p> DC Date +created: <i>2002-08-28</i> +<p> DC Date issued: <i>2002-08-28</i> +<p> DC Date available: <i>2002-08-28</i> + +<p> DC Date modified: <i>2007-09-16</i> +<p> DC Date: <i>2007-09-16</i> +<p> <b>Version Information</b> + +<p> Sourcefile: <i>sisu_search._sst</i> +<p> Filetype: <i>SiSU</i> text insert 0.58 +<p> Sourcefile +Digest, MD5(sisu_search._sst)= <i>52c1d6d3c3082e6b236c65debc733a05</i> +<p> Skin_Digest: +MD5(/home/ralph/grotto/theatre/dbld/sisu-dev/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)= + +<p><i>20fc43cf3eb6590bc3399a1aef65c5a9</i> +<p> <b>Generated</b> +<p> Document (metaverse) last +generated: <i>Sun</i> Sep 23 01:14:04 +0100 2007 +<p> Generated by: <i>SiSU</i> <i>0.58.3</i> of +2007w36/4 (2007-09-06) +<p> Ruby version: <i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36) + [i486-linux] +<p> +<ol> +<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> +><br> + <<a href='http://en.wikipedia.org/wiki/Postgresql'>http://en.wikipedia.org/wiki/Postgresql</a> +><br> + </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> +><br> + </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. + +<p> </dd> + +<dt>Other versions of this document: </dt> +<dd></dd> + +<dt>manifest: <<a href='http://www.jus.uio.no/sisu/sisu_search/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_search/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_search/sisu_manifest.html</a> +</a> +> +</dt> +<dd></dd> + +<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_search/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_search/toc.html'>http://www.jus.uio.no/sisu/sisu_search/toc.html</a> +</a> +> </dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_search/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_search/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_search/portrait.pdf</a> +</a> +> +</dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_search/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_search/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_search/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.58.3 of 2007w36/4 (2007-09-06) </dt> +<dd></dd> + +<dt>* Ruby version: ruby +1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt> +<dd></dd> + +<dt>* Last Generated on: Sun Sep 23 +01:14:07 +0100 2007 </dt> +<dd></dd> + +<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> + </dt> +<dd></dd> +</dl> +<p> +</body> +</html> diff --git a/data/doc/sisu/html/sisu_skin.1.html b/data/doc/sisu/html/sisu_skin.1.html new file mode 100644 index 00000000..87f2366e --- /dev/null +++ b/data/doc/sisu/html/sisu_skin.1.html @@ -0,0 +1,164 @@ +<!-- manual page source format generated by PolyglotMan v3.2, --> +<!-- available at http://polyglotman.sourceforge.net/ --> + +<html> +<head> +<title>"sisu_skin"("1") manual page</title> +</head> +<body bgcolor='white'> +<a href='#toc'>Table of Contents</a><p> +SISU - SKINS [0.58], RALPH AMISSAH +<p> DOCUMENT SKINS - CONFIGURATION +<p> 1. 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> 1.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> 1.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> 1.3 SITE SKIN +<p> A site skin, modifies the program default skin. +<p> 1.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> DOCUMENT INFORMATION (METADATA) +<p> METADATA +<p> Document Manifest @ <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_skin/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_skin/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> - Skins [0.58] +<p> DC Creator: <i>Ralph</i> Amissah +<p> DC Rights: +<i>Copyright</i> (C) Ralph Amissah 2007, part of SiSU documentation, License GPL + +<p>3 +<p> DC Type: <i>information</i> +<p> DC Date created: <i>2002-11-12</i> +<p> DC Date issued: + +<p><i>2002-11-12</i> +<p> DC Date available: <i>2002-11-12</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_skin.sst</i> +<p> Filetype: + +<p><i>SiSU</i> text insert 0.58 +<p> Sourcefile Digest, MD5(sisu_skin.sst)= <i>3686b1b7864132c8d6ab3b0398d6e2ae</i> + +<p> Skin_Digest: MD5(/home/ralph/grotto/theatre/dbld/sisu-dev/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)= + +<p><i>20fc43cf3eb6590bc3399a1aef65c5a9</i> +<p> <b>Generated</b> +<p> Document (metaverse) last +generated: <i>Sun</i> Sep 23 01:13:59 +0100 2007 +<p> Generated by: <i>SiSU</i> <i>0.58.3</i> of +2007w36/4 (2007-09-06) +<p> Ruby version: <i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36) + [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_skin/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_skin/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_skin/sisu_manifest.html</a> +</a> +> +</dt> +<dd></dd> + +<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_skin/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_skin/toc.html'>http://www.jus.uio.no/sisu/sisu_skin/toc.html</a> +</a> +> </dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_skin/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_skin/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_skin/portrait.pdf</a> +</a> +> +</dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_skin/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_skin/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_skin/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.58.3 of 2007w36/4 (2007-09-06) </dt> +<dd></dd> + +<dt>* Ruby version: ruby +1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt> +<dd></dd> + +<dt>* Last Generated on: Sun Sep 23 +01:14:06 +0100 2007 </dt> +<dd></dd> + +<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> + </dt> +<dd></dd> +</dl> +<p> +</body> +</html> diff --git a/data/doc/sisu/html/sisu_sqlite.7.html b/data/doc/sisu/html/sisu_sqlite.7.html index 4d85c37b..139501b2 100644 --- a/data/doc/sisu/html/sisu_sqlite.7.html +++ b/data/doc/sisu/html/sisu_sqlite.7.html @@ -1,91 +1,185 @@ - <!-- manual page source format generated by PolyglotMan v3.2, --> +<!-- manual page source format generated by PolyglotMan v3.2, --> <!-- available at http://polyglotman.sourceforge.net/ --> <html> <head> -<title>sisu_sqlite(7) manual page</title> +<title>"sisu_sqlite"("1") manual page</title> </head> <body bgcolor='white'> <a href='#toc'>Table of Contents</a><p> +SISU - SISU INFORMATION STRUCTURING UNIVERSE - SEARCH [0.58], RALPH AMISSAH + +<p> SISU SEARCH +<p> SISU SQLITE +<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 -<h2><a name='sect0' href='#toc0'>Name</a></h2> -<b>SiSU</b> - Structured information, Serialized Units - a document -publishing system, sqlite dependency package <p> -This is a dummy package to -install the dependencies required by SiSU to populate an sqlite database - -<h2><a name='sect1' href='#toc1'>Synopsis</a></h2> -<b>sisu</b> <i>-d</i> [instruction] [filename/wildcard if required] <p> -<b>sisu</b> <i>-d</i> --(sqlite|pg) ---[instruction] [filename/wildcard if required] <p> +<p>SYNOPSIS +<p> sisu -d [instruction] [filename/wildcard if required]<br> -<h2><a name='sect2' href='#toc2'>Description</a></h2> -<b>sisu_sqlite</b> <i>is</i> -part of SiSU (man sisu) sisu_sqlite is a dummy package to install dependencies -needed for sisu to populate an sqlite database, documented in man sisu +<p> sisu -d --(sqlite|pg) --[instruction] [filename/wildcard if <br> + required]<br> -<h2><a name='sect3' href='#toc3'>databases</a></h2> - +<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>dbi - database interface </dt> -<dd><b>-d</b> set for <i>sqlite</i> </dd> +<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>--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) </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>--sqlite --import -v </b> </dt> -<dd><i>[filename/wildcard]</i> -imports data specified to (sqlite) db (rb.dbi) </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>--sqlite --update -v </b> </dt> -<dd><i>[filename/wildcard]</i> -updates/imports specified data to (sqlite) db (rb.dbi) </dd> +<dt><b> sisu -d --recreate</b> </dt> +<dd> destroys -<dt><b>--sqlite --remove -v </b> -</dt> -<dd><i>[filename/wildcard]</i> removes specified data to (sqlite) db (rb.dbi) </dd> +<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>--sqlite ---dropall </b> </dt> -<dd>kills data" and drops (postgresql) db, tables & indexes </dd> +<dt><b> sisu -d --update -v [filename/wildcard]</b> </dt> +<dd>updates -<dt><b>--sqlite ---recreate </b> </dt> -<dd>kills data" and drops and rebuilds empty (postgresql) db, tables -& </dd> +<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> -indexes </blockquote> +DOCUMENT INFORMATION (METADATA) -<h2><a name='sect4' href='#toc4'>Further Information</a></h2> +<p> METADATA +<p> Document Manifest @ <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_sqlite/sisu_manifest.html'>http://www.jus.uio.no/sisu/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> - SiSU information Structuring Universe - Search [0.58] <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> + 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 0.58 +<p> Sourcefile Digest, +MD5(sisu_sqlite.sst)= <i>61ba58f6a2f5cc9651b985a8eabb96e9</i> +<p> Skin_Digest: MD5(/home/ralph/grotto/theatre/dbld/sisu-dev/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)= + +<p><i>20fc43cf3eb6590bc3399a1aef65c5a9</i> +<p> <b>Generated</b> +<p> Document (metaverse) last +generated: <i>Sun</i> Sep 23 01:14:03 +0100 2007 +<p> Generated by: <i>SiSU</i> <i>0.58.3</i> of +2007w36/4 (2007-09-06) +<p> Ruby version: <i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36) + [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.58.3 of 2007w36/4 (2007-09-06) </dt> +<dd></dd> + +<dt>* Ruby version: ruby +1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt> +<dd></dd> + +<dt>* Last Generated on: Sun Sep 23 +01:14:07 +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> -or <i>man</i> sisu -<h2><a name='sect5' href='#toc5'>Author</a></h2> -Ralph Amissah <i><ralph@amissah.com></i> or <i><ralph.amissah@gmail.com></i> - -<h2><a name='sect6' href='#toc6'>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_postgresql:7'><b>sisu_postgresql(7)</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'>databases</a></li> -<li><a name='toc4' href='#sect4'>Further Information</a></li> -<li><a name='toc5' href='#sect5'>Author</a></li> -<li><a name='toc6' href='#sect6'>See Also</a></li> -</ul> </body> </html> diff --git a/data/doc/sisu/html/sisu_syntax_highlighting.8.html b/data/doc/sisu/html/sisu_syntax_highlighting.8.html new file mode 100644 index 00000000..337b8a4b --- /dev/null +++ b/data/doc/sisu/html/sisu_syntax_highlighting.8.html @@ -0,0 +1,218 @@ +<!-- manual page source format generated by PolyglotMan v3.2, --> +<!-- available at http://polyglotman.sourceforge.net/ --> + +<html> +<head> +<title>"sisu_syntax_highlighting"("1") manual page</title> +</head> +<body bgcolor='white'> +<a href='#toc'>Table of Contents</a><p> +SISU - SYNTAX HIGHLIGHTING [0.58], RALPH AMISSAH +<p> SISU SYNTAX HIGHLIGHTING + +<p> 1. 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}::<br> + <b> SiSU</b> ] +<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</b> 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> DOCUMENT INFORMATION (METADATA) +<p> METADATA +<p> Document Manifest +@ <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_syntax_highlighting/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_syntax_highlighting/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> - Syntax Highlighting [0.58] +<p> DC Creator: <i>Ralph</i> Amissah + +<p> DC Rights: <i>Copyright</i> (C) Ralph Amissah 2007, part of SiSU documentation, + +<p>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: <i>2002-11-12</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_syntax_highlighting.sst</i> + +<p> Filetype: <i>SiSU</i> text insert 0.58 +<p> Sourcefile Digest, MD5(sisu_syntax_highlighting.sst)= + +<p><i>1dfe1975df71459c3f56c3fd13c5789c</i> +<p> Skin_Digest: MD5(/home/ralph/grotto/theatre/dbld/sisu-dev/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)= + +<p><i>20fc43cf3eb6590bc3399a1aef65c5a9</i> +<p> <b>Generated</b> +<p> Document (metaverse) last +generated: <i>Sun</i> Sep 23 01:14:02 +0100 2007 +<p> Generated by: <i>SiSU</i> <i>0.58.3</i> of +2007w36/4 (2007-09-06) +<p> Ruby version: <i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36) + [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_syntax_highlighting/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_syntax_highlighting/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_syntax_highlighting/sisu_manifest.html</a> +</a> +> +</dt> +<dd></dd> + +<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_syntax_highlighting/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_syntax_highlighting/toc.html'>http://www.jus.uio.no/sisu/sisu_syntax_highlighting/toc.html</a> +</a> +> </dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_syntax_highlighting/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_syntax_highlighting/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_syntax_highlighting/portrait.pdf</a> +</a> +> +</dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_syntax_highlighting/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_syntax_highlighting/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_syntax_highlighting/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.58.3 of 2007w36/4 (2007-09-06) +</dt> +<dd></dd> + +<dt>* Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt> +<dd></dd> + +<dt>* Last Generated +on: Sun Sep 23 01:14:07 +0100 2007 </dt> +<dd></dd> + +<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> + </dt> +<dd></dd> +</dl> +<p> +</body> +</html> diff --git a/data/doc/sisu/html/sisu_vim.7.html b/data/doc/sisu/html/sisu_vim.7.html index f0c475c5..cb9a2cad 100644 --- a/data/doc/sisu/html/sisu_vim.7.html +++ b/data/doc/sisu/html/sisu_vim.7.html @@ -1,60 +1,144 @@ - <!-- manual page source format generated by PolyglotMan v3.2, --> +<!-- manual page source format generated by PolyglotMan v3.2, --> <!-- available at http://polyglotman.sourceforge.net/ --> <html> <head> -<title>vim_sisu(7) manual page</title> +<title>"sisu_vim"("1") manual page</title> </head> <body bgcolor='white'> <a href='#toc'>Table of Contents</a><p> +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 which may be used for earlier versions +of Vim). +<p> sisu-vim actions are activated on files with the suffix .sst .ssm +.ssi .-sst +<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> +> -<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> -An ftplugin to provide vim folds for SiSU markup, -and to set some defaults for SiSU markup in installed by sisu. <p> -Vim 7 includes -sisu markup syntax highlighting. <p> -Vim related files are included in /usr/share/sisu/vim/addons, -(including the syntax highlighter which may be used by Vim 6). <p> -sisu-vim actions -are activated on files with the suffix .sst .ssm .ssi .-sst ._sst (and the same -with a further .meta extension) <p> -<b><ctrl>F</b> activate folds on headings matched -in a document (also provides folds when sourced on a ruby program file), -also <b>:F</b> <p> -<b><ctrl>S</b> search and replace down <p> -<b><ctrl>G</b> search and replace globally -within file <p> -<b><ctrl>X</b> ruby regex global search and replace within file <p> -<b><ctrl>C</b> -set color scheme to <b>slate</b> which is provided -<h2><a name='sect2' href='#toc2'>Further Information</a></h2> +<p> or man sisu +<p> DOCUMENT INFORMATION (METADATA) +<p> METADATA +<p> Document Manifest +@ <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_vim/sisu_manifest.html'>http://www.jus.uio.no/sisu/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 2007, part of SiSU documentation, License GPL 3 +<p> DC Type: + +<p><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: <i>2002-11-12</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_vim.sst</i> +<p> Filetype: <i>SiSU</i> text insert + +<p>0.58 +<p> Sourcefile Digest, MD5(sisu_vim.sst)= <i>a3db74eebef04815aa234d3c3b17f375</i> + +<p> Skin_Digest: MD5(/home/ralph/grotto/theatre/dbld/sisu-dev/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)= + +<p><i>20fc43cf3eb6590bc3399a1aef65c5a9</i> +<p> <b>Generated</b> +<p> Document (metaverse) last +generated: <i>Sun</i> Sep 23 01:14:04 +0100 2007 +<p> Generated by: <i>SiSU</i> <i>0.58.3</i> of +2007w36/4 (2007-09-06) +<p> Ruby version: <i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36) + [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.58.3 of 2007w36/4 (2007-09-06) </dt> +<dd></dd> + +<dt>* Ruby version: ruby +1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt> +<dd></dd> + +<dt>* Last Generated on: Sun Sep 23 +01:14:07 +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> -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 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)</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'>Further Information</a></li> -<li><a name='toc3' href='#sect3'>Author</a></li> -<li><a name='toc4' href='#sect4'>See Also</a></li> -</ul> </body> </html> diff --git a/data/doc/sisu/html/sisu_webrick.1.html b/data/doc/sisu/html/sisu_webrick.1.html index 917c176d..9c6fa2f0 100644 --- a/data/doc/sisu/html/sisu_webrick.1.html +++ b/data/doc/sisu/html/sisu_webrick.1.html @@ -1,69 +1,157 @@ - <!-- manual page source format generated by PolyglotMan v3.2, --> +<!-- manual page source format generated by PolyglotMan v3.2, --> <!-- available at http://polyglotman.sourceforge.net/ --> <html> <head> -<title>sisu_webrick(1) manual page</title> +<title>"sisu_webrick"("1") manual page</title> </head> <body bgcolor='white'> <a href='#toc'>Table of Contents</a><p> +SISU - SISU_WEBRICK [0.58], RALPH AMISSAH +<p> SISU WEBRICK +<p> 1. SISU_WEBRICK + +<p> 1.1 NAME +<p> <b>SiSU</b> - Structured information, Serialized Units - a document -<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_webrick</b> <i>[port]</i> <p> -or <p> -<b>sisu</b> <b>-W</b> <i>[port]</i> -<h2><a name='sect2' href='#toc2'>Description</a></h2> -<b>sisu_webrick</b> -<i>is</i> part of SiSU (man sisu) sisu_webrick starts Ruby’s Webrick web-server -and points it to the directories to which <i>SiSU</i> output is written, providing -a list of these directories (assuming <i>SiSU</i> 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: <i>~/.sisu/sisurc.yaml</i> a sample of which is provided as <i>/etc/sisu/sisurc.yaml</i> -(or in the equivalent directory on your system). -<h2><a name='sect3' href='#toc3'>Summary of man page</a></h2> -<p> -sisu_webrick, -may be started on it’s own with the command: <b>sisu_webrick</b> <i>[port]</i> or using -the sisu command with the -W flag: <b>sisu -W</b> <i>[port]</i> <p> -where no port is given -and settings are unchanged the default port is 8081 -<h2><a name='sect4' href='#toc4'>Document Processing -Command Flags</a></h2> -<p> -<b>sisu</b><i> -W</i><b> [port]</b> starts Ruby Webrick web-server, serving <i>SiSU</i> output -directories, on the port provided, or if no port is provided and the defaults -have not been changed in <i>~/.sisu/sisurc.yaml</i> then on port 8081 -<h2><a name='sect5' href='#toc5'>Further Information</a></h2> +<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://www.jus.uio.no/sisu/sisu_manual/sisu_webrick/sisu_manifest.html'>http://www.jus.uio.no/sisu/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 [0.58] +<p> DC Creator: <i>Ralph</i> Amissah +<p> DC Rights: +<i>Copyright</i> (C) Ralph Amissah 2007, part of SiSU documentation, License GPL + +<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>d288c50a18a6d7464fdb3413479b8b98</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>Sun</i> Sep 23 01:14:00 + +<p>+0100 2007 +<p> Generated by: <i>SiSU</i> <i>0.58.3</i> of 2007w36/4 (2007-09-06) +<p> Ruby version: +<i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36) [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.58.3 of 2007w36/4 (2007-09-06) </dt> +<dd></dd> + +<dt>* Ruby version: ruby +1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt> +<dd></dd> + +<dt>* Last Generated on: Sun Sep 23 +01:14:06 +0100 2007 </dt> +<dd></dd> + +<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> + </dt> +<dd></dd> +</dl> <p> -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_vim:7'><b>sisu_vim(7)</b></a> - -<a href='http:~/bin/man2html?sisu:8'><b>sisu(8)</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'>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/sisu_markup_samples/README.samples b/data/doc/sisu/sisu_markup_samples/README.samples index 56ec4c21..fe068333 100644 --- a/data/doc/sisu/sisu_markup_samples/README.samples +++ b/data/doc/sisu/sisu_markup_samples/README.samples @@ -1,9 +1,15 @@ -Document samples for sisu processing are contained in the sub-directory -./dfsg and if it exists ./non-free +Document samples for sisu processing are contained in the sub-directories +* ./dfsg +* ./sisu_manual +and if it exists +* ./non-free DFSG stands for Debian Free Software Guidelines. -Sample documents in the dfsg directory should comply with the guidelines. +* sample documents in the dfsg directory should comply with the guidelines. -The non-free directory if it exists contains document samples that do not or -may not comply with the DFSG. +* the SiSU manual has (for convenience) been placed in a separate sub-directory + of its own, the license for these is GPL 3 + +* the non-free directory if it exists contains document samples that do not or + may not comply with the DFSG. diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/Rantfile b/data/doc/sisu/sisu_markup_samples/sisu_manual/Rantfile new file mode 100644 index 00000000..8d02220c --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/Rantfile @@ -0,0 +1,332 @@ +#!/usr/bin/env ruby +raise "Please, use ruby1.8.0 or later." if RUBY_VERSION < "1.8.0" +##!/usr/bin/ruby1.9 +#raise "Please, use ruby1.9.0 or later." if RUBY_VERSION < "1.9.0" +=begin + Rantfile mapping setup.rb directory structure + + SiSU Simple information Structuring Universe, Serialised information, Structured Units + * SiSU at present is for the Linux/Unix platform + * See homepage at: << http://www.jus.uio.no/sisu/SiSU >> + * & << http://www.jus.uio.no/sisu/download >> + * & << http://www.jus.uio.no/sisu/development >> + + Rant is a Ruby 'ant' by Stefan Lang + + For Setup/Installation SiSU uses either: + * Minero Aoki's setup.rb, provided along with SiSU, or + * Rant which may be downloaded and installed from: + http://make.rubyforge.org/ + + * Name: Rant install/setup file for SiSU - Simple information Structuring Universe, Serialised information Structured Units + * + * Author: Ralph@Amissah.com + * Description: Rant install/setup file which maps directory structure used by setup.rb + * arch-tag: Rant install/setup file which maps directory structure used by setup.rb + * $Id: Rantfile,v 1.2 2006/01/24 01:55:35 ralph Exp ralph $ + + Copyright (C) 2005 Ralph Amissah (first release edition) + Copyright (C) 1997 Ralph Amissah (first edition) + + * SiSU is released under a dual License: Dual License: + (i) GPL 2 or later, for non-commercial use of the program and + publications + + (ii) Distributed under a commercial license for everything else, + (terms to be determined), that is for everything that is not (i) + + Summary of GPL 2 + + This program is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License as published by the Free + Software Foundation; either version 2 of the License, or (at your option) + any later version. + + This program is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., 59 + Temple Place, Suite 330, Boston, MA 02111-1307 USA + + If you have Internet connection, the latest version of the GPL should be + available at these locations: + http://www.fsf.org/licenses/gpl.html + http://www.gnu.org/copyleft/gpl.html + http://www.jus.uio.no/sisu/gpl2.fsf + + SiSU was first released to the public on January 4th 2005 + + SiSU uses: + + * Standard SiSU markup syntax, + * Standard SiSU meta-markup syntax, and the + * Standard SiSU object citation numbering and system + + * Ralph Amissah 1997, current 2005. + All Rights Reserved. + + * Ralph Amissah mailto:ralph@amissah.com + Ralph Amissah mailto:amissah@gmail.com + + * NOTE reminder to create independent setup file called install: + rant-import --auto install + then you can, as root (for default action): + ruby install + or for help on alternative actions: + ruby install help + ruby install -T + +=end +#% produce a makefile suitable for the target platform +require 'rbconfig' +require 'date' +require 'find' +require 'fileutils' +require 'rbconfig.rb' +include FileUtils::Verbose +pf='rant/plugin/postfix.rb' +if File.file?(pf) + require pf + include Post + @postfix=true +else @postfix=false +end +@dir=Hash.new +@proj=Hash.new +@proj[:name]='SiSU' +@proj[:rant]="Rantfile for the darcs-buildpackage debianisation of #{@proj[:name]}" +@dir[:proj]='sisu' +@dir[:proj_eg]='sisu-examples' +@dir_sisu_description='/home/ralph/grotto/theatre/scribe/sisu/sisu-description/sisu' +@dir_sisu_document_samples='/home/ralph/grotto/theatre/scribe/sisu/sisu-document-samples/sisu' +@dt=Date.today.to_s +@t=Time.now +day=if @t.day.to_s =~/^(\d)$/; "0#{$1}" +else @t.day.to_s +end +month=if @t.month.to_s =~/^(\d)$/; "0#{$1}" +else @t.month.to_s +end +@ymd="#{@t.year}#{month}#{day}" +@w=@t.strftime("%W") +@weekonly=@w +@week="#{@t.year}w#@w" +@monthonly=month +@month="#{@t.year}#{@t.month}" +@year=@t.year +d=@t.wday +@week_stamp="#{@t.year}w#@w" +#@week_stamp=@t.strftime("%Yw%W") +@week_slash_day="#@week_stamp/#{d}" +@week_dash_day="#@week_stamp-#{d}" +@host=Config::CONFIG['host'] +@pwd=Dir.pwd +@dir[:arch]=Config::CONFIG['archdir'] +@dir[:sitearch]=Config::CONFIG['sitearchdir'] +@dir[:bin]=Config::CONFIG['bindir'] +@dir[:lib]=Config::CONFIG['sitelibdir'] +@dir[:data]=Config::CONFIG['datadir'] +@dir[:conf]=Config::CONFIG['sysconfdir'] #etc +@dir[:man]=Config::CONFIG['mandir'] +@dir[:out]="#{Config::CONFIG['localstatedir']}/#{@dir[:proj]}" +@rubylib=Config::CONFIG['LIBRUBYARG_SHARED'] +@home=ENV['HOME'] +m=/.+\/(\S+)/m +@stub_pwd ||=@pwd[m,1] +prcss_dir='_sisu_processing' +prcss_dir_stub="#{prcss_dir}/#{@stub_pwd}" +def filelist_array_all + pwd=Dir.pwd + files=Dir.glob("*.ss[tm]") + files +end +def files_all + file_array=filelist_array_all + files=file_array.join(' ') + files +end +def filelist_docs + files='sisu_manual.ssm sisu_introduction.sst sisu_help.sst sisu_help_sources.sst sisu_commands.sst sisu_markup.sst sisu_filetypes.sst sisu_config.ssi sisu_skin.sst sisu_css.ssi sisu_content_directories.ssi sisu_homepages.ssi sisu_examples.sst sisu_output_overview.sst sisu_search.sst sisu_webrick.sst sisu_quickstart.sst sisu_faq.sst sisu_syntax_highlighting.sst sisu_configuration.ssm sisu_description.sst sisu_remote.sst sisu_complete.sst sisu_postgresql.sst sisu_sqlite.sst sisu_pdf.sst sisu_search.ssm sisu_vim.sst' # sisu_output_types.ssm sisu_sql.sst sisu_hyperestraier.sst sisu_latex.sst sisu_odf.sst sisu_xml.sst sisu_concordance.sst sisu_document_digest_certificate.sst document_digest_certificate.sst sisu_markup_source.sst sisupod.sst + files +end +def filelist_manpage + files='sisu.ssm sisu_introduction.sst sisu_help.sst sisu_help_sources.sst sisu_commands.sst sisu_markup.sst sisu_filetypes.sst sisu_config.ssi sisu_skin.sst sisu_css.ssi sisu_content_directories.ssi sisu_homepages.ssi sisu_examples.ssi sisu_output_overview.sst sisu_search.ssi sisu_webrick.sst sisu_download.ssi sisu_installation.ssi sisu_quickstart.sst sisu_howto.sst sisu_faq.sst sisu_syntax_highlighting.sst sisu_configuration.ssm sisu_remote.sst sisu_complete.sst sisu_postgresql.sst sisu_sqlite.sst sisu_pdf.sst sisu_search.ssm sisu_vim.sst' # sisu_output_types.ssm sisu_sql.sst sisu_hyperestraier.sst sisu_latex.sst sisu_odf.sst sisu_xml.sst sisu_concordance.sst sisu_document_digest_certificate.sst document_digest_certificate.sst sisu_markup_source.sst sisupod.sst + #puts files + "\n\n" + files +end +def man_section(files_array,man_no='1') + path_man_sisu_output='../../sisu_manual/man' + path_man_sisu_package='../../../../../man' + files_array.each do |x| + y=x.gsub(/(\S+?)\.1$/,"\\1.#{man_no}") + unless man_no =~/^1$/ + system("mv -v #{path_man_sisu_output}/#{x} #{path_man_sisu_output}/#{y}") + end + system("cp -v #{path_man_sisu_output}/#{y} #{path_man_sisu_package}/man#{man_no}/#{y}") + end +end +def manpage_move +# ../../sisu_manual/man + files_man1=['sisu.1','sisu_commands.1','sisu_markup.1','sisu_configuration.1','sisu_webrick.1','sisu_help.1','sisu_help_sources.1','sisu_skin.1'] + files_man7=['sisu_complete.1','sisu_postgresql.1','sisu_sqlite.1','sisu_pdf.1', 'sisu_vim.1'] # 'sisu_output_types.1' 'sisu_sql.1', 'sisu_hyperestraier.1', 'sisu_latex.1', 'sisu_odf.1', 'sisu_xml.1', 'sisu_concordance.1', 'sisu_document_digest_certificate.1', 'sisu_markup_source.1', 'sisupod.1' + files_man8=['sisu_quickstart.1','sisu_howto.1','sisu_faq.1','sisu_syntax_highlighting.1','sisu_remote.1','sisu_search.1'] + man_section(files_man1,'1') + man_section(files_man7,'7') + man_section(files_man8,'8') +end +def files_array_docs + file_array=filelist_docs.scan(/\S+?\.ss[mt]/) + file_array +end +def files_docs + file_array=files_array_docs + files=file_array.join(' ') + files +end +def files_array_manpage + file_array=filelist_manpage.scan(/\S+?\.ss[mt]/) + file_array +end +def files_manpage + file_array=files_array_manpage + files=file_array.join(' ') + files +end +def manual + puts files_docs + system("sisu -3sS #{files_docs}") +end +def manual_rsync + file_array=files_array_docs + puts file_array.join(' ') + file_array.each do |x| + puts %{sisu -3sS #{x}; sisu -R #{x} &} + system("sisu -3sS #{x}; sisu -R #{x} & ") + end +end +def manpages + puts files_manpage + system("sisu -iv #{files_manpage}") +end +def search_update + file_array=filelist_search.scan(/\S+/) + file_array.each do |x| + puts %{sisu -Dv --update #{x}} + system("sisu -Dv --update #{x}") + end +end +def search_update_sisu + file_array=filelist_search_sisu.scan(/\S+/) + file_array.each do |x| + puts %{sisu -Dv --update #{x}} + system("sisu -Dv --update #{x}") + end +end +def clean + system("rm *._sst footnote_conversion_errors.txt .*.swp") + #system("rm footnote_conversion_errors.txt .*.swp") +end +def zap(filelist) + system("sisu -Z #{filelist}") +end +#% Help etc. +def rant_system_info + puts <<WOK + Host + host: #@host + arch: #{@dir[:arch]} + sitearch: #{@dir[:sitearch]} + + Directories for installation + bin: #{@dir[:bin]} + lib (site-ruby): #{@dir[:lib]}/#{@dir[:proj]}/#{Version} + conf [etc]: #{@dir[:conf]}/#{@dir[:proj]} + data (document samples, images, README): #{@dir[:data]}/#{@dir[:proj]} and #{@dir[:data]}/doc/#{@dir[:proj]} + man (manual pages): #{@dir[:man]} + output: #{@dir[:out]} + processing: #{@dir[:out]}/processing + www: #{@dir[:out]}/www + + rubylib: #@rubylib + +WOK +end +def rant_help + puts <<WOK + +#{@proj[:name]} + #{@proj[:rant]} + +Commands quick start list + + #{@proj[:name]} Rant Help: (This Rantfile uses the same directory structure as setup.rb) + rant -T # a task list, (generated by Rant) for more complete and up to date help + rant system # system info used + +For a more detailed and up to date list of command options use + + rant -T + +WOK +end + #% tasks +desc 'generate and place all pages' +task :gen => [:gen] +desc 'sisu manual' +task :manual => [:manual] +desc 'sisu man pages' +task :manpages => [:manpages] +desc 'place sisu man pages' +task :manpage_mv => [:manpage_mv] +desc 'list of files' +task :files => [:filelist] +desc 'list of manual files' +task :files_docs => [:filelist_docs] +desc 'list of manpage files' +task :files_man => [:filelist_manpage] +desc 'remove output, -Z zap' +task :zap => [:filelists_zap] +desc 'help' +task :help => [:help] +task :pwd => [:pwd] +task :files_all => [:filelist_all] +task :gen do + zap(files_all) + manual + manpages + manpage_move + clean +end +task :manpages do + manpages + clean +end +task :manpage_mv do + manpage_move +end +task :manual do + manual + clean +end +task :filelist do + puts filelist_docs + "\n\n" + files_docs + "\n\n" + filelist_manpage + "\n\n" + files_manpage +end +task :filelist_manpage do + puts filelist_manpage +end +task :filelist_docs do + puts filelist_docs +end +task :filelist_all do + puts files_all +end +task :filelists_zap do + zap(files_all) +end +task :help do + rant_help +end +__END__ diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/home/index.html b/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/home/index.html new file mode 100644 index 00000000..70601ea0 --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/home/index.html @@ -0,0 +1,250 @@ +<!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= +"document structuring, ebook, publishing, PDF, LaTeX, XML, ODF, SQL, postgresql, sqlite, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, granular 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.58.3 of 2007w36/4 (2007-09-06) (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="top_band_search"> +<!-- SiSU Search --> +<a name="search"></a><form method="get" action="http://search.sisudoc.org" target="_top"> +<input type="text" name="s1" size="24" maxlength="255" /> +<br /> +<input type="submit" name="ignore" value="search" /> +<input type="hidden" name="db" value="SiSU_sisu" /> +<input type="radio" name="view" value="index" checked="checked" /> idx +<input type="radio" name="view" value="text" /> txt +</form> +<!-- SiSU Search --> +</div> +<div id="column_left"> +<p class="small"> + <a href="./sisu_markup/index.html" target="_top" > + SiSU markup + </a> +</p> +<p class="small"> + <a href="./sisu_commands/index.html" target="_top" > + SiSU commands + </a> +</p> +<p class="tiny"> + --- +</p> +<p class="tiny"> + online +</p> +<p class="bold"> + <a href="http://www.jus.uio.no/sisu/SiSU" target="_top" > + SiSU + </a> +</p> +<p class="small"> + <a href="http://www.jus.uio.no/sisu/SiSU/download.html" target="_top" > + SiSU download + </a> +</p> +</div> +<div id="column_center"> +<p class="bold"> + For less markup than the most elementary HTML you can have 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, publishing and search framework with the following features:</p> +<p> +<b>(i)</b> markup syntax: +<b>(a)</b> +simpler than html, +<b>(b)</b> +mnemonic, influenced by mail/messaging/wiki markup practices, +<b>(c)</b> human readable, and easily writable,</p> +<p><b>(ii)</b> +<b>(a)</b> +minimal markup requirement, +<b>(b)</b> +single file marked up for multiple outputs,</p> +<p><b> +notes +</b></p> +<p class="small"> +<b>*</b> +documents are prepared in a single UTF-8 file using a minimalistic mnemonic syntax. Typical literature, documents like "War and Peace" require almost no markup, and most of the headers are optional. +</p> +<p class="small"> +<b>*</b> +markup is easily readable/parsed 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> +<p class="small"> +<b>*</b> +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. +</p> +<p><b>(iii)</b> +<b>(a)</b> +multiple outputs primarily industry established and institutionally accepted open standard formats, include amongst others: plaintext (UTF-8); html; (structured) XML; ODF (Open Document text)l; LaTeX; PDF (via LaTeX); SQL type databases (currently PostgreSQL and SQLite). Also produces: concordance files; document content certificates (md5 or sha256 digests of headings, paragraphs, images etc.) and html manifests (and sitemaps of content). + +<b>(b) +</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> +<p><b>(iv)</b> +outputs share a common numbering system (dubbed "object citation numbering" (ocn)) that is meaningful (to man and machine) across various digital outputs whether paper, screen, or database oriented, (PDF, html, XML, sqlite, postgresql), this numbering system can be used to reference content.</p> +<p> +<b>(v)</b> +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 hyperesteier].</p> +<p> +<b>(vi)</b> + use of semantic meta-tags in headers permit the addition of semantic information on documents, (the available fields are easily extended)</p> +<p> +<b>(vii)</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 (e.g. 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>(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: +<b>(a)</b> +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>(b)</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> +prepared files may be batch process, documents produced are static files so 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> +<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> +there is a considerable degree of future-proofing, output representations are "upgradeable", and new document formats may be added. +</p> +<p> +<b>(xv)</b> +there is a considerable degree of future-proofing, output representations are "upgradeable", and new document formats may be added: +<b>(a)</b> +modular, (thanks in no small part to Ruby) another output format required, write another module.... +<b>(b)</b> easy to update output formats (eg html, XHTML, LaTeX/PDF produced can be updated in program and run against whole document set), +<b>(c)</b> 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 (ext3, Reiserfs, XFS, whatever) 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> +Syntax highlighting for SiSU markup is available for a number of text editors.</p> +<p><b>(xx)</b> remote operations: +<b>(a)</b> +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>(b)</b> +generated document outputs may be posted by sisu to remote sites (using rsync/scp) +<b>(c)</b> +document source (plaintext utf-8) if shared on the net may be identified by its url and processed locally to produce the different document outputs.</p> +<p> +<b>(xxi)</b> +document source may be bundled together (automatically) with associated documents (multiple language versions or master document with inclusions) and images and sent as a zip file called a sisupod, if shared on the net these too may be processed locally to produce the desired document outputs, these may be downloaded, shared as email attachments, or processed by running sisu against them, either using a url or the filename. +</p> +<p> +<b>(xxii)</b> +for basic document generation, the only software dependency is Ruby, 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> +<p> +as a developers tool it is flexible and extensible +</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="tiny"> +SiSU ("SiSU information Structuring Universe" or "Structured information, Serialized Units"),<sup>1</sup> is a Unix command line oriented framework for document structuring, publishing and search. Featuring minimalistic markup, multiple standard outputs, a common citation system, and granular search. +</p> +<p class="tiny"> + Using markup applied to a document, SiSU can produce plain text, HTML, XHTML, XML, OpenDocument, LaTeX or PDF files, and populate an SQL database with objects<sup>2</sup> (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 "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. +</p> + +<p class="small"> +How it works +</p> +<p class="tiny"> +SiSU 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 text which is related to document structure and typeface. SiSU 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 instruction 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,<sup>2</sup> 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> +<p class="tiny"> +<sup>1.</sup> also chosen for the meaning of the Finnish term "sisu". +</p> +<p class="tiny"> +<sup>2</sup> 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.</p> +<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="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/sisu_markup_samples/sisu_manual/_sisu/image/GnuDebianLinuxRubyBetterWay.png b/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/image/GnuDebianLinuxRubyBetterWay.png Binary files differnew file mode 100644 index 00000000..ce5b8830 --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/image/GnuDebianLinuxRubyBetterWay.png diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/image/aukio.png b/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/image/aukio.png Binary files differnew file mode 100644 index 00000000..f64d94a5 --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/image/aukio.png diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/image/i_sor.png b/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/image/i_sor.png Binary files differnew file mode 100644 index 00000000..fa8be7f6 --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/image/i_sor.png diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/image/sisu.home.png b/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/image/sisu.home.png Binary files differnew file mode 100644 index 00000000..b449fa6b --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/image/sisu.home.png diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/image/sisu.png b/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/image/sisu.png Binary files differnew file mode 100644 index 00000000..b449fa6b --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/image/sisu.png diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/image/tulva.png b/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/image/tulva.png Binary files differnew file mode 100644 index 00000000..20ab95bb --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/image/tulva.png diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/image/tux.png b/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/image/tux.png Binary files differnew file mode 100644 index 00000000..15fd152b --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/image/tux.png diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/sisurc.yml b/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/sisurc.yml new file mode 100644 index 00000000..e3fe2a90 --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/sisurc.yml @@ -0,0 +1,129 @@ +# Name: SiSU - Simple information Structuring Universe +# Author: Ralph@Amissah.com +# Description: Site wide envionment defaults set here +# system environment info / resource configuration file, for sisu +# License: GPL v3 or later +# this file should be configured and live in +# /etc/sisu #per environment settings, overridden by: +# ~/.sisu #per user settings, overridden by: +# ./_sisu/config #per local directory settings +# $Date$ +# $Id$ +# Notes: implemented 2004w03 +# Site environment configuration file +# this file should be configured and live in +# /etc/sisu #per environment settings, overridden by: +# ~/.sisu #per user settings, overridden by: +# ./_sisu #per local markup directory settings +#% #image source directory, main path and subdirectories +#image: +## path: 'grotto/theatre/working' +# path: 'sisu_working' +# public: 'sisu_image' +# #all: 'image' +#% presentation/web directory, main path and subdirectories (most subdirectories are created automatically based on markup directory name) +webserv: + url_root: 'http://www.jus.uio.no/sisu' #without dir stub, e.g. this dir would map to http://www.jus.uio.no/sisu + path: '~/grotto/theatre/dbld/sisu-dev/sisu/data/doc/manuals_generated' # /var/www either (i) / [full path from root] or (ii) ~/ [home] or (iii) ./ [pwd] or (iv) will be made from home + #images: 'sisu/image' + #man: 'man' + #php: 'php' + #cgi: '/usr/local/lib/sisu-cgi' + feed: 'feed' + sqlite: 'sisu/sqlite' +# webrick_url: true +#show_output_on: 'filesystem' #for -v and -u url information, alternatives: 'filesystem','webserver','remote_webserver','local:8111','localhost','localhost:8080','webrick','path' +#show_output_on: 'local:8111' +webserv_cgi: +# host: localhost +# base_path: ~ +# port: '8081' +# user: ~ + file_links: webserv +# file_links: www.jus.uio.no +show_output_on: 'filesystem_url' +#texinfo display output +#texinfo: +# stub: 'texinfo' +#% processing directories, main path and subdirectories +processing: +# path: 'sisu_processing' +# metaverse: 'metaverse' +# tune: 'tune' +# latex: 'tex' +# texinfo: 'texinfo' +# concord_max: 400000 +#% flag - set (non-default) processing flag shortcuts -1, -2 etc. (here adding colour and verbosity as default) +flag: + color: true # making colour default -c is toggle, and will now toggle colour off + default: '-NhwpoabxXyYv' # includes verbose; -m would in any event be run by default + i: '-Nhwpoayv' # includes verbose; -m run by default + ii: '-NhwpoabxXyv' # includes verbose; -m run by default + iii: '-NhwpoabxXyYv' # includes verbose; -m run by default + iv: '-NhwpoabxXYDyv --import' # includes verbose; -m run by default + v: '-NhwpoabxXYDyv --update' # includes verbose; -m run by default +#flag: +# color: false # colour off default -c is toggle, and will toggle colour on +# i: '-mhwpcyv' # adding colour and verbosity to defaults (note: another -c won't toggle off) +# ii: '-mhwpaocyv' # adding colour and verbosity to defaults (note: another -c won't toggle off) +# iii: '-mhwpaobxXcyv' # adding colour and verbosity to defaults (note: another -c won't toggle off) +# iv: '-mhwpaobxXDcyv --import' # adding colour and verbosity to defaults (note: another -c won't toggle off) +# v: '-mhwpaobxXDcyv --update' # adding colour and verbosity to defaults (note: another -c won't toggle off) +#% papersize, (LaTeX/pdf) current values A4, US_letter, book_b5, book_a5, US_legal +default: + papersize: 'A4' + language_file: 2 + #digest: 'sha' #sha is sha256, default is md5 + #multilingual: false + #language: 'English' +#% settings used by ssh scp rsync, requires keychain setup +#remote: +# user: '[provide_username]' +# host: '[provide_hostname]' +# path: '.' #no trailing slash eg 'sisu/www' +##% webrick information +##sql database info, postgresql and sqlite +#db: +# postgresql: +# user: '[provide username]' +# port: '5432' +# sqlite: +# path: ~ # './sisu_sqlite.db' +# port: "**" +# multi: true +# single: true +#% possible values ~, true, false, or command instruction e.g. editor: 'gvim -c :R -c :S'. +#will only ignore if value set to false, absence or nil will not remove program as should operate without rc file +#ie in case of ~ will ignore and use hard coded defaults within program), true, false, or command instruction e.g. editor: 'gvim -c :R -c :S' +#on value true system defaults used, to change, e.g. editor specify +permission_set: + zap: true + css_modify: true +# remote_base_site: true +program_set: + rmagick: true + wc: true + editor: true + postgresql: true + sqlite: true + tidy: true + rexml: true + pdflatex: true +program_select: + editor: 'gvim -c :R' + pdf_viewer: 'evince' + web_browser: 'kazehakase' + console_web_browser: 'links2' + odf_viewer: 'oowriter' + xml_viewer: 'xml-viewer' +#promo: sisu_icon, sisu, sisu_search_libre, open_society, fsf, ruby +search: + sisu: + flag: true +# action: http://localhost:8081/cgi-bin/sisu_pgsql.cgi + action: http://search.sisudoc.org + db: sisu + title: sample search form + hyperestraier: + flag: true + action: http://search.sisudoc.org/cgi-bin/estseek.cgi? diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/dir/skin_sisu_manual.rb b/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/dir/skin_sisu_manual.rb new file mode 120000 index 00000000..86a7b6f3 --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/dir/skin_sisu_manual.rb @@ -0,0 +1 @@ +../doc/skin_sisu_manual.rb
\ No newline at end of file diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb b/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb new file mode 100644 index 00000000..4a2b0011 --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb @@ -0,0 +1,95 @@ +=begin + * Name: SiSU information Structuring Universe - Structured information, Serialized Units + * Author: Ralph@Amissah.com + * http://www.jus.uio.no/sisu + * http://www.jus.uio.no/sisu/SiSU/download + * Description: Document skin for SiSU descriptive pages, ... + * License: Same as SiSU see http://www.jus.uio.no/sisu + * Notes: Site default appearance variables set in defaults.rb + Generic site wide modifications set here scribe_skin.rb, and this file required by other "scribes" instead of defaults.rb +=end +module SiSU_Viz + require SiSU_lib + '/defaults' + class Skin + #% widget + def widget_search + true + end + def widget_promo + ['search_sisu','sisu_manual','sisu'] + #['search_sisu','sisu_manual','sisu','ruby_logo'] + #['sisu_manual_search','sisu_manual'] + #['sisu','ruby','sisu_search_libre','ruby','open_society'] + end + #% path + def path_root + './sisu/' # the only parameter that cannot be changed here + end + def path_rel + '../' + end + #% url + def url_home + 'http://www.jus.uio.no/sisu/' + end + def url_site # used in pdf header + 'http://www.jus.uio.no/sisu' + end + def url_txt # text to go with url usually stripped url + 'www.jus.uio.no/sisu/' + end + def url_home_url + '../index.html' + end + #def url_root_http + #root server path info, used in document information + #end + #% color + def color_band1 + '"#ffffff"' + end + def color_band2 + '"#ffffff"' + end + #% text + def text_hp + ' SiSU' + end + def text_home + 'SiSU' + end + #% icon + def icon_home_button + 'sisu.png' + end + def icon_home_banner + icon_home_button + end + #% banner + def banner_home_button + %{<table summary="home button" border="0" cellpadding="3" cellspacing="0"><tr><td align="left" bgcolor="#ffffff"><a href="#{url_site}/">#{png_home}</a></td></tr></table>\n} + end + def banner_home_and_index_buttons + %{<table><tr><td width="20%"><table summary="home and index buttons" border="0" cellpadding="3" cellspacing="0"><tr><td align="left" bgcolor="#ffffff"><a href="#{url_site}/" target="_top">#{png_home}</a>#{table_close}</td><td width="60%"><center><center><table summary="buttons" border="1" cellpadding="3" cellspacing="0"><tr><td align="center" bgcolor="#ffffff"><font face="arial" size="2"><a href="toc" target="_top"> This text sub- <br /> Table of Contents </a></font>#{table_close}</center></center></td><td width="20%"> #{table_close}} + end + def banner_band + %{<table summary="band" border="0" cellpadding="3" cellspacing="0"><tr><td align="left" bgcolor="#ffffff"><a href="#{url_site}/" target="_top">#{png_home}</a>#{table_close}} + end + end + class TeX + def header_center + "\\chead{\\href{#{@vz.url_site}/}{www.jus.uio.no/sisu/}}" + end + def home_url + "\\href{#{@vz.url_site}/}{www.jus.uio.no/sisu/}" + end + def home + "\\href{#{@vz.url_site}/}{Ralph Amissah}" + end + def owner_chapter + 'Document owner details' + end + end +end +__END__ +puts "#{__LINE__} #{__FILE__}" diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/yml/list.yml b/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/yml/list.yml new file mode 100644 index 00000000..b26a1c74 --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/yml/list.yml @@ -0,0 +1,33 @@ +sisu_manual: + site: + - sisu_manual +sisu: + site: + - sisu +ruby_logo: + site: + - ruby_logo +open_society: + site: + - twon + - fc + - faif +# - ffa + - catb +sisu_icon: + site: + - sisu_icon +fsf: + site: + - fsf +gpl: + site: + - gpl +search_sisu: + search: + - search_sisu + +search_manual: + search: + - search_sisu_manual + diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/yml/promo.yml b/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/yml/promo.yml new file mode 100644 index 00000000..7dfc5ec5 --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/yml/promo.yml @@ -0,0 +1,193 @@ +# Author: ralph@amissah.com +search: + search_sisu: + action: http://search.sisudoc.org + target: _top + db: sisu +# search_sisu_manual: +# action: http://search.sisudoc.org +# target: _top +# db: sisu_manual +site: + sisu_icon: + url: SiSU + image: sisu.png + blurb: ~ + sisu_manual: + title: SiSU manual + url: sisu_manual/toc.html + #url: index.html + blurb: ~ + links: + - + title: SiSU introduction + url: sisu_introduction/toc.html + - + title: SiSU commands + url: sisu_commands/toc.html + - + title: SiSU markup + url: sisu_markup/toc.html + - + title: SiSU configuration + url: sisu_configuration/toc.html + - + title: SiSU help + url: sisu_help/toc.html + - + title: SiSU help sources + url: sisu_help_sources/toc.html + ruby_logo: + url: http://www.ruby-lang.org/en/ + image: ruby_logo.png + blurb: ~ + sisu: + title: SiSU + url: index.html + blurb: ~ + links: + - + title: What does SiSU do? Summary + url: SiSU/1.html#summary + - + title: SiSU Book Samples and Markup Examples + url: SiSU/2.html + - + title: Markup + url: sisu_markup/ + - + title: Commands + url: sisu_commands/ + - + title: Manual + url: sisu_manual/ + - + title: SiSU Download + url: SiSU/download.html + - + title: SiSU Changelog + url: SiSU/changelog.html + blurb: ~ + - + title: Wikipedia entry + url: http://en.wikipedia.org/wiki/SiSU + blurb: ~ + - + title: Freshmeat + url: http://freshmeat.net/projects/sisu/ + - + title: Ruby Application Archive + url: http://raa.ruby-lang.org/project/sisu/ + twon: + title: The Wealth of Networks + subtitle: How Social Production Transforms Markets and Freedom + author: Yochai Benkler + year: 2006 + url: the_wealth_of_networks.yochai_benkler + links: + - + title: Wikipedia entry + url: http://en.wikipedia.org/wiki/The_Wealth_of_Networks + - + title: Source Wiki + url: http://www.benkler.org/wealth_of_networks/index.php/Main_Page + fc: + title: Free Culture + subtitle: How Big Media Uses Technology and the Law to Lock Down Culture and Control Creativity + author: Lawrence Lessig + year: 2004 + url: free_culture.lawrence_lessig + links: + - + title: Wikipedia entry + url: http://en.wikipedia.org/wiki/Free_Culture_%28book%29 + - + title: Creative Commons + url: http://creativecommons.org/ + - + title: Source + url: http://www.free-culture.cc/ + faif: + title: Free As In Freedom + subtitle: Richard Stallman's Crusade for Free Software + author: Sam Williams + year: 2002 + url: free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams + links: + - + title: Wikipedia entry + url: http://en.wikipedia.org/wiki/Free_as_in_Freedom:_Richard_Stallman%27s_Crusade_for_Free_Software + - + title: Source + url: http://faifzilla.org/ + - + title: FSF + url: http://www.fsf.org/ + - + title: FSF Wikipedia + url: http://en.wikipedia.org/wiki/Free_Software_Foundation + - + title: GPL + url: http://www.gnu.org/copyleft/gpl.html + - + title: GPL Wikipedia + url: http://en.wikipedia.org/wiki/GNU_General_Public_License + ffa: + title: Free For All + subtitle: How Linux and the Free Software Movement Undercut the High Tech Titans + author: Peter Wayner + year: 2002 + url: free_for_all.peter_wayner + links: + - + title: Source + url: http://www.wayner.org/books/ffa/ + catb: + title: The Cathedral & the Bazaar + subtitle: Musings on Linux and Open Source by an Accidental Revolutionary + author: Erik S. Raymond + year: 1999 + url: the_cathedral_and_the_bazaar.eric_s_raymond + links: + - + title: Wikipedia entry + url: http://en.wikipedia.org/wiki/Cathedral_and_the_bazaar + - + title: Source + url: http://www.catb.org/~esr/writings/cathedral-bazaar/cathedral-bazaar/ + fsf: + title: Free Software Foundation + subtitle: FSF + url: http://www.fsf.org/ + links: + - + title: Wikipedia entry + url: http://en.wikipedia.org/wiki/Free_Software_Foundation + - + title: GPL + subtitle: GNU General Public License + url: http://www.gnu.org/copyleft/gpl.html + gpl: + title: GNU General Public License + subtitle: GPL + url: http://www.gnu.org/copyleft/gpl.html + links: + - + title: Wikipedia entry + url: http://en.wikipedia.org/wiki/GNU_General_Public_License + - + title: GPL 3 + url: http://gplv3.fsf.org/ + - + title: Software License List + url: http://www.fsf.org/licensing/licenses/ +#search: +# sisu_books_libre_sisusearch: +# type: sisusearch +# #action: http://search.sisudoc.org +# #action: http://88.198.23.86/cgi-bin/sisu_pgsql.cgi +# #target: _top +# db: sisu +# sisu_books_libre_hyperestraier: +# type: hyperestraier +# action: http://search.sisudoc.org/cgi-bin/estseek.cgi? diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu.ssm b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu.ssm new file mode 100644 index 00000000..81462785 --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu.ssm @@ -0,0 +1,96 @@ +% SiSU master 0.58 + +@title: SiSU - SiSU information Structuring Universe + +@subtitle: Manual [0.58] + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2002-08-28 + +@date.issued: 2002-08-28 + +@date.available: 2002-08-28 + +@date.modified: 2007-08-30 + +@date: 2007-08-30 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~ @title @creator + +:B~ What is SiSU? + +<< |sisu_introduction.sst|@|^| + +<< |sisu_help.sst|@|^| + +% :B~? SiSU Commands + +<< |sisu_commands.sst|@|^| + +% :B~? SiSU Markup + +<< |sisu_markup.sst|@|^| + +<< |sisu_filetypes.sst|@|^| + +% :B~? SiSU Configuration and Skins + +<< |sisu_config.ssi|@|^| + +<< |sisu_skin.sst|@|^| + +<< |sisu_css.ssi|@|^| + +<< |sisu_content_directories.ssi|@|^| + +<< |sisu_homepages.ssi|@|^| + +% :B~? SiSU Output and Markup Examples + +<< |sisu_examples.ssi|@|^| + +<< |sisu_search_intro.ssi|@|^| + +<< |sisu_sql.ssi|@|^| + +<< |sisu_postgresql.sst|@|^| + +<< |sisu_sqlite.sst|@|^| + +<< |sisu_search_cgi.ssi|@|^| + +<< |sisu_hyperestraier.ssi|@|^| + +<< |sisu_webrick.sst|@|^| + +<< |sisu_remote.sst|@|^| + +<< |sisu_quickstart.sst|@|^| + +<< |sisu_syntax_highlighting.sst|@|^| + +<< |sisu_help_sources.sst|@|^| diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_commands.sst b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_commands.sst new file mode 100644 index 00000000..ec0500a7 --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_commands.sst @@ -0,0 +1,261 @@ +% SiSU 0.58 + +@title: SiSU + +@subtitle: Commands [0.58] + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2002-08-28 + +@date.issued: 2002-08-28 + +@date.available: 2002-08-28 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +% @prefix: + +:A~? @title @creator + +:B~? SiSU Commands + +1~commands Commands Summary + +2~ Synopsis + +SiSU - Structured information, Serialized Units - a document publishing system + +sisu [ -abcDdFHhIiMmNnopqRrSsTtUuVvwXxYyZz0-9 ] [ filename/ wildcard ] + +sisu [ -Ddcv ] [ instruction ] + +sisu [ -CcFLSVvW ] + +Note: commands should be issued from within the directory that contains the marked up files, cd to markup directory. + +2~ Description + +SiSU SiSU 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 ("object citation numbering") and the same document structure information. For more see: http://www.jus.uio.no/sisu + +% 2~ Summary of man page + +% This man page covers a number of subjects in brief, including: document processing command flags; document markup (basic markup and headers); configuration files; directory structure; skins; document naming; interactive help and other information. + +2~ Document Processing Command Flags + +!_ -a [filename/wildcard] <br> +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 endnotes]. (Options include: --endnotes for endnotes --footnotes for footnotes at the end of each paragraph --unix for unix linefeed (default) --msdos for msdos linefeed) + +!_ -b [filename/wildcard] <br> +produces xhtml/XML output for browser viewing (sax parsing). + +!_ -C [--init-site] <br> +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. + +!_ -CC <br> +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. + +!_ -c [filename/wildcard] <br> +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). + +!_ -D [instruction] [filename] <br> +database postgresql ( --pgsql may be used instead) possible instructions, include: --createdb; --create; --dropall; --import [filename]; --update [filename]; --remove [filename]; see database section below. + +!_ -d [--db-[database type (sqlite|pg)]] --[instruction] [filename] <br> +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. + +!_ -F [--webserv=webrick] <br> +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 on setting up hyperestraier for sisu + +!_ -H [filename/wildcard] <br> +produces html without link suffixes (.html .pdf etc.) ("Hide"). Requires an appropriately configured web server. [behaviour switched after 0.35 see -h]. + +!_ -h [filename/wildcard] <br> +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]. + +!_ -I [filename/wildcard] <br> +produces texinfo and info file, (view with pinfo). + +!_ -L <br> +prints license information. + +!_ -M [filename/wildcard/url] <br> +maintenance mode files created for processing preserved and their locations indicated. (also see -V) + +!_ -m [filename/wildcard/url] <br> +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 + +!_ -N [filename/wildcard/url] <br> +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. + +!_ -n [filename/wildcard/url] <br> +skip meta-markup (building of "metaverse"), this skips the equivalent of -m which is otherwise assumed by most processing flags. + +!_ -o [filename/wildcard/url] <br> +output basic document in opendocument file format (opendocument.odt). + +!_ -p [filename/wildcard] <br> +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). + +!_ -q [filename/wildcard] <br> +quiet less output to screen. + +!_ -R [filename/wildcard] <br> +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 "keys" and ssh agent in place. Note the behavior of rsync different if -R is used with other flags from if used alone. Alone the rsync --delete parameter is sent, useful for cleaning the remote directory (when -R is used together with other flags, it is not). Also see -r + +!_ -r [filename/wildcard] <br> +copies sisu output files to remote host using scp. This requires that sisurc.yml has been provided with information on hostname and username, and that you have your "keys" and ssh agent in place. Also see -R + +!_ -S <br> +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 option is tested only with zsh). + +!_ -S [filename/wildcard] <br> +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. SiSU 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]. + +!_ -s [filename/wildcard] <br> +copies sisu markup file to output directory. + +!_ -t [filename/wildcard (*.termsheet.rb)] <br> +standard form document builder, preprocessing feature + +!_ -U [filename/wildcard] <br> +prints url output list/map for the available processing flags options and resulting files that could be requested, (can be used to get a list of processing options in relation to a file, together with information on the output that would be produced), -u provides url output mapping for those flags requested for processing. The default assumes sisu_webrick is running and provides webrick url mappings where appropriate, but these can be switched to file system paths in sisurc.yml + +!_ -u [filename/wildcard] <br> +provides url mapping of output files for the flags requested for processing, also see -U + +!_ -V <br> +on its own, provides SiSU version and environment information (sisu --help env) + +!_ -V [filename/wildcard] <br> +even more verbose than the -v flag. (also see -M) + +!_ -v <br> +on its own, provides SiSU version information + +!_ -v [filename/wildcard] <br> +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 + +!_ -W <br> +starts ruby's webrick webserver points at sisu output directories, the default port is set to 8081 and can be changed in the resource configuration files. [tip: the webrick server requires link suffixes, so html output should be created using the -h option rather than -H ; also, note -F webrick ]. + +!_ -w [filename/wildcard] <br> +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) + +!_ -X [filename/wildcard] <br> +produces XML output with deep document structure, in the nature of dom. + +!_ -x [filename/wildcard] <br> +produces XML output shallow structure (sax parsing). + +!_ -Y [filename/wildcard] <br> +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]) + +!_ -y [filename/wildcard] <br> +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. + +!_ -Z [filename/wildcard] <br> +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. + +!_ -z [filename/wildcard] <br> +produces php (zend) [this feature is disabled for the time being] + +1~command_modifiers command line modifiers + +!_ --no-ocn <br> +[with -h -H or -p] switches off object citation numbering. Produce output without identifying numbers in margins of html or LaTeX/pdf output. + +!_ --no-annotate <br> +strips output text of editor endnotes~[* square brackets ]~ denoted by asterisk or dagger/plus sign + +!_ --no-asterisk <br> +strips output text of editor endnotes~[* square brackets ]~ denoted by asterisk sign + +!_ --no-dagger <br> +strips output text of editor endnotes~[+ square brackets ]~ denoted by dagger/plus sign + +1~commands_database database commands + +dbi - database interface + +-D or --pgsql set for postgresql -d or --sqlite default set for sqlite -d is modifiable with --db=[database type (pgsql or sqlite)] + +!_ -Dv --createall <br> +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. + +!_ -Dv --import <br> +[filename/wildcard] imports data specified to postgresql db (rb.dbi) [ -dv --import sqlite equivalent] + +!_ -Dv --update <br> +[filename/wildcard] updates/imports specified data to postgresql db (rb.dbi) [ -dv --update sqlite equivalent] + +!_ -D --remove <br> +[filename/wildcard] removes specified data to postgresql db (rb.dbi) [ -d --remove sqlite equivalent] + +!_ -D --dropall <br> +kills data" and drops (postgresql or sqlite) db, tables & indexes [ -d --dropall sqlite equivalent] + +The v in e.g. -Dv is for verbose output. + +1~command_shorcuts Shortcuts, Shorthand for multiple flags + + +!_ --update [filename/wildcard] <br> +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. + +!_ -0 to -5 [filename or wildcard] <br> +Default shorthand mappings (note that the defaults can be changed/configured in the sisurc.yml file): + +!_ -0 <br> +-mNhwpAobxXyYv [this is the default action run when no options are give, i.e. on 'sisu [filename]'] + +!_ -1 <br> +-mNHwpy + +!_ -2 <br> +-mNHwpaoy + +!_ -3 <br> +-mNhwpAobxXyY + +!_ -4 <br> +-mNhwpAobxXDyY --import + +!_ -5 <br> +-mNhwpAobxXDyY --update + +add -v for verbose mode and -c for color, e.g. sisu -2vc [filename or wildcard] + +consider -u for appended url info or -v for verbose output + +3~ Command Line with Flags - Batch Processing + +In the data directory run sisu -mh filename or wildcard eg. "sisu -h cisg.sst" or "sisu -h *.{sst,ssm}" to produce html version of all documents. + +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. diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_complete.sst b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_complete.sst new file mode 100644 index 00000000..873110e7 --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_complete.sst @@ -0,0 +1,74 @@ +% SiSU 0.58 + +@title: SiSU + +@subtitle: Complete Package [0.58] + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2002-08-28 + +@date.issued: 2002-08-28 + +@date.available: 2002-08-28 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +1~complete sisu_complete + +2~ Name + +SiSU - Structured information, Serialized Units - a document publishing system, complete dependency package + +2~ Synopsis + +Debian dummy package installs the whole of SiSU, excluding sisu-examples. + +sisu-complete together with sisu-examples is the whole of SiSU + +2~ Further Information + +For more information on SiSU see: + +http://www.jus.uio.no/sisu/sisu_manual + +http://www.jus.uio.no/sisu + +2~ Author + +Ralph Amissah ralph@amissah.com or ralph.amissah@gmail.com + +2~ See + +sisu(1) + +2~ Also See + +sisu_webrick(1), sisu_pdf(7) sisu_sqlite(7) sisu_postgresql(7) sisu_vim(7) sisu_termsheet(1) diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_config.ssi b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_config.ssi new file mode 100644 index 00000000..9a5cc00c --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_config.ssi @@ -0,0 +1,83 @@ +% SiSU insert 0.58 + +@title: SiSU + +@subtitle: Search [0.58] + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2002-08-28 + +@date.issued: 2002-08-28 + +@date.available: 2002-08-28 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? Configuration + +:B~? Configuration + +:C~? Configure Environment + +1~config Configuration + +2~ Determining the Current Configuration + +Information on the current configuration of SiSU should be available with the help command: + +_1 sisu -v + +which is an alias for: + +_1 sisu --help env + +Either of these should be executed from within a directory that contains sisu markup source documents. + +2~ Configuration files (config.yml) + +SiSU 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. + +The SiSU configuration file is a yaml file, which means indentation is significant. + +SiSU resource configuration is determined by looking at the following files if they exist: + +_1 ./_sisu/sisurc.yml + +_1 ~/.sisu/sisurc.yml + +_1 /etc/sisu/sisurc.yml + +The search is in the order listed, and the first one found is used. + +In the absence of instructions in any of these it falls back to the internal program defaults. + +Configuration determines the output and processing directories and the database access details. + +If SiSU is installed a sample sisurc.yml may be found in /etc/sisu/sisurc.yml + diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_configuration.ssm b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_configuration.ssm new file mode 100644 index 00000000..48f780a6 --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_configuration.ssm @@ -0,0 +1,58 @@ +% SiSU master 0.58 + +@title: SiSU + +@subtitle: Configuration [0.58] + +@creator: Ralph Amissah + +@rights: Ralph Amissah + +% @rights: Copyright (C) Ralph Amissah + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2002-08-28 + +@date.issued: 2002-08-28 + +@date.available: 2007-08-28 + +@date.modified: 2007-08-30 + +@date: 2007-08-30 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +% :B~? SiSU Configuration and Skins + +:B~? Configuration of Environment + +% :C~ Environment + +<< |sisu_config.ssi|@|^| + +:B~? Configuration of Documents + +<< |sisu_skin.sst|@|^| + +<< |sisu_homepages.ssi|@|^| diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_content_directories.ssi b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_content_directories.ssi new file mode 100644 index 00000000..9d572c54 --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_content_directories.ssi @@ -0,0 +1,62 @@ +% SiSU insert 0.58 + +@title: SiSU + +@subtitle: Content Directories, Organising Content [0.58] + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2002-08-28 + +@date.issued: 2002-08-28 + +@date.available: 2007-08-28 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +% @rcs$ + +:A~? Organisation of Content + +:B~? Content Directories + +:C~? Content Directories + +1~organising_content Organising Content + +2~ Directory Structure and Mapping + +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) + +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. + +2~ Organising Content + +% .SH "SKINS \- document, directory and site skins" + + diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_css.ssi b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_css.ssi new file mode 100644 index 00000000..57e8a77c --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_css.ssi @@ -0,0 +1,70 @@ +% SiSU insert 0.58 + +@title: SiSU + +@subtitle: Skins [0.58] + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2007-08-28 + +@date.issued: 2007-08-28 + +@date.available: 2007-08-28 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +% @rcs$ + +:A~? CSS + +:B~? CSS + +:C~? CSS + +1~css CSS - Cascading Style Sheets (for html, XHTML and XML) + +CSS files to modify the appearance of SiSU 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 output directories with the command sisu -CC. + +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. + +HTML: +html.css + +XML DOM: +dom.css + +XML SAX: +sax.css + +XHTML: +xhtml.css + +The default homepage may use homepage.css or html.css + +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.~{ 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. }~ diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_description.sst b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_description.sst new file mode 100644 index 00000000..a0ae729c --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_description.sst @@ -0,0 +1,557 @@ +% SiSU 0.57 + +@title: SiSU - SiSU information Structuring Universe / Structured information, Serialized Units + +@subtitle: Description + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2002-11-12 + +@date.issued: 2002-11-12 + +@date.available: 2002-11-12 + +@date.modified: 2007-08-30 + +@date: 2007-08-30 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +% @rcs:+ $Id$ + +:A~? @title @creator + +:B~? SiSU an attempt to describe + +1~ Description + +2~ Outline + +SiSU is a flexible document preparation, generation publishing and search system.~{ This information was first placed on the web 12 November 2002; with predating material taken from http://www.jus.uio.no/lm/lm.information/toc.html part of a site started and developed since 1993. See document metadata section http://www.jus.uio.no/sisu/SiSU/metadata.html for information on this version. Dates related to the development of SiSU are mostly contained within the Chronology section of this document, e.g. http://www.jus.uio.no/sisu/sisu_chronology }~ + +SiSU ("SiSU information Structuring Universe" or "Structured information, Serialized Units"),~{ also chosen for the meaning of the Finnish term "sisu". }~ is a Unix command line oriented framework for document structuring, publishing and search. Featuring minimalistic markup, multiple standard outputs, a common citation system, and granular search. + +Using markup applied to a document, SiSU can produce plain text, HTML, XHTML, XML, OpenDocument, LaTeX or PDF files, and populate an SQL database with objects~{ 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. }~ (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 "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. + +SiSU is the data/information structuring and transforming tool, that has resulted from work on one of the oldest law web projects. It makes possible the one time, simple human readable markup of documents, that SiSU can then publish in various forms, suitable for paper~{ pdf via LaTeX or lout }~, web~{ currently html (two forms of html presentation one based on css the other on tables), and /PHP/; potentially structured XML }~ and relational database~{ any SQL - currently PostgreSQL and /sqlite/ (for portability, testing and development) }~ presentations, retaining common data-structure and meta-information across the output/presentation formats. Several requirements of legal and scholarly publication on the web have been addressed, including the age old need to be able to reliably cite/pinpoint text within a document, to easily make footnotes/endnotes, to allow for semantic document meta-tagging, and to keep required markup to a minimum. These and other features of interest are listed and described below. A few points are worth making early (and will be repeated a number of times): + +_1 (i) The SiSU document generator was the first to place material on the web with a system that makes possible citation across different document types, with paragraph, or rather object citation numbering~{ previously called "text object numbering" }~ a text positioning system, available for the pinpointing of text, 1997, a simple idea from which much benefit, and SiSU remains today, to the best of my knowledge, the only multiple format e-book/ electronic-document system on the web that gives you this possibility (including for relational databases). + +_1 (ii) Markup is done once for the multiple formats produced. + +_1 (iii) Markup is simple, and human readable (with a little practice), in almost all cases there is less and simpler markup required than basic html. In any event the markup required is very much simpler than the html, LaTeX, [lout], structured XML, ODF (OpenDocument), PostgreSQL or SQLite feed etc. that you can have SiSU generate for you. + +_1 (iv) SiSU is a batch processor, dealing with as many files as you need to generate at a time. + +_1 (v) Scalability is dependent on your file system (in my case Reiserfs), the database (currently Postgresql and/or SQLite) and your hardware. + +SiSU Sabaki~{ SiSU Sabaki, release version. Pre-release version SiSU Scribe, and version prior to that SiSU nicknamed Scribbler. Pre-release versions go back several years. Both Scribbler and Scribe (still maintained) made system calls to SiSU's various parts, instead of using libraries. }~ (or just SiSU) is the provisional name given to the software described here that helps structure documents for web and other publication. The name SiSU is a loose anagram for something along the lines of *{/{"SiSU is structuring unit"}/}*, or /{"SiSU, information structuring unit"}/ or the more descriptive /{"Structured information, Serialized Units"}/ or *{/{"simple - information structuring unit"}/}* or the more descriptive /{"Structured information, Serialized Units"}/ or what it may be directed towards /{"*semantic* and *{information structuring universe}*"}/,~{ A little universe it may be, but semantic you may have a hard time getting away with, given the meaning the word has taken on with markup. On a document wide basis semantic information may be provided, which can be really useful, (and meaningful, especially) if you have a large document set, and use this with rss feeds or in an sql database etc. On a markup level, I have little inclination to add semantic markup formally beyond references, title, author [Dublin Core entities? addresses?] etc. Actually this deserves a bit of thought possibly use letter tags (including letter alias/synonyms for font faces) to create a small set of default semantic tags, with the possibility for per document adjustments. Will seek to permit XML entity tagging, within SiSU markup and have that ignored/removed by the parts of the program that have no use for it. }~ tongue in cheek, only just. Guess I'll get away with *{/{"Simple - information Structuring Universe"}/}*. SiSU is also a Finnish word roughly meaning guts, inner strength and perseverance.~{ "Sisu refers not to the courage of optimism, but to a concept of life that says, 'I may not win, but I will gladly give my life for what I believe.'" Aini Rajanen, Of Finnish Ways, 1981, p. 10.<br> http://www.humanlanguages.com/finnishenglish/rlfs.htm <br>"Every Finn has his own pet definition. To me, sisu means patience without passion. But there are many varieties of sisu. Sisu can be a sudden outburst or it can be the kind that lasts. A man can have both kinds. It is outside reason. It is something in the soul. It comes from oneself. For instance, it makes a soldier do things because he himself must, not because he has been told." Paavo Nurmi<br> http://personalweb.smcvt.edu/tmatikainen/finnishtraditions.htm }~ + +SiSU was born of the need to find a way, with minimal effort, and for as wide a range of document types as possible, to produce high quality publishing output in a variety of document formats. As such it was necessary to find a simple document representation that would work across a large number of document types, and the most convenient way(s) to produce acceptable output formats. The project leading to this program was started in 1993 (together with the trade law project now known as Lex Mercatoria) as an investigation of how to effectively/efficiently place documents on the web. The unified document handling, together with features such as paragraph numbering, endnote handling and tables... appeared in 1996/97. SiSU was originally written in Perl,~{ http://www.perl.org/ }~ and converted to Ruby,~{ http://www.ruby-lang.org/en/ }~ in 2000, one of the most impressive programming languages in existence! In its current form it has been written to run on the Gnu/Linux platform, and in particular on Debian,~{ http://www.debian.org/ }~ taking advantage of many of the wonderful projects that are available there. + +SiSU markup is based on requiring the minimum markup needed to determine the structure of a document. (This can be as little as saying in a header to look for the word Book at a specified level and the word Chapter at another level). SiSU then breaks a document into its smallest parts (at a heading, and paragraph level) while retaining all structural information. This break up of the document and information on its structure is taken advantage of in the transformations made in generating the very different output types that can be created, and in providing as much as can be for what each output type is best at doing, e.g. LaTeX (professional document typesetting, easy conversion to pdf or Postscript), XML (in this case, structural representation), ODF (OpenDocument [experimental]), SQL (e.g. document search; representing constituent parts of documents based on their structure, headings, chapters, paragraphs as required; user control).~{ where explicit structure is provided through the use of tagging headings, it could be reduced (still) further, for example by reducing the number of characters used to identify heading levels; but in many cases even that information is not required as regular expressions can be used to extract the implicit structure. }~ + +From markup that is simpler and more sparse than html you get: + +_* far greater output possibilities, including html, XML, ODF (OpenDocument), LaTeX (pdf), and SQL; + +_* the advantages implicit in the very different output possibilities; + +_* a common citation system (for all outputs - including the relational database, search results are relevant for all outputs); + +For more see the short summary of features provided below. + +SiSU processes files with minimal tagging to produce various document outputs including html, LaTeX or lout (which is converted to pdf) and if required loads the structured information into an SQL database (PostgreSQL and SQLite have been used for this). SiSU produces an intermediate processing format.~{ This proved to be the easiest way to develop syntax, changes could be made, or alternatives provided for the markup syntax whilst the intermediate markup syntax was largely held constant. There is actually an optional second intermediate markup format in YAML http://www.yaml.org/ }~ + +SiSU is used in constructing Lex Mercatoria http://lexmercatoria.org/ or http://www.jus.uio.no/lm/ (one of the oldest law web sites), and considerable thought went into producing output that would be suitable for legal and academic writings (that do not have formulae) given the limitations of html, and publication in a wide variety of "formats", in particular in relation to the convenient and accurate citation of text. However, the construction of Lex Mercatoria uses only a fraction of the features available from SiSU today, /vis/ generation of flat file structures, rather than in addition the building of ("granular") SQL database content, (at an object level with relevant relational tables, and other outputs also available). + +2~ Short summary of features *~summary + +!_ (i) +markup syntax: (a) simpler than html, (b) mnemonic, influenced by mail/messaging/wiki markup practices, (c) human readable, and easily writable, + +!_ (ii) +(a) minimal markup requirement, (b) single file marked up for multiple outputs, + +notes: + +* documents are prepared in a single UTF-8 file using a minimalistic mnemonic syntax. Typical literature, documents like "War and Peace" require almost no markup, and most of the headers are optional. + +* markup is easily readable/parsed 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]. + +* 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. + +!_ (iii) +(a) multiple outputs primarily industry established and institutionally accepted open standard formats, include amongst others: plaintext (UTF-8); html; (structured) XML; ODF (Open Document text)l; LaTeX; PDF (via LaTeX); SQL type databases (currently PostgreSQL and SQLite). 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)) + +!_ (iv) +outputs share a common numbering system (dubbed "object citation numbering" (ocn)) that is meaningful (to man and machine) across various digital outputs whether paper, screen, or database oriented, (PDF, html, XML, sqlite, postgresql), this numbering system can be used to reference content. + +!_ (v) +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 hyperesteier]. + +!_ (vi) +use of semantic meta-tags in headers permit the addition of semantic information on documents, (the available fields are easily extended) + +!_ (vii) +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 (e.g. 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, + +!_ (viii) +"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), + +!_ (ix) +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: sisu_description.sst,v 1.25 2007/08/23 12:22:36 ralph Exp $ tag, which SiSU checks + +!_ (x) +SiSU's minimalist markup makes for meaningful "diffing" of the substantive content of markup-files, + +!_ (xi) +easily skinnable, document appearance on a project/site wide, directory wide, or document instance level easily controlled/changed, + +!_ (xii) +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, + +!_ (xiii) +prepared files may be batch process, documents produced are static files so 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) + +!_ (xiv) +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 + +there is a considerable degree of future-proofing, output representations are "upgradeable", and new document formats may be added. + +!_ (xv) +there is a considerable degree of future-proofing, output representations are "upgradeable", and new document formats may be added: (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, + +!_ (xvi) +scalability, dependent on your file-system (ext3, Reiserfs, XFS, whatever) and on the relational database used (currently Postgresql and SQLite), and your hardware, + +!_ (xvii) +only marked up files need be backed up, to secure the larger document set produced, + +!_ (xviii) +document management, + +!_ (xix) +Syntax highlighting for SiSU markup is available for a number of text editors. + +!_ (xx) +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) generated document outputs may be posted by sisu to remote sites (using rsync/scp) (c)document source (plaintext utf-8) if shared on the net may be identified by its url and processed locally to produce the different document outputs. + +!_ (xxi) +document source may be bundled together (automatically) with associated documents (multiple language versions or master document with inclusions) and images and sent as a zip file called a sisupod, if shared on the net these too may be processed locally to produce the desired document outputs, these may be downloaded, shared as email attachments, or processed by running sisu against them, either using a url or the filename. + +!_ (xxii) +for basic document generation, the only software dependency is Ruby, 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. + +as a developers tool it is flexible and extensible + +SiSU was developed in relation to legal documents, and is strong across a wide variety of texts (law, literature...). SiSU handles images but is not suitable for formulae/ statistics, or for technical writing at this time. + +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. + +Some modules are more mature than others, the most mature being Html and LaTeX / pdf. PostgreSQL and search functions are useable and together with /ocn/ unique (to the best of my knowledge). The XML output document set is "well formed" but largely proof of concept. + +2~ How it works + +SiSU 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 text which is related to document structure and typeface. SiSU 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 instruction 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,~{ 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. }~ 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). + +2~ Simple markup + +SiSU markup is based on requiring the minimum markup needed to determine the structure of a document. (This can be as little as saying in a header to look for the word Book at a specified level and the word Chapter at another level). SiSU then breaks a document into its smallest parts (at a heading, and paragraph level) while retaining all structural information. This break up of the document and information on its structure is taken advantage of in the transformations made in generating the very different output types that can be created, and in providing as much as can be for what each output type is best at doing, e.g. LaTeX (professional document typesetting, easy conversion to pdf or Postscript), XML (in this case, structural representation), ODF (OpenDocument), SQL (e.g. document search; representing constituent parts of documents based on their structure, headings, chapters, paragraphs as required; user control).~{ where explicit structure is provided through the use of tagging headings, it could be reduced (still) further, for example by reducing the number of characters used to identify heading levels; but in many cases even that information is not required as regular expressions can be used to extract the implicit structure. }~ + +3~ Sparse markup requirement, try to get the most out of markup + +One of its strengths is that very small amounts of initial tagging is required for the program to generate its output. + +This is a basic markup example: + +_* { basic markup example, text file - an international convention }http://www.jus.uio.no/sisu/sample/markup/un_contracts_international_sale_of_goods_convention_1980.sst ~{ http://www.jus.uio.no/sisu/sample/markup/un_contracts_international_sale_of_goods_convention_1980.sst output provided as example in the next section }~ + +_* { view basic markup, as it would be highlighted by vim editor }http://www.jus.uio.no/sisu/sample/syntax/un_contracts_international_sale_of_goods_convention_1980.sst.html ~{ http://www.jus.uio.no/sisu/sample/syntax/un_contracts_international_sale_of_goods_convention_1980.sst.html as it would appear with syntax highlighting (by vim) }~ + +Emphasis has been on simplicity and minimalism in markup requirements. Design philosophy is to try keep the amount of markup required low, for whatever has been determined to be acceptable output.~{ seems there are several "smart ASCIIs" available, primarily for ascii to html conversion, that make this, and reasonable looking ascii their goal<br /> http://webseitz.fluxent.com/wiki/SmartAscii <br> http://daringfireball.net/projects/markdown/ <br> http://www.textism.com/tools/textile/ }~ + +SiSU's markup is more minimalistic and simpler than (the equivalent) html and for it, you get considerably more than just html, as this preparation gives you all available output formats, upon request. + +3~ Single markup file provides multiple output formats + +For each document, there is only one (input, minimalistically marked up) file from which all the available output types are generated.~{ These include richly laid out and linked html (table or css variants), /PHP/, LaTeX (from which pdf portrait and landscape documents are produced), texinfo (for info files etc.), and PostgreSQL and/or SQLite. And the opportunity to fairly easily build additional modules, such as XML. See the examples provided in this document. }~ + +Eg. the markup example: + +_* {~^ original text file - an international convention }http://www.jus.uio.no/sisu/sample/markup/un_contracts_international_sale_of_goods_convention_1980.sst + +_* {~^ view as syntax would be highlighted by vim editor }http://www.jus.uio.no/sisu/sample/syntax/un_contracts_international_sale_of_goods_convention_1980.sst.html + +Produces the following output: + +_* {~^ Segmented html version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/toc.html + +_* {~^ Full length html document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/doc.html + +_* {~^ pdf landscape version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/landscape.pdf + +_* {~^ pdf portrait version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/portrait.pdf + +_* {~^ clean tex ascii version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/plain.txt + +_* {~^ /xml/ sax version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/sax.xml + +_* {~^ /xml/ dom version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/dom.xml + +_* {~^ Concordance }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/concordance.html + +(and in addition to these: PostgreSQL, SQLite, texinfo and -{YAML}- ~{ discontinued for the time being }~ versions if desired) + +3~ Syntax relatively easy to read and remember + +Syntax is kept simple and mnemonic.~{ SiSU markup syntax, an incomplete summary: http://www.jus.uio.no/sisu/sisu_markup_table/doc.html#h200306 <br>Visual check of elementary font face modifiers: *bold* *{bold}* !{emphasis}! /{italics}/ _{underscore}_ -{strikethrough}- ^{superscript}^ ,{subscript}, }~ + +3~ Kept simple by having a limited publishing feature set, and features identified as most important, are available across several document types + +To keep SiSU markup sparse and simple SiSU deliberately provides a limited publishing feature set, including: indent levels; bold; italics; superscript; subscript; simple tables; images; tables of contents and; endnotes. Which in most cases are available across the different output formats. + +The publishing feature set may be expanded as required. + +2~ Designed with usability in mind + +Output is designed to be uniform, easy to read, navigate and cite. + +2~ Code separate from content + +Code~{ the program that generates the documents }~ is separated from content. This means that when changes are desired in the output presentation, the code that produces them, and not the marked up text data set (which could be thousands of documents) is modified. Separating code from content makes large scale changes to output appearance trivial, and permits the easy addition of new output modules. + +2~ Object citation numbering, a text or object positioning / citation system - "paragraph" (or text object) numbering, that remains same and usable across all output formats by people and machine *~citation *~ocn + +Object citation numbering is a simple object (text) positioning and cition system that is human relevant and machine useable, used by SiSU for all manner of presentations, and that is available for use in all text mappings. It is based on the automated sequential numbering of objects (roughly paragraphs, (headings, tables, verse) or other blocks of text or images etc.). The text positioning system (in which I claim copyright) is invaluable for publishing requiring the citing text across multiple output formats, and for the general mapping of text within a document: + +_* in html, html not being easily citeable (change font size, or use a different browser and the page on which specific text appears has changed), and + +_* across multiple formats being common to all output formats html/xml/pdf/sql output, + +_* the results of an sql search can just be "live" citation references to the documents in which the text is found, {~^ much like an index (see image examples provided). }http://www.jus.uio.no/sisu/SiSU/1.html#search + +I claim copyright on the system I use which is the most basic of all, numbering all text in headings and paragraphs sequentially (with tables and images being treated as a single paragraph) and only footnotes/endnotes not following this numbering, as their position in text is not strictly determined, (a change from footnotes to endnotes would change their numbering), footnotes instead "belong" to the paragraph from which they are referenced, and have sequential numbers of their own. + +SiSU has a paragraph numbering system, that remains the same regardless of the output format. This provides an effective means of citation, pinpointing text accurately in all output formats, using the same reference. This is particularly useful where text has to be located across different output formats - for example once html is printed the number of pages and pages on which given text is found will vary depending on the browser, its settings the font size setting etc. Similarly SiSU produces pdf in different forms, eg. on the example site Lex Mercatoria as portrait and landscape documents - here too page numbering varies, but paragraph numbering is the same, /{vis a vis}/ all versions of the text (portrait and landscape pdf and the html versions of the text, and as stored (with "paragraphs" as records) to the PostgreSQL or SQLite database). + +These numbers are placed in the text margins and are intended to be independent of and not to interfere with authors tagging. [The citation system (object citation numbering system, automated "paragraph numbering") which is automatically generated and is common and identical across all document formats] The paragraph numbering system is more accurately described as an (text) object numbering system, as headings are also numbered... all headings and paragraphs are numbered sequentially. Endnotes are automatically numbered independently and rather "belong" to the paragraph from which they are referenced, as an endnote does not (necessarily) form a part of a documents sequence, (they may be produced as either endnotes or footnotes (or both depending on what output you choose to look at - if you take the segmented html version document provided as an example, you will find that the endnotes are placed both at the end of each section, and in a separate section of their own called endnotes, and these are hyper-linked)). An attractive feature of providing citation numbering in this way is that it is independent of the document structure... it remains the same regardless of what is done about the document structure. + +The rules have been kept very simple, unique incremental object citation numbers are assigned to headings, paragraphs, verse, tables and images. It is possible to manually override this feature on a per heading or comment basis though this should be used exceptionally, it may be of use where there a substantive text, and the addition of a minor comment by the publisher that should not be mapped as part of the text. + +The object citation number markers contain additional numbering information with regard to the document structure, that can be used for alternative presentations, including such detail as the type of object (heading, paragraph, table, image, etc.), numbered sequentially. + +An advantage is that the numbering remains the same regardless of document structure. + +Text object ("paragraph") numbering is the same for all output versions of the same document, vis html, pdf, pgsql, yaml etc. + +In the relational database, as individual text objects of a document stored (and indexed) together with object numbers, and all versions of the document have the same numbering, the results of searches may be tailored just to provide the location of the search result in all available document formats. + +/{ Note: there is a bug in the released behaviour of object citation numbering, (not certain when it was introduced) tables should be numbered, ie each table gets an ocn, required amongst other things for relational database. This will be corrected in a future release. Citation numbering of existing documents that contain tables will changed. }/ + +2~ Handling of Dublin Core meta-tags making use of the Resource Description Framework + +SiSU is able to use meta tags based on the Dublin Core~{ http://dublincore.org/ }~ and Resource Description Framework~{ http://www.w3.org/RDF/ }~ + +This provides the means of providing semantic information about a document, both as computer processable meta-tags, and as human readable information that may be of value for classification purposes. + +This information is provided both in html metatags, and (where available) under the section titled "Document Information - MetaData", near the end of a document, for example in the segmented html version of this text at: http://www.jus.uio.no/sisu/SiSU/metadata.html + +2~ Easy directory management + +#1 Directory file association, skins and special image management, made simpler.~{ The previous way was directory associations for file output were set up in the configuration file. The present system is a more natural way to work requireing less configuration. }~ + +The last part of the name of the work directory in which markup is being done, or rather from where SiSU is run in order to generate document output, is used in determining the sub-directory name for output files, that is created in the document output directory. This provides a rather easy way to associate documents e.g. of a given subject, or by owner. + +code{ + +/www/docs + /intellectual_property + /arbitration + /contract_law + +/www/docs + /ralph + /sisu + +}code + +all are placed in their own directories within the directory structure created. Similar rules are used in the creation of sql type databases (though they can be overridden). + +There are a couple of further associations with these directories. + +Directory wide skins. + +Directory specific images. + +# If there is a "directory skin", that is a skin of the same name as the directory, it is used in the generation of the documents within it, rather than the default skin, unless the document has a specific skin associated with it. + +_# default skin (always available) + +_# directory skin (precedence over default if exists) + +_# document skin (takes precedence wherever document requests a specific skin) + +Skins are defined in the document skin directory and if a directory association is desired a softlink made to the relevant skin. Skins (directory association auto load) auto load skin if a directory skin exists of same name as directory stub, (and there is no specific doc skin) + +# If the working directory has within it a sub-directory called image_local, the images within that directory are used for references to images, that are not part of the default site build. + +2~ Document Version Control Information + +The possibility of citing an exact document version. + +Permits the inclusion of document version control information to the document body and metatags.~{ from a version control system such as CVS }~ This provides a much more certain method of referring to the exact version of a particular document, (assuming that the document is from a trusted source, that will retain earlier versions of a document).~{ The version control system must be run, so the version number is obtained, prior to the SiSU document generation, and subsequent posting of the document. }~ + +This information (where available) is provided under the section of the document titled "Document Information - MetaData", near the end of a document, for example in the segmented html version of this text at: http://www.jus.uio.no/sisu/SiSU/metadata.html + +2~ Table of contents + +SiSU produces a rudimentary a table of contents based on document headings. + +2~ Auto-numbering of headings + +Headings can be automatically numbered, (and automatically named for hyper-linking) + +2~ Numbering and cross-hyperlinking of endnotes + +SiSU can automatically number footnotes/endnotes. This is the default operation where no number is provided. + +Footnotes/endnotes may also be manually numbered. Where a number, or numbers are provided for a footnote/endnote, this does not increment the automatic footnote/endnote number counter. + +In the html output footnotes/endnotes are cross-hyper-linked (to their reference point and vice versa). In th pdf output footnotes are linked from their reference point only. + +2~ "Skinnable" + +SiSU is skinnable, on a site-wide, directory-wide and per document basis, so different looking versions of things may be produced with little difficulty. There is a default skin which may be modified, as the background site skin, and each working directory may have a skin associated with it, as may each individual document. The hierarchy of application is document, directory, then site... ie if a document skin exists it gets precedence. + +Whilst it is skinnable, the default output styles are selected to work across the widest possible range of document types. + +2~ Multiple Outputs + +From markup that is simpler and more sparse than html you get: + +_* far greater output possibilities, including multiple html types, XML (different structured types), LaTeX (pdf landscape, portrait), and SQL (Postgresql or SQLite or other); + +_* the advantages implicit in these very different output possibilities;~{ e.g. LaTeX (professional document typesetting, easy conversion to pdf or Postscript), XML (in this case, structural representation), SQL (e.g. document set searches; representation of the constituent parts of documents based on their structure, headings, chapters, paragraphs as desired; control of use) }~ + +_* a common citation system + +As many output formats/presentations as one cares to write modules for - several types of html (e.g. structure based on css, or structure based on tables); /{LaTeX/pdf}/ and /{Lout/pdf}/; pgsql other databases easily added; yaml... + +3~ html - several presentations: full length & segmented; css & table based + +Most documents are produced in single and segmented html versions, described below: + +!_ The Scroll (full length text presentations) + +The full length of the text in a single scrollable document.~{ CISG http://www.jus.uio.no/lm/un_contracts_international_sale_of_goods_convention_1980/doc <br> The Unidroit Contract Principles http://www.jus.uio.no/lm/unidroit.contract.principles.1994/doc or <br> The Autonomous Contract http://www.jus.uio.no/lm/autonomous.contract.2000.amissah/doc }~ As a rule the files they are saved in are named: /doc/ or more precisely /{doc.html}/ + +For various reasons texts may only be provided in this form (such as this one which is short), though most are also provided as segmented texts. + +"Scroll" is a reference to the historical scroll, a single long document/ parchment, and also no doubt to what you will have to do to get to the bottom of the text.~{ Scrolling is not however necessarily confined to full length documents as you will have to scroll to get to the bottom of any long segment (eg. chapter) of a segmented text. }~ + +!_ The Segmented Text + +The text divided into segments (such as articles or chapters depending on the text)~{ CISG http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980 <br>The Unidroit Principles http://www.jus.uio.no/lm/unidroit.contract.principles.1994 <br> The Autonomous Contract http://www.jus.uio.no/sisu/the.autonomous.contract.2000.amissah or <br> WTA 1994 http://www.jus.uio.no/lm/wta.1994 }~ As a rule the files they are saved in are named: /toc/ and /index/ or more precisely /{toc.html}/ and /{index.html}/ + +If you know exactly what you are looking for, loading a segment of text is faster (the segments being smaller). Occasionally longer documents such as the WTA 1994 http://www.jus.uio.no/lm/wta.1994/toc are only provided in segmented form. + +!_ Cascading Style Sheet, and Table based html + +SiSU outputs html, two current standard forms available are: + +{ css based }http://www.jus.uio.no/sisu/SiSU/toc.html + +and + +table based [largely discontinued]~{ formatting possibility still exists in code tree but maintenance has been largely discontinuted. }~ + +!_ The html is tested across several browsers + +I like to remind you that there are other excellent browsers out there, many of which have long supported practical features like tabbing. + +The html is tested across several browsers, including: + +_* {~^ *Firefox* (Mozilla-Firefox) }http://www.mozilla.org/products/firefox/ + +_* {~^ Kazehakase }http://kazehakase.sourceforge.jp/ + +_* {~^ Konqueror }http://www.konqueror.org/ + +_* {~^ Mozilla }http://www.mozilla.org/ + +_* {~^ MS Internet Explorer }http://www.microsoft.com/windows/ie/default.asp + +_* {~^ Netscape }http://home.netscape.com/comprod/mirror/client_download.html + +_* {~^ Opera }http://www.opera.com/ + +Also lighter weight graphical browsers: + +_* {~^ Dillo }http://www.dillo.org/ + +_* {~^ *Epiphany* }http://www.gnome.org/projects/epiphany/ + +_* {~^ *Galeon* }http://galeon.sourceforge.net/ + +And for console/text browsing: + +_* {~^ *elinks* }http://elinks.or.cz/ + +_* {~^ *links2* }http://links.twibright.com/ + +_* {~^ *w3m* }http://w3m.sourceforge.net/ + +The html tables output is rendered more accurately across a wider variety set and older versions of browsers (than the html css output). + +3~ XML + +SiSU generates well formed XML, and multiple versions. An XML SAX version with a flat/shallow structure, and XML DOM version with a deeper (embedded) structure. There is also a released working xhtml module. Examples of SAX and DOM versions are provided within this document. + +3~ ODT:ODF, Open Document Format - ISO/IEC 26300:2006 + +SiSU generates Open Document Output format. + +3~ PDF - portrait and landscape, (through the generation of LaTeX output which is then transformed to pdf) + +SiSU outputs LaTeX if required which is easily transformed to PDF.~{ LaTeX and pdf features introduced 18^th^ June 2001, Landscape and portrait pdfs introduced 7^th^ October 2001., Lout is a more recent addition 22^th^ April 2003 }~ PDF documents are generated on the site from the same source files and Ruby program that produce html. Landscape oriented pdf introduced, providing easier screen viewing, they are also (paper saving, being currently) formatted to have fewer pages than their portrait equivalents. + +_* {~^ Adobe Reader }http://www.adobe.com/products/acrobat/readstep2.html + +_* {~^ *Evince* }http://www.gnome.org/projects/evince/ + +_* {~^ xpdf }http://www.foolabs.com/xpdf/ + +3~ Search - loading/populating of relational database while retaining document structure information, object citation numbering and other features (currently PostgreSQL and/or SQLite) + +SiSU (from the same markup input file) automatically feeds into PostgreSQL~{ http://www.postgresql.org/ <br> http://advocacy.postgresql.org/ <br> http://en.wikipedia.org/wiki/Postgresql }~ and/or SQLite~{ http://www.hwaci.com/sw/sqlite/ <br> http://en.wikipedia.org/wiki/Sqlite }~ database (could be any other of the better relational databases)~{ Relational database features retaining document structure and citation introduced 15^th^ July 2002 }~ - together with all additional information related to document structure, and the alternative ways in which it is generated on the site retained. As regards scaling of the database, it is as scalable as the database (here Postgresql or SQLite) and hardware allow. I will prune the images later. + +This is one of the more interesting output forms, as all the structural data for 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 pgsql database tables: + +_1* one containing semantic (and other) headers, including, title, author, subject, (the Dublin Core...); + +_1* another the substantive texts by individual "paragraph" (or object) - along with structural information, each paragraph being identifiable by its paragraph number (if it has one which almost all of them do), and the substantive text of each paragraph quite naturally being searchable (both in formatted and clean text versions for searching); and + +_1* a third containing endnotes cross-referenced back to the paragraph from which they are referenced (both in formatted and clean text versions for searching). + +_1* a fourth table with a one to one relation with the headers table contains full text versions of output, eg. pdf, html, xml, and ascii. + +There is of course the possibility to add further structures. + +At this level SiSU loads a relational database with documents broken in to their smallest logical structurally constituent parts, as text objects, with their object citation number and all other structural information needed to construct the structured 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. + +Because the document structure of sites created is clearly defined, and the text object citation system is available 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. + +The combination of the SiSU citation system with a relational database is pretty powerful, giving rise to several possibilities. As individual text objects of a document stored (and indexed) together with 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). + +This is a larger scale project, (with little development on the front end largely ignored), though the "infrastructure" has been in place since 2002. + +3~ Search - database frontend sample, utilising database and SiSU features, including object citation numbering (backend currently PostgreSQL) *~search + +{~^ Sample search frontend }http://search.sisudoc.org +A small database and sample query front-end (search from) that makes use of the citation system, _{object citation numbering}_ to demonstrates functionality.~{ (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. }~ + +SiSU 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. + +(further work needs to be done on the sample search form, which is rudimentary and only passes simple booleans correctly at present to the SQL engine) + +A few canned searches, showing object numbers. Search for: + +{ English documents matching Linux OR Debian }http://search.sisudoc.org?s1=Linux%2BOR%2BDebian&lang=En&db=SiSU_sisu&view=index&a=1 + +{ GPL OR Richard Stallman }http://search.sisudoc.org?s1=GPL%2BOR%2BRichard%2BStallman&lang=En&db=SiSU_sisu&view=index&a=1 + +{ invention OR innovation in English language }http://search.sisudoc.org?s1=invention%2BOR%2Binnovation&lang=En&db=SiSU_sisu&view=index&a=1 + +{ copyright in English language documents }http://search.sisudoc.org?s1=copyright&lang=En&db=SiSU_sisu&view=index&a=1 + +Note that the searches done in this form are case sensitive. + +Expand those same searches, showing the matching text in each document: + +{ English documents matching Linux OR Debian }http://search.sisudoc.org?s1=Linux%2BOR%2BDebian&lang=En&db=SiSU_sisu&view=text&a=1 + +{ GPL OR Richard Stallman }http://search.sisudoc.org?s1=GPL%2BOR%2BRichard%2BStallman&lang=En&db=SiSU_sisu&view=text&a=1 + +{ invention OR innovation in English language }http://search.sisudoc.org?s1=invention%2BOR%2Binnovation&lang=En&db=SiSU_sisu&view=text&a=1 + +{ copyright in English language documents }http://search.sisudoc.org?s1=copyright&lang=En&db=SiSU_sisu&view=text&a=1 + +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.~{ 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. }~ + +!_ OCN index mode, +(object citation number) the numbers displayed are relevant (and may be used to reference the match) in any sisu generated rendition of the text~{ OCN are provided for HTML, XML, pdf ... though currently omitted in plain-text and opendocument format output }~ the links provided are to the locations of matches within the html generated by SiSU. + +!_ Paragraph mode, +you may alternatively display the text of each paragraph in which the match was made, again the object/paragraph numbers are relevant to any SiSU generated/published text. + +Several options for output - select database to search, show results in index view (links to locations within text), show results with text, echo search in form, show what was searched, create and show a "canned url" for search, show available search fields. Also shows counters number of documents in which found and number of locations within documents where found. [could consider sorting by document with most occurrences of the search result]. + +Earlier version of the search frontend - Simple search, results with files in which search found, and locations where found within files. + +Simple search, results with files in which search found, and text object (paragraph or endnote) where found within files. + +3~ Other forms + +There are other forms as well, YAML file, Ruby Marshal dumps, document pre-processing (processing of documents prior to the steps described here, to produce input suitable for the program) snap in a new module as required/desired, well formed XML, no problem. + +2~ Concordance / Word Map or rudimentary index + +Concordance /WordMaps:~{ Concordance/ WordMaps introduced 15^th^ August 2002 }~ SiSU produces a rudimentary index based on the words within the text, making use of paragraph numbers to identify text locations. This is generated in html and hyper-linked but identifies these words locations in the other document formats. Though it is possible to search using a search engine, this is a means for browsing an alphabetical list of words which may suggest other useful content. + +% Concordance files may be built using a document vocabulary. The vocabulary to be used may be specified on a per document basis. + +2~ Managed (document) directory, database, or site structure + +SiSU builds the web site (or more generically provides a suitable directory structure) - placing various output texts in the hierarchy of the web-site (or db), which (for directories) is a sub-directory with the name of the text file. + +2~ Batch processing + +SiSU is a batch processing tool, handling and transforming multiple (or individual) documents (in many ways) with a single instruction. + +2~ Integration to superior Gnu/Linux and Unix tools + +As should have been noted by the above description of SiSU, it makes use of existing programs found on Gnu/Linux and Unix, amongst those already mentioned include the LaTeX to pdf converters and the database PostgreSQL or SQLite. + +3~ Backup and version control + +Unix provides many tools for version control. For documents Subversion, CVS and even the old RCS are useful for the per-document histories they provide. + +For writing code superior (more recent) version control system exist. These can also be used for documents though they tend to take stamps of changes across the repository as a whole, rather than for each individual file that is tracked, (as CVS and RCS do). My personal preference is for distributed systems such as Git, Mercurial or Darcs, of which I use Git for both code and documents. + +Several backup tools exist. At the base level I tend to use rdiff. + +3~ Editor support + +SiSU documents are prepared / marked up in utf-8 text _{you are free to use the text editor of your choice.}_ + +Syntax highlighting for a number of editors are provided. Amongst them Vim, Kwrite, Kate, Gedit and diakonos. These may be found with configuration instructions at http://www.jus.uio.no/sisu/syntax_highlight. {~^ Vim }http://www.vim.org/ as of version 7 has built in sytax highlighting for SiSU. + +2~ Modular design, need something new add a module + +Need a new output format that does not already exist, write a new module. + +Prefer a new input syntax, you could write a new syntax matching the existing design, though my personal preference is some uniformity in entry appearance. If necessary has been fairly easy to extend the design parameters. It is intended to incorporate some additional basic semantic tagging, (book, article, author etc.) However, keeping the requirements for input minimal, and relatively simple has been a design goal. + diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_download.ssi b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_download.ssi new file mode 100644 index 00000000..a7ac8484 --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_download.ssi @@ -0,0 +1,162 @@ +% SiSU insert 0.57 + +@title: SiSU - SiSU information Structuring Universe / Structured information, Serialized Units + +@subtitle: Download, Stable and Development Branches + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2007-08-28 + +@date.issued: 2007-08-28 + +@date.available: 2007-08-28 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +% @rcs$ + +:A~? @title @creator + +:B~? SiSU Downloads, Stable and Development Branches + +:C~? Download information + +1~download Download SiSU - Linux/Unix + +2~current- SiSU Current Version - Linux/Unix + +3~source- Source (tarball tar.gz) + +Download the latest version of SiSU (and SiSU markup samples):~{ Breakage and Fixes Report<br> http://www.jus.uio.no/sisu/SiSU/breakage_and_fixes.html }~ + +_* {~^ sisu_0.58.3.orig.tar.gz (of 2007-09-05:36/3) }http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu_0.58.3.orig.tar.gz ~{ <br>e9a20a06ffee8d633b8ce525017d89ba 1278987 }~ + +_1 cgi generated sample search form + +_2 order results on files of the same title, in multiple files (with different filenames) + +_2 postgresql, character case sensitivity, control, on/off + +_2 tail decoration, gplv3 & sisu info + +_1 texinfo/info (pinfo) module starts to do something vaguely useful again [not a much used module, testing required] + +_1 print XML rendition of document structure to screen -T + +_1 help on environment visited, sisu -V + +_1 sisurc.yml default, color set to true [apologies if this causes anyone any inconvenience, it is configurable in sisurc.yml] + +_1 help and man pages, some work man(8) related + +_1 sisu-install (install ruby rant script renamed) and permissions set to executable + +_* {~^ sisu-markup-samples_1.0.8.orig.tar.gz (of 2007-08-19:33/7 ) }http://www.jus.uio.no/sisu/archive/pool/non-free/s/sisu-markup-samples/sisu-markup-samples_1.0.7.orig.tar.gz ~{ <br>04ae2812617a4689666600a0fb32301f 3438571 }~ *~sisu-markup-samples + +For installation notes see http://www.jus.uio.no/sisu/SiSU/download.html + +For changelogs see http://www.jus.uio.no/sisu/SiSU/changelog.html + +{ tulva.png 425x339 "Tulva, by Leena Krohn" }http://www.jus.uio.no/sisu/SiSU ~{ Reproduced with the kind permission of author and artist Leena Krohn, http://www.kaapeli.fi/krohn Tulva is from the work Sphinx or Robot http://www.jus.uio.no/sisu/sphinx_or_robot.leena_krohn.1996 other works available online include Tainaron http://www.jus.uio.no/sisu/tainaron.leena_krohn.1998, these two works can be found in the book sample section http://www.jus.uio.no/sisu/SiSU/2.html#sample }~ + +3~git- Git (source control management) + +Git repository currently at: + +_* git clone git://sisudoc.org/git/sisu/ + +_* http://search.sisudoc.org/cgi-bin/gitweb.cgi?p=sisu;a=summary + +3~debian- Debian + +This section contains information on the latest SiSU release. For installation notes see http://www.jus.uio.no/sisu/sisu_download/installation.html + +SiSU is updated fairly regularly in Debian testing and unstable, and should be available therefrom. + +To add this archive, should you still choose to do so, add the following lines to your /etc/apt/sources.list + +code{ + +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 + +}code + +!_ Source + +_* {~^ sisu_0.58.3.orig.tar.gz }http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu_0.58.3.orig.tar.gz + +_* {~^ sisu_0.58.3-1.diff.gz }http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu_0.58.3-1.diff.gz + +_* {~^ sisu_0.58.3-1.dsc }http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu_0.58.3-1.dsc ~{ <br>b8330f8b97a15e6eaecba8f2616acb10 606 sisu_0.58.3-1.dsc }~ + +!_ Debs + +_* {~^ sisu_0.58.3-1_all.deb }http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu_0.58.3-1_all.deb ~{ <br>sisu, the base code, (the main package on which the others depend), without any dependencies other than ruby (and for convenience the ruby webrick web server), this generates a number of types of output on its own, other packages provide additional functionality, and have their dependencies <br>Depends: ruby (>=1.8.2), libwebrick-ruby<br>Recommends: sisu-pdf, sisu-sqlite, sisu-postgresql, sisu-examples, vim-sisu, librmagick-ruby, trang, tidy, libtidy, librexml-ruby, zip, unzip, openssl }~ + +_* {~^ sisu-complete_0.58.3-1_all.deb }http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu-complete_0.58.3-1_all.deb ~{ <br>a package that pulls in other packages to build the whole of sisu (excluding sisu-examples) <br>Depends: ruby (>=1.8.2), sisu, sisu-pdf, sisu-postgresql, sisu-remote, sisu-sqlite, vim-sisu<br>Recommends: sisu-examples }~ + + +_* {~^ sisu-pdf_0.58.3-1_all.deb }http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu-pdf_0.58.3-1_all.deb ~{ <br>dependencies used by sisu to produce pdf from LaTeX generated <br>Depends: sisu, tetex-bin, tetex-extra, latex-ucs<br>Suggests: evince, xpdf }~ + +_* {~^ sisu-postgresql_0.58.3-1_all.deb }http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu-postgresql_0.58.3-1_all.deb ~{ <br>dependencies used by sisu to populate postgresql database (further configuration is necessary) <br>Depends: sisu, postgresql-8.1, libdbi-ruby, libdbm-ruby, libdbd-pg-ruby<br>Suggests: pgaccess, libdbd-pgsql, postgresql-contrib-8.1 }~ + +_* {~^ sisu-sqlite_0.58.3-1_all.deb }http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu-sqlite_0.58.3-1_all.deb ~{ <br>dependencies used by sisu to populate sqlite database <br>Depends: sisu, sqlite, libdbi-ruby, libdbm-ruby, libdbd-sqlite-ruby<br>Suggests: libdbd-sqlite }~ + +For changelogs see: + +_1 http://www.jus.uio.no/sisu/SiSU/changelog.html + +_1 http://www.jus.uio.no/sisu/sisu_changelog/changelog.html + +!_ non-free + +Book markup samples have been moved to non-free as the substantive text of the documents are available under the author or original publisher's license, and usually do not comply with the Debian Free Software Guidelines. + +_* {~^ sisu-markup-samples_1.0.8-1_all.deb }http://www.jus.uio.no/sisu/archive/pool/non-free/s/sisu-markup-samples/sisu-markup-samples_1.0.8-1_all.deb ~{ <br>marked up documents and other examples related to sisu, a larger package containing a number of texts <br>Depends: sisu }~ + +_* {~^ sisu-markup-samples_1.0.8-1.dsc }http://www.jus.uio.no/sisu/archive/pool/non-free/s/sisu-markup-samples/sisu-markup-samples_1.0.8-1.dsc ~{ <br>ca03c11467097d6049c43c54d0961ef5 606 sisu-markup-samples_1.0.8-1.dsc }~ + +For changelogs see: + +_1 http://www.jus.uio.no/sisu/SiSU/changelog_markup_samples.html + +_1 http://www.jus.uio.no/sisu/sisu_markup_samples_changelog/changelog_markup_samples.html + +3~rpm- RPM + +The RPM is generated from the source file using Alien.~{ http://www.kitenet.net/programs/alien/ }~ Dependencies are not handled, not even that of the essential Ruby. + +_* {~^ sisu_0.58.3.orig-1-2.noarch.rpm }http://www.jus.uio.no/sisu/pkg/rpm/sisu_0.58.3.orig-1-2.noarch.rpm ~{ <br>31f5cd3e0e577b418e7c98492f71f0af<br> untested, created using: alien -r sisu_0.58.3.orig.tar.gz }~ + +_* {~^ sisu-0.58.3-2.noarch.rpm }http://www.jus.uio.no/sisu/pkg/rpm/sisu-0.58.3-2.noarch.rpm ~{ <br>8b6858f0117351ce441e8559bf5308be<br> untested, created using: alien -r sisu_0.58.3-1_all.deb }~ + +_* {~^ sisu-markup-samples_1.0.8.orig-2.noarch.rpm }http://www.jus.uio.no/sisu/pkg/rpm/sisu-markup-samples_1.0.6.orig-2.noarch.rpm ~{ <br>15eed830b4d004f011bafe831bb816da<br> untested, created using alien }~ + +sudo rpm -i [package name] diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_examples.ssi b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_examples.ssi new file mode 100644 index 00000000..581a53a6 --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_examples.ssi @@ -0,0 +1,58 @@ +% SiSU 0.57 + +@title: SiSU - SiSU information Structuring Universe / Structured information, Serialized Units + +@subtitle: Markup Samples, Output Examples + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2002-11-12 + +@date.issued: 2002-11-12 + +@date.available: 2002-11-12 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +% @rcs:+ $Id$ + +:A~? @title @creator + +:B~? SiSU Markup and Output Examples + +% :C~? SiSU Markup and Output Examples + +1~examples Markup and Output Examples + +2~ Markup examples *~markup + +Current markup examples and document output samples are provided at http://www.jus.uio.no/sisu/SiSU/2.html + +Some markup with syntax highlighting may be found under http://www.jus.uio.no/sisu/sample/syntax but is not as up to date. + +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. diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_examples.sst b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_examples.sst new file mode 100644 index 00000000..e63eefca --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_examples.sst @@ -0,0 +1,218 @@ +% SiSU 0.57 + +@title: SiSU - SiSU information Structuring Universe / Structured information, Serialized Units + +@subtitle: Markup Samples, Output Examples + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2002-11-12 + +@date.issued: 2002-11-12 + +@date.available: 2002-11-12 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +@rcs:+ $Id: sisu_examples.sst,v 1.25 2007/09/08 17:12:47 ralph Exp $ + +:A~? @title @creator + +:B~? SiSU Markup and Output Examples + +1~examples Markup and Output Examples + +2~ Markup examples *~markup + +Current markup examples and document output samples are provided at http://www.jus.uio.no/sisu/SiSU/2.html + +Some markup with syntax highlighting may be found under http://www.jus.uio.no/sisu/sample/syntax but is not as up to date. + +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. + +<:pb> + +2~ A few book (and other) examples *~books *~sample *~example *~output + +{ aukio.png 397x340 "Aukio, by Leena Krohn" }http://www.jus.uio.no/sisu/SiSU ~{ Reproduced with the kind permission of author and artist Leena Krohn, http://www.kaapeli.fi/krohn "Aukio" is from the work /{"Sphinx or Robot"}/ http://www.jus.uio.no/sisu/sphinx_or_robot.leena_krohn.1996 which is included as a book example in this section, together with another of the author's works, /{"Tainaron"}/ http://www.jus.uio.no/sisu/tainaron.leena_krohn.1998 }~ + +3~wealth_of_networks- /{"The Wealth of Networks"}/, Yochai Benkler + +{ "The Wealth of Networks", Yochai Benkler [3sS]}the_wealth_of_networks.yochai_benkler.sst + +3~freeculture- /{"Free Culture"}/, Lawrence Lessig + +{ "Free Culture", Lawrence Lessig [3sS]}free_culture.lawrence_lessig.sst + +3~free_as_in_freedom- /{"Free as in Freedom: Richard Stallman's Crusade for Free Software"}/, by Sam Williams + +{ "Free as in Freedom: Richard Stallman's Crusade for Free Software", by Sam Williams [3sS]}free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst + +3~free_for_all- /{"Free For All: How Linux and the Free Software Movement Undercut the High Tech Titans"}/, by Peter Wayner + +{ "Free For All: How Linux and the Free Software Movement Undercut the High Tech Titans", by Peter Wayner [3sS]}free_for_all.peter_wayner.sst + +3~catb- /{"The Cathedral and the Bazaar"}/, by Eric S. Raymond + +{ "The Cathedral and the Bazaar", by Eric S. Raymond [3sS]}the_cathedral_and_the_bazaar.eric_s_raymond.sst + +3~accelerando- /{"Accelerando"}/, Charles Stross *~stross + +{ "Accelerando", Charles Stross [3sS]}accelerando.charles_stross.sst *~accelerando + +3~tainaron- /{"Tainaron"}/, Leena Krohn *~krohn + +{ "Tainaron", Leena Krohn [3sS]}tainaron.leena_krohn.1998.sst *~tainaron + +3~sphinx- /{"Sphinx or Robot"}/, Leena Krohn *~sor + +{i_sor.png 294x59 "Sphinx or Robot by Leena Krohn" }http://www.jus.uio.no/sisu/sphinx_or_robot.leena_krohn.1996 + +{ "Sphinx or Robot", Leena Krohn [3sS]}sphinx_or_robot.leena_krohn.1996.sst + +3~war_and_peace- /{"War and Peace"}/, Leo Tolstoy, PG Etext 2600 *~wap *~gutenberg + +{ "War and Peace", Leo Tolstoy [3sS]}war_and_peace.leo_tolstoy.sst ~{ http://www.jus.uio.no/sisu/war_and_peace.leo_tolstoy/toc.html <br> The ascii text was taken from Project Gutenberg. The markup transforms required are trivial. Of interest, in this instance I am saved by having alternative syntaxes/(structural modes) for marking up endnotes... as it was possible to do a simple search and replace to make the Project Gutenberg ascii presentation suitable for SiSU, using the older endnote markup style. This example instructs the program to use regular expressions, in this example the words: none; none; BOOK|FIRST|SECOND; CHAPTER; occurring at the beginning of a line, to identify what should be treated as different levels of heading in a document (and used to make the table of contents). Note that there was _{very little markup required}_ after the document headers and Project Gutenberg legal notices. As I presume the legal notices are similar in Project Gutenberg documents, (and I could not bear to think of preparing the same legal notices twice), I moved those to the "skin" for the Project, and these are now represented in the markup by \<:insert1\> and \<:insert2\> and the legal notices are available for similar insertion into the next Project Gutenberg text prepared for SiSU, should there be one. <br> I did a stylesheet/skin for the Gutenberg Project, ... I may have to remove. The markup transforms required are trivial. Of interest, in this instance I am saved by having alternative syntaxes/(structural modes) for marking up endnotes... as it is possible to do a simple search and replace to make Project Gutenberg ascii presentations suitable for SiSU using the older endnote markup style. There is _{very little markup required}_ after the document headers and Project Gutenberg legal notices. As I presume the legal notices are similar in Project Gutenberg documents, (and I could not bear to think of preparing the same legal notices twice), I moved those to the "skin" for the Project, and these are now represented in the markup by the \<:insert1\> and \<:insert2\> markers and the legal notices are available for similar insertion into the next Project Gutenberg text prepared for SiSU, should there be one. }~ + +3~quixote- /{"Don Quixote"}/, Miguel de Cervantes [Saavedra], translated by John Ormsby, PG Etext 996 + +{ "Don Quixote", Miguel de Cervantes [Saavedra] [3sS]}don_quixote.miguel_de_cervantes.sst + +3~gulliver- /{"Gulliver's Travels"}/, Jonathan Swift, transcribed from the 1892 George Bell and Sons edition by David Price, PG Etext 829 *~swift + +{ "Gulliver's Travels", Jonathan Swift [3sS]}gullivers_travels.jonathan_swift.sst + +3~alice- /{"Alice's Adventures in Wonderland"}/, Lewis Carroll, PG Etext 11 + +{ "Alice's Adventures in Wonderland", Lewis Carroll [3sS]}alices_adventures_in_wonderland.lewis_carroll.sst + +3~glass- /{"Through The Looking-Glass"}/, Lewis Carroll, PG Etext 12 + +{ "Through The Looking-Glass", Lewis Carroll [3sS]}through_the_looking_glass.lewis_carroll.sst + +3~alice- /{"Alice's Adventures in Wonderland"}/ and /{"Through The Looking-Glass"}/, Lewis Carroll, PG Etexts 11 and 12 + +{ "Alice's Adventures in Wonderland" and "Through The Looking-Glass", Lewis Carroll [3sS]}alices_adventures_in_wonderland_and_through_the_looking_glass.lewis_carroll.ssm + +3~gpl- /{"Gnu Public License 2"}/, (GPL 2) Free Software Foundation + +{ "Gnu Public License 2", (GPL 2) Free Software Foundation [3sS]}gpl2.fsf.sst + +3~gpl- /{"Gnu Public License v3 - Third discussion draft"}/, (GPLv3) Free Software Foundation + +{ "Gnu Public License 3 - Third discussion draft", (GPL v3 draft3) Free Software Foundation [3sS]}gpl3_draft3.fsf.sst + +3~dsc- /{"Debian Social Contract"}/ + +{ "Debian Social Contract" [3sS]}debian_social_contract_v1.1.sst + +3~dc- /{"Debian Constitution v1.3"}/, (simple/default markup) + +{ "Debian Constitution v1.3" [3sS]}debian_constitution_v1.3.sst + +3~dc- /{"Debian Constitution v1.3"}/, (markup adjusted for output to more closely match the original) + +{ "Debian Constitution v1.3", (markup adjusted for output to more closely match the original) [3sS]}debian_constitution_v1.3.adjusted.sst + +3~dc- /{"Debian Constitution v1.2"}/, (simple/default markup) + +{ "Debian Constitution v1.2 (more translations)" [3sS]}debian_constitution_v1.2.sst + +3~dc- /{"Debian Constitution v1.2"}/, (markup adjusted for output to more closely match the original) + +{ "Debian Constitution (more translations)", (markup adjusted for output to more closely match the original) [3sS]}debian_constitution_v1.2.adjusted.sst + +3~terminology- /{"A Uniform Sales Terminology"}/, Vikki Rogers and Albert Kritzer + +{ "A Uniform Sales Terminology", Vikki Rogers and Albert Kritzer [3sS]}a_uniform_international_sales_terminology.vikki_rogers.and.albert_kritzer.sst + +3~autonomous- /{"The Autonomous Contract" 1997 }/ - markup sample + +{ "The Autonomous Contract" 1997 - markup sample [3sS]}the_autonomous_contract.amissah.19970710.sst + +3~autonomous- /{"The Autonomous Contract Revisited"}/ - markup sample + +{ "The Autonomous Contract Revisited" - markup sample [3sS]}autonomy_markup0.sst ~{ http://www.jus.uio.no/sisu/autonomy_markup0/toc.html <br> alternative markup variations revolving around endnotes<br> (i) as above, markup with embedded endnotes, and header list of words/phrases to emphasise<br> http://www.jus.uio.no/sisu/sample/syntax/autonomy_markup0.sst.html <br> http://www.jus.uio.no/sisu/sample/markup/autonomy_markup0.sst <br>(ii) Again markup with embedded endnotes, but font faces changed within paragraphs rather than in header as in i <br> http://www.jus.uio.no/sisu/sample/syntax/autonomy_markup1.sst.html <br> http://www.jus.uio.no/sisu/sample/markup/autonomy_markup1.sst <br> (iii) Markup with endnote placemarks within paragraphs, the endnotes following the paragraph that contains them http://www.jus.uio.no/sisu/sample/syntax/autonomy_markup2.sst.html <br> http://www.jus.uio.no/sisu/sample/markup/autonomy_markup2.sst <br>(iv) Another alternative is to place the marked up endnotes sequentially and at the end of the text. This also works. The paragraph variant iii is perhaps easier to visually check should there be missing endnotes; but this variant iv may better suit the conversion of alternatively pre-prepared documents. }~ + +3~cisg- /{"United Nations Convention on Contracts for the International Sale of Goods"}/ + +{ "United Nations Convention on Contracts for the International Sale of Goods" [3sS]}un_contracts_international_sale_of_goods_convention_1980.sst ~{ http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/toc.html <br>This example instructs the program to use regular expressions, in this example the words: Part, Chapter, Section, Article occurring at the beginning of a line, to identify what should be treated as different levels of heading in a document (and used to make the table of contents). <br>This example instructs the program to use regular expressions, in this example the words: Part, Chapter, Section, Article occurring at the beginning of a line, to identify what should be treated as different levels of heading in a document (and used to make the table of contents). }~ + +3~pecl- /PECL/ the "Principles of European Contract Law" + +{ "Principles of European Contract Law" [3sS]}eu_contract_principles_parts_1_to_3_2002.sst + +2~sql SQL - PostgreSQL, SQLite + +A Sample search form is available at http://search.sisudoc.org + +A few canned searches, showing object numbers. Search for: + +_1 { English documents matching Linux OR Debian }http://search.sisudoc.org?s1=Linux%2BOR%2BDebian&lang=En&db=SiSU_sisu&view=index&a=1 + +_1 { GPL OR Richard Stallman }http://search.sisudoc.org?s1=GPL%2BOR%2BRichard%2BStallman&lang=En&db=SiSU_sisu&view=index&a=1 + +_1 { invention OR innovation in English language }http://search.sisudoc.org?s1=invention%2BOR%2Binnovation&lang=En&db=SiSU_sisu&view=index&a=1 + +_1 { copyright in English language documents }http://search.sisudoc.org?s1=copyright&lang=En&db=SiSU_sisu&view=index&a=1 + +Note that the searches done in this form are case sensitive. + +Expand those same searches, showing the matching text in each document: + +_1 { English documents matching Linux OR Debian }http://search.sisudoc.org?s1=Linux%2BOR%2BDebian&lang=En&db=SiSU_sisu&view=text&a=1 + +_1 { GPL OR Richard Stallman }http://search.sisudoc.org?s1=GPL%2BOR%2BRichard%2BStallman&lang=En&db=SiSU_sisu&view=text&a=1 + +_1 { invention OR innovation in English language }http://search.sisudoc.org?s1=invention%2BOR%2Binnovation&lang=En&db=SiSU_sisu&view=text&a=1 + +_1 { copyright in English language documents }http://search.sisudoc.org?s1=copyright&lang=En&db=SiSU_sisu&view=text&a=1 + +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.~{ 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. }~ + +2~ Lex Mercatoria as an example + +There is quite a bit to peruse if you explore the site Lex Mercatoria: + +http://www.lexmercatoria.org/ ~{ http://www.jus.uio.no/lm/index }~ + +or perhaps: + +http://lexmercatoria.org/treaties.and.organisations/lm.chronological ~{ http://www.jus.uio.no/lm/treaties.and.organisations/lm.chronological }~ + +2~ For good measure the markup for a document with lots of (simple) tables + +SiSU is not optimised for table making, but does handle simple tables. + +_* {~^ SiSU marked up file with tables }http://www.jus.uio.no/sisu/sample/syntax/un_conventions_membership_status.sst.html ~{ <br> http://www.jus.uio.no/sisu/sample/markup/un_conventions_membership_status.sst }~ + +_* {~^ Output of table file example }http://www.jus.uio.no/lm/un_conventions_membership_status/toc.html + +2~ And a link to the output of a reported case + +http://www.jus.uio.no/lm/england.fothergill.v.monarch.airlines.hl.1980/toc.html diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_faq.sst b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_faq.sst new file mode 100644 index 00000000..5e065ff7 --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_faq.sst @@ -0,0 +1,191 @@ +% SiSU 0.57 + +@title: SiSU - SiSU information Structuring Universe / Structured information, Serialized Units + +@subtitle: FAQ - Frequently Asked/Answered Questions + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2006-09-06 + +@date.available: 2006-09-06 + +@date.issued: 2006-09-06 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +% @rcs: $Id$ + +:A~? @title @creator + +1~faq FAQ - Frequently Asked/Answered Questions + +2~ Why are urls produced with the -v (and -u) flag that point to a web server on port 8081 ? + +Try the following rune: + +_* sisu -W + +This should start the ruby webserver. It should be done after having produced some output as it scans the output directory for what to serve. + +2~ I cannot find my output, where is it? + +The following should provide help on output paths: + +_* sisu --help env + +_* sisu -V [same as the previous command] + +_* sisu --help directory + +_* sisu --help path + +_* sisu -U [filename] + +_* man sisu + +2~ I do not get any pdf output, why? + +SiSU produces LaTeX and pdflatex is run against that to generate pdf files. + +If you use Debian the following will install the required dependencies + +_* aptitude install sisu-pdf + +the following packages are required: tetex-bin, tetex-extra, latex-ucs + +2~ Where is the latex (or some other interim) output? + +Try adding -M (for maintenance) to your command flags, e.g.: + +_* sisu -HpMv [filename] + +this should result in the interim processing output being retained, and information being provided on where to find it. + +_* sisu --help directory + +_* sisu --help path + +should also provide some relevant information as to where it is placed. + +2~ Why isn't SiSU markup XML + +I worked with text and (though I find XML immensely valuable) disliked noise +... better to sidestep the question and say: + +SiSU currently "understands" three XML input representations - or more accurately, converts from three forms of XML to native SiSU markup for processing. The three types correspond to SAX (structure described), DOM (structure embedded, whole document must be read before structure is correctly discernable) and node based (a tree) forms of XML document structure representation. Problem is I use them very seldom and check that all is as it should be with them seldom, so I would not be surprised if something breaks there, but as far as I know they are working. I will check and add an XML markup help page before the next release. There already is a bit of information in the man page under the title SiSU VERSION CONVERSION + +_1 sisu --to-sax [filename/wildcard] + +_1 sisu --to-dom [filename/wildcard] + +_1 sisu --to-node [filename/wildcard] + +The XML should be well formed... must check, but lacks sensible headers. Suggestions welcome as to what to make of them. [For the present time I am satisfied that I can convert (both ways) between 3 forms of XML representation and SiSU markup]. + +_1 sisu --from-xml2sst [filename/wildcard] + +2~ LaTeX claims to be a document preparation system for high-quality typesetting. Can the same be said about SiSU? + +% what are some similarities and differences between LaTex and SiSU? + +SiSU is not really about type-setting. + +LaTeX is the ultimate computer instruction type-setting language for paper based publication. + +LaTeX is able to control just about everything that happens on page and pixel, position letters kerning, space variation between characters, words, paragraphs etc. formula. + +SiSU is not really about type-setting at all. It is about a lightweight markup instruction that provides enough information for an abstraction of the documents structure and objects, from which different forms of representation of the document can be generated. + +SiSU with very little markup instruction is able to produce relatively high quality pdf by virtue of being able to generate usable default LaTeX; it produces "quality" html by generating the html directly; likewise it populates an SQL database in a useful way with the document in object sized chunks and its meta-data. But SiSU works on an abstraction of the document's structure and content and custom builds suitable uniform output. The html for browser viewing and pdf for paper viewing/publishing are rather different things with different needs for layout - as indeed is what is needed to store information in a database in searchable objects. + +% SiSU is a lightweight document abstraction, meta-(structure and markup) syntax designed to make use of a minimal amount of preparation detail that can be used across very different ways of representing documents + +The pdfs or html produced for example by open office based on open document format and other office/word processor suits usually attempt to have similar looking outputs - your document rendered in html looks much the same, or in pdf... sisu is less this way, it seeks to have a starting point with as little information about appearance as possible, and to come up with the best possible appearance for each output that can be derived based on this minimal information. + +Where there are large document sets, it provides consistency in appearance in each output format for the documents. + +The excuse for going this way is, it is a waste of time to think much about appearance when working on substantive content, it is the substantive content that is relevant, not the way it looks beyond the basic informational tags - and yet you want to be able to take advantage of as many useful different ways of representing documents as are available, and for various types of output to to be/look as good as it can for each medium/format in which it is presented, (with different mediums having different focuses) and SiSU tries to achieve this from minimal markup. + +2~ How do I create GIN or GiST index in Postgresql for use in SiSU + +This at present needs to be done "manually" and it is probably necessary to alter the sample search form. The following is a helpful response from one of the contributors of GiN to Postgresql Oleg Bartunov 2006-12-06: + +"I have tsearch2 slides which introduces tsearch2 +http://www.sai.msu.su/~megera/wiki/tsearch2slides + +FTS in PostgreSQL is provided by tsearch2, which should works without +any indices (GiST or GIN) ! Indices provide performance, not functionality. + +In your example I'd do ( simple way, just for demo): + +!_ 0. +compile, install tsearch2 and load tsearch2 into your database + +_1 cd contrib/tsearch2; make&&make&&install&&make installcheck; psql DB < tsearch2.sql + +!_ 1. +Add column fts, which holds tsvector + +_1 alter table documents add column fts tsvector; + +!_ 2. +Fill fts column + +_1 update document set fts = to_tsvector(clean); + +!_ 3. +create index - just for performance ! + +_1 create index fts_gin_idx on document using gin(fts); + +!_ 4. +Run vacuum + +_1 vacuum analyze document; + +That's all. + +Now you can search: + +select lid, metadata_tid, rank_cd(fts, q,2)as rank from document, plainto_tsquery('markup syntax') q where q @@ fts order by rank desc limit 10; + +2~ Where is version 1.0? + +SiSU works pretty well as it is supposed to. +Version 1.0 will have the current markup, and directory structure. +At this point it is largely a matter of choice as to when the name change is made. + +The feature set for html,~{ html w3c compliance has been largely met. }~ LaTeX/pdf and opendocument is in place. +XML, and plaintext are in order. + +html and LaTeX/pdf may be regarded as reference copy outputs + +With regard to the populating of sql databases (postgresql and sqlite), there is a bit to be done. + +We are still almost there. diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_filetypes.sst b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_filetypes.sst new file mode 100644 index 00000000..a031691f --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_filetypes.sst @@ -0,0 +1,172 @@ +% SiSU 0.58 + +@title: SiSU + +@subtitle: Filetypes [0.58] + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2002-08-28 + +@date.issued: 2002-08-28 + +@date.available: 2002-08-28 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +% @prefix: + +:A~? @title @creator + +1~filetypes SiSU filetypes + +SiSU has plaintext and binary filetypes, and can process either type of document. + +2~ .sst .ssm .ssi marked up plain text + +SiSU documents are prepared as plain-text (utf-8) files with SiSU markup. They may make reference to and contain images (for example), which are stored in the directory beneath them _sisu/image. SiSU 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. + +SiSU 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. + +SiSU source markup can be shared with the command: + +_1 sisu -s [filename] + +3~ sisu text - regular files (.sst) + +The most common form of document in SiSU, see the section on SiSU markup. + +http://www.jus.uio.no/sisu/sisu_markup + +http://www.jus.uio.no/sisu/sisu_manual + +3~ sisu master files (.ssm) + +Composite documents which incorporate other SiSU documents which may be either regular SiSU text .sst which may be generated independently, or inserts prepared solely for the purpose of being incorporated into one or more master documents. + +The mechanism by which master files incorporate other documents is described as one of the headings under under SiSU markup in the SiSU manual. + +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. + +Note: a secondary file of the composite document is built prior to processing with the same prefix and the suffix ._sst ~{ .ssc (for composite) is under consideration but ._sst makes clear that this is not a regular file to be worked on, and thus less likely that people will have "accidents", working on a .ssc file that is overwritten by subsequent processing. It may be however that when the resulting file is shared .ssc is an appropriate suffix to use. }~ + +http://www.jus.uio.no/sisu/sisu_markup + +http://www.jus.uio.no/sisu/sisu_manual + +3~ sisu insert files (.ssi) + +Inserts are documents prepared solely for the purpose of being incorporated into one or more master documents. They resemble regular SiSU text files except they are ignored by the SiSU 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. + +2~ sisupod, zipped binary container (sisupod.zip, .ssp) + +A sisupod is a zipped SiSU text file or set of SiSU text files and any associated images that they contain (this will be extended to include sound and multimedia-files) + +SiSU 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. + +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 SiSU documents. + +The command to create a sisupod is: + +_1 sisu -S [filename] + +Alternatively, make a pod of the contents of a whole directory: + +_1 sisu -S + +SiSU processing can be done directly against a sisupod; which may be located locally or on a remote server for which a url is provided. + +http://www.jus.uio.no/sisu/sisu_commands + +http://www.jus.uio.no/sisu/sisu_manual + +1~alt Experimental Alternative Input Representations + +2~ Alternative XML + +SiSU 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. + +!_ convert from sst to simple xml representations (sax, dom and node): + +_1 sisu --to-sax [filename/wildcard] or sisu --to-sxs [filename/wildcard] + +_1 sisu --to-dom [filename/wildcard] or sisu --to-sxd [filename/wildcard] + +_1 sisu --to-node [filename/wildcard] or sisu --to-sxn [filename/wildcard] + +!_ convert to sst from any sisu xml representation (sax, dom and node): + +_1 sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] + +or the same: + +_1 sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] + +3~ XML SAX representation + +To convert from sst to simple xml (sax) representation: + +_1 sisu --to-sax [filename/wildcard] or sisu --to-sxs [filename/wildcard] + +To convert from any sisu xml representation back to sst + +_1 sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] + +or the same: + +_1 sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] + +3~ XML DOM representation + +To convert from sst to simple xml (dom) representation: + +_1 sisu --to-dom [filename/wildcard] or sisu --to-sxd [filename/wildcard] + +To convert from any sisu xml representation back to sst + +_1 sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] + +or the same: + +_1 sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] + +3~ XML Node representation + +To convert from sst to simple xml (node) representation: + +_1 sisu --to-node [filename/wildcard] or sisu --to-sxn [filename/wildcard] + +To convert from any sisu xml representation back to sst + +_1 sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] + +or the same: + +_1 sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] + +% .SH "SKINS \- document, directory and site skins" diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_help.sst b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_help.sst new file mode 100644 index 00000000..0ccf8a93 --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_help.sst @@ -0,0 +1,142 @@ +% SiSU 0.58 + +@title: SiSU - SiSU information Structuring Universe + +@subtitle: Manual [0.58] + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2002-08-28 + +@date.issued: 2002-08-28 + +@date.available: 2002-08-28 + +@date.modified: 2007-08-30 + +@date: 2007-08-30 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? SiSU Help + +1~help Help + +2~ SiSU Manual + +The most up to date information on sisu should be contained in the sisu_manual, available at: + +_1 http://www.jus.uio.no/sisu/sisu_manual/ + +and (from SiSU 0.59 onwards) installed locally at: + +_1 /usr/share/doc/sisu/sisu_manual/ + +or equivalent directory + +Within the SiSU tarball at: + +_1 ./data/doc/sisu/sisu_manual/ + +% The manual pages provided with SiSU are also available online, and there is an interactive help, which is being superseded by the man page, and possibly some document which contains this component. + +2~ SiSU man pages *~man + +If SiSU is installed on your system usual man commands should be available, try: + +_1 man sisu + +_1 man sisu_markup + +_1 man sisu_commands + +Most SiSU 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 SiSU tarball at: + +_1 ./data/doc/sisu/sisu_manual/ + +Once installed, directory equivalent to: + +_1 /usr/share/doc/sisu/sisu_manual/ + +Available man pages are converted back to html using man2html: + +_1 /usr/share/doc/sisu/html/ + +_1 ./data/doc/sisu/html/ + +The SiSU man pages can be viewed online at:~{ generated from source using rman<br> http://polyglotman.sourceforge.net/rman.html <br>With regard to SiSU man pages the formatting generated for markup syntax is not quite right, for that you might prefer the links under:<br> http://www.jus.uio.no/sample }~ + +An online version of the sisu man page is available here: + +_* {~^ various sisu man pages }http://www.jus.uio.no/sisu/man/ + +_* {~^ sisu.1 }http://www.jus.uio.no/sisu/man/sisu.1.html + +_* {~^ sisu.8 }http://www.jus.uio.no/sisu/man/sisu.8.html + +_* {~^ sisu_examples.1 }http://www.jus.uio.no/sisu/man/sisu_examples.1.html + +_* {~^ sisu_webrick.1 }http://www.jus.uio.no/sisu/man/sisu_webrick.1.html + +2~ SiSU built-in interactive help + +This is particularly useful when current installation information is obtained as the interactive help is able to provide information on your sisu configuration and setup. + +_1 sisu --help + +_1 sisu --help [subject] + +_2 sisu --help env [for feedback on the way your system is setup with regard to sisu] + +_2 sisu -V [same as above command] + +_2 sisu --help commands + +_2 sisu --help markup + +Apart from real-time information on your current configuration the SiSU manual and man pages are likely to contain more up-to-date information than the sisu interactive help (for example on commands and markup). + +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. + +2~ Help Sources + +For lists of alternative help sources, see: + +!_ man page + +_1 man sisu_help_sources + +!_ man2html + +_1 /usr/share/doc/sisu/sisu_manual/sisu_help_sources/index.html + +!_ sisu generated html + +_1 /usr/share/doc/sisu/html/sisu_help_sources/index.html + +_1 http://sisudoc.org/sisu_manual/sisu_help_sources/index.html + +_1 http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_help_sources.sst b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_help_sources.sst new file mode 100644 index 00000000..3006ef75 --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_help_sources.sst @@ -0,0 +1,452 @@ +% SiSU insert 0.58 + +@title: SiSU + +@subtitle: References + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2002-11-12 + +@date.issued: 2002-11-12 + +@date.available: 2002-11-12 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +% @rcs$ + +:A~? @title @creator + +:B~? SiSU Help Sources + +1~help_sources Help Sources + +For a summary of alternative ways to get help on SiSU try one of the following: + +!_ man page + +_1 man sisu_help + +!_ man2html + +_1 file:///usr/share/doc/sisu/html/sisu_help.1.html + +_1 http://www.jus.uio.no/sisu/man/sisu_help.1.html + +!_ sisu generated output - links to html + +_1 file:///usr/share/doc/sisu/sisu_manual/sisu_help/index.html + +_1 http://sisudoc.org/sisu_manual/sisu_help/index.html + +_1 http://www.jus.uio.no/sisu/sisu_manual/sisu_help/index.html + +!_ help sources lists + +Alternative sources for this help sources page listed here: + +_1 man sisu_help_sources + +_1 file:///usr/share/doc/sisu/sisu_manual/sisu_help_sources/index.html + +_1 file:///usr/share/doc/sisu/html/sisu_help_sources/index.html + +_1 http://sisudoc.org/sisu_manual/sisu_help_sources/index.html + +_1 http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html + +2~ man pages + +3~ man + +_1 man sisu + +_1 man sisu_commands + +_1 man 7 sisu_complete + +_1 man sisu_configuration + +_1 man 8 sisu_faq + +_1 man sisu_filetypes + +_1 man sisu_help + +_1 man sisu_help_sources + +_1 man 8 sisu_howto + +_1 man sisu_introduction + +_1 man sisu_markup + +_1 man sisu_output_overview + +_1 man 7 sisu_pdf + +_1 man 7 sisu_postgresql + +_1 man 8 sisu_quickstart + +_1 man 8 sisu_remote + +_1 man 8 sisu_search + +_1 man sisu_skin + +_1 man 7 sisu_sqlite + +_1 man 8 sisu_syntax_highlighting + +_1 man 7 sisu_vim + +_1 man sisu_webrick + +2~ sisu generated output - links to html + +Note SiSU documentation is prepared in SiSU and output is available in multiple formats including amongst others html, pdf, and odf which may be also be accessed via the html pages~{ named index.html or more extensively through sisu_manifest.html }~ + +3~ locally installed + +file:///usr/share/doc/sisu/sisu_manual/sisu_manual/index.html + +file:///usr/share/doc/sisu/sisu_manual/sisu_help/index.html + +file:///usr/share/doc/sisu/sisu_manual/sisu_help_sources/index.html + +_1 /usr/share/doc/sisu/sisu_manual/sisu/index.html + +_1 /usr/share/doc/sisu/sisu_manual/sisu_commands/index.html + +_1 /usr/share/doc/sisu/sisu_manual/sisu_complete/index.html + +_1 /usr/share/doc/sisu/sisu_manual/sisu_configuration/index.html + +_1 /usr/share/doc/sisu/sisu_manual/sisu_description/index.html + +_1 /usr/share/doc/sisu/sisu_manual/sisu_examples/index.html + +_1 /usr/share/doc/sisu/sisu_manual/sisu_faq/index.html + +_1 /usr/share/doc/sisu/sisu_manual/sisu_filetypes/index.html + +_1 /usr/share/doc/sisu/sisu_manual/sisu_help/index.html + +_1 /usr/share/doc/sisu/sisu_manual/sisu_help_sources/index.html + +_1 /usr/share/doc/sisu/sisu_manual/sisu_howto/index.html + +_1 /usr/share/doc/sisu/sisu_manual/sisu_introduction/index.html + +_1 /usr/share/doc/sisu/sisu_manual/sisu_manual/index.html + +_1 /usr/share/doc/sisu/sisu_manual/sisu_markup/index.html + +_1 /usr/share/doc/sisu/sisu_manual/sisu_output_overview/index.html + +_1 /usr/share/doc/sisu/sisu_manual/sisu_pdf/index.html + +_1 /usr/share/doc/sisu/sisu_manual/sisu_postgresql/index.html + +_1 /usr/share/doc/sisu/sisu_manual/sisu_quickstart/index.html + +_1 /usr/share/doc/sisu/sisu_manual/sisu_remote/index.html + +_1 /usr/share/doc/sisu/sisu_manual/sisu_search/index.html + +_1 /usr/share/doc/sisu/sisu_manual/sisu_skin/index.html + +_1 /usr/share/doc/sisu/sisu_manual/sisu_sqlite/index.html + +_1 /usr/share/doc/sisu/sisu_manual/sisu_syntax_highlighting/index.html + +_1 /usr/share/doc/sisu/sisu_manual/sisu_vim/index.html + +_1 /usr/share/doc/sisu/sisu_manual/sisu_webrick/index.html + +3~ www.sisudoc.org + +http://sisudoc.org/sisu_manual/sisu_manual/index.html + +_1 http://sisudoc.org/sisu_manual/sisu/index.html + +_1 http://sisudoc.org/sisu_manual/sisu_commands/index.html + +_1 http://sisudoc.org/sisu_manual/sisu_complete/index.html + +_1 http://sisudoc.org/sisu_manual/sisu_configuration/index.html + +_1 http://sisudoc.org/sisu_manual/sisu_description/index.html + +_1 http://sisudoc.org/sisu_manual/sisu_examples/index.html + +_1 http://sisudoc.org/sisu_manual/sisu_faq/index.html + +_1 http://sisudoc.org/sisu_manual/sisu_filetypes/index.html + +_1 http://sisudoc.org/sisu_manual/sisu_help/index.html + +_1 http://sisudoc.org/sisu_manual/sisu_help_sources/index.html + +_1 http://sisudoc.org/sisu_manual/sisu_howto/index.html + +_1 http://sisudoc.org/sisu_manual/sisu_introduction/index.html + +_1 http://sisudoc.org/sisu_manual/sisu_manual/index.html + +_1 http://sisudoc.org/sisu_manual/sisu_markup/index.html + +_1 http://sisudoc.org/sisu_manual/sisu_output_overview/index.html + +_1 http://sisudoc.org/sisu_manual/sisu_pdf/index.html + +_1 http://sisudoc.org/sisu_manual/sisu_postgresql/index.html + +_1 http://sisudoc.org/sisu_manual/sisu_quickstart/index.html + +_1 http://sisudoc.org/sisu_manual/sisu_remote/index.html + +_1 http://sisudoc.org/sisu_manual/sisu_search/index.html + +_1 http://sisudoc.org/sisu_manual/sisu_skin/index.html + +_1 http://sisudoc.org/sisu_manual/sisu_sqlite/index.html + +_1 http://sisudoc.org/sisu_manual/sisu_syntax_highlighting/index.html + +_1 http://sisudoc.org/sisu_manual/sisu_vim/index.html + +_1 http://sisudoc.org/sisu_manual/sisu_webrick/index.html + +3~ www.jus.uio.no/sisu + +http://www.jus.uio.no/sisu/sisu_manual/sisu_manual/index.html + +_1 http://www.jus.uio.no/sisu/sisu_manual/sisu/index.html + +_1 http://www.jus.uio.no/sisu/sisu_manual/sisu_commands/index.html + +_1 http://www.jus.uio.no/sisu/sisu_manual/sisu_complete/index.html + +_1 http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/index.html + +_1 http://www.jus.uio.no/sisu/sisu_manual/sisu_description/index.html + +_1 http://www.jus.uio.no/sisu/sisu_manual/sisu_examples/index.html + +_1 http://www.jus.uio.no/sisu/sisu_manual/sisu_faq/index.html + +_1 http://www.jus.uio.no/sisu/sisu_manual/sisu_filetypes/index.html + +_1 http://www.jus.uio.no/sisu/sisu_manual/sisu_help/index.html + +_1 http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html + +_1 http://www.jus.uio.no/sisu/sisu_manual/sisu_howto/index.html + +_1 http://www.jus.uio.no/sisu/sisu_manual/sisu_introduction/index.html + +_1 http://www.jus.uio.no/sisu/sisu_manual/sisu_manual/index.html + +_1 http://www.jus.uio.no/sisu/sisu_manual/sisu_markup/index.html + +_1 http://www.jus.uio.no/sisu/sisu_manual/sisu_output_overview/index.html + +_1 http://www.jus.uio.no/sisu/sisu_manual/sisu_pdf/index.html + +_1 http://www.jus.uio.no/sisu/sisu_manual/sisu_postgresql/index.html + +_1 http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/index.html + +_1 http://www.jus.uio.no/sisu/sisu_manual/sisu_remote/index.html + +_1 http://www.jus.uio.no/sisu/sisu_manual/sisu_search/index.html + +_1 http://www.jus.uio.no/sisu/sisu_manual/sisu_skin/index.html + +_1 http://www.jus.uio.no/sisu/sisu_manual/sisu_sqlite/index.html + +_1 http://www.jus.uio.no/sisu/sisu_manual/sisu_syntax_highlighting/index.html + +_1 http://www.jus.uio.no/sisu/sisu_manual/sisu_vim/index.html + +_1 http://www.jus.uio.no/sisu/sisu_manual/sisu_webrick/index.html + +3~ man2html + +3~ locally installed + +file:///usr/share/doc/sisu/html/sisu_manual.1.html + +file:///usr/share/doc/sisu/html/sisu_help.1.html + +file:///usr/share/doc/sisu/html/sisu_help_sources.1.html + +_1 /usr/share/doc/sisu/html/sisu.1.html + +_1 /usr/share/doc/sisu/html/sisu_commands.1.html + +_1 /usr/share/doc/sisu/html/sisu_complete.7.html + +_1 /usr/share/doc/sisu/html/sisu_configuration.1.html + +% _1 /usr/share/doc/sisu/html/sisu_description.1.html + +% _1 /usr/share/doc/sisu/html/sisu_examples.1.html + +_1 /usr/share/doc/sisu/html/sisu_faq.8.html + +% _1 /usr/share/doc/sisu/html/sisu_filetypes.1.html + +_1 /usr/share/doc/sisu/html/sisu_help.1.html + +_1 /usr/share/doc/sisu/html/sisu_help_sources.1.html + +_1 /usr/share/doc/sisu/html/sisu_howto.8.html + +% _1 /usr/share/doc/sisu/html/sisu_introduction.1.html + +% _1 /usr/share/doc/sisu/html/sisu_manual.1.html + +_1 /usr/share/doc/sisu/html/sisu_markup.1.html + +% _1 /usr/share/doc/sisu/html/sisu_output_overview.1.html + +_1 /usr/share/doc/sisu/html/sisu_pdf.7.html + +_1 /usr/share/doc/sisu/html/sisu_postgresql.7.html + +_1 /usr/share/doc/sisu/html/sisu_quickstart.8.html + +_1 /usr/share/doc/sisu/html/sisu_remote.8.html + +_1 /usr/share/doc/sisu/html/sisu_search.8.html + +_1 /usr/share/doc/sisu/html/sisu_skin.1.html + +_1 /usr/share/doc/sisu/html/sisu_sqlite.7.html + +_1 /usr/share/doc/sisu/html/sisu_syntax_highlighting.8.html + +_1 /usr/share/doc/sisu/html/sisu_vim.7.html + +_1 /usr/share/doc/sisu/html/sisu_webrick.1.html + +3~ www.sisudoc.org + +http:///sisudoc.org/man/sisu_manual.1.html + +http:///sisudoc.org/man/sisu_help.1.html + +http:///sisudoc.org/man/sisu_help_sources.1.html + +_1 http://sisudoc.org/man/sisu.1.html + +_1 http://sisudoc.org/man/sisu_commands.1.html + +_1 http://sisudoc.org/man/sisu_complete.7.html + +_1 http://sisudoc.org/man/sisu_configuration.1.html + +_1 http://sisudoc.org/man/sisu_faq.8.html + +_1 http://sisudoc.org/man/sisu_help.1.html + +_1 http://sisudoc.org/man/sisu_help_sources.1.html + +_1 http://sisudoc.org/man/sisu_howto.8.html + +_1 http://sisudoc.org/man/sisu_markup.1.html + +_1 http://sisudoc.org/man/sisu_pdf.7.html + +_1 http://sisudoc.org/man/sisu_postgresql.7.html + +_1 http://sisudoc.org/man/sisu_quickstart.8.html + +_1 http://sisudoc.org/man/sisu_remote.8.html + +_1 http://sisudoc.org/man/sisu_search.8.html + +_1 http://sisudoc.org/man/sisu_skin.1.html + +_1 http://sisudoc.org/man/sisu_sqlite.7.html + +_1 http://sisudoc.org/man/sisu_syntax_highlighting.8.html + +_1 http://sisudoc.org/man/sisu_vim.7.html + +_1 http://sisudoc.org/man/sisu_webrick.1.html + +3~ www.jus.uio.no/sisu + +http://www.jus.uio.no/sisu/man/sisu_manual.1.html + +http://www.jus.uio.no/sisu/man/sisu_help.1.html + +http://www.jus.uio.no/sisu/man/sisu_help_sources.1.html + +_1 http://www.jus.uio.no/sisu/man/sisu.1.html + +_1 http://www.jus.uio.no/sisu/man/sisu_commands.1.html + +_1 http://www.jus.uio.no/sisu/man/sisu_complete.7.html + +_1 http://www.jus.uio.no/sisu/man/sisu_configuration.1.html + +_1 http://www.jus.uio.no/sisu/man/sisu_faq.8.html + +_1 http://www.jus.uio.no/sisu/man/sisu_help.1.html + +_1 http://www.jus.uio.no/sisu/man/sisu_help_sources.1.html + +_1 http://www.jus.uio.no/sisu/man/sisu_howto.8.html + +_1 http://www.jus.uio.no/sisu/man/sisu_markup.1.html + +_1 http://www.jus.uio.no/sisu/man/sisu_pdf.7.html + +_1 http://www.jus.uio.no/sisu/man/sisu_postgresql.7.html + +_1 http://www.jus.uio.no/sisu/man/sisu_quickstart.8.html + +_1 http://www.jus.uio.no/sisu/man/sisu_remote.8.html + +_1 http://www.jus.uio.no/sisu/man/sisu_search.8.html + +_1 http://www.jus.uio.no/sisu/man/sisu_skin.1.html + +_1 http://www.jus.uio.no/sisu/man/sisu_sqlite.7.html + +_1 http://www.jus.uio.no/sisu/man/sisu_syntax_highlighting.8.html + +_1 http://www.jus.uio.no/sisu/man/sisu_vim.7.html + +_1 http://www.jus.uio.no/sisu/man/sisu_webrick.1.html diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_homepages.ssi b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_homepages.ssi new file mode 100644 index 00000000..086c622c --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_homepages.ssi @@ -0,0 +1,90 @@ +% SiSU insert 0.58 + +@title: SiSU + +@subtitle: Homepages [0.58] + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2007-08-28 + +@date.issued: 2007-08-28 + +@date.available: 2007-08-28 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +% @rcs$ + +:A~? @title @creator + +:B~? Setting up of homepages + +1~home Homepages + +SiSU is about the ability to auto-generate documents. Home pages are regarded as custom built items, and are not created by SiSU. More accurately, SiSU 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: + +# through placing your home page and other custom built documents in the subdirectory _sisu/home/ (this probably being the easier and more convenient option) + +# through providing what you want as the home page in a skin, + +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. + +2~ Home page and other custom built pages in a sub-directory + +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: + +_1 sisu -CC + +2~ Home page within a skin + +Skins are described in a separate section, but basically are a file written in the programming language Ruby 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. + +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 poems in skin_poems.rb + +code{ + + 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 + +}code + +% .SH "SKINS \- document, directory and site skins" + + diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_howto.sst b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_howto.sst new file mode 100644 index 00000000..06f3a6e5 --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_howto.sst @@ -0,0 +1,1364 @@ +% SiSU insert 0.57 + +@title: SiSU - SiSU information Structuring Universe / Structured information, Serialized Units + +@subtitle: Technical, Howto + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2002-11-12 + +@date.issued: 2002-11-12 + +@date.available: 2002-11-12 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +% @rcs:+ $Id$ + +:A~? @title @creator + +:B~? SiSU some technical information + +:C~ HowTo + +1~howto_help Getting Help + +An online manual of sorts should be available at: + +http://www.jus.uio.no/sisu_manual/ + +The manual pages provided with SiSU are also available online, and there is an interactive help, which is being superseded by the man page, and possibly some document which contains this component. + +2~ SiSU "man" pages *~man + +If SiSU is installed on your system usual man commands should be available, try: + +man sisu + +The SiSU man pages can be viewed online at:~{ generated from source using rman<br> http://polyglotman.sourceforge.net/rman.html <br>With regard to SiSU man pages the formatting generated for markup syntax is not quite right, for that you might prefer the links under:<br> http://www.jus.uio.no/sample }~ + +An online version of the sisu man page is available here: + +_* {~^ various sisu man pages }http://www.jus.uio.no/sisu/man/ + +_* {~^ sisu.1 }http://www.jus.uio.no/sisu/man/sisu.1.html + +_* {~^ sisu.8 }http://www.jus.uio.no/sisu/man/sisu.8.html + +_* {~^ sisu_examples.1 }http://www.jus.uio.no/sisu/man/sisu_examples.1.html + +_* {~^ sisu_webrick.1 }http://www.jus.uio.no/sisu/man/sisu_webrick.1.html + +2~ SiSU built-in help + +_1 sisu --help + +_1 sisu --help [subject] + +_2 sisu --help env [for feedback on the way your system is setup with regard to sisu] + +_2 sisu -V [same as above command] + +_2 sisu --help commands + +_2 sisu --help markup + +2~ Command Line with Flags - Batch Processing + +Running sisu (alone without any flags, filenames or wildcards) brings up the interactive help, as does any sisu command that is not recognised. + +In the data directory run sisu -mh filename or wildcard eg. "sisu -h cisg.sst" or "sisu -h *.{sst,ssm}" to produce html version of all documents. + +1~howto_setup Setup, initialisation + +2~ initialise output directory + +Images, css files for a document directory are copied to their respective locations in the output directory. + +while within your document markup/preparation directory, issue the following command + +_1 sisu -CC + +3~ Use of search functionality, an example using sqlite + +SiSU can populate PostgreSQL and Sqlite databases and provides a sample search form for querying these databases. + +This note provides an example to get you started and will use sqlite + +It is necessary to: + +(1) make sure the required dependencies have been installed + +(2) have a directory with sisu markup samples that is writable + +(3) use sisu to create a database + +(4) use sisu tp populate a database + +(5) use sisu to start the webrick (httpd) server + +(6) use sisu to create a search form + +(7) copy the search form to the cgi directory + +(8) open up the form in your browser + +(9) query the database using the search form + +!_ (1) make sure the required dependencies have been installed + +if you use Debian, the following command will install the required dependencies + +aptitude install sisu-sqlite + +!_ (2) have a directory with sisu markup samples that is writable + +ideally copy the sisu-examples directory to your home directory (because the directory in which you run this example should be writable) + +cp -rv /usr/share/sisu-examples/sample/document_samples_sisu_markup ~/. + +!_ (3) use sisu to create an sqlite database + +within the sisu-examples directory + +sisu -dv createall + +!_ (4) use sisu tp populate a database with some text + +within the sisu-examples directory + +sisu -div free_*.sst + +or + +sisu -dv import free_*.sst debian_constitution_v1.2.sst debian_social_contract_v1.1.sst gpl2.fsf.sst + +!_ (5) use sisu to start the webrick (httpd) server (if it has not already been started): + +sisu -W + +!_ (6) use sisu to create a search form (for use with the webrick server, and your sample documents) + +within the sisu-examples directory + +sisu -F webrick + +#here i run into a problem, you are working from a read only +#directory..., not my usual mode of operation, to complete the example +#the following is necessary +sudo touch sisu_sqlite.cgi sisu_pgsql.cgi +sudo -P chown $USER sisu_sqlite.cgi sisu_pgsql.cgi + +#now this should be possible: +sisu -F webrick + +!_ (7) copy the search form to the cgi directory + +the string should be provided as output from the previous command + +sudo cp -vi /usr/share/sisu-examples/sample/document_samples_sisu_markup/sisu_sqlite.cgi /usr/lib/cgi-bin + +sudo chmod -v 755 /usr/lib/cgi-bin/sisu_sqlite.cgi + +!_ (8) open up the form in your browser and query it + +url: + +http://localhost:8081/cgi-bin/sisu_sqlite.cgi + +or as instructed by command sisu -F webrick + +!_ (9) query the database using the search form + +if there are other options in the dropdown menu select + +document_samples_sisu_markup + +and search for some text, e.g.: + +aim OR project + +_* selecting the *index* radio button gives an index of results using the object numbers + +_* selecting the *text* radio button gives the content of the matched paragraphs with the match highlighted + +!_ (10) to start again with a new database + +to start from scratch you can drop the database with the command + +sisu -dv dropall + +and go to step 3 + +to get to step 3 in one step with a single command + +sisu -dv recreate + +continue subsequent steps + +2~ misc + +3~ url for output files -u -U + +_1 sisu -uv[and other flags] [filename/wildcard] + +_1 sisu -Uv [filename/wildcard] + +3~ toggle screen color + +_1 sisu -cv[and processing flags] [filename/wildcard] + +3~ verbose mode + +_1 sisu -v[and processing flags] [filename/wildcard] + +_1 sisu -V[and processing flags] [filename/wildcard] + +3~ quiet mode + +_1 sisu -q[and processing flags] [filename/wildcard] + +3~ maintenance mode +intermediate files kept -M + +_1 sisu -Mv[and other flags] [filename/wildcard] + +3~ start the webrick server + +_1 sisu -W + +2~ remote placement of output + +configuration is necessary + +scp + +_1 sisu -vr[and processing flags] [filename/wildcard] + +rsync + +_1 sisu -vR[and processing flags] [filename/wildcard] + +1~howto_config Configuration Files + +Sample provided, on untarring the source tarball: + +_1 conf/sisu/sisurc.yaml + +and on installation under: + +_1 /etc/sisu/sisurc.yaml + +The following paths are searched: + +_1 ./_sisu/sisurc.yaml + +_1 ~/.sisu/sisurc.yaml + +_1 ./etc/sisu/sisurc.yaml + +1~howto_markup Markup + +See sample markup provided on + +http://www.jus.uio.no/sisu + +http://www.jus.uio.no/sisu_markup + +http://www.jus.uio.no/sisu/SiSU + +in particular for each of the document output samples provided, the source document is provided as well + +http://www.jus.uio.no/sisu/SiSU/2#books + +on untarring the source tarball: + +_1 data/sisu-examples/sample/document_samples_sisu_markup/ + +or the same once source is installed (or sisu-examples) under: + +_1 /usr/share/sisu-examples/sample/document_samples_sisu_markup/ + +Some notes are contained within the man page, *{man sisu}* and within sisu help via the commands *{sisu help markup}* and *{sisu help headers}* + +SiSU is for literary and legal text, also for some social science material. In particular it does not do formula, and is not particularly suited to technical documentation. Despite the latter caveat, some notes will be provided here and added to over time: + +2~ Headers + +Headers @headername: provide information related to the document, this may relate to + +# how it is to be processed, such as whether headings are to be numbered, what skin is to be used and markup instructions, such as the document structure, or words to be made bold within the document + +# semantic information about the document including the dublin core + +2~ Font Face + +Defaults are set. You may change the face to: bold, italics, underscore, strikethrough, ... + +3~ Bold + +\@bold: [list of words that should be made bold within document] + +!_ bold line + +\!_ bold line + +*{ bold word or sentence }* + +!\{ bold word or sentence \}! + +*\{ bold word or sentence \}* + +*boldword* or !boldword! + +\*boldword\* or \!boldword\! + +3~ Italics + +\@italics: [list of words that should be italicised within document] + +/{ italicise word or sentence }/ + +/\{ italicise word or sentence \}/ + +/italicisedword/ + +\/italicisedword\/ + +3~ Underscore + +_{ underscore word or sentence }_ + +_\{ underscore word or sentence \}_ + +_underscoreword_ + +3~ Strikethrough + +-{ strikethrough word or sentence }- + +-\{ strikethrough word or sentence \}- + +-strikeword- + +\-strikeword\- + +2~ Endnotes + +There are two forms of markup for endnotes, they cannot be mixed within the same document + +here~{ this is an endnote }~ + +# preferred endnote markup + +here~\{ this is an endnote \}~ + +# alternative markup equivalent, kept because it is possible to search and replace to get markup in existing texts such as Project Gutenberg + +here\~^ + +^\~ this is an endote + +2~ Links + +{ SiSU }http://sisudoc.org + +\{ SiSU \}http://sisudoc.org + +{sisu.png }http://sisudoc.org + +\{sisu.png \}http://sisudoc.org + +{tux.png 64x80 }image + +\{ tux.png 64x80 \}image + +{~^ SiSU }http://sisudoc.org + +\{~^ SiSU \}http://sisudoc.org + +is equivalent to: + +\{ SiSU \}http://sisudoc.org ~\{ http://sisudoc.org \}~ + +the same can be done with an image: + +{~^ sisu.png "SiSU" }http://sisudoc.org + +\{~^ sisu.png "SiSU" \}http://sisudoc.org + +2~ Number Titles + +Set with the header @markup: + +2~ Line operations + +Line Operations (marker placed at start of line) + +\!_ bold line + +!_ bold line + +\_1 indent paragraph one level + +_1 indent paragraph one level + +\_2 indent paragraph two steps + +_2 indent paragraph two steps + +\_* bullet paragraph + +_* bullet paragraph + +\# number paragraph (see headers for numbering document headings) + +# number paragraph (see headers for numbering document headings) + +\_# number paragraph level 2 (see headers for numbering document headings) + +_# number paragraph level 2 (see headers for numbering document headings) + +2~ Tables + +Table markup sample + +poem{ + +table\{~h c3; 26; 32; 32; + +This is a table, column1 +this would become row one of column two +column three of row one is here + +column one row 2 +column two of row two +column three of row two, and so on + +column one row three +and so on +here + +\}table + +}poem + +Alternative form of table markup + +code{ + +{t\~h} + |Mon|Tue|Wed|Thu|Fri|Sat|Sun +0 | * | * | * | * | * | * | * +1 | * | * | * | * | | | +2 | - | * | * | * | * | * | +3 | - | * | * | * | * | * | * +4 | - | | | * | * | * | +5 | * | * | * | * | * | * | * + +}code + +2~ Grouped Text + +code{ + + 5.times { puts 'Ruby' } + +}code + +code\{ + +code{ + + 5.times { puts 'Ruby' } + +}code + +\}code + +poem{ + +A Limerick + +There was a young lady from Clyde, +who ate a green apple and died, +but the apple fermented inside the lamented, +and made cider inside her inside. + +}poem + +poem{ + +poem\{ + +There was a young lady from Clyde, +who ate a green apple and died, +but the apple fermented inside the lamented, +and made cider inside her inside. + +}\poem + +}poem + +2~ Composite Document + +To import another document, the master document or importing document should be named filename.r3 (r for require) + +\<\< \{ filename.sst \} + +\<\< \{ filename.ssi \} + +1~howto_appearance Change Appearance + +2~ Skins + +"Skins" may be used to change various aspects related to the output documents appearance, including such things as the url for the home page on which the material will be published, information on the credit band, and for html documents colours and icons used in navigation bars. Skins are ruby files which permit changing of the default values set within the program for SiSU output. + +There are a few examples provided, on untarring the source tarball: + +_1 conf/sisu/skin/doc/ + +_1 data/sisu-examples/sample/document_samples_sisu_markup/_sisu/skin/doc + +and on installation under: + +_1 /etc/sisu/skin/doc/ + +_1 /usr/share/sisu-examples/sample/document_samples_sisu_markup/_sisu/skin/doc + +The following paths are searched: + +_1 ./_sisu/skin + +_1 ~/.sisu/skin + +_1 /etc/sisu/skin + +Skins under the searched paths in a per document directory, a per directory directory, or a site directory, named: + +doc [may be specified individually in each document] + +dir [used if identifier part of name matches markup directory name] + +site + +It is usual to place all skins in the document directory, with symbolic links as required from dir or site directories. + +2~ CSS + +The appearance of html and XML related output can be changed for an ouput collection directory by prepareing and placing a new css file in one of the sisu css directories searched in the sisu configuration path. These are located at: + +_./_sisu/css + +~/.sisu/css + +and + +/etc/sisu/css + +The contents of the first directory found in the search path are copied to the corresponding sisu output directory with the commnd: + +sisu -CC + +The SiSU standard css files for SiSU output are: + +dom.css html.css html_tables.css index.css sax.css xhtml.css + +A document may specify its own/bespoke css file using the css header. + +\@css: + +[expand] + +:C~ Extracts from the README + +1~howto_readme README + +SiSU 0.55 2007w27/6 2007-07-07 + +Homepage: http://www.jus.uio.no/sisu + +!_ Description + +SiSU is lightweight markup based document creation and publishing framework that is controlled from the command line. Prepare documents for SiSU using your text editor of choice, then use SiSU to generate various output document formats. + +With minimal preparation of a plain-text (UTF-8) file using its native markup-syntax, SiSU produces: plain-text, HTML, XHTML, XML, ODF:ODT (Opendocument), LaTeX, PDF, and populates an SQL database (PostgreSQL or SQLite) in paragraph sized chunks so that document searches are done at this "atomic" level of granularity. + +Outputs share a common citation numbering system, and any semantic meta-data provided about the document. + +SiSU also provides concordance files, document content certificates and manifests of generated output. + +SiSU takes advantage of well established open standard ways of representing text, and provides a bridge to take advantage of the strengths of each, while remaining simple. SiSU implements across document formats a "useful common feature set" [coming from a humanities, law, and possibly social sciences perspective, rather than technical or scientific writing] ... focus is primarily on content and data integrity rather than appearance, (though outputs in the various formats are respectable). + +A vim syntax highlighting file and an ftplugin with folds for sisu markup is provided. Vim 7 includes syntax highlighting for SiSU. + +man pages, and interactive help are provided. + +Dependencies for various features are taken care of in sisu related packages. The package sisu-complete installs the whole of SiSU. + +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. + +Homepage: http://www.jus.uio.no/sisu + +SiSU - simple information structuring universe, is a publishing tool, document generation and management, (and search enabling) tool primarily for literary, academic and legal published works. + +SiSU can be used for Internet, Intranet, local filesystem or cd publishing. + +SiSU can be used directly off the filesystem, or from a database. + +SiSU's scalability, is be dependent on your hardware, and filesystem (in my case Reiserfs), and/or database Postgresql. + +Amongst it's characteristics are: + +_* simple mnemonoic markup style, + +_* the ability to produce multiple output formats, including html, structured XML, LaTeX, pdf (via LaTeX), stream to a relational database whilst retaining document structure - Postgresql and Sqlite, + +_* that all share a common citation system (a simple idea from which much good), possibly most exciting, the following: if fed into a relational database (as it can be automatically), the document set is searchable, with results displayed at a paragraph level, or the possibility of an indexed display of documents in which the match is found together with a hyperlinked listing for each of each paragraph in which the match is found. In any event citations using this system (with or without the relational database) are relevant for all output formats. + +_* it is command line driven, and can be set up on a remote server + +_* Documents are marked up in SiSU syntax in your favourite editor. SiSU syntax may be regarded as a type of smart ascii - which in its basic form is simpler than the most elementary html. There is currently a syntax highlighter, and folding for Vim. Syntax highlighters for other editors are welcome. + +Input files should be UTF-8 + +Once set up it is simple to use. + +2~ Online Information, places to look + +http://www.jus.uio.no/sisu + +Download Sources: + +_1 http://www.jus.uio.no/sisu/SiSU/download.html#current + +_1 http://www.jus.uio.no/sisu/SiSU/download.html#debian + +2~ Installation + +NB. Platform is Unix / Linux. + +3~ Debian + +If you use Debian use the Debian packages, check the information at: + +_1 http://www.jus.uio.no/sisu/SiSU/download.html#debian + +(A) SiSU is available directly off the Debian archives for Sid and testing. It +should necessary only to run as root: + +_1 aptitude update + +_1 aptitude install sisu-complete + +(B) If there are newer versions of SiSU upstream of the Debian archives, they +will be available by adding the following to your /etc/apt/sources.list + +_1 deb http://www.jus.uio.no/sisu/archive unstable main non-free + +_1 deb-src http://www.jus.uio.no/sisu/archive unstable main non-free + +[the non-free line is for document markup samples, for which the substantive text is provided under the author or original publisher's license and which in most cases will not be debian free software guideline compliant] + +Then as root run: + +_1 aptitude update + +_1 aptitude install sisu-complete + +3~ RPM + +RPMs are provided though untested, they are prepared by running alien against the source package, and against the debs. + +They may be downloaded from: + +_1 http://www.jus.uio.no/sisu/SiSU/download.html#rpm + +3~ Source package .tgz + +Otherwise to install SiSU from source, check information at: + +_1 http://www.jus.uio.no/sisu/SiSU/download.html#current + +alternative modes of installation from source are provided, setup.rb (by Minero Aoki), rake (by Jim Weirich) built install file, rant (by Stefan Lang) built install file, + +Ruby is the essential dependency for the basic operation of SiSU + +1. Download the latest source (information available) from: + +_1 http://www.jus.uio.no/sisu/SiSU/download.html#current + +2. Unpack the source + +Note however, that additional external package dependencies, such as texlive or postgresql should you desire to use it are not taken care of for you. + +3~ to use setup.rb + +this is a three step process, in the root directory of the unpacked SiSU as root type: + +_1 ruby setup.rb config + +_1 ruby setup.rb setup + +as root: + +_1 ruby setup.rb install + +further information: + +_1 http://i.loveruby.net/en/projects/setup/ + +_1 http://i.loveruby.net/en/projects/setup/doc/usage.html + +3~ to use install (prapared with "Rake") + +Rake must be installed on your system: + +_1 http://rake.rubyforge.org/ + +_1 http://rubyforge.org/frs/?group_id=50 + +in the root directory of the unpacked SiSU as root type: + +_1 rake + +or + +_1 rake base + +This makes use of Rake (by Jim Weirich) and the provided Rakefile + +For a list of alternative actions you may type: + +_1 rake help + +_1 rake -T + +3~ to use install (prapared with "Rant") + +(you may use the instructions above for rake substituting rant if rant is +installed on your system, or you may use an independent installer created using +rant as follows:) + +in the root directory of the unpacked SiSU as root type: + +_1 ruby ./sisu-install + +or + +_1 ruby ./sisu-install base + +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. + +further information: + +_1 http://make.rubyforge.org/ + +_1 http://rubyforge.org/frs/?group_id=615 + +For a list of alternative actions you may type: + +_1 ruby ./sisu-install help + +_1 ruby ./sisu-install -T + +2~ Dependencies + +Once installed see 'man 8 sisu' for some information on additional programs that sisu makes use of, and that you may need or wish to install. (this will depend on such factors as whether you want to generate pdf, whether you will be using SiSU with or without a database, ...) 'man sisu_markup-samples' may also be of interest if the sisu-markup-samples package has also been installed. + +The information in man 8 may not be most up to date, and it is possible that more useful information can be gleaned from the following 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). + +The following is from the debian/control file of sisu-0.58.2, which amongst other things provides the dependencies of sisu within Debian. + +code{ + +Package: sisu +Architecture: all +Depends: ruby (>= 1.8.2), libwebrick-ruby, unzip, zip +Conflicts: vim-sisu, sisu-vim, sisu-remote +Replaces: vim-sisu, sisu-vim +Recommends: sisu-pdf, sisu-sqlite, sisu-postgresql, librmagick-ruby, trang, +tidy, librexml-ruby, openssl, rsync, openssh-client | lsh-client, keychain, +hyperestraier, kdissert, vim-addon-manager +Suggests: rcs | cvs, lv, texinfo, pinfo + +Package: sisu-complete +Depends: ruby (>= 1.8.4), sisu, sisu-pdf, sisu-postgresql, sisu-sqlite +Recommends: hyperestraier + +Package: sisu-pdf +Architecture: all +Depends: sisu, texlive-latex-base, texlive-fonts-recommended, +texlive-latex-recommended, texlive-latex-extra +Suggests: evince, xpdf + +Package: sisu-postgresql +Depends: sisu, postgresql-8.1, libdbi-ruby, libdbm-ruby, libdbd-pg-ruby +Suggests: pgaccess, libdbd-pgsql, postgresql-contrib-8.1 + +Package: sisu-sqlite +Depends: sisu, sqlite, libdbi-ruby, libdbm-ruby, libdbd-sqlite-ruby +Suggests: libdbd-sqlite + +Package: sisu-markup-samples +Depends: sisu + +}code + +code{ + +Source: sisu +Section: text +Priority: optional +Maintainer: Ralph Amissah <ralph@amissah.com> +Build-Depends: debhelper (>= 5) +Standards-Version: 3.7.2 + +Package: sisu +Architecture: all +Depends: ruby (>= 1.8.2), libwebrick-ruby, unzip, zip +Conflicts: vim-sisu, sisu-vim, sisu-remote +Replaces: vim-sisu, sisu-vim +Recommends: sisu-pdf, sisu-sqlite, sisu-postgresql, hyperestraier, keychain, librmagick-ruby, librexml-ruby, openssl, openssh-client | lsh-client, rsync, tidy, vim-addon-manager +Suggests: kdissert, lv, rcs | cvs, pinfo, texinfo, trang +Description: documents - structuring, publishing in multiple formats and search + SiSU is a lightweight markup based, command line oriented, document + structuring, publishing and search framework for document collections. + . + 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. + . + SiSU also provides concordance files, document content certificates and + manifests of generated output. + . + 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. + . + man pages, and interactive help are provided. + . + Dependencies for various features are taken care of in sisu related packages. + The package sisu-complete installs the whole of SiSU. + . + 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. + . + Homepage: <http://www.jus.uio.no/sisu> + +}code + +code{ + +Package: sisu-complete +Architecture: all +Depends: ruby (>= 1.8.2), sisu, sisu-pdf, sisu-postgresql, sisu-sqlite +Recommends: hyperestraier +Description: installs all SiSU related packages + This package installs SiSU and related packages that enable sisu to produce + pdf and to populate postgresql and sqlite databases. + . + SiSU is a lightweight markup based document publishing framework. + . + See sisu for a description of the package. + . + Homepage: <http://www.jus.uio.no/sisu> + +}code + +code{ + +Package: sisu-pdf +Architecture: all +Depends: sisu, texlive-latex-base, texlive-fonts-recommended, texlive-latex-recommended, texlive-latex-extra +#Suggests: evince, xpdf +Description: dependencies to convert SiSU LaTeX output to pdf + This package enables the conversion of SiSU LaTeX output to pdf. + . + SiSU is a lightweight markup based document publishing framework. + . + Homepage: <http://www.jus.uio.no/sisu> + +}code + +code{ + +Package: sisu-postgresql +Architecture: all +Depends: sisu, libdbd-pg-ruby, libdbi-ruby, libdbm-ruby, postgresql +Recommends: libfcgi-ruby +Suggests: postgresql-contrib +Description: SiSU dependencies for use with postgresql database + This package enables SiSU to populate a postgresql database. This is done at + an object/paragraph level, making granular searches of documents possible. + . + This relational database feature of SiSU is not required but provides + interesting possibilities, including that of granular searches of documents + for matching units of text, primarily paragraphs that can be displayed or + identified by object citation number, from which an index of documents + matched and each matched paragraph within them can be displayed. + . + SiSU is a lightweight markup based document publishing framework. + . + Homepage: <http://www.jus.uio.no/sisu> + +}code + +code{ + +Package: sisu-sqlite +Architecture: all +Depends: sisu, sqlite, libdbd-sqlite-ruby, libdbi-ruby, libdbm-ruby +Recommends: libfcgi-ruby +Description: SiSU dependencies for use with sqlite database + This package enables SiSU to populate an sqlite database. This is done at an + object/paragraph level, making granular searches of documents possible. + . + This relational database feature of SiSU is not required but provides + interesting possibilities, including that of granular searches of documents + for matching units of text, primarily paragraphs that can be displayed or + identified by object citation number, from which an index of documents + matched and each matched paragraph within them can be displayed. + . + SiSU is a lightweight markup based document publishing framework. + . + Homepage: <http://www.jus.uio.no/sisu> + +}code + +2~ Quick start + +Most of the installation should be taken care of by the aptitude or rant +install. (The rant install if run in full will also test run the generation of +the first document). + +After installation of sisu-complete, move to the document samples directory + +_1 cd /usr/share/doc/sisu/sisu_markup_samples/dfsg + +and run + +_1 sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst + +or the same: + +_1 sisu -NhwpoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst + +look at output results, see the "sisu_manifest" page created for the document + +or to generate an online document move to a writable directory, as the file will be downloaded there and e.g. + +sisu -3 http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst + +the database stuff is extra perhaps, the latex stuff could be considered extra perhaps but neither needs to be installed for most of sisu output to work + +examine source document, vim has syntax support + +gvim free_as_in_freedom.rms_and_free_software.sam_williams.sst + +additional markup samples in + +_1 http://www.jus.uio.no/sisu/SiSU/2.html + +For help + +_1 man sisu + +or + +_1 sisu --help + +e.g. + +for the way sisu "sees/maps" your system + +_1 sisu --help env + +for list of commands and so on + +_1 sisu --help commands + +2~ Configuration files + +The default configuration/setup is contained within the program and is altered by configuration settings in /etc/[sisu version]/sisurc.yml or in ~/.sisu/sisurc.yml + +_* configuration file - a yaml file + +_1 /etc/sisu/[sisu version]/sisurc.yml + +_1 ~/.sisu/sisurc.yml + +_* directory structure - setting up of output and working directory. + +* skins - changing the appearance of a project, directory or individual +documents within ~/.sisu/skin + +_1 ~/.sisu/skin/doc contains individual skins, with symbolic links from + +_1 ~/.sisu/skin/dir if the contents of a directory are to take a particular document skin. + +_* additional software - eg. Tex and LaTeX (tetex, tetex-base, tetex-extra on Debian), Postgresql, [sqlite], trang, tidy, makeinfo, ... none of which are required for basic html or XML processing. + +_* if you use Vim as editor there is a syntax highlighter and fold resource config file for SiSU. I hope more syntax highlighters follow. + +There are post installation steps (which are really part of the overall installation) + +sisu -C in your marked up document directory, should do some auto-configuring provided you have the right permissions for the output directories. (and provided the output directories have already been specified if you are not using the defaults). + +2~ Use General Overview + +Documents are marked up in SiSU syntax and kept in an ordinary text editable file, named with the suffix .sst, or .ssm + +Marked up SiSU documents are usually kept in a sub-directory of your choosing + +use the interactive help and man pages + +_1 sisu --help + +_1 man sisu + +2~ Help + +interactive help described below, or man page: + +_1 man sisu + +_1 man 8 sisu + +'man sisu_markup-samples' [if the sisu-markup-samples package is also installed] + +Once installed an interactive help is available typing 'sisu' (without) any flags, and select an option: + +_1 sisu + +alternatively, you could type e.g. + +_1 sisu --help commands + +_1 sisu --help env + +_1 sisu --help headers + +_1 sisu --help markup + +_1 sisu --help headings + +etc. + +for questions about mappings, output paths etc. + +_1 sisu --help env + +_1 sisu --help path + +_1 sisu --help directory + +2~ Directory Structure + +Once installed, type: + +_1 sisu --help env + +or + +_1 sisu -V + +2~ Configuration File + +The defaults can be changed via SiSU's configure file sisurc.yml which the program expects to find in ./_sisu ~/.sisu or /etc/sisu (searched in that order, stopping on the first one found) + +2~ Markup + +See man pages. + +_1 man sisu + +_1 man 8 sisu + +Once installed there is some information on SiSU Markup in its help: + +_1 sisu --help markup + +and + +_1 sisu --help headers + +Sample marked up document are provided with the download tarball in the directory: + +_1 ./data/doc/sisu/sisu_markup_samples/dfsg + +These are installed on the system usually at: + +_1 /usr/share/doc/sisu/sisu_markup_samples/dfsg + +More markup samples are available in the package sisu-markup-samples + +_1 http://www.jus.uio.no/sisu/SiSU/download.html#sisu-markup-samples + +Many more are available online off: + +_1 http://www.jus.uio.no/sisu/SiSU/2.html + +2~ Additional Things + +There is syntax support for some editors provided (together with a README file) in + +_1 ./data/sisu/conf/syntax + +usually installed to: + +_1 /usr/share/sisu/conf/syntax + +2~ License + +License: GPL 3 or later see the copyright file in + +_1 ./data/doc/sisu + +usually installed to: + +_1 /usr/share/doc/sisu + +2~ SiSU Standard + +SiSU uses: + +_* Standard SiSU markup syntax, + +_* Standard SiSU meta-markup syntax, and the + +_* Standard SiSU object citation numbering and system + +© Ralph Amissah 1997, current 2006 All Rights Reserved. + +_* however note the License section + +CHANGELOG + +_1 ./CHANGELOG + +and see + +_1 http://www.jus.uio.no/sisu/SiSU/changelog.html + +_1 http://www.jus.uio.no/sisu/SiSU/changelog_markup_samples.html + +:C~ Extracts from man 8 sisu + +1~howto_setup_post_installation Post Installation Setup + +2~ Post Installation Setup - Quick start + +After installation of sisu-complete, move to the document samples directory, + +_1 cd /usr/share/doc/sisu/sisu_markup_samples/dfsg + +[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] + +and in that directory, initialise the output directory with the command + +_1 sisu -CC + +then run: + +_1 sisu -1 free_as_in_freedom.rms_and_free_software.sam_williams.sst + +or the same: + +_1 sisu -NhwpoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst + +look at output results, see the "sisu_manifest" page created for the document + +for an overview of your current sisu setup, type: + +_1 sisu --help env + +or + +_1 sisu -V + +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. + +_1 sisu -1 http://www.jus.uio.no/sisu/gpl3.fsf/gpl3.fsf.sst + +_1 sisu -3 http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst + +examine source document, vim has syntax highlighting support + +gvim free_as_in_freedom.rms_and_free_software.sam_williams.sst + +additional markup samples in + +_1 http://www.jus.uio.no/sisu/SiSU/2.html + +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. + +_1 sisu -3 http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip + +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: + +_1 sisu -3 --trust http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip + +For help + +_1 man sisu + +_1 sisu --help + +_1 sisu --help env +for the way sisu "sees/maps" your system + +_1 sisu --help commands +for list of commands and so on + +2~ Document markup directory + +% B. Generate a (local) document from a markup/work directory. + +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: + +_1 mkdir ~/sisu_test + +_1 cd ~/sisu_test + +_1 cp -a /usr/share/doc/sisu/sisu_markup_samples/dfsg/* ~/sisu_test/. + +!_ Tip: +the markup syntax examples may be of interest + +_1 http://www.jus.uio.no/sisu/sample/ + +!_ Tip: + +_1 sisu -U [sisu markup filename] + +should printout the different possible outputs and where sisu would place them. + +!_ Tip: +if you want to toggle ansi color add + +_1 c + +to your flags. + +3~ Configuration files + +SiSU configuration file search path is: + +_1 ./_sisu/sisurc.yaml + +_1 ~/.sisu/sisurc.yaml + +_1 /etc/sisu/sisurc.yaml + +.\"%% Debian Installation Note + +3~ Debian INSTALLATION Note + +It is best you see + +_1 http://www.jus.uio.no/sisu/SiSU/download.html#debian + +for up the most up to date information. + +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): + +Package: sisu + +SiSU is a lightweight markup based, command line oriented, document structuring, publishing and search framework for document collections. + +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. + +SiSU also provides concordance files, document content certificates and manifests of generated output. + +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. + +man pages, and interactive help are provided. + +Dependencies for various features are taken care of in sisu related packages. The package sisu-complete installs the whole of SiSU. + +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. + +Homepage: http://www.jus.uio.no/sisu + +3~ Document Resource Configuration + +!_ sisu +resource configuration information is obtained from sources (where they exist): + +_1 ~/.sisu/sisurc.yaml + +_1 /etc/sisu/[sisu version]/sisurc.yaml + +_1 sisu program defaults + +3~ Skins + +!_ Skins +default document appearance may be modified using skins contained in sub-directories located at the following paths: + +_1 ./_sisu/skin + +_1 ~/.sisu/skin + +_1 /etc/sisu/skin + +more specifically, the following locations (or their /etc/sisu equivalent) should be used: + +_1 ~/.sisu/skin/doc + +skins for individual documents; + +_1 ~/.sisu/skin/dir + +skins for directories of matching names; + +_1 ~/.sisu/skin/site + +site-wide skin modifying the site-wide appearance of documents. + +Usually all skin files are placed in the document skin directory: + +_1 ~/.sisu/skin/doc + +with softlinks being made to the skins contained there from other skin +directories as required. diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_hyperestraier.ssi b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_hyperestraier.ssi new file mode 100644 index 00000000..b63d8c04 --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_hyperestraier.ssi @@ -0,0 +1,116 @@ +% SiSU insert 0.58 + +@title: SiSU - SiSU information Structuring Universe + +@subtitle: Search [0.58] + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2002-08-28 + +@date.issued: 2002-08-28 + +@date.available: 2002-08-28 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? SiSU Search + +:C~? Search + +1~search_hyperestraier Hyperestraier + +See the documentation for hyperestraier: + +_1 http://hyperestraier.sourceforge.net/ + +_1 /usr/share/doc/hyperestraier/index.html + +_1 man estcmd + +on sisu_hyperestraier: + +_1 man sisu_hyperestraier + +_1 /usr/share/doc/sisu/sisu_markup/sisu_hyperestraier/index.html + +NOTE: the examples that follow assume that sisu output is placed in the directory /home/ralph/sisu_www + +(A) to generate the index within the webserver directory to be indexed: + +_1 estcmd gather -sd [index name] [directory path to index] + +the following are examples that will need to be tailored according to your needs: + +_1 cd /home/ralph/sisu_www + +_1 estcmd gather -sd casket /home/ralph/sisu_www + +you may use the 'find' command together with 'egrep' to limit indexing to particular document collection directories within the web server directory: + +_1 find /home/ralph/sisu_www -type f | egrep '/home/ralph/sisu_www/sisu/.+?.html$' |estcmd gather -sd casket - + +Check which directories in the webserver/output directory (~/sisu_www or elsewhere depending on configuration) you wish to include in the search index. + +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. + +_1 find /home/ralph/sisu_www -type f | egrep '/sisu_www/(sisu|bookmarks)/.+?.html$' | egrep -v '(doc|concordance).html$' |estcmd gather -sd casket - + +from your current document preparation/markup directory, you would construct a rune along the following lines: + +_1 find /home/ralph/sisu_www -type f | egrep '/home/ralph/sisu_www/([specify first directory for inclusion]|[specify second directory for inclusion]|[another directory for inclusion? ...])/.+?.html$' | egrep -v '(doc|concordance).html$' |estcmd gather -sd /home/ralph/sisu_www/casket - + +(B) to set up the search form + +(i) copy estseek.cgi to your cgi directory and set file permissions to 755: + +_1 sudo cp -vi /usr/lib/estraier/estseek.cgi /usr/lib/cgi-bin + +_1 sudo chmod -v 755 /usr/lib/cgi-bin/estseek.cgi + +_1 sudo cp -v /usr/share/hyperestraier/estseek.* /usr/lib/cgi-bin + +_1 [see estraier documentation for paths] + +(ii) edit estseek.conf, with attention to the lines starting 'indexname:' and 'replace:': + +_1 indexname: /home/ralph/sisu_www/casket + +_1 replace: ^file:///home/ralph/sisu_www{{!}}http://localhost + +_1 replace: /index.html?${{!}}/ + +(C) to test using webrick, start webrick: + +_1 sisu -W + +and try open the url: http://localhost:8081/cgi-bin/estseek.cgi + + diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_installation.ssi b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_installation.ssi new file mode 100644 index 00000000..eb1f7010 --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_installation.ssi @@ -0,0 +1,394 @@ +% SiSU insert 0.38 + +@title: Download - SiSU information Structuring Universe / Structured information, Serialized Units + +@subtitle: Downloads, Stable and Development Branches + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2002-11-12 + +@date.issued: 2002-11-12 + +@date.available: 2002-11-12 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +% @rcs$ + +:A~? SiSU Installation notes + +% :B~? Installation + +:C~ Installation + +1~installation Installation + +See the {~^ download pages }http://www.jus.uio.no/sisu/SiSU/download ~{ <br> http://www.jus.uio.no/sisu/sisu_download }~ for information related to installation. + +2~ Debian + +SiSU is developed on Debian, and packages are available for Debian that take care of the dependencies encountered on installation. + +The package is divided into the following components: + +_1 *sisu*, the base code, (the main package on which the others depend), without any dependencies other than ruby (and for convenience the ruby webrick web server), this generates a number of types of output on its own, other packages provide additional functionality, and have their dependencies + +_1 *sisu-complete*, a dummy package that installs the whole of greater sisu as described below, apart from sisu-examples + +_1 *sisu-pdf*, dependencies used by sisu to produce pdf from LaTeX generated + +_1 *sisu-postgresql*, dependencies used by sisu to populate postgresql database (further configuration is necessary) + +_1 *sisu-remote*, dependencies used to place sisu output on a remote server (further configuration is necessary) + +_1 *sisu-sqlite*, dependencies used by sisu to populate sqlite database + +_1 *sisu-markup-samples*, sisu markup samples and other miscellany (under Debian Free Software Guidelines non-free) + +SiSU is available off { Debian Unstable and Testing }http://packages.debian.org/cgi-bin/search_packages.pl?searchon=names&subword=1&version=all&release=all&keywords=sisu&sourceid=mozilla-search ~{ http://packages.qa.debian.org/s/sisu.html }~ install it using apt-get, aptitude or alternative Debian install tools. SiSU is currently comprised of eight packages. *~apt-get + +Initial packaging is done here and to get the latest version of SiSU available you may add the following line(s) to your sources list: *~sources.list + +code{ + +#/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 + +}code + +The non-free section is for sisu markup samples provided, which contain authored works the substantive text of which cannot be changed, and which as a result do not meet the debian free software guidelines. + +On Debian there is little more to know beyond how to install software on Debian using apt, aptitude or synaptic. + +code{ + +#Using aptitude: + + aptitude update + + aptitude install sisu-complete sisu-markup-samples + +}code + +code{ + +Using apt-get + + apt-get update + + apt get install sisu-complete sisu-examples + +}code + +2~ Other Unix / Linux + +A source tarball or an rpms built using alien are available, (however dependencies have not been tested). SiSU is first packaged and tested with dependency handling for Debian.~{ Notes on dependencies are provided in the section that follows }~ Information on dependencies configured for Debian is provided as this may be of assistance. + +3~ source tarball + +!_ installation with provided install script + +To install SiSU, in the root directory of the unpacked SiSU _{as root type}_:~{ This makes use of rant and the provided Rantfile. Note however, that additional external package dependencies, such as tetex-extra are not taken care of for you. }~ + +_1 ruby install + +Once installed see man 8 sisu for information on additional programs that sisu makes use of. + +Further notes on install script. + +The install script is prepared using Rant, and a Rantfile *~rant is provided,~{ a Rantfile has been configured to do post installation setup }~ with more comprehensive install options, and post install and setup configuration and generation of first test file, if you have installed Stefan Lang's {~^ Rant }http://make.rubyforge.org/ ~{ http://make.rubyforge.org/ <br> http://rubyforge.org/frs/?group_id=615 }~ installed. While in the package directory, type: rant help, or rant -T, or to install SiSU _{as root}_, type: + +*install* is an install script prepared using Stefan Lang's {~^ Rant }http://make.rubyforge.org/ ~{ http://make.rubyforge.org/ <br> http://rubyforge.org/frs/?group_id=615 }~ It should work whether you have previously installed Rant or not. It has fairly comprehensive install options, and can do some post install and setup configuration and generation of first test file. For options type: + +_1 ruby install -T + +To install as root type: + +_1 ruby install + +For a minimal install type: + +_1 ruby install base + +!_ installation with setup.rb + +{~^ setup.rb }http://i.loveruby.net/en/projects/setup/ is provided the package and will install SiSU~{ Minero Aoki<br> http://i.loveruby.net/en/projects/setup/doc/ }~ installation is a 3 step process~{ Installation instructions<br> http://i.loveruby.net/en/projects/setup/doc/usage.html }~ the following string assumes you are in the package directory and that you have root as sudo: + +_1 ruby setup.rb config && ruby setup.rb setup && sudo ruby setup.rb install + +!_ installation of rpm + +The RPM is generated from the source file using Alien.~{ http://www.kitenet.net/programs/alien/ }~ Dependencies are not handled, not even that of the essential Ruby. + +1~install_dependencies_and_notes SiSU Components, Dependencies and Notes + +The dependency lists are from the Debian control file for SiSU version 0.36, and may assist in building SiSU on other distributions. + +2~ sisu + +_* the base code, (the main package on which the others depend), without any dependencies other than ruby (and for convenience the ruby webrick web server), this generates a number of types of output on its own, other packages provide additional functionality, and have their dependencies + +*Depends:* on ruby (>=1.8.2), libwebrick-ruby + +*Recommends:* sisu-pdf, sisu-sqlite, sisu-postgresql, sisu-examples, librmagick-ruby, trang, tidy, libtidy, librexml-ruby, zip, unzip, openssl + +initialise directory + +_1 sisu -CC + +html + +_1 sisu -hv [filename/wildcard] + +_1 sisu -Hv [filename/wildcard] + +LaTeX (but sisu-pdf dependencies required to convert that to pdf) + +_1 sisu -pv [filename/wildcard] + +plain text Unix with footnotes + +_1 sisu -av [filename/wildcard] + +plain text Dos with footnotes + +_1 sisu -Av [filename/wildcard] + +plain text Unix with endnotes + +_1 sisu -ev [filename/wildcard] + +plain text Dos with endnotes + +_1 sisu -Ev [filename/wildcard] + +openoffice odt + +_1 sisu -ov [filename/wildcard] + +xhtml + +_1 sisu -bv [filename/wildcard] + +XML SAX + +_1 sisu -xv [filename/wildcard] + +XML DOM + +_1 sisu -Xv [filename/wildcard] + +wordmap (a rudimentary index of content) + +_1 sisu -wv [filename/wildcard] + +document content certificate + +_1 sisu -Nv [filename/wildcard] + +placement of sourcefile in output directory + +_1 sisu -sv [filename/wildcard] + +creation of source tarball with images, and placement of source tarball in ouput directory + +_1 sisu -Sv [filename/wildcard] + +manifest of output produced (polls output directory and provides links to existing output) + +_1 sisu -yv [filename/wildcard] + +url for output files -u -U + +_1 sisu -uv[and other flags] [filename/wildcard] + +_1 sisu -Uv [filename/wildcard] + +toggle screen colour + +_1 sisu -cv[and processing flags] [filename/wildcard] + +verbose mode + +_1 sisu -v[and processing flags] [filename/wildcard] + +_1 sisu -V[and processing flags] [filename/wildcard] + +quiet mode + +_1 sisu -q[and processing flags] [filename/wildcard] + +maintenance mode, intermediate files kept -M + +_1 sisu -Mv[and other flags] [filename/wildcard] + +[the -v is for verbose] + +start the webrick server + +_1 sisu -W + +2~ sisu-complete + +_* a dummy package that installs the whole SiSU, apart from sisu-examples + +*Depends:* ruby (>=1.8.2), sisu, sisu-pdf, sisu-postgresql, sisu-remote, sisu-sqlite + +*Recommends:* sisu-examples + +2~ sisu-examples + +_* installs sisu markup samples and other miscelleny + +*Depends:* sisu + +2~ sisu-pdf + +_* dependencies used by sisu to produce pdf from LaTeX generated + +*Depends:* sisu, tetex-bin, tetex-extra, latex-ucs + +*Suggests:* evince, xpdf + +converts sisu LaTeX produced to pdf + +_1 sisu -pv [filename/wildcard] + +[the -v is for verbose] + +2~ sisu-postgresql + +_* dependencies used by sisu to populate postgresql database (further configuration is necessary) + +*Depends:* sisu, postgresql-8.1, libdbi-ruby, libdbm-ruby, libdbd-pg-ruby + +*Suggests:* pgaccess, libdbd-pgsql, postgresql-contrib-8.1 + +installs dependencies for sisu to work with and populate postgresql database + +create database + +_1 sisu -Dv createall + +drop database + +_1 sisu -Dv dropall + +import content + +_1 sisu -Div [filename/wildcard] + +_1 sisu -Dv import [filename/wildcard] + +update content + +_1 sisu -Duv [filename/wildcard] + +_1 sisu -Dv update [filename/wildcard] + +[the -v is for verbose] + +The following are available without installation of the sisu-postgresql component, but are of interest in this context + +generate a sample database query form for use with webserver on port 80 + +_1 sisu -F + +or for use with webrick server + +_1 sisu -F webrick + +to start webrick server + +_1 sisu -W + +2~ sisu-remote + +_* dependencies used to place sisu output on a remote server (further configuration is necessary) + +scp + +_1 sisu -vr[and processing flags] [filename/wildcard] + +rsync + +_1 sisu -vR[and processing flags] [filename/wildcard] + +[the -v is for verbose] + +*Depends:* sisu, rsync, openssh-client|lsh-client, keychain + +2~ sisu-sqlite + +_* dependencies used by sisu to populate sqlite database + +*Depends:* sisu, sqlite, libdbi-ruby, libdbm-ruby, libdbd-sqlite-ruby + +*Suggests:* libdbd-sqlite + +installs dependencies for sisu to work with and populate sqlite database + +create database + +_1 sisu -dv createall + +drop database + +_1 sisu -dv dropall + +update content + +_1 sisu -div [filename/wildcard] + +_1 sisu -dv import [filename/wildcard] + +update content + +_1 sisu -duv [filename/wildcard] + +_1 sisu -dv update [filename/wildcard] + +[the -v is for verbose] + +The following are available without installation of the sisu-sqlite component, but are of interest in this context + +generate a sample database query form for use with webserver on port 80 + +_1 sisu -F + +or for use with webrick server + +_1 sisu -F webrick + +to start webrick server + +_1 sisu -W + diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_introduction.sst b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_introduction.sst new file mode 100644 index 00000000..18b57394 --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_introduction.sst @@ -0,0 +1,133 @@ +% SiSU 0.58 + +@title: SiSU + +@subtitle: Commands [0.58] + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2002-08-28 + +@date.issued: 2002-08-28 + +@date.available: 2002-08-28 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? What is SiSU? + +:C~? Description + +1~sisu_intro Introduction - What is SiSU? + +SiSU is a system for document markup, publishing (in multiple open standard formats) and search + +SiSU~{ "SiSU information Structuring Universe" or "Structured information, Serialized Units".<br>also chosen for the meaning of the Finnish term "sisu". }~ is a~{ Unix command line oriented }~ framework for document structuring, publishing 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 that (can) share a common numbering system for the citation of text within a document. + +SiSU is developed under an open source, software libre license (GPL3). It has been developed in the context of coping with large document sets with evolving markup related technologies, for which you want multiple output formats, a common mechanism for cross-output-format citation, and search. + +SiSU both defines a markup syntax and provides an engine that produces open standards format outputs from documents prepared with SiSU 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 SiSU 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. SiSU is also able to populate SQL type databases at an object level, which means that searches can be made with that degree of granularity. Results of objects (primarily paragraphs and headings) can be viewed directly in the database, or just the object numbers shown - your search criteria is met in these documents and at these locations within each document. + +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 SiSU markup applied to a document, SiSU custom builds various standard open output formats including plain text, HTML, XHTML, XML, OpenDocument, LaTeX or PDF files, and populate an SQL database with objects~{ 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. }~ (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 "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. + +In preparing a SiSU 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~{ 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. }~ the different forms of output requested. + +SiSU works with an abstraction of the document based on its structure which is comprised of its frame~{ the different heading levels }~ and the objects~{ units of text, primarily paragraphs and headings, also any tables, poems, code-blocks }~ it contains, which enables SiSU 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 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. + +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. SiSU provides the flexibility of outputing documents in multiple non-proprietary open formats including html, pdf~{ Specification submitted by Adobe to ISO to become a full open ISO specification <br> http://www.linux-watch.com/news/NS7542722606.html }~ and the ISO standard ODF.~{ ISO/IEC 26300:2006 }~ Whilst SiSU 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 SiSU can be migrated to other document formats. Further security is provided by the fact that the software itself, SiSU 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. SiSU permits new forms of output to be added as they become important, (Open Document Format text was added in 2006), 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). + +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. + +SiSU 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 SiSU offers great possibilities. + +SiSU is primarily for published works, which can take advantage of the citation system to reliably reference its documents. SiSU 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 SiSU. + +http://www.jus.uio.no/sisu + +% SiSU is a way of preparing, publishing, managing and searching documents. + +1~sisu_how How does sisu work? + +SiSU 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. SiSU 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). + +1~sisu_feature_summary Summary of features + +_* 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 "War and Peace" require almost no markup, and most of the headers are optional. + +_* 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]. + +_* 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. SiSU 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 browser viewing, paper publication, sql search etc.] (html, xml, odf, latex, pdf, sql) + +_* 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: + +_1* html - both as a single scrollable text and a segmented document + +_1* xhtml + +_1* XML - both in sax and dom style xml structures for further development as required + +_1* ODF - open document format, the iso standard for document storage + +_1* LaTeX - used to generate pdf + +_1* pdf (via LaTeX) + +_1* sql - population of an sql database, (at the same object level that is used to cite text within a document) + +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)) + +_* 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. + +_* 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]. + +_* long term maintainability of document collections in a world of changing formats, having a very sparsely marked-up source document base. there is a considerable degree of future-proofing, output representations are "upgradeable", and new document formats may be added. e.g. addition of odf (open document text) module in 2006 and in future html5 output sometime in future, without modification of existing prepared texts + +_* SQL search aside, documents are generated as required and static once generated. + +_* 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) + +_* document source (plaintext utf-8) if shared on the net may be used as input and processed locally to produce the different document outputs + +_* document source may be bundled together (automatically) with associated documents (multiple language versions or master document with inclusions) and images and sent as a zip file called a sisupod, if shared on the net these too may be processed locally to produce the desired document outputs + +_* generated document outputs may automatically be posted to remote sites. + +_* for basic document generation, the only software dependency is Ruby, 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. + +_* as a developers tool it is flexible and extensible + +Syntax highlighting for SiSU markup is available for a number of text editors. + +SiSU is less about document layout than about finding a way with little markup to be able to construct an abstract representation of a document that makes it possible to produce multiple representations of it which may be rather different from each other and used for different purposes, whether layout and publishing, or search of content + +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)... + +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. + diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_manual.ssm b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_manual.ssm new file mode 100644 index 00000000..26ca4b6a --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_manual.ssm @@ -0,0 +1,110 @@ +% SiSU master 0.58 + +@title: SiSU - SiSU information Structuring Universe + +@subtitle: Manual [0.58] + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2002-08-28 + +@date.issued: 2002-08-28 + +@date.available: 2002-08-28 + +@date.modified: 2007-08-30 + +@date: 2007-08-30 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~ @title @creator + +:B~ What is SiSU? + +<< |sisu_introduction.sst|@|^| + +<< |sisu_help.sst|@|^| + +% :B~? SiSU Commands + +<< |sisu_commands.sst|@|^| + +% :B~? SiSU Markup + +<< |sisu_markup.sst|@|^| + +<< |sisu_filetypes.sst|@|^| + +% :B~? SiSU Configuration and Skins + +<< |sisu_config.ssi|@|^| + +<< |sisu_skin.sst|@|^| + +<< |sisu_css.ssi|@|^| + +<< |sisu_content_directories.ssi|@|^| + +<< |sisu_homepages.ssi|@|^| + +% :B~? SiSU Output and Markup Examples + +<< |sisu_examples.sst|@|^| + +<< |sisu_output_overview.sst|@|^| + +<< |sisu_search_intro.ssi|@|^| + +<< |sisu_sql.ssi|@|^| + +<< |sisu_postgresql.sst|@|^| + +<< |sisu_sqlite.sst|@|^| + +<< |sisu_search_cgi.ssi|@|^| + +<< |sisu_hyperestraier.ssi|@|^| + +<< |sisu_webrick.sst|@|^| + +<< |sisu_remote.sst|@|^| + +% :B~? SiSU Download and Installation + +<< |sisu_download.ssi|@|^| + +<< |sisu_installation.ssi|@|^| + +<< |sisu_quickstart.sst|@|^| + +% :B~? SiSU Howto and FAQ + +<< |sisu_howto.sst|@|^| + +<< |sisu_faq.sst|@|^| + +<< |sisu_syntax_highlighting.sst|@|^| + +<< |sisu_help_sources.sst|@|^| diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_markup.sst b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_markup.sst new file mode 100644 index 00000000..37528e0a --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_markup.sst @@ -0,0 +1,1194 @@ +% SiSU 0.58 + +@title: SiSU + +@subtitle: Markup [0.58] + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2002-08-28 + +@date.issued: 2002-08-28 + +@date.available: 2002-08-28 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +% @prefix: + +:A~? @title @creator + +:B~? SiSU Markup + +1~markup Introduction to SiSU Markup~{ 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. }~ + +2~ Summary + +SiSU source documents are plaintext (UTF-8)~{ files should be prepared using UTF-8 character encoding }~ files + +All paragraphs are separated by an empty line. + +Markup is comprised of: + +_* 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) + +_* 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: + +_1* heading levels defines document structure + +_1* text basic attributes, italics, bold etc. + +_1* grouped text (objects), which are to be treated differently, such as code blocks or poems. + +_1* footnotes/endnotes + +_1* linked text and images + +_1* paragraph actions, such as indent, bulleted, numbered-lists, etc. + +Some interactive help on markup is available, by typing sisu and selecting markup or sisu --help markup + +2~ Markup Examples + +3~ Online + +Online markup examples are available together with the respective outputs produced from http://www.jus.uio.no/sisu/SiSU/2.html or from http://www.jus.uio.no/sisu/sisu_examples/ + +There is of course this document, which provides a cursory overview of sisu markup and the respective output produced: http://www.jus.uio.no/sisu/sisu_markup/ + +Some example marked up files are available as html with syntax highlighting for viewing: http://www.jus.uio.no/sisu/sample/syntax + +an alternative presentation of markup syntax: http://www.jus.uio.no/sisu/sample/on_markup.txt + +3~ Installed + +With SiSU 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: /usr/share/doc/sisu/sisu_markup_samples/non-free + +1~headers Markup of Headers + +Headers consist of semantic meta-data about a document, which can be used by any output module of the program; and may in addition include extra processing instructions. + +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: + +code{ + +% this would be a comment + +}code + +2~ Sample Header + +This current document has a header similar to this one (without the comments): + +code{ + +% SiSU 0.57 + +@title: SiSU + +@subtitle: Markup [0.58] + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2002-08-28 + +@date.issued: 2002-08-28 + +@date.available: 2002-08-28 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +% comment: in this @level header num_top=1 starts automatic heading numbering at heading level 1 (numbering continues 3 levels down); the new and break instructions are used by the LaTeX/pdf and odf output to determine where to put page breaks (that are not used by html output or say sql database population). + +@skin: skin_sisu_manual + +% skins modify the appearance of a document and are placed in a sub-directory under ./_sisu/skin ~/.sisu/skin or /etc/sisu/skin. A skin may affect single documents that request them, all documents in a directory, or be site-wide. (A document is affected by a single skin) + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + +}code + +2~ Available Headers + +Header tags appear at the beginning of a document and provide meta information on the document (such as the Dublin Core), or information as to how the document as a whole is to be processed. All header instructions take either the form @headername: or 0~headername. All Dublin Core meta tags are available + +!_ @indentifier: +information or instructions + +where the "identifier" is a tag recognised by the program, and the "information" or "instructions" belong to the tag/indentifier specified + +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. + +This is a sample header + +% (Dublin Core in fuschia, other information headers in cyan, markup instructions in red): + +!_ % SiSU 0.38 +[declared file-type identifier with markup version] + +!_ @title: +[title text] This is the title of the document and used as such, this header is the only one that is _{mandatory}_ + +!_ @subtitle: +The Subtitle if any + +!_ @creator: +[or @author:] Name of Author + +!_ @subject: +(whatever your subject) + +!_ @description: + +!_ @publisher: + +!_ @contributor: + +!_ @translator: +[or @translated_by:] + +!_ @illustrator: +[or @illustrated_by:] + +!_ @prepared_by: +[or @digitized_by:] + +!_ @date: 2000-08-27 +[ also @date.created: @date.issued: @date.available: @date.valid: @date.modified: ] + +!_ @type: article + +!_ @format: + +!_ @identifier: + +!_ @source: + +!_ @language: +[or @language.document:] +[country code for language if available, or language, English, en is the default setting] (en - English, fr - French, de - German, it - Italian, es - Spanish, pt - Portuguese, sv - Swedish, da - Danish, fi - Finnish, no - Norwegian, is - Icelandic, nl - Dutch, et - Estonian, hu - Hungarian, pl - Polish, ro - Romanian, ru - Russian, el - Greek, uk - Ukranian, tr - Turkish, sk - Slovak, sl - Slovenian, hr - Croatian, cs - Czech, bg - Bul garian ) [however, encodings are not available for all of the languages listed.] + +% !_ @language.original: BUG bold marker see to + +[@language.original: +original language in which the work was published] + +!_ @papersize: +(A4|US_letter|book_B5|book_A5|US_legal) + +!_ @relation: + +!_ @coverage: + +!_ @rights: +Copyright (c) Name of Right Holder, all rights reserved, or as granted: public domain, copyleft, creative commons variant, etc. + +!_ @owner: + +!_ @keywords: +text document generation processing management latex pdf structured xml citation [your keywords here, used for example by rss feeds, and in sql searches] + +!_ @abstract: +[paper abstract, placed after table of contents] + +!_ @comment: +[...] + +!_ @catalogue: +loc=[Library of Congress classification]; dewey=[Dewey classification]; isbn=[ISBN]; pg=[Project Gutenberg text number] + +!_ @classify_loc: +[Library of Congress classification] + +!_ @classify_dewey: +[Dewey classification] + +!_ @classify_isbn: +[ISBN] + +!_ @classify_pg: +[Project Gutenberg text number] + +!_ @prefix: +[prefix is placed just after table of contents] + +!_ @prefix_a: +[prefix is placed just before table of contents - not implemented] + +!_ @prefix_b: + +!_ @rcs: +$Id: sisu_markup.sst,v 1.2 2007/09/08 17:12:47 ralph Exp $ [used by rcs or cvs to embed version (revision control) information into document, rcs or cvs can usefully provide a history of updates to a document ] + +!_ @structure: +PART; CHAPTER; SECTION; ARTICLE; none; none;<br> +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:) + +!_ @level: +newpage=3; breakpage=4<br> +[paragraph level, used by latex to breakpages, the page is optional eg. in newpage] + +!_ @markup: +information on the markup used, e.g. new=1,2,3; break=4; num_top=4 [or newpage=1,2,3; breakpage=4; num_top=4] newpage and breakpage, heading level, used by LaTeX to breakpages. breakpage: starts on a new page in single column text and on a new column in double column text; newpage: starts on a new page for both single and double column texts.<br>num_top=4 [auto-number document, starting at level 4. the default is to provide 3 levels, as in 1 level 4, 1.1 level 5, 1.1.1 level 6, markup to be merged within level]<br>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] + +!_ @bold: +[regular expression of words/phrases to be made bold] + +!_ @italics: +[regular expression of words/phrases to italicise] + +!_ @vocabulary: +name of taxonomy/vocabulary/wordlist to use against document + +!_ @skin: +skin_doc_[name_of_desired_document_skin]<br> +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. + +!_ @links: +\{ SiSU }http://www.jus.uio.no/sisu/;<br> +\{ FSF }http://www.fsf.org + +!_ @promo: +sisu, ruby, search_libre_docs, open_society<br> +[places content in right pane in html, makes use of list.yml and promo.yml, commented out sample in document sample: free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst] + +% header ends here, NB only @title: is mandatory [this would be a comment] +% NOTE: headings/levels below refer to 0.38 expermental markup (a conversion script provided in sisu-examples, modify.rb makes conversion between 0.37 and 0.38 markup simple) + +1~ Markup of Substantive Text + +2~heading_levels Heading Levels + +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) + +!_ :A~ [heading text] +Top level heading [this usually has similar content to the title @title: ] +NOTE: the heading levels described here are in 0.38 notation, see heading + +!_ :B~ [heading text] +Second level heading [this is a heading level divider] + +!_ :C~ [heading text] +Third level heading [this is a heading level divider] + +!_ 1~ [heading text] +Top level heading preceding substantive text of document or sub\-heading 2, the heading level that would normally be marked 1. or 2. or 3. etc. in a document, and the level on which sisu by default would break html output into named segments, names are provided automatically if none are given (a number), otherwise takes the form 1~my\_filename\_for\_this\_segment + +!_ 2~ [heading text] +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. + +!_ 3~ [heading text] +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 + +code{ + +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) + +}code + +2~ Font Attributes + +!_ markup example: + +code{ + +normal text !{emphasis}! *{bold text}* _{underscore}_ /{italics}/ "{citation}" ^{superscript}^ ,{subscript}, +{inserted text}+ + +normal text + +!{emphasis}! + +*{bold text}* + +_{underscore}_ + +/{italics}/ + +"{citation}" + +^{superscript}^ + +,{subscript}, + ++{inserted text}+ + +-{strikethrough}- + +}code + +!_ resulting output: + +normal text !{emphasis}! *{bold text}* _{underscore}_ /{italics}/ "{citation}" ^{superscript}^ ,{subscript}, +{inserted text}+ +-{strikethrough}- + +normal text + +!{emphasis}! + +*{bold text}* + +_{underscore}_ + +/{italics}/ + +"{citation}" + +^{superscript}^ + +,{subscript}, + ++{inserted text}+ + +-{strikethrough}- + +2~ Indentation and bullets + +!_ markup example: + +code{ + +ordinary paragraph + +_1 indent paragraph one step + +_2 indent paragraph two steps + +_9 indent paragraph nine steps + +}code + +!_ resulting output: + +ordinary paragraph + +_1 indent paragraph one step + +_2 indent paragraph two steps + +_9 indent paragraph nine steps + +!_ markup example: + +code{ + +_* bullet text + +_1* bullet text, first indent + +_2* bullet text, two step indent + +}code + +!_ resulting output: + +_* bullet text + +_1* bullet text, first indent + +_2* bullet text, two step indent + +Numbered List (not to be confused with headings/titles, (document structure)) + +!_ markup example: + +code{ + +# numbered list numbered list 1., 2., 3, etc. + +_# numbered list numbered list indented a., b., c., d., etc. + +}code + +2~ Footnotes / Endnotes + +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. + +!_ markup example: + +code{ + +~{ a footnote or endnote }~ + +}code + +!_ resulting output: + +~{ a footnote or endnote }~ + +!_ markup example: + +code{ + +normal text~{ self contained endnote marker & endnote in one }~ continues + +}code + +!_ resulting output: + +normal text~{ self contained endnote marker & endnote in one }~ continues + +!_ markup example: + +code{ + +normal text ~{* unnumbered asterisk footnote/endnote, insert multiple asterisks if required }~ continues + +normal text ~{** another unnumbered asterisk footnote/endnote }~ continues + +}code + +!_ resulting output: + +normal text ~{* unnumbered asterisk footnote/endnote, insert multiple asterisks if required }~ continues + +normal text ~{** another unnumbered asterisk footnote/endnote }~ continues + +!_ markup example: + +code{ + +normal text ~[* editors notes, numbered asterisk footnote/endnote series ]~ continues + +normal text ~[+ editors notes, numbered asterisk footnote/endnote series ]~ continues + +}code + +!_ resulting output: + +normal text ~[* editors notes, numbered asterisk footnote/endnote series ]~ continues + +normal text ~[+ editors notes, numbered asterisk footnote/endnote series ]~ continues + +!_ Alternative endnote pair notation for footnotes/endnotes: + +code{ + +code{ + +% note the endnote marker "~^" + +normal text~^ continues + +^~ endnote text following the paragraph in which the marker occurs + +}code + +the standard and pair notation cannot be mixed in the same document + +2~ Links + +3~ Naked URLs within text, dealing with urls + +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). + +!_ markup example: + +code{ + +normal text http://www.jus.uio.no/sisu continues + +}code + +!_ resulting output: + +normal text http://www.jus.uio.no/sisu continues + +An escaped url without decoration + +!_ markup example: + +code{ + +normal text _http://www.jus.uio.no/sisu continues + +deb _http://www.jus.uio.no/sisu/archive unstable main non-free + +}code + +!_ resulting output: + +normal text _http://www.jus.uio.no/sisu continues + +deb _http://www.jus.uio.no/sisu/archive unstable main non-free + +where a code block is used there is neither decoration nor hyperlinking, code blocks are discussed later in this document + +!_ resulting output: + +code{ + +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 + +}code + +To link text or an image to a url the markup is as follows + +!_ markup example: + +code{ + +about { SiSU }http://url.org markup + +}code + +3~ Linking Text + +!_ resulting output: + +about { SiSU }http://www.jus.uio.no/sisu/ markup + +A shortcut notation is available so the url link may also be provided automatically as a footnote + +!_ markup example: + +code{ + +about {~^ SiSU }http://url.org markup + +}code + +!_ resulting output: + +about {~^ SiSU }http://www.jus.uio.no/sisu/ markup + +3~ Linking Images + +!_ markup example: + +code{ + +{ tux.png 64x80 }image + +% various url linked images + +{tux.png 64x80 "a better way" }http://www.jus.uio.no/sisu/ + +{GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian and Ruby" }http://www.jus.uio.no/sisu/ + +{~^ ruby_logo.png "Ruby" }http://www.ruby-lang.org/en/ + + +}code + +!_ resulting output: + +{ tux.png 64x80 }image + +{tux.png 64x80 "Gnu/Linux - a better way" }http://www.jus.uio.no/sisu/ + +{~^ ruby_logo.png "Ruby" }http://www.ruby-lang.org/en/ + +{GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian and Ruby" }http://www.jus.uio.no/sisu/ + + +!_ linked url footnote shortcut + +code{ + +{~^ [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 + +}code + +code{ + +text marker *~name + +}code + +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. + +2~ Grouped Text + +3~ Tables + +Tables may be prepared in two either of two forms + +!_ markup example: + +code{ + +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 + +}code + +!_ resulting output: + +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 + +a second form may be easier to work with in cases where there is not much information in each column + +*{markup example:}*~{ Table from the Wealth of Networks by Yochai Benkler<br> http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler }~ + +code{ + +!_ 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. + +}code + +!_ resulting output: + + +!_ 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. + + +% code{ +% +% test +% +% ~# +% +% % unnumbered paragraph (place marker at end of paragraph) +% +% -# +% +% % unnumbered paragraph, delete when not required (place marker at end of paragraph) [used in dummy headings, eg. for segmented html] +% +% % add a comment to text, that will be removed prior to processing (place marker at beginning of line) +% +% }code + +3~ Poem + +!_ basic markup: + +code{ + +poem{ + + Your poem here + +}poem + +Each verse in a poem is given a separate object number. + +}code + +!_ markup example: + +code{ + +poem{ + + `Fury said to a + mouse, That he + met in the + house, + "Let us + 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, "Such + a trial, + dear Sir, + With + no jury + or judge, + would be + wasting + our + breath." + "I'll be + judge, I'll + be jury," + Said + cunning + old Fury: + "I'll + try the + whole + cause, + and + condemn + you + to + death."' + +}poem + +}code + +!_ resulting output: + +poem{ + + `Fury said to a + mouse, That he + met in the + house, + "Let us + 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, "Such + a trial, + dear Sir, + With + no jury + or judge, + would be + wasting + our + breath." + "I'll be + judge, I'll + be jury," + Said + cunning + old Fury: + "I'll + try the + whole + cause, + and + condemn + you + to + death."' + +}poem + +3~ Group + +!_ basic markup: + +code{ + +group{ + + Your grouped text here + +}group + +A group is treated as an object and given a single object number. + +}code + +!_ markup example: + +code{ + +group{ + + `Fury said to a + mouse, That he + met in the + house, + "Let us + 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, "Such + a trial, + dear Sir, + With + no jury + or judge, + would be + wasting + our + breath." + "I'll be + judge, I'll + be jury," + Said + cunning + old Fury: + "I'll + try the + whole + cause, + and + condemn + you + to + death."' + +}group + +}code + +!_ resulting output: + +group{ + + `Fury said to a + mouse, That he + met in the + house, + "Let us + 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, "Such + a trial, + dear Sir, + With + no jury + or judge, + would be + wasting + our + breath." + "I'll be + judge, I'll + be jury," + Said + cunning + old Fury: + "I'll + try the + whole + cause, + and + condemn + you + to + death."' + +}group + +3~ Code + +Code tags are used to escape regular sisu markup, and have been used extensively within this document to provide examples of SiSU markup. You cannot however use code tags to escape code tags. They are however used in the same way as group or poem tags. + +A code-block is treated as an object and given a single object number. [an option to number each line of code may be considered at some later time] + +!_ use of code tags instead of poem compared, resulting output: + +code{ + + `Fury said to a + mouse, That he + met in the + house, + "Let us + 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, "Such + a trial, + dear Sir, + With + no jury + or judge, + would be + wasting + our + breath." + "I'll be + judge, I'll + be jury," + Said + cunning + old Fury: + "I'll + try the + whole + cause, + and + condemn + you + to + death."' + +}code + +1~ Composite documents markup + +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 *{.ssm}* 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 *{.sst}* regular markup file, or *{.ssi}* (insert/information) A secondary file of the composite document is built prior to processing with the same prefix and the suffix *{._sst}* + +basic markup for importing a document into a master document + +code{ + +<< |filename1.sst|@|^| + +<< |filename2.ssi|@|^| + +}code + +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. + +code{ + +r{filename} + +{filename.ssi}require + +<< {filename.ssi} + +% using textlink alternatives + +|filename.ssi|@|^|require + +<< |filename.ssi|@|^| + +% using thlnk alternatives + +<url:filename.ssi>require + +<< <url:filename.ssi> + +}code + +% Composite documents - remote parts + +% Composite documents may be built from remote parts, by using the composite document syntax with a url. This makes sense using either sisu regular syntax (which is just a convenient way of marking up), or thlnk syntax, which also recognises remote urls, and permits hyperlinking ascii to the url location. + +% remote documents may be called with the thlnk syntax (or regular sisu syntax), e.g. + +% << <url:http://www.url.com/filename.ssi> +% +% +% .SH "DOCUMENT NAMING CONVENTION" +% .PP +% SiSU documents are named with the suffix +% .I ss +% followed by a third distinguishing letter, usually t for ordinary text files. +% .PP +% .I .sst +% is used by regular documents, and for most purposes is all you need to be aware of +% .PP +% .I .ssm +% suffix indicates a master or composite document, i.e. a document which requests other documents, which may have the file extension .sst or .ssi. See section on Composite Documents for information on how these are prepared. +% .PP +% .I .ssi +% indicates some prepared sisu markup information that is to be requested within master or composite document(s) and is not to be processed as a stand\-alone document. +% .PP +% .I ._sst +% and +% .I .\-sst +% suffix are reserved for SiSU processing, and indicate a secondary file. Such secondary files are created when a composite file is constructed, and when a url is provided, it is saved locally for processing, as a secondary processing file. Secondary files may be clobbered by SiSU at will, and are not a way of storing information. +% +% .I .sxs.xml +% simple xml sax, sisu markup representation +% +% .I .sxd.xml +% simple xml dom, sisu markup representation +% +% .I .sxn.xml +% simple xml node, sisu markup representation +% +% .I .sxs.xml.sst +% or +% .I .sxd.xml.sst +% or +% .I .sxn.xml.sst +% auto\-converted from a simple xml markup representation (sxs, sxd, sxn) +% .\" %% Remote Operations +% .SH "REMOTE OPERATIONS" +% .PP +% These may be of three basic types. +% .PP +% Instruction that processed files are to be copied to a remote server, using the \-r or \-R flag as part of the processing instruction. This requires previous setting up/configuration of the method to be used (eg scp assumed for \-r and rsync for \-R) and url to which these files are to be sent. * +% .PP +% The downloading of a remote file for processing using SiSU locally, which is achieved in one of two ways: +% .PP +% A processing instruction may include the url to the a remote file that is to be processed \- this will be downloaded and given a temporary file .t extension, and will be processed using SiSU locally. +% .PP +% A file may request the inclusion of a remote document within it, see comments on "Composite Documents" for the request syntax. +% .PP +% Finally SiSU may be run on a remote server, which you download marked up files to for processing. This is not really a function of the operation of SiSU, just an available possibility given that not much bandwidth is required. +% .PP +% * with regard to remote files processed locally, the \-r option, a limitation is that it is up to the user to ensure that the remote file does not have an identical filename to another, e.g. local file, that is to be processed in the same directory. So far this has not been found to happen in practice... Alternative solutions are under consideration, but it is desired that filenames be human assigned, and meaningful, so hash keys of contents for filenames are not amongst the options considered. + +:C~ Markup Syntax History + +1~ Notes related to Files-types and Markup Syntax + +0.38 is substantially current, depreciated 0.16 supported, though file names were changed at 0.37 + +!_ 0.52 +(2007w14/6) +declared document type identifier at start of text/document: + +_1 SiSU 0.52 + +or, backward compatible using the comment marker: + +_1 % SiSU 0.38 + +variations include 'SiSU (text|master|insert) [version]' and 'sisu-[version]' + +!_ 0.51 +(2007w13/6) +skins changed (simplified), markup unchanged + +!_ 0.42 +(2006w27/4) +* (asterisk) type endnotes, used e.g. in relation to author + +!_ 0.38 +(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) + +!_ 0.37 +(2006w09/7) +introduced new file naming convention, .sst (text), .ssm (master), .ssi (insert), markup syntax unchanged + +!_ 0.35 +(2005w52/3) +sisupod, zipped content file introduced + +!_ 0.23 +(2005w36/2) +utf-8 for markup file + +!_ 0.22 +(2005w35/3) +image dimensions may be omitted if rmagick is available to be relied upon + +!_ 0.20.4 +(2005w33/4) +header 0~links + +!_ 0.16 +(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 marker diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_output_overview.sst b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_output_overview.sst new file mode 100644 index 00000000..dc17d5dc --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_output_overview.sst @@ -0,0 +1,96 @@ +% SiSU 0.57 + +@title: SiSU - SiSU information Structuring Universe / Structured information, Serialized Units + +@subtitle: SiSU overview of status of features available in various outputs + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2005-10-31 + +@date.available: 2006-10-31 + +@date.issued: 2006-10-31 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? SiSU overview of status of features available in various outputs + +1~ A Checklist of Output Features + +% 5~ features available in various output types + +This table gives an indication of the features that are available +for various forms of output of SiSU.~{ updated for sisu-0.36.6 on 2006-01-23 }~ + +{t~h} +feature |txt|ltx/pdf|HTML|XHTML|XML/s|XML/d|ODF|SQLite|pgSQL +headings | * | * | * | * | * | * | * | * | * +footnotes | * | * | * | * | * | * | * | * | * +bold, underscore, italics | . | * | * | * | * | * | * | * | * +strikethrough | . | * | * | * | * | * | * | | +superscript, subscript | . | * | * | * | * | * | * | | +extended ascii set (utf-8)| * | * | * | * | * | * | * | | * +indents | * | * | * | * | * | * | * | | +bullets | . | * | * | * | * | * | . | | +groups | | | | | | | | | +* tables | | * | * | . | . | . | . | . | . +* poem | * | * | * | . | . | . | * | . | . +* code | * | * | * | . | . | . | * | . | . +url | * | * | * | * | * | * | * | . | . +links | * | * | * | * | * | * | * | . | . +images | - | * | * | T | T | T | * | T | T +image caption | - | * | * | | | | | | +table of contents | | * | * | * | * | * | . | | +page header/footer? | - | * | * | * | * | * | t | | +line break | * | * | * | * | * | * | * | | +page break | | * | | | | | * | | +segments | | | * | | | | | | +skins | * | * | * | * | * | * | | | +ocn | . | * | * | * | * | * | -?| * | * +auto-heading numbers | * | * | * | * | * | * | * | * | * +minor list numbering | * | * | * | * | * | * | * | * | * +special characters | . | . | . | | | | | | + +group{ + + Done + * yes/done + . partial + + - not available/appropriate + + Not Done + T task todo + t lesser task/todo + not done + +}group + diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_pdf.sst b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_pdf.sst new file mode 100644 index 00000000..8e54160c --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_pdf.sst @@ -0,0 +1,100 @@ +% SiSU 0.58 + +@title: SiSU - SiSU information Structuring Universe + +@subtitle: Search [0.58] + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2002-08-28 + +@date.issued: 2002-08-28 + +@date.available: 2002-08-28 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? SiSU Search + +:C~ SiSU Sqlite + +1~sqlite Sqlite + +2~ Name + +SiSU - Structured information, Serialized Units - a document publishing system. + +2~ Description + +Information creating pdf output with sisu (and related to the sisu_pdf dependency package, which is a dummy package to install dependencies needed for SiSU to generate pdfs (primarily related to LaTeX), sisu_pdf being part of SiSU - man sisu). + +SiSU generates LaTeX which is converted by LaTeX tools to pdf. + +2~ Synopsis + +_1 sisu -pv [filename/wildcard] + +2~ Commands + +!_ sisu -pv [filename/wildcard]<br> +creates two pdf documents: vertical (portrait.pdf) and; horizontal (landscape.pdf). SiSU generates LaTeX output which is converted to pdf if the appropriate LaTeX dependencies are met on the system. + +!_ sisu -pv --papersize-a4 [filename/wildcard]<br> +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). + +2~ Setting Paper Size + +The paper-size may be set to any of the following sizes: 'A4', U.S. 'letter' and 'legal' and book sizes: 'A5' and 'B5' + +# The preset default if not otherwise given in the configuration file or elsewhere is A4. + +# The default paper size may be set in the configuration file sisurc.yml. See sisu_configuration: + +code{ + +#% papersize, (LaTeX/pdf) current values A4, US_letter, book_b5, book_a5, US_legal + +default: + papersize: 'A4' + +}code + +# Paper size may be set in a document header: + +code{ + +@papersize: (A4|US_letter|book_B5|book_A5|US_legal) + +}code + +# or provided with additional command line parameter, e.g. + +_1 sisu -pv --papersize-a4 [filename/wildcard] + diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_postgresql.sst b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_postgresql.sst new file mode 100644 index 00000000..42ed2bbe --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_postgresql.sst @@ -0,0 +1,99 @@ +% SiSU 0.58 + +@title: SiSU - SiSU information Structuring Universe + +@subtitle: Search [0.58] + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2002-08-28 + +@date.issued: 2002-08-28 + +@date.available: 2002-08-28 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? SiSU Search + +:C~? SiSU Postgresql + +1~postgresql Postgresql + +2~ Name + +SiSU - Structured information, Serialized Units - a document publishing system, postgresql dependency package + +2~ Description + +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 SiSU to populate a postgresql database, this being part of SiSU - man sisu). + +2~ Synopsis + +_1 sisu -D [instruction] [filename/wildcard if required] + +_1 sisu -D --pg --[instruction] [filename/wildcard if required] + + +2~ Commands + +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 + +!_ -D or --pgsql +may be used interchangeably. + +3~ create and destroy database + +!_ --pgsql --createall<br> +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) + +!_ sisu -D --createdb<br> +creates database where no database existed before + +!_ sisu -D --create<br> +creates database tables where no database tables existed before + +!_ sisu -D --Dropall<br> +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). + +!_ sisu -D --recreate<br> +destroys existing database and builds a new empty database structure + +3~ import and remove documents + +!_ sisu -D --import -v [filename/wildcard]<br> +populates database with the contents of the file. Imports documents(s) specified to a postgresql database (at an object level). + +!_ sisu -D --update -v [filename/wildcard]<br> +updates file contents in database + +!_ sisu -D --remove -v [filename/wildcard]<br> +removes specified document from postgresql database. + diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_quickstart.sst b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_quickstart.sst new file mode 100644 index 00000000..80f4753e --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_quickstart.sst @@ -0,0 +1,273 @@ +% SiSU 0.57 + +@title: SiSU - SiSU information Structuring Universe / Structured information, Serialized Units + +@subtitle: Quickstart, installation and use + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2006-09-06 + +@date.available: 2006-09-06 + +@date.issued: 2006-09-06 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? Quickstart - SiSU installation and use + +1~ Quickstart - Getting Started Howto + +2~ Installation + +Installation is currently most straightforward and tested on the Debian platform, as there are packages for the installation of sisu and all requirements for what it does. + +3~ Debian Installation + +SiSU is available directly from the Debian Sid and testing archives (and possibly Ubuntu), assuming your /etc/apt/sources.list is set accordingly: + +code{ + + aptitude update + aptitude install sisu-complete + +}code + +The following /etc/apt/sources.list setting permits the download of additional markup samples: + +code{ + +#/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 + +}code + +The aptitude commands become: + +code{ + + aptitude update + aptitude install sisu-complete sisu-markup-samples + +}code + +If there are newer versions of SiSU upstream of the Debian archives, they will be available by adding the following to your /etc/apt/sources.list + +code{ + +#/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 + +}code + +repeat the aptitude commands + +code{ + + aptitude update + aptitude install sisu-complete sisu-markup-samples + +}code + +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. + +3~ RPM Installation + +RPMs are provided though untested, they are prepared by running alien against the source package, and against the debs. + +They may be downloaded from: + +_1 http://www.jus.uio.no/sisu/SiSU/download.html#rpm + +as root type: + +_1 rpm -i [rpm package name] + +3~ Installation from source + +To install SiSU from source check information at: + +_1 http://www.jus.uio.no/sisu/SiSU/download.html#current + +_* download the source package + +_* Unpack the source + +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: + +For basic use SiSU is only dependent on the programming language in which it is written Ruby, and SiSU 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)~{ There is nothing to stop MySQL support being added in future. }~ or converting LaTeX to pdf. + +!_ setup.rb + +This is a standard ruby installer, using setup.rb is a three step process. In the root directory of the unpacked SiSU as root type: + +code{ + + ruby setup.rb config + ruby setup.rb setup + #[and as root:] + ruby setup.rb install + +}code + +further information on setup.rb is available from: + +_1 http://i.loveruby.net/en/projects/setup/ + +_1 http://i.loveruby.net/en/projects/setup/doc/usage.html + +!_ "install" + +The "install" file provided is an installer prepared using "rant". In the root directory of the unpacked SiSU as root type: + +_1 ruby install base + +or for a more complete installation: + +_1 ruby install + +or + +_1 ruby install base + +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. + +Further information on "rant" is available from: + +_1 http://make.rubyforge.org/ + +_1 http://rubyforge.org/frs/?group_id=615 + +For a list of alternative actions you may type: + +_1 ruby install help + +_1 ruby install -T + +2~ Testing SiSU, generating output + +To check which version of sisu is installed: + +sisu -v + +Depending on your mode of installation one or a number of markup sample files may be found either in the directory: + +... + +or + +... + +change directory to the appropriate one: + +cd /usr/share/doc/sisu/sisu_markup_samples/dfsg + +3~ basic text, plaintext, html, XML, ODF + +Having moved to the directory that contains the markup samples (see instructions above if necessary), choose a file and run sisu against it + +sisu -NhwoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst + +this will generate html including a concordance file, opendocument text format, plaintext, XHTML and various forms of XML, and OpenDocument text + +3~ LaTeX / pdf + +Assuming a LaTeX engine such as tetex or texlive is installed with the required modules (done automatically on selection of sisu-pdf in Debian) + +Having moved to the directory that contains the markup samples (see instructions above if necessary), choose a file and run sisu against it + +sisu -pv free_as_in_freedom.rms_and_free_software.sam_williams.sst + +sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst + +should generate most available output formats: html including a concordance file, opendocument text format, plaintext, XHTML and various forms of XML, and OpenDocument text and pdf + +3~ relational database - postgresql, sqlite + +Relational databases need some setting up - you must have permission to create the database and write to it when you run sisu. + +Assuming you have the database installed and the requisite permissions + +sisu --sqlite --recreate + +sisu --sqlite -v --import free_as_in_freedom.rms_and_free_software.sam_williams.sst + +sisu --pgsql --recreate + +sisu --pgsql -v --import free_as_in_freedom.rms_and_free_software.sam_williams.sst + +2~ Getting Help + +3~ The man pages + +Type: + +_1 man sisu + +The man pages are also available online, though not always kept as up to date as within the package itself: + +_* {~^ sisu.1 }http://www.jus.uio.no/sisu/man/sisu.1 + +_* {~^ sisu.8 }http://www.jus.uio.no/sisu/man/sisu.8 + +_* {~^ man directory }http://www.jus.uio.no/sisu/man + +3~ Built in help + +sisu --help + +sisu --help --env + +sisu --help --commands + +sisu --help --markup + +3~ The home page + +http://www.jus.uio.no/sisu + +http://www.jus.uio.no/sisu/SiSU + +2~ Markup Samples + +A number of markup samples (along with output) are available off: + +http://www.jus.uio.no/sisu/SiSU/2.html + +Additional markup samples are packaged separately in the file: + +*** + +On Debian they are available in non-free~{ the Debian Free Software guidelines require that everything distributed within Debian can be changed - and the documents are authors' works that while freely distributable are not freely changeable. }~ to include them it is necessary to include non-free in your /etc/apt/source.list or obtain them from the sisu home site. diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_remote.sst b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_remote.sst new file mode 100644 index 00000000..40d96472 --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_remote.sst @@ -0,0 +1,108 @@ +% SiSU 0.58 + +@title: SiSU + +@subtitle: Remote Operations [0.58] + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2002-08-28 + +@date.issued: 2002-08-28 + +@date.available: 2002-08-28 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +% @prefix: + +:A~? @title @creator + +:B~? SiSU Remote Operations + +1~remote_source Remote Source Documents + +SiSU 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 SiSU documents can either be sisu marked up files in plaintext .sst or .ssm or; zipped sisu files, sisupod.zip or filename.ssp + +!_ .sst / .ssm - sisu text files + +SiSU 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. + +code{ + +sisu -3 http://[provide url to valid .sst or .ssm file] + +}code + +Any of the source documents in the sisu examples page can be used in this way, see http://www.jus.uio.no/sisu/SiSU/2.html and use the url for the desired document. + +NOTE: to set up a remote machine to serve SiSU documents in this way, images should be in the directory relative to the document source ../_sisu/image + +!_ sisupod - zipped sisu files + +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. + +SiSU 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. + +code{ + +sisu -3 http://[provide url to valid sisupod.zip or .ssp file] + +}code + +Any of the source documents in the sisu examples page can be used in this way, see http://www.jus.uio.no/sisu/SiSU/2.html and use the url for the desired document. + +:C~ Remote Document Output + +1~remote_output Remote Output + +Once properly configured SiSU output can be automatically posted once generated to a designated remote machine using either rsync, or scp. + +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. + +code{ + +sisu -3R sisu_remote.sst + +}code + +2~ commands + +!_ -R [filename/wildcard] <br> +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 "keys" and ssh agent in place. Note the behavior of rsync different if -R is used with other flags from if used alone. Alone the rsync --delete parameter is sent, useful for cleaning the remote directory (when -R is used together with other flags, it is not). Also see -r + +!_ -r [filename/wildcard] <br> +copies sisu output files to remote host using scp. This requires that sisurc.yml has been provided with information on hostname and username, and that you have your "keys" and ssh agent in place. Also see -R + +2~ configuration + +[expand on the setting up of an ssh-agent / keychain] + +1~remote_servers Remote Servers + +As SiSU is generally operated using the command line, and works within a Unix type environment, SiSU 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. diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_search.ssm b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_search.ssm new file mode 100644 index 00000000..0b4be15e --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_search.ssm @@ -0,0 +1,56 @@ +% SiSU master 0.58 + +@title: SiSU - SiSU information Structuring Universe + +@subtitle: Search [0.58] + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2002-08-28 + +@date.issued: 2002-08-28 + +@date.available: 2002-08-28 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? SiSU Search + +<< |sisu_search_intro.ssi|@|^| + +<< |sisu_sql.ssi|@|^| + +<< |sisu_postgresql.sst|@|^| + +<< |sisu_sqlite.sst|@|^| + +<< |sisu_search_cgi.ssi|@|^| + +<< |sisu_hyperestraier.ssi|@|^| diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_search_cgi.ssi b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_search_cgi.ssi new file mode 100644 index 00000000..f27a7828 --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_search_cgi.ssi @@ -0,0 +1,100 @@ +% SiSU insert 0.58 + +@title: SiSU - SiSU information Structuring Universe + +@subtitle: Search [0.58] + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2002-08-28 + +@date.issued: 2002-08-28 + +@date.available: 2002-08-28 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? SiSU Search + +:C~? Search + +1~search_cgi Introduction + +2~ Search - database frontend sample, utilising database and SiSU features, including object citation numbering (backend currently PostgreSQL) *~search + +{~^ Sample search frontend }http://search.sisudoc.org +A small database and sample query front-end (search from) that makes use of the citation system, _{object citation numbering}_ to demonstrates functionality.~{ (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. }~ + +SiSU 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. + +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.~{ 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. }~ + +% Several options for output - select database to search, show results in index view (links to locations within text), show results with text, echo search in form, show what was searched, create and show a "canned url" for search, show available search fields. Also shows counters number of documents in which found and number of locations within documents where found. [could consider sorting by document with most occurrences of the search result]. + +!_ sisu -F --webserv-webrick<br> +builds a cgi web search frontend for the database created + +The following is feedback on the setup on a machine provided by the help command: + +_1 sisu --help sql + +code{ + +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 + +}code + +Note on databases built + +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 necessary] + +2~ Search Form + +!_ sisu -F<br> +generates a sample search form, which must be copied to the web-server cgi directory + +!_ sisu -F --webserv-webrick<br> +generates a sample search form for use with the webrick server, which must be copied to the web-server cgi directory + +!_ sisu -Fv<br> +as above, and provides some information on setting up hyperestraier + +!_ sisu -W<br> +starts the webrick server which should be available wherever sisu is properly installed + +The generated search form must be copied manually to the webserver directory as instructed diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_search_examples.ssi b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_search_examples.ssi new file mode 100644 index 00000000..2b5ff550 --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_search_examples.ssi @@ -0,0 +1,81 @@ +% SiSU insert 0.58 + +@title: SiSU - SiSU information Structuring Universe + +@subtitle: Search [0.58] + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2002-08-28 + +@date.issued: 2002-08-28 + +@date.available: 2002-08-28 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? SiSU Search + +:C~ Search + +1~ Search Examples + +2~ Search - database frontend sample, utilising database and SiSU features, including object citation numbering (backend currently PostgreSQL) *~search + +{~^ Sample search frontend }http://search.sisudoc.org +A small database and sample query front-end (search from) that makes use of the citation system, _{object citation numbering}_ to demonstrates functionality.~{ (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. }~ + +SiSU 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. + +A few canned searches, showing object numbers. Search for: + +_1 { English documents matching Linux OR Debian }http://search.sisudoc.org?s1=Linux%2BOR%2BDebian&lang=En&db=SiSU_sisu&view=index&a=1 + +_1 { GPL OR Richard Stallman }http://search.sisudoc.org?s1=GPL%2BOR%2BRichard%2BStallman&lang=En&db=SiSU_sisu&view=index&a=1 + +_1 { invention OR innovation in English language }http://search.sisudoc.org?s1=invention%2BOR%2Binnovation&lang=En&db=SiSU_sisu&view=index&a=1 + +_1 { copyright in English language documents }http://search.sisudoc.org?s1=copyright&lang=En&db=SiSU_sisu&view=index&a=1 + +Note that the searches done in this form are case sensitive. + +Expand those same searches, showing the matching text in each document: + +_1 { English documents matching Linux OR Debian }http://search.sisudoc.org?s1=Linux%2BOR%2BDebian&lang=En&db=SiSU_sisu&view=text&a=1 + +_1 { GPL OR Richard Stallman }http://search.sisudoc.org?s1=GPL%2BOR%2BRichard%2BStallman&lang=En&db=SiSU_sisu&view=text&a=1 + +_1 { invention OR innovation in English language }http://search.sisudoc.org?s1=invention%2BOR%2Binnovation&lang=En&db=SiSU_sisu&view=text&a=1 + +_1 { copyright in English language documents }http://search.sisudoc.org?s1=copyright&lang=En&db=SiSU_sisu&view=text&a=1 + +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.~{ 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. }~ + +% Several options for output - select database to search, show results in index view (links to locations within text), show results with text, echo search in form, show what was searched, create and show a "canned url" for search, show available search fields. Also shows counters number of documents in which found and number of locations within documents where found. [could consider sorting by document with most occurrences of the search result]. diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_search_intro.ssi b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_search_intro.ssi new file mode 100644 index 00000000..50e8f36d --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_search_intro.ssi @@ -0,0 +1,53 @@ +% SiSU insert 0.58 + +@title: SiSU - SiSU information Structuring Universe + +@subtitle: Search [0.58] + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2002-08-28 + +@date.issued: 2002-08-28 + +@date.available: 2002-08-28 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? SiSU Search + +1~search_intro SiSU Search - Introduction + +SiSU output can easily and conveniently be indexed by a number of standalone indexing tools, such as Lucene, Hyperestraier. + +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. + +In addition to this SiSU 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. + diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_skin.sst b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_skin.sst new file mode 100644 index 00000000..698a5241 --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_skin.sst @@ -0,0 +1,106 @@ +% SiSU insert 0.58 + +@title: SiSU + +@subtitle: Skins [0.58] + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2002-11-12 + +@date.issued: 2002-11-12 + +@date.available: 2002-11-12 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +% @rcs$ + +:A~? @title @creator + +:B~? Document Skins - configuration + +1~skins Skins + +% .SH "SKINS \- document, directory and site skins" + +Skins modify the default appearance of document output on a document, directory, or site wide basis. Skins are looked for in the following locations: + +_1 ./_sisu/skin + +_1 ~/.sisu/skin + +_1 /etc/sisu/skin + +!_ Within the skin directory +are the following the default sub-directories for document skins: + +_1 ./skin/doc + +_1 ./skin/dir + +_1 ./skin/site + +A skin is placed in the appropriate directory and the file named skin_[name].rb + +The skin itself is a ruby file which modifies the default appearances set in the program. + +2~ Document Skin + +Documents take on a document skin, if the header of the document specifies a skin to be used. + +code{ + +@skin: skin_united_nations + +}code + +2~ Directory Skin + +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). + +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. + +2~ Site Skin + +A site skin, modifies the program default skin. + +2~ Sample Skins + +With SiSU installed sample skins may be found in: + +_1 /etc/sisu/skin/doc and /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc + +(or equivalent directory) and if sisu-markup-samples is installed also under: + +_1 /usr/share/doc/sisu/sisu_markup_samples/non-free/_sisu/skin/doc + +Samples of list.yml and promo.yml (which are used to create the right column list) may be found in: + +_1 /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml (or equivalent directory) + diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_sql.ssi b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_sql.ssi new file mode 100644 index 00000000..701a2ee5 --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_sql.ssi @@ -0,0 +1,69 @@ +% SiSU insert 0.58 + +@title: SiSU - SiSU information Structuring Universe + +@subtitle: Search [0.58] + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2002-08-28 + +@date.issued: 2002-08-28 + +@date.available: 2002-08-28 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? SiSU Search + +:C~? Search + +1~search_sql SQL + +2~ populating SQL type databases + +SiSU feeds sisu markupd documents into sql type databases PostgreSQL~{ http://www.postgresql.org/ <br> http://advocacy.postgresql.org/ <br> http://en.wikipedia.org/wiki/Postgresql }~ and/or SQLite~{ http://www.hwaci.com/sw/sqlite/ <br> http://en.wikipedia.org/wiki/Sqlite }~ database together with information related to document structure. + +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: + +_1* one containing semantic (and other) headers, including, title, author, subject, (the Dublin Core...); + +_1* another the substantive texts by individual "paragraph" (or object) - along with structural information, each paragraph being identifiable by its paragraph number (if it has one which almost all of them do), and the substantive text of each paragraph quite naturally being searchable (both in formatted and clean text versions for searching); and + +_1* a third containing endnotes cross-referenced back to the paragraph from which they are referenced (both in formatted and clean text versions for searching). + +_1* a fourth table with a one to one relation with the headers table contains full text versions of output, eg. pdf, html, xml, and ascii. + +There is of course the possibility to add further structures. + +At this level SiSU 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. + +Being able to search a relational database at an object level with the SiSU citation system is an effective way of locating content generated by SiSU. As individual text objects of a document stored (and indexed) together with 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). + diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_sqlite.sst b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_sqlite.sst new file mode 100644 index 00000000..530444f3 --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_sqlite.sst @@ -0,0 +1,99 @@ +% SiSU 0.58 + +@title: SiSU - SiSU information Structuring Universe + +@subtitle: Search [0.58] + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2002-08-28 + +@date.issued: 2002-08-28 + +@date.available: 2002-08-28 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? SiSU Search + +:C~? SiSU Sqlite + +1~sqlite Sqlite + +2~ Name + +SiSU - Structured information, Serialized Units - a document publishing system. + + +2~ Description + +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 SiSU to populate an sqlite database, this being part of SiSU - man sisu). + +2~ Synopsis + +_1 sisu -d [instruction] [filename/wildcard if required] + +_1 sisu -d --(sqlite|pg) --[instruction] [filename/wildcard if required] + + +2~ Commands + +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 + +!_ -d or --sqlite +may be used interchangeably. + +3~ create and destroy database + +!_ --sqlite --createall<br> +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) + +!_ sisu -d --createdb<br> +creates database where no database existed before + +!_ sisu -d --create<br> +creates database tables where no database tables existed before + +!_ sisu -d --dropall<br> +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). + +!_ sisu -d --recreate<br> +destroys existing database and builds a new empty database structure + +3~ import and remove documents + +!_ sisu -d --import -v [filename/wildcard]<br> +populates database with the contents of the file. Imports documents(s) specified to an sqlite database (at an object level). + +!_ sisu -d --update -v [filename/wildcard]<br> +updates file contents in database + +!_ sisu -d --remove -v [filename/wildcard]<br> +removes specified document from sqlite database. diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_syntax_highlighting.sst b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_syntax_highlighting.sst new file mode 100644 index 00000000..60666075 --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_syntax_highlighting.sst @@ -0,0 +1,171 @@ +% SiSU insert 0.58 + +@title: SiSU + +@subtitle: Syntax Highlighting [0.58] + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2002-11-12 + +@date.issued: 2002-11-12 + +@date.available: 2002-11-12 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +% @rcs$ + +:A~? @title @creator + +:B~? SiSU Syntax Highlighting + +1~ Editor Files, Syntax Highlighting + +The directory: + +_1 ./data/sisu/conf/editor-syntax-etc/ + +_1 /usr/share/sisu/conf/editor-syntax-etc + +contains rudimentary sisu syntax highlighting files for: + +_* (g)vim http://www.vim.org + +_1 package: sisu-vim + +status: largely done + +_1 there is a vim syntax highlighting and folds component + +_* gedit http://www.gnome.org/projects/gedit + +_* gobby http://gobby.0x539.de/ + +_1 file: sisu.lang + +place in: + +_1 /usr/share/gtksourceview-1.0/language-specs + +or + +_1 ~/.gnome2/gtksourceview-1.0/language-specs + +_1 status: very basic syntax highlighting + +_1 comments: this editor features display line wrap and is used by Goby! + +_* nano http://www.nano-editor.org + +_1 file: nanorc + +save as: + +_1 ~/.nanorc + +_1 status: basic syntax highlighting + +_1 comments: assumes dark background; no display line-wrap; does line breaks + +_* diakonos (an editor written in ruby) http://purepistos.net/diakonos + +file: diakonos.conf + +save as: + +_1 ~/.diakonos/diakonos.conf + +includes: + +_1 status: basic syntax highlighting + +comments: assumes dark background; no display line-wrap + +_* kate & kwrite http://kate.kde.org + +_1 file: sisu.xml + +_1 place in: + +_2 /usr/share/apps/katepart/syntax + +_1 or + +_2 ~/.kde/share/apps/katepart/syntax + +_1 [settings::configure kate::{highlighting,filetypes}] + +_1 [tools::highlighting::{markup,scripts}::SiSU] + +% kde-config --prefix +% KDEDIR/share/apps/katepart/syntax/ +% KDEHOME/share/apps/katepart/syntax +% [In the configure dialog in kate, go to the "Editor->highlighting" page and +% >select a highlight to change the mimetype/pattern associations for it.] +% /etc/mime.types +% /usr/share/mime/text + +_* nedit http://www.nedit.org + +_1 file: sisu_nedit.pats + +_1 nedit -import sisu_nedit.pats + +_1 status: a very clumsy first attempt [not really done] + +_1 comments: this editor features display line wrap + +_* emacs http://www.gnu.org/software/emacs/emacs.html + +_1 files: sisu-mode.el + +_1 to file ~/.emacs add the following 2 lines: + +_2 (add-to-list 'load-path "/usr/share/sisu-examples/config/syntax_hi") + +_2 (require 'sisu-mode.el) + +_1 [not done / not yet included] + +_* vim & gvim http://www.vim.org + +_1 files: + +_1 package is the most comprehensive sisu syntax highlighting and editor environment provided to date (is for vim/ gvim, and is separate from the contents of this directory) + +_1 status: this includes: syntax highlighting; vim folds; some error checking + +_1 comments: this editor features display line wrap + +NOTE: + +[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] + +% aeditor (an editor written in ruby) + diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_vim.sst b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_vim.sst new file mode 100644 index 00000000..e7220b46 --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_vim.sst @@ -0,0 +1,95 @@ +% SiSU insert 0.58 + +@title: SiSU + +@subtitle: Vim + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2002-11-12 + +@date.issued: 2002-11-12 + +@date.available: 2002-11-12 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +% @rcs$ + +:A~? @title @creator + +:B~? SiSU Vim + +1~vim SiSU Vim + +!_ Synopsis + +SiSU has syntax highlighting for a number of editors including vim which are documented under: + +_1 man sisu_syntax_highlighting + +_1 /usr/share/doc/sisu/sisu_manual/sisu_syntax_highlighting/index.html + +_1 http://sisudoc.org/sisu_manual/sisu_syntax_highlighting/index.html + +_1 http://www.jus.uio.no/sisu/sisu_manual/sisu_syntax_highlighting/index.html + +SiSU also provides an ftplugin to provide vim folds for SiSU markup, and to set some defaults for SiSU markup in installed by sisu. + +Vim 7 includes sisu markup syntax highlighting. + +Vim related files are included in: +/usr/share/sisu/conf/editor-syntax-etc/vim +(including the syntax highlighter which may be used for earlier versions of Vim). + +sisu-vim actions are activated on files with the suffix .sst .ssm .ssi .-sst ._sst (and the same with a further .meta extension) + +code{ + +<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 + +}code + +FURTHER INFORMATION + +For more information on SiSU see: + +http://www.jus.uio.no/sisu + +or man sisu + diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_webrick.sst b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_webrick.sst new file mode 100644 index 00000000..2e90bef2 --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_webrick.sst @@ -0,0 +1,215 @@ +% SiSU 0.58 + +@title: SiSU + +@subtitle: sisu_webrick [0.58] + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2002-08-28 + +@date.issued: 2002-08-28 + +@date.available: 2007-08-28 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +% @prefix: + +:A~? @title @creator + +:B~? SiSU Webrick + +1~webrick sisu_webrick + +2~ Name + +SiSU - Structured information, Serialized Units - a document publishing system + +2~ Synopsis + +sisu_webrick [port] + +or + +sisu -W [port] + +2~ Description + +sisu_webrick is part of SiSU (man sisu) sisu_webrick starts Ruby's Webrick web-server and points it to the directories to which SiSU output is written, providing a list of these directories (assuming SiSU is in use and they exist). + +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). + +2~ Summary of man page + +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] + +where no port is given and settings are unchanged the default port is 8081 + +2~ Document processing command flags + +sisu -W [port] starts Ruby Webrick web-server, serving SiSU output directories, on the port provided, or if no port is provided and the defaults have not been changed in ~/.sisu/sisurc.yaml then on port 8081 + +2~ Further information + +For more information on SiSU see: http://www.jus.uio.no/sisu + +or man sisu + +2~ Author + +Ralph Amissah <ralph@amissah.com> or <ralph.amissah@gmail.com> + +2~ SEE ALSO + +_1 sisu(1) + +_1 sisu_vim(7) + +_1 sisu(8) + + + +% .\" Name: SiSU information Structuring Universe +% .\" Author: Ralph Amissah +% .\" Description: sisu webrick manpage +% .\" arch-tag: sisu manpage +% .\" License: GPL 3 or later +% .\" Notes: Process this file with +% .\" groff -man -Tascii sisu.1 +% .\" nroff -man sisu.1 | most +% .\" |sisu.1|@|^|<url:sisu.1> +% .TH sisu_webrick 1 "December 17, 2005" "version 0.34" "sisu \-W" +% .SH NAME +% .B SiSU +% \- Structured information, Serialized Units \- a document publishing system +% .SH SYNOPSIS +% .B sisu_webrick +% .I [port] +% .PP +% or +% .PP +% .B sisu +% .B \-W +% .I [port] +% .\"%% Description +% .SH DESCRIPTION +% .B sisu_webrick +% .I is part of SiSU (man sisu) +% sisu_webrick starts Ruby\'s Webrick web\-server and points it to the directories to which +% .I SiSU +% output is written, providing a list of these directories (assuming +% .I SiSU +% is in use and they exist). +% .PP +% The default port for sisu_webrick is set to 8081, this may be modified in the yaml file: +% .I ~/.sisu/sisurc.yaml +% a sample of which is provided as +% .I /etc/sisu/sisurc.yaml +% (or in the equivalent directory on your system). +% .\"%% Summary +% .SH Summary of man page +% .PP +% sisu_webrick, may be started on it\'s own with the command: +% .B sisu_webrick +% .I [port] +% or using the sisu command with the \-W flag: +% .B sisu \-W +% .I [port] +% .PP +% where no port is given and settings are unchanged the default port is 8081 +% .\"%% Flags +% .SH DOCUMENT PROCESSING COMMAND FLAGS +% .PP +% .BI sisu \ \-W \ [port] +% starts Ruby Webrick web\-server, serving +% .I SiSU +% output directories, on the port provided, or if no port is provided and the defaults have not been changed in +% .I ~/.sisu/sisurc.yaml +% then on port 8081 +% .\"%% Further Information +% .SH FURTHER INFORMATION +% .PP +% For more information on +% .I SiSU +% see: +% .I <http://www.jus.uio.no/sisu> +% .PP +% or +% .I man sisu +% .SH AUTHOR +% Ralph Amissah +% .I <ralph@amissah.com> +% or +% .I <ralph.amissah@gmail.com> +% .SH SEE ALSO +% .BR sisu(1), +% .BR sisu_vim(7), +% .BR sisu(8) + +% sisu_webrick(1) sisu -W sisu_webrick(1) +% +% NAME +% SiSU - Structured information, Serialized Units - a document publishing system +% +% SYNOPSIS +% sisu_webrick [port] +% +% or +% +% sisu -W [port] +% +% DESCRIPTION +% sisu_webrick is part of SiSU (man sisu) sisu_webrick starts Ruby´s Webrick web-server and points it to the direc- +% tories to which SiSU output is written, providing a list of these directories (assuming SiSU is in use and they +% exist). +% +% The default port for sisu_webrick is set to 8081, this may be modified in the yaml file: ~/.sisu/sisurc.yaml a +% sample of which is provided as /etc/sisu/sisurc.yaml (or in the equivalent directory on your system). +% +% Summary of man page +% 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] +% +% where no port is given and settings are unchanged the default port is 8081 +% +% DOCUMENT PROCESSING COMMAND FLAGS +% sisu -W [port] starts Ruby Webrick web-server, serving SiSU output directories, on the port provided, or if no +% port is provided and the defaults have not been changed in ~/.sisu/sisurc.yaml then on port 8081 +% +% FURTHER INFORMATION +% For more information on SiSU see: <http://www.jus.uio.no/sisu> +% +% or man sisu +% +% AUTHOR +% Ralph Amissah <ralph@amissah.com> or <ralph.amissah@gmail.com> +% +% SEE ALSO +% sisu(1), sisu_vim(7) sisu(8), +% +% version 0.34 December 17, 2005 sisu_webrick(1) |
