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_help/doc.html | 1448 ++++++++++++++++++++ 1 file changed, 1448 insertions(+) create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_help/doc.html (limited to 'data/doc/manuals_generated/sisu_manual/sisu_help/doc.html') diff --git a/data/doc/manuals_generated/sisu_manual/sisu_help/doc.html b/data/doc/manuals_generated/sisu_manual/sisu_help/doc.html new file mode 100644 index 00000000..9033f1eb --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_help/doc.html @@ -0,0 +1,1448 @@ + + + + + + SiSU - SiSU information Structuring Universe + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ +
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 +

+ +

Manual [0.58] +

+ +

Ralph Amissah +

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

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

+

+ +
+ +

+ SiSU - SiSU information Structuring Universe - Manual [0.58],
Ralph Amissah +

+ +

+ SiSU Help +

+ +

+ 1. Help +

+ +
+ 1.1 SiSU Manual +
+ +
+ 1.2 SiSU man pages +
+ +
+ 1.3 SiSU built-in interactive help +
+ +
+ 1.4 Help Sources +
+ +

+ +

+ +

+ Document Information (metadata) +

+ + + + +
+

+ + SiSU - SiSU information Structuring Universe - Manual [0.58],
Ralph Amissah +

+		 +

+   1 +

+
+ + + + +
+

+ + SiSU Help +

+		 +

+   2 +

+
+ + + + +
+

+ + 1. Help +

+		 +

+   3 +

+
+ + + + +
+
+ + 1.1 SiSU Manual +
+		 +

+   4 +

+
+ + + + +
+

+ The most up to date information on sisu should be contained in the sisu_manual, available at: +

+		 +

+   5 +

+
+ + + + +
+

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

+		 +

+   6 +

+
+ + + + +
+

+ and (from SiSU 0.59 onwards) installed locally at: +

+		 +

+   7 +

+
+ + + + +
+

+ /usr/share/doc/sisu/sisu_manual/ +

+		 +

+   8 +

+
+ + + + +
+

+ or equivalent directory +

+		 +

+   9 +

+
+ + + + +
+

+ Within the SiSU tarball at: +

+		 +

+   10 +

+
+ + + + +
+

+ ./data/doc/sisu/sisu_manual/ +

+		 +

+   11 +

+
+ + + + +
+
+ + 1.2 SiSU man pages +
+		 +

+   12 +

+
+ + + + +
+

+ If SiSU is installed on your system usual man commands should be available, try: +

+		 +

+   13 +

+
+ + + + +
+

+ man sisu +

+		 +

+   14 +

+
+ + + + +
+

+ man sisu_markup +

+		 +

+   15 +

+
+ + + + +
+

+ man sisu_commands +

+		 +

+   16 +

+
+ + + + +
+

+ Most SiSU man pages are generated directly from sisu documents that are used to prepare the sisu manual, the sources files for which are located within the SiSU tarball at: +

+		 +

+   17 +

+
+ + + + +
+

+ ./data/doc/sisu/sisu_manual/ +

+		 +

+   18 +

+
+ + + + +
+

+ Once installed, directory equivalent to: +

+		 +

+   19 +

+
+ + + + +
+

+ /usr/share/doc/sisu/sisu_manual/ +

+		 +

+   20 +

+
+ + + + +
+

+ Available man pages are converted back to html using man2html: +

+		 +

+   21 +

+
+ + + + +
+

+ /usr/share/doc/sisu/html/ +

+		 +

+   22 +

+
+ + + + +
+

+ ./data/doc/sisu/html/ +

+		 +

+   23 +

+
+ + + + +
+

+ The SiSU man pages can be viewed online at:  1  +

+		 +

+   24 +

+
+ + + + +
+

+ An online version of the sisu man page is available here: +

+		 +

+   25 +

