aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/sisu/v2/html/sisu.1.html
diff options
context:
space:
mode:
Diffstat (limited to 'data/doc/sisu/v2/html/sisu.1.html')
-rw-r--r--data/doc/sisu/v2/html/sisu.1.html811
1 files changed, 403 insertions, 408 deletions
diff --git a/data/doc/sisu/v2/html/sisu.1.html b/data/doc/sisu/v2/html/sisu.1.html
index d0af5d5b..9a56e017 100644
--- a/data/doc/sisu/v2/html/sisu.1.html
+++ b/data/doc/sisu/v2/html/sisu.1.html
@@ -13,137 +13,134 @@ sisu - documents: markup, structuring, publishing in multiple standard
formats, and search
<h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
sisu [-abcDdFehIiMmNnopqRrSsTtUuVvwXxYyZz0-9]
-[filename/wildcard ] sisu [-Ddcv] [instruction] sisu [-CcFLSVvW] sisu
---v2 [operations] sisu --v1 [operations] SISU - MANUAL, RALPH AMISSAH
-<p> WHAT
-IS SISU?
+[filename/wildcard]
+<p> sisu [-Ddcv] [instruction] [filename/wildcard]
+<p> sisu
+[-CcFLSVvW]
+<p> sisu --v2 [operations]
+<p> sisu --v1 [operations] SISU - MANUAL,
+RALPH AMISSAH
+<p> WHAT IS SISU?
<p> 1. INTRODUCTION - WHAT IS SISU?
-<p> <b>SiSU</b> is a framework for document
-structuring, publishing (in multiple open standard formats) and search,
-comprising of: (a) a lightweight document structure and presentation markup
-syntax; and (b) an accompanying engine for generating standard document
-format outputs from documents prepared in sisu markup syntax, which is
-able to produce multiple standard outputs (including the population of
-sql databases) that (can) share a common numbering system for the citation
-of text within a document.
-<p> <b>SiSU</b> is developed under an open source, software
-libre license (GPL3). Its use case for development is to cope with medium
-to large document sets with evolving markup related technologies, which
-should be prepared once, and for which you want multiple output formats
-that can be updated and a common mechanism for cross-output-format citation,
-and search.
-<p> <b>SiSU</b> both defines a markup syntax and provides an engine that
-produces open standards format outputs from documents prepared with <b>SiSU</b>
-markup. From a single lightly prepared document sisu custom builds several
-standard output formats which share a common (text object) numbering system
-for citation of content within a document (that also has implications for
-search). The sisu engine works with an abstraction of the document&rsquo;s structure
-and content from which it is possible to generate different forms of representation
-of the document. Significantly <b>SiSU</b> markup is more sparse than html and
-outputs which include html, LaTeX, landscape and portrait pdfs, Open Document
-Format (ODF), all of which can be added to and updated. <b>SiSU</b> is also able
-to populate SQL type databases at an object level, which means that searches
-can be made with that degree of granularity.
-<p> Source document preparation
-and output generation is a two step process: (i) document source is prepared,
+<p> <b>SiSU</b> is
+a framework for document structuring, publishing (in multiple open standard
+formats) and search, comprising of: (a) a lightweight document structure
+and presentation markup syntax; and (b) an accompanying engine for generating
+standard document format outputs from documents prepared in sisu markup
+syntax, which is able to produce multiple standard outputs (including the
+population of sql databases) that (can) share a common numbering system
+for the citation of text within a document.
+<p> <b>SiSU</b> is developed under an
+open source, software libre license (GPL3). Its use case for development
+is work with medium to large document sets and cope with evolving document
+formats/ representation technologies. Documents are prepared once, and generated
+as need be to update the technical presentation or add additional output
+formats. Various output formats (including search related output) share
+a common mechanism for cross-output-format citation.
+<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&rsquo;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, EPUB, LaTeX, landscape and portrait pdfs, Open Document Format (ODF),
+all of which can be added to and updated. <b>SiSU</b> is also able to populate
+SQL type databases at an object level, which means that searches can be
+made with that degree of granularity.
+<p> Source document preparation and
+output generation is a two step process: (i) document source is prepared,
that is, marked up in sisu markup syntax and (ii) the desired output subsequently
generated by running the sisu engine against document source. Output representations
if updated (in the sisu engine) can be generated by re-running the engine
against the prepared source. Using <b>SiSU</b> markup applied to a document, <b>SiSU</b>
custom builds (to take advantage of the strengths of different ways of
representing documents) various standard open output formats including
-plain text, HTML, XHTML, XML, OpenDocument, LaTeX or PDF files, and populate
-an SQL database with objects[^1] (equating generally to paragraph-sized chunks)
-so searches may be performed and matches returned with that degree of granularity
-( e.g. your search criteria is met by these documents and at these locations
-within each document). Document output formats share a common object numbering
-system for locating content. This is particularly suitable for works (finalized
-texts as opposed to works that are frequently changed or updated) for which
-it provides a fixed means of reference of content.
-<p> In preparing a <b>SiSU</b>
-document you optionally provide semantic information related to the document
-in a document header, and in marking up the substantive text provide information
-on the structure of the document, primarily indicating heading levels and
-footnotes. You also provide information on basic text attributes where used.
-The rest is automatic, sisu from this information custom builds[^2] the
-different forms of output requested.
-<p> <b>SiSU</b> works with an abstraction of
-the document based on its structure which is comprised of its structure
-(or frame)[^3] and the objects[^4] it contains, which enables <b>SiSU</b> to represent
-the document in many different ways, and to take advantage of the strengths
-of different ways of presenting documents. The objects are numbered, and
-these numbers can be used to provide a common base for citing material
-within a document across the different output format types. This is significant
-as page numbers are not well suited to the digital age, in web publishing,
-changing a browser&rsquo;s default font or using a different browser means that
-text appears on different pages; and in publishing in different formats,
-html, landscape and portrait pdf etc. again page numbers are of no use to
-cite text in a manner that is relevant against the different output types.
-Dealing with documents at an object level together with object numbering
-also has implications for search.
-<p> One of the challenges of maintaining
-documents is to keep them in a format that would allow users to use them
-without depending on a proprietary software popular at the time. Consider
-the ease of dealing with legacy proprietary formats today and what guarantee
-you have that old proprietary formats will remain (or can be read without
-proprietary software/equipment) in 15 years time, or the way the way in
-which html has evolved over its relatively short span of existence. <b>SiSU</b>
-provides the flexibility of outputing documents in multiple non-proprietary
-open formats including html, pdf[^5] and the ISO standard ODF.[^6] Whilst
-<b>SiSU</b> relies on software, the markup is uncomplicated and minimalistic which
-guarantees that future engines can be written to run against it. It is also
-easily converted to other formats, which means documents prepared in <b>SiSU</b>
-can be migrated to other document formats. Further security is provided
-by the fact that the software itself, <b>SiSU</b> is available under GPL3 a licence
-that guarantees that the source code will always be open, and free as in
-libre which means that that code base can be used, updated and further
-developed as required under the terms of its license. Another challenge
-is to keep up with a moving target. <b>SiSU</b> permits new forms of output to
-be added as they become important, (Open Document Format text was added
-in 2006 when it became an ISO standard for office applications and the
-archival of documents), and existing output to be updated (html has evolved
-and the related module has been updated repeatedly over the years, presumably
-when the World Wide Web Consortium (w3c) finalises html 5 which is currently
-under development, the html module will again be updated allowing all existing
-documents to be regenerated as html 5).
-<p> The document formats are written
-to the file-system and available for indexing by independent indexing tools,
-whether off the web like Google and Yahoo or on the site like Lucene and
-Hyperestraier.
-<p> <b>SiSU</b> also provides other features such as concordance files
-and document content certificates, and the working against an abstraction
-of document structure has further possibilities for the research and development
-of other document representations, the availability of objects is useful
-for example for topic maps and thesauri, 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> &lt;<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
+plain text, HTML, XHTML, XML, EPUB, OpenDocument, LaTeX or PDF files, and
+populate an SQL database with objects[^1] (equating generally to paragraph-sized
+chunks) so searches may be performed and matches returned with that degree
+of granularity ( e.g. your search criteria is met by these documents and
+at these locations within each document). Document output formats share
+a common object numbering system for locating content. This is particularly
+suitable for "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> In preparing a <b>SiSU</b> document you optionally provide
+semantic information related to the document in a document header, and
+in marking up the substantive text provide information on the structure
+of the document, primarily indicating heading levels and footnotes. You
+also provide information on basic text attributes where used. The rest is
+automatic, sisu from this information custom builds[^2] the different forms
+of output requested.
+<p> <b>SiSU</b> works with an abstraction of the document based
+on its structure which is comprised of its headings[^3] and objects[^4],
+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
+basis for citing material within a document across the different output
+format types. This is significant as page numbers are not well suited to
+the digital age, in web publishing, changing a browser&rsquo;s default font or
+using a different browser can mean that text will appear on a different
+page; and publishing in different formats, html, landscape and portrait
+pdf etc. again page numbers are not useful to cite text. Dealing with documents
+at an object level together with object numbering also has implications
+for search that <b>SiSU</b> is able to take advantage of.
+<p> One of the challenges
+of maintaining documents is to keep them in a format that allows use of
+them independently of proprietary platforms. Consider issues related to
+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 producing documents in multiple non-proprietary open formats
+including html, pdf[^5] ODF,[^6] and EPUB.[^7] Whilst <b>SiSU</b> relies on software,
+the markup is uncomplicated and minimalistic which guarantees that future
+engines can be written to run against it. It is also easily converted to
+other formats, which means documents prepared in <b>SiSU</b> can be migrated to
+other document formats. Further security is provided by the fact that the
+software itself, <b>SiSU</b> is available under GPL3 a licence that guarantees
+that the source code will always be open, and free as in libre, which means
+that that code base can be used, updated and further developed as required
+under the terms of its license. Another challenge is to keep up with a moving
+target. <b>SiSU</b> permits new forms of output to be added as they become important,
+(Open Document Format text was added in 2006 when it became an ISO standard
+for office applications and the archival of documents), EPUB was introduced
+in 2009; and allows the technical representations 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 thesauri,
+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>
+&lt;<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
&gt;
-<p> 2.
-COMMANDS SUMMARY
-<p> 2.1 SYNOPSIS
-<p> <b>SiSU</b> - Structured information, Serialized
-Units - a document publishing system
-<p> sisu [ &nbsp;-abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0-9
-&nbsp;] [ &nbsp;filename/ &nbsp;wildcard &nbsp;]
-<p> sisu [ &nbsp;-Ddcv &nbsp;] [ &nbsp;instruction &nbsp;]
-<p> sisu [ &nbsp;-CcFLSVvW
-&nbsp;]
-<p> Note: commands should be issued from within the directory that contains
-the marked up files, cd to markup directory.
-<p> 2.2 DESCRIPTION
+<p> 2. COMMANDS SUMMARY
+<p> 2.1 DESCRIPTION
<p> <b>SiSU</b> <b>SiSU</b>
is a document publishing system, that from a simple single marked-up document,
-produces multiple of output formats including: plaintext, html, LaTeX,
-pdf, xhtml, XML, info, and SQL (PostgreSQL and SQLite), which share numbered
-text objects ( structure information. For more see: &lt;<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
+produces multiple of output formats including: plaintext, html, xhtml,
+XML, epub, odt (odf text), LaTeX, pdf, info, and SQL (PostgreSQL and SQLite),
+which share numbered text objects ("object citation numbering") and the
+same document structure information. For more see: &lt;<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
&gt;
-<p> 2.3 DOCUMENT PROCESSING COMMAND FLAGS
+<p> 2.2 DOCUMENT PROCESSING COMMAND FLAGS
<p>
<dl>
@@ -283,19 +280,19 @@ file format (opendocument.odt).
<dd>produces LaTeX pdf
(portrait.pdf &amp; 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: &rsquo;A4&rsquo;, U.S. &rsquo;letter&rsquo; and &rsquo;legal&rsquo; and book sizes
-&rsquo;A5&rsquo; and &rsquo;B5&rsquo; (system defaults to A4).
+--papersize-a4 preset sizes include: &rsquo;A4&rsquo;, U.S. &rsquo;letter&rsquo; and
<p> </dd>
-<dt><b>-q [filename/wildcard]</b> </dt>
-<dd>quiet less output
-to screen.
+<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
+<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 "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
@@ -305,16 +302,15 @@ with other flags, it is not). Also see -r
<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
+your "keys" and ssh agent in place. Also see -R
<p> </dd>
<dt><b>-S</b> </dt>
-<dd>produces a sisupod a zipped sisu directory of markup files including
-sisu markup source files and the directories local configuration file,
-images and skins. Note: this only includes the configuration files or skins
-contained in ./_sisu not those in ~/.sisu -S [filename/wildcard] option. Note:
-(this<br>
+<dd>produces a sisupod a zipped
+sisu directory of markup files including sisu markup source files and the
+directories local configuration file, images and skins. Note: this only
+includes the configuration files or skins contained in ./_sisu not those
+in ~/.sisu -S [filename/wildcard] option. Note: (this<br>
option is tested only with zsh).
<p> </dd>
@@ -392,7 +388,7 @@ created for each of the processing flag requests. See also -V
webrick webserver points at sisu output directories, the default port is
set to 8081 and can be changed in the resource configuration files. [tip:
&nbsp;the &nbsp;webrick &nbsp;server &nbsp;requires &nbsp;link &nbsp;suffixes, &nbsp;so &nbsp;html &nbsp;output &nbsp;should &nbsp;be &nbsp;created
-&nbsp;using &nbsp;the &nbsp;-h &nbsp;option &nbsp;rather &nbsp;than and search -H; &nbsp;also, &nbsp;note &nbsp;-F &nbsp;webrick &nbsp;].
+&nbsp;using &nbsp;the &nbsp;-h &nbsp;option &nbsp;rather &nbsp;than and search -H &nbsp;; &nbsp;also, &nbsp;note &nbsp;-F &nbsp;webrick &nbsp;].
<p> </dd>
<dt><b>-w
@@ -515,42 +511,43 @@ data to postgresql db (rb.dbi) [ &nbsp;-d &nbsp;--remove &nbsp;sqlite &nbsp;equi
<dt><b>-D --dropall</b>
</dt>
-<dd>kills data --dropall &nbsp;sqlite &nbsp;equivalent]
-<p> The v in e.g. -Dv is for verbose output.
-
+<dd>kills data" and drops (postgresql or sqlite) db, tables &amp; indexes [ &nbsp;-d --dropall
+&nbsp;sqlite &nbsp;equivalent]
+<p> The v in e.g. -Dv is for verbose output.
<p> </dd>
</dl>
-5. SHORTCUTS, SHORTHAND FOR MULTIPLE FLAGS
+5. SHORTCUTS,
+SHORTHAND FOR MULTIPLE FLAGS
<p>
<dl>
-<dt><b>--update [filename/wildcard]</b>
-</dt>
-<dd>Checks existing file output and runs the flags required to update this
-output. This means that if only html and pdf output was requested on previous
-runs, only the -hp files will be applied, and only these will be generated
-this time, together with the summary. This can be very convenient, if you
-offer different outputs of different files, and just want to do the same
-again.
+<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 &nbsp;or &nbsp;wildcard]</b> </dt>
-<dd>Default shorthand mappings (note that
-the defaults can be changed/configured in the sisurc.yml file):
+<dt><b>-0 to -5 [filename
+&nbsp;or &nbsp;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 &nbsp;is &nbsp;the &nbsp;default &nbsp;action &nbsp;run &nbsp;when &nbsp;no &nbsp;i.e. &nbsp;on &nbsp;&rsquo;sisu &nbsp;[filename]&rsquo;]
+<dd>-mNhwpAobxXyYv [this &nbsp;is &nbsp;the
+&nbsp;default &nbsp;action &nbsp;run &nbsp;when &nbsp;no &nbsp;i.e. &nbsp;on &nbsp;&rsquo;sisu &nbsp;[filename]&rsquo;]
<p> </dd>
<dt><b>-1</b> </dt>
-<dd>-mhewpy
-
+<dd>-mhewpy
<p> </dd>
<dt><b>-2</b> </dt>
-<dd>-mhewpaoy
+<dd>-mhewpaoy
+
<p> </dd>
<dt><b>-3</b> </dt>
@@ -562,27 +559,26 @@ the defaults can be changed/configured in the sisurc.yml file):
<p> </dd>
<dt><b>-5</b> </dt>
-<dd>-mhewpAobxXDyY --update
-
-<p> add -v for verbose mode and -c for color, e.g. sisu -2vc [filename &nbsp;or
-<p> consider
+<dd>-mhewpAobxXDyY --update
+<p> add -v
+for verbose mode and -c for color, e.g. sisu -2vc [filename &nbsp;or
+<p> consider -u
-<p>-
-<p>u for appended url info or -v for verbose output
+<p>for appended url info or -v for verbose output
<p> </dd>
</dl>
5.1 COMMAND LINE WITH FLAGS
- BATCH PROCESSING
<p> In the data directory run sisu -mh filename or wildcard
-eg. cisg.sst documents.
-<p> Running sisu (alone without any flags, filenames
-or wildcards) brings up the interactive help, as does any sisu command
-that is not recognised. Enter to escape.
+eg. "sisu -h cisg.sst" or "sisu -h *.{sst,ssm}" to produce html version of all
+documents.
+<p> Running sisu (alone without any flags, filenames or wildcards)
+brings up the interactive help, as does any sisu command that is not recognised.
+Enter to escape.
<p> 6. HELP
<p> 6.1 SISU MANUAL
-<p> The most
-up to date information on sisu should be contained in the sisu_manual,
-available at:
+<p> The most up to date information
+on sisu should be contained in the sisu_manual, available at:
<p> &lt;<a href='http://sisudoc.org/sisu/sisu_manual/'>http://sisudoc.org/sisu/sisu_manual/</a>
&gt;<br>
@@ -620,10 +616,10 @@ within the <b>SiSU</b> tarball at:
<p> An online version of the sisu man page is available here:
<p> * various
sisu man pages &lt;<a href='http://www.jus.uio.no/sisu/man/'>http://www.jus.uio.no/sisu/man/</a>
-&gt; [^7]
+&gt; [^8]
<p> * sisu.1 &lt;<a href='http://www.jus.uio.no/sisu/man/sisu.1.html'>http://www.jus.uio.no/sisu/man/sisu.1.html</a>
&gt;
-[^8]
+[^9]
<p> 6.3 SISU BUILT-IN INTERACTIVE HELP
<p> This is particularly useful for
getting the current sisu setup/environment information:
@@ -661,10 +657,10 @@ see:
<p> &lt;<a href='http://sisudoc.org/sisu/sisu_help_sources/index.html'>http://sisudoc.org/sisu/sisu_help_sources/index.html</a>
&gt;<br>
-<p> 7. INTRODUCTION TO SISU MARKUP[^9]
+<p> 7. INTRODUCTION TO SISU MARKUP[^10]
<p> 7.1 SUMMARY
<p> <b>SiSU</b> source documents
-are plaintext (UTF-8)[^10] files
+are plaintext (UTF-8)[^11] files
<p> All paragraphs are separated by an empty
line.
<p> Markup is comprised of:
@@ -741,8 +737,8 @@ followed by a space and the comment:
<pre> % this would be a comment
</pre>
<p> 8.1 SAMPLE HEADER
-<p> This current document has a header similar to this
-one (without the comments):
+<p> This current document is loaded by a master document
+that has a header similar to this one:
<p>
<p> <br>
<pre> % SiSU master 2.0
@@ -784,7 +780,7 @@ one (without the comments):
{ 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/
-</pre></pre>
+</pre>
<p> 8.2 AVAILABLE HEADERS
<p> Header tags appear at the beginning of a document
and provide meta information on the document (such as the Dublin Core),
@@ -804,21 +800,18 @@ and can be useful to know.
<p>
<p> <br>
<pre> % SiSU 2.0 &nbsp;[declared &nbsp;file-type &nbsp;identifier &nbsp;with &nbsp;markup &nbsp;version]
-</pre></pre>
-<p>
+</pre>
<p> <br>
<pre> @title: &nbsp;[title &nbsp;text] &nbsp;[this &nbsp;header &nbsp;is &nbsp;the &nbsp;only &nbsp;one &nbsp;that &nbsp;is &nbsp;mandatory]
:subtitle: &nbsp;[subtitle &nbsp;if &nbsp;any]
:language: English
-</pre></pre>
-<p>
+</pre>
<p> <br>
<pre> @creator: :author: &nbsp;[Lastname, &nbsp;First &nbsp;names]
:illustrator: &nbsp;[Lastname, &nbsp;First &nbsp;names]
:translator: &nbsp;[Lastname, &nbsp;First &nbsp;names]
:prepared_by: &nbsp;[Lastname, &nbsp;First &nbsp;names]
-</pre></pre>
-<p>
+</pre>
<p> <br>
<pre> @date: :published: &nbsp;[year &nbsp;or &nbsp;yyyy-mm-dd]
:created: &nbsp;[year &nbsp;or &nbsp;yyyy-mm-dd]
@@ -828,16 +821,14 @@ and can be useful to know.
:valid: &nbsp;[year &nbsp;or &nbsp;yyyy-mm-dd]
:added_to_site: &nbsp;[year &nbsp;or &nbsp;yyyy-mm-dd]
:translated: &nbsp;[year &nbsp;or &nbsp;yyyy-mm-dd]
-</pre></pre>
-<p>
+</pre>
<p> <br>
<pre> @rights: :copyright: Copyright (C) &nbsp;[Year &nbsp;and &nbsp;Holder]
:license: &nbsp;[Use &nbsp;License &nbsp;granted]
:text: &nbsp;[Year &nbsp;and &nbsp;Holder]
:translation: &nbsp;[Name, &nbsp;Year]
:illustrations: &nbsp;[Name, &nbsp;Year]
-</pre></pre>
-<p>
+</pre>
<p> <br>
<pre> @classify:
:topic_register: SiSU:markup sample:book;book:novel:fantasy
@@ -850,13 +841,11 @@ and can be useful to know.
:loc: &nbsp;[Library &nbsp;of &nbsp;Congress &nbsp;classification]
:dewey: &nbsp;[Dewey &nbsp;classification
:pg: &nbsp;[Project &nbsp;Gutenberg &nbsp;text &nbsp;number]
-</pre></pre>
-<p>
+</pre>
<p> <br>
<pre> @links: { SiSU }http://www.jus.uio.no/sisu/
{ FSF }http://www.fsf.org
-</pre></pre>
-<p>
+</pre>
<p> <br>
<pre> @make:
:skin: skin_name
@@ -870,16 +859,14 @@ generated]
:promo: sisu, ruby, sisu_search_libre, open_society
:bold: [regular expression of words/phrases to be made bold]
:italics: &nbsp;[regular &nbsp;expression &nbsp;of &nbsp;words/phrases &nbsp;to &nbsp;italicise]
-</pre></pre>
-<p>
+</pre>
<p> <br>
<pre> @original: :language: &nbsp;[language]
-</pre></pre>
-<p>
+</pre>
<p> <br>
<pre> @notes: :comment:
:prefix: &nbsp;[prefix &nbsp;is &nbsp;placed &nbsp;just &nbsp;after &nbsp;table &nbsp;of &nbsp;contents]
-</pre></pre>
+</pre>
<p> 9. MARKUP OF SUBSTANTIVE TEXT
<p> 9.1 HEADING LEVELS
<p> Heading levels are
@@ -991,22 +978,22 @@ html
<p> 9.4 FOOTNOTES / ENDNOTES
<p> Footnotes and endnotes not distinguished in
markup. They are automatically numbered. Depending on the output file format
-(html, odf, pdf etc.), the document output selected will have either footnotes
-or endnotes.
+(html, EPUB, odf, pdf etc.), the document output selected will have either
+footnotes or endnotes.
<p> <b>markup example:</b>
<p>
<p> <br>
<pre> ~{ a footnote or endnote }~
</pre>
<p> <b>resulting output:</b>
-<p> [^11]
+<p> [^12]
<p> <b>markup example:</b>
<p>
<p> <br>
<pre> normal text~{ self contained endnote marker &amp; endnote in one }~ continues
</pre>
<p> <b>resulting output:</b>
-<p> normal text[^12] continues
+<p> normal text[^13] continues
<p> <b>markup example:</b>
<p>
<p> <br>
@@ -1104,11 +1091,11 @@ block is used there is neither decoration nor hyperlinking, code blocks
<pre> about {~^ SiSU }http://url.org markup
</pre>
<p> <b>resulting output:</b>
-<p> about SiSU &lt;<a href='http://www.jus.uio.no/sisu/'>http://www.jus.uio.no/sisu/</a>
-&gt; [^13] markup
-<p>
+<p> aboutSiSU &lt;<a href='http://www.jus.uio.no/sisu/'>http://www.jus.uio.no/sisu/</a>
+&gt; [^14] markup
+<p> 9.5.3
-<p>9.5.3 LINKING IMAGES
+<p>LINKING IMAGES
<p> <b>markup example:</b>
<p>
<p> <br>
@@ -1122,7 +1109,7 @@ block is used there is neither decoration nor hyperlinking, code blocks
<p> [ tux.png ]
<p> tux.png 64x80
<p> [ &nbsp;ruby_logo &nbsp;(png &nbsp;missing)
-&nbsp;] [^14]
+&nbsp;] [^15]
<p> GnuDebianLinuxRubyBetterWay.png 100x101 and Ruby
<p> <b>linked url footnote
@@ -1165,7 +1152,7 @@ auto-heading numbering, without further intervention.
<p> a second form may be easier to work with in cases where there is not
<p>much information in each column
-<p> <b>markup example:</b> [^15]
+<p> <b>markup example:</b> [^16]
<p>
<p> <br>
<pre> !_ Table 3.1: Contributors to Wikipedia, January 2001 - June 2005
@@ -1708,7 +1695,7 @@ and processing will occur normally if a .sst file is renamed .ssm without
requiring any other documents; the .ssm marker flags that the document may
contain other documents.
<p> Note: a secondary file of the composite document
-is built prior to processing with the same prefix and the suffix ._sst [^16]
+is built prior to processing with the same prefix and the suffix ._sst [^17]
<p> &lt;<a href='http://www.jus.uio.no/sisu/sisu_markup'>http://www.jus.uio.no/sisu/sisu_markup</a>
&gt;
@@ -1895,90 +1882,90 @@ and symbolic links as needed from the site, or dir directories as required.
<p> With <b>SiSU</b> installed sample skins may be found in:
<p> /etc/sisu/skin/doc
and<br>
- /usr/share/doc/sisu/v1/sisu_markup_samples/dfsg/_sisu/skin/doc<br>
+ /usr/share/doc/sisu/v2/sisu_markup_samples/samples/_sisu/skin/doc<br>
<p> (or equivalent directory) and if sisu-markup-samples is installed also
under:
-<p> /usr/share/doc/sisu/v1/sisu_markup_samples/non-free/_sisu/skin/doc<br>
+<p> /usr/share/doc/sisu-markup-samples/v2/samples/_sisu/skin/doc<br>
<p> Samples of list.yml and promo.yml (which are used to create the right
column list) may be found in:
-<p> /usr/share/doc/sisu/v1/sisu_markup_samples/dfsg/_sisu/skin/yml
+<p> /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml
(or equivalent<br>
directory)<br>
<p> 16. CSS - CASCADING STYLE SHEETS (FOR HTML, XHTML AND XML)
<p> CSS files
to modify the appearance of <b>SiSU</b> html, XHTML or XML may be placed in the
-configuration directory: ./_sisu/css; ~/.sisu/css or; /etc/sisu/css and
-these will be copied to the<br>
- output directories with the command sisu -CC.
-<p> The basic CSS file for html
-output is html.css, placing a file of that name in directory _sisu/css or
-equivalent will result in the default file of that name being overwritten.
+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: sax.css
+<p> XML
+SAX: sax.css
<p> XHTML: xhtml.css
-<p>
- The default homepage may use homepage.css or html.css
-<p> Under consideration
-is to permit the placement of a CSS file with a different name in directory
-_sisu/css directory or equivalent, and change the default CSS file that
-is looked for in a skin.[^17]
-<p> 17. ORGANISING CONTENT
-<p> 17.1 DIRECTORY STRUCTURE
-
-<p>AND MAPPING
-<p> The output directory root can be set in the sisurc.yml file.
-Under the root, subdirectories are made for each directory in which a document
-set resides. If you have a directory named poems or conventions, that directory
-will be created under the output directory root and the output for all
-documents contained in the directory of a particular name will be generated
-to subdirectories beneath that directory (poem or conventions). A document
-will be placed in a subdirectory of the same name as the document with
-the filetype identifier stripped (.sst .ssm)
-<p> The last part of a directory
-path, representing the sub-directory in which a document set resides, is
-the directory name that will be used for the output directory. This has
-implications for the organisation of document collections as it could make
-sense to place documents of a particular subject, or type within a directory
-identifying them. This grouping as suggested could be by subject (sales_law,
-english_literature); or just as conveniently by some other classification
-(X University). The mapping means it is also possible to place in the same
-output directory documents that are for organisational purposes kept separately,
-for example documents on a given subject of two different institutions
-may be kept in two different directories of the same name, under a directory
-named after each institution, and these would be output to the same output
-directory. Skins could be associated with each institution on a directory
-basis and resulting documents will take on the appropriate different appearance.
-
+<p> The default homepage may use homepage.css
+
+<p>or html.css
+<p> Under consideration is to permit the placement of a CSS file
+with a different name in directory _sisu/css directory or equivalent, and
+change the default CSS file that is looked for in a skin.[^18]
+<p> 17. ORGANISING
+CONTENT
+<p> 17.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>
<p> 18. HOMEPAGES
-<p> <b>SiSU</b> is about the ability to auto-generate documents. Home
-pages are regarded as custom built items, and are not created by <b>SiSU</b>
-<b>SiSU</b> has a default home page, which will not be appropriate for use with
-other sites, and the means to provide your own home page instead in one
-of two ways as part of a site&rsquo;s configuration, these being:
-<p> 1. through
-placing your home page and other custom built documents in the subdirectory
-_sisu/home/ (this probably being the easier and more convenient option)
-
-<p> 2. through providing what you want as the home page in a skin,
-<p> Document
-sets are contained in directories, usually organised by site or subject.
-Each directory can/should have its own homepage. See the section on directory
-structure and organisation of content.
-<p> 18.1 HOME PAGE AND OTHER CUSTOM BUILT
-
-<p>PAGES IN A SUB-DIRECTORY
-<p> Custom built pages, including the home page index.html
-may be placed within the configuration directory _sisu/home/ in any of
-the locations that is searched for the configuration directory, namely
-./_sisu; ~/_sisu; /etc/sisu From there they are copied to the root of the
-output directory with the command:
-<p> sisu -CC<br>
+<p> <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&rsquo;s configuration,
+these being:
+<p> 1. through placing your home page and other custom built
+documents in the subdirectory _sisu/home/ (this probably being the easier
+and more convenient option)
+<p> 2. through providing what you want as the
+home page in a skin,
+<p> Document sets are contained in directories, usually
+organised by site or subject. Each directory can/should have its own homepage.
+See the section on directory structure and organisation of content.
+<p> 18.1
+
+<p>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> 18.2 HOME PAGE WITHIN A SKIN
<p> Skins are described in a separate section,
@@ -2040,8 +2027,8 @@ or in various output formats.
<p> 21. SQL
<p> 21.1 POPULATING SQL TYPE DATABASES
-<p> <b>SiSU</b> feeds sisu markupd documents into sql type databases PostgreSQL[^18]
-and/or SQLite[^19] database together with information related to document
+<p> <b>SiSU</b> feeds sisu markupd documents into sql type databases PostgreSQL[^19]
+and/or SQLite[^20] database together with information related to document
structure.
<p> This is one of the more interesting output forms, as all the
structural data of the documents are retained (though can be ignored by
@@ -2051,7 +2038,8 @@ are (currently) streamed to four tables:
(and other) headers, including, title, author,<br>
subject, (the Dublin Core...);<br>
-<p> * another the substantive texts by individual<br>
+<p> * another the substantive texts by individual "paragraph" (or object)
+-<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>
@@ -2256,20 +2244,20 @@ DATABASE AND SISU FEATURES, INCLUDING OBJECT CITATION NUMBERING (BACKEND
CURRENTLY POSTGRESQL)
<p> Sample search frontend &lt;<a href='http://search.sisudoc.org'>http://search.sisudoc.org</a>
&gt;
-[^20] A small database and sample query front-end (search from) that makes
-use of the citation system, <i>object</i> citation numbering to demonstrates functionality.[^21]
+[^21] 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.[^22]
<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
+html, XML, EPUB, LaTeX, PDF and indeed the SQL database. You can then refer
+to one of the other outputs or in the SQL database expand the text within
the matched objects (paragraphs) in the documents matched.
<p> Note you may
set results either for documents matched and object number locations within
each matched document meeting the search criteria; or display the names
of the documents matched along with the objects (paragraphs) that meet
-the search criteria.[^22]
+the search criteria.[^23]
<p>
<dl>
@@ -2621,11 +2609,11 @@ 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
+<b>Ruby</b> , and <b>SiSU</b> will be able to generate html, EPUB, various XMLs, including
ODF (and will also produce LaTeX). Dependencies required for further actions,
though it relies on the installation of additional dependencies which the
source tarball does not take care of, for things like using a database
-(postgresql or sqlite)[^23] or converting LaTeX to pdf.
+(postgresql or sqlite)[^24] 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
@@ -2686,9 +2674,9 @@ a number of markup sample files may be found either in the directory:
<p> change directory to the appropriate one:
<p> cd /usr/share/doc/sisu/sisu_markup_samples/dfsg
-<p> 30.2.1 BASIC TEXT, PLAINTEXT, HTML, XML, ODF
-<p> Having moved to the directory
-that contains the markup samples (see instructions above if necessary),
+<p> 30.2.1 BASIC TEXT, PLAINTEXT, HTML, XML, ODF, EPUB
+<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
@@ -2735,12 +2723,12 @@ create the database and write to it when you run sisu.
to date as within the package itself:
<p> * sisu.1 &lt;<a href='http://www.jus.uio.no/sisu/man/sisu.1'>http://www.jus.uio.no/sisu/man/sisu.1</a>
&gt;
-[^24]
+[^25]
<p> * sisu.8 &lt;<a href='http://www.jus.uio.no/sisu/man/sisu.8'>http://www.jus.uio.no/sisu/man/sisu.8</a>
-&gt; [^25]
+&gt; [^26]
<p> * man directory
&lt;<a href='http://www.jus.uio.no/sisu/man'>http://www.jus.uio.no/sisu/man</a>
-&gt; [^26]
+&gt; [^27]
<p> 30.3.2 BUILT IN HELP
<p> sisu --help
<p> sisu
@@ -2765,7 +2753,7 @@ to date as within the package itself:
<p> Additional markup samples are packaged separately in the file:
<p> <b>*</b>
<p>
-On <b>Debian</b> they are available in non-free[^27] to include them it is necessary
+On <b>Debian</b> they are available in non-free[^28] to include them it is necessary
to include non-free in your /etc/apt/source.list or obtain them from the
sisu home site.
<p> 31. EDITOR FILES, SYNTAX HIGHLIGHTING
@@ -2919,16 +2907,19 @@ may also contain processing instructions. <b>SiSU</b> markup is primarily an abs
of document structure and document metadata to permit taking advantage
of the basic strengths of existing alternative practical standard ways
of representing documents [be &nbsp;that &nbsp;paper &nbsp;publication, &nbsp;sql &nbsp;search &nbsp;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>
+epub, xml, odf, latex, pdf, sql)
+<p> * for output produces reasonably elegant
+output of established industry and institutionally accepted open standard
+formats.[3] takes advantage of the different strengths of various standard
+formats for representing documents, amongst the output formats currently
+supported are:
+<p> * html - both as a single scrollable text and a segmented
+document<br>
<p> * xhtml<br>
+<p> * epub<br>
+
<p> * XML - both in sax and dom style xml structures for further development
as<br>
required<br>
@@ -2958,74 +2949,71 @@ 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 &nbsp;indexing &nbsp;also &nbsp;work
-&nbsp;well &nbsp;with &nbsp;search &nbsp;indexing tools &nbsp;like &nbsp;hyperestraier].
-<p> * long term maintainability
-of document collections in a world of changing formats, having a very sparsely
-marked-up source document base. there is a considerable degree of future-proofing,
-output representations are upgradeable (open document text) module in 2006
-and in future html5 output sometime in future, without modification of
-
-<p>existing prepared texts
-<p> * SQL search aside, documents are generated as
-required and static once generated.
-<p> * documents produced are static files,
-and may be batch processed, this needs to be done only once but may be
-repeated for various reasons as desired (updated content, addition of new
-output formats, updated technology document presentations/representations)
-
-<p> * document source (plaintext utf-8) if shared on the net may be used as
-
-<p>input and processed locally to produce the different document outputs
-<p>
- * document source may be bundled together (automatically) with associated
-documents (multiple language versions or master document with inclusions)
-and images and sent as a zip file called a sisupod, if shared on the net
-
-<p>these too may be processed locally to produce the desired document outputs
-
-<p> * generated document outputs may automatically be posted to remote sites.
-
-<p> * for basic document generation, the only software dependency is <b>Ruby</b>
-, and a few standard Unix tools (this covers plaintext, HTML, XML, ODF,
-LaTeX). To use a database you of course need that, and to convert the LaTeX
-generated to pdf, a latex processor like tetex or texlive.
-<p> * as a developers
-
-<p>tool it is flexible and extensible
-<p> Syntax highlighting for <b>SiSU</b> markup
-is available for a number of text editors.
-<p> <b>SiSU</b> is less about document
-layout than about finding a way with little markup to be able to construct
-an abstract representation of a document that makes it possible to produce
-multiple representations of it which may be rather different from each
-other and used for different purposes, whether layout and publishing, or
-
-<p>search of content
-<p> i.e. to be able to take advantage from this minimal preparation
-starting point of some of the strengths of rather different established
-ways of representing documents for different purposes, whether for search
-(relational database, or indexed flat files generated for that purpose
-whether of complete documents, or say of files made up of objects), online
-viewing (e.g. html, xml, pdf), or paper publication (e.g. pdf)...
-<p> the solution
-arrived at is by extracting structural information about the document (about
-headings within the document) and by tracking objects (which are serialized
-and also given hash values) in the manner described. It makes possible representations
-that are quite different from those offered at present. For example objects
-could be saved individually and identified by their hashes, with an index
-of how the objects relate to each other to form a document.
-<p> 34. HELP SOURCES
-
-<p> For a summary of alternative ways to get help on <b>SiSU</b> try one of the
-following:
+or database oriented, (pdf, HTML, EPUB, 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 &nbsp;indexing
+&nbsp;also &nbsp;work &nbsp;well &nbsp;with &nbsp;search &nbsp;indexing tools &nbsp;like &nbsp;hyperestraier].
+<p> <b>*</b>long<b>term</b>maintainability<b>of</b>document<b>collections</b>in<b>a</b>world<b>of</b>changing
+formats, having a very sparsely marked-up source document base. there is
+a considerable degree of future-proofing, output representations are upgradeable
+(open document text) module in 2006, epub in 2009 and in future html5 output
+sometime in future, without modification of existing prepared texts
+<p> *
+SQL search aside, documents are generated as required and static once generated.
+
+<p> * documents produced are static files, and may be batch processed, this
+needs to be done only once but may be repeated for various reasons as desired
+(updated content, addition of new output formats, updated technology document
+presentations/representations)
+<p> * document source (plaintext utf-8) if
+
+<p>shared on the net may be used as input and processed locally to produce
+
+<p>the different document outputs
+<p> * document source may be bundled together
+(automatically) with associated documents (multiple language versions or
+master document with inclusions) and images and sent as a zip file called
+a sisupod, if shared on the net these too may be processed locally to produce
+
+<p>the desired document outputs
+<p> * generated document outputs may automatically
+be posted to remote sites.
+<p> * for basic document generation, the only software
+dependency is <b>Ruby</b> , and a few standard Unix tools (this covers plaintext,
+HTML, EPUB, XML, ODF, LaTeX). To use a database you of course need that,
+and to convert the LaTeX generated to pdf, a latex processor like tetex
+or texlive.
+<p> * as a developers tool it is flexible and extensible
+<p> Syntax
+highlighting for <b>SiSU</b> markup is available for a number of text editors.
+
+<p> <b>SiSU</b> is less about document layout than about finding a way with little
+markup to be able to construct an abstract representation of a document
+that makes it possible to produce multiple representations of it which
+may be rather different from each other and used for different purposes,
+whether layout and publishing, or search of content
+<p> i.e. to be able to
+take advantage from this minimal preparation starting point of some of
+the strengths of rather different established ways of representing documents
+for different purposes, whether for search (relational database, or indexed
+flat files generated for that purpose whether of complete documents, or
+say of files made up of objects), online viewing (e.g. html, xml, pdf), or
+paper publication (e.g. pdf)...
+<p> the solution arrived at is by extracting structural
+information about the document (about headings within the document) and
+by tracking objects (which are serialized and also given hash values) in
+the manner described. It makes possible representations that are quite different
+from those offered at present. For example objects could be saved individually
+and identified by their hashes, with an index of how the objects relate
+to each other to form a document.
+<p> 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>
@@ -3064,8 +3052,8 @@ listed here:
<p> 34.2 SISU GENERATED OUTPUT - LINKS TO HTML
<p> Note <b>SiSU</b> documentation is
prepared in <b>SiSU</b> and output is available in multiple formats including
-amongst others html, pdf, and odf which may be also be accessed via the
-html pages[^28]
+amongst others html, pdf, odf and epub which may be also be accessed via
+the html pages[^28]
<p> 34.2.1 WWW.SISUDOC.ORG
<p> &lt;<a href='http://sisudoc.org/sisu/sisu_manual/index.html'>http://sisudoc.org/sisu/sisu_manual/index.html</a>
&gt;
@@ -3152,15 +3140,15 @@ html pages[^28]
<p> &lt;file:///usr/share/doc/sisu/v2/html/sisu_help.1.html&gt;
<p> &lt;file:///usr/share/doc/sisu/v2/html/sisu_help_sources.1.html&gt;
-<p> /usr/share/doc/sisu/html/v2/sisu.1.html<br>
+<p> /usr/share/doc/sisu/v2/html/sisu.1.html<br>
-<p> /usr/share/doc/sisu/html/v2/sisu_pdf.7.html<br>
+<p> /usr/share/doc/sisu/v2/html/sisu_pdf.7.html<br>
-<p> /usr/share/doc/sisu/html/v2/sisu_postgresql.7.html<br>
+<p> /usr/share/doc/sisu/v2/html/sisu_postgresql.7.html<br>
-<p> /usr/share/doc/sisu/html/v2/sisu_sqlite.7.html<br>
+<p> /usr/share/doc/sisu/v2/html/sisu_sqlite.7.html<br>
-<p> /usr/share/doc/sisu/html/v2/sisu_webrick.1.html<br>
+<p> /usr/share/doc/sisu/v2/html/sisu_webrick.1.html<br>
<p> 34.3.2 WWW.JUS.UIO.NO/SISU
<p> &lt;<a href='http://www.jus.uio.no/sisu/man/sisu.1.html'>http://www.jus.uio.no/sisu/man/sisu.1.html</a>
@@ -3187,29 +3175,33 @@ html pages[^28]
<ol>
<b>.</b><li>objects include: headings, paragraphs, verse, tables, images, but not
footnotes/endnotes which are numbered separately and tied to the object
-from which they are referenced. </li><b>.</b><li>i.e. the html, pdf, odf outputs are each built
-individually and optimised for that form of presentation, rather than for
-example the html being a saved version of the odf, or the pdf being a saved
-version of the html. </li><b>.</b><li>the different heading levels </li><b>.</b><li>units of text, primarily
-paragraphs and headings, also any tables, poems, code-blocks </li><b>.</b><li>Specification
-submitted by Adobe to ISO to become a full open ISO specification &lt;<a href='http://www.linux-watch.com/news/NS7542722606.html'>http://www.linux-watch.com/news/NS7542722606.html</a>
-&gt;
-</li><b>.</b><li>ISO/IEC 26300:2006 </dd>
+from which they are referenced. </li><b>.</b><li>i.e. the html, pdf, epub, 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.
+<p> </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
+&lt;<a href='http://www.linux-watch.com/news/NS7542722606.html'>http://www.linux-watch.com/news/NS7542722606.html</a>
+&gt; </li><b>.</b><li>ISO standard ISO/IEC 26300:2006
+
+<p> </li><b>.</b><li>An open standard format for e-books
+<p> </dd>
<dt><b>*1.</b> </dt>
<dd>square brackets </dd>
<dt><b>*2.</b> </dt>
-<dd>square brackets </dd>
+<dd>square brackets
+</dd>
<dt><b>+1.</b> </dt>
-<dd>square brackets
-</li><b>.</b><li>&lt;<a href='http://www.jus.uio.no/sisu/man/'>http://www.jus.uio.no/sisu/man/</a>
+<dd>square brackets </li><b>.</b><li>&lt;<a href='http://www.jus.uio.no/sisu/man/'>http://www.jus.uio.no/sisu/man/</a>
&gt; </li><b>.</b><li>&lt;<a href='http://www.jus.uio.no/sisu/man/sisu.1.html'>http://www.jus.uio.no/sisu/man/sisu.1.html</a>
-&gt; </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
+&gt;
+</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 &amp; endnote in one </dd>
<dt><b>*.</b> </dt>
@@ -3234,22 +3226,19 @@ notes, numbered asterisk footnote/endnote series </li><b>.</b><li>&lt;<a href='h
is under consideration but ._sst makes clear that this is not a regular
file to be worked on, and thus less likely that people will have processing.
It may be however that when the resulting file is shared .ssc is an appropriate
-suffix to use. </li><b>.</b><li>.B SiSU has worked this way in the past, though this was dropped
-as it was thought the complexity outweighed the flexibility, however, the
-balance was rather fine and this behaviour could be reinstated. </li><b>.</b><li>&lt;<a href='http://www.postgresql.org/'>http://www.postgresql.org/</a>
-&gt;
-&lt;<a href='http://advocacy.postgresql.org/'>http://advocacy.postgresql.org/</a>
+suffix to use. </li><b>.</b><li>&lt;<a href='http://www.postgresql.org/'>http://www.postgresql.org/</a>
+&gt; &lt;<a href='http://advocacy.postgresql.org/'>http://advocacy.postgresql.org/</a>
&gt; &lt;<a href='http://en.wikipedia.org/wiki/Postgresql'>http://en.wikipedia.org/wiki/Postgresql</a>
-&gt; </li><b>.</b><li>&lt;<a href='http://www.hwaci.com/sw/sqlite/'>http://www.hwaci.com/sw/sqlite/</a>
&gt;
-&lt;<a href='http://en.wikipedia.org/wiki/Sqlite'>http://en.wikipedia.org/wiki/Sqlite</a>
+</li><b>.</b><li>&lt;<a href='http://www.hwaci.com/sw/sqlite/'>http://www.hwaci.com/sw/sqlite/</a>
+&gt; &lt;<a href='http://en.wikipedia.org/wiki/Sqlite'>http://en.wikipedia.org/wiki/Sqlite</a>
&gt; </li><b>.</b><li>&lt;<a href='http://search.sisudoc.org'>http://search.sisudoc.org</a>
-&gt; </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
+&gt;
+</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
@@ -3316,7 +3305,7 @@ are authors&rsquo; works that while freely distributable are not freely changeab
<p> </dd>
<dt>Source digest: </dt>
-<dd><i>MD5(sisu.ssm.sst)=</i> 2a794c5f8a7df8d6a216025243d432d6
+<dd><i>MD5(sisu.ssm.sst)=</i> fd741a3ccf160aa55b942d76bd4e3f2a
<p> </dd>
@@ -3332,7 +3321,7 @@ are authors&rsquo; works that while freely distributable are not freely changeab
<dt>Document (dal) last generated:
</dt>
<dd>
-<p><i>Fri</i> Mar 05 20:04:20 -0500 2010
+<p><i>Wed</i> Mar 17 13:34:15 -0400 2010
<p> </dd>
<dt>Other versions of this document: </dt>
@@ -3350,31 +3339,37 @@ are authors&rsquo; works that while freely distributable are not freely changeab
</dt>
<dd></dd>
-<dt>pdf: &lt;<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>
+<dt>epub: &lt;<a href='http://www.jus.uio.no/sisu/epub/sisu.epub'><a href='http://www.jus.uio.no/sisu/epub/sisu.epub'>http://www.jus.uio.no/sisu/epub/sisu.epub</a>
</a>
&gt; </dt>
<dd></dd>
-<dt>pdf: &lt;<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>
+<dt>pdf: &lt;<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>
&gt;
</dt>
+<dd></dd>
+
+<dt>pdf: &lt;<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>
+&gt; </dt>
<dd> </dd>
<dt>at: &lt;<a href='http://www.jus.uio.no/sisu'><a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
</a>
-&gt; </dt>
+&gt;
+</dt>
<dd></dd>
-<dt>* Generated by: SiSU 0.70.2 of 2008w50/2 (2008-12-16)
-</dt>
+<dt>* Generated by: SiSU 2.0.0 of 2010w09/6 (2010-03-06) </dt>
<dd></dd>
-<dt>* Ruby version: ruby 1.8.7 (2008-08-11 patchlevel 72) [i486-linux] </dt>
+<dt>* Ruby version: ruby 1.8.7
+(2010-01-10 patchlevel 249) [i486-linux] </dt>
<dd></dd>
-<dt>* Last Generated
-on: Tue Dec 16 00:16:50 -0500 2008 </dt>
+<dt>* Last Generated on: Wed Mar 17 13:34:17
+-0400 2010 </dt>
<dd></dd>
<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>