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_configuration/concordance.html | 661 +++++++++ .../sisu_manual/sisu_configuration/config.html | 672 +++++++++ .../sisu_manual/sisu_configuration/digest.txt | 154 ++ .../sisu_manual/sisu_configuration/doc.html | 1531 ++++++++++++++++++++ .../sisu_manual/sisu_configuration/dom.xml | 795 ++++++++++ .../sisu_manual/sisu_configuration/home.html | 614 ++++++++ .../sisu_manual/sisu_configuration/index.html | 564 +++++++ .../sisu_manual/sisu_configuration/landscape.pdf | Bin 0 -> 109404 bytes .../sisu_manual/sisu_configuration/metadata.html | 590 ++++++++ .../sisu_configuration/opendocument.odt | Bin 0 -> 10037 bytes .../sisu_manual/sisu_configuration/plain.txt | 349 +++++ .../sisu_manual/sisu_configuration/portrait.pdf | Bin 0 -> 111064 bytes .../sisu_manual/sisu_configuration/sax.xml | 466 ++++++ .../sisu_manual/sisu_configuration/scroll.xhtml | 467 ++++++ .../sisu_configuration/sisu_manifest.html | 198 +++ .../sisu_manual/sisu_configuration/sisupod.zip | Bin 0 -> 7642 bytes .../sisu_manual/sisu_configuration/sitemap.xml | 30 + .../sisu_manual/sisu_configuration/skins.html | 778 ++++++++++ .../sisu_manual/sisu_configuration/toc.html | 564 +++++++ 19 files changed, 8433 insertions(+) create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_configuration/concordance.html create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_configuration/config.html create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_configuration/digest.txt create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_configuration/doc.html create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_configuration/dom.xml create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_configuration/home.html create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_configuration/index.html create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_configuration/landscape.pdf create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_configuration/metadata.html create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_configuration/opendocument.odt create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_configuration/plain.txt create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_configuration/portrait.pdf create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_configuration/sax.xml create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_configuration/scroll.xhtml create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_configuration/sisu_manifest.html create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_configuration/sisupod.zip create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_configuration/sitemap.xml create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_configuration/skins.html create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_configuration/toc.html (limited to 'data/doc/manuals_generated/sisu_manual/sisu_configuration') diff --git a/data/doc/manuals_generated/sisu_manual/sisu_configuration/concordance.html b/data/doc/manuals_generated/sisu_manual/sisu_configuration/concordance.html new file mode 100644 index 00000000..0263bab9 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_configuration/concordance.html @@ -0,0 +1,661 @@ + + + + + SiSU created WordIndex for: SiSU - Configuration [0.58] + + + + + + + + + + + + + + + + +
+ +
SiSU -->
+		 + + + + + + + + + + + + + + +
+ + + TOC linked  toc  + + + + + + Full Text  scroll  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
+		 +   + TOC +   +
+

+
 

SiSU - Configuration [0.58]

Ralph Amissah

+ +

Word index links are to html versions of the text the segmented version followed by the scroll (single document) version.
[For segmented text references [T1], [T2] or [T3] appearing without a link, indicates that the word appears in a title (or subtitle) of the text (that is identifiable by the appended object citation number).]

+

(The word listing/index is Case sensitive: Capitalized words appear before lower case)

+

+ word (number of occurences)
linked references to word within document
+ [if number of occurences exceed number of references - word occurs more than once in at least one reference. Footnote/endnotes are either assigned to the paragraph from which they are referenced or ignored, so it is relevant to check the footnotes referenced from within a paragraph as well.] +

+

