From 50d45c6deb0afd2e4222d2e33a45487a9d1fa676 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Sun, 23 Sep 2007 05:16:21 +0100 Subject: primarily todo with sisu documentation, changelog reproduced below: * start documenting sisu using sisu * sisu markup source files in data/doc/sisu/sisu_markup_samples/sisu_manual/ /usr/share/doc/sisu/sisu_markup_samples/sisu_manual/ * default output [sisu -3] in data/doc/manuals_generated/sisu_manual/ /usr/share/doc/manuals_generated/sisu_manual/ (adds substantially to the size of sisu package!) * help related edits * manpage, work on ability to generate manpages, improved * param, exclude footnote mark count when occurs within code block * plaintext changes made * shared_txt, line wrap visited * file:// link option introduced (in addition to existing https?:// and ftp://) a bit arbitrarily, diff here, [double check changes in sysenv and hub] * minor adjustments * html url match refinement * css added tiny_center * plaintext * endnotes fix * footnote adjustment to make more easily distinguishable from substantive text * flag -a only [flags -A -e -E dropped] controlled by modifiers --unix/msdos --footnote/endnote * defaults, homepage * renamed homepage (instead of index) implications for modifying skins, which need likewise to have any homepage entry renamed * added link to sisu_manual in homepage * css the css for the default homepage is renamed homepage.css (instead of index.css) [consider removing this and relying on html.css] * ruby version < ruby1.9 * place stop on installation and working with for now [ruby String.strip broken in ruby 1.9.0 (2007-09-10 patchlevel 0) [i486-linux], 2007-09-18:38/2] * debian/control restrict use to ruby > 1.8.4 and ruby < 1.9 * debian * debian/control restrict use to ruby > 1.8.4 and ruby < 1.9 * sisu-doc new sub-package for sisu documentation debian/control and sisu-doc.install --- .../sisu_manual/sisu_quickstart/1.html | 1626 +++++++++++++++ .../sisu_manual/sisu_quickstart/concordance.html | 769 +++++++ .../sisu_manual/sisu_quickstart/digest.txt | 203 ++ .../sisu_manual/sisu_quickstart/doc.html | 2129 ++++++++++++++++++++ .../sisu_manual/sisu_quickstart/dom.xml | 1267 ++++++++++++ .../sisu_manual/sisu_quickstart/endnotes.html | 484 +++++ .../sisu_manual/sisu_quickstart/index.html | 584 ++++++ .../sisu_manual/sisu_quickstart/landscape.pdf | Bin 0 -> 111469 bytes .../sisu_manual/sisu_quickstart/metadata.html | 591 ++++++ .../sisu_manual/sisu_quickstart/opendocument.odt | Bin 0 -> 10908 bytes .../sisu_manual/sisu_quickstart/plain.txt | 476 +++++ .../sisu_manual/sisu_quickstart/portrait.pdf | Bin 0 -> 114292 bytes .../sisu_manual/sisu_quickstart/sax.xml | 767 +++++++ .../sisu_manual/sisu_quickstart/scroll.xhtml | 753 +++++++ .../sisu_manual/sisu_quickstart/sisu_manifest.html | 200 ++ .../sisu_quickstart/sisu_quickstart.sst | 273 +++ .../sisu_manual/sisu_quickstart/sisupod.zip | Bin 0 -> 5598 bytes .../sisu_manual/sisu_quickstart/sitemap.xml | 30 + .../sisu_manual/sisu_quickstart/toc.html | 584 ++++++ 19 files changed, 10736 insertions(+) create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_quickstart/1.html create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_quickstart/concordance.html create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_quickstart/digest.txt create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_quickstart/doc.html create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_quickstart/dom.xml create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_quickstart/endnotes.html create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_quickstart/index.html create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_quickstart/landscape.pdf create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_quickstart/metadata.html create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_quickstart/opendocument.odt create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_quickstart/plain.txt create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_quickstart/portrait.pdf create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_quickstart/sax.xml create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_quickstart/scroll.xhtml create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_quickstart/sisu_manifest.html create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_quickstart/sisu_quickstart.sst create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_quickstart/sisupod.zip create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_quickstart/sitemap.xml create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_quickstart/toc.html (limited to 'data/doc/manuals_generated/sisu_manual/sisu_quickstart') diff --git a/data/doc/manuals_generated/sisu_manual/sisu_quickstart/1.html b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/1.html new file mode 100644 index 00000000..bf834ea0 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/1.html @@ -0,0 +1,1626 @@ + + + + + + 1 - + SiSU - SiSU information Structuring Universe / Structured information, Serialized Units + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ +
SiSU -->
+		 + + + + + + + + + + + + + + + + + +
+ + + TOC linked  toc  + + + + + + Full Text  scroll  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
+		 + + + + + + +
+ + TOC + + + + next >> + + +
+
+ + + + +
+ + < + + + + ^ + + + + > + +

+ SiSU - SiSU information Structuring Universe / Structured information, Serialized Units +

+

+ Quickstart, installation and use +

+

+ Ralph Amissah + +

+

+ copy @ + + SiSU + +

+ + +
+

+ SiSU - SiSU information Structuring Universe / Structured information, Serialized Units - Quickstart, installation and use,
Ralph Amissah +

+		   +

+   1 +

+
+ + +
+ +   +

+   2 +

+
+ + +
+ +   +
+ + +
+

+ + 1. Quickstart - Getting Started Howto +

+		 +

+   3 +

+
+ + 1.1 Installation + +
+ + 1.1.1 Debian Installation + +
+ + 1.1.2 RPM Installation + +
+ + 1.1.3 Installation from source + +
+ + 1.2 Testing SiSU, generating output + +
+ + 1.2.1 basic text, plaintext, html, XML, ODF + +
+ + 1.2.2 LaTeX / pdf + +
+ + 1.2.3 relational database - postgresql, sqlite + +
+ + 1.3 Getting Help + +
+ + 1.3.1 The man pages + +
+ + 1.3.2 Built in help + +
+ + 1.3.3 The home page + +
+ + 1.4 Markup Samples + +
+ + +
+ +

+ 1.1 Installation +

+		 +

+   4 +

+
+ + +
+

+ Installation is currently most straightforward and tested on the Debian platform, as there are packages for the installation of sisu and all requirements for what it does. +

+		 +

+   5 +

+
+ + +
+ +

+ 1.1.1 Debian Installation +

+		 +

+   6 +

+
+ + +
+

+ SiSU is available directly from the Debian Sid and testing archives (and possibly Ubuntu), assuming your /etc/apt/sources.list is set accordingly: +

+		 +

+   7 +

+
+ + +
+

+     aptitude update
    aptitude install sisu-complete +

+		 +

+   8 +

+
+ + +
+

+ The following /etc/apt/sources.list setting permits the download of additional markup samples: +

+		 +

+   9 +

+
+ + +
+

+   #/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 +

+		 +

+   10 +

+
+ + +
+

+ The aptitude commands become: +

+		 +

+   11 +

+
+ + +
+

+     aptitude update
    aptitude install sisu-complete sisu-markup-samples +

+		 +

+   12 +

+
+ + +
+

+ If there are newer versions of SiSU upstream of the Debian archives, they will be available by adding the following to your /etc/apt/sources.list +

+		 +

+   13 +

+
+ + +
+

+   #/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 +

+		 +

+   14 +

+
+ + +
+

+ repeat the aptitude commands +

+		 +

+   15 +

+
+ + +
+

+     aptitude update
    aptitude install sisu-complete sisu-markup-samples +

+		 +

+   16 +

+
+ + +
+

+ 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. +

+		 +

+   17 +

+
+ + +
+ +

+ 1.1.2 RPM Installation +

+		 +

+   18 +

+
+ + +
+

+ RPMs are provided though untested, they are prepared by running alien against the source package, and against the debs. +

+		 +

+   19 +

+
+ + +
+

+ They may be downloaded from: +

+		 +

+   20 +

+
+ + +
+

+ <http://www.jus.uio.no/sisu/SiSU/download.html#rpm> +

+		 +

+   21 +

+
+ + +
+

+ as root type: +

+		 +

+   22 +

+
+ + +
+

+ rpm -i [rpm package name] +

+		 +

+   23 +

+
+ + +
+ +

+ 1.1.3 Installation from source +

+		 +

+   24 +

+
+ + +
+

+ To install SiSU from source check information at: +

+		 +

+   25 +

+
+ + +
+

+ <http://www.jus.uio.no/sisu/SiSU/download.html#current> +

+		 +

+   26 +

