aboutsummaryrefslogtreecommitdiffhomepage
path: root/man/man1/sisu_skin.1
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 /man/man1/sisu_skin.1
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 'man/man1/sisu_skin.1')
-rw-r--r--man/man1/sisu_skin.1222
1 files changed, 222 insertions, 0 deletions
diff --git a/man/man1/sisu_skin.1 b/man/man1/sisu_skin.1
new file mode 100644
index 00000000..eb6d825d
--- /dev/null
+++ b/man/man1/sisu_skin.1
@@ -0,0 +1,222 @@
+.TH "sisu_skin" "1" "2007-09-16" "0.58.3" "SiSU"
+.SH
+SISU \- SKINS \ [0.58],
+RALPH AMISSAH
+.BR
+
+.SH
+DOCUMENT SKINS \- CONFIGURATION
+.BR
+
+.SH
+1. SKINS
+.BR
+
+.BR
+Skins modify the default appearance of document output on a document,
+directory, or site wide basis. Skins are looked for in the following locations:
+
+.BR
+ ./_sisu/skin
+
+.BR
+ ~/.sisu/skin
+
+.BR
+ /etc/sisu/skin
+
+.BR
+.B Within the skin directory
+are the following the default sub\-directories for document skins:
+
+.BR
+ ./skin/doc
+
+.BR
+ ./skin/dir
+
+.BR
+ ./skin/site
+
+.BR
+A skin is placed in the appropriate directory and the file named skin_[name].rb
+
+.BR
+The skin itself is a ruby file which modifies the default appearances set in
+the program.
+
+.SH
+1.1 DOCUMENT SKIN
+
+.BR
+Documents take on a document skin, if the header of the document specifies a
+skin to be used.
+
+
+.nf
+ @skin: skin_united_nations
+.fi
+
+.SH
+1.2 DIRECTORY SKIN
+
+.BR
+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).
+
+.BR
+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.
+
+.SH
+1.3 SITE SKIN
+
+.BR
+A site skin, modifies the program default skin.
+
+.SH
+1.4 SAMPLE SKINS
+
+.BR
+With
+.B SiSU
+installed sample skins may be found in:
+
+.BR
+ /etc/sisu/skin/doc and
+ /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc
+
+.BR
+(or equivalent directory) and if sisu\-markup\-samples is installed also under:
+
+.BR
+ /usr/share/doc/sisu/sisu_markup_samples/non\-free/_sisu/skin/doc
+
+.BR
+Samples of list.yml and promo.yml (which are used to create the right column
+list) may be found in:
+
+.BR
+ /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml (or equivalent
+ directory)
+
+.SH
+DOCUMENT INFORMATION (METADATA)
+.BR
+
+.SH
+METADATA
+.BR
+
+.BR
+Document Manifest @
+<http://www.jus.uio.no/sisu/sisu_manual/sisu_skin/sisu_manifest.html>
+
+.BR
+.B Dublin Core
+(DC)
+
+.BR
+.I DC tags included with this document are provided here.
+
+.BR
+DC Title:
+.I SiSU \- Skins \ [0.58]
+
+.BR
+DC Creator:
+.I Ralph Amissah
+
+.BR
+DC Rights:
+.I Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL
+3
+
+.BR
+DC Type:
+.I information
+
+.BR
+DC Date created:
+.I 2002\-11\-12
+
+.BR
+DC Date issued:
+.I 2002\-11\-12
+
+.BR
+DC Date available:
+.I 2002\-11\-12
+
+.BR
+DC Date modified:
+.I 2007\-09\-16
+
+.BR
+DC Date:
+.I 2007\-09\-16
+
+.BR
+.B Version Information
+
+.BR
+Sourcefile:
+.I sisu_skin.sst
+
+.BR
+Filetype:
+.I SiSU text insert 0.58
+
+.BR
+Sourcefile Digest, MD5(sisu_skin.sst)=
+.I 3686b1b7864132c8d6ab3b0398d6e2ae
+
+.BR
+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)=
+.I 20fc43cf3eb6590bc3399a1aef65c5a9
+
+.BR
+.B Generated
+
+.BR
+Document (metaverse) last generated:
+.I Sun Sep 23 01:13:59 +0100 2007
+
+.BR
+Generated by:
+.I SiSU
+.I 0.58.3
+of 2007w36/4 (2007\-09\-06)
+
+.BR
+Ruby version:
+.I ruby 1.8.6 (2007\-06\-07 patchlevel 36) \ [i486\-linux]
+
+
+.TP
+Other versions of this document:
+.TP
+manifest: <http://www.jus.uio.no/sisu/sisu_skin/sisu_manifest.html>
+.TP
+html: <http://www.jus.uio.no/sisu/sisu_skin/toc.html>
+.TP
+pdf: <http://www.jus.uio.no/sisu/sisu_skin/portrait.pdf>
+.TP
+pdf: <http://www.jus.uio.no/sisu/sisu_skin/landscape.pdf>
+." .TP
+." manpage: http://www.jus.uio.no/sisu/sisu_skin/sisu_skin.1
+.TP
+at: <http://www.jus.uio.no/sisu>
+.TP
+.TP
+* Generated by: SiSU 0.58.3 of 2007w36/4 (2007-09-06)
+.TP
+* Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux]
+.TP
+* Last Generated on: Sun Sep 23 01:14:06 +0100 2007
+.TP
+* SiSU http://www.jus.uio.no/sisu