+ (After the page is fully loaded) you can jump directly to a word by appending a hash (#) and the word to the url for this text, (do not forget that words are case sensitive, and may be listed twice (starting with and without an upper case letter)), #your_word # [ http://[web host]/sisu_configuration/concordance.html#your_word ] +

+ +

Ability

(1)

+

49,

+

About

(1)

+

49,

+

Absence

(1)

+

18,

+

Access

(1)

+

19,

+

Accurately

(1)

+

49,

+

Adjusted

(1)

+

11,

+

Alias

(1)

+

7,

+

All

(2)

+

37, 38,

+

Also

(1)

+

44,

+

Amissah

(1)

+

[H]1,

+

And

(16)

+

11, 17, 19, 31, 38, 43, 44, 46, 49, 50, 52, 53, 58,

+

Another

(1)

+

37,

+

Any

(2)

+

18, 54,

+

Appearance

(2)

+

23, 37,

+

Appearances

(1)

+

32,

+

Appropriate

(2)

+

31, 49,

+

Are

(11)

+

11, 23, 27, 46, 49, 52, 54, 57,

+

Auto

(1)

+

49,

+

Automatically

(1)

+

37,

+

Available

(1)

+

5,

+

Back

(1)

+

18,

+

Basically

(1)

+

57,

+

Basis

(1)

+

23,

+

Become

(2)

+

58, 59,

+

Being

(2)

+

49, 50,

+

Built

(4)

+

49, 50, 53, 54,

+

But

(1)

+

57,

+

Can

(2)

+

11, 52,

+

Change

(1)

+

57,

+

Class

(1)

+

59,

+

Column

(1)

+

46,

+

Command

(2)

+

5, 54,

+

Config

(2)

+

3, 10,

+

Configration

(1)

+

11,

+

Configuration

(14)

+

[H]1, [H]2, 3, 4, 5, 10, 11, 12, 13, 19, [H]21, 49, 54,

+

Contained

(1)

+

52,

+

Contains

(1)

+

9,

+

Content

(2)

+

52, 59,

+

Contents

(1)

+

57,

+

Convenient

(1)

+

50,

+

Copied

(1)

+

54,

+

Create

(1)

+

46,

+

Created

(1)

+

49,

+

Current

(2)

+

4, 5,

+

Custom

(4)

+

49, 50, 53, 54,

+

Database

(1)

+

19,

+

Def

(1)

+

59,

+

Default

(5)

+

23, 27, 32, 40, 49,

+

Defaults

(3)

+

11, 18, 57,

+

Described

(1)

+

57,

+

Details

(1)

+

19,

+

Determined

(1)

+

13,

+

Determines

(1)

+

19,

+

Determining

(1)

+

4,

+

Dfsg

(2)

+

43, 47,

+

Dir

(4)

+

29, 37, 38, 58,

+

Directories

(5)

+

19, 27, 38, 52, 57,

+

Directory

(24)

+

9, 11, 23, 27, 31, 36, 37, 38, 44, 47, 52, 53, 54, 58,

+

Doc

(9)

+

28, 37, 38, 43, 45, 47,

+

Document

(9)

+

23, 27, 33, 34, 37, 52,

+

Documents

(9)

+

9, [H]21, 34, 37, 49, 50, 57, 58,

+

Done

(1)

+

11,

+

Each

(2)

+

37, 52,

+

Easier

(1)

+

50,

+

Either

(1)

+

9,

+

End

(2)

+

59,

+

Env

(1)

+

8,

+

Environment

(1)

+

[H]2,

+

Equivalent

(2)

+

44, 47,

+

Etc

(5)

+

16, 20, 26, 43, 54,

+

Except

(1)

+

37,

+

Executed

(1)

+

9,

+

Exist

(1)

+

13,

+

Exists

(1)

+

37,

+

Falls

(1)

+

18,

+

File

(6)

+

11, 12, 31, 32, 57,

+

Files

(2)

+

10, 13,

+

First

(1)

+

17,

+

Following

(3)

+

13, 23, 27,

+

For

(8)

+

7, 23, 27, 37, 49, 54, 57, 58,

+

Found

(4)

+

17, 20, 42, 46,

+

Free

(1)

+

45,

+

From

(3)

+

9, 38, 54,

+

Generate

(1)

+

49,

+

Generated

(1)

+

11,

+

Habit

(1)

+

38,

+

Has

(1)

+

49,

+

Have

(3)

+

52, 58,

+

Header

(1)

+

34,

+

Help

(2)

+

5, 8,

+

Here

(1)

+

59,

+

HOME

(2)

+

59,

+

Home

(13)

+

48, 49, 50, 51, 53, 54, 56, 58, 59,

+

Homepage

(6)

+

52, 58, 59,

+

Homepages

(1)

+

48,

+

Html

(3)

+

54, 59,

+

Includes

(1)

+

11,

+

Including

(1)

+

54,

+

Indentation

(1)

+

12,

+

Index

(2)

+

54, 59,

+

Individual

(1)

+

57,

+

Information

(1)

+

5,

+

Installed

(3)

+

20, 42, 44,

+

Instead

(1)

+

49,

+

Instructions

(1)

+

18,

+

Interim

(1)

+

11,

+

Internal

(1)

+

18,

+

Items

(1)

+

49,

+

Its

(1)

+

52,

+

Itself

(1)

+

32,

+

Language

(1)

+

57,

+

Law

(1)

+

58,

+

Links

(1)

+

38,

+

List

(2)

+

46,

+

Listed

(1)

+

17,

+

Locations

(2)

+

23, 54,

+

Looked

(1)

+

23,

+

Looking

(1)

+

13,

+

Mapped

(1)

+

37,

+

Markup

(2)

+

9, 44,

+

May

(6)

+

20, 37, 42, 46, 54, 57,

+

Means

(2)

+

12, 49,

+

Modified

(1)

+

58,

+

Modifies

(2)

+

32, 40,

+

Modify

(1)

+

23,

+

More

(2)

+

49, 50,

+

Name

(3)

+

31, 37, 58,

+

Named

(1)

+

31,

+

Namely

(1)

+

54,

+

Nbsp

(50)

+

35, 59,

+

Needed

(1)

+

38,

+

New

(1)

+

59,

+

Non

(1)

+

45,

+

Not

(2)

+

49,

+

One

(2)

+

17, 49,

+

Option

(1)

+

50,

+

Order

(1)

+

17,

+

Organisation

(1)

+

52,

+

Organised

(1)

+

52,

+

Other

(3)

+

49, 50, 53,

+

Output

(4)

+

11, 19, 23, 54,

+

Override

(1)

+

11,

+

Own

(2)

+

49, 52,

+

Page

(8)

+

49, 50, 51, 53, 54, 56, 58,

+

Pages

(3)

+

49, 53, 54,

+

Parameters

(1)

+

11,

+

Part

(1)

+

49,

+

Particular

(2)

+

37,

+

Personal

(1)

+

38,

+

Place

(2)

+

38, 59,

+

Placed

(3)

+

11, 31, 54,

+

Placing

(1)

+

50,

+

Poems

(1)

+

58,

+

Probably

(1)

+

50,

+

Processing

(2)

+

11, 19,

+

Program

(3)

+

18, 32, 40,

+

Programming

(1)

+

57,

+

Promo

(1)

+

46,

+

Provide

(2)

+

49, 58,

+

Provided

(2)

+

57,

+

Providing

(1)

+

51,

+

Ralph

(1)

+

[H]1,

+

Regarded

(1)

+

49,

+

Required

(1)

+

38,

+

Resource

(1)

+

13,

+

Respect

(1)

+

57,

+

Right

(1)

+

46,

+

Root

(1)

+

54,

+

Ruby

(2)

+

32, 57,

+

Same

(1)

+

37,

+

Sample

(3)

+

20, 41, 42,

+

Samples

(2)

+

44, 46,

+

Search

(1)

+

17,

+

Searched

(1)

+

54,

+

Section

(2)

+

52, 57,

+

See

(1)

+

52,

+

Separate

(1)

+

57,

+

Set

(2)

+

11, 32,

+

Sets

(1)

+

52,

+

Share

(3)

+

43, 45, 47,

+

Should

(6)

+

5, 9, 11, 52, 58,

+

Significant

(1)

+

12,

+

SiSU

(10)

+

[H]1, 5, 11, 12, 13, 20, 42, 49,

+

Sisu

(16)

+

6, 8, 9, 15, 16, 20, 25, 26, 43, 44, 45, 47, 54, 55, 57,

+

Sisurc

(5)

+

14, 15, 16, 20,

+

Site

(8)

+

23, 30, 38, 39, 40, 49, 52, 57,

+

Sites

(1)

+

49,

+

Skin

(31)

+

24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 39, 40, 43, 45, 47, 51, 56, 58,

+

Skin_

(1)

+

31,

+

Skins

(9)

+

22, 23, 27, 38, 41, 42, 57,

+

Source

(1)

+

9,

+

Specifies

(2)

+

34, 37,

+

Structure

(1)

+

52,

+

Sub

(2)

+

27, 53,

+

Subdirectory

(1)

+

50,

+

Subject

(1)

+

52,

+

Such

(1)

+

11,

+

Symbolic

(1)

+

38,

+

Take

(2)

+

34, 37,

+

That

(6)

+

9, 37, 54, 57,

+

The

(61)

+

4, 5, 11, 12, 13, 17, 18, 19, 23, 27, 31, 32, 34, 37, 38, 40, 46, 49, 50, 51, 52, 54, 57, 58, 59,

+

There

(1)

+

54,

+

These

(3)

+

9, 18, 49,

+

They

(2)

+

13, 54,

+

Things

(1)

+

11,

+

This

(4)

+

11, 50, 59,

+

Through

(2)

+

50, 51,

+

Two

(1)

+

49,

+

Under

(1)

+

44,

+

Use

(2)

+

37, 49,

+

Used

(5)

+

11, 17, 34, 37, 46,

+

Usr

(3)

+

43, 45, 47,

+

Usually

(1)

+

52,

+

Want

(1)

+

51,

+

Ways

(1)

+

49,

+

What

(1)

+

51,

+

Where

(2)

+

11, 37,

+

Which

(8)

+

7, 11, 12, 32, 46, 49, 58,

+

Wide

(1)

+

23,

+

Will

(3)

+

37, 49, 59,

+

Wish

(1)

+

58,

+

With

(7)

+

5, 37, 42, 49, 54, 57,

+

Within

(7)

+

9, 27, 37, 38, 54, 56, 58,

+

Would

(1)

+

58,

+

Written

(1)

+

57,

+

Yaml

(1)

+

12,

+

Yml

(9)

+

10, 14, 15, 16, 20, 46, 47,

+

You

(2)

+

51, 58,

+

Your

(3)

+

49, 50, 59,

+ + + + + + +
+ +
+

+ + SiSU + +

+		 + +

+ 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. +

+
+

+ + GPLv3 + +

+		 +

+ + 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! + +

+
+ \ No newline at end of file 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 -->
+		 + + + + + + + + + + + + + + + + + +
+ + + TOC linked  toc  + + + + + + Full Text  scroll  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
+		 + + + + + + +
+ + TOC + + + + next >> + + +
+
+ + + + +
+ + < + + + + ^ + + + + > + +

+ SiSU +

+

+ Configuration [0.58] +

+

+ Ralph Amissah + +

+

+ copy @ + + SiSU + +

+ + +
+

+ SiSU - Configuration [0.58],
Ralph Amissah +

+		   +

+   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 +

+
+ + +
+

+ sisu -v +

+		 +

+   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 -->
+		 + + + + + + + + + + + + + + + + + +
+ + + TOC linked  toc  + + + + + + Full Text  scroll  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
+		 + + + + + + +
+ + TOC + + + + next >> + + +
+
+ + + + +
+ + < + + + + ^ + + + + > + +

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

+ + SiSU + +

+		 + +

+ 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. +

+
+

+ + GPLv3 + +

+		 +

+ + 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! + +

+
+ + + + + +
+
+ + +
+ + +
+ + + + idx + txt + + +
+
+ +
+

+ + +SiSU manual + +

+ + + + +

SiSU introduction

+

SiSU commands

+

SiSU markup

+

SiSU configuration

+

SiSU help

+

SiSU help sources

+ +
+

+ + +SiSU + +

+ + + + +

What does SiSU do? Summary

+

SiSU Book Samples and Markup Examples

+

Markup

+

Commands

+

Manual

+

SiSU Download

+

SiSU Changelog

+

Wikipedia entry

+

Freshmeat

+

Ruby Application Archive

+ + +
+ \ No newline at end of file diff --git a/data/doc/manuals_generated/sisu_manual/sisu_configuration/digest.txt b/data/doc/manuals_generated/sisu_manual/sisu_configuration/digest.txt new file mode 100644 index 00000000..bb65bf1f --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_configuration/digest.txt @@ -0,0 +1,154 @@ +SiSU - Configuration [0.58] +Ralph Amissah +sisu_configuration._sst +---------------------------------------------- +SiSU Document Content Certificate (Digest/DCC) +---------------------------------------------- + md5 digests +------------ +Sourcefile digest: + source filename: +available outputs: http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/sisu_manifest.html + time generated: Sun Sep 23 04:11:03 +0100 2007 + SiSU version used: SiSU 0.59.0 of 2007w38/0 (2007-09-23) + Ruby version used: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux] +------------ +Document Digest Tree (from dal): +level (if any), ocn: digest clean (no markup/notes), digest all (includes markup & endnotes) + [endnote number] endnote digest clean + + :A - 1 dddbbd57638fe3ed09a7b2b2154f5d91 03d46288faa5b2fda4a39333b030639e + :B - 2 32bbefad07af496b39093f2a476f9d1b 8c960d15fa2c75e23e67b89db37a8aad + 1 - 3 22d0275be531ac07899711ced409ab0d 9323cb645dc212abfe1210c1cc600dc1 + 2 - 4 57e95da01b4621e1e584e40a9a543023 c60127fe336d27ed994d0dc3573d03c1 + - 5 7031c47d99c6b3341db2b63f5f15546a 798c5b6a02c26d0f92838839974ee6e5 + - 6 f5a15c0dcebdec6614428fe6283c3c31 858d04001754705020dab690cb7e91f4 + - 7 45b9aaab90e4c6a7541e972583b671e5 b77ba7c30530c1a5c9b418b80d4552b1 + - 8 381c2f35eae6cb74b0c43020448509b6 50c81a01439cb1c7e8f3eac6b3397a64 + - 9 0935e6507fb15fa609295313ec2e327b d3493dbe996fe362b007e5ee2fbfc6ce + 2 - 10 4488a07ebc34097c5e12ac1af6e1bb3c b1615085feb31082679047d0bb4d2819 + - 11 a480d3d8eae29b93b867c3aed186b64b d2baae2f8d989eecb08ff5b3c6245a37 + - 12 58682f1d364cf77d54287ff977cecc46 4acb943845ddbde86390480d82d8573b + - 13 c5e8b7b40dbe4b908826973cd4e92b87 2b90eb86e82be65519cb268f285c9565 + - 14 9324bf042690f50300ccf2519b58e934 e21684b154db6f6c3c28e2c735202eab + - 15 b997c81d514435422abb475a142794fb 0069efa838ea2a54bcfc69c087070ad3 + - 16 0c36556eeff8ebecea318e6d95b5bc24 4a1e19cc49ec5bbc97465501ac62469b + - 17 d154aac751e241764c0a71b086a61785 6445c4dd307e1b43490a8d3cc907722a + - 18 743c0ed3138510cbfeb4680fe8b6a937 817ae0e552802bcb9ffdc3977d7cb059 + - 19 bb5ddf2f4d0843e5b7067c3f727f334b 0250b8ccab8e2f2f92fcd4fae6fc3581 + - 20 3a362dd7b46f3b3d40ee22936dcb1242 6b83fc9f2f6a1e340c4569a8edaa0826 + :B - 21 249d9e1e7cac41ad2f2af834b0ab6690 07595815323c6125fb5fa761ea5e4eb8 + 1 - 22 0e15148ce832dc96f88cc8eb39da1ece dcfa893284385680706d9fc612140134 + - 23 6878448dc1c0e6c6f3ccb219cbb86806 a779e6f3eb749c4b6b1030f57ac891d6 + - 24 df6f62ea022d4c99f64c155896674414 4b2346c15a43fb37b3df1ab507973a67 + - 25 14eeec8fb5906471eaea61988216495b 6669079620d24c8af242d50676e27820 + - 26 c468f83345165d07e650aa02e4366759 c066eebf16dd0259ce6f5e2ac9f67579 + - 27 bd25d8e5af86cf018199da66d8f3819d e5ae57bd4bab752bd51d7c3872b9b02a + - 28 51166c2586e3a84b7e6b5583db340af6 6f877c30b1cd392e1d9948deb905fb73 + - 29 c96532777102f2a2277bcb87d0d4a8c3 d14b1a0db1efb7443f5a2cb4c7d6eafd + - 30 30e7a18aa30d9e84fc5b60140da0bca3 b317c675c336939fb3256e05e0c7864f + - 31 a3a68a27e5a67327a525ab26cfeab510 63fb78f7f6eeb14b2de6a6c2a494287b + - 32 7b63992c00b1ebd52bc7bc20d3dd2f68 9bf1e0f9f8fe998f735ea3651fc51c10 + 2 - 33 7a0841788265ceea0b8d30b250df7ff1 0c156421f61c8928d0f7236be9076efd + - 34 a0e28d8893526b2911d7f80802813e3d d5fe8c5755e1620d69af096d40b62a2c + - 35 d0c204e8b354b5ae4315603941a1dde4 e9f766354b9dad2e37004135ad2bcfaf + 2 - 36 06926bceee00f17571b24a7c284a808a fec0187e0d5bdb4cb400e4ae8ec7b07b + - 37 27e640cd901f817db252fed4f8f25139 e60eadd096a1e59b8c81730990bf3701 + - 38 39b0b0394c2bc31a21d9ae44d9fd8399 442626d5489660220383733bc7c2f2e9 + 2 - 39 6933699e08b267c85821dc3d70b76cfb b988098fd97b9c4463c5ea7d3bdb687b + - 40 c782692bc6f62ca8481f2747bfafdedc 36d45584c292c1dc0d95ea4ae27621c2 + 2 - 41 8be11b546c360a151f8839f93f49c789 a6cc90366ad17e382e6646ac3d94fddc + - 42 35b54affe61bb54b77a77920b4aa6013 354040e3ecb1641700357b7a1fb6f9eb + - 43 336af649f6ac24a87d70564a1f069f3e 6a5822b08a9b5644c30c43e339d757c1 + - 44 f674d46fde77f3e513e28e97f484f6b7 a8f3bfbbe4fae85c9e2a2b44d6314604 + - 45 60f7dacb2394d60f2cfc5437a3c2bbe7 801e8c50d1fbabf824570daa4fa29f63 + - 46 9568107b039118d1bcd7a7fa45f74e41 daa1c1a8ca17af3108794a755bea9457 + - 47 f258ffa3857217ec9af7c8c0e9e5ed0f 71173759b2debc96c08b15a74a5863b8 + 1 - 48 84932e4b584dd7fca7c3eda5d2dd4292 317c5813d9b591aa7023c87df438b058 + - 49 b9c622c60bca9847f6367c6fe497d1ca 9051256ee45b8a16af72d850d7d2c4f7 + - 50 d3689733ae5cd8442be918eb4c619ebd 085e962b4348c28de9faa8db5a018110 + - 51 193243a1b426247d91b3bd2b8366fc3c a8489e4abc848247029da7be3effea3d + - 52 50d58e1e478ee84a44198332a387b34a cddaf6cfa6f609ea1fd2115ee031f4ae + 2 - 53 c0bfeb3f6857c9dfef953c4874cb1600 6675483bc43cf5540a73788f30939876 + - 54 8f3c722ec214d347101b78aa9a65861e 70ff7be48718227c96ec18fff9d94a67 + - 55 b8e2965a84b2054fc80eaa48914af667 b5378f335caaee1849d0abcdb97b3a67 + 2 - 56 c965e2f2f559b237d595b4d886dc11d5 fba8ae085de94c10e41ad13dfcadfe0f + - 57 0b676112a62ec7e9a5a7233a8cd5c4af fff7d4b09d02caad9f2e0cedec90cc43 + - 58 1bc0a3755cd0161510a852a563ed0ee6 e87762e5896efed304688b937357efbb + - 59 7142bf94d96482106a5e0a6f3c8b31c2 70a1ac6c29fa3ae2c7a499ec112c0e52 + :A - 0 5b23a6f796c80555992b9b68cfdbc2bb 5fbbfb7933004e25553d56929ed7e545 + 1 - 0 ce21470ab49d1d1976bc3dc72438c183 f2709633c4c07e46bf6aeef624e8a736 + - 0 03c6368c6ae870ab6be464cf569dbb7f 54f9017543682015dcf53378e8c34708 + + - 0 3bca2a5af45d3d764dd73c03690cd66e ac56056f12b17cdaf50a68e61c70c01e + + - 0 ebd0aa03a5f7fa6f0e2d38b9676fb155 6f43d92a036c9944794c8582322b5875 + +dc title - 0 634264dbe92fa1fdfcdba109ef8edfcc 70d5ad642b51c8bfd6ea2839d9ed1f36 + +dc creator - 0 0679b0c2bbba4dc8a8eea763236c903f e64313bcf0600cea90bc0935c74877cc + +dc rights - 0 a96b616963450ca7ae751850a8f648fe 0aeceeeee2441bea626413070c4a0772 + +dc type - 0 7ff1b8f5fc0daaa20ab922214e3a045c ff73c0e3a5d9de30b22e26cd2ad33690 + +dc date created - 0 cb35879552fc1bf1b910d906c181a1c0 449aac6b2dc0ececc07a37d174561d31 + +dc date issued - 0 73eb6864ff85079ef9dd3a08e07d320a c71b78ab67a35af417f840927614569a + +dc date available - 0 03e622c14574e7cb72181336c8dd5b80 47e1c2418a1bb656552bee2f71208748 + +dc date modified - 0 a76d080f6129a423c6df9e494182464c 226f36d6861bb817387c603c5729a31e + +dc date - 0 813710616a3b633ca5d9096fa68a5cc8 d394bfc8003f9fa9e3260aad421295a2 + + - 0 9d11e23779d9604067dd20e359117573 3f883fb08147a237efaeb152bfaaa1ee + +sourcefile - 0 320244b35a4f74b345727bda0fe8f55e 1d9a6b52b0b7058bb3ec255ff18958fa + + - 0 ec09d0bf690f922c3eccf2e4fbece1eb b7bc31947a219c2bf960290037e709d0 + + - 0 9a046b43732ddd7ceca4b23e6ebb2f7b 7b1152223abe849546144ace04231ba5 + source 2a18ae8bbfec534c6e064d666ffbe20d sisu_configuration._sst + + - 0 b57a2a5f0948b054d5b755c5b93cbdd6 94dcd9e8be6ede945e89ef2ae152fa9a + skin 20fc43cf3eb6590bc3399a1aef65c5a9 skin_sisu_manual.rb + + - 0 5c5f06440fcb85cd5c8cfafe32e34b78 d8f5595da03dd0c38d62b56492f5eb0f + +document (metaverse) last generated - 0 ed1be887547024e0ce43f6e8bf850a56 e7ad95602907b2d064add9cf76d2efb7 + +generated by - 0 96f99dc6b8b2209e22e49bcdbb9e0497 1533ff37a88b9cb74747383c1a8b8598 + +ruby version - 0 37cf2ede6f4722230340c84e2753e412 4ccb32a8ff87fa8b6600884d16e2d685 +------------ +document structure[*] +:A + :B + 1 + 2 + 2 + :B + 1 + 2 + 2 + 2 + 2 + 1 + 2 + 2 +:A + 1 + [*] heading levels +------------ +document structure[*] +@ = 15 +:A = 2 +:B = 2 +1 = 4 +2 = 8 +objects (ocn) = 59 +endnotes = + [*] number of headers (@) and of each heading level (:A to :C and 1 to 3) +------------ +Note: the time generated related fields (text and digests) will vary between otherwise identical document outputs diff --git a/data/doc/manuals_generated/sisu_manual/sisu_configuration/doc.html b/data/doc/manuals_generated/sisu_manual/sisu_configuration/doc.html new file mode 100644 index 00000000..17e80525 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_configuration/doc.html @@ -0,0 +1,1531 @@ + + + + + + SiSU + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ +
SiSU -->
+		 + + + + + + + + + + + + + + + +
+ + Full Text  scroll  + + + + + TOC linked  toc  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
+		 +   +
+