+
+ + +
+
  • + download the source package +
    • +    		 +

    +   27 +

    +
    + + +
    +
  • + Unpack the source +
    • +    		 +

    +   28 +

    +
    + + +
    +

    + 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: +

    +    		 +

    +   29 +

    +
    + + +
    +

    + For basic use SiSU is only dependent on the programming language in which it is written Ruby, and SiSU will be able to generate html, various XMLs, including ODF (and will also produce LaTeX). Dependencies required for further actions, though it relies on the installation of additional dependencies which the source tarball does not take care of, for things like using a database (postgresql or sqlite)  1  or converting LaTeX to pdf. +

    +    		 +

    +   30 +

    +
    + + +
    +

    + setup.rb +

    +    		 +

    +   31 +

    +
    + + +
    +

    + This is a standard ruby installer, using setup.rb is a three step process. In the root directory of the unpacked SiSU as root type: +

    +    		 +

    +   32 +

    +
    + + +
    +

    +       ruby setup.rb config
          ruby setup.rb setup
          #[and as root:]
          ruby setup.rb install +

    +    		 +

    +   33 +

    +
    + + +
    +

    + further information on setup.rb is available from: +

    +    		 +

    +   34 +

    +
    + + +
    +

    + <http://i.loveruby.net/en/projects/setup/> +

    +    		 +

    +   35 +

    +
    + + +
    +

    + <http://i.loveruby.net/en/projects/setup/doc/usage.html> +

    +    		 +

    +   36 +

    +
    + + +
    +

    + "install" +

    +    		 +

    +   37 +

    +
    + + +
    +

    + The "install" file provided is an installer prepared using "rant". In the root directory of the unpacked SiSU as root type: +

    +    		 +

    +   38 +

    +
    + + +
    +

    + ruby install base +

    +    		 +

    +   39 +

    +
    + + +
    +

    + or for a more complete installation: +

    +    		 +

    +   40 +

    +
    + + +
    +

    + ruby install +

    +    		 +

    +   41 +

    +
    + + +
    +

    + or +

    +    		 +

    +   42 +

    +
    + + +
    +

    + ruby install base +

    +    		 +

    +   43 +

    +
    + + +
    +

    + 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. +

    +    		 +

    +   44 +

    +
    + + +
    +

    + Further information on "rant" is available from: +

    +    		 +

    +   45 +

    +
    + + +
    +

    + <http://make.rubyforge.org/> +

    +    		 +

    +   46 +

    +
    + + +
    +

    + <http://rubyforge.org/frs/?group_id=615> +

    +    		 +

    +   47 +

    +
    + + +
    +

    + For a list of alternative actions you may type: +

    +    		 +

    +   48 +

    +
    + + +
    +

    + ruby install help +

    +    		 +

    +   49 +

    +
    + + +
    +

    + ruby install -T +

    +    		 +

    +   50 +

    +
    + + +
    + +

    + 1.2 Testing SiSU, generating output +

    +    		 +

    +   51 +

    +
    + + +
    +

    + To check which version of sisu is installed: +

    +    		 +

    +   52 +

    +
    + + +
    +

    + sisu -v +

    +    		 +

    +   53 +

    +
    + + +
    +

    + Depending on your mode of installation one or a number of markup sample files may be found either in the directory: +

    +    		 +

    +   54 +

    +
    + + +
    +

    + ... +

    +    		 +

    +   55 +

    +
    + + +
    +

    + or +

    +    		 +

    +   56 +

    +
    + + +
    +

    + ... +

    +    		 +

    +   57 +

    +
    + + +
    +

    + change directory to the appropriate one: +

    +    		 +

    +   58 +

    +
    + + +
    +

    + cd /usr/share/doc/sisu/sisu_markup_samples/dfsg +

    +    		 +

    +   59 +

    +
    + + +
    + +

    + 1.2.1 basic text, plaintext, html, XML, ODF +

    +    		 +

    +   60 +

    +
    + + +
    +

    + Having moved to the directory that contains the markup samples (see instructions above if necessary), choose a file and run sisu against it +

    +    		 +

    +   61 +

    +
    + + +
    +

    + sisu -NhwoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst +

    +    		 +

    +   62 +

    +
    + + +
    +

    + this will generate html including a concordance file, opendocument text format, plaintext, XHTML and various forms of XML, and OpenDocument text +

    +    		 +

    +   63 +

    +
    + + +
    + +

    + 1.2.2 LaTeX / pdf +

    +    		 +

    +   64 +

    +
    + + +
    +

    + Assuming a LaTeX engine such as tetex or texlive is installed with the required modules (done automatically on selection of sisu-pdf in Debian) +

    +    		 +

    +   65 +

    +
    + + +
    +

    + Having moved to the directory that contains the markup samples (see instructions above if necessary), choose a file and run sisu against it +

    +    		 +

    +   66 +

    +
    + + +
    +

    + sisu -pv free_as_in_freedom.rms_and_free_software.sam_williams.sst +

    +    		 +

    +   67 +

    +
    + + +
    +

    + sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst +

    +    		 +

    +   68 +

    +
    + + +
    +

    + should generate most available output formats: html including a concordance file, opendocument text format, plaintext, XHTML and various forms of XML, and OpenDocument text and pdf +

    +    		 +

    +   69 +

    +
    + + +
    + +

    + 1.2.3 relational database - postgresql, sqlite +

    +    		 +

    +   70 +

    +
    + + +
    +

    + Relational databases need some setting up - you must have permission to create the database and write to it when you run sisu. +

    +    		 +

    +   71 +

    +
    + + +
    +

    + Assuming you have the database installed and the requisite permissions +

    +    		 +

    +   72 +

    +
    + + +
    +

    + sisu --sqlite --recreate +

    +    		 +

    +   73 +

    +
    + + +
    +

    + sisu --sqlite -v --import free_as_in_freedom.rms_and_free_software.sam_williams.sst +

    +    		 +

    +   74 +

    +
    + + +
    +

    + sisu --pgsql --recreate +

    +    		 +

    +   75 +

    +
    + + +
    +

    + sisu --pgsql -v --import free_as_in_freedom.rms_and_free_software.sam_williams.sst +

    +    		 +

    +   76 +

    +
    + + +
    + +

    + 1.3 Getting Help +

    +    		 +

    +   77 +

    +
    + + +
    + +

    + 1.3.1 The man pages +

    +    		 +

    +   78 +

    +
    + + +
    +

    + Type: +

    +    		 +

    +   79 +

    +
    + + +
    +

    + man sisu +

    +    		 +

    +   80 +

    +
    + + +
    +

    + The man pages are also available online, though not always kept as up to date as within the package itself: +

    +    		 +

    +   81 +

    +
    + + +
    +
  • + sisu.1   2  +
    • +    		 +

    +   82 +

    +
    + + +
    +
  • + sisu.8   3  +
    • +    		 +

    +   83 +

    +
    + + +
    +
  • + man directory   4  +
    • +    		 +

    +   84 +

    +
    + + +
    + +

    + 1.3.2 Built in help +

    +    		 +

    +   85 +

    +
    + + +
    +

    + sisu --help +

    +    		 +

    +   86 +

    +
    + + +
    +

    + sisu --help --env +

    +    		 +

    +   87 +

    +
    + + +
    +

    + sisu --help --commands +

    +    		 +

    +   88 +

    +
    + + +
    +

    + sisu --help --markup +

    +    		 +

    +   89 +

    +
    + + +
    + +

    + 1.3.3 The home page +

    +    		 +

    +   90 +

    +
    + + +
    +

    + <http://www.jus.uio.no/sisu> +

    +    		 +

    +   91 +

    +
    + + +
    +

    + <http://www.jus.uio.no/sisu/SiSU> +

    +    		 +

    +   92 +

    +
    + + +
    + +

    + 1.4 Markup Samples +

    +    		 +

    +   93 +

    +
    + + +
    +

    + A number of markup samples (along with output) are available off: +

    +    		 +

    +   94 +

    +
    + + +
    +

    + <http://www.jus.uio.no/sisu/SiSU/2.html> +

    +    		 +

    +   95 +

    +
    + + +
    +

    + Additional markup samples are packaged separately in the file: +

    +    		 +

    +   96 +

    +
    + + +
    +

    + * +

    +    		 +

    +   97 +

    +
    + + +
    +

    + On Debian 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. +

    +    		 +

    +   98 +

    +

    +^

    + + +
    +

    +  1. There is nothing to stop MySQL support being added in future. +

    +    		   +
    + + +
    +

    +  2. <http://www.jus.uio.no/sisu/man/sisu.1> +

    +    		   +
    + + +
    +

    +  3. <http://www.jus.uio.no/sisu/man/sisu.8> +

    +    		   +
    + + +
    +

    +  4. <http://www.jus.uio.no/sisu/man> +

    +    		   +
    + + +
    +

    +  5. the Debian Free Software guidelines require that everything distributed within Debian can be changed - and the documents are authors' works that while freely distributable are not freely changeable. +

    +    		   +
     
    + + + +
    + +
    SiSU -->
    +    		 + + + + + + + + + + + + + + + + + +
    + + + TOC linked  toc  + + + + + + Full Text  scroll  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
    +    		 + + + + + + +
    + + TOC + + + + next >> + + +
    +
    + + + + +
    + + < + + + + ^ + + + + > + +

    + + + + + + + + +
    + +
    +

    + + SiSU + +

    +    		 + +

    + Output generated by + + SiSU + + 0.59.0 2007-09-23 (2007w38/0) +
    + + SiSU + + Copyright © Ralph Amissah + 1997, current 2007. + All Rights Reserved. +
    + + SiSU + + is software for document structuring, publishing and search, +
    + + www.jus.uio.no/sisu + + and + + www.sisudoc.org + +
    + w3 since October 3 1993 + + ralph@amissah.com + +

    +    		 +

    + SiSU using: +
    Standard SiSU markup syntax, +
    Standard SiSU meta-markup syntax, and the +
    Standard SiSU object citation numbering and system, (object/text positioning system) +
    + Copyright © Ralph Amissah 1997, current 2007. + All Rights Reserved. +

    +
    +

    + + GPLv3 + +

    +    		 +

    + + SiSU + + is released under + GPLv3 + or later, + <http://www.gnu.org/licenses/gpl.html> +

    +    		 +

    + SiSU, developed using + + Ruby + + on + + Debian/Gnu/Linux + + software infrastructure, + with the usual GPL (or OSS) suspects. +
    + Better - "performance, reliability, scalability, security & total cost of ownership" + [not to mention flexibility & choice] use of and adherence to open standards (where practical and fair) and it is software libre. +
    + Get With the Future + + Way Better! + +

    +
    + + + + + +
    +
    + + +
    + + +
    + + + + idx + txt + + +
    +
    + +
    +

    + + +SiSU manual + +

    + + + + +

    SiSU introduction

    +

    SiSU commands

    +

    SiSU markup

    +

    SiSU configuration

    +

    SiSU help

    +

    SiSU help sources

    + +
    +

    + + +SiSU + +

    + + + + +

    What does SiSU do? Summary

    +

    SiSU Book Samples and Markup Examples

    +

    Markup

    +

    Commands

    +

    Manual

    +

    SiSU Download

    +

    SiSU Changelog

    +

    Wikipedia entry

    +

    Freshmeat

    +

    Ruby Application Archive

    + + +
    + \ No newline at end of file diff --git a/data/doc/manuals_generated/sisu_manual/sisu_quickstart/concordance.html b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/concordance.html new file mode 100644 index 00000000..3e47a7d6 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/concordance.html @@ -0,0 +1,769 @@ + + + + + SiSU created WordIndex for: SiSU - SiSU information Structuring Universe / Structured information, Serialized Units - Quickstart, installation and use + + + + + + + + + + + + + + + + +
    + +
    SiSU -->
    +    		 + + + + + + + + + + + + + + +
    + + + TOC linked  toc  + + + + + + Full Text  scroll  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
    +    		 +   + TOC +   +
    +

    +
     

    SiSU - SiSU information Structuring Universe / Structured information, Serialized Units - Quickstart, installation and use

    Ralph Amissah

    + +

    Word index links are to html versions of the text the segmented version followed by the scroll (single document) version.
    [For segmented text references [T1], [T2] or [T3] appearing without a link, indicates that the word appears in a title (or subtitle) of the text (that is identifiable by the appended object citation number).]

    +

    (The word listing/index is Case sensitive: Capitalized words appear before lower case)

    +

    + word (number of occurences)
    linked references to word within document
    + [if number of occurences exceed number of references - word occurs more than once in at least one reference. Footnote/endnotes are either assigned to the paragraph from which they are referenced or ignored, so it is relevant to check the footnotes referenced from within a paragraph as well.] +

    +

    + (After the page is fully loaded) you can jump directly to a word by appending a hash (#) and the word to the url for this text, (do not forget that words are case sensitive, and may be listed twice (starting with and without an upper case letter)), #your_word # [ http://[web host]/sisu_quickstart/concordance.html#your_word ] +

    + +

    Able

    (1)

    +

    30,

    +

    Above

    (2)

    +

    61, 66,

    +

    Accordingly

    (1)

    +

    7,

    +

    Actions

    (2)

    +

    30, 48,

    +

    Added

    (1)

    +

    30,

    +

    Adding

    (1)

    +

    13,

    +

    Additional

    (4)

    +

    9, 30, 44, 96,

    +

    Against

    (4)

    +

    19, 61, 66,

    +

    Alien

    (1)

    +

    19,

    +

    All

    (2)

    +

    5, 17,

    +

    Along

    (1)

    +

    94,

    +

    Also

    (2)

    +

    30, 81,

    +

    Alternative

    (2)

    +

    29, 48,

    +

    Always

    (1)

    +

    81,

    +

    Amissah

    (1)

    +

    [H]1,

    +

    And

    (24)

    +

    [H]1, [H]2, 5, 7, 19, 29, 30, 33, 44, 61, 63, 66, 69, 71, 72, 98,

    +

    Aoki

    (1)

    +

    29,

    +

    Appropriate

    (1)

    +

    58,

    +

    Apt

    (6)

    +

    7, 9, 10, 13, 14, 98,

    +

    Aptitude

    (8)

    +

    8, 11, 12, 15, 16,

    +

    Archives

    (2)

    +

    7, 13,

    +

    Are

    (14)

    +

    5, 13, 17, 19, 29, 44, 81, 94, 96, 98,

    +

    Assuming

    (3)

    +

    7, 65, 72,

    +

    Authors

    (1)

    +

    98,

    +

    Automatically

    (1)

    +

    65,

    +

    Available

    (8)

    +

    7, 13, 34, 45, 69, 81, 94, 98,

    +

    Base

    (2)

    +

    39, 43,

    +

    Basic

    (3)

    +

    17, 30, 60,

    +

    Become

    (1)

    +

    11,

    +

    Been

    (1)

    +

    44,

    +

    Being

    (1)

    +

    30,

    +

    Built

    (2)

    +

    29, 85,

    +

    Can

    (1)

    +

    98,

    +

    Care

    (2)

    +

    30, 44,

    +

    Case

    (1)

    +

    29,

    +

    Change

    (1)

    +

    58,

    +

    Changeable

    (1)

    +

    98,

    +

    Changed

    (1)

    +

    98,

    +

    Check

    (2)

    +

    25, 52,

    +

    Choose

    (2)

    +

    61, 66,

    +

    Commands

    (3)

    +

    11, 15, 88,

    +

    Complete

    (5)

    +

    8, 12, 16, 17, 40,

    +

    Components

    (1)

    +

    17,

    +

    Concordance

    (2)

    +

    63, 69,

    +

    Config

    (1)

    +

    33,

    +

    Configuration

    (1)

    +

    44,

    +

    Configured

    (1)

    +

    44,

    +

    Contains

    (2)

    +

    61, 66,

    +

    Contrib

    (2)

    +

    10,

    +

    Converting

    (1)

    +

    30,

    +

    Create

    (1)

    +

    71,

    +

    Currently

    (1)

    +

    5,

    +

    Database

    (4)

    +

    30, 70, 71, 72,

    +

    Databases

    (1)

    +

    71,

    +

    Date

    (1)

    +

    81,

    +

    Deb

    (4)

    +

    10, 14,

    +

    Debian

    (8)

    +

    5, 6, 7, 13, 65, 98,

    +

    Debs

    (1)

    +

    19,

    +

    Dependencies

    (3)

    +

    30, 44,

    +

    Dependent

    (1)

    +

    30,

    +

    Depending

    (1)

    +

    54,

    +

    Dfsg

    (1)

    +

    59,

    +

    Directly

    (1)

    +

    7,

    +

    Directory

    (7)

    +

    32, 38, 54, 58, 61, 66, 84,

    +

    Distributable

    (1)

    +

    98,

    +

    Distributed

    (1)

    +

    98,

    +

    Doc

    (1)

    +

    59,

    +

    Documents

    (1)

    +

    98,

    +

    Does

    (2)

    +

    5, 30,

    +

    Done

    (1)

    +

    65,

    +

    Download

    (3)

    +

    9, 27, 29,

    +

    Downloaded

    (1)

    +

    20,

    +

    Either

    (2)

    +

    29, 54,

    +

    Engine

    (1)

    +

    65,

    +

    Env

    (1)

    +

    87,

    +

    Etc

    (6)

    +

    7, 9, 10, 13, 14, 98,

    +

    Everything

    (1)

    +

    98,

    +

    External

    (1)

    +

    44,

    +

    Extra

    (1)

    +

    44,

    +

    File

    (9)

    +

    29, 38, 44, 61, 63, 66, 69, 96,

    +

    Files

    (1)

    +

    54,

    +

    First

    (2)

    +

    29, 44,

    +

    Following

    (2)

    +

    9, 13,

    +

    For

    (8)

    +

    5, 30, 40, 44, 48,

    +

    Format

    (2)

    +

    63, 69,

    +

    Formats

    (1)

    +

    69,

    +

    Forms

    (2)

    +

    63, 69,

    +

    Found

    (1)

    +

    54,

    +

    Free

    (7)

    +

    10, 14, 98,

    +

    Freely

    (2)

    +

    98,

    +

    From

    (8)

    +

    7, 20, 24, 25, 29, 34, 45, 98,

    +

    Functionality

    (1)

    +

    17,

    +

    Further

    (3)

    +

    30, 34, 45,

    +

    Future

    (1)

    +

    30,

    +

    Generate

    (3)

    +

    30, 63, 69,

    +

    Generating

    (1)

    +

    51,

    +

    Generation

    (1)

    +

    44,

    +

    Getting

    (2)

    +

    3, 77,

    +

    Guidelines

    (1)

    +

    98,

    +

    Has

    (1)

    +

    44,

    +

    Have

    (2)

    +

    71, 72,

    +

    Having

    (2)

    +

    61, 66,

    +

    Help

    (7)

    +

    49, 77, 85, 86, 87, 88, 89,

    +

    Home

    (2)

    +

    90, 98,

    +

    However

    (2)

    +

    17, 44,

    +

    Howto

    (1)

    +

    3,

    +

    Html

    (4)

    +

    30, 60, 63, 69,

    +

    Import

    (2)

    +

    74, 76,

    +

    Include

    (2)

    +

    98,

    +

    Including

    (3)

    +

    30, 63, 69,

    +

    Information

    (5)

    +

    [H]1, 25, 34, 45,

    +

    Install

    (14)

    +

    8, 12, 16, 17, 25, 29, 33, 37, 38, 39, 41, 43, 49, 50,

    +

    Installation

    (13)

    +

    [H]1, [H]2, 4, 5, 6, 18, 24, 29, 30, 40, 44, 54,

    +

    Installed

    (3)

    +

    52, 65, 72,

    +

    Installer

    (2)

    +

    32, 38,

    +

    Installing

    (1)

    +

    17,

    +

    Instructions

    (2)

    +

    61, 66,

    +

    Itself

    (1)

    +

    81,

    +

    Just

    (1)

    +

    17,

    +

    Kept

    (1)

    +

    81,

    +

    Lang

    (2)

    +

    29, 44,

    +

    Language

    (1)

    +

    30,

    +

    Latex

    (4)

    +

    30, 64, 65,

    +

    Like

    (1)

    +

    30,

    +

    List

    (7)

    +

    7, 9, 10, 13, 14, 48, 98,

    +

    Main

    (4)

    +

    10, 14,

    +

    Makes

    (1)

    +

    44,

    +

    Man

    (4)

    +

    78, 80, 81, 84,

    +

    Markup

    (10)

    +

    9, 12, 16, 54, 61, 66, 89, 93, 94, 96,

    +

    May

    (3)

    +

    20, 48, 54,

    +

    Minero

    (1)

    +

    29,

    +

    Mode

    (1)

    +

    54,

    +

    Modes

    (1)

    +

    29,

    +

    Modules

    (1)

    +

    65,

    +

    More

    (1)

    +

    40,

    +

    Most

    (2)

    +

    5, 69,

    +

    Moved

    (2)

    +

    61, 66,

    +

    Must

    (1)

    +

    71,

    +

    MySQL

    (1)

    +

    30,

    +

    Name

    (1)

    +

    23,

    +

    Nbsp

    (70)

    +

    8, 10, 12, 14, 16, 33,

    +

    Necessary

    (4)

    +

    17, 61, 66, 98,

    +

    Need

    (1)

    +

    71,

    +

    Newer

    (1)

    +

    13,

    +

    Nhwoabxxyv

    (1)

    +

    62,

    +

    Non

    (6)

    +

    10, 14, 98,

    +

    Not

    (6)

    +

    17, 30, 44, 81, 98,

    +

    Note

    (2)

    +

    17, 44,

    +

    Nothing

    (1)

    +

    30,

    +

    Number

    (2)

    +

    54, 94,

    +

    Obtain

    (1)

    +

    98,

    +

    ODF

    (2)

    +

    30, 60,

    +

    Off

    (1)

    +

    94,

    +

    One

    (2)

    +

    54, 58,

    +

    Online

    (1)

    +

    81,

    +

    Only

    (1)

    +

    30,

    +

    Opendocument

    (4)

    +

    63, 69,

    +

    Output

    (3)

    +

    51, 69, 94,

    +

    Package

    (6)

    +

    17, 19, 23, 27, 44, 81,

    +

    Packaged

    (1)

    +

    96,

    +

    Packages

    (1)

    +

    5,

    +

    Page

    (1)

    +

    90,

    +

    Pages

    (2)

    +

    78, 81,

    +

    Pdf

    (4)

    +

    30, 64, 65, 69,

    +

    Permission

    (1)

    +

    71,

    +

    Permissions

    (1)

    +

    72,

    +

    Permits

    (1)

    +

    9,

    +

    Pgsql

    (2)

    +

    75, 76,

    +

    Plaintext

    (3)

    +

    60, 63, 69,

    +

    Platform

    (1)

    +

    5,

    +

    Possibly

    (1)

    +

    7,

    +

    Post

    (1)

    +

    44,

    +

    Postgresql

    (2)

    +

    30, 70,

    +

    Prepared

    (2)

    +

    19, 38,

    +

    Process

    (1)

    +

    32,

    +

    Produce

    (1)

    +

    30,

    +

    Programming

    (1)

    +

    30,

    +

    Provide

    (1)

    +

    17,

    +

    Provided

    (4)

    +

    19, 29, 38, 44,

    +

    Quickstart

    (3)

    +

    [H]1, [H]2, 3,

    +

    Ralph

    (1)

    +

    [H]1,

    +

    Rant

    (4)

    +

    29, 38, 44, 45,

    +

    Rantfile

    (1)

    +

    44,

    +

    Recreate

    (2)

    +

    73, 75,

    +

    Relational

    (2)

    +

    70, 71,

    +

    Relies

    (1)

    +

    30,

    +

    Repeat

    (1)

    +

    15,

    +

    Require

    (1)

    +

    98,

    +

    Required

    (2)

    +

    30, 65,

    +

    Requirements

    (1)

    +

    5,

    +

    Requisite

    (1)

    +

    72,

    +

    Root

    (6)

    +

    22, 32, 33, 38,

    +

    RPM

    (1)

    +

    18,

    +

    Rpm

    (2)

    +

    23,

    +

    RPMs

    (1)

    +

    19,

    +

    Ruby

    (10)

    +

    30, 32, 33, 39, 41, 43, 49, 50,

    +

    Run

    (3)

    +

    61, 66, 71,

    +

    Running

    (1)

    +

    19,

    +

    Same

    (1)

    +

    29,

    +

    Sample

    (1)

    +

    54,

    +

    Samples

    (8)

    +

    9, 12, 16, 61, 66, 93, 94, 96,

    +

    See

    (2)

    +

    61, 66,

    +

    Selection

    (1)

    +

    65,

    +

    Separately

    (1)

    +

    96,

    +

    Serialized

    (1)

    +

    [H]1,

    +

    Set

    (1)

    +

    7,

    +

    Setting

    (2)

    +

    9, 71,

    +

    Setup

    (10)

    +

    29, 31, 32, 33, 34, 44,

    +

    Share

    (1)

    +

    59,

    +

    Should

    (1)

    +

    69,

    +

    Sid

    (1)

    +

    7,

    +

    Sisu

    (31)

    +

    5, 8, 12, 16, 17, 52, 53, 59, 61, 62, 65, 66, 67, 68, 71, 73, 74, 75, 76, 80, 82, 83, 86, 87, 88, 89, 98,

    +

    SiSU

    (11)

    +

    [H]1, [H]2, 7, 13, 25, 30, 32, 38, 51,

    +

    Site

    (1)

    +

    98,

    +

    Software

    (1)

    +

    98,

    +

    Some

    (1)

    +

    71,

    +

    Source

    (9)

    +

    19, 24, 25, 27, 28, 29, 30, 98,

    +

    Sources

    (5)

    +

    7, 9, 10, 13, 14,

    +

    Sqlite

    (4)

    +

    30, 70, 73, 74,

    +

    Src

    (2)

    +

    10, 14,

    +

    Sst

    (5)

    +

    62, 67, 68, 74, 76,

    +

    Standard

    (1)

    +

    32,

    +

    Started

    (1)

    +

    3,

    +

    Stefan

    (2)

    +

    29, 44,

    +

    Step

    (1)

    +

    32,

    +

    Steps

    (1)

    +

    29,

    +

    Stop

    (1)

    +

    30,

    +

    Straightforward

    (1)

    +

    5,

    +

    Structured

    (1)

    +

    [H]1,

    +

    Structuring

    (1)

    +

    [H]1,

    +

    Such

    (2)

    +

    44, 65,

    +

    Support

    (1)

    +

    30,

    +

    Take

    (1)

    +

    30,

    +

    Taken

    (1)

    +

    44,

    +

    Tarball

    (1)

    +

    30,

    +

    Test

    (1)

    +

    44,

    +

    Tested

    (1)

    +

    5,

    +

    Testing

    (2)

    +

    7, 51,

    +

    Tetex

    (2)

    +

    44, 65,

    +

    Texlive

    (1)

    +

    65,

    +

    Text

    (5)

    +

    60, 63, 69,

    +

    That

    (6)

    +

    17, 44, 61, 66, 98,

    +

    The

    (44)

    +

    5, 7, 9, 11, 13, 15, 17, 19, 27, 28, 29, 30, 32, 38, 44, 54, 58, 61, 65, 66, 71, 72, 78, 81, 90, 96, 98,

    +

    Them

    (2)

    +

    98,

    +

    There

    (3)

    +

    5, 13, 30,

    +

    They

    (4)

    +

    13, 19, 20, 98,

    +

    Things

    (1)

    +

    30,

    +

    This

    (3)

    +

    32, 44, 63,

    +

    Though

    (3)

    +

    19, 30, 81,

    +

    Three

    (1)

    +

    32,

    +

    Two

    (1)

    +

    29,

    +

    Type

    (5)

    +

    22, 32, 38, 48, 79,

    +

    Ubuntu

    (1)

    +

    7,

    +

    Units

    (1)

    +

    [H]1,

    +

    Universe

    (1)

    +

    [H]1,

    +

    Unpack

    (2)

    +

    28, 29,

    +

    Unpacked

    (2)

    +

    32, 38,

    +

    Unstable

    (4)

    +

    10, 14,

    +

    Untested

    (1)

    +

    19,

    +

    Update

    (3)

    +

    8, 12, 16,

    +

    Upstream

    (1)

    +

    13,

    +

    Use

    (4)

    +

    [H]1, [H]2, 30, 44,

    +

    Used

    (1)

    +

    17,

    +

    Using

    (3)

    +

    30, 32, 38,

    +

    Usr

    (1)

    +

    59,

    +

    Various

    (3)

    +

    30, 63, 69,

    +

    Version

    (1)

    +

    52,

    +

    Versions

    (1)

    +

    13,

    +

    What

    (1)

    +

    5,

    +

    When

    (1)

    +

    71,

    +

    Which

    (3)

    +

    30, 52,

    +

    While

    (1)

    +

    98,

    +

    Will

    (5)

    +

    13, 17, 30, 63,

    +

    With

    (2)

    +

    65, 94,

    +

    Within

    (2)

    +

    81, 98,

    +

    Works

    (1)

    +

    98,

    +

    Write

    (1)

    +

    71,

    +

    Written

    (1)

    +

    30,

    +

    XHTML

    (2)

    +

    63, 69,

    +

    XML

    (3)

    +

    60, 63, 69,

    +

    XMLs

    (1)

    +

    30,

    +

    You

    (5)

    +

    44, 48, 71, 72,

    +

    Your

    (4)

    +

    7, 13, 54, 98,

    + + + + + + +
    + +
    +

    + + SiSU + +

    +    		 + +

    + Output generated by + + SiSU + + 0.59.0 2007-09-23 (2007w38/0) +
    + + SiSU + + Copyright © Ralph Amissah + 1997, current 2007. + All Rights Reserved. +
    + + SiSU + + is software for document structuring, publishing and search, +
    + + www.jus.uio.no/sisu + + and + + www.sisudoc.org + +
    + w3 since October 3 1993 + + ralph@amissah.com + +

    +    		 +

    + SiSU using: +
    Standard SiSU markup syntax, +
    Standard SiSU meta-markup syntax, and the +
    Standard SiSU object citation numbering and system, (object/text positioning system) +
    + Copyright © Ralph Amissah 1997, current 2007. + All Rights Reserved. +

    +
    +

    + + GPLv3 + +

    +    		 +

    + + SiSU + + is released under + GPLv3 + or later, + <http://www.gnu.org/licenses/gpl.html> +

    +    		 +

    + SiSU, developed using + + Ruby + + on + + Debian/Gnu/Linux + + software infrastructure, + with the usual GPL (or OSS) suspects. +
    + Better - "performance, reliability, scalability, security & total cost of ownership" + [not to mention flexibility & choice] use of and adherence to open standards (where practical and fair) and it is software libre. +
    + Get With the Future + + Way Better! + +

    +
    + \ No newline at end of file diff --git a/data/doc/manuals_generated/sisu_manual/sisu_quickstart/digest.txt b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/digest.txt new file mode 100644 index 00000000..394e6313 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/digest.txt @@ -0,0 +1,203 @@ +SiSU - SiSU information Structuring Universe / Structured information, Serialized Units - Quickstart, installation and use +Ralph Amissah +sisu_quickstart.sst +---------------------------------------------- +SiSU Document Content Certificate (Digest/DCC) +---------------------------------------------- + md5 digests +------------ +Sourcefile digest: 05a047fd659fbbeaa3cdb982b5911bcd + source filename: sisu_quickstart.sst +available outputs: http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/sisu_manifest.html + time generated: Sun Sep 23 04:11:02 +0100 2007 + SiSU version used: SiSU 0.59.0 of 2007w38/0 (2007-09-23) + Ruby version used: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux] +------------ +Document Digest Tree (from dal): +level (if any), ocn: digest clean (no markup/notes), digest all (includes markup & endnotes) + [endnote number] endnote digest clean + + :A - 1 ee61c2b50f6bedc22ec52b726d009ad6 0c7d51f1c4a8ba387a536df8c1169cae + :B - 2 f80354536f6817e5665f333655efd660 3d689e47479989b52e559702c12af662 + 1 - 3 74249e61589a710cd7c5b679067db891 0f8137e404e101a8eb637dbba8a2ee44 + 2 - 4 00c1053bed459d628364e31b788ad44a dd0a1d40be2fc1a723c7849962bb4f1e + - 5 e1cdc3cd31e57fd0ebdc176bfacb889f aeaf7ecbba305c5663c3d0e74ad8a928 + 3 - 6 e4cbf43470164cb064eac87ab7def05a 2e215602c08e978794a31ff8c6e35931 + - 7 44a35db864fb99ad631ec7bd00a81726 d13a69b6ca549b3fbf08c0f1071b8f3c + - 8 519c076307bd658e4a0fdcd6d7c65386 fe3b20caf4b42fbee5e6a1316cc6a599 + - 9 d28ee46ae6dc80a42a02ae82ca244fee a8d5b8398f9633f36f5993d7640571e0 + - 10 887165e3d37c4a41efd19feee029bad6 059d0c4e31695b76464ff02fca7fe013 + - 11 2223c386c6c0d7d805e58c164ce5834e bba11e5953f52f0b7a53abe07a6f21b3 + - 12 dfe24a406b4fd298486542738a9fdc94 4d02487c423c168c10e65a9081124527 + - 13 2acb07c1768c2478fefa7110af2bd467 7248afae346ee3ba389d14c7ecb84c4c + - 14 c65e96cd4c6c739abacfc2e3ec43ad8f a96921f25401e4f4128528dbaad4aa5c + - 15 3579a4cd1a71b56e94f8ba452a186b89 f9b78624cca0b7c12daff57f369c9721 + - 16 dfe24a406b4fd298486542738a9fdc94 b967a385912af364626f7c12432d3d5d + - 17 331a5380a760aa35e2bfcc191bbc4f41 187a84155ee8770c42861ff8be6f2c8d + 3 - 18 7d10cff3e8c44c767506dc1c097a40d7 c9e251f8022004fe753a6bf5f0ce2f80 + - 19 7ae483c113bb69f8488f95577ef32470 f79ea13831f7675f15cab5340e9629ec + - 20 2e78ede4192aff2f64c6b289442e9d8e f55d60912f12e06f80532f752c2360a3 + - 21 b5fb137f552b89d9eefa4937222d0486 597ab6b365d11026515c80c6f7c28282 + - 22 1af1d7ff580dfa40e76fb2d6c0234a2e cdbe91f8d7206390c3d38144065cfb06 + - 23 6f7e85223361ceec49d96d0216143998 458bbff010cc3c2d806dff0a3501a881 + 3 - 24 c45ef51f2e3a2b6c67ff97cd2d8042b4 67c7d701edd755fa9a61ded7a30002f5 + - 25 75081c65d94544f07f29a0ded3163d98 4bd77d47727b8f241ca5356caa024e08 + - 26 da7564dc4d25add6b36fa47fb74ea863 f9495e4252d1807dc28c5f74f9eb018f + - 27 951d2e736f86a04189c13441badf2bb2 34222c7a2ac19a630b8d65924e0913e7 + - 28 e9f988c418cb50b473627971e672b060 4146bb9cee1af476b5d374c44609d5ae + - 29 ae8d73e01517d67df1a379b782d4ef1a 866babadc478feeb68a109ff145824cf + - 30 36e83878c7c27fd1f46798dd9793a284 a69bc25e5d29a2a322f2b35e451d741f + [1] 420aeccd79f61a3113c18bf0ae57bfe8 + - 31 821ee3ad9f092530ce4c1223ef81ed94 adbe57e574e221c2768873c68be2816f + - 32 e12bd7a3ccba92b18cdee5999df66fcd 6adfff40b4967b30f25726f101fdfc58 + - 33 fc6b11835200ea60a8cf2acfe76937e3 7466a462a0ae22a243cd0353355a5ce8 + - 34 47cbed4d02773f2f111369411c2fd8bf 7d1f4b92cd61893d0d10fe3706375138 + - 35 5ac11cf3a9f220bd6261166b2a1c2b81 3e8741b8108b5f4ef5e8c3a028bbafec + - 36 58114bbd2a359489db7845c1e44b9d70 187df094e9ddd875aae790308785cd9c + - 37 64c129b5e494ac592634b7948482a4d1 b33479ad27612c16b2f12e68ce1a2501 + - 38 0d5bfd397ad567182adc79df96dce39e 73cd729e0b723fae1dbf13b8b4676168 + - 39 ff35d81ef427c061c9fdabedc540f1b3 14030343f0be846a0d63843aa82d6594 + - 40 f1c2c14dc4c28544e29194d6d3425c4d 2a68247475adee0eae3468c13d05ca7c + - 41 0270801856710e50b80a9eb070598f7e 89bdbfd1452ef8afc15964dae40bf773 + - 42 e81c4e4f2b7b93b481e13a8553c2ae1b a0c3f0904569d2cfee53f618e5a5cecb + - 43 ff35d81ef427c061c9fdabedc540f1b3 e9dc274f09e4813d3841fe09e0d33f52 + - 44 b6741b0a0351bb30cace4a3e4cc4a65c cb3eb7d466bb2cf75cc9d9335a932f68 + - 45 1a9857c4940aa8e365350794db813e3e 7bdcc9e446ff8f4ed60fb7acb012851e + - 46 7d15442b7632758d7c2f7d96ad9bfde1 65ecdc1b68de1cd7abce5a61fc860a11 + - 47 cf45229a9de7a36ba7aafdebacfe2b94 55d6c1d5d8fad7f1f6750ceb413caab5 + - 48 23a77a04904e3b36921387795bce28ef ed495a39d0629e52ebea38b58395f867 + - 49 c68b715231a0317921d82836f29a0493 f0423557a23a69ba04d37894e25a8677 + - 50 c0f7e06fab57955232723f1edcf25aa0 e8dab6183c6de00db701a66e14fdddcc + 2 - 51 d3d84270dfb9780ec3832be432a4da44 974f87b722b4755a4204de96658d49b2 + - 52 4443b90b362a766867492ee5c5e1963e 2ede96273da4c5e8447e4d7ee12240b5 + - 53 bc2a6915a8a9c999636e2b9d35bd88ef d77ff67179dec1dbe46ff3422f7636af + - 54 51d58158484cc3d6a48a2ed6d469463c 253b995fb4389976926a508af8a765c5 + - 55 2f43b42fd833d1e77420a8dae7419000 de493fadb159af155214cc69c0e48f43 + - 56 e81c4e4f2b7b93b481e13a8553c2ae1b bc79262b4a0795a7fe5c8f0792fd34c7 + - 57 2f43b42fd833d1e77420a8dae7419000 45e2d5e1f4455ea4d613e58de129fdf6 + - 58 46b96b716e1abe029ee37b22ce0a6062 db51d868482b2603fef09f69eab9a631 + - 59 9581cdddcc2c1a747392b2909f612cfb 946fa85bd02c412eb36661d4f87a7b75 + 3 - 60 3fefd536518ab30e5350c4a8375c73b2 e5ba358c32beb0524981d7bc788008b0 + - 61 bb11fc36611e1f498e01b243c17941bb 7d82fe76b988462c94451183028ddea7 + - 62 2cb77b14d3b7442ae3b048ec3a72552a 09c851b314112e165a87ca81a0eef216 + - 63 f03e4bf669c4877342538b417b19bb76 750636fd2689feef39a65b08425feda3 + 3 - 64 f02eb999159899101682944dc8771e8c 78cf80ccedb7f26a6ac70245dce13f48 + - 65 a2637fbe301bc0726e2ec2faf29e391d 5282825b158a61cc4f4e060ddab4be72 + - 66 bb11fc36611e1f498e01b243c17941bb d5c1edf8186a7f48d61b9e4388fe6c13 + - 67 22814c09a9f2fe1fb656badecd5476eb 8fc075baa429f42e1fa07387a34bc5d6 + - 68 b07a4b8ff3ff27063be6b5028be55fff cedb0c46b789d4a41effa360f11a60f5 + - 69 2717da9e5b60c462ca7210c7cda34ff7 4b6164242436d63d5bb2d48a5bfa2111 + 3 - 70 0ecea839de61813b8f6f23a6f55db43f 000d0b23f6c05500670a1478b943fe2f + - 71 bac4dda0af18ea2852f5e406ea6c3b47 e0071a015a6e2baac8c5d3fd97d13e0c + - 72 0328506ca4afca1db2c127eb7053a095 6dd9bc059f5204eceb446acc53c17d73 + - 73 4b1f206a73b6fb51b91bab89601f474d 628a6d7a54b6d49222df050bac23aeff + - 74 c4df1eff46fc0b3296c326f37ae5d469 324db4a18d5fad4f37fd54c2d1bba5e0 + - 75 4e828ea31dbd9603d50945e924076f19 4f177ffb8971331cf39b1c6a78e7d8fa + - 76 883a86b6110623b969701f7546d783a0 dad5b111f734429eb9f021bf55251ba9 + 2 - 77 2f7f321ec01871e94a8c32c7f68681b5 a68f6d4a5fd95b36c523d029e5f8e5fe + 3 - 78 ab6b845c411ea04afbeec5970c589916 869d40796daf55c835bdc9c1525d7450 + - 79 e659b52eba1f0299b2d8ca3483919e72 90ad09c4e6831946dd5b1c488d4c267a + - 80 4344ca6323deda7f850d499e0e1575b0 4d7902554bac676bafb86a5cfa5bf3ba + - 81 fe72331ae5d8825475e24c5833b603c5 e62efdc8ca696f5fd15a7a58bcc3e336 + - 82 69db967c6daa26a1ca59219582725e5c 1f191b836009b67090b3ba2fa8133c66 + [2] f7fa7cd1ad3e527ba2821d8a9c58857f + - 83 3f031392abb0055195af3b2392fe8c4f 62c3bb59deb574ab03dfd6239c1746b9 + [3] 5a3cbd55fa1db9fb4a2c648f5f4743a6 + - 84 4be3942dba9319fac84c48385fd70deb a731325f8b6e9a1990b970806f6d20d9 + [4] 89819e21326d36527caf79f166956d4a + 3 - 85 3eb0472ee8b07e77bf5255f2d5e70c15 073cb9c394c3c927039198f0ecffb6be + - 86 ffb549d4e9bcb03d96ec982b1310fed3 afaf2f4ac569b13e3516403747cfd028 + - 87 ea0837b713363efd0280dbed88635d5d 327ea25edc98e1ab7e996ff8b809d71d + - 88 296f8e7a912617db1f990b8f574d0e03 18402454a1fa336df9ff78b932433caf + - 89 6b4516bcdfc5c14622b0e8e162a5c94f 140e05a232b7622c80ce5311a8551c9b + 3 - 90 06d2e957070a7699a02be329c8e1142f bd689f8f75f8afe655dae7dc9ce02a0a + - 91 586b179b53a0fe074bf210a4a84a87ef a00a1bdffdc59fb8164c22a2d72232ab + - 92 61eee52ba3e80af5ad809b18560febd5 a6f4d6d0e17304347b2478971bb091bb + 2 - 93 e623a5c31de2c01b9bfaebdbb51a4708 64d3f3555160c8104140604c64cae76f + - 94 0579f6a3a6163d9a892db36cee3e53b2 212dab4ed9e24eb14ebebd2ccaf4b6b7 + - 95 e75688770a97326285ee2dc68c94c817 06292ac402e66ccad13f3966336ae013 + - 96 398a944fbed3cf12cdd64dade51fbaf0 85cf5deca4d71ce96d9a8070d86ac5bb + - 97 3389dae361af79b04c9c8e7057f60cc6 16b43c50922c5e29f6aa7159913b4398 + - 98 e585163a9b292521b13c57a14d0c5816 70a5a332e635fdbaef96ee12694f15a8 + [5] 4a5af48cf96f4686f492ceae9e2d6992 + 1 - 0 cc4947558ec26d67c755c76262f85131 c7a5392e3bd6d769d940d79b19a68e4c + :A - 0 5b23a6f796c80555992b9b68cfdbc2bb 5fbbfb7933004e25553d56929ed7e545 + 1 - 0 ce21470ab49d1d1976bc3dc72438c183 f2709633c4c07e46bf6aeef624e8a736 + - 0 42c63e3643536e7c9c785144fedd7bf5 dc0387ec9f623a8261296c515ed5e70a + + - 0 3bca2a5af45d3d764dd73c03690cd66e ac56056f12b17cdaf50a68e61c70c01e + + - 0 ebd0aa03a5f7fa6f0e2d38b9676fb155 6f43d92a036c9944794c8582322b5875 + +dc title - 0 a542eda0c8d93b5704b230abc799a9d1 bfb854b7900de7c9d0d6c5be4a6acb35 + +dc creator - 0 0679b0c2bbba4dc8a8eea763236c903f e64313bcf0600cea90bc0935c74877cc + +dc rights - 0 0e230d9710d8294315f77233e2b11ef9 94f3688a12e01bb32bff91cf018e0aae + +dc type - 0 7ff1b8f5fc0daaa20ab922214e3a045c ff73c0e3a5d9de30b22e26cd2ad33690 + +dc date created - 0 2ad9d8750091fa63ff5c1acc50d49dda 14d54761028e880531d324ad2200847a + +dc date available - 0 ab83341a16a4931c6a2680915caceccd 71a58c5023d33383fa5b721e51c7e20e + +dc date issued - 0 752135ec36eb8d6c4a15a0bcd5fcae47 0cfacd1166506a462a7b0e05e5993ee2 + +dc date modified - 0 d325bb430d51f592e18ecd88b488cf97 0140c70c106aab09eb65289d8332dec0 + +dc date - 0 c8d7d2f3fe839d8e3a4f8f0abb18e8b1 0e048ac65f0bf92fba616933ffe7acbe + + - 0 9d11e23779d9604067dd20e359117573 3f883fb08147a237efaeb152bfaaa1ee + +sourcefile - 0 7199ebee51f065de3a3339c8fe53864d 647e32f48b7dc1b2ce01fc3b66115346 + + - 0 794ce8cc422272c64a3d3821caf6c214 f2b54639d1bf563e60268bc3eb417571 + + - 0 544e58889d38acfb026f13a84df2c534 0b87fab8fee16db4a4446060918472cd + source 05a047fd659fbbeaa3cdb982b5911bcd sisu_quickstart.sst + + - 0 b57a2a5f0948b054d5b755c5b93cbdd6 94dcd9e8be6ede945e89ef2ae152fa9a + skin 20fc43cf3eb6590bc3399a1aef65c5a9 skin_sisu_manual.rb + + - 0 5c5f06440fcb85cd5c8cfafe32e34b78 d8f5595da03dd0c38d62b56492f5eb0f + +document (metaverse) last generated - 0 df0c63d4ce769b67c1481d18719f68d0 33bf24323f861f0e77e4423ed05701e6 + +generated by - 0 96f99dc6b8b2209e22e49bcdbb9e0497 1533ff37a88b9cb74747383c1a8b8598 + +ruby version - 0 37cf2ede6f4722230340c84e2753e412 4ccb32a8ff87fa8b6600884d16e2d685 +------------ +document structure[*] +:A + :B + 1 + 2 + 3 + 3 + 3 + 2 + 3 + 3 + 3 + 2 + 3 + 3 + 3 + 2 + 1 +:A + 1 + [*] heading levels +------------ +document structure[*] +@ = 15 +:A = 2 +:B = 1 +1 = 3 +2 = 4 +3 = 9 +objects (ocn) = 98 +endnotes = 5 + [*] number of headers (@) and of each heading level (:A to :C and 1 to 3) +------------ +Note: the time generated related fields (text and digests) will vary between otherwise identical document outputs diff --git a/data/doc/manuals_generated/sisu_manual/sisu_quickstart/doc.html b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/doc.html new file mode 100644 index 00000000..a2bc6978 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/doc.html @@ -0,0 +1,2129 @@ + + + + + + SiSU - SiSU information Structuring Universe / Structured information, Serialized Units + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + +
    + +
    SiSU -->
    +    		 + + + + + + + + + + + + + + + +
    + + Full Text  scroll  + + + + + TOC linked  toc  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
    +    		 +   +
    +

    + +

    + +
    + + +
    + +

    SiSU - SiSU information Structuring Universe / Structured information, Serialized Units +

    + +

    Quickstart, installation and use +

    + +

    Ralph Amissah +

    + +copy @ + + SiSU + + +
    + + + +

    Copyright ©  Ralph Amissah 2007, part of SiSU documentation, License GPL 3

    +

    + +
    + +

    + SiSU - SiSU information Structuring Universe / Structured information, Serialized Units - Quickstart, installation and use,
    Ralph Amissah     +

    + +

    + Quickstart - SiSU installation and use +

    + +

    + 1. Quickstart - Getting Started Howto +

    + +
    + 1.1 Installation +
    + +
    + 1.1.1 Debian Installation +
    + +
    + 1.1.2 RPM Installation +
    + +
    + 1.1.3 Installation from source +
    + +
    + 1.2 Testing SiSU, generating output +
    + +
    + 1.2.1 basic text, plaintext, html, XML, ODF +
    + +
    + 1.2.2 LaTeX / pdf +
    + +
    + 1.2.3 relational database - postgresql, sqlite +
    + +
    + 1.3 Getting Help +
    + +
    + 1.3.1 The man pages +
    + +
    + 1.3.2 Built in help +
    + +
    + 1.3.3 The home page +
    + +
    + 1.4 Markup Samples +
    + +

    + +

    + +

    + Document Information (metadata) +

    + + + + +
    +

    + + SiSU - SiSU information Structuring Universe / Structured information, Serialized Units - Quickstart, installation and use,
    Ralph Amissah +

    +    		 +

    +   1 +

    +
    + + + + +
    +

    + + Quickstart - SiSU installation and use +

    +    		 +

    +   2 +

    +
    + + + + +
    +

    + + 1. Quickstart - Getting Started Howto +

    +    		 +

    +   3 +

    +
    + + + + +
    +
    + + 1.1 Installation +
    +    		 +

    +   4 +

    +
    + + + + +
    +

    + Installation is currently most straightforward and tested on the Debian platform, as there are packages for the installation of sisu and all requirements for what it does. +

    +    		 +

    +   5 +

    +
    + + + + +
    +
    + + 1.1.1 Debian Installation +
    +    		 +

    +   6 +

    +
    + + + + +
    +

    + SiSU is available directly from the Debian Sid and testing archives (and possibly Ubuntu), assuming your /etc/apt/sources.list is set accordingly: +

    +    		 +

    +   7 +

    +
    + + + + +
    +

    + +    aptitude update
    +    aptitude install sisu-complete + +

    +    		 +

    +   8 +

    +
    + + + + +
    +

    + The following /etc/apt/sources.list setting permits the download of additional markup samples: +

    +    		 +

    +   9 +

    +
    + + + + +
    +

    + +  #/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 + +

    +    		 +

    +   10 +

    +
    + + + + +
    +

    + The aptitude commands become: +

    +    		 +

    +   11 +

    +
    + + + + +
    +

    + +    aptitude update
    +    aptitude install sisu-complete sisu-markup-samples + +

    +    		 +

    +   12 +

    +
    + + + + +
    +

    + If there are newer versions of SiSU upstream of the Debian archives, they will be available by adding the following to your /etc/apt/sources.list +

    +    		 +

    +   13 +

    +
    + + + + +
    +

    + +  #/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 + +

    +    		 +

    +   14 +

    +
    + + + + +
    +

    + repeat the aptitude commands +

    +    		 +

    +   15 +

    +
    + + + + +
    +

    + +    aptitude update
    +    aptitude install sisu-complete sisu-markup-samples + +

    +    		 +

    +   16 +

    +
    + + + + +
    +

    + 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. +

    +    		 +

    +   17 +

    +
    + + + + +
    +
    + + 1.1.2 RPM Installation +
    +    		 +

    +   18 +

    +
    + + + + +
    +

    + RPMs are provided though untested, they are prepared by running alien against the source package, and against the debs. +

    +    		 +

    +   19 +

    +
    + + + + +
    +

    + They may be downloaded from: +

    +    		 +

    +   20 +

    +
    + + + + +
    +

    + <http://www.jus.uio.no/sisu/SiSU/download.html#rpm> +

    +    		 +

    +   21 +

    +
    + + + + +
    +

    + as root type: +

    +    		 +

    +   22 +

    +
    + + + + +
    +

    + rpm -i [rpm package name] +

    +    		 +

    +   23 +

    +
    + + + + +
    +
    + + 1.1.3 Installation from source +
    +    		 +

    +   24 +

    +
    + + + + +
    +

    + To install SiSU from source check information at: +

    +    		 +

    +   25 +

    +
    + + + + +
    +

    + <http://www.jus.uio.no/sisu/SiSU/download.html#current> +

    +    		 +

    +   26 +

    +
    + + + + +
    +
  • + download the source package +
    • +    		 +

    +   27 +

    +
    + + + + +
    +
  • + Unpack the source +
    • +    		 +

    +   28 +

    +
    + + + + +
    +

    + 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: +

    +    		 +

    +   29 +

    +
    + + + + +
    +

    + For basic use SiSU is only dependent on the programming language in which it is written Ruby, and SiSU will be able to generate html, various XMLs, including ODF (and will also produce LaTeX). Dependencies required for further actions, though it relies on the installation of additional dependencies which the source tarball does not take care of, for things like using a database (postgresql or sqlite)  1  or converting LaTeX to pdf. +

    +    		 +

    +   30 +

    +
    + + + + +
    +

    + setup.rb +

    +    		 +

    +   31 +

    +
    + + + + +
    +

    + This is a standard ruby installer, using setup.rb is a three step process. In the root directory of the unpacked SiSU as root type: +

    +    		 +

    +   32 +

    +
    + + + + +
    +

    + +      ruby setup.rb config
    +      ruby setup.rb setup
    +      #[and as root:]
    +      ruby setup.rb install + +

    +    		 +

    +   33 +

    +
    + + + + +
    +

    + further information on setup.rb is available from: +

    +    		 +

    +   34 +

    +
    + + + + +
    +

    + <http://i.loveruby.net/en/projects/setup/> +

    +    		 +

    +   35 +

    +
    + + + + +
    +

    + <http://i.loveruby.net/en/projects/setup/doc/usage.html> +

    +    		 +

    +   36 +

    +
    + + + + +
    +

    + "install" +

    +    		 +

    +   37 +

    +
    + + + + +
    +

    + The "install" file provided is an installer prepared using "rant". In the root directory of the unpacked SiSU as root type: +

    +    		 +

    +   38 +

    +
    + + + + +
    +

    + ruby install base +

    +    		 +

    +   39 +

    +
    + + + + +
    +

    + or for a more complete installation: +

    +    		 +

    +   40 +

    +
    + + + + +
    +

    + ruby install +

    +    		 +

    +   41 +

    +
    + + + + +
    +

    + or +

    +    		 +

    +   42 +

    +
    + + + + +
    +

    + ruby install base +

    +    		 +

    +   43 +

    +
    + + + + +
    +

    + 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. +

    +    		 +

    +   44 +

    +
    + + + + +
    +

    + Further information on "rant" is available from: +

    +    		 +

    +   45 +

    +
    + + + + +
    +

    + <http://make.rubyforge.org/> +

    +    		 +

    +   46 +

    +
    + + + + +
    +

    + <http://rubyforge.org/frs/?group_id=615> +

    +    		 +

    +   47 +

    +
    + + + + +
    +

    + For a list of alternative actions you may type: +

    +    		 +

    +   48 +

    +
    + + + + +
    +

    + ruby install help +

    +    		 +

    +   49 +

    +
    + + + + +
    +

    + ruby install -T +

    +    		 +

    +   50 +

    +
    + + + + +
    +
    + + 1.2 Testing SiSU, generating output +
    +    		 +

    +   51 +

    +
    + + + + +
    +

    + To check which version of sisu is installed: +

    +    		 +

    +   52 +

    +
    + + + + +
    +

    + sisu -v +

    +    		 +

    +   53 +

    +
    + + + + +
    +

    + Depending on your mode of installation one or a number of markup sample files may be found either in the directory: +

    +    		 +

    +   54 +

    +
    + + + + +
    +

    + ... +

    +    		 +

    +   55 +

    +
    + + + + +
    +

    + or +

    +    		 +

    +   56 +

    +
    + + + + +
    +

    + ... +

    +    		 +

    +   57 +

    +
    + + + + +
    +

    + change directory to the appropriate one: +

    +    		 +

    +   58 +

    +
    + + + + +
    +

    + cd /usr/share/doc/sisu/sisu_markup_samples/dfsg +

    +    		 +

    +   59 +

    +
    + + + + +
    +
    + + 1.2.1 basic text, plaintext, html, XML, ODF +
    +    		 +

    +   60 +

    +
    + + + + +
    +

    + Having moved to the directory that contains the markup samples (see instructions above if necessary), choose a file and run sisu against it +

    +    		 +

    +   61 +

    +
    + + + + +
    +

    + sisu -NhwoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst +

    +    		 +

    +   62 +

    +
    + + + + +
    +

    + this will generate html including a concordance file, opendocument text format, plaintext, XHTML and various forms of XML, and OpenDocument text +

    +    		 +

    +   63 +

    +
    + + + + +
    +
    + + 1.2.2 LaTeX / pdf +
    +    		 +

    +   64 +

    +
    + + + + +
    +

    + Assuming a LaTeX engine such as tetex or texlive is installed with the required modules (done automatically on selection of sisu-pdf in Debian) +

    +    		 +

    +   65 +

    +
    + + + + +
    +

    + Having moved to the directory that contains the markup samples (see instructions above if necessary), choose a file and run sisu against it +

    +    		 +

    +   66 +

    +
    + + + + +
    +

    + sisu -pv free_as_in_freedom.rms_and_free_software.sam_williams.sst +

    +    		 +

    +   67 +

    +
    + + + + +
    +

    + sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst +

    +    		 +

    +   68 +

    +
    + + + + +
    +

    + should generate most available output formats: html including a concordance file, opendocument text format, plaintext, XHTML and various forms of XML, and OpenDocument text and pdf +

    +    		 +

    +   69 +

    +
    + + + + +
    +
    + + 1.2.3 relational database - postgresql, sqlite +
    +    		 +

    +   70 +

    +
    + + + + +
    +

    + Relational databases need some setting up - you must have permission to create the database and write to it when you run sisu. +

    +    		 +

    +   71 +

    +
    + + + + +
    +

    + Assuming you have the database installed and the requisite permissions +

    +    		 +

    +   72 +

    +
    + + + + +
    +

    + sisu --sqlite --recreate +

    +    		 +

    +   73 +

    +
    + + + + +
    +

    + sisu --sqlite -v --import free_as_in_freedom.rms_and_free_software.sam_williams.sst +

    +    		 +

    +   74 +

    +
    + + + + +
    +

    + sisu --pgsql --recreate +

    +    		 +

    +   75 +

    +
    + + + + +
    +

    + sisu --pgsql -v --import free_as_in_freedom.rms_and_free_software.sam_williams.sst +

    +    		 +

    +   76 +

    +
    + + + + +
    +
    + + 1.3 Getting Help +
    +    		 +

    +   77 +

    +
    + + + + +
    +
    + + 1.3.1 The man pages +
    +    		 +

    +   78 +

    +
    + + + + +
    +

    + Type: +

    +    		 +

    +   79 +

    +
    + + + + +
    +

    + man sisu +

    +    		 +

    +   80 +

    +
    + + + + +
    +

    + The man pages are also available online, though not always kept as up to date as within the package itself: +

    +    		 +

    +   81 +

    +
    + + + + +
    +
  • + sisu.1   2  +
    • +    		 +

    +   82 +

    +
    + + + + +
    +
  • + sisu.8   3  +
    • +    		 +

    +   83 +

    +
    + + + + +
    +
  • + man directory   4  +
    • +    		 +

    +   84 +

    +
    + + + + +
    +
    + + 1.3.2 Built in help +
    +    		 +

    +   85 +

    +
    + + + + +
    +

    + sisu --help +

    +    		 +

    +   86 +

    +
    + + + + +
    +

    + sisu --help --env +

    +    		 +

    +   87 +

    +
    + + + + +
    +

    + sisu --help --commands +

    +    		 +

    +   88 +

    +
    + + + + +
    +

    + sisu --help --markup +

    +    		 +

    +   89 +

    +
    + + + + +
    +
    + + 1.3.3 The home page +
    +    		 +

    +   90 +

    +
    + + + + +
    +

    + <http://www.jus.uio.no/sisu> +

    +    		 +

    +   91 +

    +
    + + + + +
    +

    + <http://www.jus.uio.no/sisu/SiSU> +

    +    		 +

    +   92 +

    +
    + + + + +
    +
    + + 1.4 Markup Samples +
    +    		 +

    +   93 +

    +
    + + + + +
    +

    + A number of markup samples (along with output) are available off: +

    +    		 +

    +   94 +

    +
    + + + + +
    +

    + <http://www.jus.uio.no/sisu/SiSU/2.html> +

    +    		 +

    +   95 +

    +
    + + + + +
    +

    + Additional markup samples are packaged separately in the file: +

    +    		 +

    +   96 +

    +
    + + + + +
    +

    + * +

    +    		 +

    +   97 +

    +
    + + + + +
    +

    + On Debian 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. +

    +    		 +

    +   98 +

    +
    + + + + +
    +

    + + Endnotes +

    +    		 +

    +   0 +

    +
    + + + +
    + +

    +

    +

    		 +   +
    + + + + +
    +

    +  1. There is nothing to stop MySQL support being added in future. +

    +    		 +   +
    + + + + +
    +

    +  2. <http://www.jus.uio.no/sisu/man/sisu.1> +

    +    		 +   +
    + + + + +
    +

    +  3. <http://www.jus.uio.no/sisu/man/sisu.8> +

    +    		 +   +
    + + + + +
    +

    +  4. <http://www.jus.uio.no/sisu/man> +

    +    		 +   +
    + + + + +
    +

    +  5. the Debian Free Software guidelines require that everything distributed within Debian can be changed - and the documents are authors' works that while freely distributable are not freely changeable. +

    +    		 +   +
    + + + + +
    +

    + + Document Information (metadata) +

    +    		 +

    +   0 +

    +
    + +

    + Metadata +

    + + +     + + + + + +
    +

    + <http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/sisu_manifest.html> +

    		 +
    + + + +
    +

    + Dublin Core (DC) +

    		 +
    + + + +
    +

    + DC tags included with this document are provided here. +

    		 +
    + + + +
    +

    + DC Title: SiSU - SiSU information Structuring Universe / Structured information, Serialized Units - Quickstart, installation and use +

    		 +
    + + + +
    +

    + DC Creator: Ralph Amissah +

    		 +
    + + + +
    +

    + DC Rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +

    		 +
    + + + +
    +

    + DC Type: information +

    		 +
    + + + +
    +

    + DC Date created: 2006-09-06 +

    		 +
    + + + +
    +

    + DC Date available: 2006-09-06 +

    		 +
    + + + +
    +

    + DC Date issued: 2006-09-06 +

    		 +
    + + + +
    +

    + DC Date modified: 2007-09-16 +

    		 +
    + + + +
    +

    + DC Date: 2007-09-16 +

    		 +
    + + + +
    +

    + Version Information +

    		 +
    + + + +
    +

    + Sourcefile: sisu_quickstart.sst +

    		 +
    + + + +
    +

    + Filetype: SiSU text 0.57 +

    		 +
    + + + +
    +

    + Sourcefile Digest, MD5(sisu_quickstart.sst)= 05a047fd659fbbeaa3cdb982b5911bcd +

    		 +
    + + + +
    +

    + 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)= 20fc43cf3eb6590bc3399a1aef65c5a9 +

    		 +
    + + + +
    +

    + Generated +

    		 +
    + + + +
    +

    + Document (metaverse) last generated: Sun Sep 23 04:11:02 +0100 2007 +

    		 +
    + + + +
    +

    + Generated by: SiSU 0.59.0 of 2007w38/0 (2007-09-23) +

    		 +
    + + + +
    +

    + Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux] +

    		 +
    + + + + + +
    + +
    SiSU -->
    +    		 + + + + + + + + + + + + + + + +
    + + Full Text  scroll  + + + + + TOC linked  toc  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
    +    		 +   +
    +

    + + + + + + + + +
    + +
    +

    + + SiSU + +

    +    		 + +

    + Output generated by + + SiSU + + 0.59.0 2007-09-23 (2007w38/0) +
    + + SiSU + + Copyright © Ralph Amissah + 1997, current 2007. + All Rights Reserved. +
    + + SiSU + + is software for document structuring, publishing and search, +
    + + www.jus.uio.no/sisu + + and + + www.sisudoc.org + +
    + w3 since October 3 1993 + + ralph@amissah.com + +

    +    		 +

    + SiSU using: +
    Standard SiSU markup syntax, +
    Standard SiSU meta-markup syntax, and the +
    Standard SiSU object citation numbering and system, (object/text positioning system) +
    + Copyright © Ralph Amissah 1997, current 2007. + All Rights Reserved. +

    +
    +

    + + GPLv3 + +

    +    		 +

    + + SiSU + + is released under + GPLv3 + or later, + <http://www.gnu.org/licenses/gpl.html> +

    +    		 +

    + SiSU, developed using + + Ruby + + on + + Debian/Gnu/Linux + + software infrastructure, + with the usual GPL (or OSS) suspects. +
    + Better - "performance, reliability, scalability, security & total cost of ownership" + [not to mention flexibility & choice] use of and adherence to open standards (where practical and fair) and it is software libre. +
    + Get With the Future + + Way Better! + +

    +
    + + + + + + + +

    + +
    +
    + + +
    + + +
    + + + + idx + txt + + +
    +
    + +
    +

    + + +SiSU manual + +

    + + + + +

    SiSU introduction

    +

    SiSU commands

    +

    SiSU markup

    +

    SiSU configuration

    +

    SiSU help

    +

    SiSU help sources

    + +
    +

    + + +SiSU + +

    + + + + +

    What does SiSU do? Summary

    +

    SiSU Book Samples and Markup Examples

    +

    Markup

    +

    Commands

    +

    Manual

    +

    SiSU Download

    +

    SiSU Changelog

    +

    Wikipedia entry

    +

    Freshmeat

    +

    Ruby Application Archive

    + + +
    + + + + diff --git a/data/doc/manuals_generated/sisu_manual/sisu_quickstart/dom.xml b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/dom.xml new file mode 100644 index 00000000..92d72984 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/dom.xml @@ -0,0 +1,1267 @@ + + + + + + + + +
    + Title: + + SiSU - SiSU information Structuring Universe / Structured information, Serialized Units - Quickstart, installation and use + +
    + +
    + Creator: + + Ralph Amissah + +
    + +
    + Rights: + + Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +
    + +
    + Type: + + information + +
    + +
    + Subject: + + ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +
    + +
    + Date created: + + 2006-09-06 + +
    + +
    + Date available: + + 2006-09-06 + +
    + +
    + Date issued: + + 2006-09-06 + +
    + +
    + Date modified: + + 2007-09-16 + +
    + +
    + Date: + + 2007-09-16 + +
    + + + + + + + + + + + + + + 1 + SiSU - SiSU information Structuring Universe / Structured information, Serialized Units - Quickstart, installation and use,
    Ralph Amissah     +     +     + + + + + 2 + Quickstart - SiSU installation and use + + + + + + + 3 + 1 + + 1. Quickstart - Getting Started Howto + + + + + + + + + + 4 + 1.1 + + 1.1 Installation + + + + + + + + 5 + + + Installation is currently most straightforward and tested on the Debian platform, as there are packages for the installation of sisu and all requirements for what it does. + + + + + + + + + + 6 + 1.1.1 + + 1.1.1 Debian Installation + + + + + + + + 7 + + + SiSU is available directly from the Debian Sid and testing archives (and possibly Ubuntu), assuming your /etc/apt/sources.list is set accordingly: + + + + + + + + 8 + + + + +        aptitude update
           aptitude install sisu-complete     + +     + +     + + + + + + 9 + + + The following /etc/apt/sources.list setting permits the download of additional markup samples: + + + + + + + + 10 + + + + +      #/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     + +     + +     + + + + + + 11 + + + The aptitude commands become: + + + + + + + + 12 + + + + +        aptitude update
           aptitude install sisu-complete sisu-markup-samples     + +     + +     + + + + + + 13 + + + If there are newer versions of SiSU upstream of the Debian archives, they will be available by adding the following to your /etc/apt/sources.list + + + + + + + + 14 + + + + +      #/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     + +     + +     + + + + + + 15 + + + repeat the aptitude commands + + + + + + + + 16 + + + + +        aptitude update
           aptitude install sisu-complete sisu-markup-samples     + +     + +     + + + + + + 17 + + + 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. + + + + +     + +     + + + + + 18 + 1.1.2 + + 1.1.2 RPM Installation + + + + + + + + 19 + + + RPMs are provided though untested, they are prepared by running alien against the source package, and against the debs. + + + + + + + + 20 + + + They may be downloaded from: + + + + + + + + 21 + + + <http://www.jus.uio.no/sisu/SiSU/download.html#rpm> + + + + + + + + 22 + + + as root type: + + + + + + + + 23 + + + rpm -i [rpm package name] + + + + + + + + + + + + 24 + 1.1.3 + + 1.1.3 Installation from source + + + + + + + + 25 + + + To install SiSU from source check information at: + + + + + + + + 26 + + + <http://www.jus.uio.no/sisu/SiSU/download.html#current> + + + + + + + + 27 + + + download the source package + + + + + + + + 28 + + + Unpack the source + + + + + + + + 29 + + + 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: + + + + + + + + 30 + + + For basic use SiSU is only dependent on the programming language in which it is written Ruby, and SiSU will be able to generate html, various XMLs, including ODF (and will also produce LaTeX). Dependencies required for further actions, though it relies on the installation of additional dependencies which the source tarball does not take care of, for things like using a database (postgresql or sqlite)1There is nothing to stop MySQL support being added in future. or converting LaTeX to pdf. + + + + + + + + 31 + + + setup.rb + + + + + + + + 32 + + + This is a standard ruby installer, using setup.rb is a three step process. In the root directory of the unpacked SiSU as root type: + + + + + + + + 33 + + + + +          ruby setup.rb config
             ruby setup.rb setup
             #[and as root:]
             ruby setup.rb install     + +     + +     + + + + + + 34 + + + further information on setup.rb is available from: + + + + + + + + 35 + + + <http://i.loveruby.net/en/projects/setup/> + + + + + + + + 36 + + + <http://i.loveruby.net/en/projects/setup/doc/usage.html> + + + + + + + + 37 + + + "install" + + + + + + + + 38 + + + The "install" file provided is an installer prepared using "rant". In the root directory of the unpacked SiSU as root type: + + + + + + + + 39 + + + ruby install base + + + + + + + + 40 + + + or for a more complete installation: + + + + + + + + 41 + + + ruby install + + + + + + + + 42 + + + or + + + + + + + + 43 + + + ruby install base + + + + + + + + 44 + + + 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. + + + + + + + + 45 + + + Further information on "rant" is available from: + + + + + + + + 46 + + + <http://make.rubyforge.org/> + + + + + + + + 47 + + + <http://rubyforge.org/frs/?group_id=615> + + + + + + + + 48 + + + For a list of alternative actions you may type: + + + + + + + + 49 + + + ruby install help + + + + + + + + 50 + + + ruby install -T + + + + +     + +     + +     + + + + + 51 + 1.2 + + 1.2 Testing SiSU, generating output + + + + + + + + 52 + + + To check which version of sisu is installed: + + + + + + + + 53 + + + sisu -v + + + + + + + + 54 + + + Depending on your mode of installation one or a number of markup sample files may be found either in the directory: + + + + + + + + 55 + + + ... + + + + + + + + 56 + + + or + + + + + + + + 57 + + + ... + + + + + + + + 58 + + + change directory to the appropriate one: + + + + + + + + 59 + + + cd /usr/share/doc/sisu/sisu_markup_samples/dfsg + + + + + + + + + + 60 + 1.2.1 + + 1.2.1 basic text, plaintext, html, XML, ODF + + + + + + + + 61 + + + Having moved to the directory that contains the markup samples (see instructions above if necessary), choose a file and run sisu against it + + + + + + + + 62 + + + sisu -NhwoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst + + + + + + + + 63 + + + this will generate html including a concordance file, opendocument text format, plaintext, XHTML and various forms of XML, and OpenDocument text + + + + + + + + + + + + 64 + 1.2.2 + + 1.2.2 LaTeX / pdf + + + + + + + + 65 + + + Assuming a LaTeX engine such as tetex or texlive is installed with the required modules (done automatically on selection of sisu-pdf in Debian) + + + + + + + + 66 + + + Having moved to the directory that contains the markup samples (see instructions above if necessary), choose a file and run sisu against it + + + + + + + + 67 + + + sisu -pv free_as_in_freedom.rms_and_free_software.sam_williams.sst + + + + + + + + 68 + + + sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst + + + + + + + + 69 + + + should generate most available output formats: html including a concordance file, opendocument text format, plaintext, XHTML and various forms of XML, and OpenDocument text and pdf + + + + + + + + + + + + 70 + 1.2.3 + + 1.2.3 relational database - postgresql, sqlite + + + + + + + + 71 + + + Relational databases need some setting up - you must have permission to create the database and write to it when you run sisu. + + + + + + + + 72 + + + Assuming you have the database installed and the requisite permissions + + + + + + + + 73 + + + sisu --sqlite --recreate + + + + + + + + 74 + + + sisu --sqlite -v --import free_as_in_freedom.rms_and_free_software.sam_williams.sst + + + + + + + + 75 + + + sisu --pgsql --recreate + + + + + + + + 76 + + + sisu --pgsql -v --import free_as_in_freedom.rms_and_free_software.sam_williams.sst + + + + + + + + + + + + + + 77 + 1.3 + + 1.3 Getting Help + + + + + + + + + + 78 + 1.3.1 + + 1.3.1 The man pages + + + + + + + + 79 + + + Type: + + + + + + + + 80 + + + man sisu + + + + + + + + 81 + + + The man pages are also available online, though not always kept as up to date as within the package itself: + + + + + + + + 82 + + + sisu.1 2<http://www.jus.uio.no/sisu/man/sisu.1> + + + + + + + + 83 + + + sisu.8 3<http://www.jus.uio.no/sisu/man/sisu.8> + + + + + + + + 84 + + + man directory 4<http://www.jus.uio.no/sisu/man> + + + + + + + + + + + + 85 + 1.3.2 + + 1.3.2 Built in help + + + + + + + + 86 + + + sisu --help + + + + + + + + 87 + + + sisu --help --env + + + + + + + + 88 + + + sisu --help --commands + + + + + + + + 89 + + + sisu --help --markup + + + + + + + + + + + + 90 + 1.3.3 + + 1.3.3 The home page + + + + + + + + 91 + + + <http://www.jus.uio.no/sisu> + + + + + + + + 92 + + + <http://www.jus.uio.no/sisu/SiSU> + + + + + + + + + + + + + + 93 + 1.4 + + 1.4 Markup Samples + + + + + + + + 94 + + + A number of markup samples (along with output) are available off: + + + + + + + + 95 + + + <http://www.jus.uio.no/sisu/SiSU/2.html> + + + + + + + + 96 + + + Additional markup samples are packaged separately in the file: + + + + + + + + 97 + + + * + + + + + + + + 98 + + + On Debian they are available in non-free5the Debian Free Software guidelines require that everything distributed within Debian can be changed - and the documents are authors' works that while freely distributable are not freely changeable. to include them it is necessary to include non-free in your /etc/apt/source.list or obtain them from the sisu home site. + + + + + + + + +     + + + + + 0 + endnotes + + Endnotes + + + + + + + +     + +     + + + +     + diff --git a/data/doc/manuals_generated/sisu_manual/sisu_quickstart/endnotes.html b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/endnotes.html new file mode 100644 index 00000000..a50d853e --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/endnotes.html @@ -0,0 +1,484 @@ + + + + + + endnotes - + SiSU - SiSU information Structuring Universe / Structured information, Serialized Units + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + +
    + +
    SiSU -->
    +    		 + + + + + + + + + + + + + + + + + +
    + + + TOC linked  toc  + + + + + + Full Text  scroll  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
    +    		 + + + + + + +
    + + << previous + + + + TOC + + + + next >> + + +
    +
    + + + + +
    + + < + + + + ^ + + + + > + +
    + +
    +

    + SiSU - SiSU information Structuring Universe / Structured information, Serialized Units +

    +

    + Quickstart, installation and use +

    +

    + Ralph Amissah + +

    + +
    +

    Endnotes

    + + +
    +

    +  1. There is nothing to stop MySQL support being added in future. +

    +    		   +
    + + +
    +

    +  2. <http://www.jus.uio.no/sisu/man/sisu.1> +

    +    		   +
    + + +
    +

    +  3. <http://www.jus.uio.no/sisu/man/sisu.8> +

    +    		   +
    + + +
    +

    +  4. <http://www.jus.uio.no/sisu/man> +

    +    		   +
    + + +
    +

    +  5. the Debian Free Software guidelines require that everything distributed within Debian can be changed - and the documents are authors' works that while freely distributable are not freely changeable. +

    +    		   +

    +^

     
    + + + +
    + +
    SiSU -->
    +    		 + + + + + + + + + + + + + + + + + +
    + + + TOC linked  toc  + + + + + + Full Text  scroll  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
    +    		 + + + + + + +
    + + << previous + + + + TOC + + + + next >> + + +
    +
    + + + + +
    + + < + + + + ^ + + + + > + +

    + + + + + + + + +
    + +
    +

    + + SiSU + +

    +    		 + +

    + Output generated by + + SiSU + + 0.59.0 2007-09-23 (2007w38/0) +
    + + SiSU + + Copyright © Ralph Amissah + 1997, current 2007. + All Rights Reserved. +
    + + SiSU + + is software for document structuring, publishing and search, +
    + + www.jus.uio.no/sisu + + and + + www.sisudoc.org + +
    + w3 since October 3 1993 + + ralph@amissah.com + +

    +    		 +

    + SiSU using: +
    Standard SiSU markup syntax, +
    Standard SiSU meta-markup syntax, and the +
    Standard SiSU object citation numbering and system, (object/text positioning system) +
    + Copyright © Ralph Amissah 1997, current 2007. + All Rights Reserved. +

    +
    +

    + + GPLv3 + +

    +    		 +

    + + SiSU + + is released under + GPLv3 + or later, + <http://www.gnu.org/licenses/gpl.html> +

    +    		 +

    + SiSU, developed using + + Ruby + + on + + Debian/Gnu/Linux + + software infrastructure, + with the usual GPL (or OSS) suspects. +
    + Better - "performance, reliability, scalability, security & total cost of ownership" + [not to mention flexibility & choice] use of and adherence to open standards (where practical and fair) and it is software libre. +
    + Get With the Future + + Way Better! + +

    +
    + + + + + +
    +
    + + +
    + + +
    + + + + idx + txt + + +
    +
    + +
    +

    + + +SiSU manual + +

    + + + + +

    SiSU introduction

    +

    SiSU commands

    +

    SiSU markup

    +

    SiSU configuration

    +

    SiSU help

    +

    SiSU help sources

    + +
    +

    + + +SiSU + +

    + + + + +

    What does SiSU do? Summary

    +

    SiSU Book Samples and Markup Examples

    +

    Markup

    +

    Commands

    +

    Manual

    +

    SiSU Download

    +

    SiSU Changelog

    +

    Wikipedia entry

    +

    Freshmeat

    +

    Ruby Application Archive

    + + +
    + \ No newline at end of file diff --git a/data/doc/manuals_generated/sisu_manual/sisu_quickstart/index.html b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/index.html new file mode 100644 index 00000000..835f3182 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/index.html @@ -0,0 +1,584 @@ + + + + + + SiSU - SiSU information Structuring Universe / Structured information, Serialized Units + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + +
    + +
    SiSU -->
    +    		 + + + + + + + + + + + + + + + +
    + + TOC linked  toc  + + + + + Full Text  scroll  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
    +    		 +   + next >> +   +
    +

    + +

    + +
    + + +
    + +

    SiSU - SiSU information Structuring Universe / Structured information, Serialized Units +

    + +

    Quickstart, installation and use +

    + +

    Ralph Amissah +

    + +copy @ + + SiSU + + +
    + + + +

    + SiSU - SiSU information Structuring Universe / Structured information, Serialized Units - Quickstart, installation and use,
    Ralph Amissah +

    + +

    + Quickstart - SiSU installation and use +

    + +

    + + 1. Quickstart - Getting Started Howto + +

    + +
    + + 1.1 Installation + +
    + +
    + + 1.1.1 Debian Installation + +
    + +
    + + 1.1.2 RPM Installation + +
    + +
    + + 1.1.3 Installation from source + +
    + +
    + + 1.2 Testing SiSU, generating output + +
    + +
    + + 1.2.1 basic text, plaintext, html, XML, ODF + +
    + +
    + + 1.2.2 LaTeX / pdf + +
    + +
    + + 1.2.3 relational database - postgresql, sqlite + +
    + +
    + + 1.3 Getting Help + +
    + +
    + + 1.3.1 The man pages + +
    + +
    + + 1.3.2 Built in help + +
    + +
    + + 1.3.3 The home page + +
    + +
    + + 1.4 Markup Samples + +
    + +

    + + Endnotes + +

    + +

    + Document Information (metadata) +

    + +

    Copyright ©  Ralph Amissah 2007, part of SiSU documentation, License GPL 3

    +

    + +

    + + + + + +
    + +
    SiSU -->
    +    		 + + + + + + + + + + + + + + + +
    + + TOC linked  toc  + + + + + Full Text  scroll  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
    +    		 +   + next >> +   +
    +

    + +

     

    + + + + + + + + +
    + +
    +

    + + SiSU + +

    +    		 + +

    + Output generated by + + SiSU + + 0.59.0 2007-09-23 (2007w38/0) +
    + + SiSU + + Copyright © Ralph Amissah + 1997, current 2007. + All Rights Reserved. +
    + + SiSU + + is software for document structuring, publishing and search, +
    + + www.jus.uio.no/sisu + + and + + www.sisudoc.org + +
    + w3 since October 3 1993 + + ralph@amissah.com + +

    +    		 +

    + SiSU using: +
    Standard SiSU markup syntax, +
    Standard SiSU meta-markup syntax, and the +
    Standard SiSU object citation numbering and system, (object/text positioning system) +
    + Copyright © Ralph Amissah 1997, current 2007. + All Rights Reserved. +

    +
    +

    + + GPLv3 + +

    +    		 +

    + + SiSU + + is released under + GPLv3 + or later, + <http://www.gnu.org/licenses/gpl.html> +

    +    		 +

    + SiSU, developed using + + Ruby + + on + + Debian/Gnu/Linux + + software infrastructure, + with the usual GPL (or OSS) suspects. +
    + Better - "performance, reliability, scalability, security & total cost of ownership" + [not to mention flexibility & choice] use of and adherence to open standards (where practical and fair) and it is software libre. +
    + Get With the Future + + Way Better! + +

    +
    + + + + + + + +
    + +
    +
    + + +
    + + +
    + + + + idx + txt + + +
    +
    + +
    +

    + + +SiSU manual + +

    + + + + +

    SiSU introduction

    +

    SiSU commands

    +

    SiSU markup

    +

    SiSU configuration

    +

    SiSU help

    +

    SiSU help sources

    + +
    +

    + + +SiSU + +

    + + + + +

    What does SiSU do? Summary

    +

    SiSU Book Samples and Markup Examples

    +

    Markup

    +

    Commands

    +

    Manual

    +

    SiSU Download

    +

    SiSU Changelog

    +

    Wikipedia entry

    +

    Freshmeat

    +

    Ruby Application Archive

    + + +
    + + + + diff --git a/data/doc/manuals_generated/sisu_manual/sisu_quickstart/landscape.pdf b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/landscape.pdf new file mode 100644 index 00000000..f426f1db Binary files /dev/null and b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/landscape.pdf differ diff --git a/data/doc/manuals_generated/sisu_manual/sisu_quickstart/metadata.html b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/metadata.html new file mode 100644 index 00000000..0c40ff63 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/metadata.html @@ -0,0 +1,591 @@ + + + + + + - + SiSU - SiSU information Structuring Universe / Structured information, Serialized Units + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + +
    + +
    SiSU -->
    +    		 + + + + + + + + + + + + + + + + + +
    + + + TOC linked  toc  + + + + + + Full Text  scroll  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
    +    		 + + + + + + +
    + + << previous + + + + TOC + + +
    +
    + + + + +
    + + < + + + + ^ + + + + > + +

    + SiSU - SiSU information Structuring Universe / Structured information, Serialized Units +

    +

    + Quickstart, installation and use +

    +

    + Ralph Amissah + +

    +

    + copy @ + + SiSU + +

    + + +
    +

    + Document Information (metadata) +

    +    		   +

    +   0 +

    +
    + + +
    + +   +
    + + +
    +

    + + Metadata +

    +    		 +

    +   0 +

    +
    + +
    +

    + <http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/sisu_manifest.html> +

    		 +
    + +
    +

    + Dublin Core (DC) +

    		 +
    + +
    +

    + DC tags included with this document are provided here. +

    		 +
    + +
    +

    + DC Title: SiSU - SiSU information Structuring Universe / Structured information, Serialized Units - Quickstart, installation and use +

    		 +
    + +
    +

    + DC Creator: Ralph Amissah +

    		 +
    + +
    +

    + DC Rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +

    		 +
    + +
    +

    + DC Type: information +

    		 +
    + +
    +

    + DC Date created: 2006-09-06 +

    		 +
    + +
    +

    + DC Date available: 2006-09-06 +

    		 +
    + +
    +

    + DC Date issued: 2006-09-06 +

    		 +
    + +
    +

    + DC Date modified: 2007-09-16 +

    		 +
    + +
    +

    + DC Date: 2007-09-16 +

    		 +
    + +
    +

    + Version Information +

    		 +
    + +
    +

    + Sourcefile: sisu_quickstart.sst +

    		 +
    + +
    +

    + Filetype: SiSU text 0.57 +

    		 +
    + +
    +

    + Sourcefile Digest, MD5(sisu_quickstart.sst)= 05a047fd659fbbeaa3cdb982b5911bcd +

    		 +
    + +
    +

    + 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)= 20fc43cf3eb6590bc3399a1aef65c5a9 +

    		 +
    + +
    +

    + Generated +

    		 +
    + +
    +

    + Document (metaverse) last generated: Sun Sep 23 04:11:02 +0100 2007 +

    		 +
    + +
    +

    + Generated by: SiSU 0.59.0 of 2007w38/0 (2007-09-23) +

    		 +
    + +
    +

    + Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux] +

    		 +

    +^

     
    + + + +
    + +
    SiSU -->
    +    		 + + + + + + + + + + + + + + + + + +
    + + + TOC linked  toc  + + + + + + Full Text  scroll  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
    +    		 + + + + + + +
    + + << previous + + + + TOC + + +
    +
    + + + + +
    + + < + + + + ^ + + + + > + +

    + + + + + + + + +
    + +
    +

    + + SiSU + +

    +    		 + +

    + Output generated by + + SiSU + + 0.59.0 2007-09-23 (2007w38/0) +
    + + SiSU + + Copyright © Ralph Amissah + 1997, current 2007. + All Rights Reserved. +
    + + SiSU + + is software for document structuring, publishing and search, +
    + + www.jus.uio.no/sisu + + and + + www.sisudoc.org + +
    + w3 since October 3 1993 + + ralph@amissah.com + +

    +    		 +

    + SiSU using: +
    Standard SiSU markup syntax, +
    Standard SiSU meta-markup syntax, and the +
    Standard SiSU object citation numbering and system, (object/text positioning system) +
    + Copyright © Ralph Amissah 1997, current 2007. + All Rights Reserved. +

    +
    +

    + + GPLv3 + +

    +    		 +

    + + SiSU + + is released under + GPLv3 + or later, + <http://www.gnu.org/licenses/gpl.html> +

    +    		 +

    + SiSU, developed using + + Ruby + + on + + Debian/Gnu/Linux + + software infrastructure, + with the usual GPL (or OSS) suspects. +
    + Better - "performance, reliability, scalability, security & total cost of ownership" + [not to mention flexibility & choice] use of and adherence to open standards (where practical and fair) and it is software libre. +
    + Get With the Future + + Way Better! + +

    +
    + + + + + +
    +
    + + +
    + + +
    + + + + idx + txt + + +
    +
    + +
    +

    + + +SiSU manual + +

    + + + + +

    SiSU introduction

    +

    SiSU commands

    +

    SiSU markup

    +

    SiSU configuration

    +

    SiSU help

    +

    SiSU help sources

    + +
    +

    + + +SiSU + +

    + + + + +

    What does SiSU do? Summary

    +

    SiSU Book Samples and Markup Examples

    +

    Markup

    +

    Commands

    +

    Manual

    +

    SiSU Download

    +

    SiSU Changelog

    +

    Wikipedia entry

    +

    Freshmeat

    +

    Ruby Application Archive

    + + +
    + \ No newline at end of file diff --git a/data/doc/manuals_generated/sisu_manual/sisu_quickstart/opendocument.odt b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/opendocument.odt new file mode 100644 index 00000000..5fe82dc7 Binary files /dev/null and b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/opendocument.odt differ diff --git a/data/doc/manuals_generated/sisu_manual/sisu_quickstart/plain.txt b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/plain.txt new file mode 100644 index 00000000..d4f3b297 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/plain.txt @@ -0,0 +1,476 @@ +SISU - SISU INFORMATION STRUCTURING UNIVERSE / STRUCTURED INFORMATION, +SERIALIZED UNITS - QUICKSTART, INSTALLATION AND USE, +RALPH AMISSAH +****************************************************************************** + +QUICKSTART - SISU INSTALLATION AND USE +====================================== + +1. QUICKSTART - GETTING STARTED HOWTO +------------------------------------- + +1.1 INSTALLATION +................ + +Installation is currently most straightforward and tested on the *Debian* +platform, as there are packages for the installation of sisu and all +requirements for what it does. + + +1.1.1 DEBIAN INSTALLATION +......................... + +*SiSU* is available directly from the *Debian* Sid and testing archives (and +possibly Ubuntu), assuming your /etc/apt/sources.list is set accordingly: + + + + aptitude update + aptitude install sisu-complete + +The following /etc/apt/sources.list setting permits the download of additional +markup samples: + + + + #/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 + +The aptitude commands become: + + + + aptitude update + aptitude install sisu-complete sisu-markup-samples + +If there are newer versions of *SiSU* upstream of the *Debian* archives, they +will be available by adding the following to your /etc/apt/sources.list + + + + #/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 + +repeat the aptitude commands + + + + aptitude update + aptitude install sisu-complete sisu-markup-samples + +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. + + +1.1.2 RPM INSTALLATION +...................... + +RPMs are provided though untested, they are prepared by running alien against +the source package, and against the debs. + + +They may be downloaded from: + + + + + +as root type: + + + rpm -i [rpm package name] + + +1.1.3 INSTALLATION FROM SOURCE +.............................. + +To install *SiSU* from source check information at: + + + + + +* download the source package + + +* Unpack the source + + +Two alternative modes of installation from source are provided, setup.rb (by +Minero Aoki) and a rant(by Stefan Lang) built install file, in either case: the +first steps are the same, download and unpack the source file: + + +For basic use *SiSU* is only dependent on the programming language in which it +is written *Ruby*, and *SiSU* will be able to generate html, various XMLs, +including ODF (and will also produce LaTeX). Dependencies required for further +actions, though it relies on the installation of additional dependencies which +the source tarball does not take care of, for things like using a database +(postgresql or sqlite)[^1] or converting LaTeX to pdf. + + +- [1]: There is nothing to stop MySQL support being added in future. + +*setup.rb* + + +This is a standard ruby installer, using setup.rb is a three step process. In +the root directory of the unpacked *SiSU* as root type: + + + + ruby setup.rb config + ruby setup.rb setup + #[and as root:] + ruby setup.rb install + +further information on setup.rb is available from: + + + + + + + + +*"install"* + + +The "install" file provided is an installer prepared using "rant". In the root +directory of the unpacked *SiSU* as root type: + + + ruby install base + + +or for a more complete installation: + + + ruby install + + +or + + + ruby install base + + +This makes use of Rant (by Stefan Lang) and the provided Rantfile. It has been +configured to do post installation setup setup configuration and generation of +first test file. Note however, that additional external package dependencies, +such as tetex-extra are not taken care of for you. + + +Further information on "rant" is available from: + + + + + + + + +For a list of alternative actions you may type: + + + ruby install help + + + ruby install -T + + +1.2 TESTING SISU, GENERATING OUTPUT +................................... + +To check which version of sisu is installed: + + +sisu -v + + +Depending on your mode of installation one or a number of markup sample files +may be found either in the directory: + + +... + + +or + + +... + + +change directory to the appropriate one: + + +cd /usr/share/doc/sisu/sisu_markup_samples/dfsg + + +1.2.1 BASIC TEXT, PLAINTEXT, HTML, XML, ODF +........................................... + +Having moved to the directory that contains the markup samples (see +instructions above if necessary), choose a file and run sisu against it + + +sisu -NhwoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst + + +this will generate html including a concordance file, opendocument text format, +plaintext, XHTML and various forms of XML, and OpenDocument text + + +1.2.2 LATEX / PDF +................. + +Assuming a LaTeX engine such as tetex or texlive is installed with the required +modules (done automatically on selection of sisu-pdf in *Debian*) + + +Having moved to the directory that contains the markup samples (see +instructions above if necessary), choose a file and run sisu against it + + +sisu -pv free_as_in_freedom.rms_and_free_software.sam_williams.sst + + +sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst + + +should generate most available output formats: html including a concordance +file, opendocument text format, plaintext, XHTML and various forms of XML, and +OpenDocument text and pdf + + +1.2.3 RELATIONAL DATABASE - POSTGRESQL, SQLITE +.............................................. + +Relational databases need some setting up - you must have permission to create +the database and write to it when you run sisu. + + +Assuming you have the database installed and the requisite permissions + + +sisu --sqlite --recreate + + +sisu --sqlite -v --import +free_as_in_freedom.rms_and_free_software.sam_williams.sst + + +sisu --pgsql --recreate + + +sisu --pgsql -v --import +free_as_in_freedom.rms_and_free_software.sam_williams.sst + + +1.3 GETTING HELP +................ + +1.3.1 THE MAN PAGES +................... + +Type: + + + man sisu + + +The man pages are also available online, though not always kept as up to date +as within the package itself: + + +* sisu.1 [link:] [^2] + + +- [2]: + +* sisu.8 [link:] [^3] + + +- [3]: + +* man directory [link:] [^4] + + +- [4]: + +1.3.2 BUILT IN HELP +................... + +sisu --help + + +sisu --help --env + + +sisu --help --commands + + +sisu --help --markup + + +1.3.3 THE HOME PAGE +................... + + + + + + + +1.4 MARKUP SAMPLES +.................. + +A number of markup samples (along with output) are available off: + + + + + +Additional markup samples are packaged separately in the file: + + +*** + + +On *Debian* 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. + + +- [5]: the *Debian* Free Software guidelines require that everything distributed + within *Debian* can be changed - and the documents are authors' works that + while freely distributable are not freely changeable. + +DOCUMENT INFORMATION (METADATA) +******************************* + +METADATA +-------- + +Document Manifest @ + + + +*Dublin Core* (DC) + + +/DC tags included with this document are provided here./ + + +DC Title: _SiSU - SiSU information Structuring Universe / Structured +information, Serialized Units - Quickstart, installation and use_ + + +DC Creator: _Ralph Amissah_ + + +DC Rights: _Copyright (C) Ralph Amissah 2007, part of SiSU documentation, +License GPL 3_ + + +DC Type: _information_ + + +DC Date created: _2006-09-06_ + + +DC Date available: _2006-09-06_ + + +DC Date issued: _2006-09-06_ + + +DC Date modified: _2007-09-16_ + + +DC Date: _2007-09-16_ + + +*Version Information* + + +Sourcefile: _sisu_quickstart.sst_ + + +Filetype: _SiSU text 0.57_ + + +Sourcefile Digest, MD5(sisu_quickstart.sst)= _05a047fd659fbbeaa3cdb982b5911bcd_ + + +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)= +_20fc43cf3eb6590bc3399a1aef65c5a9_ + + +*Generated* + + +Document (metaverse) last generated: _Sun Sep 23 04:11:02 +0100 2007_ + + +Generated by: _SiSU_ _0.59.0_ of 2007w38/0 (2007-09-23) + + +Ruby version: _ ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux]_ + + + +============================================================================== + + title: SiSU - SiSU information Structuring Universe / Structured + information, Serialized Units - Quickstart, installation and use + + creator: Ralph Amissah + + rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, + License GPL 3 + + type: information + + subject: ebook, epublishing, electronic book, electronic publishing, + electronic document, electronic citation, data structure, + citation systems, search + + date.created: 2006-09-06 + + date.available: 2006-09-06 + + date.issued: 2006-09-06 + + date.modified: 2007-09-16 + + date: 2007-09-16 + + + + + +============================================================================== +nil + +Other versions of this document: +manifest: + http://www.jus.uio.no/sisu/sisu_quickstart/sisu_manifest.html +html: + http://www.jus.uio.no/sisu/sisu_quickstart/toc.html +pdf: + http://www.jus.uio.no/sisu/sisu_quickstart/portrait.pdf + http://www.jus.uio.no/sisu/sisu_quickstart/landscape.pdf +plaintext (plain text): + http://www.jus.uio.no/sisu/sisu_quickstart/plain.txt +at: + http://www.jus.uio.no/sisu +* Generated by: SiSU 0.59.0 of 2007w38/0 (2007-09-23) +* Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux] +* Last Generated on: Sun Sep 23 04:11:51 +0100 2007 +* SiSU http://www.jus.uio.no/sisu diff --git a/data/doc/manuals_generated/sisu_manual/sisu_quickstart/portrait.pdf b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/portrait.pdf new file mode 100644 index 00000000..3c70afce Binary files /dev/null and b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/portrait.pdf differ diff --git a/data/doc/manuals_generated/sisu_manual/sisu_quickstart/sax.xml b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/sax.xml new file mode 100644 index 00000000..732593a6 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/sax.xml @@ -0,0 +1,767 @@ + + + + + + + Title: + + SiSU - SiSU information Structuring Universe / Structured information, Serialized Units - Quickstart, installation and use + +
    + Creator: + + Ralph Amissah + +
    + Rights: + + Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +
    + Type: + + information + +
    + Subject: + + ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +
    + Date created: + + 2006-09-06 + +
    + Date available: + + 2006-09-06 + +
    + Date issued: + + 2006-09-06 + +
    + Date modified: + + 2007-09-16 + +
    + Date: + + 2007-09-16 + +
    + + + + 1 + + SiSU - SiSU information Structuring Universe / Structured information, +Serialized Units - Quickstart, installation and use,
    Ralph +Amissah +     +     + + 2 + + Quickstart - SiSU installation and use + + + + 3 + + 1. Quickstart - Getting Started Howto + + + + 4 + + 1.1 Installation + + + + 5 + + Installation is currently most straightforward and tested on the +Debian platform, as there are packages for the installation of +sisu and all requirements for what it does. + + + + 6 + + 1.1.1 Debian Installation + + + + 7 + + SiSU is available directly from the Debian Sid and +testing archives (and possibly Ubuntu), assuming your +/etc/apt/sources.list is set accordingly: + + + + 8 + +        aptitude update
           aptitude install sisu-complete     +     +     + + 9 + + The following /etc/apt/sources.list setting permits the download of +additional markup samples: + + + + 10 + +      #/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     +     +     + + 11 + + The aptitude commands become: + + + + 12 + +        aptitude update
           aptitude install sisu-complete sisu-markup-samples     +     +     + + 13 + + If there are newer versions of SiSU upstream of the +Debian archives, they will be available by adding the following +to your /etc/apt/sources.list + + + + 14 + +      #/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     +     +     + + 15 + + repeat the aptitude commands + + + + 16 + +        aptitude update
           aptitude install sisu-complete sisu-markup-samples     +     +     + + 17 + + 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. + + + + 18 + + 1.1.2 RPM Installation + + + + 19 + + RPMs are provided though untested, they are prepared by running alien +against the source package, and against the debs. + + + + 20 + + They may be downloaded from: + + + + 21 + + <http://www.jus.uio.no/sisu/SiSU/download.html#rpm> + + + + 22 + + as root type: + + + + 23 + + rpm -i [rpm package name] + + + + 24 + + 1.1.3 Installation from source + + + + 25 + + To install SiSU from source check information at: + + + + 26 + + <http://www.jus.uio.no/sisu/SiSU/download.html#current> + + + + 27 + + download the source package + + + + 28 + + Unpack the source + + + + 29 + + 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: + + + + 30 + + For basic use SiSU is only dependent on the programming language +in which it is written Ruby, and SiSU will be able to +generate html, various XMLs, including ODF (and will also produce +LaTeX). Dependencies required for further actions, though it relies on +the installation of additional dependencies which the source tarball +does not take care of, for things like using a database (postgresql or +sqlite)1 or converting LaTeX to pdf. + + + 1 + + There is nothing to stop MySQL support being added in future. + + + + + 31 + + setup.rb + + + + 32 + + This is a standard ruby installer, using setup.rb is a three step +process. In the root directory of the unpacked SiSU as root +type: + + + + 33 + +          ruby setup.rb config
             ruby setup.rb setup
             #[and as root:]
             ruby setup.rb install     +     +     + + 34 + + further information on setup.rb is available from: + + + + 35 + + <http://i.loveruby.net/en/projects/setup/> + + + + 36 + + <http://i.loveruby.net/en/projects/setup/doc/usage.html> + + + + 37 + + "install" + + + + 38 + + The "install" file provided is an installer prepared using "rant". In +the root directory of the unpacked SiSU as root type: + + + + 39 + + ruby install base + + + + 40 + + or for a more complete installation: + + + + 41 + + ruby install + + + + 42 + + or + + + + 43 + + ruby install base + + + + 44 + + 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. + + + + 45 + + Further information on "rant" is available from: + + + + 46 + + <http://make.rubyforge.org/> + + + + 47 + + <http://rubyforge.org/frs/?group_id=615> + + + + 48 + + For a list of alternative actions you may type: + + + + 49 + + ruby install help + + + + 50 + + ruby install -T + + + + 51 + + 1.2 Testing SiSU, generating output + + + + 52 + + To check which version of sisu is installed: + + + + 53 + + sisu -v + + + + 54 + + Depending on your mode of installation one or a number of markup sample +files may be found either in the directory: + + + + 55 + + ... + + + + 56 + + or + + + + 57 + + ... + + + + 58 + + change directory to the appropriate one: + + + + 59 + + cd /usr/share/doc/sisu/sisu_markup_samples/dfsg + + + + 60 + + 1.2.1 basic text, plaintext, html, XML, ODF + + + + 61 + + Having moved to the directory that contains the markup samples (see +instructions above if necessary), choose a file and run sisu against it + + + + 62 + + sisu -NhwoabxXyv +free_as_in_freedom.rms_and_free_software.sam_williams.sst + + + + 63 + + this will generate html including a concordance file, opendocument text +format, plaintext, XHTML and various forms of XML, and OpenDocument +text + + + + 64 + + 1.2.2 LaTeX / pdf + + + + 65 + + Assuming a LaTeX engine such as tetex or texlive is installed with the +required modules (done automatically on selection of sisu-pdf in +Debian) + + + + 66 + + Having moved to the directory that contains the markup samples (see +instructions above if necessary), choose a file and run sisu against it + + + + 67 + + sisu -pv free_as_in_freedom.rms_and_free_software.sam_williams.sst + + + + 68 + + sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst + + + + 69 + + should generate most available output formats: html including a +concordance file, opendocument text format, plaintext, XHTML and +various forms of XML, and OpenDocument text and pdf + + + + 70 + + 1.2.3 relational database - postgresql, sqlite + + + + 71 + + Relational databases need some setting up - you must have permission to +create the database and write to it when you run sisu. + + + + 72 + + Assuming you have the database installed and the requisite permissions + + + + 73 + + sisu --sqlite --recreate + + + + 74 + + sisu --sqlite -v --import +free_as_in_freedom.rms_and_free_software.sam_williams.sst + + + + 75 + + sisu --pgsql --recreate + + + + 76 + + sisu --pgsql -v --import +free_as_in_freedom.rms_and_free_software.sam_williams.sst + + + + 77 + + 1.3 Getting Help + + + + 78 + + 1.3.1 The man pages + + + + 79 + + Type: + + + + 80 + + man sisu + + + + 81 + + The man pages are also available online, though not always kept as up +to date as within the package itself: + + + + 82 + + sisu.1 +2 + + + 2 + + <http://www.jus.uio.no/sisu/man/sisu.1> + + + + + 83 + + sisu.8 +3 + + + 3 + + <http://www.jus.uio.no/sisu/man/sisu.8> + + + + + 84 + + man directory +4 + + + 4 + + <http://www.jus.uio.no/sisu/man> + + + + + 85 + + 1.3.2 Built in help + + + + 86 + + sisu --help + + + + 87 + + sisu --help --env + + + + 88 + + sisu --help --commands + + + + 89 + + sisu --help --markup + + + + 90 + + 1.3.3 The home page + + + + 91 + + <http://www.jus.uio.no/sisu> + + + + 92 + + <http://www.jus.uio.no/sisu/SiSU> + + + + 93 + + 1.4 Markup Samples + + + + 94 + + A number of markup samples (along with output) are available off: + + + + 95 + + <http://www.jus.uio.no/sisu/SiSU/2.html> + + + + 96 + + Additional markup samples are packaged separately in the file: + + + + 97 + + * + + + + 98 + + On Debian they are available in non-free5 to include +them it is necessary to include non-free in your /etc/apt/source.list +or obtain them from the sisu home site. + + + 5 + + the Debian Free Software guidelines require that everything +distributed within Debian can be changed - and the documents are +authors' works that while freely distributable are not freely +changeable. + + + + + 0 + + Endnotes + + + +     diff --git a/data/doc/manuals_generated/sisu_manual/sisu_quickstart/scroll.xhtml b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/scroll.xhtml new file mode 100644 index 00000000..a4ed3478 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/scroll.xhtml @@ -0,0 +1,753 @@ + + + + + + + + Title: + + SiSU - SiSU information Structuring Universe / Structured information, Serialized Units - Quickstart, installation and use + +
    + Creator: + + Ralph Amissah + +
    + Rights: + + Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +
    + Type: + + information + +
    + Subject: + + ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +
    + Date created: + + 2006-09-06 + +
    + Date available: + + 2006-09-06 + +
    + Date issued: + + 2006-09-06 + +
    + Date modified: + + 2007-09-16 + +
    + Date: + + 2007-09-16 + +
    + + + + + SiSU - SiSU information Structuring Universe / Structured information, +Serialized Units - Quickstart, installation and use,
    Ralph +Amissah +     + 1 +     + + + Quickstart - SiSU installation and use + + 2 + + + + 1. Quickstart - Getting Started Howto + + 3 + + + + 1.1 Installation + + 4 + + + + Installation is currently most straightforward and tested on the +Debian platform, as there are packages for the installation of +sisu and all requirements for what it does. + + 5 + + + + 1.1.1 Debian Installation + + 6 + + + + SiSU is available directly from the Debian Sid and +testing archives (and possibly Ubuntu), assuming your +/etc/apt/sources.list is set accordingly: + + 7 + + + 8 + +        aptitude update
           aptitude install sisu-complete     +     +     + + + The following /etc/apt/sources.list setting permits the download of +additional markup samples: + + 9 + + + 10 + +      #/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     +     +     + + + The aptitude commands become: + + 11 + + + 12 + +        aptitude update
           aptitude install sisu-complete sisu-markup-samples     +     +     + + + If there are newer versions of SiSU upstream of the +Debian archives, they will be available by adding the following +to your /etc/apt/sources.list + + 13 + + + 14 + +      #/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     +     +     + + + repeat the aptitude commands + + 15 + + + 16 + +        aptitude update
           aptitude install sisu-complete sisu-markup-samples     +     +     + + + 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. + + 17 + + + + 1.1.2 RPM Installation + + 18 + + + + RPMs are provided though untested, they are prepared by running alien +against the source package, and against the debs. + + 19 + + + + They may be downloaded from: + + 20 + + + + <http://www.jus.uio.no/sisu/SiSU/download.html#rpm> + + 21 + + + + as root type: + + 22 + + + + rpm -i [rpm package name] + + 23 + + + + 1.1.3 Installation from source + + 24 + + + + To install SiSU from source check information at: + + 25 + + + + <http://www.jus.uio.no/sisu/SiSU/download.html#current> + + 26 + + + + download the source package + + 27 + + + + Unpack the source + + 28 + + + + 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: + + 29 + + + + For basic use SiSU is only dependent on the programming language +in which it is written Ruby, and SiSU will be able to +generate html, various XMLs, including ODF (and will also produce +LaTeX). Dependencies required for further actions, though it relies on +the installation of additional dependencies which the source tarball +does not take care of, for things like using a database (postgresql or +sqlite)1 or converting LaTeX to pdf. + + + 1. There is nothing to stop MySQL support being added in future. + + 30 + + + + setup.rb + + 31 + + + + This is a standard ruby installer, using setup.rb is a three step +process. In the root directory of the unpacked SiSU as root +type: + + 32 + + + 33 + +          ruby setup.rb config
             ruby setup.rb setup
             #[and as root:]
             ruby setup.rb install     +     +     + + + further information on setup.rb is available from: + + 34 + + + + <http://i.loveruby.net/en/projects/setup/> + + 35 + + + + <http://i.loveruby.net/en/projects/setup/doc/usage.html> + + 36 + + + + "install" + + 37 + + + + The "install" file provided is an installer prepared using "rant". In +the root directory of the unpacked SiSU as root type: + + 38 + + + + ruby install base + + 39 + + + + or for a more complete installation: + + 40 + + + + ruby install + + 41 + + + + or + + 42 + + + + ruby install base + + 43 + + + + 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. + + 44 + + + + Further information on "rant" is available from: + + 45 + + + + <http://make.rubyforge.org/> + + 46 + + + + <http://rubyforge.org/frs/?group_id=615> + + 47 + + + + For a list of alternative actions you may type: + + 48 + + + + ruby install help + + 49 + + + + ruby install -T + + 50 + + + + 1.2 Testing SiSU, generating output + + 51 + + + + To check which version of sisu is installed: + + 52 + + + + sisu -v + + 53 + + + + Depending on your mode of installation one or a number of markup sample +files may be found either in the directory: + + 54 + + + + ... + + 55 + + + + or + + 56 + + + + ... + + 57 + + + + change directory to the appropriate one: + + 58 + + + + cd /usr/share/doc/sisu/sisu_markup_samples/dfsg + + 59 + + + + 1.2.1 basic text, plaintext, html, XML, ODF + + 60 + + + + Having moved to the directory that contains the markup samples (see +instructions above if necessary), choose a file and run sisu against it + + 61 + + + + sisu -NhwoabxXyv +free_as_in_freedom.rms_and_free_software.sam_williams.sst + + 62 + + + + this will generate html including a concordance file, opendocument text +format, plaintext, XHTML and various forms of XML, and OpenDocument +text + + 63 + + + + 1.2.2 LaTeX / pdf + + 64 + + + + Assuming a LaTeX engine such as tetex or texlive is installed with the +required modules (done automatically on selection of sisu-pdf in +Debian) + + 65 + + + + Having moved to the directory that contains the markup samples (see +instructions above if necessary), choose a file and run sisu against it + + 66 + + + + sisu -pv free_as_in_freedom.rms_and_free_software.sam_williams.sst + + 67 + + + + sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst + + 68 + + + + should generate most available output formats: html including a +concordance file, opendocument text format, plaintext, XHTML and +various forms of XML, and OpenDocument text and pdf + + 69 + + + + 1.2.3 relational database - postgresql, sqlite + + 70 + + + + Relational databases need some setting up - you must have permission to +create the database and write to it when you run sisu. + + 71 + + + + Assuming you have the database installed and the requisite permissions + + 72 + + + + sisu --sqlite --recreate + + 73 + + + + sisu --sqlite -v --import +free_as_in_freedom.rms_and_free_software.sam_williams.sst + + 74 + + + + sisu --pgsql --recreate + + 75 + + + + sisu --pgsql -v --import +free_as_in_freedom.rms_and_free_software.sam_williams.sst + + 76 + + + + 1.3 Getting Help + + 77 + + + + 1.3.1 The man pages + + 78 + + + + Type: + + 79 + + + + man sisu + + 80 + + + + The man pages are also available online, though not always kept as up +to date as within the package itself: + + 81 + + + + sisu.1 +2 + + + 2. <http://www.jus.uio.no/sisu/man/sisu.1> + + 82 + + + + sisu.8 +3 + + + 3. <http://www.jus.uio.no/sisu/man/sisu.8> + + 83 + + + + man directory +4 + + + 4. <http://www.jus.uio.no/sisu/man> + + 84 + + + + 1.3.2 Built in help + + 85 + + + + sisu --help + + 86 + + + + sisu --help --env + + 87 + + + + sisu --help --commands + + 88 + + + + sisu --help --markup + + 89 + + + + 1.3.3 The home page + + 90 + + + + <http://www.jus.uio.no/sisu> + + 91 + + + + <http://www.jus.uio.no/sisu/SiSU> + + 92 + + + + 1.4 Markup Samples + + 93 + + + + A number of markup samples (along with output) are available off: + + 94 + + + + <http://www.jus.uio.no/sisu/SiSU/2.html> + + 95 + + + + Additional markup samples are packaged separately in the file: + + 96 + + + + * + + 97 + + + + On Debian they are available in non-free5 to include +them it is necessary to include non-free in your /etc/apt/source.list +or obtain them from the sisu home site. + + + 5. the Debian Free Software guidelines require that everything +distributed within Debian can be changed - and the documents are +authors' works that while freely distributable are not freely +changeable. + + 98 + + + + Endnotes + + 0 + + +     diff --git a/data/doc/manuals_generated/sisu_manual/sisu_quickstart/sisu_manifest.html b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/sisu_manifest.html new file mode 100644 index 00000000..126b5f0b --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/sisu_manifest.html @@ -0,0 +1,200 @@ + + + + +SiSU manifest: SiSU - SiSU information Structuring Universe / Structured information, Serialized Units + + + + + + + + + + +
    SiSU -->

    <http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/>

    		 + +
    + + +
    + + + idx + txt + +     +
    +
    + +

    SiSU - SiSU information Structuring Universe / Structured information, Serialized Units - Quickstart, installation and use

    +

    Ralph Amissah

    + + +

    SiSU manifest

    + + + + + + + + + + + + + + +

    description

    filename

    file size

    (kB)

    TOC linked table of contents (for segmented HTML text)

    toc.html

    <http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/toc.html>

    17.4

    Full Text full length document (HTML)

    doc.html

    <http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/doc.html>

    64.9

    PDF portrait full length document (PDF portrait / vertical - recommended for printing)

    portrait.pdf

    <http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/portrait.pdf>

    111.6

    PDF landscape full length document (PDF landscape / horizontal - recommended for screen viewing)

    landscape.pdf

    <http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/landscape.pdf>

    108.8

    ODF/ODT full length document (ODF:ODT - Open Document Format)

    opendocument.odt

    <http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/opendocument.odt>

    10.6

    full length document (XHTML)

    scroll.xhtml

    <http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/scroll.xhtml>

    18.4

    full length document (XML SAX)

    sax.xml

    <http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/sax.xml>

    18.5

    full length document (XML DOM)

    dom.xml

    <http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/dom.xml>

    22.8

    full length document (plaintext (UTF-8))

    plain.txt

    <http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/plain.txt>

    10.0

    Concordance file (HTML - wordmap, alphabetical wordlist)

    concordance.html

    <http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/concordance.html>

    64.3

    Digest/DCC - Document Content Certificate (md5)

    digest.txt

    <http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/digest.txt>

    13.7

    + + +

    Markup (SiSU source)

    sisu_quickstart.sst   05a047fd659fbbeaa3cdb982b5911bcd
    <http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/sisu_quickstart.sst>

    7.8

    +

    SiSU doc (zip)

    sisupod.zip   2c1986ca67e88ef8d1c5697612b14e8c
    <http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/sisupod.zip>

    5.4

    +

    SiSU manifest of document metadata

    + + + + + + + + + + + + + + + + + + + + + + + +

    metadata

    description

    DC Title:

    SiSU - SiSU information Structuring Universe / Structured information, Serialized Units - Quickstart, installation and use

    Title:

    SiSU - SiSU information Structuring Universe / Structured information, Serialized Units

    Subtitle:

    Quickstart, installation and use

    DC Creator:

    Ralph Amissah

    DC Publisher:

    SiSU http://www.jus.uio.no/sisu (this copy)

    DC Subject:

    ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search

    DC Type:

    information

    DC Rights:

    Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3

    DC Date:

    2007-09-16

    DC Date created:

    2006-09-06

    DC Date issued:

    2006-09-06

    DC Date available:

    2006-09-06

    DC Date modified:

    2007-09-16

    DC Language:

    English

    DC Identifier:

    http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/toc.html

    Sourcefile:

    sisu_quickstart.sst

    Word Count approximate:

    924

    Sourcefile Digest (md5):

    05a047fd659fbbeaa3cdb982b5911bcd

    Document (metaverse) last generated:

    Sun Sep 23 04:13:44 +0100 2007

    Generated by:

    SiSU 0.59.0 2007w38/0 (2007-09-23)

    Ruby version:

    ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux]

    + + + + + + + + + + + + +

    metadata suggested links:

    SiSU Manual

      <http://www.jus.uio.no/sisu/sisu_manual/>

    Book Samples and Markup Examples

      <http://www.jus.uio.no/sisu/SiSU/2.html>

    SiSU @ Wikipedia

      <http://en.wikipedia.org/wiki/SiSU>

    SiSU @ Freshmeat

      <http://freshmeat.net/projects/sisu/>

    SiSU @ Ruby Application Archive

      <http://raa.ruby-lang.org/project/sisu/>

    SiSU @ Debian

      <http://packages.qa.debian.org/s/sisu.html>

    SiSU Download

      <http://www.jus.uio.no/sisu/SiSU/download.html>

    SiSU Changelog

      <http://www.jus.uio.no/sisu/SiSU/changelog.html>

    SiSU help

      <http://www.jus.uio.no/sisu/sisu_manual/sisu_help/>

    SiSU help sources

      <http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/>

    +

    Document Language Versions, manifests

    + + + + +

    filename

    description

     

    English

    English

    <http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/sisu_manifest.html>

     

    + + + + + + + + +
    + +
    +

    + + SiSU + +

    +    		 + +

    + Output generated by + + SiSU + + 0.59.0 2007-09-23 (2007w38/0) +
    + + SiSU + + Copyright © Ralph Amissah + 1997, current 2007. + All Rights Reserved. +
    + + SiSU + + is software for document structuring, publishing and search, +
    + + www.jus.uio.no/sisu + + and + + www.sisudoc.org + +
    + w3 since October 3 1993 + + ralph@amissah.com + +

    +    		 +

    + SiSU using: +
    Standard SiSU markup syntax, +
    Standard SiSU meta-markup syntax, and the +
    Standard SiSU object citation numbering and system, (object/text positioning system) +
    + Copyright © Ralph Amissah 1997, current 2007. + All Rights Reserved. +

    +
    +

    + + GPLv3 + +

    +    		 +

    + + SiSU + + is released under + GPLv3 + or later, + <http://www.gnu.org/licenses/gpl.html> +

    +    		 +

    + SiSU, developed using + + Ruby + + on + + Debian/Gnu/Linux + + software infrastructure, + with the usual GPL (or OSS) suspects. +
    + Better - "performance, reliability, scalability, security & total cost of ownership" + [not to mention flexibility & choice] use of and adherence to open standards (where practical and fair) and it is software libre. +
    + Get With the Future + + Way Better! + +

    +
    + + diff --git a/data/doc/manuals_generated/sisu_manual/sisu_quickstart/sisu_quickstart.sst b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/sisu_quickstart.sst new file mode 100644 index 00000000..80f4753e --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/sisu_quickstart.sst @@ -0,0 +1,273 @@ +% SiSU 0.57 + +@title: SiSU - SiSU information Structuring Universe / Structured information, Serialized Units + +@subtitle: Quickstart, installation and use + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2006-09-06 + +@date.available: 2006-09-06 + +@date.issued: 2006-09-06 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? Quickstart - SiSU installation and use + +1~ Quickstart - Getting Started Howto + +2~ Installation + +Installation is currently most straightforward and tested on the Debian platform, as there are packages for the installation of sisu and all requirements for what it does. + +3~ Debian Installation + +SiSU is available directly from the Debian Sid and testing archives (and possibly Ubuntu), assuming your /etc/apt/sources.list is set accordingly: + +code{ + + aptitude update + aptitude install sisu-complete + +}code + +The following /etc/apt/sources.list setting permits the download of additional markup samples: + +code{ + +#/etc/apt/sources.list + + deb http://ftp.fi.debian.org/debian/ unstable main non-free contrib + deb-src http://ftp.fi.debian.org/debian/ unstable main non-free contrib +d + +}code + +The aptitude commands become: + +code{ + + aptitude update + aptitude install sisu-complete sisu-markup-samples + +}code + +If there are newer versions of SiSU upstream of the Debian archives, they will be available by adding the following to your /etc/apt/sources.list + +code{ + +#/etc/apt/sources.list + + deb http://www.jus.uio.no/sisu/archive unstable main non-free + deb-src http://www.jus.uio.no/sisu/archive unstable main non-free + +}code + +repeat the aptitude commands + +code{ + + aptitude update + aptitude install sisu-complete sisu-markup-samples + +}code + +Note however that it is not necessary to install sisu-complete if not all components of sisu are to be used. Installing just the package sisu will provide basic functionality. + +3~ RPM Installation + +RPMs are provided though untested, they are prepared by running alien against the source package, and against the debs. + +They may be downloaded from: + +_1 http://www.jus.uio.no/sisu/SiSU/download.html#rpm + +as root type: + +_1 rpm -i [rpm package name] + +3~ Installation from source + +To install SiSU from source check information at: + +_1 http://www.jus.uio.no/sisu/SiSU/download.html#current + +_* download the source package + +_* Unpack the source + +Two alternative modes of installation from source are provided, setup.rb (by Minero Aoki) and a rant(by Stefan Lang) built install file, in either case: the first steps are the same, download and unpack the source file: + +For basic use SiSU is only dependent on the programming language in which it is written Ruby, and SiSU will be able to generate html, various XMLs, including ODF (and will also produce LaTeX). Dependencies required for further actions, though it relies on the installation of additional dependencies which the source tarball does not take care of, for things like using a database (postgresql or sqlite)~{ There is nothing to stop MySQL support being added in future. }~ or converting LaTeX to pdf. + +!_ setup.rb + +This is a standard ruby installer, using setup.rb is a three step process. In the root directory of the unpacked SiSU as root type: + +code{ + + ruby setup.rb config + ruby setup.rb setup + #[and as root:] + ruby setup.rb install + +}code + +further information on setup.rb is available from: + +_1 http://i.loveruby.net/en/projects/setup/ + +_1 http://i.loveruby.net/en/projects/setup/doc/usage.html + +!_ "install" + +The "install" file provided is an installer prepared using "rant". In the root directory of the unpacked SiSU as root type: + +_1 ruby install base + +or for a more complete installation: + +_1 ruby install + +or + +_1 ruby install base + +This makes use of Rant (by Stefan Lang) and the provided Rantfile. It has been configured to do post installation setup setup configuration and generation of first test file. Note however, that additional external package dependencies, such as tetex-extra are not taken care of for you. + +Further information on "rant" is available from: + +_1 http://make.rubyforge.org/ + +_1 http://rubyforge.org/frs/?group_id=615 + +For a list of alternative actions you may type: + +_1 ruby install help + +_1 ruby install -T + +2~ Testing SiSU, generating output + +To check which version of sisu is installed: + +sisu -v + +Depending on your mode of installation one or a number of markup sample files may be found either in the directory: + +... + +or + +... + +change directory to the appropriate one: + +cd /usr/share/doc/sisu/sisu_markup_samples/dfsg + +3~ basic text, plaintext, html, XML, ODF + +Having moved to the directory that contains the markup samples (see instructions above if necessary), choose a file and run sisu against it + +sisu -NhwoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst + +this will generate html including a concordance file, opendocument text format, plaintext, XHTML and various forms of XML, and OpenDocument text + +3~ LaTeX / pdf + +Assuming a LaTeX engine such as tetex or texlive is installed with the required modules (done automatically on selection of sisu-pdf in Debian) + +Having moved to the directory that contains the markup samples (see instructions above if necessary), choose a file and run sisu against it + +sisu -pv free_as_in_freedom.rms_and_free_software.sam_williams.sst + +sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst + +should generate most available output formats: html including a concordance file, opendocument text format, plaintext, XHTML and various forms of XML, and OpenDocument text and pdf + +3~ relational database - postgresql, sqlite + +Relational databases need some setting up - you must have permission to create the database and write to it when you run sisu. + +Assuming you have the database installed and the requisite permissions + +sisu --sqlite --recreate + +sisu --sqlite -v --import free_as_in_freedom.rms_and_free_software.sam_williams.sst + +sisu --pgsql --recreate + +sisu --pgsql -v --import free_as_in_freedom.rms_and_free_software.sam_williams.sst + +2~ Getting Help + +3~ The man pages + +Type: + +_1 man sisu + +The man pages are also available online, though not always kept as up to date as within the package itself: + +_* {~^ sisu.1 }http://www.jus.uio.no/sisu/man/sisu.1 + +_* {~^ sisu.8 }http://www.jus.uio.no/sisu/man/sisu.8 + +_* {~^ man directory }http://www.jus.uio.no/sisu/man + +3~ Built in help + +sisu --help + +sisu --help --env + +sisu --help --commands + +sisu --help --markup + +3~ The home page + +http://www.jus.uio.no/sisu + +http://www.jus.uio.no/sisu/SiSU + +2~ Markup Samples + +A number of markup samples (along with output) are available off: + +http://www.jus.uio.no/sisu/SiSU/2.html + +Additional markup samples are packaged separately in the file: + +*** + +On Debian they are available in non-free~{ the Debian Free Software guidelines require that everything distributed within Debian can be changed - and the documents are authors' works that while freely distributable are not freely changeable. }~ to include them it is necessary to include non-free in your /etc/apt/source.list or obtain them from the sisu home site. diff --git a/data/doc/manuals_generated/sisu_manual/sisu_quickstart/sisupod.zip b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/sisupod.zip new file mode 100644 index 00000000..9a915a7e Binary files /dev/null and b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/sisupod.zip differ diff --git a/data/doc/manuals_generated/sisu_manual/sisu_quickstart/sitemap.xml b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/sitemap.xml new file mode 100644 index 00000000..048bc43f --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/sitemap.xml @@ -0,0 +1,30 @@ + + + + + + http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/toc.html + 2007-09-16 + monthly + 0.7 + + + http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/doc.html + 2007-09-16 + 0.5 + + + http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/sisu_manifest.html + 2007-09-16 + 0.5 + + diff --git a/data/doc/manuals_generated/sisu_manual/sisu_quickstart/toc.html b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/toc.html new file mode 100644 index 00000000..835f3182 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/toc.html @@ -0,0 +1,584 @@ + + + + + + SiSU - SiSU information Structuring Universe / Structured information, Serialized Units + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + +
    + +
    SiSU -->
    +    		 + + + + + + + + + + + + + + + +
    + + TOC linked  toc  + + + + + Full Text  scroll  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
    +    		 +   + next >> +   +
    +

    + +

    + +
    + + +
    + +

    SiSU - SiSU information Structuring Universe / Structured information, Serialized Units +

    + +

    Quickstart, installation and use +

    + +

    Ralph Amissah +

    + +copy @ + + SiSU + + +
    + + + +

    + SiSU - SiSU information Structuring Universe / Structured information, Serialized Units - Quickstart, installation and use,
    Ralph Amissah +

    + +

    + Quickstart - SiSU installation and use +

    + +

    + + 1. Quickstart - Getting Started Howto + +

    + +
    + + 1.1 Installation + +
    + +
    + + 1.1.1 Debian Installation + +
    + +
    + + 1.1.2 RPM Installation + +
    + +
    + + 1.1.3 Installation from source + +
    + +
    + + 1.2 Testing SiSU, generating output + +
    + +
    + + 1.2.1 basic text, plaintext, html, XML, ODF + +
    + +
    + + 1.2.2 LaTeX / pdf + +
    + +
    + + 1.2.3 relational database - postgresql, sqlite + +
    + +
    + + 1.3 Getting Help + +
    + +
    + + 1.3.1 The man pages + +
    + +
    + + 1.3.2 Built in help + +
    + +
    + + 1.3.3 The home page + +
    + +
    + + 1.4 Markup Samples + +
    + +

    + + Endnotes + +

    + +

    + Document Information (metadata) +

    + +

    Copyright ©  Ralph Amissah 2007, part of SiSU documentation, License GPL 3

    +

    + +

    + + + + + +
    + +
    SiSU -->
    +    		 + + + + + + + + + + + + + + + +
    + + TOC linked  toc  + + + + + Full Text  scroll  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
    +    		 +   + next >> +   +
    +

    + +

     

    + + + + + + + + +
    + +
    +

    + + SiSU + +

    +    		 + +

    + Output generated by + + SiSU + + 0.59.0 2007-09-23 (2007w38/0) +
    + + SiSU + + Copyright © Ralph Amissah + 1997, current 2007. + All Rights Reserved. +
    + + SiSU + + is software for document structuring, publishing and search, +
    + + www.jus.uio.no/sisu + + and + + www.sisudoc.org + +
    + w3 since October 3 1993 + + ralph@amissah.com + +

    +    		 +

    + SiSU using: +
    Standard SiSU markup syntax, +
    Standard SiSU meta-markup syntax, and the +
    Standard SiSU object citation numbering and system, (object/text positioning system) +
    + Copyright © Ralph Amissah 1997, current 2007. + All Rights Reserved. +

    +
    +

    + + GPLv3 + +

    +    		 +

    + + SiSU + + is released under + GPLv3 + or later, + <http://www.gnu.org/licenses/gpl.html> +

    +    		 +

    + SiSU, developed using + + Ruby + + on + + Debian/Gnu/Linux + + software infrastructure, + with the usual GPL (or OSS) suspects. +
    + Better - "performance, reliability, scalability, security & total cost of ownership" + [not to mention flexibility & choice] use of and adherence to open standards (where practical and fair) and it is software libre. +
    + Get With the Future + + Way Better! + +

    +
    + + + + + + + +
    + + + + + + -- cgit v1.2.3