+
+ + + + +
+
  • + various sisu man pages   2  +
    • +    		 +

    +   26 +

    +
    + + + + +
    +
  • + sisu.1   3  +
    • +    		 +

    +   27 +

    +
    + + + + +
    +
  • + sisu.8   4  +
    • +    		 +

    +   28 +

    +
    + + + + +
    +
  • + sisu_examples.1   5  +
    • +    		 +

    +   29 +

    +
    + + + + +
    +
  • + sisu_webrick.1   6  +
    • +    		 +

    +   30 +

    +
    + + + + +
    +
    + + 1.3 SiSU built-in interactive help +
    +    		 +

    +   31 +

    +
    + + + + +
    +

    + This is particularly useful when current installation information is obtained as the interactive help is able to provide information on your sisu configuration and setup. +

    +    		 +

    +   32 +

    +
    + + + + +
    +

    + sisu --help +

    +    		 +

    +   33 +

    +
    + + + + +
    +

    + sisu --help [subject] +

    +    		 +

    +   34 +

    +
    + + + + +
    +

    + sisu --help env [for feedback on the way your system is setup with regard to sisu] +

    +    		 +

    +   35 +

    +
    + + + + +
    +

    + sisu -V [same as above command] +

    +    		 +

    +   36 +

    +
    + + + + +
    +

    + sisu --help commands +

    +    		 +

    +   37 +

    +
    + + + + +
    +

    + sisu --help markup +

    +    		 +

    +   38 +

    +
    + + + + +
    +

    + Apart from real-time information on your current configuration the SiSU manual and man pages are likely to contain more up-to-date information than the sisu interactive help (for example on commands and markup). +

    +    		 +

    +   39 +

    +
    + + + + +
    +

    + NOTE: Running the command sisu (alone without any flags, filenames or wildcards) brings up the interactive help, as does any sisu command that is not recognised. Enter to escape. +

    +    		 +

    +   40 +

    +
    + + + + +
    +
    + + 1.4 Help Sources +
    +    		 +

    +   41 +

    +
    + + + + +
    +

    + For lists of alternative help sources, see: +

    +    		 +

    +   42 +

    +
    + + + + +
    +

    + man page +

    +    		 +

    +   43 +

    +
    + + + + +
    +

    + man sisu_help_sources +

    +    		 +

    +   44 +

    +
    + + + + +
    +

    + man2html +

    +    		 +

    +   45 +

    +
    + + + + +
    +

    + /usr/share/doc/sisu/sisu_manual/sisu_help_sources/index.html +

    +    		 +

    +   46 +

    +
    + + + + +
    +

    + sisu generated html +

    +    		 +

    +   47 +

    +
    + + + + +
    +

    + /usr/share/doc/sisu/html/sisu_help_sources/index.html +

    +    		 +

    +   48 +

    +
    + + + + +
    +

    + <http://sisudoc.org/sisu_manual/sisu_help_sources/index.html> +

    +    		 +

    +   49 +

    +
    + + + + +
    +

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

    +    		 +

    +   50 +

    +
    + + + + +
    +

    + + Endnotes +

    +    		 +

    +   0 +

    +
    + + + +
    + +

    +

    +

    		 +   +
    + + + + +
    +

    +  1. generated from source using rman
    <http://polyglotman.sourceforge.net/rman.html>
    With regard to SiSU man pages the formatting generated for markup syntax is not quite right, for that you might prefer the links under:
    <http://www.jus.uio.no/sample> +

    +    		 +   +
    + + + + +
    +

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

    +    		 +   +
    + + + + +
    +

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

    +    		 +   +
    + + + + +
    +

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

    +    		 +   +
    + + + + +
    +

    +  5. <http://www.jus.uio.no/sisu/man/sisu_examples.1.html> +

    +    		 +   +
    + + + + +
    +

    +  6. <http://www.jus.uio.no/sisu/man/sisu_webrick.1.html> +

    +    		 +   +
    + + + + +
    +

    + + Document Information (metadata) +

    +    		 +

    +   0 +

    +
    + +

    + Metadata +

    + + +     + + + + + +
    +

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

    		 +
    + + + +
    +

    + Dublin Core (DC) +

    		 +
    + + + +
    +

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

    		 +
    + + + +
    +

    + DC Title: SiSU - SiSU information Structuring Universe - Manual [0.58] +

    		 +
    + + + +
    +

    + DC Creator: Ralph Amissah +

    		 +
    + + + +
    +

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

    		 +
    + + + +
    +

    + DC Type: information +

    		 +
    + + + +
    +

    + DC Date created: 2002-08-28 +

    		 +
    + + + +
    +

    + DC Date issued: 2002-08-28 +

    		 +
    + + + +
    +

    + DC Date available: 2002-08-28 +

    		 +
    + + + +
    +

    + DC Date modified: 2007-08-30 +

    		 +
    + + + +
    +

    + DC Date: 2007-08-30 +

    		 +
    + + + +
    +

    + Version Information +

    		 +
    + + + +
    +

    + Sourcefile: sisu_help.sst +

    		 +
    + + + +
    +

    + Filetype: SiSU text 0.58 +

    		 +
    + + + +
    +

    + Sourcefile Digest, MD5(sisu_help.sst)= 387208846e53080b55b39cf92b70aaa9 +

    		 +
    + + + +
    +

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

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