+ +

+ +
+ + +
+ +

SiSU +

+ +

Configuration [0.58] +

+ +

Ralph Amissah +

+ +copy @ + + SiSU + + +
+ + + +

Ralph Amissah

+

+ +
+ +

+ SiSU - Configuration [0.58],
Ralph Amissah +

+ +

+ Configuration of Environment +

+ +

+ 1. Configuration +

+ +
+ 1.1 Determining the Current Configuration +
+ +
+ 1.2 Configuration files (config.yml) +
+ +

+ Configuration of Documents +

+ +

+ 2. Skins +

+ +
+ 2.1 Document Skin +
+ +
+ 2.2 Directory Skin +
+ +
+ 2.3 Site Skin +
+ +
+ 2.4 Sample Skins +
+ +

+ 3. Homepages +

+ +
+ 3.1 Home page and other custom built pages in a sub-directory +
+ +
+ 3.2 Home page within a skin +
+ +

+ Document Information (metadata) +

+ + + + +
+

+ + SiSU - Configuration [0.58],
Ralph Amissah +

+		 +

+   1 +

+
+ + + + +
+

+ + Configuration of Environment +

+		 +

+   2 +

+
+ + + + +
+

+ + 1. Configuration +

+		 +

+   3 +

+
+ + + + +
+
+ + 1.1 Determining the Current Configuration +
+		 +

+   4 +

+
+ + + + +
+

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

+		 +

+   5 +

+
+ + + + +
+

+ sisu -v +

+		 +

+   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 +

+
+ + + + +
+

+ + Configuration of Documents +

+		 +

+   21 +

+
+ + + + +
+

+ + 2. Skins +

+		 +

+   22 +

+
+ + + + +
+

+ Skins modify the default appearance of document output on a document, directory, or site wide basis. Skins are looked for in the following locations: +

+		 +

