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/plain.txt | 219 +++++++++++++++++++++ 1 file changed, 219 insertions(+) create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_skin/plain.txt (limited to 'data/doc/manuals_generated/sisu_manual/sisu_skin/plain.txt') diff --git a/data/doc/manuals_generated/sisu_manual/sisu_skin/plain.txt b/data/doc/manuals_generated/sisu_manual/sisu_skin/plain.txt new file mode 100644 index 00000000..52febd7e --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_skin/plain.txt @@ -0,0 +1,219 @@ +SISU - SKINS [0.58], +RALPH AMISSAH +*********************************** + +DOCUMENT SKINS - CONFIGURATION +============================== + +1. SKINS +-------- + +Skins modify the default appearance of document output on a document, +directory, or site wide basis. Skins are looked for in the following locations: + + + ./_sisu/skin + + + ~/.sisu/skin + + + /etc/sisu/skin + + +*Within the skin directory* are the following the default sub-directories for +document skins: + + + ./skin/doc + + + ./skin/dir + + + ./skin/site + + +A skin is placed in the appropriate directory and the file named skin_[name].rb + + +The skin itself is a ruby file which modifies the default appearances set in +the program. + + +1.1 DOCUMENT SKIN +................. + +Documents take on a document skin, if the header of the document specifies a +skin to be used. + + + + @skin: skin_united_nations + +1.2 DIRECTORY SKIN +.................. + +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). + + +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. + + +1.3 SITE SKIN +............. + +A site skin, modifies the program default skin. + + +1.4 SAMPLE SKINS +................ + +With *SiSU* installed sample skins may be found in: + + + /etc/sisu/skin/doc and + /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc + + +(or equivalent directory) and if sisu-markup-samples is installed also under: + + + /usr/share/doc/sisu/sisu_markup_samples/non-free/_sisu/skin/doc + + +Samples of list.yml and promo.yml (which are used to create the right column +list) may be found in: + + + /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml (or equivalent + directory) + + +DOCUMENT INFORMATION (METADATA) +******************************* + +METADATA +-------- + +Document Manifest @ + + + +*Dublin Core* (DC) + + +/DC tags included with this document are provided here./ + + +DC Title: _SiSU - Skins [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-11-12_ + + +DC Date issued: _2002-11-12_ + + +DC Date available: _2002-11-12_ + + +DC Date modified: _2007-09-16_ + + +DC Date: _2007-09-16_ + + +*Version Information* + + +Sourcefile: _sisu_skin.sst_ + + +Filetype: _SiSU text insert 0.58_ + + +Sourcefile Digest, MD5(sisu_skin.sst)= _3686b1b7864132c8d6ab3b0398d6e2ae_ + + +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:11:00 +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 - 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 + + + + + +============================================================================== +nil + +Other versions of this document: +manifest: + http://www.jus.uio.no/sisu/sisu_skin/sisu_manifest.html +html: + http://www.jus.uio.no/sisu/sisu_skin/toc.html +pdf: + http://www.jus.uio.no/sisu/sisu_skin/portrait.pdf + http://www.jus.uio.no/sisu/sisu_skin/landscape.pdf +plaintext (plain text): + http://www.jus.uio.no/sisu/sisu_skin/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:50 +0100 2007 +* SiSU http://www.jus.uio.no/sisu -- cgit v1.2.3