diff options
| -rw-r--r-- | data/doc/sisu/html/sisu_commands.1.html | 553 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu_configuration.1.html | 254 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu_doc.7.html | 121 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu_faq.8.html | 273 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu_help.1.html | 213 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu_help_sources.1.html | 582 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu_howto.8.html | 1447 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu_markup.1.html | 1113 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu_quickstart.8.html | 332 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu_remote.8.html | 189 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu_search.8.html | 512 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu_skin.1.html | 162 | ||||
| -rw-r--r-- | data/doc/sisu/html/sisu_syntax_highlighting.8.html | 219 |
13 files changed, 0 insertions, 5970 deletions
diff --git a/data/doc/sisu/html/sisu_commands.1.html b/data/doc/sisu/html/sisu_commands.1.html deleted file mode 100644 index e519713e..00000000 --- a/data/doc/sisu/html/sisu_commands.1.html +++ /dev/null @@ -1,553 +0,0 @@ -<!-- manual page source format generated by PolyglotMan v3.2, --> -<!-- available at http://polyglotman.sourceforge.net/ --> - -<html> -<head> -<title>"sisu_commands"("1") manual page</title> -</head> -<body bgcolor='white'> -<a href='#toc'>Table of Contents</a><p> -SISU - COMMANDS, RALPH AMISSAH -<p> SISU COMMANDS -<p> 1. COMMANDS SUMMARY -<p> 1.1 - -<p>SYNOPSIS -<p> <b>SiSU</b> - Structured information, Serialized Units - a document publishing - -<p>system -<p> sisu [ -abcDdFHhIiMmNnopqRrSsTtUuVvwXxYyZz0-9 ] [ filename/ -<p> sisu - [ -Ddcv ] [ instruction ] -<p> sisu [ -CcFLSVvW ] -<p> Note: commands should be -issued from within the directory that contains the marked up files, cd -to markup directory. -<p> 1.2 DESCRIPTION -<p> <b>SiSU</b> <b>SiSU</b> is a document publishing -system, that from a simple single marked-up document, produces multiple -of output formats including: plaintext, html, LaTeX, pdf, xhtml, XML, info, -and SQL (PostgreSQL and SQLite), which share numbered text objects ( structure -information. For more see: <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> -> -<p> 1.3 DOCUMENT PROCESSING - -<p>COMMAND FLAGS -<p> -<dl> - -<dt><b> -a [filename/wildcard]</b> </dt> -<dd>produces plaintext with Unix linefeeds -and without markup, (object numbers are omitted), has footnotes at end -of each paragraph that contains them [ -A for equivalent dos (linefeed) - output file] [see -e for endnotes]. (Options include: --endnotes for endnotes ---footnotes for footnotes at the end of each paragraph --unix for unix linefeed -(default) --msdos for msdos linefeed) -<p> </dd> - -<dt><b> -b [filename/wildcard]</b> </dt> -<dd>produces xhtml/XML -output for browser viewing (sax parsing). -<p> </dd> - -<dt><b> -C [--init-site]</b> </dt> -<dd>configure/initialise -shared output directory files initialize shared output directory (config -files such as css and dtd files are not updated if they already exist unless -modifier is used). -C --init-site configure/initialise site more extensive than --C on its own, shared output directory files/force update, existing shared -output config files such as css and dtd files are updated if this modifier -is used. -<p> </dd> - -<dt><b> -CC</b> </dt> -<dd> configure/initialise shared output directory files initialize -shared output directory (config files such as css and dtd is used). The - equivalent of: -C --init-site configure/initialise site, more extensive than - -C on its own, shared output directory files/force update, existing shared -output config files such as css and dtd files are updated if -CC is used. -such as css and dtd files are updated -<p> </dd> - -<dt><b> -c [filename/wildcard]</b> </dt> -<dd>screen toggle -ansi screen colour on or off depending on default set (unless -c flag is -used: if sisurc colour default is set to ’true’, output to screen will be -with colour, if sisurc colour default is set to ’false’ or is undefined screen -output will be without colour). -<p> </dd> - -<dt><b> -D [instruction] [filename]</b> </dt> -<dd>database postgresql -( --pgsql may be used instead) possible instructions, include: --createdb; ---create; --dropall; --import [filename]; --update [filename]; --remove [filename]; -see database section below. -<p> </dd> - -<dt><b> -d [--db-[database type (sqlite|pg)]] --[instruction] -</dt> -<dd>[filename] database type default set to sqlite, (for which --sqlite may be -used instead) or to specify another database --db-[pgsql, sqlite] (however -see -D) possible instructions include: --createdb; --create; --dropall; --import - [filename]; --update [filename]; --remove [filename]; see database section -below. -<p> </dd> - -<dt><b> -F [--webserv=webrick]</b> </dt> -<dd>generate examples of (naive) cgi search form -for sqlite and pgsql depends on your already having used sisu to populate -an sqlite and/or pgsql database, (the sqlite version scans the output directories -for existing sisu_sqlite databases, so it is first necessary to create -them, before generating the search form) see -d -D and the database section -below. If the optional parameter --webserv=webrick is passed, the cgi examples -created will be set up to use the default port set for use by the webrick -server, (otherwise the port is left blank and the system setting used, -usually 80). The samples are dumped in the present work directory which -must be writable, (with screen instructions given that they be copied to -the cgi-bin directory). -Fv (in addition to the above) provides some information - -<p>on setting up hyperestraier for sisu -<p> </dd> - -<dt><b> -H [filename/wildcard]</b> </dt> -<dd>produces html -without link suffixes (.html .pdf etc.) ( an appropriately configured web -server. [behaviour switched after 0.35 see -h]. -<p> </dd> - -<dt><b> -h [filename/wildcard]</b> </dt> -<dd>produces -html (with hardlinks i.e. with name suffixes in links/local urls). html, with -internal document links that include the document suffix, i.e. whether it -is .html or .pdf (required for browsing directly off a file system, and works -with most web servers). [behaviour switched after -<p> </dd> - -<dt><b> -I [filename/wildcard]</b> -</dt> -<dd>produces texinfo and info file, (view with pinfo). -<p> </dd> - -<dt><b> -L</b> </dt> -<dd> prints license information. - -<p> </dd> - -<dt><b> -M [filename/wildcard/url]</b> </dt> -<dd>maintenance mode files created for processing -preserved and their locations indicated. (also see -V) -<p> </dd> - -<dt><b> -m [filename/wildcard/url]</b> -</dt> -<dd>assumed for most other flags, creates new meta-markup file, (the metaverse -) that is used in all subsequent processing of other output. This step is -assumed for most processing flags. To skip it see -n -<p> </dd> - -<dt><b> -N [filename/wildcard/url]</b> -</dt> -<dd>document digest or document content certificate ( DCC ) as md5 digest tree -of the document: the digest for the document, and digests for each object -contained within the document (together with information on software versions -that produced it) (digest.txt). -NV for verbose digest output to screen. -<p> </dd> - -<dt><b> -n - [filename/wildcard/url]</b> </dt> -<dd>skip meta-markup (building of -m which is otherwise -assumed by most processing flags. -<p> </dd> - -<dt><b> -o [filename/wildcard/url]</b> </dt> -<dd>output basic -document in opendocument file format (opendocument.odt). -<p> </dd> - -<dt><b> -p [filename/wildcard]</b> -</dt> -<dd>produces LaTeX pdf (portrait.pdf & landscape.pdf). Default paper size is set -in config file, or document header, or provided with additional command -line parameter, e.g. --papersize-a4 preset sizes include: ’A4’, U.S. ’letter’ and -’legal’ and book sizes ’A5’ and ’B5’ (system defaults to A4). -<p> </dd> - -<dt><b> -q [filename/wildcard]</b> -</dt> -<dd>quiet less output to screen. -<p> </dd> - -<dt><b> -R [filename/wildcard]</b> </dt> -<dd>copies sisu output files -to remote host using rsync. This requires that sisurc.yml has been provided -with information on hostname and username, and that you have your different -if -R is used with other flags from if used alone. Alone the rsync --delete -parameter is sent, useful for cleaning the remote directory (when -R is -used together with other flags, it is not). Also see -r -<p> </dd> - -<dt><b> -r [filename/wildcard]</b> -</dt> -<dd>copies sisu output files to remote host using scp. This requires that sisurc.yml -has been provided with information on hostname and username, and that you - -<p>have your -<p> </dd> - -<dt><b> -S</b> </dt> -<dd> produces a sisupod a zipped sisu directory of markup local - configuration file, images and skins. Note: this only includes the configuration - files or skins contained in ./_sisu not those in ~/.sisu -S [filename/wildcard] -option. Note: (this option is tested only with zsh). -<p> </dd> - -<dt><b> -S [filename/wildcard]</b> -</dt> -<dd>produces a zipped file of the prepared document specified along with associated -images, by default named sisupod.zip they may alternatively be named with -the filename extension .ssp This provides a quick way of gathering the relevant -parts of a sisu document which can then for example be emailed. A sisupod -includes sisu markup source file, (along with associated documents if a -master file, or available in multilingual versions), together with related -images and skin. <b>SiSU</b> commands can be run directly against a sisupod contained -in a local directory, or provided as a url on a remote site. As there is -a security issue with skins provided by other users, they are not applied -unless the flag --trust or --trusted is added to the command instruction, it -is recommended that file that are not your own are treated as untrusted. -The directory structure of the unzipped file is understood by sisu, and -sisu commands can be run within it. Note: if you wish to send multiple files, -it quickly becomes more space efficient to zip the sisu markup directory, -rather than the individual files for sending). See the -S option without - -<p> </dd> - -<dt><b> -s [filename/wildcard]</b> </dt> -<dd>copies sisu markup file to output directory. -<p> </dd> - -<dt><b> -t [filename/wildcard - (*.termsheet.rb)]</b> </dt> -<dd>standard form document builder, preprocessing feature -<p> -</dd> - -<dt><b> -U [filename/wildcard]</b> </dt> -<dd>prints url output list/map for the available processing -flags options and resulting files that could be requested, (can be used -to get a list of processing options in relation to a file, together with -information on the output that would be produced), -u provides url output -mapping for those flags requested for processing. The default assumes sisu_webrick -is running and provides webrick url mappings where appropriate, but these - -<p>can be switched to file system paths in sisurc.yml -<p> </dd> - -<dt><b> -u [filename/wildcard]</b> -</dt> -<dd>provides url mapping of output files for the flags requested for processing, - -<p>also see -U -<p> </dd> - -<dt><b> -V</b> </dt> -<dd> on its own, provides <b> SiSU</b> version and environment information - (sisu --help env) -<p> </dd> - -<dt><b> -V [filename/wildcard]</b> </dt> -<dd>even more verbose than the -v flag. -(also see -M) -<p> </dd> - -<dt><b> -v</b> </dt> -<dd> on its own, provides <b> SiSU</b> version information -<p> </dd> - -<dt><b> -v [filename/wildcard]</b> -</dt> -<dd>provides verbose output of what is being built, where it is being built -(and error messages if any), as with -u flag provides a url mapping of files -created for each of the processing flag requests. See also -V -<p> </dd> - -<dt><b> -W</b> </dt> -<dd> starts ruby’s - webrick webserver points at sisu output the default port is set to 8081 - and can be [tip: the so html output should be created using the -h option - rather than -H; also, note -F webrick ]. -<p> </dd> - -<dt><b> -w [filename/wildcard]</b> </dt> -<dd>produces concordance -(wordmap) a rudimentary index of all the words in a document. (Concordance -files are not generated for documents of over 260,000 words unless this -limit is increased in the file sisurc.yml) -<p> </dd> - -<dt><b> -X [filename/wildcard]</b> </dt> -<dd>produces -XML output with deep document structure, in the nature of dom. -<p> </dd> - -<dt><b> -x [filename/wildcard]</b> -</dt> -<dd>produces XML output shallow structure (sax parsing). -<p> </dd> - -<dt><b> -Y [filename/wildcard]</b> -</dt> -<dd>produces a short sitemap entry for the document, based on html output and -the sisu_manifest. --sitemaps generates/updates the sitemap index of existing -sitemaps. (Experimental, [g,y,m announcement this week]) -<p> </dd> - -<dt><b> -y [filename/wildcard]</b> -</dt> -<dd>produces an html summary of output generated (hyperlinked to content) and -document specific metadata (sisu_manifest.html). This step is assumed for -most processing flags. -<p> </dd> - -<dt><b> -Z [filename/wildcard]</b> </dt> -<dd>Zap, if used with other processing -flags deletes output files of the type about to be processed, prior to -processing. If -Z is used as the lone processing related flag (or in conjunction -with a combination of -[mMvVq]), will remove the related document output -directory. -<p> </dd> - -<dt><b> -z [filename/wildcard]</b> </dt> -<dd>produces php (zend) [this feature is disabled - for the time being] -<p> </dd> -</dl> -2. COMMAND LINE MODIFIERS -<p> -<dl> - -<dt><b> --no-ocn</b> </dt> -<dd> [with -h -H or -p] switches -off object citation numbering. Produce output without identifying numbers -in margins of html or LaTeX/pdf output. -<p> </dd> - -<dt><b> --no-annotate</b> </dt> -<dd> strips output text of - editor endnotes[^*1] denoted by asterisk or dagger/plus sign -<p> </dd> - -<dt><b> --no-asterisk</b> -</dt> -<dd> strips output text of editor endnotes[^*2] denoted by asterisk sign -<p> </dd> - -<dt><b> --no-dagger</b> -</dt> -<dd> strips output text of editor endnotes[^+1] denoted by dagger/plus sign -<p> -</dd> -</dl> -3. DATABASE COMMANDS -<p> dbi - database interface -<p> -D or --pgsql set for postgresql --d or --sqlite default set for sqlite -d is modifiable with --db=[database type - (pgsql or sqlite)] -<p> -<dl> - -<dt><b> -Dv --createall</b> </dt> -<dd> initial step, creates required relations - (tables, indexes) in existing postgresql database (a database should be - created manually and given the same name as working directory, as requested) - (rb.dbi) [ -dv --createall sqlite equivalent] it may be necessary to run sisu --Dv --createdb initially NOTE: at the present time for postgresql it may be -necessary to manually create the database. The command would be ’createdb - [database name]’ where database name would be SiSU_[present working directory - name (without path)]. Please use only alphanumerics and underscores. -<p> </dd> - -<dt><b> -Dv - --import</b> </dt> -<dd> [filename/wildcard] imports data specified to postgresql db (rb.dbi) - [ -dv --import sqlite equivalent] -<p> </dd> - -<dt><b> -Dv --update</b> </dt> -<dd> [filename/wildcard] updates/imports -specified data to postgresql db (rb.dbi) [ -dv --update sqlite equivalent] - -<p> </dd> - -<dt><b> -D --remove</b> </dt> -<dd> [filename/wildcard] removes specified data to postgresql db (rb.dbi) - [ -d --remove sqlite equivalent] -<p> </dd> - -<dt><b> -D --dropall</b> </dt> -<dd> kills data & indexes [ -d --dropall - sqlite equivalent] -<p> The v in e.g. -Dv is for verbose output. -<p> </dd> -</dl> -4. SHORTCUTS, -SHORTHAND FOR MULTIPLE FLAGS -<p> -<dl> - -<dt><b> --update [filename/wildcard]</b> </dt> -<dd>Checks existing -file output and runs the flags required to update this output. This means -that if only html and pdf output was requested on previous runs, only the --hp files will be applied, and only these will be generated this time, together -with the summary. This can be very convenient, if you offer different outputs -of different files, and just want to do the same again. -<p> </dd> - -<dt><b> -0 to -5 [filename - or wildcard]</b> </dt> -<dd>Default shorthand mappings (note that the defaults can be -changed/configured in the sisurc.yml file): -<p> </dd> - -<dt><b> -0</b> </dt> -<dd> -mNhwpAobxXyYv [this is the - default action run when no i.e. on ’sisu [filename]’] -<p> </dd> - -<dt><b> -1</b> </dt> -<dd> -mNHwpy give, i.e. on - ’sisu [filename]’] -<p> </dd> - -<dt><b> -2</b> </dt> -<dd> -mNHwpaoy give, i.e. on ’sisu [filename]’] -<p> </dd> - -<dt><b> -3</b> </dt> -<dd> -mNhwpAobxXyY - i.e. on ’sisu [filename]’] -<p> </dd> - -<dt><b> -4</b> </dt> -<dd> -mNhwpAobxXDyY --import ’sisu [filename]’] -<p> </dd> - -<dt><b> -5</b> </dt> -<dd> -mNhwpAobxXDyY - --update ’sisu [filename]’] -<p> add -v for verbose mode and -c for color, e.g. sisu --2vc [filename or wildcard] -<p> consider -u for appended url info or -v for - -<p>verbose output -<p> </dd> -</dl> -4.0.1 COMMAND LINE WITH FLAGS - BATCH PROCESSING -<p> In the -data directory run sisu -mh filename or wildcard eg. cisg.sst documents. -<p> -Running sisu (alone without any flags, filenames or wildcards) brings up -the interactive help, as does any sisu command that is not recognised. Enter -to escape. -<p> DOCUMENT INFORMATION (METADATA) -<p> METADATA -<p> Document Manifest -@ <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_commands/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_commands/sisu_manifest.html</a> -> -<p> - <b>Dublin Core</b> (DC) -<p> <i>DC</i> tags included with this document are provided here. - -<p> DC Title: <i>SiSU</i> - Commands -<p> DC Creator: <i>Ralph</i> Amissah -<p> DC Rights: <i>Copyright</i> -(C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 -<p> DC -Type: <i>information</i> -<p> DC Date created: <i>2002-08-28</i> -<p> DC Date issued: <i>2002-08-28</i> - -<p> DC Date available: <i>2002-08-28</i> -<p> DC Date modified: <i>2007-09-16</i> -<p> DC Date: <i>2007-09-16</i> - -<p> <b>Version Information</b> -<p> Sourcefile: <i>sisu_commands.sst</i> -<p> Filetype: <i>SiSU</i> text - -<p>0.58 -<p> Sourcefile Digest, MD5(sisu_commands.sst)= <i>68a4087f984baffbea779da25e1b6141</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:13 +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) - [i486-linux] -<p> -<dl> - -<dt><b>*1.</b> </dt> -<dd>square brackets </dd> - -<dt><b>*2.</b> </dt> -<dd>square brackets </dd> - -<dt><b>+1.</b> </dt> -<dd>square brackets -<p> -</dd> - -<dt>Other versions of this document: </dt> -<dd></dd> - -<dt>manifest: <<a href='http://www.jus.uio.no/sisu/sisu_commands/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_commands/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_commands/sisu_manifest.html</a> -</a> -> -</dt> -<dd></dd> - -<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_commands/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_commands/toc.html'>http://www.jus.uio.no/sisu/sisu_commands/toc.html</a> -</a> -> </dt> -<dd></dd> - -<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_commands/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_commands/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_commands/portrait.pdf</a> -</a> -> -</dt> -<dd></dd> - -<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_commands/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_commands/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_commands/landscape.pdf</a> -</a> -> </dt> -<dd> </dd> - -<dt>at: <<a href='http://www.jus.uio.no/sisu'><a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> -</a> -> -</dt> -<dd></dd> - -<dt>* Generated by: SiSU 0.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:30 +0100 2007 </dt> -<dd></dd> - -<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> - </dt> -<dd></dd> -</dl> -<p> -</body> -</html> diff --git a/data/doc/sisu/html/sisu_configuration.1.html b/data/doc/sisu/html/sisu_configuration.1.html deleted file mode 100644 index e3be86fe..00000000 --- a/data/doc/sisu/html/sisu_configuration.1.html +++ /dev/null @@ -1,254 +0,0 @@ -<!-- manual page source format generated by PolyglotMan v3.2, --> -<!-- available at http://polyglotman.sourceforge.net/ --> - -<html> -<head> -<title>"sisu_configuration"("1") manual page</title> -</head> -<body bgcolor='white'> -<a href='#toc'>Table of Contents</a><p> -SISU - CONFIGURATION, RALPH AMISSAH -<p> CONFIGURATION OF ENVIRONMENT -<p> 1. CONFIGURATION - -<p> 1.1 DETERMINING THE CURRENT CONFIGURATION -<p> Information on the current -configuration of <b>SiSU</b> should be available with the help command: -<p> sisu --v<br> - -<p> which is an alias for: -<p> sisu --help env<br> - -<p> Either of these should be executed from within a directory that contains -sisu markup source documents. -<p> 1.2 CONFIGURATION FILES (CONFIG.YML) -<p> <b>SiSU</b> -configration parameters are adjusted in the configuration file, which can -be used to override the defaults set. This includes such things as which -directory interim processing should be done in and where the generated -output should be placed. -<p> The <b>SiSU</b> configuration file is a yaml file, which -means indentation is significant. -<p> <b>SiSU</b> resource configuration is determined -by looking at the following files if they exist: -<p> ./_sisu/sisurc.yml<br> - -<p> ~/.sisu/sisurc.yml<br> - -<p> /etc/sisu/sisurc.yml<br> - -<p> The search is in the order listed, and the first one found is used. -<p> - In the absence of instructions in any of these it falls back to the internal -program defaults. -<p> Configuration determines the output and processing directories -and the database access details. -<p> If <b>SiSU</b> is installed a sample sisurc.yml - -<p>may be found in /etc/sisu/sisurc.yml -<p> CONFIGURATION OF DOCUMENTS -<p> 2. SKINS - -<p> Skins modify the default appearance of document output on a document, -directory, or site wide basis. Skins are looked for in the following locations: - -<p> ./_sisu/skin<br> - -<p> ~/.sisu/skin<br> - -<p> /etc/sisu/skin<br> - -<p> <b>Within the skin directory</b> are the following the default sub-directories -for document skins: -<p> ./skin/doc<br> - -<p> ./skin/dir<br> - -<p> ./skin/site<br> - -<p> A skin is placed in the appropriate directory and the file named skin_[name].rb - -<p> The skin itself is a ruby file which modifies the default appearances -set in the program. -<p> 2.1 DOCUMENT SKIN -<p> Documents take on a document skin, -if the header of the document specifies a skin to be used. -<p> -<p> <br> -<pre> @skin: skin_united_nations -</pre> -<p> 2.2 DIRECTORY SKIN -<p> A directory may be mapped on to a particular skin, -so all documents within that directory take on a particular appearance. -If a skin exists in the skin/dir with the same name as the document directory, -it will automatically be used for each of the documents in that directory, -(except where a document specifies the use of another skin, in the skin/doc -directory). -<p> A personal habit is to place all skins within the doc directory, -and symbolic links as needed from the site, or dir directories as required. - -<p> 2.3 SITE SKIN -<p> A site skin, modifies the program default skin. -<p> 2.4 SAMPLE - -<p>SKINS -<p> With <b>SiSU</b> installed sample skins may be found in: -<p> /etc/sisu/skin/doc -and<br> - /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc<br> - -<p> (or equivalent directory) and if sisu-markup-samples is installed also -under: -<p> /usr/share/doc/sisu/sisu_markup_samples/non-free/_sisu/skin/doc<br> - -<p> Samples of list.yml and promo.yml (which are used to create the right -column list) may be found in: -<p> /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml -(or equivalent<br> - directory)<br> - -<p> 3. HOMEPAGES -<p> <b>SiSU</b> is about the ability to auto-generate documents. Home -pages are regarded as custom built items, and are not created by <b>SiSU</b> -<b>SiSU</b> has a default home page, which will not be appropriate for use with -other sites, and the means to provide your own home page instead in one -of two ways as part of a site’s configuration, these being: -<p> 1. through -placing your home page and other custom built documents in the subdirectory -_sisu/home/ (this probably being the easier and more convenient option) - -<p> 2. through providing what you want as the home page in a skin, -<p> Document -sets are contained in directories, usually organised by site or subject. -Each directory can/should have its own homepage. See the section on directory -structure and organisation of content. -<p> 3.1 HOME PAGE AND OTHER CUSTOM BUILT - -<p>PAGES IN A SUB-DIRECTORY -<p> Custom built pages, including the home page index.html -may be placed within the configuration directory _sisu/home/ in any of -the locations that is searched for the configuration directory, namely -./_sisu; ~/_sisu; /etc/sisu From there they are copied to the root of the -output directory with the command: -<p> sisu -CC<br> - -<p> 3.2 HOME PAGE WITHIN A SKIN -<p> Skins are described in a separate section, -but basically are a file written in the programming language <b>Ruby</b> that -may be provided to change the defaults that are provided with sisu with -respect to individual documents, a directories contents or for a site. -<p> - If you wish to provide a homepage within a skin the skin should be in -the directory _sisu/skin/dir and have the name of the directory for which -it is to become the home page. Documents in the directory commercial_law -would have the homepage modified in skin_commercial law.rb; or the directory - -<p>poems in skin_poems.rb -<p> -<p> <br> -<pre> class Home - def homepage - # place the html content of your homepage here, this will become -index.html - <<HOME <html> - <head></head> - <doc> - <p>this is my new homepage.</p> - </doc> - </html> - HOME - end - end -</pre> -<p> DOCUMENT INFORMATION (METADATA) -<p> METADATA -<p> Document Manifest @ <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/sisu_manifest.html</a> -> - -<p> <b>Dublin Core</b> (DC) -<p> <i>DC</i> tags included with this document are provided here. - -<p> DC Title: <i>SiSU</i> - Configuration -<p> DC Creator: <i>Ralph</i> Amissah -<p> DC Rights: - -<p><i>Ralph</i> Amissah -<p> DC Type: <i>information</i> -<p> DC Date created: <i>2002-08-28</i> -<p> DC Date -issued: <i>2002-08-28</i> -<p> DC Date available: <i>2007-08-28</i> -<p> DC Date modified: <i>2007-08-30</i> - -<p> DC Date: <i>2007-08-30</i> -<p> <b>Version Information</b> -<p> Sourcefile: <i>sisu_configuration._sst</i> - -<p> Filetype: <i>SiSU</i> text insert 0.58 -<p> Sourcefile Digest, MD5(sisu_configuration._sst)= - -<p><i>491d3da039162d60ae0e2951aa260915</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:17 +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) - [i486-linux] -<p> -<p> -<dl> - -<dt>Other versions of this document: </dt> -<dd></dd> - -<dt>manifest: <<a href='http://www.jus.uio.no/sisu/sisu_configuration/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_configuration/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_configuration/sisu_manifest.html</a> -</a> -> -</dt> -<dd></dd> - -<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_configuration/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_configuration/toc.html'>http://www.jus.uio.no/sisu/sisu_configuration/toc.html</a> -</a> -> </dt> -<dd></dd> - -<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_configuration/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_configuration/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_configuration/portrait.pdf</a> -</a> -> -</dt> -<dd></dd> - -<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_configuration/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_configuration/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_configuration/landscape.pdf</a> -</a> -> </dt> -<dd> </dd> - -<dt>at: <<a href='http://www.jus.uio.no/sisu'><a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> -</a> -> -</dt> -<dd></dd> - -<dt>* Generated by: SiSU 0.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:32 +0100 2007 </dt> -<dd></dd> - -<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> - </dt> -<dd></dd> -</dl> -<p> -</body> -</html> diff --git a/data/doc/sisu/html/sisu_doc.7.html b/data/doc/sisu/html/sisu_doc.7.html deleted file mode 100644 index 2496c3b6..00000000 --- a/data/doc/sisu/html/sisu_doc.7.html +++ /dev/null @@ -1,121 +0,0 @@ -<!-- manual page source format generated by PolyglotMan v3.2, --> -<!-- available at http://polyglotman.sourceforge.net/ --> - -<html> -<head> -<title>"sisu_doc"("1") manual page</title> -</head> -<body bgcolor='white'> -<a href='#toc'>Table of Contents</a><p> -SISU - SISU-DOC, RALPH AMISSAH -<p> SISU DOC -<p> SISU-DOC -<p> 1.1 NAME -<p> <b>SiSU</b> - Structured -information, Serialized Units - a document publishing system. -<p> Information - -<p>related to sisu documentation -<p> 1.2 DESCRIPTION -<p> sisu documentation is installed - -<p>in /usr/share/doc/sisu/sisu_manual or equivalent directory -<p> file:///usr/share/doc/sisu/sisu_manual - -<p> file:///usr/share/doc/sisu/sisu_manual/sisu_manual/ -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual'>http://www.jus.uio.no/sisu/sisu_manual</a> -> - -<p> <<a href='http://www.sisudoc.org/sisu_manual'>http://www.sisudoc.org/sisu_manual</a> -> -<p> DOCUMENT INFORMATION (METADATA) -<p> METADATA - -<p> Document Manifest @ <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_doc/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_doc/sisu_manifest.html</a> -> - -<p> <b>Dublin Core</b> (DC) -<p> <i>DC</i> tags included with this document are provided here. - -<p> DC Title: <i>SiSU</i> - sisu-doc -<p> DC Creator: <i>Ralph</i> Amissah -<p> DC Rights: <i>Copyright</i> -(C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 -<p> DC -Type: <i>information</i> -<p> DC Date created: <i>2007-09-24</i> -<p> DC Date issued: <i>2007-09-24</i> - -<p> DC Date available: <i>2007-09-24</i> -<p> DC Date modified: <i>2007-09-24</i> -<p> DC Date: <i>2007-09-24</i> - -<p> <b>Version Information</b> -<p> Sourcefile: <i>sisu_doc.sst</i> -<p> Filetype: <i>SiSU</i> text 0.58 - -<p> Sourcefile Digest, MD5(sisu_doc.sst)= <i>00116fb664a23c87ce52dbe0d4c5a702</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:19 +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) - [i486-linux] -<p> -<p> -<dl> - -<dt>Other versions of this document: </dt> -<dd></dd> - -<dt>manifest: <<a href='http://www.jus.uio.no/sisu/sisu_doc/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_doc/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_doc/sisu_manifest.html</a> -</a> -> -</dt> -<dd></dd> - -<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_doc/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_doc/toc.html'>http://www.jus.uio.no/sisu/sisu_doc/toc.html</a> -</a> -> </dt> -<dd></dd> - -<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_doc/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_doc/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_doc/portrait.pdf</a> -</a> -> -</dt> -<dd></dd> - -<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_doc/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_doc/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_doc/landscape.pdf</a> -</a> -> </dt> -<dd> </dd> - -<dt>at: <<a href='http://www.jus.uio.no/sisu'><a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> -</a> -> -</dt> -<dd></dd> - -<dt>* Generated by: SiSU 0.59.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:32 +0100 2007 </dt> -<dd></dd> - -<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> - </dt> -<dd></dd> -</dl> -<p> -</body> -</html> diff --git a/data/doc/sisu/html/sisu_faq.8.html b/data/doc/sisu/html/sisu_faq.8.html deleted file mode 100644 index 18284509..00000000 --- a/data/doc/sisu/html/sisu_faq.8.html +++ /dev/null @@ -1,273 +0,0 @@ -<!-- manual page source format generated by PolyglotMan v3.2, --> -<!-- available at http://polyglotman.sourceforge.net/ --> - -<html> -<head> -<title>"sisu_faq"("1") manual page</title> -</head> -<body bgcolor='white'> -<a href='#toc'>Table of Contents</a><p> -SISU - FAQ - FREQUENTLY ASKED/ANSWERED QUESTIONS, RALPH AMISSAH -<p> 1. FAQ - -FREQUENTLY ASKED/ANSWERED QUESTIONS -<p> 1.1 WHY ARE URLS PRODUCED WITH THE --V (AND -U) FLAG THAT POINT TO A WEB SERVER ON PORT 8081? -<p> Try the following -rune: -<p> * sisu -W -<p> This should start the ruby webserver. It should be done -after having produced some output as it scans the output directory for -what to serve. -<p> 1.2 I CANNOT FIND MY OUTPUT, WHERE IS IT? -<p> The following -should provide help on output paths: -<p> * sisu --help env -<p> * sisu -V [same - as the previous command] -<p> * sisu --help directory -<p> * sisu --help path -<p> * -sisu -U [filename] -<p> * man sisu -<p> 1.3 I DO NOT GET ANY PDF OUTPUT, WHY? -<p> -<b>SiSU</b> produces LaTeX and pdflatex is run against that to generate pdf files. - -<p> If you use <b>Debian</b> the following will install the required dependencies - -<p> * aptitude install sisu-pdf -<p> the following packages are required: tetex-bin, -tetex-extra, latex-ucs -<p> 1.4 WHERE IS THE LATEX (OR SOME OTHER INTERIM) OUTPUT? - -<p> Try adding -M (for maintenance) to your command flags, e.g.: -<p> * sisu -HpMv - [filename] -<p> this should result in the interim processing output being -retained, and information being provided on where to find it. -<p> * sisu --help - -<p>directory -<p> * sisu --help path -<p> should also provide some relevant information -as to where it is placed. -<p> 1.5 WHY ISN’T SISU MARKUP XML -<p> I worked with text -and (though I find XML immensely valuable) disliked noise ... better to sidestep -the question and say: -<p> <b>SiSU</b> currently accurately, converts from three -forms of XML to native <b>SiSU</b> markup for processing. The three types correspond -to SAX (structure described), DOM (structure embedded, whole document must -be read before structure is correctly discernable) and node based (a tree) -forms of XML document structure representation. Problem is I use them very -seldom and check that all is as it should be with them seldom, so I would -not be surprised if something breaks there, but as far as I know they are -working. I will check and add an XML markup help page before the next release. - -<p>There already is a bit of information in the man page under the title <b>SiSU</b> - -<p>VERSION CONVERSION -<p> sisu --to-sax [filename/wildcard]<br> - -<p> sisu --to-dom [filename/wildcard]<br> - -<p> sisu --to-node [filename/wildcard]<br> - -<p> The XML should be well formed... must check, but lacks sensible headers. -Suggestions welcome as to what to make of them. [For the present time I - am satisfied that I can convert (both ways) between 3 forms of XML representation - and <b> SiSU</b> markup]. -<p> sisu --from-xml2sst [filename/wildcard]<br> - -<p> 1.6 LATEX CLAIMS TO BE A DOCUMENT PREPARATION SYSTEM FOR HIGH-QUALITY TYPESETTING. -CAN THE SAME BE SAID ABOUT SISU? -<p> <b>SiSU</b> is not really about type-setting. - -<p> LaTeX is the ultimate computer instruction type-setting language for paper -based publication. -<p> LaTeX is able to control just about everything that -happens on page and pixel, position letters kerning, space variation between -characters, words, paragraphs etc. formula. -<p> <b>SiSU</b> is not really about type-setting -at all. It is about a lightweight markup instruction that provides enough -information for an abstraction of the documents structure and objects, -from which different forms of representation of the document can be generated. - -<p> <b>SiSU</b> with very little markup instruction is able to produce relatively -high quality pdf by virtue of being able to generate usable default LaTeX; -it produces populates an SQL database in a useful way with the document -in object sized chunks and its meta-data. But <b>SiSU</b> works on an abstraction -of the document’s structure and content and custom builds suitable uniform -output. The html for browser viewing and pdf for paper viewing/publishing -are rather different things with different needs for layout - as indeed -is what is needed to store information in a database in searchable objects. - -<p> The pdfs or html produced for example by open office based on open document -format and other office/word processor suits usually attempt to have similar -looking outputs - your document rendered in html looks much the same, or -in pdf... sisu is less this way, it seeks to have a starting point with as -little information about appearance as possible, and to come up with the -best possible appearance for each output that can be derived based on this -minimal information. -<p> Where there are large document sets, it provides -consistency in appearance in each output format for the documents. -<p> The -excuse for going this way is, it is a waste of time to think much about -appearance when working on substantive content, it is the substantive content -that is relevant, not the way it looks beyond the basic informational tags -- and yet you want to be able to take advantage of as many useful different -ways of representing documents as are available, and for various types -of output to to be/look as good as it can for each medium/format in which -it is presented, (with different mediums having different focuses) and -<b>SiSU</b> tries to achieve this from minimal markup. -<p> 1.7 HOW DO I CREATE GIN - -<p>OR GIST INDEX IN POSTGRESQL FOR USE IN SISU -<p> This at present needs to -be done alter the sample search form. The following is a helpful response -from one of the contributors of GiN to Postgresql Oleg Bartunov 2006-12-06: - -<p> I have tsearch2 slides which introduces tsearch2 <<a href='http://www.sai.msu.su/~megera/wiki/tsearch2slides'>http://www.sai.msu.su/~megera/wiki/tsearch2slides</a> -> - -<p> FTS in PostgreSQL is provided by tsearch2, which should works without -any indices (GiST or GIN) ! Indices provide performance, not functionality. - -<p> In your example I’d do ( simple way, just for demo): -<p> <b>0.</b> compile, install - -<p>tsearch2 and load tsearch2 into your database -<p> cd contrib/tsearch2; -make&&make&&install&&make installcheck; psql DB &lt;<br> - tsearch2.sql<br> - -<p> <b>1.</b> Add column fts, which holds tsvector -<p> alter table documents add -column fts tsvector;<br> - -<p> <b>2.</b> Fill fts column -<p> update document set fts = to_tsvector(clean);<br> - -<p> <b>3.</b> create index - just for performance ! -<p> create index fts_gin_idx -on document using gin(fts);<br> - -<p> <b>4.</b> Run vacuum -<p> vacuum analyze document;<br> - -<p> That’s all. -<p> Now you can search: -<p> select lid, metadata_tid, rank_cd(fts, -q,2)as rank from document, plainto_tsquery(’markup syntax’) q where q @@ -fts order by rank desc limit 10; -<p> 1.8 WHERE IS VERSION 1.0? -<p> <b>SiSU</b> works -pretty well as it is supposed to. Version 1.0 will have the current markup, -and directory structure. At this point it is largely a matter of choice -as to when the name change is made. -<p> The feature set for html,[^1] LaTeX/pdf -and opendocument is in place. XML, and plaintext are in order. -<p> html and - -<p>LaTeX/pdf may be regarded as reference copy outputs -<p> With regard to the -populating of sql databases (postgresql and sqlite), there is a bit to -be done. -<p> We are still almost there. -<p> DOCUMENT INFORMATION (METADATA) -<p> -METADATA -<p> Document Manifest @ <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_faq/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_faq/sisu_manifest.html</a> -> - -<p> <b>Dublin Core</b> (DC) -<p> <i>DC</i> tags included with this document are provided here. - -<p> DC Title: <i>SiSU</i> - FAQ - Frequently Asked/Answered Questions -<p> DC Creator: - -<p><i>Ralph</i> Amissah -<p> DC Rights: <i>Copyright</i> (C) Ralph Amissah 2007, part of SiSU -documentation, License GPL 3 -<p> DC Type: <i>information</i> -<p> DC Date created: - -<p><i>2006-09-06</i> -<p> DC Date available: <i>2006-09-06</i> -<p> DC Date issued: <i>2006-09-06</i> -<p> DC -Date modified: <i>2007-09-16</i> -<p> DC Date: <i>2007-09-16</i> -<p> <b>Version Information</b> -<p> Sourcefile: - -<p><i>sisu_faq.sst</i> -<p> Filetype: <i>SiSU</i> text 0.57 -<p> Sourcefile Digest, MD5(sisu_faq.sst)= - -<p><i>41577c9fc063cd232914a1a11a59e91a</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:17 +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) - [i486-linux] -<p> -<ol> -<b>.</b><li>html w3c compliance has been largely met. -<p> </dd> - -<dt>Other versions of -this document: </dt> -<dd></dd> - -<dt>manifest: <<a href='http://www.jus.uio.no/sisu/sisu_faq/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_faq/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_faq/sisu_manifest.html</a> -</a> -> -</dt> -<dd></dd> - -<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_faq/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_faq/toc.html'>http://www.jus.uio.no/sisu/sisu_faq/toc.html</a> -</a> -> </dt> -<dd></dd> - -<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_faq/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_faq/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_faq/portrait.pdf</a> -</a> -> -</dt> -<dd></dd> - -<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_faq/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_faq/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_faq/landscape.pdf</a> -</a> -> </dt> -<dd> </dd> - -<dt>at: <<a href='http://www.jus.uio.no/sisu'><a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> -</a> -> -</dt> -<dd></dd> - -<dt>* Generated by: SiSU 0.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:32 +0100 2007 </dt> -<dd></dd> - -<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> - </dt> -<dd></dd> -</dl> -<p> -</body> -</html> diff --git a/data/doc/sisu/html/sisu_help.1.html b/data/doc/sisu/html/sisu_help.1.html deleted file mode 100644 index 9b820917..00000000 --- a/data/doc/sisu/html/sisu_help.1.html +++ /dev/null @@ -1,213 +0,0 @@ -<!-- manual page source format generated by PolyglotMan v3.2, --> -<!-- available at http://polyglotman.sourceforge.net/ --> - -<html> -<head> -<title>"sisu_help"("1") manual page</title> -</head> -<body bgcolor='white'> -<a href='#toc'>Table of Contents</a><p> -SISU - HELP, RALPH AMISSAH -<p> SISU HELP -<p> 1. HELP -<p> 1.1 SISU MANUAL -<p> The most -up to date information on sisu should be contained in the sisu_manual, -available at: -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/'>http://www.jus.uio.no/sisu/sisu_manual/</a> -><br> - -<p> and (from <b>SiSU</b> 0.59 onwards) installed locally at: -<p> /usr/share/doc/sisu/sisu_manual/<br> - -<p> or equivalent directory -<p> Within the <b>SiSU</b> tarball at: -<p> ./data/doc/sisu/sisu_manual/<br> - -<p> 1.2 SISU MAN PAGES -<p> If <b>SiSU</b> is installed on your system usual man commands -should be available, try: -<p> man sisu<br> - -<p> man sisu_markup<br> - -<p> man sisu_commands<br> - -<p> Most <b>SiSU</b> man pages are generated directly from sisu documents that -are used to prepare the sisu manual, the sources files for which are located -within the <b>SiSU</b> tarball at: -<p> ./data/doc/sisu/sisu_manual/<br> - -<p> Once installed, directory equivalent to: -<p> /usr/share/doc/sisu/sisu_manual/<br> - -<p> Available man pages are converted back to html using man2html: -<p> /usr/share/doc/sisu/html/<br> - -<p> ./data/doc/sisu/html/<br> - -<p> The <b>SiSU</b> man pages can be viewed online at:[^1] -<p> An online version of -the sisu man page is available here: -<p> * various sisu man pages <<a href='http://www.jus.uio.no/sisu/man/'>http://www.jus.uio.no/sisu/man/</a> -> - [^2] -<p> * sisu.1 <<a href='http://www.jus.uio.no/sisu/man/sisu.1.html'>http://www.jus.uio.no/sisu/man/sisu.1.html</a> -> [^3] -<p> * sisu.8 <<a href='http://www.jus.uio.no/sisu/man/sisu.8.html'>http://www.jus.uio.no/sisu/man/sisu.8.html</a> -> - [^4] -<p> * sisu_examples.1 <<a href='http://www.jus.uio.no/sisu/man/sisu_examples.1.html'>http://www.jus.uio.no/sisu/man/sisu_examples.1.html</a> -> [^5] - -<p> * sisu_webrick.1 <<a href='http://www.jus.uio.no/sisu/man/sisu_webrick.1.html'>http://www.jus.uio.no/sisu/man/sisu_webrick.1.html</a> -> [^6] -<p> 1.3 - -<p>SISU BUILT-IN INTERACTIVE HELP -<p> This is particularly useful when current -installation information is obtained as the interactive help is able to -provide information on your sisu configuration and setup. -<p> sisu --help<br> - -<p> sisu --help [subject]<br> - -<p> sisu --help env [for feedback on the way your system is <br> - setup with regard to sisu]<br> - -<p> sisu -V [same as above command]<br> - -<p> sisu --help commands<br> - -<p> sisu --help markup<br> - -<p> Apart from real-time information on your current configuration the <b>SiSU</b> -manual and man pages are likely to contain more up-to-date information than -the sisu interactive help (for example on commands and markup). -<p> NOTE: -Running the command sisu (alone without any flags, filenames or wildcards) -brings up the interactive help, as does any sisu command that is not recognised. -Enter to escape. -<p> 1.4 HELP SOURCES -<p> For lists of alternative help sources, -see: -<p> <b>man page</b> -<p> man sisu_help_sources<br> - -<p> <b>man2html</b> -<p> /usr/share/doc/sisu/sisu_manual/sisu_help_sources/index.html<br> - -<p> <b>sisu generated html</b> -<p> /usr/share/doc/sisu/html/sisu_help_sources/index.html<br> - -<p> <<a href='http://sisudoc.org/sisu_manual/sisu_help_sources/index.html'>http://sisudoc.org/sisu_manual/sisu_help_sources/index.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html</a> -><br> - -<p> DOCUMENT INFORMATION (METADATA) -<p> METADATA -<p> Document Manifest @ <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_help/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_help/sisu_manifest.html</a> -> - -<p> <b>Dublin Core</b> (DC) -<p> <i>DC</i> tags included with this document are provided here. - -<p> DC Title: <i>SiSU</i> - Help -<p> DC Creator: <i>Ralph</i> Amissah -<p> DC Rights: <i>Copyright</i> -(C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 -<p> DC -Type: <i>information</i> -<p> DC Date created: <i>2002-08-28</i> -<p> DC Date issued: <i>2002-08-28</i> - -<p> DC Date available: <i>2002-08-28</i> -<p> DC Date modified: <i>2007-08-30</i> -<p> DC Date: <i>2007-08-30</i> - -<p> <b>Version Information</b> -<p> Sourcefile: <i>sisu_help.sst</i> -<p> Filetype: <i>SiSU</i> text - -<p>0.58 -<p> Sourcefile Digest, MD5(sisu_help.sst)= <i>66d04ba5f3dd4ede774ffa5549b3faba</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:13 +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) - [i486-linux] -<p> -<ol> -<b>.</b><li>generated from source using rman <<a href='http://polyglotman.sourceforge.net/rman.html'>http://polyglotman.sourceforge.net/rman.html</a> -><br> - With regard to<br> - <b>SiSU</b> man pages the formatting generated for markup syntax is not quite -right, for that you might prefer the links under: <<a href='http://www.jus.uio.no/sample'>http://www.jus.uio.no/sample</a> -><br> - </li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man/'>http://www.jus.uio.no/sisu/man/</a> -> </li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man/sisu.1.html'>http://www.jus.uio.no/sisu/man/sisu.1.html</a> -> </li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man/sisu.8.html'>http://www.jus.uio.no/sisu/man/sisu.8.html</a> -> -</li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man/sisu_examples.1.html'>http://www.jus.uio.no/sisu/man/sisu_examples.1.html</a> -> </li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man/sisu_webrick.1.html'>http://www.jus.uio.no/sisu/man/sisu_webrick.1.html</a> -> - -<p> </dd> - -<dt>Other versions of this document: </dt> -<dd></dd> - -<dt>manifest: <<a href='http://www.jus.uio.no/sisu/sisu_help/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_help/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_help/sisu_manifest.html</a> -</a> -> -</dt> -<dd></dd> - -<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_help/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_help/toc.html'>http://www.jus.uio.no/sisu/sisu_help/toc.html</a> -</a> -> </dt> -<dd></dd> - -<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_help/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_help/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_help/portrait.pdf</a> -</a> -> -</dt> -<dd></dd> - -<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_help/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_help/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_help/landscape.pdf</a> -</a> -> </dt> -<dd> </dd> - -<dt>at: <<a href='http://www.jus.uio.no/sisu'><a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> -</a> -> -</dt> -<dd></dd> - -<dt>* Generated by: SiSU 0.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:30 +0100 2007 </dt> -<dd></dd> - -<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> - </dt> -<dd></dd> -</dl> -<p> -</body> -</html> diff --git a/data/doc/sisu/html/sisu_help_sources.1.html b/data/doc/sisu/html/sisu_help_sources.1.html deleted file mode 100644 index 8ff0d1de..00000000 --- a/data/doc/sisu/html/sisu_help_sources.1.html +++ /dev/null @@ -1,582 +0,0 @@ -<!-- manual page source format generated by PolyglotMan v3.2, --> -<!-- available at http://polyglotman.sourceforge.net/ --> - -<html> -<head> -<title>"sisu_help_sources"("1") manual page</title> -</head> -<body bgcolor='white'> -<a href='#toc'>Table of Contents</a><p> -SISU - REFERENCES, RALPH AMISSAH -<p> SISU HELP SOURCES -<p> 1. HELP SOURCES -<p> - For a summary of alternative ways to get help on <b>SiSU</b> try one of the following: - -<p> <b>man page</b> -<p> man sisu_help<br> - -<p> <b>man2html</b> -<p> <file:///usr/share/doc/sisu/html/sisu_help.1.html><br> - -<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_help.1.html'>http://www.jus.uio.no/sisu/man/sisu_help.1.html</a> -><br> - -<p> <b>sisu generated output - links to html</b> -<p> <file:///usr/share/doc/sisu/sisu_manual/sisu_help/index.html><br> - -<p> <<a href='http://sisudoc.org/sisu_manual/sisu_help/index.html'>http://sisudoc.org/sisu_manual/sisu_help/index.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_help/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_help/index.html</a> -><br> - -<p> <b>help sources lists</b> -<p> Alternative sources for this help sources page -listed here: -<p> man sisu_help_sources<br> - -<p> <file:///usr/share/doc/sisu/sisu_manual/sisu_help_sources/index.html><br> - -<p> <file:///usr/share/doc/sisu/html/sisu_help_sources/index.html><br> - -<p> <<a href='http://sisudoc.org/sisu_manual/sisu_help_sources/index.html'>http://sisudoc.org/sisu_manual/sisu_help_sources/index.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html</a> -><br> - -<p> 1.1 MAN PAGES -<p> 1.1.1 MAN -<p> man sisu<br> - -<p> man sisu_commands<br> - -<p> man 7 sisu_complete<br> - -<p> man sisu_configuration<br> - -<p> man 8 sisu_faq<br> - -<p> man sisu_filetypes<br> - -<p> man sisu_help<br> - -<p> man sisu_help_sources<br> - -<p> man 8 sisu_howto<br> - -<p> man sisu_introduction<br> - -<p> man sisu_markup<br> - -<p> man sisu_output_overview<br> - -<p> man 7 sisu_pdf<br> - -<p> man 7 sisu_postgresql<br> - -<p> man 8 sisu_quickstart<br> - -<p> man 8 sisu_remote<br> - -<p> man 8 sisu_search<br> - -<p> man sisu_skin<br> - -<p> man 7 sisu_sqlite<br> - -<p> man 8 sisu_syntax_highlighting<br> - -<p> man 7 sisu_vim<br> - -<p> man sisu_webrick<br> - -<p> 1.2 SISU GENERATED OUTPUT - LINKS TO HTML -<p> Note <b>SiSU</b> documentation is -prepared in <b>SiSU</b> and output is available in multiple formats including -amongst others html, pdf, and odf which may be also be accessed via the -html pages[^1] -<p> 1.2.1 LOCALLY INSTALLED -<p> <file:///usr/share/doc/sisu/sisu_manual/sisu_manual/index.html> - -<p> <file:///usr/share/doc/sisu/sisu_manual/sisu_help/index.html> -<p> <file:///usr/share/doc/sisu/sisu_manual/sisu_help_sources/index.html> - -<p> /usr/share/doc/sisu/sisu_manual/sisu/index.html<br> - -<p> /usr/share/doc/sisu/sisu_manual/sisu_commands/index.html<br> - -<p> /usr/share/doc/sisu/sisu_manual/sisu_complete/index.html<br> - -<p> /usr/share/doc/sisu/sisu_manual/sisu_configuration/index.html<br> - -<p> /usr/share/doc/sisu/sisu_manual/sisu_description/index.html<br> - -<p> /usr/share/doc/sisu/sisu_manual/sisu_examples/index.html<br> - -<p> /usr/share/doc/sisu/sisu_manual/sisu_faq/index.html<br> - -<p> /usr/share/doc/sisu/sisu_manual/sisu_filetypes/index.html<br> - -<p> /usr/share/doc/sisu/sisu_manual/sisu_help/index.html<br> - -<p> /usr/share/doc/sisu/sisu_manual/sisu_help_sources/index.html<br> - -<p> /usr/share/doc/sisu/sisu_manual/sisu_howto/index.html<br> - -<p> /usr/share/doc/sisu/sisu_manual/sisu_introduction/index.html<br> - -<p> /usr/share/doc/sisu/sisu_manual/sisu_manual/index.html<br> - -<p> /usr/share/doc/sisu/sisu_manual/sisu_markup/index.html<br> - -<p> /usr/share/doc/sisu/sisu_manual/sisu_output_overview/index.html<br> - -<p> /usr/share/doc/sisu/sisu_manual/sisu_pdf/index.html<br> - -<p> /usr/share/doc/sisu/sisu_manual/sisu_postgresql/index.html<br> - -<p> /usr/share/doc/sisu/sisu_manual/sisu_quickstart/index.html<br> - -<p> /usr/share/doc/sisu/sisu_manual/sisu_remote/index.html<br> - -<p> /usr/share/doc/sisu/sisu_manual/sisu_search/index.html<br> - -<p> /usr/share/doc/sisu/sisu_manual/sisu_skin/index.html<br> - -<p> /usr/share/doc/sisu/sisu_manual/sisu_sqlite/index.html<br> - -<p> /usr/share/doc/sisu/sisu_manual/sisu_syntax_highlighting/index.html<br> - -<p> /usr/share/doc/sisu/sisu_manual/sisu_vim/index.html<br> - -<p> /usr/share/doc/sisu/sisu_manual/sisu_webrick/index.html<br> - -<p> 1.2.2 WWW.SISUDOC.ORG -<p> <<a href='http://sisudoc.org/sisu_manual/sisu_manual/index.html'>http://sisudoc.org/sisu_manual/sisu_manual/index.html</a> -> - -<p> <<a href='http://sisudoc.org/sisu_manual/sisu/index.html'>http://sisudoc.org/sisu_manual/sisu/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu_manual/sisu_commands/index.html'>http://sisudoc.org/sisu_manual/sisu_commands/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu_manual/sisu_complete/index.html'>http://sisudoc.org/sisu_manual/sisu_complete/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu_manual/sisu_configuration/index.html'>http://sisudoc.org/sisu_manual/sisu_configuration/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu_manual/sisu_description/index.html'>http://sisudoc.org/sisu_manual/sisu_description/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu_manual/sisu_examples/index.html'>http://sisudoc.org/sisu_manual/sisu_examples/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu_manual/sisu_faq/index.html'>http://sisudoc.org/sisu_manual/sisu_faq/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu_manual/sisu_filetypes/index.html'>http://sisudoc.org/sisu_manual/sisu_filetypes/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu_manual/sisu_help/index.html'>http://sisudoc.org/sisu_manual/sisu_help/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu_manual/sisu_help_sources/index.html'>http://sisudoc.org/sisu_manual/sisu_help_sources/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu_manual/sisu_howto/index.html'>http://sisudoc.org/sisu_manual/sisu_howto/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu_manual/sisu_introduction/index.html'>http://sisudoc.org/sisu_manual/sisu_introduction/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu_manual/sisu_manual/index.html'>http://sisudoc.org/sisu_manual/sisu_manual/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu_manual/sisu_markup/index.html'>http://sisudoc.org/sisu_manual/sisu_markup/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu_manual/sisu_output_overview/index.html'>http://sisudoc.org/sisu_manual/sisu_output_overview/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu_manual/sisu_pdf/index.html'>http://sisudoc.org/sisu_manual/sisu_pdf/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu_manual/sisu_postgresql/index.html'>http://sisudoc.org/sisu_manual/sisu_postgresql/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu_manual/sisu_quickstart/index.html'>http://sisudoc.org/sisu_manual/sisu_quickstart/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu_manual/sisu_remote/index.html'>http://sisudoc.org/sisu_manual/sisu_remote/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu_manual/sisu_search/index.html'>http://sisudoc.org/sisu_manual/sisu_search/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu_manual/sisu_skin/index.html'>http://sisudoc.org/sisu_manual/sisu_skin/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu_manual/sisu_sqlite/index.html'>http://sisudoc.org/sisu_manual/sisu_sqlite/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu_manual/sisu_syntax_highlighting/index.html'>http://sisudoc.org/sisu_manual/sisu_syntax_highlighting/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu_manual/sisu_vim/index.html'>http://sisudoc.org/sisu_manual/sisu_vim/index.html</a> -><br> - -<p> <<a href='http://sisudoc.org/sisu_manual/sisu_webrick/index.html'>http://sisudoc.org/sisu_manual/sisu_webrick/index.html</a> -><br> - -<p> 1.2.3 WWW.JUS.UIO.NO/SISU -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_manual/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_manual/index.html</a> -> - -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu/index.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_commands/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_commands/index.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_complete/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_complete/index.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/index.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_description/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_description/index.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_examples/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_examples/index.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_faq/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_faq/index.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_filetypes/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_filetypes/index.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_help/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_help/index.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_howto/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_howto/index.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_introduction/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_introduction/index.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_manual/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_manual/index.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_markup/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_markup/index.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_output_overview/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_output_overview/index.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_pdf/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_pdf/index.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_postgresql/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_postgresql/index.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/index.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_remote/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_remote/index.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_search/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_search/index.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_skin/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_skin/index.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_sqlite/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_sqlite/index.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_syntax_highlighting/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_syntax_highlighting/index.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_vim/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_vim/index.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_webrick/index.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_webrick/index.html</a> -><br> - -<p> 1.2.4 MAN2HTML -<p> 1.2.5 LOCALLY INSTALLED -<p> <file:///usr/share/doc/sisu/html/sisu_manual.1.html> - -<p> <file:///usr/share/doc/sisu/html/sisu_help.1.html> -<p> <file:///usr/share/doc/sisu/html/sisu_help_sources.1.html> - -<p> /usr/share/doc/sisu/html/sisu.1.html<br> - -<p> /usr/share/doc/sisu/html/sisu_commands.1.html<br> - -<p> /usr/share/doc/sisu/html/sisu_complete.7.html<br> - -<p> /usr/share/doc/sisu/html/sisu_configuration.1.html<br> - -<p> /usr/share/doc/sisu/html/sisu_faq.8.html<br> - -<p> /usr/share/doc/sisu/html/sisu_help.1.html<br> - -<p> /usr/share/doc/sisu/html/sisu_help_sources.1.html<br> - -<p> /usr/share/doc/sisu/html/sisu_howto.8.html<br> - -<p> /usr/share/doc/sisu/html/sisu_markup.1.html<br> - -<p> /usr/share/doc/sisu/html/sisu_pdf.7.html<br> - -<p> /usr/share/doc/sisu/html/sisu_postgresql.7.html<br> - -<p> /usr/share/doc/sisu/html/sisu_quickstart.8.html<br> - -<p> /usr/share/doc/sisu/html/sisu_remote.8.html<br> - -<p> /usr/share/doc/sisu/html/sisu_search.8.html<br> - -<p> /usr/share/doc/sisu/html/sisu_skin.1.html<br> - -<p> /usr/share/doc/sisu/html/sisu_sqlite.7.html<br> - -<p> /usr/share/doc/sisu/html/sisu_syntax_highlighting.8.html<br> - -<p> /usr/share/doc/sisu/html/sisu_vim.7.html<br> - -<p> /usr/share/doc/sisu/html/sisu_webrick.1.html<br> - -<p> 1.2.6 WWW.SISUDOC.ORG -<p> <<a href='http:///sisudoc.org/man/sisu_manual.1.html'>http:///sisudoc.org/man/sisu_manual.1.html</a> -> -<p> <<a href='http:///sisudoc.org/man/sisu_help.1.html'>http:///sisudoc.org/man/sisu_help.1.html</a> -> - -<p> <<a href='http:///sisudoc.org/man/sisu_help_sources.1.html'>http:///sisudoc.org/man/sisu_help_sources.1.html</a> -> -<p> <<a href='http://sisudoc.org/man/sisu.1.html'>http://sisudoc.org/man/sisu.1.html</a> -><br> - -<p> <<a href='http://sisudoc.org/man/sisu_commands.1.html'>http://sisudoc.org/man/sisu_commands.1.html</a> -><br> - -<p> <<a href='http://sisudoc.org/man/sisu_complete.7.html'>http://sisudoc.org/man/sisu_complete.7.html</a> -><br> - -<p> <<a href='http://sisudoc.org/man/sisu_configuration.1.html'>http://sisudoc.org/man/sisu_configuration.1.html</a> -><br> - -<p> <<a href='http://sisudoc.org/man/sisu_faq.8.html'>http://sisudoc.org/man/sisu_faq.8.html</a> -><br> - -<p> <<a href='http://sisudoc.org/man/sisu_help.1.html'>http://sisudoc.org/man/sisu_help.1.html</a> -><br> - -<p> <<a href='http://sisudoc.org/man/sisu_help_sources.1.html'>http://sisudoc.org/man/sisu_help_sources.1.html</a> -><br> - -<p> <<a href='http://sisudoc.org/man/sisu_howto.8.html'>http://sisudoc.org/man/sisu_howto.8.html</a> -><br> - -<p> <<a href='http://sisudoc.org/man/sisu_markup.1.html'>http://sisudoc.org/man/sisu_markup.1.html</a> -><br> - -<p> <<a href='http://sisudoc.org/man/sisu_pdf.7.html'>http://sisudoc.org/man/sisu_pdf.7.html</a> -><br> - -<p> <<a href='http://sisudoc.org/man/sisu_postgresql.7.html'>http://sisudoc.org/man/sisu_postgresql.7.html</a> -><br> - -<p> <<a href='http://sisudoc.org/man/sisu_quickstart.8.html'>http://sisudoc.org/man/sisu_quickstart.8.html</a> -><br> - -<p> <<a href='http://sisudoc.org/man/sisu_remote.8.html'>http://sisudoc.org/man/sisu_remote.8.html</a> -><br> - -<p> <<a href='http://sisudoc.org/man/sisu_search.8.html'>http://sisudoc.org/man/sisu_search.8.html</a> -><br> - -<p> <<a href='http://sisudoc.org/man/sisu_skin.1.html'>http://sisudoc.org/man/sisu_skin.1.html</a> -><br> - -<p> <<a href='http://sisudoc.org/man/sisu_sqlite.7.html'>http://sisudoc.org/man/sisu_sqlite.7.html</a> -><br> - -<p> <<a href='http://sisudoc.org/man/sisu_syntax_highlighting.8.html'>http://sisudoc.org/man/sisu_syntax_highlighting.8.html</a> -><br> - -<p> <<a href='http://sisudoc.org/man/sisu_vim.7.html'>http://sisudoc.org/man/sisu_vim.7.html</a> -><br> - -<p> <<a href='http://sisudoc.org/man/sisu_webrick.1.html'>http://sisudoc.org/man/sisu_webrick.1.html</a> -><br> - -<p> 1.2.7 WWW.JUS.UIO.NO/SISU -<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_manual.1.html'>http://www.jus.uio.no/sisu/man/sisu_manual.1.html</a> -> -<p> - <<a href='http://www.jus.uio.no/sisu/man/sisu_help.1.html'>http://www.jus.uio.no/sisu/man/sisu_help.1.html</a> -> -<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_help_sources.1.html'>http://www.jus.uio.no/sisu/man/sisu_help_sources.1.html</a> -> - -<p> <<a href='http://www.jus.uio.no/sisu/man/sisu.1.html'>http://www.jus.uio.no/sisu/man/sisu.1.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_commands.1.html'>http://www.jus.uio.no/sisu/man/sisu_commands.1.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_complete.7.html'>http://www.jus.uio.no/sisu/man/sisu_complete.7.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_configuration.1.html'>http://www.jus.uio.no/sisu/man/sisu_configuration.1.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_faq.8.html'>http://www.jus.uio.no/sisu/man/sisu_faq.8.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_help.1.html'>http://www.jus.uio.no/sisu/man/sisu_help.1.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_help_sources.1.html'>http://www.jus.uio.no/sisu/man/sisu_help_sources.1.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_howto.8.html'>http://www.jus.uio.no/sisu/man/sisu_howto.8.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_markup.1.html'>http://www.jus.uio.no/sisu/man/sisu_markup.1.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_pdf.7.html'>http://www.jus.uio.no/sisu/man/sisu_pdf.7.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_postgresql.7.html'>http://www.jus.uio.no/sisu/man/sisu_postgresql.7.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_quickstart.8.html'>http://www.jus.uio.no/sisu/man/sisu_quickstart.8.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_remote.8.html'>http://www.jus.uio.no/sisu/man/sisu_remote.8.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_search.8.html'>http://www.jus.uio.no/sisu/man/sisu_search.8.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_skin.1.html'>http://www.jus.uio.no/sisu/man/sisu_skin.1.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_sqlite.7.html'>http://www.jus.uio.no/sisu/man/sisu_sqlite.7.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_syntax_highlighting.8.html'>http://www.jus.uio.no/sisu/man/sisu_syntax_highlighting.8.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_vim.7.html'>http://www.jus.uio.no/sisu/man/sisu_vim.7.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_webrick.1.html'>http://www.jus.uio.no/sisu/man/sisu_webrick.1.html</a> -><br> - -<p> DOCUMENT INFORMATION (METADATA) -<p> METADATA -<p> Document Manifest @ <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/sisu_manifest.html</a> -> - -<p> <b>Dublin Core</b> (DC) -<p> <i>DC</i> tags included with this document are provided here. - -<p> DC Title: <i>SiSU</i> - References -<p> DC Creator: <i>Ralph</i> Amissah -<p> DC Rights: <i>Copyright</i> -(C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 -<p> DC -Type: <i>information</i> -<p> DC Date created: <i>2002-11-12</i> -<p> DC Date issued: <i>2002-11-12</i> - -<p> DC Date available: <i>2002-11-12</i> -<p> DC Date modified: <i>2007-09-16</i> -<p> DC Date: <i>2007-09-16</i> - -<p> <b>Version Information</b> -<p> Sourcefile: <i>sisu_help_sources.sst</i> -<p> Filetype: <i>SiSU</i> - -<p>text insert 0.58 -<p> Sourcefile Digest, MD5(sisu_help_sources.sst)= <i>ff6812b3008391d7a20d777bbbeb3ec1</i> - -<p> Skin_Digest: MD5(/home/ralph/grotto/theatre/dbld/sisu-dev/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)= - -<p><i>20fc43cf3eb6590bc3399a1aef65c5a9</i> -<p> <b>Generated</b> -<p> Document (metaverse) last -generated: <i>Mon</i> Sep 24 15:36:13 +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) - [i486-linux] -<p> -<ol> -<b>.</b><li>named index.html or more extensively through sisu_manifest.html - -<p> </dd> - -<dt>Other versions of this document: </dt> -<dd></dd> - -<dt>manifest: <<a href='http://www.jus.uio.no/sisu/sisu_help_sources/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_help_sources/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_help_sources/sisu_manifest.html</a> -</a> -> -</dt> -<dd></dd> - -<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_help_sources/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_help_sources/toc.html'>http://www.jus.uio.no/sisu/sisu_help_sources/toc.html</a> -</a> -> </dt> -<dd></dd> - -<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_help_sources/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_help_sources/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_help_sources/portrait.pdf</a> -</a> -> -</dt> -<dd></dd> - -<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_help_sources/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_help_sources/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_help_sources/landscape.pdf</a> -</a> -> </dt> -<dd> </dd> - -<dt>at: <<a href='http://www.jus.uio.no/sisu'><a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> -</a> -> -</dt> -<dd></dd> - -<dt>* Generated by: SiSU 0.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:30 +0100 2007 </dt> -<dd></dd> - -<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> - </dt> -<dd></dd> -</dl> -<p> -</body> -</html> diff --git a/data/doc/sisu/html/sisu_howto.8.html b/data/doc/sisu/html/sisu_howto.8.html 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> <<a href='http://www.jus.uio.no/sisu_manual/'>http://www.jus.uio.no/sisu_manual/</a> -> -<p> The manual pages provided with -<b>SiSU</b> are also available online, and there is an interactive help, which -is being superseded by the man page, and possibly some document which contains -this component. -<p> 1.1 SISU -<p> If <b>SiSU</b> is installed on your system usual man -commands should be available, try: -<p> man sisu -<p> The <b>SiSU</b> man pages can -be viewed online at:[^1] -<p> An online version of the sisu man page is available -here: -<p> * various sisu man pages <<a href='http://www.jus.uio.no/sisu/man/'>http://www.jus.uio.no/sisu/man/</a> -> [^2] -<p> * sisu.1 -<<a href='http://www.jus.uio.no/sisu/man/sisu.1.html'>http://www.jus.uio.no/sisu/man/sisu.1.html</a> -> [^3] -<p> * sisu.8 <<a href='http://www.jus.uio.no/sisu/man/sisu.8.html'>http://www.jus.uio.no/sisu/man/sisu.8.html</a> -> - [^4] -<p> * sisu_examples.1 <<a href='http://www.jus.uio.no/sisu/man/sisu_examples.1.html'>http://www.jus.uio.no/sisu/man/sisu_examples.1.html</a> -> [^5] - -<p> * sisu_webrick.1 <<a href='http://www.jus.uio.no/sisu/man/sisu_webrick.1.html'>http://www.jus.uio.no/sisu/man/sisu_webrick.1.html</a> -> [^6] -<p> 1.2 - -<p>SISU BUILT-IN HELP -<p> sisu --help<br> - -<p> sisu --help [subject]<br> - -<p> sisu --help env [for feedback on the way your system is <br> - setup with regard to sisu]<br> - -<p> sisu -V [same as above command]<br> - -<p> sisu --help commands<br> - -<p> sisu --help markup<br> - -<p> 1.3 COMMAND LINE WITH FLAGS - BATCH PROCESSING -<p> Running sisu (alone without -any flags, filenames or wildcards) brings up the interactive help, as does -any sisu command that is not recognised. -<p> In the data directory run sisu --mh filename or wildcard eg. cisg.sst documents. -<p> 2. SETUP, INITIALISATION - -<p> 2.1 INITIALISE OUTPUT DIRECTORY -<p> Images, css files for a document directory -are copied to their respective locations in the output directory. -<p> while -within your document markup/preparation directory, issue the following - -<p>command -<p> sisu -CC<br> - -<p> 2.1.1 USE OF SEARCH FUNCTIONALITY, AN EXAMPLE USING SQLITE -<p> <b>SiSU</b> can populate -PostgreSQL and Sqlite databases and provides a sample search form for querying -these databases. -<p> This note provides an example to get you started and - -<p>will use sqlite -<p> It is necessary to: -<p> (1) make sure the required dependencies - -<p>have been installed -<p> (2) have a directory with sisu markup samples that - -<p>is writable -<p> (3) use sisu to create a database -<p> (4) use sisu tp populate - -<p>a database -<p> (5) use sisu to start the webrick (httpd) server -<p> (6) use - -<p>sisu to create a search form -<p> (7) copy the search form to the cgi directory - -<p> (8) open up the form in your browser -<p> (9) query the database using the - -<p>search form -<p> <b>(1) make sure the required dependencies have been installed</b> - -<p> if you use <b>Debian</b> , the following command will install the required dependencies - -<p> aptitude install sisu-sqlite -<p> <b>(2) have a directory with sisu markup samples - -<p>that is writable</b> -<p> ideally copy the sisu-examples directory to your home -directory (because the directory in which you run this example should be -writable) -<p> cp -rv /usr/share/sisu-examples/sample/document_samples_sisu_markup -~/. -<p> <b>(3) use sisu to create an sqlite database</b> -<p> within the sisu-examples - -<p>directory -<p> sisu -dv createall -<p> <b>(4) use sisu tp populate a database with - -<p>some text</b> -<p> within the sisu-examples directory -<p> sisu -div free_*.sst -<p> or - -<p> sisu -dv import free_*.sst debian_constitution_v1.2.sst debian_social_contract_v1.1.sst - -<p>gpl2.fsf.sst -<p> <b>(5) use sisu to start the webrick (httpd) server (if it has -not already</b> been started): -<p> sisu -W -<p> <b>(6) use sisu to create a search form -(for use with the webrick server, and</b> your sample documents) -<p> within the - -<p>sisu-examples directory -<p> sisu -F webrick -<p> #here i run into a problem, you -are working from a read only #directory..., not my usual mode of operation, - -<p>to complete the example #the following is necessary sudo touch sisu_sqlite.cgi - -<p>sisu_pgsql.cgi sudo -P chown $USER sisu_sqlite.cgi sisu_pgsql.cgi -<p> #now this -should be possible: sisu -F webrick -<p> <b>(7) copy the search form to the cgi - -<p>directory</b> -<p> the string should be provided as output from the previous command - -<p> sudo cp -vi /usr/share/sisu-examples/sample/document_samples_sisu_markup/sisu_sqlite.cgi - -<p>/usr/lib/cgi-bin -<p> sudo chmod -v 755 /usr/lib/cgi-bin/sisu_sqlite.cgi -<p> <b>(8) - -<p>open up the form in your browser and query it</b> -<p> url: -<p> <<a href='http://localhost:8081/cgi-bin/sisu_sqlite.cgi'>http://localhost:8081/cgi-bin/sisu_sqlite.cgi</a> -> - -<p> or as instructed by command sisu -F webrick -<p> <b>(9) query the database using - -<p>the search form</b> -<p> if there are other options in the dropdown menu select - -<p> document_samples_sisu_markup -<p> and search for some text, e.g.: -<p> aim OR - -<p>project -<p> * selecting the <b>index</b> radio button gives an index of results - -<p>using the object numbers -<p> * selecting the <b>text</b> radio button gives the - -<p>content of the matched paragraphs with the match highlighted -<p> <b>(10) to - -<p>start again with a new database</b> -<p> to start from scratch you can drop the - -<p>database with the command -<p> sisu -dv dropall -<p> and go to step 3 -<p> to get - -<p>to step 3 in one step with a single command -<p> sisu -dv recreate -<p> continue - -<p>subsequent steps -<p> 2.2 MISC -<p> 2.2.1 URL FOR OUTPUT FILES -U -U -<p> sisu -uv[and - other flags] [filename/wildcard]<br> - -<p> sisu -Uv [filename/wildcard]<br> - -<p> 2.2.2 TOGGLE SCREEN COLOR -<p> sisu -cv[and processing flags] [filename/wildcard]<br> - -<p> 2.2.3 VERBOSE MODE -<p> sisu -v[and processing flags] [filename/wildcard]<br> - -<p> sisu -V[and processing flags] [filename/wildcard]<br> - -<p> 2.2.4 QUIET MODE -<p> sisu -q[and processing flags] [filename/wildcard]<br> - -<p> 2.2.5 MAINTENANCE MODE INTERMEDIATE FILES KEPT -M -<p> sisu -Mv[and other - flags] [filename/wildcard]<br> - -<p> 2.2.6 START THE WEBRICK SERVER -<p> sisu -W<br> - -<p> 2.3 REMOTE PLACEMENT OF OUTPUT -<p> configuration is necessary -<p> scp -<p> -sisu -vr[and processing flags] [filename/wildcard]<br> - -<p> rsync -<p> sisu -vR[and processing flags] [filename/wildcard]<br> - -<p> 3. CONFIGURATION FILES -<p> Sample provided, on untarring the source tarball: - -<p> conf/sisu/sisurc.yaml<br> - -<p> and on installation under: -<p> /etc/sisu/sisurc.yaml<br> - -<p> The following paths are searched: -<p> ./_sisu/sisurc.yaml<br> - -<p> ~/.sisu/sisurc.yaml<br> - -<p> ./etc/sisu/sisurc.yaml<br> - -<p> 4. MARKUP -<p> See sample markup provided on -<p> <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> -> -<p> - <<a href='http://www.jus.uio.no/sisu_markup'>http://www.jus.uio.no/sisu_markup</a> -> -<p> <<a href='http://www.jus.uio.no/sisu/SiSU'>http://www.jus.uio.no/sisu/SiSU</a> -> -<p> in particular -for each of the document output samples provided, the source document is - -<p>provided as well -<p> <<a href='http://www.jus.uio.no/sisu/SiSU/2#books'>http://www.jus.uio.no/sisu/SiSU/2#books</a> -> -<p> on untarring -the source tarball: -<p> data/sisu-examples/sample/document_samples_sisu_markup/<br> - -<p> or the same once source is installed (or sisu-examples) under: -<p> /usr/share/sisu-examples/sample/document_samples_sisu_markup/<br> - -<p> Some notes are contained within the man page, <b>man sisu</b> and within sisu - -<p>help via the commands <b>sisu help markup</b> and <b>sisu help headers</b> -<p> <b>SiSU</b> is -for literary and legal text, also for some social science material. In particular -it does not do formula, and is not particularly suited to technical documentation. -Despite the latter caveat, some notes will be provided here and added to -over time: -<p> 4.1 HEADERS -<p> Headers @headername: provide information related -to the document, this may relate to -<p> 1. how it is to be processed, such -as whether headings are to be numbered, what skin is to be used and markup -instructions, such as the document structure, or words to be made bold - -<p>within the document -<p> 2. semantic information about the document including - -<p>the dublin core -<p> 4.2 FONT FACE -<p> Defaults are set. You may change the face -to: bold, italics, underscore, strikethrough, ... -<p> 4.2.1 BOLD -<p> @bold: [list - of words that should be made bold within or document] -<p> <b>bold line</b> -<p> !_ - -<p>bold line -<p> <b>bold word or sentence</b> -<p> !{ bold word or sentence }! -<p> *{ bold -word or sentence }* -<p> <b>boldword</b> or <b>boldword</b> -<p> *boldword* or !boldword! -<p> - -<p>4.2.2 ITALICS -<p> @italics: [list of words that should be italicised within - -<p> <i>italicise</i> word or sentence -<p> /{ italicise word or sentence }/ -<p> <i>italicisedword</i> - -<p> /italicisedword/ -<p> 4.2.3 UNDERSCORE -<p> <i>underscore</i> word or sentence -<p> _{ underscore -word or sentence }_ -<p> <i>underscoreword</i> -<p> 4.2.4 STRIKETHROUGH -<p> <del> strikethrough -word or sentence </del> -<p> -{ strikethrough word or sentence }- -<p> <del>strikeword</del> - -<p> -strikeword- -<p> 4.3 ENDNOTES -<p> There are two forms of markup for endnotes, - -<p>they cannot be mixed within the same document -<p> here[^7] -<p> 1. preferred endnote - -<p>markup -<p> here~{ this is an endnote }~ -<p> 2. alternative markup equivalent, - -<p>kept because it is possible to search and replace to get markup in existing - -<p>texts such as Project Gutenberg -<p> here~^ -<p> ^~ this is an endote -<p> 4.4 LINKS - -<p> SiSU <<a href='http://sisudoc.org'>http://sisudoc.org</a> -> -<p> { <b>SiSU</b> }<a href='http://sisudoc.org'>http://sisudoc.org</a> - -<p> sisu.png 120x39 <<a href='http://sisudoc.org'>http://sisudoc.org</a> -> - -<p> {sisu.png }<a href='http://sisudoc.org'>http://sisudoc.org</a> - -<p> [ tux.png ] -<p> { tux.png 64x80 }image -<p> SiSU -<<a href='http://sisudoc.org'>http://sisudoc.org</a> -> [^8] -<p> { <b>SiSU</b> }<a href='http://sisudoc.org'>http://sisudoc.org</a> - -<p> is equivalent to: -<p> - { <b>SiSU</b> }<a href='http://sisudoc.org'>http://sisudoc.org</a> - ~{ <<a href='http://sisudoc.org'>http://sisudoc.org</a> -> }~ -<p> the same can be done -with an image: -<p> sisu.png 120x39 -<p> { sisu.png <b>SiSU</b> }<a href='http://sisudoc.org'>http://sisudoc.org</a> -<br> - -<p> 4.5 NUMBER TITLES -<p> Set with the header @markup: -<p> 4.6 LINE OPERATIONS -<p> - Line Operations (marker placed at start of line) -<p> !_ bold line -<p> <b>bold - -<p>line</b> -<p> _1 indent paragraph one level -<p> indent paragraph one level<br> - -<p> _2 indent paragraph two steps -<p> indent paragraph two steps<br> - -<p> _* bullet paragraph -<p> * bullet paragraph -<p> # number paragraph (see headers -for numbering document headings) -<p> 1. number paragraph (see headers for -numbering document headings) -<p> _# number paragraph level 2 (see headers -for numbering document headings) -<p> a. number paragraph level 2 (see headers -for numbering document headings)<br> - -<p> 4.7 TABLES -<p> Table markup sample -<p> -<p> table{~h c3; 26; 32; 32; <p> - -<p> -<p> This is -a table, column1 <p> -this would become row one of column two <p> -column three of -row one is here <p> - -<p> -<p> column one row 2 <p> -column two of row two <p> -column three of -row two, and so on <p> - -<p> -<p> column one row three <p> -and so on <p> -here <p> - -<p> -<p> }table <p> - -<p> Alternative - -<p>form of table markup -<p> -<p> <br> -<pre> {t~h} - |Mon|Tue|Wed|Thu|Fri|Sat|Sun - 0 | * | * | * | * | * | * | * - 1 | * | * | * | * | | | - 2 | - | * | * | * | * | * | - 3 | - | * | * | * | * | * | * - 4 | - | | | * | * | * | - 5 | * | * | * | * | * | * | * -</pre> -<p> 4.8 GROUPED TEXT -<p> -<p> <br> -<pre> 5.times { puts ’Ruby’ } -</pre> -<p> code{ -<p> -<p> <br> -<pre> 5.times { puts ’Ruby’ } -</pre> -<p> }code -<p> -<p> A Limerick <p> - -<p> -<p> There was a young lady from Clyde, <p> -who ate a green -apple and died, <p> -but the apple fermented inside the lamented, <p> -and made cider -inside her inside. <p> - -<p> -<p> poem{ <p> - -<p> -<p> There was a young lady from Clyde, <p> -who ate -a green apple and died, <p> -but the apple fermented inside the lamented, <p> -and -made cider inside her inside. <p> - -<p> -<p> }poem <p> - -<p> 4.9 COMPOSITE DOCUMENT -<p> To import -another document, the master document or importing document should be named -filename.r3 (r for require) -<p> &lt;&lt; { filename.sst } -<p> &lt;&lt; { filename.ssi -} -<p> 5. CHANGE APPEARANCE -<p> 5.1 SKINS -<p> Skins appearance, including such things -as the url for the home page on which the material will be published, information -on the credit band, and for html documents colours and icons used in navigation -bars. Skins are ruby files which permit changing of the default values set -within the program for <b>SiSU</b> output. -<p> There are a few examples provided, -on untarring the source tarball: -<p> conf/sisu/skin/doc/<br> - -<p> data/sisu-examples/sample/document_samples_sisu_markup/_sisu/skin/doc<br> - -<p> and on installation under: -<p> /etc/sisu/skin/doc/<br> - -<p> /usr/share/sisu-examples/sample/document_samples_sisu_markup/_sisu/skin/doc<br> - -<p> The following paths are searched: -<p> ./_sisu/skin<br> - -<p> ~/.sisu/skin<br> - -<p> /etc/sisu/skin<br> - -<p> Skins under the searched paths in a per document directory, a per directory -directory, or a site directory, named: -<p> doc [may be specified individually - in each document] -<p> dir [used if identifier part of name matches markup - directory name] -<p> site -<p> It is usual to place all skins in the document -directory, with symbolic links as required from dir or site directories. - -<p> 5.2 CSS -<p> The appearance of html and XML related output can be changed -for an ouput collection directory by prepareing and placing a new css file -in one of the sisu css directories searched in the sisu configuration path. -These are located at: -<p> _./_sisu/css -<p> ~/.sisu/css -<p> and -<p> /etc/sisu/css - -<p> The contents of the first directory found in the search path are copied -to the corresponding sisu output directory with the commnd: -<p> sisu -CC -<p> - The <b>SiSU</b> standard css files for <b>SiSU</b> output are: -<p> dom.css html.css html_tables.css - -<p>index.css sax.css xhtml.css -<p> A document may specify its own/bespoke css file -using the css header. -<p> @css: -<p> [expand] -<p> EXTRACTS FROM THE README -<p> 6. README - -<p> <b>SiSU</b> 0.55 2007w27/6 2007-07-07 -<p> Homepage: <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> -> -<p> <b>Description</b> - -<p> <b>SiSU</b> is lightweight markup based document creation and publishing framework -that is controlled from the command line. Prepare documents for <b>SiSU</b> using -your text editor of choice, then use <b>SiSU</b> to generate various output document -formats. -<p> With minimal preparation of a plain-text (UTF-8) file using its -native markup-syntax, <b>SiSU</b> produces: plain-text, HTML, XHTML, XML, ODF:ODT -(Opendocument), LaTeX, PDF, and populates an SQL database (PostgreSQL or -SQLite) in paragraph sized chunks so that document searches are done at - -<p>this -<p> Outputs share a common citation numbering system, and any semantic -meta-data provided about the document. -<p> <b>SiSU</b> also provides concordance files, -document content certificates and manifests of generated output. -<p> <b>SiSU</b> -takes advantage of well established open standard ways of representing -text, and provides a bridge to take advantage of the strengths of each, -while remaining simple. <b>SiSU</b> implements across document formats a from a - humanities, law, and possibly social sciences rather than technical or - scientific writing] ... focus is primarily on content and data integrity rather -than appearance, (though outputs in the various formats are respectable). - -<p> A vim syntax highlighting file and an ftplugin with folds for sisu markup -is provided. Vim 7 includes syntax highlighting for <b>SiSU</b> -<p> man pages, and -interactive help are provided. -<p> Dependencies for various features are taken -care of in sisu related packages. The package sisu-complete installs the -whole of <b>SiSU</b> -<p> Additional document markup samples are provided in the -package sisu-markup-samples which is found in the non-free archive the licenses -for the substantive content of the marked up documents provided is that -provided by the author or original publisher. -<p> Homepage: <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> -> - -<p> <b>SiSU</b> - simple information structuring universe, is a publishing tool, -document generation and management, (and search enabling) tool primarily -for literary, academic and legal published works. -<p> <b>SiSU</b> can be used for -Internet, Intranet, local filesystem or cd publishing. -<p> <b>SiSU</b> can be used -directly off the filesystem, or from a database. -<p> <b>SiSU</b> ’s scalability, is -be dependent on your hardware, and filesystem (in my case Reiserfs), and/or -database Postgresql. -<p> Amongst it’s characteristics are: -<p> * simple mnemonoic -markup style, -<p> * the ability to produce multiple output formats, including -html, structured XML, LaTeX, pdf (via LaTeX), stream to a relational database -whilst retaining document structure - Postgresql and Sqlite, -<p> * that all -share a common citation system (a simple idea from which much good), possibly -most exciting, the following: if fed into a relational database (as it -can be automatically), the document set is searchable, with results displayed -at a paragraph level, or the possibility of an indexed display of documents -in which the match is found together with a hyperlinked listing for each -of each paragraph in which the match is found. In any event citations using -this system (with or without the relational database) are relevant for -all output formats. -<p> * it is command line driven, and can be set up on - -<p>a remote server -<p> * Documents are marked up in <b>SiSU</b> syntax in your favourite -editor. <b>SiSU</b> syntax may be regarded as a type of smart ascii - which in its -basic form is simpler than the most elementary html. There is currently -a syntax highlighter, and folding for Vim. Syntax highlighters for other -editors are welcome. -<p> Input files should be UTF-8 -<p> Once set up it is simple -to use. -<p> 6.1 ONLINE INFORMATION, PLACES TO LOOK -<p> <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> -> - -<p> Download Sources: -<p> <<a href='http://www.jus.uio.no/sisu/SiSU/download.html#current'>http://www.jus.uio.no/sisu/SiSU/download.html#current</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/SiSU/download.html#debian'>http://www.jus.uio.no/sisu/SiSU/download.html#debian</a> -><br> - -<p> 6.2 INSTALLATION -<p> NB. Platform is Unix / Linux. -<p> 6.2.1 DEBIAN -<p> If you use -<b>Debian</b> use the <b>Debian</b> packages, check the information at: -<p> <<a href='http://www.jus.uio.no/sisu/SiSU/download.html#debian'>http://www.jus.uio.no/sisu/SiSU/download.html#debian</a> -><br> - -<p> (A) <b>SiSU</b> is available directly off the <b>Debian</b> archives for Sid and testing. -It should necessary only to run as root: -<p> aptitude update<br> - -<p> aptitude install sisu-complete<br> - -<p> (B) If there are newer versions of <b>SiSU</b> upstream of the <b>Debian</b> archives, - -<p>they will be available by adding the following to your /etc/apt/sources.list - -<p> deb <<a href='http://www.jus.uio.no/sisu/archive'>http://www.jus.uio.no/sisu/archive</a> -> unstable main non-free<br> - -<p> deb-src <<a href='http://www.jus.uio.no/sisu/archive'>http://www.jus.uio.no/sisu/archive</a> -> unstable main non-free<br> - -<p> [the non-free line is for document markup samples, for which the substantive - text is provided under the author or which original publisher’s license - and which in most cases will -<p> Then as root run: -<p> aptitude update<br> - -<p> aptitude install sisu-complete<br> - -<p> 6.2.2 RPM -<p> RPMs are provided though untested, they are prepared by running -alien against the source package, and against the debs. -<p> They may be downloaded -from: -<p> <<a href='http://www.jus.uio.no/sisu/SiSU/download.html#rpm'>http://www.jus.uio.no/sisu/SiSU/download.html#rpm</a> -><br> - -<p> 6.2.3 SOURCE PACKAGE .TGZ -<p> Otherwise to install <b>SiSU</b> from source, check -information at: -<p> <<a href='http://www.jus.uio.no/sisu/SiSU/download.html#current'>http://www.jus.uio.no/sisu/SiSU/download.html#current</a> -><br> - -<p> alternative modes of installation from source are provided, setup.rb -(by Minero Aoki), rake (by Jim Weirich) built install file, rant (by Stefan -Lang) built install file, -<p> <b>Ruby</b> is the essential dependency for the basic - -<p>operation of <b>SiSU</b> -<p> 1. Download the latest source (information available) -from: -<p> <<a href='http://www.jus.uio.no/sisu/SiSU/download.html#current'>http://www.jus.uio.no/sisu/SiSU/download.html#current</a> -><br> - -<p> 2. Unpack the source -<p> Note however, that additional external package -dependencies, such as texlive or postgresql should you desire to use it -are not taken care of for you. -<p> 6.2.4 TO USE SETUP.RB -<p> this is a three step -process, in the root directory of the unpacked <b>SiSU</b> as root type: -<p> ruby -setup.rb config<br> - -<p> ruby setup.rb setup<br> - -<p> as root: -<p> ruby setup.rb install<br> - -<p> further information: -<p> <<a href='http://i.loveruby.net/en/projects/setup/'>http://i.loveruby.net/en/projects/setup/</a> -><br> - -<p> <<a href='http://i.loveruby.net/en/projects/setup/doc/usage.html'>http://i.loveruby.net/en/projects/setup/doc/usage.html</a> -><br> - -<p> 6.2.5 TO USE INSTALL (PRAPARED WITH -<p> Rake must be installed on your system: - -<p> <<a href='http://rake.rubyforge.org/'>http://rake.rubyforge.org/</a> -><br> - -<p> <<a href='http://rubyforge.org/frs/?group_id=50'>http://rubyforge.org/frs/?group_id=50</a> -><br> - -<p> in the root directory of the unpacked <b>SiSU</b> as root type: -<p> rake<br> - -<p> or -<p> rake base<br> - -<p> This makes use of Rake (by Jim Weirich) and the provided Rakefile -<p> -For a list of alternative actions you may type: -<p> rake help<br> - -<p> rake -T<br> - -<p> 6.2.6 TO USE INSTALL (PRAPARED WITH -<p> (you may use the instructions above -for rake substituting rant if rant is installed on your system, or you -may use an independent installer created using rant as follows:) -<p> in the -root directory of the unpacked <b>SiSU</b> as root type: -<p> ruby ./sisu-install<br> - -<p> or -<p> ruby ./sisu-install base<br> - -<p> This makes use of Rant (by Stefan Lang) and the provided Rantfile. It -has been configured to do post installation setup setup configuration and -generation of first test file. Note however, that additional external package -dependencies, such as tetex-extra are not taken care of for you. -<p> further -information: -<p> <<a href='http://make.rubyforge.org/'>http://make.rubyforge.org/</a> -><br> - -<p> <<a href='http://rubyforge.org/frs/?group_id=615'>http://rubyforge.org/frs/?group_id=615</a> -><br> - -<p> For a list of alternative actions you may type: -<p> ruby ./sisu-install -help<br> - -<p> ruby ./sisu-install -T<br> - -<p> 6.3 DEPENDENCIES -<p> Once installed see ’man 8 sisu’ for some information -on additional programs that sisu makes use of, and that you may need or -wish to install. (this will depend on such factors as whether you want to -generate pdf, whether you will be using <b>SiSU</b> with or without a database, -...) ’man sisu_markup-samples’ may also be of interest if the sisu-markup-samples -package has also been installed. -<p> The information in man 8 may not be most -up to date, and it is possible that more useful information can be gleaned -from the following notes taken from the <b>Debian</b> control file (end edited), -gives an idea of additional packages that <b>SiSU</b> can make use of if available, -(the use/requirement of some of which are interdependent for specific actions -by <b>SiSU</b> ). -<p> The following is from the debian/control file of sisu-0.58.2, -which amongst other things provides the dependencies of sisu within <b>Debian</b> - -<p> -<p> <br> -<pre> Package: sisu - Architecture: all - Depends: ruby (>= 1.8.2), libwebrick-ruby, unzip, zip - Conflicts: vim-sisu, sisu-vim, sisu-remote - Replaces: vim-sisu, sisu-vim - Recommends: sisu-pdf, sisu-sqlite, sisu-postgresql, librmagick-ruby, trang, - tidy, librexml-ruby, openssl, rsync, openssh-client | lsh-client, keychain, - hyperestraier, kdissert, vim-addon-manager - Suggests: rcs | cvs, lv, texinfo, pinfo - Package: sisu-complete - Depends: ruby (>= 1.8.4), sisu, sisu-pdf, sisu-postgresql, sisu-sqlite - Recommends: hyperestraier - Package: sisu-pdf - Architecture: all - Depends: sisu, texlive-latex-base, texlive-fonts-recommended, - texlive-latex-recommended, texlive-latex-extra - Suggests: evince, xpdf - Package: sisu-postgresql - Depends: sisu, postgresql-8.1, libdbi-ruby, libdbm-ruby, libdbd-pg-ruby - Suggests: pgaccess, libdbd-pgsql, postgresql-contrib-8.1 - Package: sisu-sqlite - Depends: sisu, sqlite, libdbi-ruby, libdbm-ruby, libdbd-sqlite-ruby - Suggests: libdbd-sqlite - Package: sisu-markup-samples - Depends: sisu -</pre> -<p> -<p> <br> -<pre> Source: sisu - Section: text - Priority: optional - Maintainer: Ralph Amissah <ralph@amissah.com> - Build-Depends: debhelper (>= 5) - Standards-Version: 3.7.2 - Package: sisu - Architecture: all - Depends: ruby (>= 1.8.2), libwebrick-ruby, unzip, zip - Conflicts: vim-sisu, sisu-vim, sisu-remote - Replaces: vim-sisu, sisu-vim - Recommends: sisu-pdf, sisu-sqlite, sisu-postgresql, hyperestraier, keychain, -librmagick-ruby, librexml-ruby, openssl, openssh-client | lsh-client, rsync, -tidy, vim-addon-manager - Suggests: kdissert, lv, rcs | cvs, pinfo, texinfo, trang - Description: documents - structuring, publishing in multiple formats and -search - SiSU is a lightweight markup based, command line oriented, document - structuring, publishing and search framework for document collections. - . - With minimal preparation of a plain-text, (UTF-8) file, using its native - markup syntax in your text editor of choice, SiSU can generate various - document formats (most of which share a common object numbering system -for - locating content), including plain text, HTML, XHTML, XML, OpenDocument -text - (ODF:ODT), LaTeX, PDF files, and populate an SQL database with objects - (roughly paragraph-sized chunks) so searches may be performed and matches - returned with that degree of granularity: your search criteria is met -by these - documents and at these locations within each document. Object numbering -is - particularly suitable for - works that are frequently changed or updated) for which it provides -a fixed - means of reference of content. Document outputs also share semantic meta-data - provided. - . - SiSU also provides concordance files, document content certificates -and - manifests of generated output. - . - A vim syntax highlighting file and an ftplugin with folds for sisu markup -is - provided, as are syntax highlighting files for kate, kwrite, gedit and - diakonos. Vim 7 includes syntax highlighting for SiSU. - . - man pages, and interactive help are provided. - . - Dependencies for various features are taken care of in sisu related -packages. - The package sisu-complete installs the whole of SiSU. - . - Additional document markup samples are provided in the package - sisu-markup-samples which is found in the non-free archive the licenses -for - the substantive content of the marked up documents provided is that -provided - by the author or original publisher. - . - Homepage: <http://www.jus.uio.no/sisu> -</pre> -<p> -<p> <br> -<pre> Package: sisu-complete - Architecture: all - Depends: ruby (>= 1.8.2), sisu, sisu-pdf, sisu-postgresql, sisu-sqlite - Recommends: hyperestraier - Description: installs all SiSU related packages - This package installs SiSU and related packages that enable sisu to -produce - pdf and to populate postgresql and sqlite databases. - . - SiSU is a lightweight markup based document publishing framework. - . - See sisu for a description of the package. - . - Homepage: <http://www.jus.uio.no/sisu> -</pre> -<p> -<p> <br> -<pre> Package: sisu-pdf - Architecture: all - Depends: sisu, texlive-latex-base, texlive-fonts-recommended, texlive-latex-recommended, -texlive-latex-extra - #Suggests: evince, xpdf - Description: dependencies to convert SiSU LaTeX output to pdf - This package enables the conversion of SiSU LaTeX output to pdf. - . - SiSU is a lightweight markup based document publishing framework. - . - Homepage: <http://www.jus.uio.no/sisu> -</pre> -<p> -<p> <br> -<pre> Package: sisu-postgresql - Architecture: all - Depends: sisu, libdbd-pg-ruby, libdbi-ruby, libdbm-ruby, postgresql - Recommends: libfcgi-ruby - Suggests: postgresql-contrib - Description: SiSU dependencies for use with postgresql database - This package enables SiSU to populate a postgresql database. This is -done at - an object/paragraph level, making granular searches of documents possible. - . - This relational database feature of SiSU is not required but provides - interesting possibilities, including that of granular searches of documents - for matching units of text, primarily paragraphs that can be displayed -or - identified by object citation number, from which an index of documents - matched and each matched paragraph within them can be displayed. - . - SiSU is a lightweight markup based document publishing framework. - . - Homepage: <http://www.jus.uio.no/sisu> -</pre> -<p> -<p> <br> -<pre> Package: sisu-sqlite - Architecture: all - Depends: sisu, sqlite, libdbd-sqlite-ruby, libdbi-ruby, libdbm-ruby - Recommends: libfcgi-ruby - Description: SiSU dependencies for use with sqlite database - This package enables SiSU to populate an sqlite database. This is done -at an - object/paragraph level, making granular searches of documents possible. - . - This relational database feature of SiSU is not required but provides - interesting possibilities, including that of granular searches of documents - for matching units of text, primarily paragraphs that can be displayed -or - identified by object citation number, from which an index of documents - matched and each matched paragraph within them can be displayed. - . - SiSU is a lightweight markup based document publishing framework. - . - Homepage: <http://www.jus.uio.no/sisu> -</pre> -<p> 6.4 QUICK START -<p> Most of the installation should be taken care of by the -aptitude or rant install. (The rant install if run in full will also test -run the generation of the first document). -<p> After installation of sisu-complete, - -<p>move to the document samples directory -<p> cd /usr/share/doc/sisu/sisu_markup_samples/dfsg<br> - -<p> and run -<p> sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst<br> - -<p> or the same: -<p> sisu -NhwpoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst<br> - -<p> look at output results, see the -<p> or to generate an online document -move to a writable directory, as the file will be downloaded there and -e.g. -<p> sisu -3 <<a href='http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst'>http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst</a> -> - -<p> the database stuff is extra perhaps, the latex stuff could be considered - -<p>extra perhaps but neither needs to be installed for most of sisu output - -<p>to work -<p> examine source document, vim has syntax support -<p> gvim free_as_in_freedom.rms_and_free_software.sam_williams.sst - -<p> additional markup samples in -<p> <<a href='http://www.jus.uio.no/sisu/SiSU/2.html'>http://www.jus.uio.no/sisu/SiSU/2.html</a> -><br> - -<p> For help -<p> man sisu<br> - -<p> or -<p> sisu --help<br> - -<p> e.g. -<p> for the way sisu -<p> sisu --help env<br> - -<p> for list of commands and so on -<p> sisu --help commands<br> - -<p> 6.5 CONFIGURATION FILES -<p> The default configuration/setup is contained - -<p>within the program and is altered by configuration settings in <i>etc</i> [sisu - -<p> version]/sisurc.yml or in ~/.sisu/sisurc.yml -<p> * configuration file - a yaml - -<p>file -<p> /etc/sisu/[sisu version]/sisurc.yml<br> - -<p> ~/.sisu/sisurc.yml<br> - -<p> * directory structure - setting up of output and working directory. -<p> -* skins - changing the appearance of a project, directory or individual - -<p>documents within ~/.sisu/skin -<p> ~/.sisu/skin/doc contains individual skins, -with symbolic links from<br> - -<p> ~/.sisu/skin/dir if the contents of a directory are to take a particular<br> - document skin.<br> - -<p> * additional software - eg. Tex and LaTeX (tetex, tetex-base, tetex-extra -on <b>Debian</b> ), Postgresql, [sqlite], trang, tidy, makeinfo, ... none of which -are required for basic html or XML processing. -<p> * if you use Vim as editor -there is a syntax highlighter and fold resource config file for <b>SiSU</b> <i>hope</i> -more syntax highlighters follow. -<p> There are post installation steps (which -are really part of the overall installation) -<p> sisu -C in your marked up -document directory, should do some auto-configuring provided you have the -right permissions for the output directories. (and provided the output directories -have already been specified if you are not using the defaults). -<p> 6.6 USE - -<p>GENERAL OVERVIEW -<p> Documents are marked up in <b>SiSU</b> syntax and kept in an -ordinary text editable file, named with the suffix .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> ’man sisu_markup-samples’ [if the sisu-markup-samples package is also installed] - -<p> Once installed an interactive help is available typing ’sisu’ (without) -any flags, and select an option: -<p> sisu<br> - -<p> alternatively, you could type e.g. -<p> sisu --help commands<br> - -<p> sisu --help env<br> - -<p> sisu --help headers<br> - -<p> sisu --help markup<br> - -<p> sisu --help headings<br> - -<p> etc. -<p> for questions about mappings, output paths etc. -<p> sisu --help env<br> - -<p> sisu --help path<br> - -<p> sisu --help directory<br> - -<p> 6.8 DIRECTORY STRUCTURE -<p> Once installed, type: -<p> sisu --help env<br> - -<p> or -<p> sisu -V<br> - -<p> 6.9 CONFIGURATION FILE -<p> The defaults can be changed via <b>SiSU</b> ’s configure -file sisurc.yml which the program expects to find in ./_sisu ~/.sisu or /etc/sisu -(searched in that order, stopping on the first one found) -<p> 6.10 MARKUP -<p> - See man pages. -<p> man sisu<br> - -<p> man 8 sisu<br> - -<p> Once installed there is some information on <b>SiSU</b> Markup in its help: - -<p> sisu --help markup<br> - -<p> and -<p> sisu --help headers<br> - -<p> Sample marked up document are provided with the download tarball in -the directory: -<p> ./data/doc/sisu/sisu_markup_samples/dfsg<br> - -<p> These are installed on the system usually at: -<p> /usr/share/doc/sisu/sisu_markup_samples/dfsg<br> - -<p> More markup samples are available in the package sisu-markup-samples -<p> - <<a href='http://www.jus.uio.no/sisu/SiSU/download.html#sisu-markup-samples'>http://www.jus.uio.no/sisu/SiSU/download.html#sisu-markup-samples</a> -><br> - -<p> Many more are available online off: -<p> <<a href='http://www.jus.uio.no/sisu/SiSU/2.html'>http://www.jus.uio.no/sisu/SiSU/2.html</a> -><br> - -<p> 6.11 ADDITIONAL THINGS -<p> There is syntax support for some editors provided -(together with a README file) in -<p> ./data/sisu/conf/syntax<br> - -<p> usually installed to: -<p> /usr/share/sisu/conf/syntax<br> - -<p> 6.12 LICENSE -<p> License: GPL 3 or later see the copyright file in -<p> ./data/doc/sisu<br> - -<p> usually installed to: -<p> /usr/share/doc/sisu<br> - -<p> 6.13 SISU STANDARD -<p> <b>SiSU</b> uses: -<p> * Standard <b>SiSU</b> markup syntax, -<p> * Standard -<b>SiSU</b> meta-markup syntax, and the -<p> * Standard <b>SiSU</b> object citation numbering - -<p>and system -<p> © Ralph Amissah 1997, current 2006 All Rights Reserved. -<p> * - -<p>however note the License section -<p> CHANGELOG -<p> ./CHANGELOG<br> - -<p> and see -<p> <<a href='http://www.jus.uio.no/sisu/SiSU/changelog.html'>http://www.jus.uio.no/sisu/SiSU/changelog.html</a> -><br> - -<p> <<a href='http://www.jus.uio.no/sisu/SiSU/changelog_markup_samples.html'>http://www.jus.uio.no/sisu/SiSU/changelog_markup_samples.html</a> -><br> - -<p> EXTRACTS FROM MAN 8 SISU -<p> 7. POST INSTALLATION SETUP -<p> 7.1 POST INSTALLATION -SETUP - QUICK START -<p> After installation of sisu-complete, move to the document -samples directory, -<p> cd /usr/share/doc/sisu/sisu_markup_samples/dfsg<br> - -<p> [this is not where you would normally work but provides sample documents - for testing, you may prefer instead to copy the contents of that directory - to a local directory before proceeding] -<p> and in that directory, initialise - -<p>the output directory with the command -<p> sisu -CC<br> - -<p> then run: -<p> sisu -1 free_as_in_freedom.rms_and_free_software.sam_williams.sst<br> - -<p> or the same: -<p> sisu -NhwpoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst<br> - -<p> look at output results, see the -<p> for an overview of your current sisu -setup, type: -<p> sisu --help env<br> - -<p> or -<p> sisu -V<br> - -<p> To generate a document from a remote url accessible location move to -a writable directory, (create a work directory and cd into it) as the file -will be downloaded there and e.g. -<p> sisu -1 <<a href='http://www.jus.uio.no/sisu/gpl3.fsf/gpl3.fsf.sst'>http://www.jus.uio.no/sisu/gpl3.fsf/gpl3.fsf.sst</a> -><br> - -<p> sisu -3<br> - <<a href='http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst'>http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst</a> -><br> - -<p> examine source document, vim has syntax highlighting support -<p> gvim - -<p>free_as_in_freedom.rms_and_free_software.sam_williams.sst -<p> additional markup - -<p>samples in -<p> <<a href='http://www.jus.uio.no/sisu/SiSU/2.html'>http://www.jus.uio.no/sisu/SiSU/2.html</a> -><br> - -<p> it should also be possible to run sisu against sisupods (prepared zip -files, created by running the command sisu -S [filename]), whether stored -locally or remotely. -<p> sisu -3<br> - <<a href='http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip'>http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip</a> -><br> - -<p> there is a security issue associated with the running of document skins -that are not your own, so these are turned of by default, and the use of -the following command, which switches on the associated skin is not recommended: - -<p> sisu -3 --trust<br> - <<a href='http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip'>http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip</a> -><br> - -<p> For help -<p> man sisu<br> - -<p> sisu --help<br> - -<p> sisu --help env for the way sisu<br> - -<p> sisu --help commands for list of commands and so on<br> - -<p> 7.2 DOCUMENT MARKUP DIRECTORY -<p> Perhaps the easiest way to begin is to -create a directory for sisu marked up documents within your home directory, -and copy the file structure (and document samples) provided in the document -sample directory: -<p> mkdir ~/sisu_test<br> - -<p> cd ~/sisu_test<br> - -<p> cp -a /usr/share/doc/sisu/sisu_markup_samples/dfsg/* ~/sisu_test/.<br> - -<p> <b>Tip:</b> the markup syntax examples may be of interest -<p> <<a href='http://www.jus.uio.no/sisu/sample/'>http://www.jus.uio.no/sisu/sample/</a> -><br> - -<p> <b>Tip:</b> -<p> sisu -U [sisu markup filename]<br> - -<p> should printout the different possible outputs and where sisu would -place them. -<p> <b>Tip:</b> if you want to toggle ansi color add -<p> c<br> - -<p> to your flags. -<p> 7.2.1 CONFIGURATION FILES -<p> <b>SiSU</b> configuration file search -path is: -<p> ./_sisu/sisurc.yaml<br> - -<p> ~/.sisu/sisurc.yaml<br> - -<p> /etc/sisu/sisurc.yaml<br> - -<p> <b>Debian</b> Installation Note -<p> 7.2.2 DEBIAN INSTALLATION NOTE -<p> It is best - -<p>you see -<p> <<a href='http://www.jus.uio.no/sisu/SiSU/download.html#debian'>http://www.jus.uio.no/sisu/SiSU/download.html#debian</a> -><br> - -<p> for up the most up to date information. -<p> notes taken from the <b>Debian</b> -control file (end edited), gives an idea of additional packages that <b>SiSU</b> -can make use of if available, (the use/requirement of some of which are -interdependent for specific actions by <b>SiSU</b> ): -<p> Package: sisu -<p> <b>SiSU</b> is -a lightweight markup based, command line oriented, document structuring, -publishing and search framework for document collections. -<p> With minimal -preparation of a plain-text, (UTF-8) file, using its native markup syntax -in your text editor of choice, <b>SiSU</b> can generate various document formats -(most of which share a common object numbering system for locating content), -including plain text, HTML, XHTML, XML, OpenDocument text (ODF:ODT), LaTeX, -PDF files, and populate an SQL database with objects (roughly paragraph-sized -chunks) so searches may be performed and matches returned with that degree -of granularity: your search criteria is met by these documents and at these -locations within each document. Object numbering is particularly suitable -for opposed to works that are frequently changed or updated) for which -it provides a fixed means of reference of content. Document outputs also -share semantic meta-data provided. -<p> <b>SiSU</b> also provides concordance files, -document content certificates and manifests of generated output. -<p> A vim -syntax highlighting file and an ftplugin with folds for sisu markup is -provided, as are syntax highlighting files for kate, kwrite, gedit and -diakonos. Vim 7 includes syntax highlighting for <b>SiSU</b> -<p> man pages, and -interactive help are provided. -<p> Dependencies for various features are taken -care of in sisu related packages. The package sisu-complete installs the -whole of <b>SiSU</b> -<p> Additional document markup samples are provided in the -package sisu-markup-samples which is found in the non-free archive the licenses -for the substantive content of the marked up documents provided is that -provided by the author or original publisher. -<p> Homepage: <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> -> - -<p> 7.2.3 DOCUMENT RESOURCE CONFIGURATION -<p> <b>sisu</b> resource configuration information -is obtained from sources (where they exist): -<p> ~/.sisu/sisurc.yaml<br> - -<p> /etc/sisu/[sisu version]/sisurc.yaml<br> - -<p> sisu program defaults<br> - -<p> 7.2.4 SKINS -<p> <b>Skins</b> default document appearance may be modified using skins -contained in sub-directories located at the following paths: -<p> ./_sisu/skin<br> - -<p> ~/.sisu/skin<br> - -<p> /etc/sisu/skin<br> - -<p> more specifically, the following locations (or their /etc/sisu equivalent) -should be used: -<p> ~/.sisu/skin/doc<br> - -<p> skins for individual documents; -<p> ~/.sisu/skin/dir<br> - -<p> skins for directories of matching names; -<p> ~/.sisu/skin/site<br> - -<p> site-wide skin modifying the site-wide appearance of documents. -<p> Usually -all skin files are placed in the document skin directory: -<p> ~/.sisu/skin/doc<br> - -<p> with softlinks being made to the skins contained there from other skin -directories as required. -<p> DOCUMENT INFORMATION (METADATA) -<p> METADATA -<p> -Document Manifest @ <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_howto/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_howto/sisu_manifest.html</a> -> - -<p> <b>Dublin Core</b> (DC) -<p> <i>DC</i> tags included with this document are provided here. - -<p> DC Title: <i>SiSU</i> - 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) - [i486-linux] -<p> -<ol> -<b>.</b><li>generated from source using rman <<a href='http://polyglotman.sourceforge.net/rman.html'>http://polyglotman.sourceforge.net/rman.html</a> -><br> - With regard to<br> - <b>SiSU</b> man pages the formatting generated for markup syntax is not quite -right, for that you might prefer the links under: <<a href='http://www.jus.uio.no/sample'>http://www.jus.uio.no/sample</a> -><br> - </li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man/'>http://www.jus.uio.no/sisu/man/</a> -> </li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man/sisu.1.html'>http://www.jus.uio.no/sisu/man/sisu.1.html</a> -> </li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man/sisu.8.html'>http://www.jus.uio.no/sisu/man/sisu.8.html</a> -> -</li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man/sisu_examples.1.html'>http://www.jus.uio.no/sisu/man/sisu_examples.1.html</a> -> </li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man/sisu_webrick.1.html'>http://www.jus.uio.no/sisu/man/sisu_webrick.1.html</a> -> -</li><b>.</b><li>this is an endnote </li><b>.</b><li><<a href='http://sisudoc.org'>http://sisudoc.org</a> -> </li><b>.</b><li><<a href='http://sisudoc.org'>http://sisudoc.org</a> -> -<p> </dd> - -<dt>Other versions -of this document: </dt> -<dd></dd> - -<dt>manifest: <<a href='http://www.jus.uio.no/sisu/sisu_howto/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_howto/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_howto/sisu_manifest.html</a> -</a> -> -</dt> -<dd></dd> - -<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_howto/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_howto/toc.html'>http://www.jus.uio.no/sisu/sisu_howto/toc.html</a> -</a> -> </dt> -<dd></dd> - -<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_howto/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_howto/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_howto/portrait.pdf</a> -</a> -> -</dt> -<dd></dd> - -<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_howto/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_howto/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_howto/landscape.pdf</a> -</a> -> </dt> -<dd> </dd> - -<dt>at: <<a href='http://www.jus.uio.no/sisu'><a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> -</a> -> -</dt> -<dd></dd> - -<dt>* Generated by: SiSU 0.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> diff --git a/data/doc/sisu/html/sisu_markup.1.html b/data/doc/sisu/html/sisu_markup.1.html deleted file mode 100644 index 3be61258..00000000 --- a/data/doc/sisu/html/sisu_markup.1.html +++ /dev/null @@ -1,1113 +0,0 @@ -<!-- manual page source format generated by PolyglotMan v3.2, --> -<!-- available at http://polyglotman.sourceforge.net/ --> - -<html> -<head> -<title>"sisu_markup"("1") manual page</title> -</head> -<body bgcolor='white'> -<a href='#toc'>Table of Contents</a><p> -SISU - MARKUP, RALPH AMISSAH -<p> SISU MARKUP -<p> 1. INTRODUCTION TO SISU MARKUP[^1] - -<p> 1.1 SUMMARY -<p> <b>SiSU</b> source documents are plaintext (UTF-8)[^2] files -<p> All -paragraphs are separated by an empty line. -<p> Markup is comprised of: -<p> * -at the top of a document, the document header made up of semantic meta-data -about the document and if desired additional processing instructions (such -an instruction to automatically number headings from a particular level -down) -<p> * followed by the prepared substantive text of which the most important -single characteristic is the markup of different heading levels, which -define the primary outline of the document structure. Markup of substantive -text includes: -<p> * heading levels defines document structure<br> - -<p> * text basic attributes, italics, bold etc.<br> - -<p> * grouped text (objects), which are to be treated differently, such -as code<br> - blocks or poems.<br> - -<p> * footnotes/endnotes<br> - -<p> * linked text and images<br> - -<p> * paragraph actions, such as indent, bulleted, numbered-lists, etc.<br> - -<p> Some interactive help on markup is available, by typing sisu and selecting - -<p>markup or sisu --help markup -<p> 1.2 MARKUP EXAMPLES -<p> 1.2.1 ONLINE -<p> Online markup -examples are available together with the respective outputs produced from -<<a href='http://www.jus.uio.no/sisu/SiSU/2.html'>http://www.jus.uio.no/sisu/SiSU/2.html</a> -> or from <<a href='http://www.jus.uio.no/sisu/sisu_examples/'>http://www.jus.uio.no/sisu/sisu_examples/</a> -> - -<p> There is of course this document, which provides a cursory overview of -sisu markup and the respective output produced: <<a href='http://www.jus.uio.no/sisu/sisu_markup/'>http://www.jus.uio.no/sisu/sisu_markup/</a> -> - -<p> Some example marked up files are available as html with syntax highlighting -for viewing: <<a href='http://www.jus.uio.no/sisu/sample/syntax'>http://www.jus.uio.no/sisu/sample/syntax</a> -> -<p> an alternative presentation -of markup syntax: <<a href='http://www.jus.uio.no/sisu/sample/on_markup.txt'>http://www.jus.uio.no/sisu/sample/on_markup.txt</a> -> -<p> 1.2.2 INSTALLED - -<p> With <b>SiSU</b> installed sample skins may be found in: /usr/share/doc/sisu/sisu_markup_samples/dfsg -(or equivalent directory) and if sisu-markup-samples is installed also under: - -<p>/usr/share/doc/sisu/sisu_markup_samples/non-free -<p> 2. MARKUP OF HEADERS -<p> - Headers consist of semantic meta-data about a document, which can be used -by any output module of the program; and may in addition include extra -processing instructions. -<p> Note: the first line of a document may include -information on the markup version used in the form of a comment. Comments -are a percentage mark at the start of a paragraph (and as the first character -in a line of text) followed by a space and the comment: -<p> -<p> <br> -<pre> % this would be a comment -</pre> -<p> 2.1 SAMPLE HEADER -<p> This current document has a header similar to this -one (without the comments): -<p> -<p> <br> -<pre> % SiSU 0.57 - @title: SiSU - @subtitle: Markup - @creator: Ralph Amissah - @rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, -License GPL 3 - @type: information - @subject: ebook, epublishing, electronic book, electronic publishing, -electronic document, electronic citation, data structure, citation systems, -search - @date.created: 2002-08-28 - @date.issued: 2002-08-28 - @date.available: 2002-08-28 - @date.modified: 2007-09-16 - @date: 2007-09-16 - @level: new=C; break=1; num_top=1 - % comment: in this @level header num_top=1 starts automatic heading numbering -at heading level 1 (numbering continues 3 levels down); the new and break -instructions are used by the LaTeX/pdf and odf output to determine where -to put page breaks (that are not used by html output or say sql database -population). - @skin: skin_sisu_manual - % skins modify the appearance of a document and are placed in a sub-directory -under ./_sisu/skin ~/.sisu/skin or /etc/sisu/skin. A skin may affect single -documents that request them, all documents in a directory, or be site-wide. -(A document is affected by a single skin) - @bold: /Gnu|Debian|Ruby|SiSU/ - @links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html -</pre> -<p> 2.2 AVAILABLE HEADERS -<p> Header tags appear at the beginning of a document -and provide meta information on the document (such as the Dublin Core), -or information as to how the document as a whole is to be processed. All -header instructions take either the form @headername: or 0~headername. All - -<p>Dublin Core meta tags are available -<p> <b>@indentifier:</b> information or instructions - -<p> where the information -<p> Note: a header where used should only be used -once; all headers apart from @title: are optional; the @structure: header -is used to describe document structure, and can be useful to know. -<p> This - -<p>is a sample header -<p> <b>% SiSU 0.38</b> [declared file-type identifier with markup - version] -<p> <b>@title:</b> [title text] This is the title of the document and used -as such, this header is the only one that is <i>mandatory</i> -<p> <b>@subtitle:</b> The - -<p>Subtitle if any -<p> <b>@creator:</b> [or @author:] Name of Author -<p> <b>@subject:</b> (whatever -your subject) -<p> <b>@description:</b> -<p> <b>@publisher:</b> -<p> <b>@contributor:</b> -<p> <b>@translator:</b> - [or @translated_by:] -<p> <b>@illustrator:</b> [or @illustrated_by:] -<p> <b>@prepared_by:</b> - [or @digitized_by:] -<p> <b>@date: 2000-08-27</b> [ also @date.created: @date.issued: - @date.available: @date.valid: @date.modified: ] -<p> <b>@type: article</b> -<p> <b>@format:</b> - -<p> <b>@identifier:</b> -<p> <b>@source:</b> -<p> <b>@language:</b> [or @language.document:] [country - code for language if available, or language, English, en is the default - setting] (en - English, fr - French, de - German, it - Italian, es - Spanish, -pt - Portuguese, sv - Swedish, da - Danish, fi - Finnish, no - Norwegian, is -- Icelandic, nl - Dutch, et - Estonian, hu - Hungarian, pl - Polish, ro - Romanian, -ru - Russian, el - Greek, uk - Ukranian, tr - Turkish, sk - Slovak, sl - Slovenian, -hr - Croatian, cs - Czech, bg - Bul garian ) [however, encodings are not available - for all of the languages listed.] -<p> [@language.original: original language - in which the work was published] -<p> <b>@papersize:</b> (A4|US_letter|book_B5|book_A5|US_legal) - -<p> <b>@relation:</b> -<p> <b>@coverage:</b> -<p> <b>@rights:</b> Copyright (c) Name of Right Holder, -all rights reserved, or as granted: public domain, copyleft, creative commons -variant, etc. -<p> <b>@owner:</b> -<p> <b>@keywords:</b> text document generation processing -management latex pdf structured xml citation [your keywords here, used - for example by rss feeds, and in sql searches] -<p> <b>@abstract:</b> [paper abstract, - placed after table of contents] -<p> <b>@comment:</b> [...] -<p> <b>@catalogue:</b> loc=[Library - of Congress classification]; dewey=[Dewey rss feeds, classification]; isbn=[ISBN]; -pg=[Project Gutenberg text number] -<p> <b>@classify_loc:</b> [Library of Congress - classification] -<p> <b>@classify_dewey:</b> [Dewey classification] -<p> <b>@classify_isbn:</b> - [ISBN] -<p> <b>@classify_pg:</b> [Project Gutenberg text number] -<p> <b>@prefix:</b> [prefix - is placed just after table of contents] -<p> <b>@prefix_a:</b> [prefix is placed - just before table of contents - not implemented] -<p> <b>@prefix_b:</b> -<p> <b>@rcs:</b> $Id: -sisu_markup.sst,v 1.2 2007/09/08 17:12:47 ralph Exp $ [used by rcs or cvs - to embed version (revision control) information into under ./_sisu/skin -~/.sisu/skin or /etc/sisu/skin. A skin may affect single documents that request -them, all documents in a directory, or be site-wide. (A document is affected -by a single skin) document, rcs or cvs can usefully provide a history of -under ./_sisu/skin ~/.sisu/skin or /etc/sisu/skin. A skin may affect single -documents that request them, all documents in a directory, or be site-wide. -(A document is affected by a single skin) updates to a document ] -<p> <b>@structure:</b> -PART; CHAPTER; SECTION; ARTICLE; none; none; optional, document structure -can be defined by words to match or regular expression (the regular expression -is assumed to start at the beginning of a line of text i.e. ^) default markers -:A~ to :C~ and 1~ to 6~ can be used within text instead, without this header -tag, and may be used to supplement the instructions provided in this header -tag if provided (@structure: is a synonym for @toc:) -<p> <b>@level:</b> newpage=3; -breakpage=4 [paragraph level, used by latex to breakpages, the page in - newpage] -<p> <b>@markup:</b> information on the markup used, e.g. new=1,2,3; break=4; -num_top=4 [or newpage=1,2,3; breakpage=4; num_top=4] newpage and breakpage, -heading level, used by LaTeX to breakpages. breakpage: starts on a new page -in single column text and on a new column in double column text; newpage: -starts on a new page for both single and double column texts. num_top=4 - [auto-number document, starting at level 4. the new default is to provide - 3 levels, as in 1 level 4, 1.1 1.1.1 level 6, markup to be merged within level] -num_extract [take numbering of headings provided (manually in and use - for numbering of Available where a clear numbering structure is without - the repetition of a number in a header.] [In 0.38 notation, you would map - to the equivalent levels, the examples provided would map to the following - new=A,B,C; break=1; num_top=1 [or newpage=A,B,C; breakpage=1; num_top=1] -see headings] -<p> <b>@bold:</b> [regular expression of words/phrases to be made - bold] -<p> <b>@italics:</b> [regular expression of words/phrases to italicise] -<p> -<b>@vocabulary:</b> name of taxonomy/vocabulary/wordlist to use against document - -<p> <b>@skin:</b> skin_doc_[name_of_desired_document_skin] skins change default -settings related to the appearance of documents generated, such as the -urls of the home site, and the icon/logo for the document or site. -<p> <b>@links:</b> -{ <b>SiSU</b> }<a href='http://www.jus.uio.no/sisu/;'>http://www.jus.uio.no/sisu/;</a> - { FSF }<a href='http://www.fsf.org'>http://www.fsf.org</a> - -<p> <b>@promo:</b> sisu, -ruby, search_libre_docs, open_society [places content in right pane in - html, makes use of list.yml and promo.yml, commented out sample in document -sample: and promo.yml, commented out sample in document free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst] - -<p> 3. MARKUP OF SUBSTANTIVE TEXT -<p> 3.1 HEADING LEVELS -<p> Heading levels are -:A~ ,:B~ ,:C~ ,1~ ,2~ ,3~ ... :A - :C being part / section headings, followed -by other heading levels, and 1 -6 being headings followed by substantive -text or sub-headings. :A~ usually the title :A~? conditional level 1 heading -(used where a stand-alone document may be imported into another) -<p> <b>:A~ [heading - text]</b> Top level heading [this usually has similar content to the ] NOTE: -the heading levels described here are in 0.38 notation, see heading -<p> <b>:B~ - [heading text]</b> Second level heading [this is a heading level divider] -<p> - <b>:C~ [heading text]</b> Third level heading [this is a heading level divider] - -<p> <b>1~ [heading text]</b> Top level heading preceding substantive text of document -or sub-heading 2, the heading level that would normally be marked 1. or 2. -or 3. etc. in a document, and the level on which sisu by default would break -html output into named segments, names are provided automatically if none -are given (a number), otherwise takes the form 1~my_filename_for_this_segment - -<p> <b>2~ [heading text]</b> Second level heading preceding substantive text of -document or sub-heading 3, the heading level that would normally be marked -1.1 or 1.2 or 1.3 or 2.1 etc. in a document. -<p> <b>3~ [heading text]</b> Third level -heading preceding substantive text of document, that would normally be -marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a document -<p> -<p> <br> -<pre> 1~filename level 1 heading, - % the primary division such as Chapter that is followed by substantive -text, and may be further subdivided (this is the level on which by default -html segments are made) -</pre> -<p> 3.2 FONT ATTRIBUTES -<p> <b>markup example:</b> -<p> -<p> <br> -<pre> normal text !{emphasis}! *{bold text}* _{underscore}_ /{italics}/ - normal text - !{emphasis}! - *{bold text}* - _{underscore} - /{italics}/ - - ^{superscript}^ - ,{subscript}, - +{inserted text}+ - -{strikethrough}- -</pre> -<p> <b>resulting output:</b> -<p> normal text <em>emphasis</em> <b>bold text</b> <i>underscore</i> <i>italics</i> -<cite>citation</cite> ^superscript^ [subscript] <ins>inserted text</ins> <del>strikethrough</del> - -<p> normal text -<p> <em>emphasis</em> -<p> <b>bold text</b> -<p> <i>underscore</i> -<p> <i>italics</i> -<p> <cite>citation</cite> - -<p> ^superscript^ -<p> [subscript] -<p> <ins>inserted text</ins> -<p> <del>strikethrough</del> - -<p> 3.3 INDENTATION AND BULLETS -<p> <b>markup example:</b> -<p> -<p> <br> -<pre> ordinary paragraph - _1 indent paragraph one step - _2 indent paragraph two steps - _9 indent paragraph nine steps -</pre> -<p> <b>resulting output:</b> -<p> ordinary paragraph -<p> indent paragraph one step<br> - -<p> indent paragraph two steps<br> - -<p> indent paragraph nine steps<br> - -<p> <b>markup example:</b> -<p> -<p> <br> -<pre> * bullet text - _1* bullet text, first indent - _2* bullet text, two step indent -</pre> -<p> <b>resulting output:</b> -<p> * bullet text -<p> * bullet text, first indent<br> - -<p> * bullet text, two step indent<br> - -<p> Numbered List (not to be confused with headings/titles, (document structure)) - -<p> <b>markup example:</b> -<p> -<p> <br> -<pre> # numbered list numbered list 1., 2., 3, etc. - _# numbered list numbered list indented a., b., c., d., etc. -</pre> -<p> 3.4 FOOTNOTES / ENDNOTES -<p> Footnotes and endnotes not distinguished in -markup. They are automatically numbered. Depending on the output file format -(html, odf, pdf etc.), the document output selected will have either footnotes -or endnotes. -<p> <b>markup example:</b> -<p> -<p> <br> -<pre> ~{ a footnote or endnote }~ -</pre> -<p> <b>resulting output:</b> -<p> [^3] -<p> <b>markup example:</b> -<p> -<p> <br> -<pre> normal text~{ self contained endnote marker & endnote in one }~ continues -</pre> -<p> <b>resulting output:</b> -<p> normal text[^4] continues -<p> <b>markup example:</b> -<p> -<p> <br> -<pre> normal text ~{* unnumbered asterisk footnote/endnote, insert multiple -asterisks if required }~ continues - normal text ~{** another unnumbered asterisk footnote/endnote }~ continues -</pre> -<p> <b>resulting output:</b> -<p> normal text [^*] continues -<p> normal text [^**] continues - -<p> <b>markup example:</b> -<p> -<p> <br> -<pre> normal text ~[* editors notes, numbered asterisk footnote/endnote series - ]~ continues - normal text ~[+ editors notes, numbered asterisk footnote/endnote series - ]~ continues -</pre> -<p> <b>resulting output:</b> -<p> normal text [^*1] continues -<p> normal text [^+1] continues - -<p> <b>Alternative endnote pair notation for footnotes/endnotes:</b> -<p> -<p> <br> -<pre> - % note the endnote marker - normal text~^ continues - ^~ endnote text following the paragraph in which the marker occurs -</pre> -<p> the standard and pair notation cannot be mixed in the same document -<p> - -<p>3.5 LINKS -<p> 3.5.1 NAKED URLS WITHIN TEXT, DEALING WITH URLS -<p> urls are found -within text and marked up automatically. A url within text is automatically -hyperlinked to itself and by default decorated with angled braces, unless -they are contained within a code block (in which case they are passed as -normal text), or escaped by a preceding underscore (in which case the decoration -is omitted). -<p> <b>markup example:</b> -<p> -<p> <br> -<pre> normal text http://www.jus.uio.no/sisu continues -</pre> -<p> <b>resulting output:</b> -<p> normal text <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> -> continues -<p> An - -<p>escaped url without decoration -<p> <b>markup example:</b> -<p> -<p> <br> -<pre> normal text http://www.jus.uio.no/sisu continues - deb http://www.jus.uio.no/sisu/archive unstable main non-free -</pre> -<p> <b>resulting output:</b> -<p> normal text <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> - continues -<p> deb - -<p><a href='http://www.jus.uio.no/sisu/archive'>http://www.jus.uio.no/sisu/archive</a> - unstable main non-free -<p> where a code block -is used there is neither decoration nor hyperlinking, code blocks are discussed - -<p>later in this document -<p> <b>resulting output:</b> -<p> -<p> <br> -<pre> deb http://www.jus.uio.no/sisu/archive unstable main non-free - deb-src http://www.jus.uio.no/sisu/archive unstable main non-free -</pre> -<p> To link text or an image to a url the markup is as follows -<p> <b>markup example:</b> - -<p> -<p> <br> -<pre> about { SiSU }http://url.org markup -</pre> -<p> 3.5.2 LINKING TEXT -<p> <b>resulting output:</b> -<p> about SiSU <<a href='http://www.jus.uio.no/sisu/'>http://www.jus.uio.no/sisu/</a> -> - -<p>markup -<p> A shortcut notation is available so the url link may also be provided - -<p>automatically as a footnote -<p> <b>markup example:</b> -<p> -<p> <br> -<pre> about {~^ SiSU }http://url.org markup -</pre> -<p> <b>resulting output:</b> -<p> about SiSU <<a href='http://www.jus.uio.no/sisu/'>http://www.jus.uio.no/sisu/</a> -> [^5] markup -<p> 3.5.3 - -<p>LINKING IMAGES -<p> <b>markup example:</b> -<p> -<p> <br> -<pre> [ tux.png ] - % various url linked images - [ tux.png ] - [ GnuDebianLinuxRubyBetterWay.png ] - {~^ ruby_logo.png -</pre> -<p> <b>resulting output:</b> -<p> [ tux.png ] -<p> tux.png 64x80 -<p> [ ruby_logo (png missing) - ] [^6] -<p> GnuDebianLinuxRubyBetterWay.png 100x101 and Ruby -<p> <b>linked url footnote - -<p>shortcut</b> -<p> -<p> <br> -<pre> {~^ [text to link] }http://url.org - % maps to: { [text to link] }http://url.org ~{ http://url.org }~ - % which produces hyper-linked text within a document/paragraph, with an -endnote providing the url for the text location used in the hyperlink -</pre> -<p> -<p> <br> -<pre> text marker *~name -</pre> -<p> note at a heading level the same is automatically achieved by providing -names to headings 1, 2 and 3 i.e. 2~[name] and 3~[name] or in the case of -auto-heading numbering, without further intervention. -<p> 3.6 GROUPED TEXT -<p> 3.6.1 - -<p>TABLES -<p> Tables may be prepared in two either of two forms -<p> <b>markup example:</b> - -<p> -<p> <br> -<pre> table{ c3; 40; 30; 30; - This is a table - this would become column two of row one - column three of row one is here - And here begins another row - column two of row two - column three of row two, and so on - }table -</pre> -<p> <b>resulting output:</b> -<p> [table omitted, see other document formats]<br> - -<p> a second form may be easier to work with in cases where there is not - -<p>much information in each column -<p> <b>markup example:</b> [^7] -<p> -<p> <br> -<pre> !_ Table 3.1: Contributors to Wikipedia, January 2001 - June 2005 - {table~h 24; 12; 12; 12; 12; 12; 12;} - |Jan. 2001|Jan. 2002|Jan. 2003|Jan. 2004|July -2004|June 2006 - Contributors* | 10| 472| 2,188| 9,653| - 25,011| 48,721 - Active contributors** | 9| 212| 846| 3,228| - 8,442| 16,945 - Very active contributors*** | 0| 31| 190| 692| - 1,639| 3,016 - No. of English language articles| 25| 16,000| 101,000| 190,000| -320,000| 630,000 - No. of articles, all languages | 25| 19,000| 138,000| 490,000| -862,000|1,600,000 - \* Contributed at least ten times; \** at least 5 times in last month; -\* more than 100 times in last month. -</pre> -<p> <b>resulting output:</b> -<p> <b>Table 3.1: Contributors to Wikipedia, January 2001 -- June 2005</b> -<p> [table omitted, see other document formats]<br> - -<p> * Contributed at least ten times; ** at least 5 times in last month; -*** more than 100 times in last month. -<p> 3.6.2 POEM -<p> <b>basic markup:</b> -<p> -<p> <br> -<pre> poem{ - Your poem here - }poem - Each verse in a poem is given a separate object number. -</pre> -<p> <b>markup example:</b> -<p> -<p> <br> -<pre> poem{ - ’Fury said to a - mouse, That he - met in the - house, - - both go to - law: I will - prosecute - YOU. --Come, - I’ll take no - denial; We - must have a - trial: For - really this - morning I’ve - nothing - to do. - Said the - mouse to the - cur, - a trial, - dear Sir, - With - no jury - or judge, - would be - wasting - our - breath. - - judge, I’ll - be jury, - Said - cunning - old Fury: - - try the - whole - cause, - and - condemn - you - to - death. - }poem -</pre> -<p> <b>resulting output:</b> -<p> -<p> ’Fury said to a<br> - <p> - mouse, That he<br> - <p> - met in the<br> - <p> - house,<br> - <p> - <br> - <p> - both go to<br> - <p> - law: I will<br> - <p> - prosecute<br> - <p> - YOU. --Come,<br> - <p> - I’ll take no<br> - <p> - denial; We<br> - <p> - must have a<br> - <p> - trial: For<br> - <p> - really this<br> - <p> - morning I’ve<br> - <p> - nothing<br> - <p> - to do.<br> - <p> - Said the<br> - <p> - mouse to the<br> - <p> - cur,<br> - <p> - a trial,<br> - <p> - dear Sir,<br> - <p> - With<br> - <p> - no jury<br> - <p> - or judge,<br> - <p> - would be<br> - <p> - wasting<br> - <p> - our<br> - <p> - breath.<br> - <p> - <br> - <p> - judge, I’ll<br> - <p> - be jury,<br> - <p> - Said<br> - <p> - cunning<br> - <p> - old Fury:<br> - <p> - <br> - <p> - try the<br> - <p> - whole<br> - <p> - cause,<br> - <p> - and<br> - <p> - condemn<br> - <p> - you<br> - <p> - to<br> - <p> - death.<br> - <p> - -<p> 3.6.3 GROUP -<p> <b>basic markup:</b> -<p> -<p> <br> -<pre> group{ - Your grouped text here - }group - A group is treated as an object and given a single object number. -</pre> -<p> <b>markup example:</b> -<p> -<p> <br> -<pre> group{ - ’Fury said to a - mouse, That he - met in the - house, - - both go to - law: I will - prosecute - YOU. --Come, - I’ll take no - denial; We - must have a - trial: For - really this - morning I’ve - nothing - to do. - Said the - mouse to the - cur, - a trial, - dear Sir, - With - no jury - or judge, - would be - wasting - our - breath. - - judge, I’ll - be jury, - Said - cunning - old Fury: - - try the - whole - cause, - and - condemn - you - to - death. - }group -</pre> -<p> <b>resulting output:</b> -<p> -<p> ’Fury said to a<br> - <p> - mouse, That he<br> - <p> - met in the<br> - <p> - house,<br> - <p> - <br> - <p> - both go to<br> - <p> - law: I will<br> - <p> - prosecute<br> - <p> - YOU. --Come,<br> - <p> - I’ll take no<br> - <p> - denial; We<br> - <p> - must have a<br> - <p> - trial: For<br> - <p> - really this<br> - <p> - morning I’ve<br> - <p> - nothing<br> - <p> - to do.<br> - <p> - Said the<br> - <p> - mouse to the<br> - <p> - cur,<br> - <p> - a trial,<br> - <p> - dear Sir,<br> - <p> - With<br> - <p> - no jury<br> - <p> - or judge,<br> - <p> - would be<br> - <p> - wasting<br> - <p> - our<br> - <p> - breath.<br> - <p> - <br> - <p> - judge, I’ll<br> - <p> - be jury,<br> - <p> - Said<br> - <p> - cunning<br> - <p> - old Fury:<br> - <p> - <br> - <p> - try the<br> - <p> - whole<br> - <p> - cause,<br> - <p> - and<br> - <p> - condemn<br> - <p> - you<br> - <p> - to<br> - <p> - death.<br> - <p> - -<p> 3.6.4 CODE -<p> Code tags are used to escape regular sisu markup, and have -been used extensively within this document to provide examples of <b>SiSU</b> -markup. You cannot however use code tags to escape code tags. They are however -used in the same way as group or poem tags. -<p> A code-block is treated as -an object and given a single object number. [an more than 100 times in last -month. option to number each line of code may be considered at more than -100 times in last month. some later time] -<p> <b>use of code tags instead of -poem compared, resulting output:</b> -<p> -<p> <br> -<pre> ’Fury said to a - mouse, That he - met in the - house, - - both go to - law: I will - prosecute - YOU. --Come, - I’ll take no - denial; We - must have a - trial: For - really this - morning I’ve - nothing - to do. - Said the - mouse to the - cur, - a trial, - dear Sir, - With - no jury - or judge, - would be - wasting - our - breath. - - judge, I’ll - be jury, - Said - cunning - old Fury: - - try the - whole - cause, - and - condemn - you - to - death. -</pre> -<p> 4. COMPOSITE DOCUMENTS MARKUP -<p> It is possible to build a document by -creating a master document that requires other documents. The documents -required may be complete documents that could be generated independently, -or they could be markup snippets, prepared so as to be easily available -to be placed within another text. If the calling document is a master document -(built from other documents), it should be named with the suffix <b>.ssm</b> Within -this document you would provide information on the other documents that -should be included within the text. These may be other documents that would -be processed in a regular way, or markup bits prepared only for inclusion -within a master document <b>.sst</b> regular markup file, or <b>.ssi</b> (insert/information) - -<p>A secondary file of the composite document is built prior to processing - -<p>with the same prefix and the suffix <b>._sst</b> -<p> basic markup for importing a - -<p>document into a master document -<p> -<p> <br> -<pre> << |filename1.sst|@|^| - << |filename2.ssi|@|^| -</pre> -<p> The form described above should be relied on. Within the Vim editor it -results in the text thus linked becoming hyperlinked to the document it -is calling in which is convenient for editing. Alternative markup for importation -of documents under consideration, and occasionally supported have been. - -<p> -<p> <br> -<pre> r{filename} - {filename.ssi}require - << {filename.ssi} - % using textlink alternatives - |filename.ssi|@|^|require - << |filename.ssi|@|^| - % using thlnk alternatives - <url:filename.ssi>require - << <url:filename.ssi> -</pre> -<p> MARKUP SYNTAX HISTORY -<p> 5. NOTES RELATED TO FILES-TYPES AND MARKUP SYNTAX - -<p> 0.38 is substantially current, depreciated 0.16 supported, though file - -<p>names were changed at 0.37 -<p> <b>0.52</b> (2007w14/6) declared document type identifier -at start of text/document: -<p> .B SiSU<br> - 0.52 -<p> or, backward compatible using the comment marker: -<p> %<br> - <b>SiSU</b> 0.38 -<p> variations include ’ <b>SiSU</b> (text|master|insert) [version]’ and ’sisu-[version]’ - -<p> <b>0.51</b> (2007w13/6) skins changed (simplified), markup unchanged -<p> <b>0.42</b> (2006w27/4) -* (asterisk) type endnotes, used e.g. in relation to author -<p> <b>0.38</b> (2006w15/7) -introduced new/alternative notation for headers, e.g. @title: (instead of -0~title), and accompanying document structure markup, :A,:B,:C,1,2,3 (maps -to previous 1,2,3,4,5,6) -<p> <b>0.37</b> (2006w09/7) introduced new file naming convention, -.sst (text), .ssm (master), .ssi (insert), markup syntax unchanged -<p> <b>0.35</b> (2005w52/3) -sisupod, zipped content file introduced -<p> <b>0.23</b> (2005w36/2) utf-8 for markup - -<p>file -<p> <b>0.22</b> (2005w35/3) image dimensions may be omitted if rmagick is available - -<p>to be relied upon -<p> <b>0.20.4</b> (2005w33/4) header 0~links -<p> <b>0.16</b> (2005w25/2) substantial -changes introduced to make markup cleaner, header 0~title type, and headings - [1-6]~ introduced, also percentage sign (%) at start of a text line as comment - -<p>marker -<p> DOCUMENT INFORMATION (METADATA) -<p> METADATA -<p> Document Manifest -@ <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_markup/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_markup/sisu_manifest.html</a> -> -<p> <b>Dublin -Core</b> (DC) -<p> <i>DC</i> tags included with this document are provided here. -<p> DC -Title: <i>SiSU</i> - Markup -<p> DC Creator: <i>Ralph</i> Amissah -<p> DC Rights: <i>Copyright</i> -(C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 -<p> DC -Type: <i>information</i> -<p> DC Date created: <i>2002-08-28</i> -<p> DC Date issued: <i>2002-08-28</i> - -<p> DC Date available: <i>2002-08-28</i> -<p> DC Date modified: <i>2007-09-16</i> -<p> DC Date: <i>2007-09-16</i> - -<p> <b>Version Information</b> -<p> Sourcefile: <i>sisu_markup.sst</i> -<p> Filetype: <i>SiSU</i> text - -<p>0.58 -<p> Sourcefile Digest, MD5(sisu_markup.sst)= <i>6848f40f5844e0a7d59dbb86b3ddae92</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:14 +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) - [i486-linux] -<p> -<ol> -<b>.</b><li>From sometime after SiSU 0.58 it should be possible to describe -SiSU markup using SiSU, which though not an original design goal is useful. -</li><b>.</b><li>files should be prepared using UTF-8 character encoding </li><b>.</b><li>a footnote or endnote -</li><b>.</b><li>self contained endnote marker & endnote in one </dd> - -<dt><b>*.</b> </dt> -<dd>unnumbered asterisk footnote/endnote, -insert multiple asterisks if required </dd> - -<dt><b>**.</b> </dt> -<dd>another unnumbered asterisk footnote/endnote -</dd> - -<dt><b>*1.</b> </dt> -<dd>editors notes, numbered asterisk footnote/endnote series </dd> - -<dt><b>+1.</b> </dt> -<dd>editors -notes, numbered asterisk footnote/endnote series </li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/'>http://www.jus.uio.no/sisu/</a> -> -</li><b>.</b><li><<a href='http://www.ruby-lang.org/en/'>http://www.ruby-lang.org/en/</a> -> </li><b>.</b><li>Table from the Wealth of Networks by Yochai Benkler - <<a href='http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler'>http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler</a> -><br> - -<p> </dd> - -<dt>Other versions of this document: </dt> -<dd></dd> - -<dt>manifest: <<a href='http://www.jus.uio.no/sisu/sisu_markup/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_markup/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_markup/sisu_manifest.html</a> -</a> -> -</dt> -<dd></dd> - -<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_markup/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_markup/toc.html'>http://www.jus.uio.no/sisu/sisu_markup/toc.html</a> -</a> -> </dt> -<dd></dd> - -<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_markup/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_markup/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_markup/portrait.pdf</a> -</a> -> -</dt> -<dd></dd> - -<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_markup/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_markup/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_markup/landscape.pdf</a> -</a> -> </dt> -<dd> </dd> - -<dt>at: <<a href='http://www.jus.uio.no/sisu'><a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> -</a> -> -</dt> -<dd></dd> - -<dt>* Generated by: SiSU 0.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:30 +0100 2007 </dt> -<dd></dd> - -<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> - </dt> -<dd></dd> -</dl> -<p> -</body> -</html> diff --git a/data/doc/sisu/html/sisu_quickstart.8.html b/data/doc/sisu/html/sisu_quickstart.8.html deleted file mode 100644 index 6afe5b27..00000000 --- a/data/doc/sisu/html/sisu_quickstart.8.html +++ /dev/null @@ -1,332 +0,0 @@ -<!-- manual page source format generated by PolyglotMan v3.2, --> -<!-- available at http://polyglotman.sourceforge.net/ --> - -<html> -<head> -<title>"sisu_quickstart"("1") manual page</title> -</head> -<body bgcolor='white'> -<a href='#toc'>Table of Contents</a><p> -SISU - QUICKSTART, INSTALLATION AND USE, RALPH AMISSAH -<p> QUICKSTART - SISU -INSTALLATION AND USE -<p> 1. QUICKSTART - GETTING STARTED HOWTO -<p> 1.1 INSTALLATION - -<p> Installation is currently most straightforward and tested on the <b>Debian</b> -platform, as there are packages for the installation of sisu and all requirements -for what it does. -<p> 1.1.1 DEBIAN INSTALLATION -<p> <b>SiSU</b> is available directly -from the <b>Debian</b> Sid and testing archives (and possibly Ubuntu), assuming -your /etc/apt/sources.list is set accordingly: -<p> -<p> <br> -<pre> aptitude update - aptitude install sisu-complete -</pre> -<p> The following /etc/apt/sources.list setting permits the download of additional -markup samples: -<p> -<p> <br> -<pre> #/etc/apt/sources.list - deb http://ftp.fi.debian.org/debian/ unstable main non-free contrib - deb-src http://ftp.fi.debian.org/debian/ unstable main non-free contrib - d -</pre> -<p> The aptitude commands become: -<p> -<p> <br> -<pre> aptitude update - aptitude install sisu-complete sisu-markup-samples -</pre> -<p> If there are newer versions of <b>SiSU</b> upstream of the <b>Debian</b> archives, - -<p>they will be available by adding the following to your /etc/apt/sources.list - -<p> -<p> <br> -<pre> #/etc/apt/sources.list - deb http://www.jus.uio.no/sisu/archive unstable main non-free - deb-src http://www.jus.uio.no/sisu/archive unstable main non-free -</pre> -<p> repeat the aptitude commands -<p> -<p> <br> -<pre> aptitude update - aptitude install sisu-complete sisu-markup-samples -</pre> -<p> Note however that it is not necessary to install sisu-complete if not -all components of sisu are to be used. Installing just the package sisu -will provide basic functionality. -<p> 1.1.2 RPM INSTALLATION -<p> RPMs are provided -though untested, they are prepared by running alien against the source -package, and against the debs. -<p> They may be downloaded from: -<p> <<a href='http://www.jus.uio.no/sisu/SiSU/download.html#rpm'>http://www.jus.uio.no/sisu/SiSU/download.html#rpm</a> -><br> - -<p> as root type: -<p> rpm -i [rpm package name]<br> - -<p> 1.1.3 INSTALLATION FROM SOURCE -<p> To install <b>SiSU</b> from source check information -at: -<p> <<a href='http://www.jus.uio.no/sisu/SiSU/download.html#current'>http://www.jus.uio.no/sisu/SiSU/download.html#current</a> -><br> - -<p> * download the source package -<p> * Unpack the source -<p> Two alternative -modes of installation from source are provided, setup.rb (by Minero Aoki) -and a rant(by Stefan Lang) built install file, in either case: the first -steps are the same, download and unpack the source file: -<p> For basic use -<b>SiSU</b> is only dependent on the programming language in which it is written -<b>Ruby</b> , and <b>SiSU</b> will be able to generate html, various XMLs, including -ODF (and will also produce LaTeX). Dependencies required for further actions, -though it relies on the installation of additional dependencies which the -source tarball does not take care of, for things like using a database -(postgresql or sqlite)[^1] or converting LaTeX to pdf. -<p> <b>setup.rb</b> -<p> This is -a standard ruby installer, using setup.rb is a three step process. In the -root directory of the unpacked <b>SiSU</b> as root type: -<p> -<p> <br> -<pre> ruby setup.rb config - ruby setup.rb setup - #[and as root:] - ruby setup.rb install -</pre> -<p> further information on setup.rb is available from: -<p> <<a href='http://i.loveruby.net/en/projects/setup/'>http://i.loveruby.net/en/projects/setup/</a> -><br> - -<p> <<a href='http://i.loveruby.net/en/projects/setup/doc/usage.html'>http://i.loveruby.net/en/projects/setup/doc/usage.html</a> -><br> - -<p> <b></b> -<p> The root directory of the unpacked <b>SiSU</b> as root type: -<p> ruby install -base<br> - -<p> or for a more complete installation: -<p> ruby install<br> - -<p> or -<p> ruby install base<br> - -<p> This makes use of Rant (by Stefan Lang) and the provided Rantfile. It -has been configured to do post installation setup setup configuration and -generation of first test file. Note however, that additional external package -dependencies, such as tetex-extra are not taken care of for you. -<p> Further - -<p>information on -<p> <<a href='http://make.rubyforge.org/'>http://make.rubyforge.org/</a> -><br> - -<p> <<a href='http://rubyforge.org/frs/?group_id=615'>http://rubyforge.org/frs/?group_id=615</a> -><br> - -<p> For a list of alternative actions you may type: -<p> ruby install help<br> - -<p> ruby install -T<br> - -<p> 1.2 TESTING SISU, GENERATING OUTPUT -<p> To check which version of sisu is -installed: -<p> sisu -v -<p> Depending on your mode of installation one or a number -of markup sample files may be found either in the directory: -<p> -<p> or -<p> - -<p> change directory to the appropriate one: -<p> cd /usr/share/doc/sisu/sisu_markup_samples/dfsg - -<p> 1.2.1 BASIC TEXT, PLAINTEXT, HTML, XML, ODF -<p> Having moved to the directory -that contains the markup samples (see instructions above if necessary), - -<p>choose a file and run sisu against it -<p> sisu -NhwoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst - -<p> this will generate html including a concordance file, opendocument text -format, plaintext, XHTML and various forms of XML, and OpenDocument text - -<p> 1.2.2 LATEX / PDF -<p> Assuming a LaTeX engine such as tetex or texlive is -installed with the required modules (done automatically on selection of -sisu-pdf in <b>Debian</b> ) -<p> Having moved to the directory that contains the markup -samples (see instructions above if necessary), choose a file and run sisu - -<p>against it -<p> sisu -pv free_as_in_freedom.rms_and_free_software.sam_williams.sst - -<p> sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst -<p> should -generate most available output formats: html including a concordance file, -opendocument text format, plaintext, XHTML and various forms of XML, and - -<p>OpenDocument text and pdf -<p> 1.2.3 RELATIONAL DATABASE - POSTGRESQL, SQLITE - -<p> Relational databases need some setting up - you must have permission to -create the database and write to it when you run sisu. -<p> Assuming you have - -<p>the database installed and the requisite permissions -<p> sisu --sqlite --recreate - -<p> sisu --sqlite -v --import free_as_in_freedom.rms_and_free_software.sam_williams.sst - -<p> sisu --pgsql --recreate -<p> sisu --pgsql -v --import free_as_in_freedom.rms_and_free_software.sam_williams.sst - -<p> 1.3 GETTING HELP -<p> 1.3.1 THE MAN PAGES -<p> Type: -<p> man sisu<br> - -<p> The man pages are also available online, though not always kept as up -to date as within the package itself: -<p> * sisu.1 <<a href='http://www.jus.uio.no/sisu/man/sisu.1'>http://www.jus.uio.no/sisu/man/sisu.1</a> -> - [^2] -<p> * sisu.8 <<a href='http://www.jus.uio.no/sisu/man/sisu.8'>http://www.jus.uio.no/sisu/man/sisu.8</a> -> [^3] -<p> * man directory <<a href='http://www.jus.uio.no/sisu/man'>http://www.jus.uio.no/sisu/man</a> -> - [^4] -<p> 1.3.2 BUILT IN HELP -<p> sisu --help -<p> sisu --help --env -<p> sisu --help --commands - -<p> sisu --help --markup -<p> 1.3.3 THE HOME PAGE -<p> <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> -> -<p> <<a href='http://www.jus.uio.no/sisu/SiSU'>http://www.jus.uio.no/sisu/SiSU</a> -> - -<p> 1.4 MARKUP SAMPLES -<p> A number of markup samples (along with output) are -available off: -<p> <<a href='http://www.jus.uio.no/sisu/SiSU/2.html'>http://www.jus.uio.no/sisu/SiSU/2.html</a> -> -<p> Additional markup -samples are packaged separately in the file: -<p> <b>*</b> -<p> On <b>Debian</b> they are available -in non-free[^5] to include them it is necessary to include non-free in your -/etc/apt/source.list or obtain them from the sisu home site. -<p> DOCUMENT INFORMATION -(METADATA) -<p> METADATA -<p> Document Manifest @ <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/sisu_manifest.html</a> -> - -<p> <b>Dublin Core</b> (DC) -<p> <i>DC</i> tags included with this document are provided here. - -<p> DC Title: <i>SiSU</i> - Quickstart, installation and use -<p> DC Creator: <i>Ralph</i> - -<p>Amissah -<p> DC Rights: <i>Copyright</i> (C) Ralph Amissah 2007, part of SiSU documentation, - -<p>License GPL 3 -<p> DC Type: <i>information</i> -<p> DC Date created: <i>2006-09-06</i> -<p> DC Date -available: <i>2006-09-06</i> -<p> DC Date issued: <i>2006-09-06</i> -<p> DC Date modified: <i>2007-09-16</i> - -<p> DC Date: <i>2007-09-16</i> -<p> <b>Version Information</b> -<p> Sourcefile: <i>sisu_quickstart.sst</i> - -<p> Filetype: <i>SiSU</i> text 0.57 -<p> Sourcefile Digest, MD5(sisu_quickstart.sst)= - -<p><i>e76db98ca0d8c2bfe526dad55622fa7a</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:15 +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) - [i486-linux] -<p> -<ol> -<b>.</b><li>There is nothing to stop MySQL support being added in future. -</li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man/sisu.1'>http://www.jus.uio.no/sisu/man/sisu.1</a> -> </li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man/sisu.8'>http://www.jus.uio.no/sisu/man/sisu.8</a> -> </li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man'>http://www.jus.uio.no/sisu/man</a> -> -</li><b>.</b><li>the .B Debian Free Software guidelines require that everything distributed -within .B Debian can be changed - and the documents are authors’ works that -while freely distributable are not freely changeable. -<p> </dd> - -<dt>Other versions of -this document: </dt> -<dd></dd> - -<dt>manifest: <<a href='http://www.jus.uio.no/sisu/sisu_quickstart/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_quickstart/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_quickstart/sisu_manifest.html</a> -</a> -> -</dt> -<dd></dd> - -<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_quickstart/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_quickstart/toc.html'>http://www.jus.uio.no/sisu/sisu_quickstart/toc.html</a> -</a> -> </dt> -<dd></dd> - -<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_quickstart/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_quickstart/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_quickstart/portrait.pdf</a> -</a> -> -</dt> -<dd></dd> - -<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_quickstart/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_quickstart/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_quickstart/landscape.pdf</a> -</a> -> </dt> -<dd> </dd> - -<dt>at: <<a href='http://www.jus.uio.no/sisu'><a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> -</a> -> -</dt> -<dd></dd> - -<dt>* Generated by: SiSU 0.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> diff --git a/data/doc/sisu/html/sisu_remote.8.html b/data/doc/sisu/html/sisu_remote.8.html deleted file mode 100644 index 6d453b15..00000000 --- a/data/doc/sisu/html/sisu_remote.8.html +++ /dev/null @@ -1,189 +0,0 @@ -<!-- manual page source format generated by PolyglotMan v3.2, --> -<!-- available at http://polyglotman.sourceforge.net/ --> - -<html> -<head> -<title>"sisu_remote"("1") manual page</title> -</head> -<body bgcolor='white'> -<a href='#toc'>Table of Contents</a><p> -SISU - REMOTE OPERATIONS, RALPH AMISSAH -<p> SISU REMOTE OPERATIONS -<p> 1. REMOTE -SOURCE DOCUMENTS -<p> <b>SiSU</b> processing instructions can be run against remote -source documents by providing the url of the documents against which the -processing instructions are to be carried out. The remote <b>SiSU</b> documents -can either be sisu marked up files in plaintext .sst or .ssm or; zipped sisu -files, sisupod.zip or filename.ssp -<p> <b>.sst / .ssm - sisu text files</b> -<p> <b>SiSU</b> can -be run against source text files on a remote machine, provide the processing -instruction and the url. The source file and any associated parts (such -as images) will be downloaded and generated locally. -<p> -<p> <br> -<pre> sisu -3 http://[provide url to valid .sst or .ssm file] -</pre> -<p> Any of the source documents in the sisu examples page can be used in -this way, see <<a href='http://www.jus.uio.no/sisu/SiSU/2.html'>http://www.jus.uio.no/sisu/SiSU/2.html</a> -> and use the url for the -desired document. -<p> NOTE: to set up a remote machine to serve <b>SiSU</b> documents -in this way, images should be in the directory relative to the document - -<p>source ../_sisu/image -<p> <b>sisupod - zipped sisu files</b> -<p> A sisupod is the zipped -content of a sisu marked up text or texts and any other associated parts -to the document such as images. -<p> <b>SiSU</b> can be run against a sisupod on a -(local or) remote machine, provide the processing instruction and the url, -the sisupod will be downloaded and the documents it contains generated -locally. -<p> -<p> <br> -<pre> sisu -3 http://[provide url to valid sisupod.zip or .ssp file] -</pre> -<p> Any of the source documents in the sisu examples page can be used in -this way, see <<a href='http://www.jus.uio.no/sisu/SiSU/2.html'>http://www.jus.uio.no/sisu/SiSU/2.html</a> -> and use the url for the -desired document. -<p> REMOTE DOCUMENT OUTPUT -<p> 2. REMOTE OUTPUT -<p> Once properly -configured <b>SiSU</b> output can be automatically posted once generated to a -designated remote machine using either rsync, or scp. -<p> In order to do this -some ssh authentication agent and keychain or similar tool will need to -be configured. Once that is done the placement on a remote host can be done -seamlessly with the -r (for scp) or -R (for rsync) flag, which may be used -in conjunction with other processing flags, e.g. -<p> -<p> <br> -<pre> sisu -3R sisu_remote.sst -</pre> -<p> 2.1 COMMANDS -<p> -<dl> - -<dt><b> -R [filename/wildcard]</b> </dt> -<dd>copies sisu output files to remote -host using rsync. This requires that sisurc.yml has been provided with information -on hostname and username, and that you have your different if -R is used -with other flags from if used alone. Alone the rsync --delete parameter is -sent, useful for cleaning the remote directory (when -R is used together -with other flags, it is not). Also see -r -<p> </dd> - -<dt><b> -r [filename/wildcard]</b> </dt> -<dd>copies sisu -output files to remote host using scp. This requires that sisurc.yml has -been provided with information on hostname and username, and that you have - -<p>your -<p> </dd> -</dl> -2.2 CONFIGURATION -<p> [expand on the setting up of an ssh-agent / keychain] - -<p> 3. REMOTE SERVERS -<p> As <b>SiSU</b> is generally operated using the command line, -and works within a Unix type environment, <b>SiSU</b> the program and all documents -can just as easily be on a remote server, to which you are logged on using -a terminal, and commands and operations would be pretty much the same as -they would be on your local machine. -<p> DOCUMENT INFORMATION (METADATA) -<p> -METADATA -<p> Document Manifest @ <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_remote/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_remote/sisu_manifest.html</a> -> - -<p> <b>Dublin Core</b> (DC) -<p> <i>DC</i> tags included with this document are provided here. - -<p> DC Title: <i>SiSU</i> - Remote Operations -<p> DC Creator: <i>Ralph</i> Amissah -<p> DC Rights: -<i>Copyright</i> (C) Ralph Amissah 2007, part of SiSU documentation, License GPL - -<p>3 -<p> DC Type: <i>information</i> -<p> DC Date created: <i>2002-08-28</i> -<p> DC Date issued: - -<p><i>2002-08-28</i> -<p> DC Date available: <i>2002-08-28</i> -<p> DC Date modified: <i>2007-09-16</i> -<p> DC -Date: <i>2007-09-16</i> -<p> <b>Version Information</b> -<p> Sourcefile: <i>sisu_remote.sst</i> -<p> Filetype: - -<p><i>SiSU</i> text 0.58 -<p> Sourcefile Digest, MD5(sisu_remote.sst)= <i>9bdac464998dc3f034fbd8f80df23b83</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:17 +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) - [i486-linux] -<p> -<p> -<dl> - -<dt>Other versions of this document: </dt> -<dd></dd> - -<dt>manifest: <<a href='http://www.jus.uio.no/sisu/sisu_remote/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_remote/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_remote/sisu_manifest.html</a> -</a> -> -</dt> -<dd></dd> - -<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_remote/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_remote/toc.html'>http://www.jus.uio.no/sisu/sisu_remote/toc.html</a> -</a> -> </dt> -<dd></dd> - -<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_remote/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_remote/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_remote/portrait.pdf</a> -</a> -> -</dt> -<dd></dd> - -<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_remote/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_remote/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_remote/landscape.pdf</a> -</a> -> </dt> -<dd> </dd> - -<dt>at: <<a href='http://www.jus.uio.no/sisu'><a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> -</a> -> -</dt> -<dd></dd> - -<dt>* Generated by: SiSU 0.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:32 +0100 2007 </dt> -<dd></dd> - -<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> - </dt> -<dd></dd> -</dl> -<p> -</body> -</html> diff --git a/data/doc/sisu/html/sisu_search.8.html b/data/doc/sisu/html/sisu_search.8.html deleted file mode 100644 index 64fe307b..00000000 --- a/data/doc/sisu/html/sisu_search.8.html +++ /dev/null @@ -1,512 +0,0 @@ -<!-- manual page source format generated by PolyglotMan v3.2, --> -<!-- available at http://polyglotman.sourceforge.net/ --> - -<html> -<head> -<title>"sisu_search"("1") manual page</title> -</head> -<body bgcolor='white'> -<a href='#toc'>Table of Contents</a><p> -SISU - SEARCH, RALPH AMISSAH -<p> SISU SEARCH -<p> 1. SISU SEARCH - INTRODUCTION - -<p> <b>SiSU</b> output can easily and conveniently be indexed by a number of standalone -indexing tools, such as Lucene, Hyperestraier. -<p> Because the document structure -of sites created is clearly defined, and the text object citation system -is available hypothetically at least, for all forms of output, it is possible -to search the sql database, and either read results from that database, -or just as simply map the results to the html output, which has richer -text markup. -<p> In addition to this <b>SiSU</b> has the ability to populate a relational -sql type database with documents at an object level, with objects numbers -that are shared across different output types, which make them searchable -with that degree of granularity. Basically, your match criteria is met by -these documents and at these locations within each document, which can -be viewed within the database directly or in various output formats. -<p> 2. -SQL -<p> 2.1 POPULATING SQL TYPE DATABASES -<p> <b>SiSU</b> feeds sisu markupd documents -into sql type databases PostgreSQL[^1] and/or SQLite[^2] database together -with information related to document structure. -<p> This is one of the more -interesting output forms, as all the structural data of the documents are -retained (though can be ignored by the user of the database should they -so choose). All site texts/documents are (currently) streamed to four tables: - -<p> * one containing semantic (and other) headers, including, title, author,<br> - subject, (the Dublin Core...);<br> - -<p> * another the substantive texts by individual<br> - along with structural information, each paragraph being identifiable -by its<br> - paragraph number (if it has one which almost all of them do), and the<br> - substantive text of each paragraph quite naturally being searchable -(both in<br> - formatted and clean text versions for searching); and<br> - -<p> * a third containing endnotes cross-referenced back to the paragraph -from<br> - which they are referenced (both in formatted and clean text versions -for<br> - searching).<br> - -<p> * a fourth table with a one to one relation with the headers table -contains<br> - full text versions of output, eg. pdf, html, xml, and ascii.<br> - -<p> There is of course the possibility to add further structures. -<p> At this -level <b>SiSU</b> loads a relational database with documents chunked into objects, -their smallest logical structurally constituent parts, as text objects, -with their object citation number and all other structural information -needed to construct the document. Text is stored (at this text object level) -with and without elementary markup tagging, the stripped version being -so as to facilitate ease of searching. -<p> Being able to search a relational -database at an object level with the <b>SiSU</b> citation system is an effective -way of locating content generated by <b>SiSU</b> object numbers, and all versions -of the document have the same numbering, complex searches can be tailored -to return just the locations of the search results relevant for all available -output formats, with live links to the precise locations in the database -or in html/xml documents; or, the structural information provided makes -it possible to search the full contents of the database and have headings -in which search content appears, or to search only headings etc. (as the -Dublin Core is incorporated it is easy to make use of that as well). -<p> 3. -POSTGRESQL -<p> 3.1 NAME -<p> <b>SiSU</b> - Structured information, Serialized Units - -a document publishing system, postgresql dependency package -<p> 3.2 DESCRIPTION - -<p> Information related to using postgresql with sisu (and related to the -sisu_postgresql dependency package, which is a dummy package to install -dependencies needed for <b>SiSU</b> to populate a postgresql database, this being -part of <b>SiSU</b> - man sisu). -<p> 3.3 SYNOPSIS -<p> sisu -D [instruction] [filename/wildcard - if required]<br> - -<p> sisu -D --pg --[instruction] [filename/wildcard if required]<br> - -<p> 3.4 COMMANDS -<p> Mappings to two databases are provided by default, postgresql -and sqlite, the same commands are used within sisu to construct and populate -databases however -d (lowercase) denotes sqlite and -D (uppercase) denotes -postgresql, alternatively --sqlite or --pgsql may be used -<p> <b>-D or --pgsql</b> may -be used interchangeably. -<p> 3.4.1 CREATE AND DESTROY DATABASE -<p> -<dl> - -<dt><b> --pgsql --createall</b> -</dt> -<dd> initial step, creates required relations (tables, indexes) in existing - (postgresql) database (a database should be created manually and given - the same name as working directory, as requested) (rb.dbi) the same name - as working directory, as -<p> </dd> - -<dt><b> sisu -D --createdb</b> </dt> -<dd> creates database where no database - existed before as -<p> </dd> - -<dt><b> sisu -D --create</b> </dt> -<dd> creates database tables where no database - tables existed before database tables where no database tables existed - -<p> </dd> - -<dt><b> sisu -D --Dropall</b> </dt> -<dd> destroys database (including all its content)! kills data -and drops tables, indexes and database associated with a given directory - (and directories of the same name). a -<p> </dd> - -<dt><b> sisu -D --recreate</b> </dt> -<dd> destroys existing - -<p> database and builds a new empty database structure -<p> </dd> -</dl> -3.4.2 IMPORT AND REMOVE - -<p>DOCUMENTS -<p> -<dl> - -<dt><b> sisu -D --import -v [filename/wildcard]</b> </dt> -<dd>populates database with -the contents of the file. Imports documents(s) specified to a postgresql -database (at an object level). -<p> </dd> - -<dt><b> sisu -D --update -v [filename/wildcard]</b> </dt> -<dd>updates - -<p>file contents in database -<p> </dd> - -<dt><b> sisu -D --remove -v [filename/wildcard]</b> </dt> -<dd>removes -specified document from postgresql database. -<p> </dd> -</dl> -4. SQLITE -<p> 4.1 NAME -<p> <b>SiSU</b> -- Structured information, Serialized Units - a document publishing system. - -<p> 4.2 DESCRIPTION -<p> Information related to using sqlite with sisu (and related -to the sisu_sqlite dependency package, which is a dummy package to install -dependencies needed for <b>SiSU</b> to populate an sqlite database, this being -part of <b>SiSU</b> - man sisu). -<p> 4.3 SYNOPSIS -<p> sisu -d [instruction] [filename/wildcard - if required]<br> - -<p> sisu -d --(sqlite|pg) --[instruction] [filename/wildcard if <br> - required]<br> - -<p> 4.4 COMMANDS -<p> Mappings to two databases are provided by default, postgresql -and sqlite, the same commands are used within sisu to construct and populate -databases however -d (lowercase) denotes sqlite and -D (uppercase) denotes -postgresql, alternatively --sqlite or --pgsql may be used -<p> <b>-d or --sqlite</b> may -be used interchangeably. -<p> 4.4.1 CREATE AND DESTROY DATABASE -<p> -<dl> - -<dt><b> --sqlite --createall</b> -</dt> -<dd> initial step, creates required relations (tables, indexes) in existing - (sqlite) database (a database should be created as requested) (rb.dbi) the - same name as working directory, as -<p> </dd> - -<dt><b> sisu -d --createdb</b> </dt> -<dd> creates database where - no database existed before as -<p> </dd> - -<dt><b> sisu -d --create</b> </dt> -<dd> creates database tables where - no database tables existed before database tables where no database tables - existed -<p> </dd> - -<dt><b> sisu -d --dropall</b> </dt> -<dd> destroys database (including all its content)! - kills data and drops tables, indexes and database associated with a given - directory (and directories of the same name). a -<p> </dd> - -<dt><b> sisu -d --recreate</b> </dt> -<dd> destroys - -<p> existing database and builds a new empty database structure -<p> </dd> -</dl> -4.4.2 IMPORT - -<p>AND REMOVE DOCUMENTS -<p> -<dl> - -<dt><b> sisu -d --import -v [filename/wildcard]</b> </dt> -<dd>populates database -with the contents of the file. Imports documents(s) specified to an sqlite -database (at an object level). -<p> </dd> - -<dt><b> sisu -d --update -v [filename/wildcard]</b> </dt> -<dd>updates - -<p>file contents in database -<p> </dd> - -<dt><b> sisu -d --remove -v [filename/wildcard]</b> </dt> -<dd>removes -specified document from sqlite database. -<p> </dd> -</dl> -5. INTRODUCTION -<p> 5.1 SEARCH - DATABASE -FRONTEND SAMPLE, UTILISING DATABASE AND SISU FEATURES, INCLUDING OBJECT -CITATION NUMBERING (BACKEND CURRENTLY POSTGRESQL) -<p> Sample search frontend -<<a href='http://search.sisudoc.org'>http://search.sisudoc.org</a> -> [^3] A small database and sample query front-end -(search from) that makes use of the citation system, <i>object</i> citation numbering -to demonstrates functionality.[^4] -<p> <b>SiSU</b> can provide information on which -documents are matched and at what locations within each document the matches -are found. These results are relevant across all outputs using object citation -numbering, which includes html, XML, LaTeX, PDF and indeed the SQL database. -You can then refer to one of the other outputs or in the SQL database expand -the text within the matched objects (paragraphs) in the documents matched. - -<p> Note you may set results either for documents matched and object number -locations within each matched document meeting the search criteria; or -display the names of the documents matched along with the objects (paragraphs) -that meet the search criteria.[^5] -<p> -<dl> - -<dt><b> sisu -F --webserv-webrick</b> </dt> -<dd> builds a cgi web - -<p> search frontend for the database created -<p> The following is feedback on -the setup on a machine provided by the help command: -<p> sisu --help sql<br> - -<p> -<p> <br> -<pre> Postgresql - user: ralph - current db set: SiSU_sisu - port: 5432 - dbi connect: DBI:Pg:database=SiSU_sisu;port=5432 - sqlite - current db set: /home/ralph/sisu_www/sisu/sisu_sqlite.db - dbi connect DBI:SQLite:/home/ralph/sisu_www/sisu/sisu_sqlite.db -</pre> -<p> Note on databases built -<p> By default, [unless otherwise specified] databases -are built on a directory basis, from collections of documents within that -directory. The name of the directory you choose to work from is used as -the database name, i.e. if you are working in a directory called /home/ralph/ebook -the database SiSU_ebook is used. [otherwise a manual mapping for the collection - is -<p> </dd> -</dl> -5.2 SEARCH FORM -<p> -<dl> - -<dt><b> sisu -F</b> </dt> -<dd> generates a sample search form, which must be - copied to which must be copied to -<p> </dd> - -<dt><b> sisu -F --webserv-webrick</b> </dt> -<dd> generates a sample - search form for use with the webrick which must be copied to the web-server - cgi directory which must be copied to the web-server cgi directory -<p> </dd> - -<dt><b> sisu - -Fv</b> </dt> -<dd> as above, and provides some information on setting up -<p> </dd> - -<dt><b> sisu -W</b> </dt> -<dd> starts - -<p> the webrick server which should be available -<p> The generated search form - -<p>must be copied manually to the webserver directory as instructed -<p> </dd> -</dl> -6. HYPERESTRAIER - -<p> See the documentation for hyperestraier: -<p> <<a href='http://hyperestraier.sourceforge.net/'>http://hyperestraier.sourceforge.net/</a> -><br> - -<p> /usr/share/doc/hyperestraier/index.html<br> - -<p> man estcmd<br> - -<p> on sisu_hyperestraier: -<p> man sisu_hyperestraier<br> - -<p> /usr/share/doc/sisu/sisu_markup/sisu_hyperestraier/index.html<br> - -<p> NOTE: the examples that follow assume that sisu output is placed in - -<p>the directory /home/ralph/sisu_www -<p> (A) to generate the index within the -webserver directory to be indexed: -<p> estcmd gather -sd [index name] [directory - path to index]<br> - -<p> the following are examples that will need to be tailored according to -your needs: -<p> cd /home/ralph/sisu_www<br> - -<p> estcmd gather -sd casket /home/ralph/sisu_www<br> - -<p> you may use the ’find’ command together with ’egrep’ to limit indexing to -particular document collection directories within the web server directory: - -<p> find /home/ralph/sisu_www -type f | egrep<br> - ’/home/ralph/sisu_www/sisu/.+?.html$’ |estcmd gather -sd casket -<br> - -<p> Check which directories in the webserver/output directory (~/sisu_www -or elsewhere depending on configuration) you wish to include in the search -index. -<p> As sisu duplicates output in multiple file formats, it it is probably -preferable to limit the estraier index to html output, and as it may also -be desirable to exclude files ’plain.txt’, ’toc.html’ and ’concordance.html’, as -these duplicate information held in other html output e.g. -<p> find /home/ralph/sisu_www --type f | egrep<br> - ’/sisu_www/(sisu|bookmarks)/.+?.html$’ | egrep -v<br> - ’(doc|concordance).html$’ |estcmd gather -sd casket -<br> - -<p> from your current document preparation/markup directory, you would construct -a rune along the following lines: -<p> find /home/ralph/sisu_www -type f -| egrep ’/home/ralph/sisu_www/([specify <br> - first directory for inclusion]|[specify second directory for <br> - inclusion]|[another directory for inclusion? ...])/.+?.html$’ |<br> - egrep -v ’(doc|concordance).html$’ |estcmd gather -sd<br> - /home/ralph/sisu_www/casket -<br> - -<p> (B) to set up the search form -<p> (i) copy estseek.cgi to your cgi directory -and set file permissions to 755: -<p> sudo cp -vi /usr/lib/estraier/estseek.cgi -/usr/lib/cgi-bin<br> - -<p> sudo chmod -v 755 /usr/lib/cgi-bin/estseek.cgi<br> - -<p> sudo cp -v /usr/share/hyperestraier/estseek.* /usr/lib/cgi-bin<br> - -<p> [see estraier documentation for paths]<br> - -<p> (ii) edit estseek.conf, with attention to the lines starting ’indexname:’ -and ’replace:’: -<p> indexname: /home/ralph/sisu_www/casket<br> - -<p> replace: ^file:///home/ralph/sisu_www{{!}}<a href='http://localhost'>http://localhost</a> -<br> - -<p> replace: /index.html?${{!}}/<br> - -<p> (C) to test using webrick, start webrick: -<p> sisu -W<br> - -<p> and try open the url: <<a href='http://localhost:8081/cgi-bin/estseek.cgi'>http://localhost:8081/cgi-bin/estseek.cgi</a> -> -<p> DOCUMENT -INFORMATION (METADATA) -<p> METADATA -<p> Document Manifest @ <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_search/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_search/sisu_manifest.html</a> -> - -<p> <b>Dublin Core</b> (DC) -<p> <i>DC</i> tags included with this document are provided here. - -<p> DC Title: <i>SiSU</i> - Search -<p> DC Creator: <i>Ralph</i> Amissah -<p> DC Rights: <i>Copyright</i> -(C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 -<p> DC -Type: <i>information</i> -<p> DC Date created: <i>2002-08-28</i> -<p> DC Date issued: <i>2002-08-28</i> - -<p> DC Date available: <i>2002-08-28</i> -<p> DC Date modified: <i>2007-09-16</i> -<p> DC Date: <i>2007-09-16</i> - -<p> <b>Version Information</b> -<p> Sourcefile: <i>sisu_search._sst</i> -<p> Filetype: <i>SiSU</i> text - -<p>insert 0.58 -<p> Sourcefile Digest, MD5(sisu_search._sst)= <i>c085c2eb6d68f1b7d50435f673ede407</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:19 +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) - [i486-linux] -<p> -<ol> -<b>.</b><li><<a href='http://www.postgresql.org/'>http://www.postgresql.org/</a> -> <<a href='http://advocacy.postgresql.org/'>http://advocacy.postgresql.org/</a> -><br> - <<a href='http://en.wikipedia.org/wiki/Postgresql'>http://en.wikipedia.org/wiki/Postgresql</a> -><br> - </li><b>.</b><li><<a href='http://www.hwaci.com/sw/sqlite/'>http://www.hwaci.com/sw/sqlite/</a> -> <<a href='http://en.wikipedia.org/wiki/Sqlite'>http://en.wikipedia.org/wiki/Sqlite</a> -><br> - </li><b>.</b><li><<a href='http://search.sisudoc.org'>http://search.sisudoc.org</a> -> </li><b>.</b><li>(which could be extended further with current -back-end). As regards scaling of the database, it is as scalable as the database -(here Postgresql) and hardware allow. </li><b>.</b><li>of this feature when demonstrated -to an IBM software innovations evaluator in 2004 he said to paraphrase: -this could be of interest to us. We have large document management systems, -you can search hundreds of thousands of documents and we can tell you which -documents meet your search criteria, but there is no way we can tell you -without opening each document where within each your matches are found. - -<p> </dd> - -<dt>Other versions of this document: </dt> -<dd></dd> - -<dt>manifest: <<a href='http://www.jus.uio.no/sisu/sisu_search/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_search/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_search/sisu_manifest.html</a> -</a> -> -</dt> -<dd></dd> - -<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_search/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_search/toc.html'>http://www.jus.uio.no/sisu/sisu_search/toc.html</a> -</a> -> </dt> -<dd></dd> - -<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_search/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_search/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_search/portrait.pdf</a> -</a> -> -</dt> -<dd></dd> - -<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_search/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_search/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_search/landscape.pdf</a> -</a> -> </dt> -<dd> </dd> - -<dt>at: <<a href='http://www.jus.uio.no/sisu'><a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> -</a> -> -</dt> -<dd></dd> - -<dt>* Generated by: SiSU 0.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:32 +0100 2007 </dt> -<dd></dd> - -<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> - </dt> -<dd></dd> -</dl> -<p> -</body> -</html> diff --git a/data/doc/sisu/html/sisu_skin.1.html b/data/doc/sisu/html/sisu_skin.1.html deleted file mode 100644 index 84b90fa5..00000000 --- a/data/doc/sisu/html/sisu_skin.1.html +++ /dev/null @@ -1,162 +0,0 @@ -<!-- manual page source format generated by PolyglotMan v3.2, --> -<!-- available at http://polyglotman.sourceforge.net/ --> - -<html> -<head> -<title>"sisu_skin"("1") manual page</title> -</head> -<body bgcolor='white'> -<a href='#toc'>Table of Contents</a><p> -SISU - SKINS, RALPH AMISSAH -<p> DOCUMENT SKINS - CONFIGURATION -<p> 1. SKINS -<p> - Skins modify the default appearance of document output on a document, -directory, or site wide basis. Skins are looked for in the following locations: - -<p> ./_sisu/skin<br> - -<p> ~/.sisu/skin<br> - -<p> /etc/sisu/skin<br> - -<p> <b>Within the skin directory</b> are the following the default sub-directories -for document skins: -<p> ./skin/doc<br> - -<p> ./skin/dir<br> - -<p> ./skin/site<br> - -<p> A skin is placed in the appropriate directory and the file named skin_[name].rb - -<p> The skin itself is a ruby file which modifies the default appearances -set in the program. -<p> 1.1 DOCUMENT SKIN -<p> Documents take on a document skin, -if the header of the document specifies a skin to be used. -<p> -<p> <br> -<pre> @skin: skin_united_nations -</pre> -<p> 1.2 DIRECTORY SKIN -<p> A directory may be mapped on to a particular skin, -so all documents within that directory take on a particular appearance. -If a skin exists in the skin/dir with the same name as the document directory, -it will automatically be used for each of the documents in that directory, -(except where a document specifies the use of another skin, in the skin/doc -directory). -<p> A personal habit is to place all skins within the doc directory, -and symbolic links as needed from the site, or dir directories as required. - -<p> 1.3 SITE SKIN -<p> A site skin, modifies the program default skin. -<p> 1.4 SAMPLE - -<p>SKINS -<p> With <b>SiSU</b> installed sample skins may be found in: -<p> /etc/sisu/skin/doc -and<br> - /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc<br> - -<p> (or equivalent directory) and if sisu-markup-samples is installed also -under: -<p> /usr/share/doc/sisu/sisu_markup_samples/non-free/_sisu/skin/doc<br> - -<p> Samples of list.yml and promo.yml (which are used to create the right -column list) may be found in: -<p> /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml -(or equivalent<br> - directory)<br> - -<p> DOCUMENT INFORMATION (METADATA) -<p> METADATA -<p> Document Manifest @ <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_skin/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_skin/sisu_manifest.html</a> -> - -<p> <b>Dublin Core</b> (DC) -<p> <i>DC</i> tags included with this document are provided here. - -<p> DC Title: <i>SiSU</i> - Skins -<p> DC Creator: <i>Ralph</i> Amissah -<p> DC Rights: <i>Copyright</i> -(C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 -<p> DC -Type: <i>information</i> -<p> DC Date created: <i>2002-11-12</i> -<p> DC Date issued: <i>2002-11-12</i> - -<p> DC Date available: <i>2002-11-12</i> -<p> DC Date modified: <i>2007-09-16</i> -<p> DC Date: <i>2007-09-16</i> - -<p> <b>Version Information</b> -<p> Sourcefile: <i>sisu_skin.sst</i> -<p> Filetype: <i>SiSU</i> text - -<p>insert 0.58 -<p> Sourcefile Digest, MD5(sisu_skin.sst)= <i>8aebfb5312045c3a705ad6c314246f67</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:15 +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) - [i486-linux] -<p> -<p> -<dl> - -<dt>Other versions of this document: </dt> -<dd></dd> - -<dt>manifest: <<a href='http://www.jus.uio.no/sisu/sisu_skin/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_skin/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_skin/sisu_manifest.html</a> -</a> -> -</dt> -<dd></dd> - -<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_skin/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_skin/toc.html'>http://www.jus.uio.no/sisu/sisu_skin/toc.html</a> -</a> -> </dt> -<dd></dd> - -<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_skin/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_skin/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_skin/portrait.pdf</a> -</a> -> -</dt> -<dd></dd> - -<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_skin/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_skin/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_skin/landscape.pdf</a> -</a> -> </dt> -<dd> </dd> - -<dt>at: <<a href='http://www.jus.uio.no/sisu'><a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> -</a> -> -</dt> -<dd></dd> - -<dt>* Generated by: SiSU 0.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> diff --git a/data/doc/sisu/html/sisu_syntax_highlighting.8.html b/data/doc/sisu/html/sisu_syntax_highlighting.8.html deleted file mode 100644 index 3eb27e48..00000000 --- a/data/doc/sisu/html/sisu_syntax_highlighting.8.html +++ /dev/null @@ -1,219 +0,0 @@ -<!-- manual page source format generated by PolyglotMan v3.2, --> -<!-- available at http://polyglotman.sourceforge.net/ --> - -<html> -<head> -<title>"sisu_syntax_highlighting"("1") manual page</title> -</head> -<body bgcolor='white'> -<a href='#toc'>Table of Contents</a><p> -SISU - SYNTAX HIGHLIGHTING, RALPH AMISSAH -<p> SISU SYNTAX HIGHLIGHTING -<p> 1. -EDITOR FILES, SYNTAX HIGHLIGHTING -<p> The directory: -<p> ./data/sisu/conf/editor-syntax-etc/<br> - -<p> /usr/share/sisu/conf/editor-syntax-etc<br> - -<p> contains rudimentary sisu syntax highlighting files for: -<p> * (g)vim -<<a href='http://www.vim.org'>http://www.vim.org</a> -> -<p> package: sisu-vim<br> - -<p> status: largely done -<p> there is a vim syntax highlighting and folds -component<br> - -<p> * gedit <<a href='http://www.gnome.org/projects/gedit'>http://www.gnome.org/projects/gedit</a> -> -<p> * gobby <<a href='http://gobby.0x539.de/'>http://gobby.0x539.de/</a> -> - -<p> file: sisu.lang<br> - -<p> place in: -<p> /usr/share/gtksourceview-1.0/language-specs<br> - -<p> or -<p> ~/.gnome2/gtksourceview-1.0/language-specs<br> - -<p> status: very basic syntax highlighting<br> - -<p> comments: this editor features display line wrap and is used by Goby!<br> - -<p> * nano <<a href='http://www.nano-editor.org'>http://www.nano-editor.org</a> -> -<p> file: nanorc<br> - -<p> save as: -<p> ~/.nanorc<br> - -<p> status: basic syntax highlighting<br> - -<p> comments: assumes dark background; no display line-wrap; does line -breaks<br> - -<p> * diakonos (an editor written in ruby) <<a href='http://purepistos.net/diakonos'>http://purepistos.net/diakonos</a> -> - -<p> file: diakonos.conf -<p> save as: -<p> ~/.diakonos/diakonos.conf<br> - -<p> includes: -<p> status: basic syntax highlighting<br> - -<p> comments: assumes dark background; no display line-wrap -<p> * kate & kwrite -<<a href='http://kate.kde.org'>http://kate.kde.org</a> -> -<p> file: sisu.xml<br> - -<p> place in:<br> - -<p> /usr/share/apps/katepart/syntax<br> - -<p> or<br> - -<p> ~/.kde/share/apps/katepart/syntax<br> - -<p> [settings::configure kate::{highlighting,filetypes}]<br> - -<p> [tools::highlighting::{markup,scripts}::<br> - <b> SiSU</b> ] -<p> * nedit <<a href='http://www.nedit.org'>http://www.nedit.org</a> -> -<p> file: sisu_nedit.pats<br> - -<p> nedit -import sisu_nedit.pats<br> - -<p> status: a very clumsy first attempt [not really done]<br> - -<p> comments: this editor features display line wrap<br> - -<p> * emacs <<a href='http://www.gnu.org/software/emacs/emacs.html'>http://www.gnu.org/software/emacs/emacs.html</a> -> -<p> files: sisu-mode.el<br> - -<p> to file ~/.emacs add the following 2 lines:<br> - -<p> (add-to-list ’load-path<br> - -<p> (require ’sisu-mode.el)<br> - -<p> [not done / not yet included]<br> - -<p> * vim & gvim <<a href='http://www.vim.org'>http://www.vim.org</a> -> -<p> files:<br> - -<p> package is the most comprehensive sisu syntax highlighting and editor<br> - environment provided to date (is for vim/ gvim, and is separate from -the<br> - contents of this directory)<br> - -<p> status: this includes: syntax highlighting; vim folds; some error -checking<br> - -<p> comments: this editor features display line wrap<br> - -<p> NOTE: -<p> [ <b> SiSU</b> parses files with long lines or line breaks, but, display - linewrap (without line-breaks) is a convenient editor feature to have for - sisu markup] -<p> DOCUMENT INFORMATION (METADATA) -<p> METADATA -<p> Document Manifest -@ <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_syntax_highlighting/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_syntax_highlighting/sisu_manifest.html</a> -> - -<p> <b>Dublin Core</b> (DC) -<p> <i>DC</i> tags included with this document are provided here. - -<p> DC Title: <i>SiSU</i> - Syntax Highlighting -<p> DC Creator: <i>Ralph</i> Amissah -<p> DC -Rights: <i>Copyright</i> (C) Ralph Amissah 2007, part of SiSU documentation, License - -<p>GPL 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_syntax_highlighting.sst</i> - -<p> Filetype: <i>SiSU</i> text insert 0.58 -<p> Sourcefile Digest, MD5(sisu_syntax_highlighting.sst)= - -<p><i>28dd0275c6fcd67bbedcd8aee9df4b3e</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:17 +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) - [i486-linux] -<p> -<p> -<dl> - -<dt>Other versions of this document: </dt> -<dd></dd> - -<dt>manifest: <<a href='http://www.jus.uio.no/sisu/sisu_syntax_highlighting/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_syntax_highlighting/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_syntax_highlighting/sisu_manifest.html</a> -</a> -> -</dt> -<dd></dd> - -<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_syntax_highlighting/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_syntax_highlighting/toc.html'>http://www.jus.uio.no/sisu/sisu_syntax_highlighting/toc.html</a> -</a> -> </dt> -<dd></dd> - -<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_syntax_highlighting/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_syntax_highlighting/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_syntax_highlighting/portrait.pdf</a> -</a> -> -</dt> -<dd></dd> - -<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_syntax_highlighting/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_syntax_highlighting/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_syntax_highlighting/landscape.pdf</a> -</a> -> </dt> -<dd> </dd> - -<dt>at: -<<a href='http://www.jus.uio.no/sisu'><a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> -</a> -> </dt> -<dd></dd> - -<dt>* Generated by: SiSU 0.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:32 +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> |