+   23 +

+
+ + + + +
+

+ ./_sisu/skin +

+		 +

+   24 +

+
+ + + + +
+

+ ~/.sisu/skin +

+		 +

+   25 +

+
+ + + + +
+

+ /etc/sisu/skin +

+		 +

+   26 +

+
+ + + + +
+

+ Within the skin directory are the following the default sub-directories for document skins: +

+		 +

+   27 +

+
+ + + + +
+

+ ./skin/doc +

+		 +

+   28 +

+
+ + + + +
+

+ ./skin/dir +

+		 +

+   29 +

+
+ + + + +
+

+ ./skin/site +

+		 +

+   30 +

+
+ + + + +
+

+ A skin is placed in the appropriate directory and the file named skin_[name].rb +

+		 +

+   31 +

+
+ + + + +
+

+ The skin itself is a ruby file which modifies the default appearances set in the program. +

+		 +

+   32 +

+
+ + + + +
+
+ + 2.1 Document Skin +
+		 +

+   33 +

+
+ + + + +
+

+ Documents take on a document skin, if the header of the document specifies a skin to be used. +

+		 +

+   34 +

+
+ + + + +
+

+ +  @skin: skin_united_nations + +

+		 +

+   35 +

+
+ + + + +
+
+ + 2.2 Directory Skin +
+		 +

+   36 +

+
+ + + + +
+

+ 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). +

+		 +

+   37 +

+
+ + + + +
+

+ 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. +

+		 +

+   38 +

+
+ + + + +
+
+ + 2.3 Site Skin +
+		 +

+   39 +

+
+ + + + +
+

+ A site skin, modifies the program default skin. +

+		 +

+   40 +

+
+ + + + +
+
+ + 2.4 Sample Skins +
+		 +

+   41 +

+
+ + + + +
+

+ With SiSU installed sample skins may be found in: +

+		 +

+   42 +

+
+ + + + +
+

+ /etc/sisu/skin/doc and /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc +

+		 +

+   43 +

+
+ + + + +
+

+ (or equivalent directory) and if sisu-markup-samples is installed also under: +

+		 +

+   44 +

+
+ + + + +
+

+ /usr/share/doc/sisu/sisu_markup_samples/non-free/_sisu/skin/doc +

+		 +

+   45 +

+
+ + + + +
+

+ Samples of list.yml and promo.yml (which are used to create the right column list) may be found in: +

+		 +

+   46 +

+
+ + + + +
+

+ /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml (or equivalent directory) +

+		 +

+   47 +

+
+ + + + +
+

+ + 3. Homepages +

+		 +

+   48 +

+
+ + + + +
+

+ SiSU is about the ability to auto-generate documents. Home pages are regarded as custom built items, and are not created by SiSU. More accurately, SiSU has a default home page, which will not be appropriate for use with other sites, and the means to provide your own home page instead in one of two ways as part of a site's configuration, these being: +

+		 +

+   49 +

+
+ + + + +
+

+ 1. through placing your home page and other custom built documents in the subdirectory _sisu/home/ (this probably being the easier and more convenient option) +

+		 +

+   50 +

+
+ + + + +
+

+ 2. through providing what you want as the home page in a skin, +

+		 +

+   51 +

+
+ + + + +
+

+ Document sets are contained in directories, usually organised by site or subject. Each directory can/should have its own homepage. See the section on directory structure and organisation of content. +

+		 +

+   52 +

+
+ + + + +
+
+ + 3.1 Home page and other custom built pages in a sub-directory +
+		 +

+   53 +

+
+ + + + +
+

+ Custom built pages, including the home page index.html may be placed within the configuration directory _sisu/home/ in any of the locations that is searched for the configuration directory, namely ./_sisu; ~/_sisu; /etc/sisu From there they are copied to the root of the output directory with the command: +

+		 +

+   54 +

+
+ + + + +
+

+ sisu -CC +

+		 +

+   55 +

+
+ + + + +
+
+ + 3.2 Home page within a skin +
+		 +

+   56 +

+
+ + + + +
+

+ Skins are described in a separate section, but basically are a file written in the programming language Ruby that may be provided to change the defaults that are provided with sisu with respect to individual documents, a directories contents or for a site. +

+		 +

+   57 +

+
+ + + + +
+

+ If you wish to provide a homepage within a skin the skin should be in the directory _sisu/skin/dir and have the name of the directory for which it is to become the home page. Documents in the directory commercial_law would have the homepage modified in skin_commercial law.rb; or the directory poems in skin_poems.rb +

+		 +

+   58 +

+
+ + + + +
+

+ +    class Home
+      def homepage
+        # place the html content of your homepage here, this will become index.html
+        <<HOME <html>
+  <head></head>
+  <doc>
+  <p>this is my new homepage.</p>
+  </doc>
+  </html>
+  HOME
+      end
+    end + +

+		 +

+   59 +

+
+ + + +
+ +

+

+

 +   +
+ + + + +
+

+ + Document Information (metadata) +

+		 +

+   0 +

+
+ +

+ Metadata +

+ + +     + + + + + +
+

+ <http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/sisu_manifest.html> +

 +
+ + + +
+

+ Dublin Core (DC) +

 +
+ + + +
+

+ DC tags included with this document are provided here. +

 +
+ + + +
+

+ DC Title: SiSU - Configuration [0.58] +

 +
+ + + +
+

+ DC Creator: Ralph Amissah +

 +
+ + + +
+

+ DC Rights: Ralph Amissah +

 +
+ + + +
+

+ DC Type: information +

 +
+ + + +
+

+ DC Date created: 2002-08-28 +

 +
+ + + +
+

+ DC Date issued: 2002-08-28 +

 +
+ + + +
+

+ DC Date available: 2007-08-28 +

 +
+ + + +
+

+ DC Date modified: 2007-08-30 +

 +
+ + + +
+

+ DC Date: 2007-08-30 +

 +
+ + + +
+

+ Version Information +

 +
+ + + +
+

+ Sourcefile: sisu_configuration._sst +

 +
+ + + +
+

+ Filetype: SiSU text insert 0.58 +

 +
+ + + +
+

+ Sourcefile Digest, MD5(sisu_configuration._sst)= 2a18ae8bbfec534c6e064d666ffbe20d +

 +
+ + + +
+

+ 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:03 +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] +

 +
+ + + + + +
+ +
SiSU -->
+		 + + + + + + + + + + + + + + + +
+ + Full Text  scroll  + + + + + TOC linked  toc  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
+		 +   +
+

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

+ + SiSU + +

+		 + +

+ 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. +

+
+

+ + GPLv3 + +

+		 +

+ + 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! + +

+
+ + + + + + + +

+ +
+
+ + +
+ + +
+ + + + idx + txt + + +
+
+ +
+

+ + +SiSU manual + +

+ + + + +

SiSU introduction

+

SiSU commands

+

SiSU markup

+

SiSU configuration

+

SiSU help

+

SiSU help sources

+ +
+

+ + +SiSU + +

+ + + + +

What does SiSU do? Summary

+

SiSU Book Samples and Markup Examples

+

Markup

+

Commands

+

Manual

+

SiSU Download

+

SiSU Changelog

+

Wikipedia entry

+

Freshmeat

+

Ruby Application Archive

