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_skin/dom.xml | 427 +++++++++++++++++++++ 1 file changed, 427 insertions(+) create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_skin/dom.xml (limited to 'data/doc/manuals_generated/sisu_manual/sisu_skin/dom.xml') diff --git a/data/doc/manuals_generated/sisu_manual/sisu_skin/dom.xml b/data/doc/manuals_generated/sisu_manual/sisu_skin/dom.xml new file mode 100644 index 00000000..f50261a5 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_skin/dom.xml @@ -0,0 +1,427 @@ + + + + + + + + +
+ Title: + + SiSU - Skins [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-11-12 + +
+ +
+ Date issued: + + 2002-11-12 + +
+ +
+ Date available: + + 2002-11-12 + +
+ +
+ Date modified: + + 2007-09-16 + +
+ +
+ Date: + + 2007-09-16 + +
+ + + + + + + + + + + + + + 1 + SiSU - Skins [0.58],
Ralph Amissah + + + + + + + 2 + Document Skins - configuration + + + + + + + 3 + skins + + 1. Skins + + + + + + + + 4 + + + Skins modify the default appearance of document output on a document, directory, or site wide basis. Skins are looked for in the following locations: + + + + + + + + 5 + + + ./_sisu/skin + + + + + + + + 6 + + + ~/.sisu/skin + + + + + + + + 7 + + + /etc/sisu/skin + + + + + + + + 8 + + + Within the skin directory are the following the default sub-directories for document skins: + + + + + + + + 9 + + + ./skin/doc + + + + + + + + 10 + + + ./skin/dir + + + + + + + + 11 + + + ./skin/site + + + + + + + + 12 + + + A skin is placed in the appropriate directory and the file named skin_[name].rb + + + + + + + + 13 + + + The skin itself is a ruby file which modifies the default appearances set in the program. + + + + + + + + + + 14 + 1.1 + + 1.1 Document Skin + + + + + + + + 15 + + + Documents take on a document skin, if the header of the document specifies a skin to be used. + + + + + + + + 16 + + + + +      @skin: skin_united_nations     + + + + + + + + + + + + + + 17 + 1.2 + + 1.2 Directory Skin + + + + + + + + 18 + + + A directory may be mapped on to a particular skin, so all documents within that directory take on a particular appearance. If a skin exists in the skin/dir with the same name as the document directory, it will automatically be used for each of the documents in that directory, (except where a document specifies the use of another skin, in the skin/doc directory). + + + + + + + + 19 + + + A personal habit is to place all skins within the doc directory, and symbolic links as needed from the site, or dir directories as required. + + + + + + + + + + + + 20 + 1.3 + + 1.3 Site Skin + + + + + + + + 21 + + + A site skin, modifies the program default skin. + + + + + + + + + + + + 22 + 1.4 + + 1.4 Sample Skins + + + + + + + + 23 + + + With SiSU installed sample skins may be found in: + + + + + + + + 24 + + + /etc/sisu/skin/doc and /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc + + + + + + + + 25 + + + (or equivalent directory) and if sisu-markup-samples is installed also under: + + + + + + + + 26 + + + /usr/share/doc/sisu/sisu_markup_samples/non-free/_sisu/skin/doc + + + + + + + + 27 + + + Samples of list.yml and promo.yml (which are used to create the right column list) may be found in: + + + + + + + + 28 + + + /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml (or equivalent directory) + + + + + + + + + + + + + + + + + + -- cgit v1.2.3