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/dom.xml | 679 +++++++++++++++++++++ 1 file changed, 679 insertions(+) create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_help/dom.xml (limited to 'data/doc/manuals_generated/sisu_manual/sisu_help/dom.xml') diff --git a/data/doc/manuals_generated/sisu_manual/sisu_help/dom.xml b/data/doc/manuals_generated/sisu_manual/sisu_help/dom.xml new file mode 100644 index 00000000..2f320827 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_help/dom.xml @@ -0,0 +1,679 @@ + + + + + + + + +
+ Title: + + SiSU - SiSU information Structuring Universe - Manual [0.58] + +
+ +
+ Creator: + + Ralph Amissah + +
+ +
+ Rights: + + Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +
+ +
+ Type: + + information + +
+ +
+ Subject: + + ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +
+ +
+ Date created: + + 2002-08-28 + +
+ +
+ Date issued: + + 2002-08-28 + +
+ +
+ Date available: + + 2002-08-28 + +
+ +
+ Date modified: + + 2007-08-30 + +
+ +
+ Date: + + 2007-08-30 + +
+ + + + + + + + + + + + + + 1 + SiSU - SiSU information Structuring Universe - Manual [0.58],
Ralph Amissah + + + + + + + 2 + SiSU Help + + + + + + + 3 + help + + 1. Help + + + + + + + + + + 4 + 1.1 + + 1.1 SiSU Manual + + + + + + + + 5 + + + The most up to date information on sisu should be contained in the sisu_manual, available at: + + + + + + + + 6 + + + <http://www.jus.uio.no/sisu/sisu_manual/> + + + + + + + + 7 + + + and (from SiSU 0.59 onwards) installed locally at: + + + + + + + + 8 + + + /usr/share/doc/sisu/sisu_manual/ + + + + + + + + 9 + + + or equivalent directory + + + + + + + + 10 + + + Within the SiSU tarball at: + + + + + + + + 11 + + + ./data/doc/sisu/sisu_manual/ + + + + + + + + + + + + 12 + 1.2 + + 1.2 SiSU man pages + + + + + + + + 13 + + + If SiSU is installed on your system usual man commands should be available, try: + + + + + + + + 14 + + + man sisu + + + + + + + + 15 + + + man sisu_markup + + + + + + + + 16 + + + man sisu_commands + + + + + + + + 17 + + + 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: + + + + + + + + 18 + + + ./data/doc/sisu/sisu_manual/ + + + + + + + + 19 + + + Once installed, directory equivalent to: + + + + + + + + 20 + + + /usr/share/doc/sisu/sisu_manual/ + + + + + + + + 21 + + + Available man pages are converted back to html using man2html: + + + + + + + + 22 + + + /usr/share/doc/sisu/html/ + + + + + + + + 23 + + + ./data/doc/sisu/html/ + + + + + + + + 24 + + + The SiSU man pages can be viewed online at:1generated 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> + + + + + + + + 25 + + + An online version of the sisu man page is available here: + + + + + + + + 26 + + + various sisu man pages 2<http://www.jus.uio.no/sisu/man/> + + + + + + + + 27 + + + sisu.1 3<http://www.jus.uio.no/sisu/man/sisu.1.html> + + + + + + + + 28 + + + sisu.8 4<http://www.jus.uio.no/sisu/man/sisu.8.html> + + + + + + + + 29 + + + sisu_examples.1 5<http://www.jus.uio.no/sisu/man/sisu_examples.1.html> + + + + + + + + 30 + + + sisu_webrick.1 6<http://www.jus.uio.no/sisu/man/sisu_webrick.1.html> + + + + + + + + + + + + 31 + 1.3 + + 1.3 SiSU built-in interactive help + + + + + + + + 32 + + + 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. + + + + + + + + 33 + + + sisu --help + + + + + + + + 34 + + + sisu --help [subject] + + + + + + + + 35 + + + sisu --help env [for feedback on the way your system is setup with regard to sisu] + + + + + + + + 36 + + + sisu -V [same as above command] + + + + + + + + 37 + + + sisu --help commands + + + + + + + + 38 + + + sisu --help markup + + + + + + + + 39 + + + 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). + + + + + + + + 40 + + + 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. + + + + + + + + + + + + 41 + 1.4 + + 1.4 Help Sources + + + + + + + + 42 + + + For lists of alternative help sources, see: + + + + + + + + 43 + + + man page + + + + + + + + 44 + + + man sisu_help_sources + + + + + + + + 45 + + + man2html + + + + + + + + 46 + + + /usr/share/doc/sisu/sisu_manual/sisu_help_sources/index.html + + + + + + + + 47 + + + sisu generated html + + + + + + + + 48 + + + /usr/share/doc/sisu/html/sisu_help_sources/index.html + + + + + + + + 49 + + + <http://sisudoc.org/sisu_manual/sisu_help_sources/index.html> + + + + + + + + 50 + + + <http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html> + + + + + + + + + + + + + + 0 + endnotes + + Endnotes + + + + + + + + + + + + + + + -- cgit v1.2.3