aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_skin.sst
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2007-09-23 05:16:21 +0100
committerRalph Amissah <ralph@amissah.com>2007-09-23 05:16:21 +0100
commit50d45c6deb0afd2e4222d2e33a45487a9d1fa676 (patch)
tree100c62d678f009139999bf77c26c81653a721eeb /data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_skin.sst
parentsisu-0.58.3 + md5s (diff)
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
Diffstat (limited to 'data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_skin.sst')
-rw-r--r--data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_skin.sst106
1 files changed, 106 insertions, 0 deletions
diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_skin.sst b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_skin.sst
new file mode 100644
index 00000000..698a5241
--- /dev/null
+++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_skin.sst
@@ -0,0 +1,106 @@
+% SiSU insert 0.58
+
+@title: SiSU
+
+@subtitle: 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
+
+@level: new=C; break=1; num_top=1
+
+@skin: skin_sisu_manual
+
+@bold: /Gnu|Debian|Ruby|SiSU/
+
+@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/
+{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html
+{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU
+{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/
+{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/
+{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html
+{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html
+{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html
+{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/
+{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/
+
+% @rcs$
+
+:A~? @title @creator
+
+:B~? Document Skins - configuration
+
+1~skins Skins
+
+% .SH "SKINS \- document, directory and site 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:
+
+_1 ./_sisu/skin
+
+_1 ~/.sisu/skin
+
+_1 /etc/sisu/skin
+
+!_ Within the skin directory
+are the following the default sub-directories for document skins:
+
+_1 ./skin/doc
+
+_1 ./skin/dir
+
+_1 ./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.
+
+2~ Document Skin
+
+Documents take on a document skin, if the header of the document specifies a skin to be used.
+
+code{
+
+@skin: skin_united_nations
+
+}code
+
+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.
+
+2~ Site Skin
+
+A site skin, modifies the program default skin.
+
+2~ Sample Skins
+
+With SiSU installed sample skins may be found in:
+
+_1 /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:
+
+_1 /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:
+
+_1 /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml (or equivalent directory)
+