aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/sisu/html/sisu_howto.8.html
diff options
context:
space:
mode:
Diffstat (limited to 'data/doc/sisu/html/sisu_howto.8.html')
-rw-r--r--data/doc/sisu/html/sisu_howto.8.html1447
1 files changed, 0 insertions, 1447 deletions
diff --git a/data/doc/sisu/html/sisu_howto.8.html b/data/doc/sisu/html/sisu_howto.8.html
deleted file mode 100644
index a5b9adf7..00000000
--- a/data/doc/sisu/html/sisu_howto.8.html
+++ /dev/null
@@ -1,1447 +0,0 @@
-<!-- manual page source format generated by PolyglotMan v3.2, -->
-<!-- available at http://polyglotman.sourceforge.net/ -->
-
-<html>
-<head>
-<title>"sisu_howto"("1") manual page</title>
-</head>
-<body bgcolor='white'>
-<a href='#toc'>Table of Contents</a><p>
-SISU - TECHNICAL, HOWTO, RALPH AMISSAH
-<p> SISU SOME TECHNICAL INFORMATION
-
-<p> HOWTO
-<p> 1. GETTING HELP
-<p> An online manual of sorts should be available
-at:
-<p> &lt;<a href='http://www.jus.uio.no/sisu_manual/'>http://www.jus.uio.no/sisu_manual/</a>
-&gt;
-<p> The manual pages provided with
-<b>SiSU</b> are also available online, and there is an interactive help, which
-is being superseded by the man page, and possibly some document which contains
-this component.
-<p> 1.1 SISU
-<p> If <b>SiSU</b> is installed on your system usual man
-commands should be available, try:
-<p> man sisu
-<p> The <b>SiSU</b> man pages can
-be viewed online at:[^1]
-<p> An online version of the sisu man page is available
-here:
-<p> * various sisu man pages &lt;<a href='http://www.jus.uio.no/sisu/man/'>http://www.jus.uio.no/sisu/man/</a>
-&gt; &nbsp;[^2]
-<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; &nbsp;[^3]
-<p> * sisu.8 &lt;<a href='http://www.jus.uio.no/sisu/man/sisu.8.html'>http://www.jus.uio.no/sisu/man/sisu.8.html</a>
-&gt;
-&nbsp;[^4]
-<p> * sisu_examples.1 &lt;<a href='http://www.jus.uio.no/sisu/man/sisu_examples.1.html'>http://www.jus.uio.no/sisu/man/sisu_examples.1.html</a>
-&gt; &nbsp;[^5]
-
-<p> * sisu_webrick.1 &lt;<a href='http://www.jus.uio.no/sisu/man/sisu_webrick.1.html'>http://www.jus.uio.no/sisu/man/sisu_webrick.1.html</a>
-&gt; &nbsp;[^6]
-<p> 1.2
-
-<p>SISU BUILT-IN HELP
-<p> sisu --help<br>
-
-<p> sisu --help &nbsp;[subject]<br>
-
-<p> sisu --help env &nbsp;[for &nbsp;feedback &nbsp;on &nbsp;the &nbsp;way &nbsp;your &nbsp;system &nbsp;is <br>
- setup &nbsp;with &nbsp;regard &nbsp;to &nbsp;sisu]<br>
-
-<p> sisu -V &nbsp;[same &nbsp;as &nbsp;above &nbsp;command]<br>
-
-<p> sisu --help commands<br>
-
-<p> sisu --help markup<br>
-
-<p> 1.3 COMMAND LINE WITH FLAGS - BATCH PROCESSING
-<p> Running sisu (alone without
-any flags, filenames or wildcards) brings up the interactive help, as does
-any sisu command that is not recognised.
-<p> In the data directory run sisu
--mh filename or wildcard eg. cisg.sst documents.
-<p> 2. SETUP, INITIALISATION
-
-<p> 2.1 INITIALISE OUTPUT DIRECTORY
-<p> Images, css files for a document directory
-are copied to their respective locations in the output directory.
-<p> while
-within your document markup/preparation directory, issue the following
-
-<p>command
-<p> sisu -CC<br>
-
-<p> 2.1.1 USE OF SEARCH FUNCTIONALITY, AN EXAMPLE USING SQLITE
-<p> <b>SiSU</b> can populate
-PostgreSQL and Sqlite databases and provides a sample search form for querying
-these databases.
-<p> This note provides an example to get you started and
-
-<p>will use sqlite
-<p> It is necessary to:
-<p> (1) make sure the required dependencies
-
-<p>have been installed
-<p> (2) have a directory with sisu markup samples that
-
-<p>is writable
-<p> (3) use sisu to create a database
-<p> (4) use sisu tp populate
-
-<p>a database
-<p> (5) use sisu to start the webrick (httpd) server
-<p> (6) use
-
-<p>sisu to create a search form
-<p> (7) copy the search form to the cgi directory
-
-<p> (8) open up the form in your browser
-<p> (9) query the database using the
-
-<p>search form
-<p> <b>(1) make sure the required dependencies have been installed</b>
-
-<p> if you use <b>Debian</b> , the following command will install the required dependencies
-
-<p> aptitude install sisu-sqlite
-<p> <b>(2) have a directory with sisu markup samples
-
-<p>that is writable</b>
-<p> ideally copy the sisu-examples directory to your home
-directory (because the directory in which you run this example should be
-writable)
-<p> cp -rv /usr/share/sisu-examples/sample/document_samples_sisu_markup
-~/.
-<p> <b>(3) use sisu to create an sqlite database</b>
-<p> within the sisu-examples
-
-<p>directory
-<p> sisu -dv createall
-<p> <b>(4) use sisu tp populate a database with
-
-<p>some text</b>
-<p> within the sisu-examples directory
-<p> sisu -div free_*.sst
-<p> or
-
-<p> sisu -dv import free_*.sst debian_constitution_v1.2.sst debian_social_contract_v1.1.sst
-
-<p>gpl2.fsf.sst
-<p> <b>(5) use sisu to start the webrick (httpd) server (if it has
-not already</b> been started):
-<p> sisu -W
-<p> <b>(6) use sisu to create a search form
-(for use with the webrick server, and</b> your sample documents)
-<p> within the
-
-<p>sisu-examples directory
-<p> sisu -F webrick
-<p> #here i run into a problem, you
-are working from a read only #directory..., not my usual mode of operation,
-
-<p>to complete the example #the following is necessary sudo touch sisu_sqlite.cgi
-
-<p>sisu_pgsql.cgi sudo -P chown $USER sisu_sqlite.cgi sisu_pgsql.cgi
-<p> #now this
-should be possible: sisu -F webrick
-<p> <b>(7) copy the search form to the cgi
-
-<p>directory</b>
-<p> the string should be provided as output from the previous command
-
-<p> sudo cp -vi /usr/share/sisu-examples/sample/document_samples_sisu_markup/sisu_sqlite.cgi
-
-<p>/usr/lib/cgi-bin
-<p> sudo chmod -v 755 /usr/lib/cgi-bin/sisu_sqlite.cgi
-<p> <b>(8)
-
-<p>open up the form in your browser and query it</b>
-<p> url:
-<p> &lt;<a href='http://localhost:8081/cgi-bin/sisu_sqlite.cgi'>http://localhost:8081/cgi-bin/sisu_sqlite.cgi</a>
-&gt;
-
-<p> or as instructed by command sisu -F webrick
-<p> <b>(9) query the database using
-
-<p>the search form</b>
-<p> if there are other options in the dropdown menu select
-
-<p> document_samples_sisu_markup
-<p> and search for some text, e.g.:
-<p> aim OR
-
-<p>project
-<p> * selecting the <b>index</b> radio button gives an index of results
-
-<p>using the object numbers
-<p> * selecting the <b>text</b> radio button gives the
-
-<p>content of the matched paragraphs with the match highlighted
-<p> <b>(10) to
-
-<p>start again with a new database</b>
-<p> to start from scratch you can drop the
-
-<p>database with the command
-<p> sisu -dv dropall
-<p> and go to step 3
-<p> to get
-
-<p>to step 3 in one step with a single command
-<p> sisu -dv recreate
-<p> continue
-
-<p>subsequent steps
-<p> 2.2 MISC
-<p> 2.2.1 URL FOR OUTPUT FILES -U -U
-<p> sisu -uv[and
-&nbsp;other &nbsp;flags] &nbsp;[filename/wildcard]<br>
-
-<p> sisu -Uv &nbsp;[filename/wildcard]<br>
-
-<p> 2.2.2 TOGGLE SCREEN COLOR
-<p> sisu -cv[and &nbsp;processing &nbsp;flags] &nbsp;[filename/wildcard]<br>
-
-<p> 2.2.3 VERBOSE MODE
-<p> sisu -v[and &nbsp;processing &nbsp;flags] &nbsp;[filename/wildcard]<br>
-
-<p> sisu -V[and &nbsp;processing &nbsp;flags] &nbsp;[filename/wildcard]<br>
-
-<p> 2.2.4 QUIET MODE
-<p> sisu -q[and &nbsp;processing &nbsp;flags] &nbsp;[filename/wildcard]<br>
-
-<p> 2.2.5 MAINTENANCE MODE INTERMEDIATE FILES KEPT -M
-<p> sisu -Mv[and &nbsp;other
-&nbsp;flags] &nbsp;[filename/wildcard]<br>
-
-<p> 2.2.6 START THE WEBRICK SERVER
-<p> sisu -W<br>
-
-<p> 2.3 REMOTE PLACEMENT OF OUTPUT
-<p> configuration is necessary
-<p> scp
-<p>
-sisu -vr[and &nbsp;processing &nbsp;flags] &nbsp;[filename/wildcard]<br>
-
-<p> rsync
-<p> sisu -vR[and &nbsp;processing &nbsp;flags] &nbsp;[filename/wildcard]<br>
-
-<p> 3. CONFIGURATION FILES
-<p> Sample provided, on untarring the source tarball:
-
-<p> conf/sisu/sisurc.yaml<br>
-
-<p> and on installation under:
-<p> /etc/sisu/sisurc.yaml<br>
-
-<p> The following paths are searched:
-<p> ./_sisu/sisurc.yaml<br>
-
-<p> ~/.sisu/sisurc.yaml<br>
-
-<p> ./etc/sisu/sisurc.yaml<br>
-
-<p> 4. MARKUP
-<p> See sample markup provided on
-<p> &lt;<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
-&gt;
-<p>
- &lt;<a href='http://www.jus.uio.no/sisu_markup'>http://www.jus.uio.no/sisu_markup</a>
-&gt;
-<p> &lt;<a href='http://www.jus.uio.no/sisu/SiSU'>http://www.jus.uio.no/sisu/SiSU</a>
-&gt;
-<p> in particular
-for each of the document output samples provided, the source document is
-
-<p>provided as well
-<p> &lt;<a href='http://www.jus.uio.no/sisu/SiSU/2#books'>http://www.jus.uio.no/sisu/SiSU/2#books</a>
-&gt;
-<p> on untarring
-the source tarball:
-<p> data/sisu-examples/sample/document_samples_sisu_markup/<br>
-
-<p> or the same once source is installed (or sisu-examples) under:
-<p> /usr/share/sisu-examples/sample/document_samples_sisu_markup/<br>
-
-<p> Some notes are contained within the man page, <b>man sisu</b> and within sisu
-
-<p>help via the commands <b>sisu help markup</b> and <b>sisu help headers</b>
-<p> <b>SiSU</b> is
-for literary and legal text, also for some social science material. In particular
-it does not do formula, and is not particularly suited to technical documentation.
-Despite the latter caveat, some notes will be provided here and added to
-over time:
-<p> 4.1 HEADERS
-<p> Headers @headername: provide information related
-to the document, this may relate to
-<p> 1. how it is to be processed, such
-as whether headings are to be numbered, what skin is to be used and markup
-instructions, such as the document structure, or words to be made bold
-
-<p>within the document
-<p> 2. semantic information about the document including
-
-<p>the dublin core
-<p> 4.2 FONT FACE
-<p> Defaults are set. You may change the face
-to: bold, italics, underscore, strikethrough, ...
-<p> 4.2.1 BOLD
-<p> @bold: &nbsp;[list
-&nbsp;of &nbsp;words &nbsp;that &nbsp;should &nbsp;be &nbsp;made &nbsp;bold &nbsp;within or document]
-<p> <b>bold line</b>
-<p> !_
-
-<p>bold line
-<p> <b>bold word or sentence</b>
-<p> !{ bold word or sentence }!
-<p> *{ bold
-word or sentence }*
-<p> <b>boldword</b> or <b>boldword</b>
-<p> *boldword* or !boldword!
-<p>
-
-<p>4.2.2 ITALICS
-<p> @italics: &nbsp;[list &nbsp;of &nbsp;words &nbsp;that &nbsp;should &nbsp;be &nbsp;italicised &nbsp;within
-
-<p> <i>italicise</i> word or sentence
-<p> /{ italicise word or sentence }/
-<p> <i>italicisedword</i>
-
-<p> /italicisedword/
-<p> 4.2.3 UNDERSCORE
-<p> <i>underscore</i> word or sentence
-<p> _{ underscore
-word or sentence }_
-<p> <i>underscoreword</i>
-<p> 4.2.4 STRIKETHROUGH
-<p> &lt;del&gt; strikethrough
-word or sentence &lt;/del&gt;
-<p> -{ strikethrough word or sentence }-
-<p> &lt;del&gt;strikeword&lt;/del&gt;
-
-<p> -strikeword-
-<p> 4.3 ENDNOTES
-<p> There are two forms of markup for endnotes,
-
-<p>they cannot be mixed within the same document
-<p> here[^7]
-<p> 1. preferred endnote
-
-<p>markup
-<p> here~{ this is an endnote }~
-<p> 2. alternative markup equivalent,
-
-<p>kept because it is possible to search and replace to get markup in existing
-
-<p>texts such as Project Gutenberg
-<p> here~^
-<p> ^~ this is an endote
-<p> 4.4 LINKS
-
-<p> SiSU &lt;<a href='http://sisudoc.org'>http://sisudoc.org</a>
-&gt;
-<p> { <b>SiSU</b> }<a href='http://sisudoc.org'>http://sisudoc.org</a>
-
-<p> sisu.png 120x39 &lt;<a href='http://sisudoc.org'>http://sisudoc.org</a>
-&gt;
-
-<p> {sisu.png }<a href='http://sisudoc.org'>http://sisudoc.org</a>
-
-<p> [ tux.png ]
-<p> { tux.png 64x80 }image
-<p> SiSU
-&lt;<a href='http://sisudoc.org'>http://sisudoc.org</a>
-&gt; &nbsp;[^8]
-<p> { <b>SiSU</b> }<a href='http://sisudoc.org'>http://sisudoc.org</a>
-
-<p> is equivalent to:
-<p>
- { <b>SiSU</b> }<a href='http://sisudoc.org'>http://sisudoc.org</a>
- ~{ &lt;<a href='http://sisudoc.org'>http://sisudoc.org</a>
-&gt; }~
-<p> the same can be done
-with an image:
-<p> sisu.png 120x39
-<p> { sisu.png <b>SiSU</b> }<a href='http://sisudoc.org'>http://sisudoc.org</a>
-<br>
-
-<p> 4.5 NUMBER TITLES
-<p> Set with the header @markup:
-<p> 4.6 LINE OPERATIONS
-<p>
- Line Operations (marker placed at start of line)
-<p> !_ bold line
-<p> <b>bold
-
-<p>line</b>
-<p> _1 indent paragraph one level
-<p> indent paragraph one level<br>
-
-<p> _2 indent paragraph two steps
-<p> indent paragraph two steps<br>
-
-<p> _* bullet paragraph
-<p> * bullet paragraph
-<p> # number paragraph (see headers
-for numbering document headings)
-<p> 1. number paragraph (see headers for
-numbering document headings)
-<p> _# number paragraph level 2 (see headers
-for numbering document headings)
-<p> a. number paragraph level 2 (see headers
-for numbering document headings)<br>
-
-<p> 4.7 TABLES
-<p> Table markup sample
-<p>
-<p> table{~h c3; 26; 32; 32; <p>
-
-<p>
-<p> This is
-a table, column1 <p>
-this would become row one of column two <p>
-column three of
-row one is here <p>
-
-<p>
-<p> column one row 2 <p>
-column two of row two <p>
-column three of
-row two, and so on <p>
-
-<p>
-<p> column one row three <p>
-and so on <p>
-here <p>
-
-<p>
-<p> }table <p>
-
-<p> Alternative
-
-<p>form of table markup
-<p>
-<p> <br>
-<pre> {t~h}
- |Mon|Tue|Wed|Thu|Fri|Sat|Sun
- 0 | * | * | * | * | * | * | *
- 1 | * | * | * | * | | |
- 2 | - | * | * | * | * | * |
- 3 | - | * | * | * | * | * | *
- 4 | - | | | * | * | * |
- 5 | * | * | * | * | * | * | *
-</pre>
-<p> 4.8 GROUPED TEXT
-<p>
-<p> <br>
-<pre> 5.times { puts &rsquo;Ruby&rsquo; }
-</pre>
-<p> code{
-<p>
-<p> <br>
-<pre> 5.times { puts &rsquo;Ruby&rsquo; }
-</pre>
-<p> }code
-<p>
-<p> A Limerick <p>
-
-<p>
-<p> There was a young lady from Clyde, <p>
-who ate a green
-apple and died, <p>
-but the apple fermented inside the lamented, <p>
-and made cider
-inside her inside. <p>
-
-<p>
-<p> poem{ <p>
-
-<p>
-<p> There was a young lady from Clyde, <p>
-who ate
-a green apple and died, <p>
-but the apple fermented inside the lamented, <p>
-and
-made cider inside her inside. <p>
-
-<p>
-<p> }poem <p>
-
-<p> 4.9 COMPOSITE DOCUMENT
-<p> To import
-another document, the master document or importing document should be named
-filename.r3 (r for require)
-<p> &amp;lt;&amp;lt; { filename.sst }
-<p> &amp;lt;&amp;lt; { filename.ssi
-}
-<p> 5. CHANGE APPEARANCE
-<p> 5.1 SKINS
-<p> Skins appearance, including such things
-as the url for the home page on which the material will be published, information
-on the credit band, and for html documents colours and icons used in navigation
-bars. Skins are ruby files which permit changing of the default values set
-within the program for <b>SiSU</b> output.
-<p> There are a few examples provided,
-on untarring the source tarball:
-<p> conf/sisu/skin/doc/<br>
-
-<p> data/sisu-examples/sample/document_samples_sisu_markup/_sisu/skin/doc<br>
-
-<p> and on installation under:
-<p> /etc/sisu/skin/doc/<br>
-
-<p> /usr/share/sisu-examples/sample/document_samples_sisu_markup/_sisu/skin/doc<br>
-
-<p> The following paths are searched:
-<p> ./_sisu/skin<br>
-
-<p> ~/.sisu/skin<br>
-
-<p> /etc/sisu/skin<br>
-
-<p> Skins under the searched paths in a per document directory, a per directory
-directory, or a site directory, named:
-<p> doc &nbsp;[may &nbsp;be &nbsp;specified &nbsp;individually
-&nbsp;in &nbsp;each &nbsp;document]
-<p> dir &nbsp;[used &nbsp;if &nbsp;identifier &nbsp;part &nbsp;of &nbsp;name &nbsp;matches &nbsp;markup
-&nbsp;directory &nbsp;name]
-<p> site
-<p> It is usual to place all skins in the document
-directory, with symbolic links as required from dir or site directories.
-
-<p> 5.2 CSS
-<p> The appearance of html and XML related output can be changed
-for an ouput collection directory by prepareing and placing a new css file
-in one of the sisu css directories searched in the sisu configuration path.
-These are located at:
-<p> _./_sisu/css
-<p> ~/.sisu/css
-<p> and
-<p> /etc/sisu/css
-
-<p> The contents of the first directory found in the search path are copied
-to the corresponding sisu output directory with the commnd:
-<p> sisu -CC
-<p>
- The <b>SiSU</b> standard css files for <b>SiSU</b> output are:
-<p> dom.css html.css html_tables.css
-
-<p>index.css sax.css xhtml.css
-<p> A document may specify its own/bespoke css file
-using the css header.
-<p> @css:
-<p> [expand]
-<p> EXTRACTS FROM THE README
-<p> 6. README
-
-<p> <b>SiSU</b> 0.55 2007w27/6 2007-07-07
-<p> Homepage: &lt;<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
-&gt;
-<p> <b>Description</b>
-
-<p> <b>SiSU</b> is lightweight markup based document creation and publishing framework
-that is controlled from the command line. Prepare documents for <b>SiSU</b> using
-your text editor of choice, then use <b>SiSU</b> to generate various output document
-formats.
-<p> With minimal preparation of a plain-text (UTF-8) file using its
-native markup-syntax, <b>SiSU</b> produces: plain-text, HTML, XHTML, XML, ODF:ODT
-(Opendocument), LaTeX, PDF, and populates an SQL database (PostgreSQL or
-SQLite) in paragraph sized chunks so that document searches are done at
-
-<p>this
-<p> Outputs share a common citation numbering system, and any semantic
-meta-data provided about the document.
-<p> <b>SiSU</b> also provides concordance files,
-document content certificates and manifests of generated output.
-<p> <b>SiSU</b>
-takes advantage of well established open standard ways of representing
-text, and provides a bridge to take advantage of the strengths of each,
-while remaining simple. <b>SiSU</b> implements across document formats a &nbsp;from &nbsp;a
-&nbsp;humanities, &nbsp;law, &nbsp;and &nbsp;possibly &nbsp;social &nbsp;sciences &nbsp;rather &nbsp;than &nbsp;technical &nbsp;or
-&nbsp;scientific &nbsp;writing] ... focus is primarily on content and data integrity rather
-than appearance, (though outputs in the various formats are respectable).
-
-<p> A vim syntax highlighting file and an ftplugin with folds for sisu markup
-is provided. Vim 7 includes syntax highlighting for <b>SiSU</b>
-<p> man pages, and
-interactive help are provided.
-<p> Dependencies for various features are taken
-care of in sisu related packages. The package sisu-complete installs the
-whole of <b>SiSU</b>
-<p> Additional document markup samples are provided in the
-package sisu-markup-samples which is found in the non-free archive the licenses
-for the substantive content of the marked up documents provided is that
-provided by the author or original publisher.
-<p> Homepage: &lt;<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
-&gt;
-
-<p> <b>SiSU</b> - simple information structuring universe, is a publishing tool,
-document generation and management, (and search enabling) tool primarily
-for literary, academic and legal published works.
-<p> <b>SiSU</b> can be used for
-Internet, Intranet, local filesystem or cd publishing.
-<p> <b>SiSU</b> can be used
-directly off the filesystem, or from a database.
-<p> <b>SiSU</b> &rsquo;s scalability, is
-be dependent on your hardware, and filesystem (in my case Reiserfs), and/or
-database Postgresql.
-<p> Amongst it&rsquo;s characteristics are:
-<p> * simple mnemonoic
-markup style,
-<p> * the ability to produce multiple output formats, including
-html, structured XML, LaTeX, pdf (via LaTeX), stream to a relational database
-whilst retaining document structure - Postgresql and Sqlite,
-<p> * that all
-share a common citation system (a simple idea from which much good), possibly
-most exciting, the following: if fed into a relational database (as it
-can be automatically), the document set is searchable, with results displayed
-at a paragraph level, or the possibility of an indexed display of documents
-in which the match is found together with a hyperlinked listing for each
-of each paragraph in which the match is found. In any event citations using
-this system (with or without the relational database) are relevant for
-all output formats.
-<p> * it is command line driven, and can be set up on
-
-<p>a remote server
-<p> * Documents are marked up in <b>SiSU</b> syntax in your favourite
-editor. <b>SiSU</b> syntax may be regarded as a type of smart ascii - which in its
-basic form is simpler than the most elementary html. There is currently
-a syntax highlighter, and folding for Vim. Syntax highlighters for other
-editors are welcome.
-<p> Input files should be UTF-8
-<p> Once set up it is simple
-to use.
-<p> 6.1 ONLINE INFORMATION, PLACES TO LOOK
-<p> &lt;<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
-&gt;
-
-<p> Download Sources:
-<p> &lt;<a href='http://www.jus.uio.no/sisu/SiSU/download.html#current'>http://www.jus.uio.no/sisu/SiSU/download.html#current</a>
-&gt;<br>
-
-<p> &lt;<a href='http://www.jus.uio.no/sisu/SiSU/download.html#debian'>http://www.jus.uio.no/sisu/SiSU/download.html#debian</a>
-&gt;<br>
-
-<p> 6.2 INSTALLATION
-<p> NB. Platform is Unix / Linux.
-<p> 6.2.1 DEBIAN
-<p> If you use
-<b>Debian</b> use the <b>Debian</b> packages, check the information at:
-<p> &lt;<a href='http://www.jus.uio.no/sisu/SiSU/download.html#debian'>http://www.jus.uio.no/sisu/SiSU/download.html#debian</a>
-&gt;<br>
-
-<p> (A) <b>SiSU</b> is available directly off the <b>Debian</b> archives for Sid and testing.
-It should necessary only to run as root:
-<p> aptitude update<br>
-
-<p> aptitude install sisu-complete<br>
-
-<p> (B) If there are newer versions of <b>SiSU</b> upstream of the <b>Debian</b> archives,
-
-<p>they will be available by adding the following to your /etc/apt/sources.list
-
-<p> deb &lt;<a href='http://www.jus.uio.no/sisu/archive'>http://www.jus.uio.no/sisu/archive</a>
-&gt; unstable main non-free<br>
-
-<p> deb-src &lt;<a href='http://www.jus.uio.no/sisu/archive'>http://www.jus.uio.no/sisu/archive</a>
-&gt; unstable main non-free<br>
-
-<p> [the &nbsp;non-free &nbsp;line &nbsp;is &nbsp;for &nbsp;document &nbsp;markup &nbsp;samples, &nbsp;for &nbsp;which &nbsp;the &nbsp;substantive
-&nbsp;text &nbsp;is &nbsp;provided &nbsp;under &nbsp;the &nbsp;author &nbsp;or which original &nbsp;publisher&rsquo;s &nbsp;license
-&nbsp;and &nbsp;which &nbsp;in &nbsp;most &nbsp;cases &nbsp;will
-<p> Then as root run:
-<p> aptitude update<br>
-
-<p> aptitude install sisu-complete<br>
-
-<p> 6.2.2 RPM
-<p> RPMs are provided though untested, they are prepared by running
-alien against the source package, and against the debs.
-<p> They may be downloaded
-from:
-<p> &lt;<a href='http://www.jus.uio.no/sisu/SiSU/download.html#rpm'>http://www.jus.uio.no/sisu/SiSU/download.html#rpm</a>
-&gt;<br>
-
-<p> 6.2.3 SOURCE PACKAGE .TGZ
-<p> Otherwise to install <b>SiSU</b> from source, check
-information at:
-<p> &lt;<a href='http://www.jus.uio.no/sisu/SiSU/download.html#current'>http://www.jus.uio.no/sisu/SiSU/download.html#current</a>
-&gt;<br>
-
-<p> alternative modes of installation from source are provided, setup.rb
-(by Minero Aoki), rake (by Jim Weirich) built install file, rant (by Stefan
-Lang) built install file,
-<p> <b>Ruby</b> is the essential dependency for the basic
-
-<p>operation of <b>SiSU</b>
-<p> 1. Download the latest source (information available)
-from:
-<p> &lt;<a href='http://www.jus.uio.no/sisu/SiSU/download.html#current'>http://www.jus.uio.no/sisu/SiSU/download.html#current</a>
-&gt;<br>
-
-<p> 2. Unpack the source
-<p> Note however, that additional external package
-dependencies, such as texlive or postgresql should you desire to use it
-are not taken care of for you.
-<p> 6.2.4 TO USE SETUP.RB
-<p> this is a three step
-process, in the root directory of the unpacked <b>SiSU</b> as root type:
-<p> ruby
-setup.rb config<br>
-
-<p> ruby setup.rb setup<br>
-
-<p> as root:
-<p> ruby setup.rb install<br>
-
-<p> further information:
-<p> &lt;<a href='http://i.loveruby.net/en/projects/setup/'>http://i.loveruby.net/en/projects/setup/</a>
-&gt;<br>
-
-<p> &lt;<a href='http://i.loveruby.net/en/projects/setup/doc/usage.html'>http://i.loveruby.net/en/projects/setup/doc/usage.html</a>
-&gt;<br>
-
-<p> 6.2.5 TO USE INSTALL (PRAPARED WITH
-<p> Rake must be installed on your system:
-
-<p> &lt;<a href='http://rake.rubyforge.org/'>http://rake.rubyforge.org/</a>
-&gt;<br>
-
-<p> &lt;<a href='http://rubyforge.org/frs/?group_id=50'>http://rubyforge.org/frs/?group_id=50</a>
-&gt;<br>
-
-<p> in the root directory of the unpacked <b>SiSU</b> as root type:
-<p> rake<br>
-
-<p> or
-<p> rake base<br>
-
-<p> This makes use of Rake (by Jim Weirich) and the provided Rakefile
-<p>
-For a list of alternative actions you may type:
-<p> rake help<br>
-
-<p> rake -T<br>
-
-<p> 6.2.6 TO USE INSTALL (PRAPARED WITH
-<p> (you may use the instructions above
-for rake substituting rant if rant is installed on your system, or you
-may use an independent installer created using rant as follows:)
-<p> in the
-root directory of the unpacked <b>SiSU</b> as root type:
-<p> ruby ./sisu-install<br>
-
-<p> or
-<p> ruby ./sisu-install base<br>
-
-<p> This makes use of Rant (by Stefan Lang) and the provided Rantfile. It
-has been configured to do post installation setup setup configuration and
-generation of first test file. Note however, that additional external package
-dependencies, such as tetex-extra are not taken care of for you.
-<p> further
-information:
-<p> &lt;<a href='http://make.rubyforge.org/'>http://make.rubyforge.org/</a>
-&gt;<br>
-
-<p> &lt;<a href='http://rubyforge.org/frs/?group_id=615'>http://rubyforge.org/frs/?group_id=615</a>
-&gt;<br>
-
-<p> For a list of alternative actions you may type:
-<p> ruby ./sisu-install
-help<br>
-
-<p> ruby ./sisu-install -T<br>
-
-<p> 6.3 DEPENDENCIES
-<p> Once installed see &rsquo;man 8 sisu&rsquo; for some information
-on additional programs that sisu makes use of, and that you may need or
-wish to install. (this will depend on such factors as whether you want to
-generate pdf, whether you will be using <b>SiSU</b> with or without a database,
-...) &rsquo;man sisu_markup-samples&rsquo; may also be of interest if the sisu-markup-samples
-package has also been installed.
-<p> The information in man 8 may not be most
-up to date, and it is possible that more useful information can be gleaned
-from the following notes taken from the <b>Debian</b> control file (end edited),
-gives an idea of additional packages that <b>SiSU</b> can make use of if available,
-(the use/requirement of some of which are interdependent for specific actions
-by <b>SiSU</b> ).
-<p> The following is from the debian/control file of sisu-0.58.2,
-which amongst other things provides the dependencies of sisu within <b>Debian</b>
-
-<p>
-<p> <br>
-<pre> Package: sisu
- Architecture: all
- Depends: ruby (&gt;= 1.8.2), libwebrick-ruby, unzip, zip
- Conflicts: vim-sisu, sisu-vim, sisu-remote
- Replaces: vim-sisu, sisu-vim
- Recommends: sisu-pdf, sisu-sqlite, sisu-postgresql, librmagick-ruby, trang,
- tidy, librexml-ruby, openssl, rsync, openssh-client | lsh-client, keychain,
- hyperestraier, kdissert, vim-addon-manager
- Suggests: rcs | cvs, lv, texinfo, pinfo
- Package: sisu-complete
- Depends: ruby (&gt;= 1.8.4), sisu, sisu-pdf, sisu-postgresql, sisu-sqlite
- Recommends: hyperestraier
- Package: sisu-pdf
- Architecture: all
- Depends: sisu, texlive-latex-base, texlive-fonts-recommended,
- texlive-latex-recommended, texlive-latex-extra
- Suggests: evince, xpdf
- Package: sisu-postgresql
- Depends: sisu, postgresql-8.1, libdbi-ruby, libdbm-ruby, libdbd-pg-ruby
- Suggests: pgaccess, libdbd-pgsql, postgresql-contrib-8.1
- Package: sisu-sqlite
- Depends: sisu, sqlite, libdbi-ruby, libdbm-ruby, libdbd-sqlite-ruby
- Suggests: libdbd-sqlite
- Package: sisu-markup-samples
- Depends: sisu
-</pre>
-<p>
-<p> <br>
-<pre> Source: sisu
- Section: text
- Priority: optional
- Maintainer: Ralph Amissah &lt;ralph@amissah.com&gt;
- Build-Depends: debhelper (&gt;= 5)
- Standards-Version: 3.7.2
- Package: sisu
- Architecture: all
- Depends: ruby (&gt;= 1.8.2), libwebrick-ruby, unzip, zip
- Conflicts: vim-sisu, sisu-vim, sisu-remote
- Replaces: vim-sisu, sisu-vim
- Recommends: sisu-pdf, sisu-sqlite, sisu-postgresql, hyperestraier, keychain,
-librmagick-ruby, librexml-ruby, openssl, openssh-client | lsh-client, rsync,
-tidy, vim-addon-manager
- Suggests: kdissert, lv, rcs | cvs, pinfo, texinfo, trang
- Description: documents - structuring, publishing in multiple formats and
-search
- SiSU is a lightweight markup based, command line oriented, document
- structuring, publishing and search framework for document collections.
- .
- With minimal preparation of a plain-text, (UTF-8) file, using its native
- markup syntax in your text editor of choice, SiSU can generate various
- document formats (most of which share a common object numbering system
-for
- locating content), including plain text, HTML, XHTML, XML, OpenDocument
-text
- (ODF:ODT), LaTeX, PDF files, and populate an SQL database with objects
- (roughly paragraph-sized chunks) so searches may be performed and matches
- returned with that degree of granularity: your search criteria is met
-by these
- documents and at these locations within each document. Object numbering
-is
- particularly suitable for
- works that are frequently changed or updated) for which it provides
-a fixed
- means of reference of content. Document outputs also share semantic meta-data
- provided.
- .
- SiSU also provides concordance files, document content certificates
-and
- manifests of generated output.
- .
- A vim syntax highlighting file and an ftplugin with folds for sisu markup
-is
- provided, as are syntax highlighting files for kate, kwrite, gedit and
- diakonos. Vim 7 includes syntax highlighting for SiSU.
- .
- man pages, and interactive help are provided.
- .
- Dependencies for various features are taken care of in sisu related
-packages.
- The package sisu-complete installs the whole of SiSU.
- .
- Additional document markup samples are provided in the package
- sisu-markup-samples which is found in the non-free archive the licenses
-for
- the substantive content of the marked up documents provided is that
-provided
- by the author or original publisher.
- .
- Homepage: &lt;http://www.jus.uio.no/sisu&gt;
-</pre>
-<p>
-<p> <br>
-<pre> Package: sisu-complete
- Architecture: all
- Depends: ruby (&gt;= 1.8.2), sisu, sisu-pdf, sisu-postgresql, sisu-sqlite
- Recommends: hyperestraier
- Description: installs all SiSU related packages
- This package installs SiSU and related packages that enable sisu to
-produce
- pdf and to populate postgresql and sqlite databases.
- .
- SiSU is a lightweight markup based document publishing framework.
- .
- See sisu for a description of the package.
- .
- Homepage: &lt;http://www.jus.uio.no/sisu&gt;
-</pre>
-<p>
-<p> <br>
-<pre> Package: sisu-pdf
- Architecture: all
- Depends: sisu, texlive-latex-base, texlive-fonts-recommended, texlive-latex-recommended,
-texlive-latex-extra
- #Suggests: evince, xpdf
- Description: dependencies to convert SiSU LaTeX output to pdf
- This package enables the conversion of SiSU LaTeX output to pdf.
- .
- SiSU is a lightweight markup based document publishing framework.
- .
- Homepage: &lt;http://www.jus.uio.no/sisu&gt;
-</pre>
-<p>
-<p> <br>
-<pre> Package: sisu-postgresql
- Architecture: all
- Depends: sisu, libdbd-pg-ruby, libdbi-ruby, libdbm-ruby, postgresql
- Recommends: libfcgi-ruby
- Suggests: postgresql-contrib
- Description: SiSU dependencies for use with postgresql database
- This package enables SiSU to populate a postgresql database. This is
-done at
- an object/paragraph level, making granular searches of documents possible.
- .
- This relational database feature of SiSU is not required but provides
- interesting possibilities, including that of granular searches of documents
- for matching units of text, primarily paragraphs that can be displayed
-or
- identified by object citation number, from which an index of documents
- matched and each matched paragraph within them can be displayed.
- .
- SiSU is a lightweight markup based document publishing framework.
- .
- Homepage: &lt;http://www.jus.uio.no/sisu&gt;
-</pre>
-<p>
-<p> <br>
-<pre> Package: sisu-sqlite
- Architecture: all
- Depends: sisu, sqlite, libdbd-sqlite-ruby, libdbi-ruby, libdbm-ruby
- Recommends: libfcgi-ruby
- Description: SiSU dependencies for use with sqlite database
- This package enables SiSU to populate an sqlite database. This is done
-at an
- object/paragraph level, making granular searches of documents possible.
- .
- This relational database feature of SiSU is not required but provides
- interesting possibilities, including that of granular searches of documents
- for matching units of text, primarily paragraphs that can be displayed
-or
- identified by object citation number, from which an index of documents
- matched and each matched paragraph within them can be displayed.
- .
- SiSU is a lightweight markup based document publishing framework.
- .
- Homepage: &lt;http://www.jus.uio.no/sisu&gt;
-</pre>
-<p> 6.4 QUICK START
-<p> Most of the installation should be taken care of by the
-aptitude or rant install. (The rant install if run in full will also test
-run the generation of the first document).
-<p> After installation of sisu-complete,
-
-<p>move to the document samples directory
-<p> cd /usr/share/doc/sisu/sisu_markup_samples/dfsg<br>
-
-<p> and run
-<p> sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst<br>
-
-<p> or the same:
-<p> sisu -NhwpoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst<br>
-
-<p> look at output results, see the
-<p> or to generate an online document
-move to a writable directory, as the file will be downloaded there and
-e.g.
-<p> sisu -3 &lt;<a href='http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst'>http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst</a>
-&gt;
-
-<p> the database stuff is extra perhaps, the latex stuff could be considered
-
-<p>extra perhaps but neither needs to be installed for most of sisu output
-
-<p>to work
-<p> examine source document, vim has syntax support
-<p> gvim free_as_in_freedom.rms_and_free_software.sam_williams.sst
-
-<p> additional markup samples in
-<p> &lt;<a href='http://www.jus.uio.no/sisu/SiSU/2.html'>http://www.jus.uio.no/sisu/SiSU/2.html</a>
-&gt;<br>
-
-<p> For help
-<p> man sisu<br>
-
-<p> or
-<p> sisu --help<br>
-
-<p> e.g.
-<p> for the way sisu
-<p> sisu --help env<br>
-
-<p> for list of commands and so on
-<p> sisu --help commands<br>
-
-<p> 6.5 CONFIGURATION FILES
-<p> The default configuration/setup is contained
-
-<p>within the program and is altered by configuration settings in <i>etc</i> [sisu
-
-<p>&nbsp;version]/sisurc.yml or in ~/.sisu/sisurc.yml
-<p> * configuration file - a yaml
-
-<p>file
-<p> /etc/sisu/[sisu &nbsp;version]/sisurc.yml<br>
-
-<p> ~/.sisu/sisurc.yml<br>
-
-<p> * directory structure - setting up of output and working directory.
-<p>
-* skins - changing the appearance of a project, directory or individual
-
-<p>documents within ~/.sisu/skin
-<p> ~/.sisu/skin/doc contains individual skins,
-with symbolic links from<br>
-
-<p> ~/.sisu/skin/dir if the contents of a directory are to take a particular<br>
- document skin.<br>
-
-<p> * additional software - eg. Tex and LaTeX (tetex, tetex-base, tetex-extra
-on <b>Debian</b> ), Postgresql, &nbsp;[sqlite], trang, tidy, makeinfo, ... none of which
-are required for basic html or XML processing.
-<p> * if you use Vim as editor
-there is a syntax highlighter and fold resource config file for <b>SiSU</b> <i>hope</i>
-more syntax highlighters follow.
-<p> There are post installation steps (which
-are really part of the overall installation)
-<p> sisu -C in your marked up
-document directory, should do some auto-configuring provided you have the
-right permissions for the output directories. (and provided the output directories
-have already been specified if you are not using the defaults).
-<p> 6.6 USE
-
-<p>GENERAL OVERVIEW
-<p> Documents are marked up in <b>SiSU</b> syntax and kept in an
-ordinary text editable file, named with the suffix .sst, or .ssm
-<p> Marked
-
-<p>up <b>SiSU</b> documents are usually kept in a sub-directory of your choosing
-<p>
- use the interactive help and man pages
-<p> sisu --help<br>
-
-<p> man sisu<br>
-
-<p> 6.7 HELP
-<p> interactive help described below, or man page:
-<p> man sisu<br>
-
-<p> man 8 sisu<br>
-
-<p> &rsquo;man sisu_markup-samples&rsquo; &nbsp;[if &nbsp;the &nbsp;sisu-markup-samples &nbsp;package &nbsp;is &nbsp;also &nbsp;installed]
-
-<p> Once installed an interactive help is available typing &rsquo;sisu&rsquo; (without)
-any flags, and select an option:
-<p> sisu<br>
-
-<p> alternatively, you could type e.g.
-<p> sisu --help commands<br>
-
-<p> sisu --help env<br>
-
-<p> sisu --help headers<br>
-
-<p> sisu --help markup<br>
-
-<p> sisu --help headings<br>
-
-<p> etc.
-<p> for questions about mappings, output paths etc.
-<p> sisu --help env<br>
-
-<p> sisu --help path<br>
-
-<p> sisu --help directory<br>
-
-<p> 6.8 DIRECTORY STRUCTURE
-<p> Once installed, type:
-<p> sisu --help env<br>
-
-<p> or
-<p> sisu -V<br>
-
-<p> 6.9 CONFIGURATION FILE
-<p> The defaults can be changed via <b>SiSU</b> &rsquo;s configure
-file sisurc.yml which the program expects to find in ./_sisu ~/.sisu or /etc/sisu
-(searched in that order, stopping on the first one found)
-<p> 6.10 MARKUP
-<p>
- See man pages.
-<p> man sisu<br>
-
-<p> man 8 sisu<br>
-
-<p> Once installed there is some information on <b>SiSU</b> Markup in its help:
-
-<p> sisu --help markup<br>
-
-<p> and
-<p> sisu --help headers<br>
-
-<p> Sample marked up document are provided with the download tarball in
-the directory:
-<p> ./data/doc/sisu/sisu_markup_samples/dfsg<br>
-
-<p> These are installed on the system usually at:
-<p> /usr/share/doc/sisu/sisu_markup_samples/dfsg<br>
-
-<p> More markup samples are available in the package sisu-markup-samples
-<p>
- &lt;<a href='http://www.jus.uio.no/sisu/SiSU/download.html#sisu-markup-samples'>http://www.jus.uio.no/sisu/SiSU/download.html#sisu-markup-samples</a>
-&gt;<br>
-
-<p> Many more are available online off:
-<p> &lt;<a href='http://www.jus.uio.no/sisu/SiSU/2.html'>http://www.jus.uio.no/sisu/SiSU/2.html</a>
-&gt;<br>
-
-<p> 6.11 ADDITIONAL THINGS
-<p> There is syntax support for some editors provided
-(together with a README file) in
-<p> ./data/sisu/conf/syntax<br>
-
-<p> usually installed to:
-<p> /usr/share/sisu/conf/syntax<br>
-
-<p> 6.12 LICENSE
-<p> License: GPL 3 or later see the copyright file in
-<p> ./data/doc/sisu<br>
-
-<p> usually installed to:
-<p> /usr/share/doc/sisu<br>
-
-<p> 6.13 SISU STANDARD
-<p> <b>SiSU</b> uses:
-<p> * Standard <b>SiSU</b> markup syntax,
-<p> * Standard
-<b>SiSU</b> meta-markup syntax, and the
-<p> * Standard <b>SiSU</b> object citation numbering
-
-<p>and system
-<p> Â&copy; Ralph Amissah 1997, current 2006 All Rights Reserved.
-<p> *
-
-<p>however note the License section
-<p> CHANGELOG
-<p> ./CHANGELOG<br>
-
-<p> and see
-<p> &lt;<a href='http://www.jus.uio.no/sisu/SiSU/changelog.html'>http://www.jus.uio.no/sisu/SiSU/changelog.html</a>
-&gt;<br>
-
-<p> &lt;<a href='http://www.jus.uio.no/sisu/SiSU/changelog_markup_samples.html'>http://www.jus.uio.no/sisu/SiSU/changelog_markup_samples.html</a>
-&gt;<br>
-
-<p> EXTRACTS FROM MAN 8 SISU
-<p> 7. POST INSTALLATION SETUP
-<p> 7.1 POST INSTALLATION
-SETUP - QUICK START
-<p> After installation of sisu-complete, move to the document
-samples directory,
-<p> cd /usr/share/doc/sisu/sisu_markup_samples/dfsg<br>
-
-<p> [this &nbsp;is &nbsp;not &nbsp;where &nbsp;you &nbsp;would &nbsp;normally &nbsp;work &nbsp;but &nbsp;provides sample &nbsp;documents
-&nbsp;for &nbsp;testing, &nbsp;you &nbsp;may &nbsp;prefer &nbsp;instead &nbsp;to &nbsp;copy &nbsp;the &nbsp;contents &nbsp;of &nbsp;that &nbsp;directory
-&nbsp;to &nbsp;a &nbsp;local &nbsp;directory &nbsp;before &nbsp;proceeding]
-<p> and in that directory, initialise
-
-<p>the output directory with the command
-<p> sisu -CC<br>
-
-<p> then run:
-<p> sisu -1 free_as_in_freedom.rms_and_free_software.sam_williams.sst<br>
-
-<p> or the same:
-<p> sisu -NhwpoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst<br>
-
-<p> look at output results, see the
-<p> for an overview of your current sisu
-setup, type:
-<p> sisu --help env<br>
-
-<p> or
-<p> sisu -V<br>
-
-<p> To generate a document from a remote url accessible location move to
-a writable directory, (create a work directory and cd into it) as the file
-will be downloaded there and e.g.
-<p> sisu -1 &lt;<a href='http://www.jus.uio.no/sisu/gpl3.fsf/gpl3.fsf.sst'>http://www.jus.uio.no/sisu/gpl3.fsf/gpl3.fsf.sst</a>
-&gt;<br>
-
-<p> sisu -3<br>
- &lt;<a href='http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst'>http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst</a>
-&gt;<br>
-
-<p> examine source document, vim has syntax highlighting support
-<p> gvim
-
-<p>free_as_in_freedom.rms_and_free_software.sam_williams.sst
-<p> additional markup
-
-<p>samples in
-<p> &lt;<a href='http://www.jus.uio.no/sisu/SiSU/2.html'>http://www.jus.uio.no/sisu/SiSU/2.html</a>
-&gt;<br>
-
-<p> it should also be possible to run sisu against sisupods (prepared zip
-files, created by running the command sisu -S &nbsp;[filename]), whether stored
-locally or remotely.
-<p> sisu -3<br>
- &lt;<a href='http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip'>http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip</a>
-&gt;<br>
-
-<p> there is a security issue associated with the running of document skins
-that are not your own, so these are turned of by default, and the use of
-the following command, which switches on the associated skin is not recommended:
-
-<p> sisu -3 --trust<br>
- &lt;<a href='http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip'>http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip</a>
-&gt;<br>
-
-<p> For help
-<p> man sisu<br>
-
-<p> sisu --help<br>
-
-<p> sisu --help env for the way sisu<br>
-
-<p> sisu --help commands for list of commands and so on<br>
-
-<p> 7.2 DOCUMENT MARKUP DIRECTORY
-<p> Perhaps the easiest way to begin is to
-create a directory for sisu marked up documents within your home directory,
-and copy the file structure (and document samples) provided in the document
-sample directory:
-<p> mkdir ~/sisu_test<br>
-
-<p> cd ~/sisu_test<br>
-
-<p> cp -a /usr/share/doc/sisu/sisu_markup_samples/dfsg/* ~/sisu_test/.<br>
-
-<p> <b>Tip:</b> the markup syntax examples may be of interest
-<p> &lt;<a href='http://www.jus.uio.no/sisu/sample/'>http://www.jus.uio.no/sisu/sample/</a>
-&gt;<br>
-
-<p> <b>Tip:</b>
-<p> sisu -U &nbsp;[sisu &nbsp;markup &nbsp;filename]<br>
-
-<p> should printout the different possible outputs and where sisu would
-place them.
-<p> <b>Tip:</b> if you want to toggle ansi color add
-<p> c<br>
-
-<p> to your flags.
-<p> 7.2.1 CONFIGURATION FILES
-<p> <b>SiSU</b> configuration file search
-path is:
-<p> ./_sisu/sisurc.yaml<br>
-
-<p> ~/.sisu/sisurc.yaml<br>
-
-<p> /etc/sisu/sisurc.yaml<br>
-
-<p> <b>Debian</b> Installation Note
-<p> 7.2.2 DEBIAN INSTALLATION NOTE
-<p> It is best
-
-<p>you see
-<p> &lt;<a href='http://www.jus.uio.no/sisu/SiSU/download.html#debian'>http://www.jus.uio.no/sisu/SiSU/download.html#debian</a>
-&gt;<br>
-
-<p> for up the most up to date information.
-<p> notes taken from the <b>Debian</b>
-control file (end edited), gives an idea of additional packages that <b>SiSU</b>
-can make use of if available, (the use/requirement of some of which are
-interdependent for specific actions by <b>SiSU</b> ):
-<p> Package: sisu
-<p> <b>SiSU</b> is
-a lightweight markup based, command line oriented, document structuring,
-publishing and search framework for document collections.
-<p> With minimal
-preparation of a plain-text, (UTF-8) file, using its native markup syntax
-in your text editor of choice, <b>SiSU</b> can generate various document formats
-(most of which share a common object numbering system for locating content),
-including plain text, HTML, XHTML, XML, OpenDocument text (ODF:ODT), LaTeX,
-PDF files, and populate an SQL database with objects (roughly paragraph-sized
-chunks) so searches may be performed and matches returned with that degree
-of granularity: your search criteria is met by these documents and at these
-locations within each document. Object numbering is particularly suitable
-for opposed to works that are frequently changed or updated) for which
-it provides a fixed means of reference of content. Document outputs also
-share semantic meta-data provided.
-<p> <b>SiSU</b> also provides concordance files,
-document content certificates and manifests of generated output.
-<p> A vim
-syntax highlighting file and an ftplugin with folds for sisu markup is
-provided, as are syntax highlighting files for kate, kwrite, gedit and
-diakonos. Vim 7 includes syntax highlighting for <b>SiSU</b>
-<p> man pages, and
-interactive help are provided.
-<p> Dependencies for various features are taken
-care of in sisu related packages. The package sisu-complete installs the
-whole of <b>SiSU</b>
-<p> Additional document markup samples are provided in the
-package sisu-markup-samples which is found in the non-free archive the licenses
-for the substantive content of the marked up documents provided is that
-provided by the author or original publisher.
-<p> Homepage: &lt;<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
-&gt;
-
-<p> 7.2.3 DOCUMENT RESOURCE CONFIGURATION
-<p> <b>sisu</b> resource configuration information
-is obtained from sources (where they exist):
-<p> ~/.sisu/sisurc.yaml<br>
-
-<p> /etc/sisu/[sisu &nbsp;version]/sisurc.yaml<br>
-
-<p> sisu program defaults<br>
-
-<p> 7.2.4 SKINS
-<p> <b>Skins</b> default document appearance may be modified using skins
-contained in sub-directories located at the following paths:
-<p> ./_sisu/skin<br>
-
-<p> ~/.sisu/skin<br>
-
-<p> /etc/sisu/skin<br>
-
-<p> more specifically, the following locations (or their /etc/sisu equivalent)
-should be used:
-<p> ~/.sisu/skin/doc<br>
-
-<p> skins for individual documents;
-<p> ~/.sisu/skin/dir<br>
-
-<p> skins for directories of matching names;
-<p> ~/.sisu/skin/site<br>
-
-<p> site-wide skin modifying the site-wide appearance of documents.
-<p> Usually
-all skin files are placed in the document skin directory:
-<p> ~/.sisu/skin/doc<br>
-
-<p> with softlinks being made to the skins contained there from other skin
-directories as required.
-<p> DOCUMENT INFORMATION (METADATA)
-<p> METADATA
-<p>
-Document Manifest @ &lt;<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_howto/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_howto/sisu_manifest.html</a>
-&gt;
-
-<p> <b>Dublin Core</b> (DC)
-<p> <i>DC</i> tags included with this document are provided here.
-
-<p> DC Title: <i>SiSU</i> - Technical, Howto
-<p> DC Creator: <i>Ralph</i> Amissah
-<p> DC Rights:
-<i>Copyright</i> (C) Ralph Amissah 2007, part of SiSU documentation, License GPL
-
-<p>3
-<p> DC Type: <i>information</i>
-<p> DC Date created: <i>2002-11-12</i>
-<p> DC Date issued:
-
-<p><i>2002-11-12</i>
-<p> DC Date available: <i>2002-11-12</i>
-<p> DC Date modified: <i>2007-09-16</i>
-<p> DC
-Date: <i>2007-09-16</i>
-<p> <b>Version Information</b>
-<p> Sourcefile: <i>sisu_howto.sst</i>
-<p> Filetype:
-
-<p><i>SiSU</i> text insert 0.57
-<p> Sourcefile Digest, MD5(sisu_howto.sst)= <i>bb17770a0fa5b4ef035ebf0bcfca3faa</i>
-
-<p> Skin_Digest: MD5(/home/ralph/grotto/theatre/dbld/sisu-dev/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)=
-
-<p><i>20fc43cf3eb6590bc3399a1aef65c5a9</i>
-<p> <b>Generated</b>
-<p> Document (metaverse) last
-generated: <i>Mon</i> Sep 24 15:36:16 +0100 2007
-<p> Generated by: <i>SiSU</i> <i>0.59.0</i> of
-2007w38/0 (2007-09-23)
-<p> Ruby version: <i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36)
-&nbsp;[i486-linux]
-<p>
-<ol>
-<b>.</b><li>generated from source using rman &lt;<a href='http://polyglotman.sourceforge.net/rman.html'>http://polyglotman.sourceforge.net/rman.html</a>
-&gt;<br>
- With regard to<br>
- <b>SiSU</b> man pages the formatting generated for markup syntax is not quite
-right, for that you might prefer the links under: &lt;<a href='http://www.jus.uio.no/sample'>http://www.jus.uio.no/sample</a>
-&gt;<br>
- </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>&lt;<a href='http://www.jus.uio.no/sisu/man/sisu.8.html'>http://www.jus.uio.no/sisu/man/sisu.8.html</a>
-&gt;
-</li><b>.</b><li>&lt;<a href='http://www.jus.uio.no/sisu/man/sisu_examples.1.html'>http://www.jus.uio.no/sisu/man/sisu_examples.1.html</a>
-&gt; </li><b>.</b><li>&lt;<a href='http://www.jus.uio.no/sisu/man/sisu_webrick.1.html'>http://www.jus.uio.no/sisu/man/sisu_webrick.1.html</a>
-&gt;
-</li><b>.</b><li>this is an endnote </li><b>.</b><li>&lt;<a href='http://sisudoc.org'>http://sisudoc.org</a>
-&gt; </li><b>.</b><li>&lt;<a href='http://sisudoc.org'>http://sisudoc.org</a>
-&gt;
-<p> </dd>
-
-<dt>Other versions
-of this document: </dt>
-<dd></dd>
-
-<dt>manifest: &lt;<a href='http://www.jus.uio.no/sisu/sisu_howto/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_howto/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_howto/sisu_manifest.html</a>
-</a>
-&gt;
-</dt>
-<dd></dd>
-
-<dt>html: &lt;<a href='http://www.jus.uio.no/sisu/sisu_howto/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_howto/toc.html'>http://www.jus.uio.no/sisu/sisu_howto/toc.html</a>
-</a>
-&gt; </dt>
-<dd></dd>
-
-<dt>pdf: &lt;<a href='http://www.jus.uio.no/sisu/sisu_howto/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_howto/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_howto/portrait.pdf</a>
-</a>
-&gt;
-</dt>
-<dd></dd>
-
-<dt>pdf: &lt;<a href='http://www.jus.uio.no/sisu/sisu_howto/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_howto/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_howto/landscape.pdf</a>
-</a>
-&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>
-<dd></dd>
-
-<dt>* Generated by: SiSU 0.59.0 of 2007w38/0 (2007-09-23) </dt>
-<dd></dd>
-
-<dt>* Ruby version: ruby
-1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt>
-<dd></dd>
-
-<dt>* Last Generated on: Mon Sep 24
-15:36:31 +0100 2007 </dt>
-<dd></dd>
-
-<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
- </dt>
-<dd></dd>
-</dl>
-<p>
-</body>
-</html>