% SiSU master 0.58
@title: SiSU
@subtitle: Manual
@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|@|^|>>ok
% SiSU 0.58
% [imported header:] SiSU
% [imported header:] Commands
% [imported header:] Ralph Amissah
% [imported header:] Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
% [imported header:] information
% [imported header:] ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search
% [imported header:] 2002-08-28
% [imported header:] 2002-08-28
% [imported header:] 2002-08-28
% [imported header:] 2007-09-16
% [imported header:] 2007-09-16
% [imported header:] new=C; break=1; num_top=1
% [imported header:] skin_sisu_manual
% [imported header:] /Gnu|Debian|Ruby|SiSU/
% [imported header:] { 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/% [conditional heading:] :A~ @title @creator
% [conditional heading:] :B~ What is SiSU?
% [conditional heading:] :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".
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
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.
% end import
% |sisu_help.sst|@|^|>>ok
% SiSU 0.58
% [imported header:] SiSU
% [imported header:] Help
% [imported header:] Ralph Amissah
% [imported header:] Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
% [imported header:] information
% [imported header:] ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search
% [imported header:] 2002-08-28
% [imported header:] 2002-08-28
% [imported header:] 2002-08-28
% [imported header:] 2007-08-30
% [imported header:] 2007-08-30
% [imported header:] new=C; break=1; num_top=1
% [imported header:] skin_sisu_manual
% [imported header:] /Gnu|Debian|Ruby|SiSU/
% [imported header:] { 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/% [conditional heading:] :A~ @title @creator
% [conditional heading:] :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
http://polyglotman.sourceforge.net/rman.html
With regard to SiSU man pages the formatting generated for markup syntax is not quite right, for that you might prefer the links under:
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
% end import
% :B~? SiSU Commands
% |sisu_commands.sst|@|^|>>ok
% SiSU 0.58
% [imported header:] SiSU
% [imported header:] Commands
% [imported header:] Ralph Amissah
% [imported header:] Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
% [imported header:] information
% [imported header:] ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search
% [imported header:] 2002-08-28
% [imported header:] 2002-08-28
% [imported header:] 2002-08-28
% [imported header:] 2007-09-16
% [imported header:] 2007-09-16
% [imported header:] new=C; break=1; num_top=1
% [imported header:] skin_sisu_manual
% [imported header:] /Gnu|Debian|Ruby|SiSU/
% [imported header:] { 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:
% [conditional heading:] :A~ @title @creator
% [conditional heading:] :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]
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]
produces xhtml/XML output for browser viewing (sax parsing).
!_ -C [--init-site]
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
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]
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]
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]
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]
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]
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]
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]
produces texinfo and info file, (view with pinfo).
!_ -L
prints license information.
!_ -M [filename/wildcard/url]
maintenance mode files created for processing preserved and their locations indicated. (also see -V)
!_ -m [filename/wildcard/url]
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]
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]
skip meta-markup (building of "metaverse"), this skips the equivalent of -m which is otherwise assumed by most processing flags.
!_ -o [filename/wildcard/url]
output basic document in opendocument file format (opendocument.odt).
!_ -p [filename/wildcard]
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]
quiet less output to screen.
!_ -R [filename/wildcard]
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]
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
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]
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]
copies sisu markup file to output directory.
!_ -t [filename/wildcard (*.termsheet.rb)]
standard form document builder, preprocessing feature
!_ -U [filename/wildcard]
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]
provides url mapping of output files for the flags requested for processing, also see -U
!_ -V
on its own, provides SiSU version and environment information (sisu --help env)
!_ -V [filename/wildcard]
even more verbose than the -v flag. (also see -M)
!_ -v
on its own, provides SiSU version information
!_ -v [filename/wildcard]
provides verbose output of what is being built, where it is being built (and error messages if any), as with -u flag provides a url mapping of files created for each of the processing flag requests. See also -V
!_ -W
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]
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]
produces XML output with deep document structure, in the nature of dom.
!_ -x [filename/wildcard]
produces XML output shallow structure (sax parsing).
!_ -Y [filename/wildcard]
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]
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]
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]
produces php (zend) [this feature is disabled for the time being]
1~command_modifiers command line modifiers
!_ --no-ocn
[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
strips output text of editor endnotes~[* square brackets ]~ denoted by asterisk or dagger/plus sign
!_ --no-asterisk
strips output text of editor endnotes~[* square brackets ]~ denoted by asterisk sign
!_ --no-dagger
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
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
[filename/wildcard] imports data specified to postgresql db (rb.dbi) [ -dv --import sqlite equivalent]
!_ -Dv --update
[filename/wildcard] updates/imports specified data to postgresql db (rb.dbi) [ -dv --update sqlite equivalent]
!_ -D --remove
[filename/wildcard] removes specified data to postgresql db (rb.dbi) [ -d --remove sqlite equivalent]
!_ -D --dropall
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]
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]
Default shorthand mappings (note that the defaults can be changed/configured in the sisurc.yml file):
!_ -0
-mNhwpAobxXyYv [this is the default action run when no options are give, i.e. on 'sisu [filename]']
!_ -1
-mNHwpy
!_ -2
-mNHwpaoy
!_ -3
-mNhwpAobxXyY
!_ -4
-mNhwpAobxXDyY --import
!_ -5
-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.
% end import
% :B~? SiSU Markup
% |sisu_markup.sst|@|^|>>ok
% SiSU 0.58
% [imported header:] SiSU
% [imported header:] Markup
% [imported header:] Ralph Amissah
% [imported header:] Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
% [imported header:] information
% [imported header:] ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search
% [imported header:] 2002-08-28
% [imported header:] 2002-08-28
% [imported header:] 2002-08-28
% [imported header:] 2007-09-16
% [imported header:] 2007-09-16
% [imported header:] new=C; break=1; num_top=1
% [imported header:] skin_sisu_manual
% [imported header:] /Gnu|Debian|Ruby|SiSU/
% [imported header:] { 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:
% [conditional heading:] :A~ @title @creator
% [conditional heading:] :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
@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;
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
[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.
num_top=4 [auto-number document, starting at level 4. the default is to provide 3 levels, as in 1 level 4, 1.1 level 5, 1.1.1 level 6, markup to be merged within level]
num_extract [take numbering of headings provided (manually in marked up source document), and use for numbering of segments. Available where a clear numbering structure is provided within document, without the repetition of a number in a header.]
[In 0.38 notation, you would map to the equivalent levels, the examples provided would map to the following new=A,B,C; break=1; num_top=1 [or newpage=A,B,C; breakpage=1; num_top=1] see headings]
!_ @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]
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/;
\{ FSF }http://www.fsf.org
!_ @promo:
sisu, ruby, search_libre_docs, open_society
[places content in right pane in html, makes use of list.yml and promo.yml, commented out sample in document sample: free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst]
% 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
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
require
<<
}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.
% <<
%
%
% .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
% end import
% |sisu_filetypes.sst|@|^|>>ok
% SiSU 0.58
% [imported header:] SiSU
% [imported header:] Filetypes
% [imported header:] Ralph Amissah
% [imported header:] Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
% [imported header:] information
% [imported header:] ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search
% [imported header:] 2002-08-28
% [imported header:] 2002-08-28
% [imported header:] 2002-08-28
% [imported header:] 2007-09-16
% [imported header:] 2007-09-16
% [imported header:] new=C; break=1; num_top=1
% [imported header:] skin_sisu_manual
% [imported header:] /Gnu|Debian|Ruby|SiSU/
% [imported header:] { 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:
% [conditional heading:] :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"
% end import
% :B~? SiSU Configuration and Skins
% |sisu_config.ssi|@|^|>>ok
% SiSU insert 0.58
% [imported header:] SiSU
% [imported header:] Search
% [imported header:] Ralph Amissah
% [imported header:] Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
% [imported header:] information
% [imported header:] ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search
% [imported header:] 2002-08-28
% [imported header:] 2002-08-28
% [imported header:] 2002-08-28
% [imported header:] 2007-09-16
% [imported header:] 2007-09-16
% [imported header:] new=C; break=1; num_top=1
% [imported header:] skin_sisu_manual
% [imported header:] /Gnu|Debian|Ruby|SiSU/
% [imported header:] { 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/% [conditional heading:] :A~ Configuration
% [conditional heading:] :B~ Configuration
% [conditional heading:] :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
% end import
% |sisu_skin.sst|@|^|>>ok
% SiSU insert 0.58
% [imported header:] SiSU
% [imported header:] Skins
% [imported header:] Ralph Amissah
% [imported header:] Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
% [imported header:] information
% [imported header:] ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search
% [imported header:] 2002-11-12
% [imported header:] 2002-11-12
% [imported header:] 2002-11-12
% [imported header:] 2007-09-16
% [imported header:] 2007-09-16
% [imported header:] new=C; break=1; num_top=1
% [imported header:] skin_sisu_manual
% [imported header:] /Gnu|Debian|Ruby|SiSU/
% [imported header:] { 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$
% [conditional heading:] :A~ @title @creator
% [conditional heading:] :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)
% end import
% |sisu_css.ssi|@|^|>>ok
% SiSU insert 0.58
% [imported header:] SiSU
% [imported header:] CSS - Cascading Style Sheets
% [imported header:] Ralph Amissah
% [imported header:] Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
% [imported header:] information
% [imported header:] ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search
% [imported header:] 2007-08-28
% [imported header:] 2007-08-28
% [imported header:] 2007-08-28
% [imported header:] 2007-09-16
% [imported header:] 2007-09-16
% [imported header:] new=C; break=1; num_top=1
% [imported header:] skin_sisu_manual
% [imported header:] /Gnu|Debian|Ruby|SiSU/
% [imported header:] { 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$
% [conditional heading:] :A~ 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. }~
% end import
% |sisu_content_directories.ssi|@|^|>>ok
% SiSU insert 0.58
% [imported header:] SiSU
% [imported header:] Content Directories, Organising Content
% [imported header:] Ralph Amissah
% [imported header:] Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
% [imported header:] information
% [imported header:] ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search
% [imported header:] 2002-08-28
% [imported header:] 2002-08-28
% [imported header:] 2007-08-28
% [imported header:] 2007-09-16
% [imported header:] 2007-09-16
% [imported header:] new=C; break=1; num_top=1
% [imported header:] skin_sisu_manual
% [imported header:] /Gnu|Debian|Ruby|SiSU/
% [imported header:] { 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$
% [conditional heading:] :A~ Organisation of Content
% [conditional heading:] :B~ 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"
% end import
% |sisu_homepages.ssi|@|^|>>ok
% SiSU insert 0.58
% [imported header:] SiSU
% [imported header:] Homepages
% [imported header:] Ralph Amissah
% [imported header:] Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
% [imported header:] information
% [imported header:] ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search
% [imported header:] 2007-08-28
% [imported header:] 2007-08-28
% [imported header:] 2007-08-28
% [imported header:] 2007-09-16
% [imported header:] 2007-09-16
% [imported header:] new=C; break=1; num_top=1
% [imported header:] skin_sisu_manual
% [imported header:] /Gnu|Debian|Ruby|SiSU/
% [imported header:] { 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$
% [conditional heading:] :A~ @title @creator
% [conditional heading:] :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
<
this is my new homepage.