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

+ + + +

+ +

SiSU -->

+

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

+

+ + + A-Z + + +

+ +

+

+

+ + + + + + +

+

+

+ + + + +

+ SiSU - SiSU information Structuring Universe +

+

+ Manual [0.58] +

+

+ Ralph Amissah + +

+

+ copy @ + + SiSU + +

+ + +

+ +

+

+ 1 +

+

+ + +

+ +

+

+ 2 +

+

+ + +

+ +

+

+ + +

+

+ + 1. Help +

+

+

+ 3 +

+

+ + 1.1 SiSU Manual + +

+ + 1.2 SiSU man pages + +

+ + 1.3 SiSU built-in interactive help + +

+ + 1.4 Help Sources + +

+ + +

+ +

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

+

+ + +

+

+

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

+

+

+ 24 +

+

+ + +

+

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

+

+ 25 +

+

+ + +

+

+ various sisu man pages ² +

+

+

+ 26 +

+

+ + +

+

+

+

+ 27 +

+

+ + +

+

+

+

+ 28 +

+

+ + +

+

+ sisu_examples.1 ⁵ +

+

+

+ 29 +

+

+ + +

+

+ sisu_webrick.1 ⁶ +

+

+

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

+

+^

+ + +

+

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

+

+

+ + + +

+ +

SiSU -->

+

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

+

+ + + A-Z + + +

+ +

+

+

+ + + + + + +

+

+

+ + + + +

+ + + + + + + + +

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

+ + + + + +

+
+ + + +
+ +
+

+ + +SiSU manual + +

+ + + + +

SiSU introduction

+

+

+

SiSU configuration

+

+

SiSU help sources

+ +
+

+ + +SiSU + +

+ + + + +

What does SiSU do? Summary

+

SiSU Book Samples and Markup Examples

+

+

+

+

+

+

Wikipedia entry

+

+

Ruby Application Archive

+ + +

+ \ No newline at end of file -- cgit v1.2.3