+ + +
+ + + + diff --git a/data/doc/manuals_generated/sisu_manual/sisu_configuration/dom.xml b/data/doc/manuals_generated/sisu_manual/sisu_configuration/dom.xml new file mode 100644 index 00000000..527c13f7 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_configuration/dom.xml @@ -0,0 +1,795 @@ + + + + + + + + +
+ Title: + + SiSU - Configuration [0.58] + +
+ +
+ Creator: + + Ralph Amissah + +
+ +
+ Rights: + + Ralph Amissah + +
+ +
+ Type: + + information + +
+ +
+ Subject: + + ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +
+ +
+ Date created: + + 2002-08-28 + +
+ +
+ Date issued: + + 2002-08-28 + +
+ +
+ Date available: + + 2007-08-28 + +
+ +
+ Date modified: + + 2007-08-30 + +
+ +
+ Date: + + 2007-08-30 + +
+ + + + + + + + + + + + + + 1 + SiSU - Configuration [0.58],
Ralph Amissah + + + + + + + 2 + Configuration of Environment + + + + + + + 3 + config + + 1. Configuration + + + + + + + + + + 4 + 1.1 + + 1.1 Determining the Current Configuration + + + + + + + + 5 + + + Information on the current configuration of SiSU should be available with the help command: + + + + + + + + 6 + + + sisu -v + + + + + + + + 7 + + + which is an alias for: + + + + + + + + 8 + + + sisu --help env + + + + + + + + 9 + + + Either of these should be executed from within a directory that contains sisu markup source documents. + + + + + + + + + + + + 10 + 1.2 + + 1.2 Configuration files (config.yml) + + + + + + + + 11 + + + 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. + + + + + + + + 12 + + + The SiSU configuration file is a yaml file, which means indentation is significant. + + + + + + + + 13 + + + SiSU resource configuration is determined by looking at the following files if they exist: + + + + + + + + 14 + + + ./_sisu/sisurc.yml + + + + + + + + 15 + + + ~/.sisu/sisurc.yml + + + + + + + + 16 + + + /etc/sisu/sisurc.yml + + + + + + + + 17 + + + The search is in the order listed, and the first one found is used. + + + + + + + + 18 + + + In the absence of instructions in any of these it falls back to the internal program defaults. + + + + + + + + 19 + + + Configuration determines the output and processing directories and the database access details. + + + + + + + + 20 + + + If SiSU is installed a sample sisurc.yml may be found in /etc/sisu/sisurc.yml + + + + + + + + + + + + + + + + 21 + Configuration of Documents + + + + + + + 22 + skins + + 2. Skins + + + + + + + + 23 + + + Skins modify the default appearance of document output on a document, directory, or site wide basis. Skins are looked for in the following locations: + + + + + + + + 24 + + + ./_sisu/skin + + + + + + + + 25 + + + ~/.sisu/skin + + + + + + + + 26 + + + /etc/sisu/skin + + + + + + + + 27 + + + Within the skin directory are the following the default sub-directories for document skins: + + + + + + + + 28 + + + ./skin/doc + + + + + + + + 29 + + + ./skin/dir + + + + + + + + 30 + + + ./skin/site + + + + + + + + 31 + + + A skin is placed in the appropriate directory and the file named skin_[name].rb + + + + + + + + 32 + + + The skin itself is a ruby file which modifies the default appearances set in the program. + + + + + + + + + + 33 + 2.1 + + 2.1 Document Skin + + + + + + + + 34 + + + Documents take on a document skin, if the header of the document specifies a skin to be used. + + + + + + + + 35 + + + + +      @skin: skin_united_nations     + + + + + + + + + + + + + + 36 + 2.2 + + 2.2 Directory Skin + + + + + + + + 37 + + + 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). + + + + + + + + 38 + + + 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. + + + + + + + + + + + + 39 + 2.3 + + 2.3 Site Skin + + + + + + + + 40 + + + A site skin, modifies the program default skin. + + + + + + + + + + + + 41 + 2.4 + + 2.4 Sample Skins + + + + + + + + 42 + + + With SiSU installed sample skins may be found in: + + + + + + + + 43 + + + /etc/sisu/skin/doc and /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc + + + + + + + + 44 + + + (or equivalent directory) and if sisu-markup-samples is installed also under: + + + + + + + + 45 + + + /usr/share/doc/sisu/sisu_markup_samples/non-free/_sisu/skin/doc + + + + + + + + 46 + + + Samples of list.yml and promo.yml (which are used to create the right column list) may be found in: + + + + + + + + 47 + + + /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml (or equivalent directory) + + + + + + + + + + + + + + 48 + home + + 3. Homepages + + + + + + + + 49 + + + SiSU is about the ability to auto-generate documents. Home pages are regarded as custom built items, and are not created by SiSU. More accurately, SiSU has a default home page, which will not be appropriate for use with other sites, and the means to provide your own home page instead in one of two ways as part of a site's configuration, these being: + + + + + + + + 50 + + + 1. through placing your home page and other custom built documents in the subdirectory _sisu/home/ (this probably being the easier and more convenient option) + + + + + + + + 51 + + + 2. through providing what you want as the home page in a skin, + + + + + + + + 52 + + + Document sets are contained in directories, usually organised by site or subject. Each directory can/should have its own homepage. See the section on directory structure and organisation of content. + + + + + + + + + + 53 + 3.1 + + 3.1 Home page and other custom built pages in a sub-directory + + + + + + + + 54 + + + Custom built pages, including the home page index.html may be placed within the configuration directory _sisu/home/ in any of the locations that is searched for the configuration directory, namely ./_sisu; ~/_sisu; /etc/sisu From there they are copied to the root of the output directory with the command: + + + + + + + + 55 + + + sisu -CC + + + + + + + + + + + + 56 + 3.2 + + 3.2 Home page within a skin + + + + + + + + 57 + + + Skins are described in a separate section, but basically are a file written in the programming language Ruby that may be provided to change the defaults that are provided with sisu with respect to individual documents, a directories contents or for a site. + + + + + + + + 58 + + + If you wish to provide a homepage within a skin the skin should be in the directory _sisu/skin/dir and have the name of the directory for which it is to become the home page. Documents in the directory commercial_law would have the homepage modified in skin_commercial law.rb; or the directory poems in skin_poems.rb + + + + + + + + 59 + + + + +        class Home
         def homepage
           # place the html content of your homepage here, this will become index.html
           <<HOME <html>
     <head></head>
     <doc>
     <p>this is my new homepage.</p>
     </doc>
     </html>
     HOME
         end
       end     + + + + + + + + + + + + + + + + + + + + diff --git a/data/doc/manuals_generated/sisu_manual/sisu_configuration/home.html b/data/doc/manuals_generated/sisu_manual/sisu_configuration/home.html new file mode 100644 index 00000000..85674644 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_configuration/home.html @@ -0,0 +1,614 @@ + + + + + + home - + SiSU + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ +
SiSU -->
+		 + + + + + + + + + + + + + + + + + +
+ + + TOC linked  toc  + + + + + + Full Text  scroll  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
+		 + + + + + + +
+ + << previous + + + + TOC + + + + next >> + + +
+
+ + + + +
+ + < + + + + ^ + + + + > + +

+ SiSU +

+

+ Configuration [0.58] +

+

+ Ralph Amissah + +

+

+ copy @ + + SiSU + +

+ + +
+

+ SiSU - Configuration [0.58],
Ralph Amissah +

+		   +

+   1 +

+
+ + +
+ +   +

+   21 +

+
+ + +
+ +   +
+ + +
+

+ + 3. Homepages +

+		 +

+   48 +

+
+ + 3.1 Home page and other custom built pages in a sub-directory + +
+ + 3.2 Home page within a skin + +
+ + +
+

+ SiSU is about the ability to auto-generate documents. Home pages are regarded as custom built items, and are not created by SiSU. More accurately, SiSU has a default home page, which will not be appropriate for use with other sites, and the means to provide your own home page instead in one of two ways as part of a site's configuration, these being: +

+		 +

+   49 +

+
+ + +
+

+ 1. through placing your home page and other custom built documents in the subdirectory _sisu/home/ (this probably being the easier and more convenient option) +

+		 +

+   50 +

+
+ + +
+

+ 2. through providing what you want as the home page in a skin, +

+		 +

+   51 +

+
+ + +
+

+ Document sets are contained in directories, usually organised by site or subject. Each directory can/should have its own homepage. See the section on directory structure and organisation of content. +

+		 +

+   52 +

+
+ + +
+ +

+ 3.1 Home page and other custom built pages in a sub-directory +

+		 +

+   53 +

+
+ + +
+

+ Custom built pages, including the home page index.html may be placed within the configuration directory _sisu/home/ in any of the locations that is searched for the configuration directory, namely ./_sisu; ~/_sisu; /etc/sisu From there they are copied to the root of the output directory with the command: +

+		 +

+   54 +

+
+ + +
+

+ sisu -CC +

+		 +

+   55 +

+
+ + +
+ +

+ 3.2 Home page within a skin +

+		 +

+   56 +

+
+ + +
+

+ Skins are described in a separate section, but basically are a file written in the programming language Ruby that may be provided to change the defaults that are provided with sisu with respect to individual documents, a directories contents or for a site. +

+		 +

+   57 +

+
+ + +
+

+ If you wish to provide a homepage within a skin the skin should be in the directory _sisu/skin/dir and have the name of the directory for which it is to become the home page. Documents in the directory commercial_law would have the homepage modified in skin_commercial law.rb; or the directory poems in skin_poems.rb +

+		 +

+   58 +

+
+ + +
+

+     class Home
      def homepage
        # place the html content of your homepage here, this will become index.html
        <<HOME <html>
  <head></head>
  <doc>
  <p>this is my new homepage.</p>
  </doc>
  </html>
  HOME
      end
    end +

+		 +

+   59 +

+
 
+ + + +
+ +
SiSU -->
+		 + + + + + + + + + + + + + + + + + +
+ + + TOC linked  toc  + + + + + + Full Text  scroll  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
+		 + + + + + + +
+ + << previous + + + + TOC + + + + next >> + + +
+
+ + + + +
+ + < + + + + ^ + + + + > + +

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

+ + SiSU + +

+		 + +

+ 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. +

+
+

+ + GPLv3 + +

+		 +

+ + 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! + +

+
+ + + + + +
+
+ + +
+ + +
+ + + + idx + txt + + +
+
+ +
+

+ + +SiSU manual + +

+ + + + +

SiSU introduction

+

SiSU commands

+

SiSU markup

+

SiSU configuration

+

SiSU help

+

SiSU help sources

+ +
+

+ + +SiSU + +

+ + + + +

What does SiSU do? Summary

+

SiSU Book Samples and Markup Examples

+

Markup

+

Commands

+

Manual

+

SiSU Download

+

SiSU Changelog

+

Wikipedia entry

+

Freshmeat

+

Ruby Application Archive

+ + +
+ \ No newline at end of file diff --git a/data/doc/manuals_generated/sisu_manual/sisu_configuration/index.html b/data/doc/manuals_generated/sisu_manual/sisu_configuration/index.html new file mode 100644 index 00000000..69c005c5 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_configuration/index.html @@ -0,0 +1,564 @@ + + + + + + SiSU + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ +
SiSU -->
+		 + + + + + + + + + + + + + + + +
+ + TOC linked  toc  + + + + + Full Text  scroll  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
+		 +   + next >> +   +
+

+ +

+ +
+ + +
+ +

SiSU +

+ +

Configuration [0.58] +

+ +

Ralph Amissah +

+ +copy @ + + SiSU + + +
+ + + +

+ SiSU - Configuration [0.58],
Ralph Amissah +

+ +

+ Configuration of Environment +

+ +

+ + 1. Configuration + +

+ +
+ + 1.1 Determining the Current Configuration + +
+ +
+ + 1.2 Configuration files (config.yml) + +
+ +

+ Configuration of Documents +

+ +

+ + 2. Skins + +

+ +
+ + 2.1 Document Skin + +
+ +
+ + 2.2 Directory Skin + +
+ +
+ + 2.3 Site Skin + +
+ +
+ + 2.4 Sample Skins + +
+ +

+ + 3. Homepages + +

+ +
+ + 3.1 Home page and other custom built pages in a sub-directory + +
+ +
+ + 3.2 Home page within a skin + +
+ +

+ Document Information (metadata) +

+ +

Ralph Amissah

+

+ +

+ + + + + +
+ +
SiSU -->
+		 + + + + + + + + + + + + + + + +
+ + TOC linked  toc  + + + + + Full Text  scroll  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
+		 +   + next >> +   +
+

+ +

 

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

+ + SiSU + +

+		 + +

+ 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. +

+
+

+ + GPLv3 + +

+		 +

+ + 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! + +

+
+ + + + + + + +
+ +
+
+ + +
+ + +
+ + + + idx + txt + + +
+
+ +
+

+ + +SiSU manual + +

+ + + + +

