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_configuration/config.html | 672 +++++++++++++++++++++ 1 file changed, 672 insertions(+) create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_configuration/config.html (limited to 'data/doc/manuals_generated/sisu_manual/sisu_configuration/config.html') diff --git a/data/doc/manuals_generated/sisu_manual/sisu_configuration/config.html b/data/doc/manuals_generated/sisu_manual/sisu_configuration/config.html new file mode 100644 index 00000000..96a1fd4f --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_configuration/config.html @@ -0,0 +1,672 @@ + + + + + + config - + SiSU + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ + + +

+ +

SiSU -->

+

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

+

+ + + A-Z + + +

+ +

+

+

+ + + + + + +

+

+

+ + + + +

+ SiSU +

+

+ Configuration [0.58] +

+

+ Ralph Amissah + +

+

+ copy @ + + SiSU + +

+ + +

+ +

+

+ 1 +

+

+ + +

+ +

+

+ 2 +

+

+ + +

+ +

+

+ + +

+

+ + 1. Configuration +

+

+

+ 3 +

+

+ + 1.1 Determining the Current Configuration + +

+ + 1.2 Configuration files (config.yml) + +

+ + +

+ +

+ 1.1 Determining the Current Configuration +

+

+ 4 +

+

+ + +

+

+ Information on the current configuration of SiSU should be available with the help command: +

+

+ 5 +

+

+ + +

+

+

+ 6 +

+

+ + +

+

+ which is an alias for: +

+

+ 7 +

+

+ + +

+

+ sisu --help env +

+

+ 8 +

+

+ + +

+

+ Either of these should be executed from within a directory that contains sisu markup source documents. +

+

+ 9 +

+

+ + +

+ +

+ 1.2 Configuration files (config.yml) +

+

+ 10 +

+

+ + +

+

+ SiSU configration parameters are adjusted in the configuration file, which can be used to override the defaults set. This includes such things as which directory interim processing should be done in and where the generated output should be placed. +

+

+ 11 +

+

+ + +

+

+ The SiSU configuration file is a yaml file, which means indentation is significant. +

+

+ 12 +

+

+ + +

+

+ SiSU resource configuration is determined by looking at the following files if they exist: +

+

+ 13 +

+

+ + +

+

+ ./_sisu/sisurc.yml +

+

+ 14 +

+

+ + +

+

+ ~/.sisu/sisurc.yml +

+

+ 15 +

+

+ + +

+

+ /etc/sisu/sisurc.yml +

+

+ 16 +

+

+ + +

+

+ The search is in the order listed, and the first one found is used. +

+

+ 17 +

+

+ + +

+

+ In the absence of instructions in any of these it falls back to the internal program defaults. +

+

+ 18 +

+

+ + +

+

+ Configuration determines the output and processing directories and the database access details. +

+

+ 19 +

+

+ + +

+

+ If SiSU is installed a sample sisurc.yml may be found in /etc/sisu/sisurc.yml +

+

+ 20 +

+

+ + + +

+ +

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