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/plain.txt | 305 +++++++++++++++++++++ 1 file changed, 305 insertions(+) create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_help/plain.txt (limited to 'data/doc/manuals_generated/sisu_manual/sisu_help/plain.txt') diff --git a/data/doc/manuals_generated/sisu_manual/sisu_help/plain.txt b/data/doc/manuals_generated/sisu_manual/sisu_help/plain.txt new file mode 100644 index 00000000..7f1a3537 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_help/plain.txt @@ -0,0 +1,305 @@ +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: + + + + + +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] + + +- [1]: generated from source using rman + +- + +- With regard to *SiSU* man pages the formatting generated for markup syntax is + not quite right, for that you might prefer the links under: + +- + +An online version of the sisu man page is available here: + + +* various sisu man pages [link:] [^2] + + +- [2]: + +* sisu.1 [link:] [^3] + + +- [3]: + +* sisu.8 [link:] [^4] + + +- [4]: + +* sisu_examples.1 [link:] +[^5] + + +- [5]: + +* sisu_webrick.1 [link:] +[^6] + + +- [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 + + + + + + + + +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 - 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]_ + + + +============================================================================== + + 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 + + + + + +============================================================================== +nil + +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 + http://www.jus.uio.no/sisu/sisu_help/landscape.pdf +plaintext (plain text): + http://www.jus.uio.no/sisu/sisu_help/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:49 +0100 2007 +* SiSU http://www.jus.uio.no/sisu -- cgit v1.2.3