SiSU introduction

+

SiSU commands

+

SiSU markup

+

SiSU configuration

+

SiSU help

+

SiSU help sources

+ +
+

+ + +SiSU + +

+ + + + +

What does SiSU do? Summary

+

SiSU Book Samples and Markup Examples

+

Markup

+

Commands

+

Manual

+

SiSU Download

+

SiSU Changelog

+

Wikipedia entry

+

Freshmeat

+

Ruby Application Archive

+ + +
+ + + + diff --git a/data/doc/manuals_generated/sisu_manual/sisu_configuration/landscape.pdf b/data/doc/manuals_generated/sisu_manual/sisu_configuration/landscape.pdf new file mode 100644 index 00000000..9cfbab37 Binary files /dev/null and b/data/doc/manuals_generated/sisu_manual/sisu_configuration/landscape.pdf differ diff --git a/data/doc/manuals_generated/sisu_manual/sisu_configuration/metadata.html b/data/doc/manuals_generated/sisu_manual/sisu_configuration/metadata.html new file mode 100644 index 00000000..b42da776 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_configuration/metadata.html @@ -0,0 +1,590 @@ + + + + + + - + SiSU + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ +
SiSU -->
+		 + + + + + + + + + + + + + + + + + +
+ + + TOC linked  toc  + + + + + + Full Text  scroll  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
+		 + + + + + + +
+ + << previous + + + + TOC + + +
+
+ + + + +
+ + < + + + + ^ + + + + > + +

+ SiSU +

+

+ Configuration [0.58] +

+

+ Ralph Amissah + +

+

+ copy @ + + SiSU + +

+ + +
+

+ Document Information (metadata) +

+		   +

+   0 +

+
+ + +
+ +   +
+ + +
+

+ + Metadata +

+		 +

+   0 +

+
+ +
+

+ <http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/sisu_manifest.html> +

 +
+ +
+

+ Dublin Core (DC) +

 +
+ +
+

+ DC tags included with this document are provided here. +

 +
+ +
+

+ DC Title: SiSU - Configuration [0.58] +

 +
+ +
+

+ DC Creator: Ralph Amissah +

 +
+ +
+

+ DC Rights: Ralph Amissah +

 +
+ +
+

+ DC Type: information +

 +
+ +
+

+ DC Date created: 2002-08-28 +

 +
+ +
+

+ DC Date issued: 2002-08-28 +

 +
+ +
+

+ DC Date available: 2007-08-28 +

 +
+ +
+

+ DC Date modified: 2007-08-30 +

 +
+ +
+

+ DC Date: 2007-08-30 +

 +
+ +
+

+ Version Information +

 +
+ +
+

+ Sourcefile: sisu_configuration._sst +

 +
+ +
+

+ Filetype: SiSU text insert 0.58 +

 +
+ +
+

+ Sourcefile Digest, MD5(sisu_configuration._sst)= 2a18ae8bbfec534c6e064d666ffbe20d +

 +
+ +
+

+ 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:03 +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] +

 +
 
+ + + +
+ +
SiSU -->
+		 + + + + + + + + + + + + + + + + + +
+ + + TOC linked  toc  + + + + + + Full Text  scroll  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
+		 + + + + + + +
+ + << previous + + + + TOC + + +
+
+ + + + +
+ + < + + + + ^ + + + + > + +

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

+ + SiSU + +

+		 + +

+ 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. +

+
+

+ + GPLv3 + +

+		 +

+ + 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! + +

+
+ + + + + +
+
+ + +
+ + +
+ + + + idx + txt + + +
+
+ +
+

+ + +SiSU manual + +

+ + + + +

SiSU introduction

+

SiSU commands

+

SiSU markup

+

SiSU configuration

+

SiSU help

+

SiSU help sources

+ +
+

+ + +SiSU + +

+ + + + +

What does SiSU do? Summary

+

SiSU Book Samples and Markup Examples

+

Markup

+

Commands

+

Manual

+

SiSU Download

+

SiSU Changelog

+

Wikipedia entry

+

Freshmeat

+

Ruby Application Archive

+ + +
+ \ No newline at end of file diff --git a/data/doc/manuals_generated/sisu_manual/sisu_configuration/opendocument.odt b/data/doc/manuals_generated/sisu_manual/sisu_configuration/opendocument.odt new file mode 100644 index 00000000..c2c47b06 Binary files /dev/null and b/data/doc/manuals_generated/sisu_manual/sisu_configuration/opendocument.odt differ diff --git a/data/doc/manuals_generated/sisu_manual/sisu_configuration/plain.txt b/data/doc/manuals_generated/sisu_manual/sisu_configuration/plain.txt new file mode 100644 index 00000000..a4dcb9b7 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_configuration/plain.txt @@ -0,0 +1,349 @@ +SISU - CONFIGURATION [0.58], +RALPH AMISSAH +******************************************* + +CONFIGURATION OF ENVIRONMENT +============================ + +1. CONFIGURATION +---------------- + +1.1 DETERMINING THE CURRENT CONFIGURATION +......................................... + +Information on the current configuration of *SiSU* should be available with the +help command: + + + sisu -v + + +which is an alias for: + + + sisu --help env + + +Either of these should be executed from within a directory that contains sisu +markup source documents. + + +1.2 CONFIGURATION FILES (CONFIG.YML) +.................................... + +*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. + + +The *SiSU* configuration file is a yaml file, which means indentation is +significant. + + +*SiSU* resource configuration is determined by looking at the following files +if they exist: + + + ./_sisu/sisurc.yml + + + ~/.sisu/sisurc.yml + + + /etc/sisu/sisurc.yml + + +The search is in the order listed, and the first one found is used. + + +In the absence of instructions in any of these it falls back to the internal +program defaults. + + +Configuration determines the output and processing directories and the database +access details. + + +If *SiSU* is installed a sample sisurc.yml may be found in /etc/sisu/sisurc.yml + + +CONFIGURATION OF DOCUMENTS +========================== + +2. 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. + + +2.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 + +2.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.3 SITE SKIN +............. + +A site skin, modifies the program default skin. + + +2.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) + + +3. HOMEPAGES +------------ + +*SiSU* is about the ability to auto-generate documents. Home pages are regarded +as custom built items, and are not created by *SiSU*. More accurately, *SiSU* +has a default home page, which will not be appropriate for use with other +sites, and the means to provide your own home page instead in one of two ways +as part of a site's configuration, these being: + + +1. through placing your home page and other custom built documents in the +subdirectory _sisu/home/ (this probably being the easier and more convenient +option) + + +2. through providing what you want as the home page in a skin, + + +Document sets are contained in directories, usually organised by site or +subject. Each directory can/should have its own homepage. See the section on +directory structure and organisation of content. + + +3.1 HOME PAGE AND OTHER CUSTOM BUILT PAGES IN A SUB-DIRECTORY +............................................................. + +Custom built pages, including the home page index.html may be placed within the +configuration directory _sisu/home/ in any of the locations that is searched +for the configuration directory, namely ./_sisu; ~/_sisu; /etc/sisu From there +they are copied to the root of the output directory with the command: + + + sisu -CC + + +3.2 HOME PAGE WITHIN A SKIN +........................... + +Skins are described in a separate section, but basically are a file written in +the programming language *Ruby* that may be provided to change the defaults +that are provided with sisu with respect to individual documents, a directories +contents or for a site. + + +If you wish to provide a homepage within a skin the skin should be in the +directory _sisu/skin/dir and have the name of the directory for which it is to +become the home page. Documents in the directory commercial_law would have the +homepage modified in skin_commercial law.rb; or the directory poems in +skin_poems.rb + + + + class Home + def homepage + # place the html content of your homepage here, this will become index.html + < + + +

this is my new homepage.

