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 --- data/doc/sisu/html/sisu_help.1.html | 212 ++++++++++++++++++++++++++++++++++++ 1 file changed, 212 insertions(+) create mode 100644 data/doc/sisu/html/sisu_help.1.html (limited to 'data/doc/sisu/html/sisu_help.1.html') diff --git a/data/doc/sisu/html/sisu_help.1.html b/data/doc/sisu/html/sisu_help.1.html new file mode 100644 index 00000000..98167e65 --- /dev/null +++ b/data/doc/sisu/html/sisu_help.1.html @@ -0,0 +1,212 @@ + + + + + +"sisu_help"("1") manual page + + +Table of Contents

+SISU - SISU INFORMATION STRUCTURING UNIVERSE - MANUAL  [0.58], RALPH AMISSAH + +

SISU HELP +

1. HELP +

1.1 SISU MANUAL +

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

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

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

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

or equivalent directory +

Within the SiSU tarball at: +

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

1.2 SISU MAN PAGES +

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

man sisu
+ +

man sisu_markup
+ +

man sisu_commands
+ +

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

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

Once installed, directory equivalent to: +

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

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

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

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

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

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

* various sisu man pages <http://www.jus.uio.no/sisu/man/ +> + [^2] +

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

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

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

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

1.3 + +

SISU BUILT-IN INTERACTIVE HELP +

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

sisu --help
+ +

sisu --help  [subject]
+ +

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

sisu -V  [same  as  above  command]
+ +

sisu --help commands
+ +

sisu --help markup
+ +

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

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

1.4 HELP SOURCES +

For lists of alternative help sources, +see: +

man page +

man sisu_help_sources
+ +

man2html +

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

sisu generated html +

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

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

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

DOCUMENT INFORMATION (METADATA) +

METADATA +

Document Manifest @ <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 01:13:57 +0100 2007 +

Generated by: SiSU 0.58.3 of +2007w36/4 (2007-09-06) +

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

+

    +.
  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. .
  2. <http://www.jus.uio.no/sisu/man/ +>
    3. .
  3. <http://www.jus.uio.no/sisu/man/sisu.1.html +>
    4. .
  4. <http://www.jus.uio.no/sisu/man/sisu.8.html +> +
    5. .
  5. <http://www.jus.uio.no/sisu/man/sisu_examples.1.html +>
    6. .
  6. <http://www.jus.uio.no/sisu/man/sisu_webrick.1.html +> + +

    + +

    Other versions of this document:
    +
    + +
    manifest: <http://www.jus.uio.no/sisu/sisu_help/sisu_manifest.html + +> +
    +
    + +
    html: <http://www.jus.uio.no/sisu/sisu_help/toc.html + +>
    +
    + +
    pdf: <http://www.jus.uio.no/sisu/sisu_help/portrait.pdf + +> +
    +
    + +
    pdf: <http://www.jus.uio.no/sisu/sisu_help/landscape.pdf + +>
    +
    + +
    at: <http://www.jus.uio.no/sisu + +> +
    +
    + +
    * Generated by: SiSU 0.58.3 of 2007w36/4 (2007-09-06)
    +
    + +
    * Ruby version: ruby +1.8.6 (2007-06-07 patchlevel 36) [i486-linux]
    +
    + +
    * Last Generated on: Sun Sep 23 +01:14:05 +0100 2007
    +
    + +
    * SiSU http://www.jus.uio.no/sisu +
    +
    + +

    + + -- cgit v1.2.3