+ + + HOME + end + end + +DOCUMENT INFORMATION (METADATA) +******************************* + +METADATA +-------- + +Document Manifest @ + + + +*Dublin Core* (DC) + + +/DC tags included with this document are provided here./ + + +DC Title: _SiSU - Configuration [0.58]_ + + +DC Creator: _Ralph Amissah_ + + +DC Rights: _Ralph Amissah_ + + +DC Type: _information_ + + +DC Date created: _2002-08-28_ + + +DC Date issued: _2002-08-28_ + + +DC Date available: _2007-08-28_ + + +DC Date modified: _2007-08-30_ + + +DC Date: _2007-08-30_ + + +*Version Information* + + +Sourcefile: _sisu_configuration._sst_ + + +Filetype: _SiSU text insert 0.58_ + + +Sourcefile Digest, MD5(sisu_configuration._sst)= +_2a18ae8bbfec534c6e064d666ffbe20d_ + + +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:03 +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 - Configuration [0.58] + + creator: Ralph Amissah + + rights: Ralph Amissah + + type: information + + subject: ebook, epublishing, electronic book, electronic publishing, + electronic document, electronic citation, data structure, + citation systems, search + + date.created: 2002-08-28 + + date.issued: 2002-08-28 + + date.available: 2007-08-28 + + date.modified: 2007-08-30 + + date: 2007-08-30 + + + + + +============================================================================== +nil + +Other versions of this document: +manifest: + http://www.jus.uio.no/sisu/sisu_configuration/sisu_manifest.html +html: + http://www.jus.uio.no/sisu/sisu_configuration/toc.html +pdf: + http://www.jus.uio.no/sisu/sisu_configuration/portrait.pdf + http://www.jus.uio.no/sisu/sisu_configuration/landscape.pdf +plaintext (plain text): + http://www.jus.uio.no/sisu/sisu_configuration/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:51 +0100 2007 +* SiSU http://www.jus.uio.no/sisu diff --git a/data/doc/manuals_generated/sisu_manual/sisu_configuration/portrait.pdf b/data/doc/manuals_generated/sisu_manual/sisu_configuration/portrait.pdf new file mode 100644 index 00000000..80d75e97 Binary files /dev/null and b/data/doc/manuals_generated/sisu_manual/sisu_configuration/portrait.pdf differ diff --git a/data/doc/manuals_generated/sisu_manual/sisu_configuration/sax.xml b/data/doc/manuals_generated/sisu_manual/sisu_configuration/sax.xml new file mode 100644 index 00000000..3da1a79b --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_configuration/sax.xml @@ -0,0 +1,466 @@ + + + + + + + Title: + + SiSU - Configuration [0.58] + +
+ Creator: + + Ralph Amissah + +
+ Rights: + + Ralph Amissah + +
+ Type: + + information + +
+ Subject: + + ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +
+ Date created: + + 2002-08-28 + +
+ Date issued: + + 2002-08-28 + +
+ Date available: + + 2007-08-28 + +
+ Date modified: + + 2007-08-30 + +
+ Date: + + 2007-08-30 + +
+ + + + 1 + + SiSU - Configuration [0.58],
Ralph Amissah + + + + 2 + + Configuration of Environment + + + + 3 + + 1. Configuration + + + + 4 + + 1.1 Determining the Current Configuration + + + + 5 + + Information on the current configuration of SiSU should be +available with the help command: + + + + 6 + + sisu -v + + + + 7 + + which is an alias for: + + + + 8 + + sisu --help env + + + + 9 + + Either of these should be executed from within a directory that +contains sisu markup source documents. + + + + 10 + + 1.2 Configuration files (config.yml) + + + + 11 + + 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. + + + + 12 + + The SiSU configuration file is a yaml file, which means +indentation is significant. + + + + 13 + + SiSU resource configuration is determined by looking at the +following files if they exist: + + + + 14 + + ./_sisu/sisurc.yml + + + + 15 + + ~/.sisu/sisurc.yml + + + + 16 + + /etc/sisu/sisurc.yml + + + + 17 + + The search is in the order listed, and the first one found is used. + + + + 18 + + In the absence of instructions in any of these it falls back to the +internal program defaults. + + + + 19 + + Configuration determines the output and processing directories and the +database access details. + + + + 20 + + If SiSU is installed a sample sisurc.yml may be found in +/etc/sisu/sisurc.yml + + + + 21 + + Configuration of Documents + + + + 22 + + 2. Skins + + + + 23 + + Skins modify the default appearance of document output on a document, +directory, or site wide basis. Skins are looked for in the following +locations: + + + + 24 + + ./_sisu/skin + + + + 25 + + ~/.sisu/skin + + + + 26 + + /etc/sisu/skin + + + + 27 + + Within the skin directory are the following the default +sub-directories for document skins: + + + + 28 + + ./skin/doc + + + + 29 + + ./skin/dir + + + + 30 + + ./skin/site + + + + 31 + + A skin is placed in the appropriate directory and the file named +skin_[name].rb + + + + 32 + + The skin itself is a ruby file which modifies the default appearances +set in the program. + + + + 33 + + 2.1 Document Skin + + + + 34 + + Documents take on a document skin, if the header of the document +specifies a skin to be used. + + + + 35 + +      @skin: skin_united_nations     + + + + 36 + + 2.2 Directory Skin + + + + 37 + + 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). + + + + 38 + + 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. + + + + 39 + + 2.3 Site Skin + + + + 40 + + A site skin, modifies the program default skin. + + + + 41 + + 2.4 Sample Skins + + + + 42 + + With SiSU installed sample skins may be found in: + + + + 43 + + /etc/sisu/skin/doc and +/usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc + + + + 44 + + (or equivalent directory) and if sisu-markup-samples is installed also +under: + + + + 45 + + /usr/share/doc/sisu/sisu_markup_samples/non-free/_sisu/skin/doc + + + + 46 + + Samples of list.yml and promo.yml (which are used to create the right +column list) may be found in: + + + + 47 + + /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml (or +equivalent directory) + + + + 48 + + 3. Homepages + + + + 49 + + SiSU is about the ability to auto-generate documents. Home pages +are regarded as custom built items, and are not created by SiSU. +More accurately, SiSU has a default home page, which will not be +appropriate for use with other sites, and the means to provide your own +home page instead in one of two ways as part of a site's configuration, +these being: + + + + 50 + + 1. through placing your home page and other custom built documents in +the subdirectory _sisu/home/ (this probably being the easier and more +convenient option) + + + + 51 + + 2. through providing what you want as the home page in a skin, + + + + 52 + + Document sets are contained in directories, usually organised by site +or subject. Each directory can/should have its own homepage. See the +section on directory structure and organisation of content. + + + + 53 + + 3.1 Home page and other custom built pages in a sub-directory + + + + 54 + + Custom built pages, including the home page index.html may be placed +within the configuration directory _sisu/home/ in any of the locations +that is searched for the configuration directory, namely ./_sisu; +~/_sisu; /etc/sisu From there they are copied to the root of the +output directory with the command: + + + + 55 + + sisu -CC + + + + 56 + + 3.2 Home page within a skin + + + + 57 + + Skins are described in a separate section, but basically are a file +written in the programming language Ruby that may be provided to +change the defaults that are provided with sisu with respect to +individual documents, a directories contents or for a site. + + + + 58 + + If you wish to provide a homepage within a skin the skin should be in +the directory _sisu/skin/dir and have the name of the directory for +which it is to become the home page. Documents in the directory +commercial_law would have the homepage modified in skin_commercial +law.rb; or the directory poems in skin_poems.rb + + + + 59 + +        class Home
         def homepage
           # place the html content of your homepage here, this will become index.html
           <<HOME <html>
     <head></head>
     <doc>
     <p>this is my new homepage.</p>
     </doc>
     </html>
     HOME
         end
       end     + + + + diff --git a/data/doc/manuals_generated/sisu_manual/sisu_configuration/scroll.xhtml b/data/doc/manuals_generated/sisu_manual/sisu_configuration/scroll.xhtml new file mode 100644 index 00000000..a00a6f77 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_configuration/scroll.xhtml @@ -0,0 +1,467 @@ + + + + + + + + Title: + + SiSU - Configuration [0.58] + +
+ Creator: + + Ralph Amissah + +
+ Rights: + + Ralph Amissah + +
+ Type: + + information + +
+ Subject: + + ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +
+ Date created: + + 2002-08-28 + +
+ Date issued: + + 2002-08-28 + +
+ Date available: + + 2007-08-28 + +
+ Date modified: + + 2007-08-30 + +
+ Date: + + 2007-08-30 + +
+ + + + + SiSU - Configuration [0.58],
Ralph Amissah + + 1 + + + + Configuration of Environment + + 2 + + + + 1. Configuration + + 3 + + + + 1.1 Determining the Current Configuration + + 4 + + + + Information on the current configuration of SiSU should be +available with the help command: + + 5 + + + + sisu -v + + 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 + + + + Configuration of Documents + + 21 + + + + 2. Skins + + 22 + + + + Skins modify the default appearance of document output on a document, +directory, or site wide basis. Skins are looked for in the following +locations: + + 23 + + + + ./_sisu/skin + + 24 + + + + ~/.sisu/skin + + 25 + + + + /etc/sisu/skin + + 26 + + + + Within the skin directory are the following the default +sub-directories for document skins: + + 27 + + + + ./skin/doc + + 28 + + + + ./skin/dir + + 29 + + + + ./skin/site + + 30 + + + + A skin is placed in the appropriate directory and the file named +skin_[name].rb + + 31 + + + + The skin itself is a ruby file which modifies the default appearances +set in the program. + + 32 + + + + 2.1 Document Skin + + 33 + + + + Documents take on a document skin, if the header of the document +specifies a skin to be used. + + 34 + + + 35 + +      @skin: skin_united_nations     + + + + + 2.2 Directory Skin + + 36 + + + + 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). + + 37 + + + + 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. + + 38 + + + + 2.3 Site Skin + + 39 + + + + A site skin, modifies the program default skin. + + 40 + + + + 2.4 Sample Skins + + 41 + + + + With SiSU installed sample skins may be found in: + + 42 + + + + /etc/sisu/skin/doc and +/usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc + + 43 + + + + (or equivalent directory) and if sisu-markup-samples is installed also +under: + + 44 + + + + /usr/share/doc/sisu/sisu_markup_samples/non-free/_sisu/skin/doc + + 45 + + + + Samples of list.yml and promo.yml (which are used to create the right +column list) may be found in: + + 46 + + + + /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml (or +equivalent directory) + + 47 + + + + 3. Homepages + + 48 + + + + SiSU is about the ability to auto-generate documents. Home pages +are regarded as custom built items, and are not created by SiSU. +More accurately, SiSU has a default home page, which will not be +appropriate for use with other sites, and the means to provide your own +home page instead in one of two ways as part of a site's configuration, +these being: + + 49 + + + + 1. through placing your home page and other custom built documents in +the subdirectory _sisu/home/ (this probably being the easier and more +convenient option) + + 50 + + + + 2. through providing what you want as the home page in a skin, + + 51 + + + + Document sets are contained in directories, usually organised by site +or subject. Each directory can/should have its own homepage. See the +section on directory structure and organisation of content. + + 52 + + + + 3.1 Home page and other custom built pages in a sub-directory + + 53 + + + + Custom built pages, including the home page index.html may be placed +within the configuration directory _sisu/home/ in any of the locations +that is searched for the configuration directory, namely ./_sisu; +~/_sisu; /etc/sisu From there they are copied to the root of the +output directory with the command: + + 54 + + + + sisu -CC + + 55 + + + + 3.2 Home page within a skin + + 56 + + + + Skins are described in a separate section, but basically are a file +written in the programming language Ruby that may be provided to +change the defaults that are provided with sisu with respect to +individual documents, a directories contents or for a site. + + 57 + + + + If you wish to provide a homepage within a skin the skin should be in +the directory _sisu/skin/dir and have the name of the directory for +which it is to become the home page. Documents in the directory +commercial_law would have the homepage modified in skin_commercial +law.rb; or the directory poems in skin_poems.rb + + 58 + + + 59 + +        class Home
         def homepage
           # place the html content of your homepage here, this will become index.html
           <<HOME <html>
     <head></head>
     <doc>
     <p>this is my new homepage.</p>
     </doc>
     </html>
     HOME
         end
       end     + + + + diff --git a/data/doc/manuals_generated/sisu_manual/sisu_configuration/sisu_manifest.html b/data/doc/manuals_generated/sisu_manual/sisu_configuration/sisu_manifest.html new file mode 100644 index 00000000..09c5c3cb --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_configuration/sisu_manifest.html @@ -0,0 +1,198 @@ + + + + +SiSU manifest: SiSU + + + + + + + + + + +
SiSU -->

<http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/>

 + +
+ + +
+ + + idx + txt + + +
+
+ +

SiSU - Configuration [0.58]

+

Ralph Amissah

+ + +

SiSU manifest

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

description

filename

file size

(kB)

TOC linked table of contents (for segmented HTML text)

toc.html

<http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/toc.html>

16.7

Full Text full length document (HTML)

doc.html

<http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/doc.html>

47.0

PDF portrait full length document (PDF portrait / vertical - recommended for printing)

portrait.pdf

<http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/portrait.pdf>

108.4

PDF landscape full length document (PDF landscape / horizontal - recommended for screen viewing)

landscape.pdf

<http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/landscape.pdf>

106.8

ODF/ODT full length document (ODF:ODT - Open Document Format)

opendocument.odt

<http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/opendocument.odt>

9.8

full length document (XHTML)

scroll.xhtml

<http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/scroll.xhtml>

11.2

full length document (XML SAX)

sax.xml

<http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/sax.xml>

11.1

full length document (XML DOM)

dom.xml

<http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/dom.xml>

14.0

full length document (plaintext (UTF-8))

plain.txt

<http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/plain.txt>

7.6

Concordance file (HTML - wordmap, alphabetical wordlist)

concordance.html

<http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/concordance.html>

55.0

Digest/DCC - Document Content Certificate (md5)

digest.txt

<http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/digest.txt>

9.4

+ +

SiSU doc (zip)

sisupod.zip   35ea4f2d0ecbc7675018ba1a2db843ef
<http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/sisupod.zip>

7.4

+

SiSU manifest of document metadata

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

metadata

description

DC Title:

SiSU - Configuration [0.58]

Title:

SiSU

Subtitle:

Configuration [0.58]

DC Creator:

Ralph Amissah

DC Publisher:

SiSU http://www.jus.uio.no/sisu (this copy)

DC Subject:

ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search

DC Type:

information

DC Rights:

Ralph Amissah

DC Date:

2007-08-30

DC Date created:

2002-08-28

DC Date issued:

2002-08-28

DC Date available:

2007-08-28

DC Date modified:

2007-08-30

DC Language:

English

DC Identifier:

http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/toc.html

Sourcefile:

sisu_configuration._sst

Word Count approximate:

1331

Sourcefile Digest (md5):

2a18ae8bbfec534c6e064d666ffbe20d

Document (metaverse) last generated:

Sun Sep 23 04:13:46 +0100 2007

Generated by:

SiSU 0.59.0 2007w38/0 (2007-09-23)

Ruby version:

ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux]

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

metadata suggested 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/>

+

Document Language Versions, manifests

+ + + + +

filename

description

 

English

English

<http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/sisu_manifest.html>

 

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

+ + SiSU + +

+		 + +

+ 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. +

+
+

+ + GPLv3 + +

+		 +

+ + 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! + +

+
+ + diff --git a/data/doc/manuals_generated/sisu_manual/sisu_configuration/sisupod.zip b/data/doc/manuals_generated/sisu_manual/sisu_configuration/sisupod.zip new file mode 100644 index 00000000..2e4d4e97 Binary files /dev/null and b/data/doc/manuals_generated/sisu_manual/sisu_configuration/sisupod.zip differ diff --git a/data/doc/manuals_generated/sisu_manual/sisu_configuration/sitemap.xml b/data/doc/manuals_generated/sisu_manual/sisu_configuration/sitemap.xml new file mode 100644 index 00000000..68cdd82f --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_configuration/sitemap.xml @@ -0,0 +1,30 @@ + + + + + + http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/toc.html + 2007-08-30 + monthly + 0.7 + + + http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/doc.html + 2007-08-30 + 0.5 + + + http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/sisu_manifest.html + 2007-08-30 + 0.5 + + diff --git a/data/doc/manuals_generated/sisu_manual/sisu_configuration/skins.html b/data/doc/manuals_generated/sisu_manual/sisu_configuration/skins.html new file mode 100644 index 00000000..e3eb6ad2 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_configuration/skins.html @@ -0,0 +1,778 @@ + + + + + + skins - + SiSU + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ +
SiSU -->
+		 + + + + + + + + + + + + + + + + + +
+ + + TOC linked  toc  + + + + + + Full Text  scroll  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
+		 + + + + + + +
+ + << previous + + + + TOC + + + + next >> + + +
+
+ + + + +
+ + < + + + + ^ + + + + > + +

+ SiSU +

+

+ Configuration [0.58] +

+

+ Ralph Amissah + +

+

+ copy @ + + SiSU + +

+ + +
+

+ SiSU - Configuration [0.58],
Ralph Amissah +

+		   +

+   1 +

+
+ + +
+ +   +

+   21 +

+
+ + +
+ +   +
+ + +
+

+ + 2. Skins +

+		 +

+   22 +

+
+ + 2.1 Document Skin + +
+ + 2.2 Directory Skin + +
+ + 2.3 Site Skin + +
+ + 2.4 Sample 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: +

+		 +

+   23 +

+
+ + +
+

+ ./_sisu/skin +

+		 +

+   24 +

+
+ + +
+

+ ~/.sisu/skin +

+		 +

+   25 +

+
+ + +
+

+ /etc/sisu/skin +

+		 +

+   26 +

+
+ + +
+

+ Within the skin directory are the following the default sub-directories for document skins: +

+		 +

+   27 +

+
+ + +
+

+ ./skin/doc +

+		 +

+   28 +

+
+ + +
+

+ ./skin/dir +

+		 +

+   29 +

+
+ + +
+

+ ./skin/site +

+		 +

+   30 +

+
+ + +
+

+ A skin is placed in the appropriate directory and the file named skin_[name].rb +

+		 +

+   31 +

+
+ + +
+

+ The skin itself is a ruby file which modifies the default appearances set in the program. +

+		 +

+   32 +

+
+ + +
+ +

+ 2.1 Document Skin +

+		 +

+   33 +

+
+ + +
+

+ Documents take on a document skin, if the header of the document specifies a skin to be used. +

+		 +

+   34 +

+
+ + +
+

+   @skin: skin_united_nations +

+		 +

+   35 +

+
+ + +
+ +

+ 2.2 Directory Skin +

+		 +

+   36 +

+
+ + +
+

+ 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). +

+		 +

+   37 +

+
+ + +
+

+ 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. +

+		 +

+   38 +

+
+ + +
+ +

+ 2.3 Site Skin +

+		 +

+   39 +

+
+ + +
+

+ A site skin, modifies the program default skin. +

+		 +

+   40 +

+
+ + +
+ +

+ 2.4 Sample Skins +

+		 +

+   41 +

+
+ + +
+

+ With SiSU installed sample skins may be found in: +

+		 +

+   42 +

+
+ + +
+

+ /etc/sisu/skin/doc and /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc +

+		 +

+   43 +

+
+ + +
+

+ (or equivalent directory) and if sisu-markup-samples is installed also under: +

+		 +

+   44 +

+
+ + +
+

+ /usr/share/doc/sisu/sisu_markup_samples/non-free/_sisu/skin/doc +

+		 +

+   45 +

+
+ + +
+

+ Samples of list.yml and promo.yml (which are used to create the right column list) may be found in: +

+		 +

+   46 +

+
+ + +
+

+ /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml (or equivalent directory) +

+		 +

+   47 +

+
 
+ + + +
+ +
SiSU -->
+		 + + + + + + + + + + + + + + + + + +
+ + + TOC linked  toc  + + + + + + Full Text  scroll  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
+		 + + + + + + +
+ + << previous + + + + TOC + + + + next >> + + +
+
+ + + + +
+ + < + + + + ^ + + + + > + +

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

+ + SiSU + +

+		 + +

+ 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. +

+
+

+ + GPLv3 + +

+		 +

+ + 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! + +

+
+ + + + + +
+ \ No newline at end of file diff --git a/data/doc/manuals_generated/sisu_manual/sisu_configuration/toc.html b/data/doc/manuals_generated/sisu_manual/sisu_configuration/toc.html new file mode 100644 index 00000000..69c005c5 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_configuration/toc.html @@ -0,0 +1,564 @@ + + + + + + SiSU + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ +
SiSU -->
+		 + + + + + + + + + + + + + + + +
+ + TOC linked  toc  + + + + + Full Text  scroll  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
+		 +   + next >> +   +
+

+ +

+ +
+ + +
+ +

SiSU +

+ +

Configuration [0.58] +

+ +

Ralph Amissah +

+ +copy @ + + SiSU + + +
+ + + +

+ SiSU - Configuration [0.58],
Ralph Amissah +

+ +

+ Configuration of Environment +

+ +

+ + 1. Configuration + +

+ +
+ + 1.1 Determining the Current Configuration + +
+ +
+ + 1.2 Configuration files (config.yml) + +
+ +

+ Configuration of Documents +

+ +

+ + 2. Skins + +

+ +
+ + 2.1 Document Skin + +
+ +
+ + 2.2 Directory Skin + +
+ +
+ + 2.3 Site Skin + +
+ +
+ + 2.4 Sample Skins + +
+ +

+ + 3. Homepages + +

+ +
+ + 3.1 Home page and other custom built pages in a sub-directory + +
+ +
+ + 3.2 Home page within a skin + +
+ +

+ Document Information (metadata) +

+ +

Ralph Amissah

+

+ +

+ + + + + +
+ +
SiSU -->
+		 + + + + + + + + + + + + + + + +
+ + TOC linked  toc  + + + + + Full Text  scroll  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
+		 +   + next >> +   +
+

+ +

 

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

+ + SiSU + +

+		 + +

+ 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. +

+
+

+ + GPLv3 + +

+		 +

+ + 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! + +

+
+ + + + + + + +
+ + + + + + -- cgit v1.2.3