From 50d45c6deb0afd2e4222d2e33a45487a9d1fa676 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Sun, 23 Sep 2007 05:16:21 +0100 Subject: primarily todo with sisu documentation, changelog reproduced below: * start documenting sisu using sisu * sisu markup source files in data/doc/sisu/sisu_markup_samples/sisu_manual/ /usr/share/doc/sisu/sisu_markup_samples/sisu_manual/ * default output [sisu -3] in data/doc/manuals_generated/sisu_manual/ /usr/share/doc/manuals_generated/sisu_manual/ (adds substantially to the size of sisu package!) * help related edits * manpage, work on ability to generate manpages, improved * param, exclude footnote mark count when occurs within code block * plaintext changes made * shared_txt, line wrap visited * file:// link option introduced (in addition to existing https?:// and ftp://) a bit arbitrarily, diff here, [double check changes in sysenv and hub] * minor adjustments * html url match refinement * css added tiny_center * plaintext * endnotes fix * footnote adjustment to make more easily distinguishable from substantive text * flag -a only [flags -A -e -E dropped] controlled by modifiers --unix/msdos --footnote/endnote * defaults, homepage * renamed homepage (instead of index) implications for modifying skins, which need likewise to have any homepage entry renamed * added link to sisu_manual in homepage * css the css for the default homepage is renamed homepage.css (instead of index.css) [consider removing this and relying on html.css] * ruby version < ruby1.9 * place stop on installation and working with for now [ruby String.strip broken in ruby 1.9.0 (2007-09-10 patchlevel 0) [i486-linux], 2007-09-18:38/2] * debian/control restrict use to ruby > 1.8.4 and ruby < 1.9 * debian * debian/control restrict use to ruby > 1.8.4 and ruby < 1.9 * sisu-doc new sub-package for sisu documentation debian/control and sisu-doc.install --- .../sisu_manual/sisu_introduction/concordance.html | 1453 ++++++++++++++++++++ .../sisu_manual/sisu_introduction/digest.txt | 142 ++ .../sisu_manual/sisu_introduction/doc.html | 1400 +++++++++++++++++++ .../sisu_manual/sisu_introduction/dom.xml | 617 +++++++++ .../sisu_manual/sisu_introduction/endnotes.html | 508 +++++++ .../sisu_manual/sisu_introduction/index.html | 522 +++++++ .../sisu_manual/sisu_introduction/landscape.pdf | Bin 0 -> 115148 bytes .../sisu_manual/sisu_introduction/metadata.html | 591 ++++++++ .../sisu_manual/sisu_introduction/opendocument.odt | Bin 0 -> 14159 bytes .../sisu_manual/sisu_introduction/plain.txt | 460 +++++++ .../sisu_manual/sisu_introduction/portrait.pdf | Bin 0 -> 118844 bytes .../sisu_manual/sisu_introduction/sax.xml | 599 ++++++++ .../sisu_manual/sisu_introduction/scroll.xhtml | 576 ++++++++ .../sisu_introduction/sisu_feature_summary.html | 781 +++++++++++ .../sisu_manual/sisu_introduction/sisu_how.html | 506 +++++++ .../sisu_manual/sisu_introduction/sisu_intro.html | 699 ++++++++++ .../sisu_introduction/sisu_introduction.sst | 133 ++ .../sisu_introduction/sisu_manifest.html | 200 +++ .../sisu_manual/sisu_introduction/sisupod.zip | Bin 0 -> 8947 bytes .../sisu_manual/sisu_introduction/sitemap.xml | 30 + .../sisu_manual/sisu_introduction/toc.html | 522 +++++++ 21 files changed, 9739 insertions(+) create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_introduction/concordance.html create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_introduction/digest.txt create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_introduction/doc.html create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_introduction/dom.xml create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_introduction/endnotes.html create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_introduction/index.html create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_introduction/landscape.pdf create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_introduction/metadata.html create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_introduction/opendocument.odt create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_introduction/plain.txt create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_introduction/portrait.pdf create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_introduction/sax.xml create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_introduction/scroll.xhtml create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_introduction/sisu_feature_summary.html create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_introduction/sisu_how.html create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_introduction/sisu_intro.html create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_introduction/sisu_introduction.sst create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_introduction/sisu_manifest.html create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_introduction/sisupod.zip create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_introduction/sitemap.xml create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_introduction/toc.html (limited to 'data/doc/manuals_generated/sisu_manual/sisu_introduction') diff --git a/data/doc/manuals_generated/sisu_manual/sisu_introduction/concordance.html b/data/doc/manuals_generated/sisu_manual/sisu_introduction/concordance.html new file mode 100644 index 00000000..1094e53d --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_introduction/concordance.html @@ -0,0 +1,1453 @@ + + + + + SiSU created WordIndex for: SiSU - Commands [0.58] + + + + + + + + + + + + + + + + +
+ +
SiSU -->
+		 + + + + + + + + + + + + + + +
+ + + TOC linked  toc  + + + + + + Full Text  scroll  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
+		 +   + TOC +   +
+

+
 

SiSU - Commands [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_introduction/concordance.html#your_word ] +

+ +

Able

(5)

+

6, 8, 18, 43, 44,

+

About

(6)

+

18, 43, 45,

+

Abstract

(1)

+

43,

+

Abstraction

(6)

+

8, 11, 14, 18, 22,

+

Academics

(1)

+

32,

+

Accepted

(1)

+

23,

+

Accompanying

(1)

+

6,

+

Across

(4)

+

11, 32, 33,

+

Added

(4)

+

8, 12, 34,

+

Addition

(2)

+

34, 36,

+

Adobe

(1)

+

12,

+

Advantage

(8)

+

11, 15, 18, 22, 23, 31, 44,

+

Again

(2)

+

11, 12,

+

Against

(6)

+

9, 11, 12, 14, 18,

+

Age

(1)

+

11,

+

All

(4)

+

8, 12, 32, 33,

+

Allow

(1)

+

12,

+

Allowing

(1)

+

12,

+

Almost

(1)

+

20,

+

Also

(14)

+

6, 8, 10, 11, 12, 14, 21, 22, 31, 33, 45,

+

Alternative

(1)

+

22,

+

Always

(1)

+

12,

+

Amissah

(1)

+

[H]1,

+

Amongst

(1)

+

23,

+

And

(86)

+

5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 18, 20, 21, 22, 23, 24, 26, 31, 32, 33, 34, 35, 36, 37, 38, 40, 41, 43, 45,

+

Another

(1)

+

12,

+

Any

(2)

+

11, 18,

+

Appears

(1)

+

11,

+

Applied

(1)

+

9,

+

Are

(20)

+

9, 10, 11, 13, 18, 20, 23, 32, 33, 34, 35, 36, 45,

+

Arrived

(1)

+

45,

+

Aside

(1)

+

35,

+

Assigned

(1)

+

18,

+

Associated

(1)

+

38,

+

Attributes

(2)

+

10, 22,

+

Authored

(1)

+

18,

+

Automatic

(1)

+

10,

+

Automatically

(2)

+

38, 39,

+

Availability

(1)

+

14,

+

Available

(3)

+

12, 13, 42,

+

Base

(3)

+

11, 12, 34,

+

Based

(2)

+

11, 18,

+

Basic

(6)

+

10, 21, 22, 40,

+

Batch

(1)

+

36,

+

Become

(3)

+

12, 33,

+

Been

(2)

+

7, 12,

+

Being

(2)

+

10,

+

Beyond

(1)

+

22,

+

Blocks

(1)

+

11,

+

Bold

(1)

+

22,

+

Both

(4)

+

8, 18, 24, 26,

+

Browser

(3)

+

11, 22,

+

Browsers

(1)

+

32,

+

Builds

(3)

+

8, 9, 10,

+

Built

(1)

+

10,

+

Bundled

(1)

+

38,

+

But

(2)

+

9, 36,

+

Called

(1)

+

38,

+

Can

(15)

+

6, 8, 9, 11, 12, 15, 32,

+

Certificates

(2)

+

14, 31,

+

Certification

(1)

+

18,

+

Challenge

(1)

+

12,

+

Challenges

(1)

+

12,

+

Changed

(1)

+

9,

+

Changing

(2)

+

11, 34,

+

Chosen

(1)

+

6,

+

Chunks

(1)

+

9,

+

Citation

(5)

+

6, 7, 8, 15, 32,

+

Cite

(2)

+

11, 30,

+

Cited

(1)

+

32,

+

Citing

(2)

+

11, 32,

+

Clean

(1)

+

20,

+

Code

(3)

+

11, 12,

+

Collaborative

(1)

+

15,

+

Collections

(1)

+

34,

+

Combination

(1)

+

18,

+

Command

(1)

+

6,

+

Commands

(1)

+

[H]1,

+

Commercial

(1)

+

14,

+

Common

(7)

+

6, 7, 8, 9, 11, 32,

+

Complementary

(1)

+

15,

+

Complete

(1)

+

44,

+

Comprised

(1)

+

11,

+

Comprising

(2)

+

6, 18,

+

Concordance

(3)

+

14, 18, 31,

+

Consider

(1)

+

12,

+

Considerable

(2)

+

18, 34,

+

Consists

(1)

+

18,

+

Consortium

(1)

+

12,

+

Construct

(1)

+

43,

+

Contain

(1)

+

22,

+

Contains

(1)

+

11,

+

Content

(14)

+

8, 9, 14, 15, 18, 31, 32, 36, 43,

+

Context

(1)

+

7,

+

Convert

(1)

+

40,

+

Converted

(2)

+

12, 21,

+

Coping

(1)

+

7,

+

Core

(1)

+

22,

+

Could

(1)

+

45,

+

Course

(1)

+

40,

+

Covers

(1)

+

40,

+

Create

(1)

+

18,

+

Criteria

(2)

+

8, 9,

+

Cross

(1)

+

7,

+

Currently

(2)

+

12, 23,

+

Custom

(3)

+

8, 9, 10,

+

Database

(7)

+

8, 9, 30, 32, 33, 40, 44,

+

Databases

(3)

+

8, 31, 33,

+

Dealing

(2)

+

11, 12,

+

Default

(1)

+

11,

+

Defines

(2)

+

8, 22,

+

Degree

(4)

+

8, 9, 33, 34,

+

Dependency

(1)

+

40,

+

Depending

(1)

+

12,

+

Described

(1)

+

45,

+

Description

(2)

+

[H]3, 22,

+

Desired

(3)

+

9, 36, 38,

+

Developed

(3)

+

7, 12,

+

Developers

(1)

+

41,

+

Development

(3)

+

12, 14, 26,

+

Different

(20)

+

8, 10, 11, 18, 23, 31, 37, 43, 44, 45,

+

Digests

(1)

+

31,

+

Digital

(2)

+

11, 32,

+

Directly

(1)

+

8,

+

Discern

(1)

+

18,

+

Discuss

(1)

+

15,

+

Document

(70)

+

5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 18, 21, 22, 24, 27, 30, 31, 32, 34, 36, 37, 38, 39, 40, 43, 45,

+

Documents

(26)

+

6, 8, 9, 11, 12, 15, 18, 20, 22, 23, 31, 32, 33, 35, 36, 38, 44,

+

Does

(1)

+

17,

+

Dom

(1)

+

26,

+

Done

(3)

+

18, 22, 36,

+

Dublin

(1)

+

22,

+

Each

(6)

+

8, 9, 10, 18, 43, 45,

+

Ease

(1)

+

12,

+

Easily

(3)

+

12, 21, 22,

+

Editors

(1)

+

42,

+

Either

(1)

+

18,

+

Elegant

(1)

+

23,

+

Enables

(1)

+

11,

+

Endnotes

(1)

+

9,

+

Engine

(6)

+

6, 8, 9,

+

Engines

(2)

+

12, 32,

+

Ensuring

(1)

+

32,

+

Equating

(1)

+

9,

+

Equipment

(1)

+

12,

+

Established

(3)

+

18, 23, 44,

+

Etc

(5)

+

11, 18, 22, 31,

+

Evolved

(2)

+

12,

+

Evolving

(1)

+

7,

+

Example

(3)

+

10, 14, 45,

+

Existence

(1)

+

12,

+

Existing

(4)

+

12, 22, 34,

+

Extended

(2)

+

22,

+

Extensible

(1)

+

41,

+

Extracting

(1)

+

45,

+

Eye

(1)

+

21,

+

Fact

(1)

+

12,

+

Fairly

(1)

+

18,

+

Features

(2)

+

14, 19,

+

Few

(1)

+

40,

+

File

(3)

+

13, 20, 38,

+

Files

(6)

+

9, 14, 31, 36, 44,

+

Finalises

(1)

+

12,

+

Finalized

(1)

+

9,

+

Finding

(1)

+

43,

+

Finnish

(1)

+

6,

+

Fixed

(1)

+

9,

+

Flat

(1)

+

44,

+

Flexibility

(3)

+

12, 14, 18,

+

Flexible

(1)

+

41,

+

Font

(1)

+

11,

+

Footnotes

(2)

+

9, 10,

+

For

(37)

+

5, 6, 7, 8, 9, 10, 11, 13, 14, 15, 18, 22, 23, 26, 27, 32, 36, 40, 42, 43, 44, 45,

+

Form

(2)

+

10, 45,

+

Format

(9)

+

6, 7, 8, 11, 12, 27, 32,

+

Formats

(20)

+

5, 7, 8, 9, 11, 12, 13, 23, 32, 34, 36,

+

Forms

(3)

+

8, 10, 12,

+

Frame

(1)

+

11,

+

Framework

(1)

+

6,

+

Free

(1)

+

12,

+

Frequently

(1)

+

9,

+

From

(12)

+

6, 8, 9, 10, 18, 43, 44, 45,

+

Full

(1)

+

12,

+

Further

(5)

+

12, 14, 22, 26,

+

Future

(4)

+

12, 34,

+

Generally

(2)

+

9, 32,

+

Generate

(2)

+

8, 28,

+

Generated

(8)

+

9, 33, 35, 39, 40, 44,

+

Generating

(1)

+

6,

+

Generation

(2)

+

9, 40,

+

Given

(1)

+

45,

+

Google

(1)

+

13,

+

GPL3

(2)

+

7, 12,

+

Granting

(1)

+

18,

+

Granular

(2)

+

31, 33,

+

Granularity

(3)

+

8, 9, 33,

+

Great

(1)

+

14,

+

Guarantee

(1)

+

12,

+

Guarantees

(2)

+

12,

+

Has

(7)

+

7, 8, 11, 12, 14,

+

Hash

(3)

+

18, 45,

+

Hashes

(1)

+

45,

+

Have

(1)

+

12,

+

Having

(1)

+

34,

+

Header

(5)

+

10, 18, 22,

+

Headers

(2)

+

20, 22,

+

Heading

(3)

+

10, 11, 22,

+

Headings

(7)

+

8, 9, 11, 18, 31, 33, 45,

+

Highlighting

(1)

+

42,

+

How

(2)

+

17, 45,

+

Html

(16)

+

8, 10, 11, 12, 22, 24, 31, 44,

+

HTML

(4)

+

9, 21, 32, 40,

+

Html5

(1)

+

34,

+

Human

(1)

+

21,

+

Hyperestraier

(2)

+

13, 33,

+

Identified

(1)

+

45,

+

IEC

(1)

+

12,

+

Images

(3)

+

9, 31, 38,

+

Implications

(2)

+

8, 11,

+

Implicit

(1)

+

31,

+

Important

(2)

+

12, 32,

+

Include

(2)

+

8, 9,

+

Including

(2)

+

9, 12,

+

Inclusions

(1)

+

38,

+

Indeed

(1)

+

18,

+

Independent

(1)

+

13,

+

Index

(1)

+

45,

+

Indexed

(1)

+

44,

+

Indexing

(4)

+

13, 33,

+

Indicating

(1)

+

10,

+

Individual

(1)

+

31,

+

Individually

(3)

+

10, 22, 45,

+

Industry

(1)

+

23,

+

Information

(14)

+

6, 10, 18, 22, 33, 45,

+

Input

(2)

+

21, 37,

+

Institutionally

(1)

+

23,

+

Instructions

(2)

+

18, 22,

+

Internally

(1)

+

32,

+

Introduction

(1)

+

4,

+

ISO

(4)

+

12,

+

Iso

(1)

+

27,

+

Italics

(1)

+

22,

+

Its

(6)

+

11, 12, 15, 18,

+

Itself

(1)

+

12,

+

Just

(2)

+

8, 33,

+

Keep

(2)

+

12,

+

Krtizer

(1)

+

14,

+

Lacks

(1)

+

32,

+

Landscape

(2)

+

8, 11,

+

Language

(1)

+

38,

+

Large

(1)

+

7,

+

Largely

(1)

+

18,

+

Latex

(9)

+

8, 9, 22, 28, 29, 31, 40,

+

Law

(1)

+

14,

+

Lawyers

(1)

+

32,

+

Layout

(3)

+

18, 43,

+

Legacy

(1)

+

12,

+

Less

(1)

+

43,

+

Level

(5)

+

8, 11, 30, 31, 33,

+

Levels

(4)

+

10, 11, 18, 22,

+

Libre

(2)

+

7, 12,

+

Licence

(1)

+

12,

+

License

(2)

+

7, 12,

+

Lightly

(1)

+

8,

+

Lightweight

(1)

+

6,

+

Like

(5)

+

13, 20, 33, 40,

+

Line

(1)

+

6,

+

Literature

(1)

+

20,

+

Little

(1)

+

43,

+

Locally

(2)

+

37, 38,

+

Locating

(1)

+

9,

+

Locations

(2)

+

8, 9,

+

Long

(1)

+

34,

+

Look

(1)

+

33,

+

Lucene

(1)

+

13,

+

Machine

(1)

+

32,

+

Made

(3)

+

8, 18, 44,

+

Maintainability

(1)

+

34,

+

Maintaining

(1)

+

12,

+

Makes

(3)

+

18, 43, 45,

+

Making

(1)

+

31,

+

Man

(1)

+

32,

+

Manifests

(1)

+

31,

+

Manner

(3)

+

11, 15, 45,

+

Many

(1)

+

11,

+

Maps

(1)

+

14,

+

Marked

(2)

+

9, 34,

+

Marking

(1)

+

10,

+

Markup

(21)

+

5, 6, 7, 8, 9, 12, 18, 20, 21, 22, 42, 43,

+

Master

(1)

+

38,

+

Match

(1)

+

22,

+

Matches

(1)

+

9,

+

Matching

(1)

+

33,

+

Material

(1)

+

11,

+

May

(12)

+

9, 21, 22, 34, 36, 37, 38, 39, 43,

+

Md5

(1)

+

31,

+

Meaning

(1)

+

6,

+

Meaningful

(2)

+

32,

+

Meaningless

(1)

+

32,

+

Means

(5)

+

8, 9, 11, 12,

+

Mechanism

(1)

+

7,

+

Met

(2)

+

8, 9,

+

Metadata

(1)

+

22,

+

Migrated

(1)

+

12,

+

Minimal

(2)

+

20, 44,

+

Minimalistic

(3)

+

12, 18, 20,

+

Mnemonic

(1)

+

20,

+

Modification

(1)

+

34,

+

Module

(3)

+

12, 34,

+

More

(2)

+

8, 21,

+

Most

(2)

+

20, 21,

+

Moving

(1)

+

12,

+

Multiple

(7)

+

5, 6, 7, 12, 32, 38, 43,

+

Must

(1)

+

18,

+

Need

(1)

+

40,

+

Needs

(1)

+

36,

+

Net

(2)

+

37, 38,

+

New

(4)

+

12, 18, 34, 36,

+

Non

(1)

+

12,

+

Not

(2)

+

9, 11,

+

Number

(1)

+

42,

+

Numbered

(2)

+

9, 11,

+

Numbering

(6)

+

6, 8, 9, 11, 32,

+

Numbers

(7)

+

8, 11, 18, 32, 33,

+

Object

(12)

+

8, 9, 11, 18, 30, 31, 33,

+

Objects

(12)

+

8, 9, 11, 14, 18, 44, 45,

+

Odf

(4)

+

10, 22, 34,

+

ODF

(4)

+

8, 12, 27, 40,

+

Off

(1)

+

13,

+

Offered

(1)

+

45,

+

Offers

(1)

+

14,

+

Old

(1)

+

12,

+

Once

(3)

+

22, 35, 36,

+

One

(1)

+

12,

+

Ones

(1)

+

18,

+

Online

(2)

+

32, 44,

+

Only

(2)

+

36, 40,

+

Open

(12)

+

5, 7, 8, 9, 12, 23, 27, 34,

+

Opendocument

(1)

+

9,

+

Opposed

(1)

+

9,

+

Optimised

(1)

+

10,

+

Optional

(2)

+

18, 20,

+

Optionally

(1)

+

10,

+

Oriented

(2)

+

6, 32,

+

Other

(7)

+

12, 14, 18, 43, 45,

+

Output

(23)

+

7, 8, 9, 10, 11, 12, 23, 31, 32, 33, 34, 36,

+

Outputing

(1)

+

12,

+

Outputs

(11)

+

6, 8, 10, 32, 33, 37, 38, 39,

+

Over

(2)

+

12,

+

Page

(3)

+

11, 32,

+

Pages

(1)

+

11,

+

Paper

(3)

+

22, 32, 44,

+

Paragraph

(3)

+

9, 31, 33,

+

Paragraphs

(6)

+

8, 9, 11, 31, 33,

+

Parsable

(1)

+

21,

+

Particularly

(1)

+

9,

+

Pattern

(1)

+

22,

+

Pdf

(11)

+

10, 11, 12, 22, 28, 29, 32, 40, 44,

+

PDF

(1)

+

9,

+

Pdfs

(1)

+

8,

+

PDFs

(1)

+

31,

+

Peace

(1)

+

20,

+

Performed

(1)

+

9,

+

Permit

(1)

+

22,

+

Permits

(1)

+

12,

+

Pinpoint

(1)

+

32,

+

Plain

(1)

+

9,

+

Plaintext

(2)

+

37, 40,

+

Poems

(1)

+

11,

+

Point

(1)

+

44,

+

Popular

(1)

+

12,

+

Populate

(2)

+

8, 9,

+

Populated

(2)

+

31, 33,

+

Population

(1)

+

30,

+

Portrait

(2)

+

8, 11,

+

Possibilities

(3)

+

14, 31,

+

Possible

(6)

+

8, 18, 31, 33, 43, 45,

+

Posted

(1)

+

39,

+

Postgresql

(1)

+

32,

+

Practical

(1)

+

22,

+

Preparation

(2)

+

9, 44,

+

Prepared

(9)

+

6, 8, 9, 12, 15, 20, 34,

+

Preparing

(1)

+

10,

+

Present

(1)

+

45,

+

Presentation

(2)

+

6, 10,

+

Presentations

(1)

+

36,

+

Presenting

(1)

+

11,

+

Presumably

(1)

+

12,

+

Primarily

(5)

+

8, 10, 11, 15, 22,

+

Process

(1)

+

9,

+

Processed

(3)

+

36, 37, 38,

+

Processing

(3)

+

18, 22,

+

Processor

(1)

+

40,

+

Produce

(4)

+

6, 37, 38, 43,

+

Produced

(2)

+

31, 36,

+

Produces

(3)

+

8, 23, 31,

+

Program

(1)

+

18,

+

Proofing

(1)

+

34,

+

Proprietary

(5)

+

12,

+

Provide

(5)

+

10, 11, 32,

+

Provided

(2)

+

12, 18,

+

Provides

(6)

+

8, 9, 12, 14, 18, 33,

+

Providing

(1)

+

18,

+

Publication

(2)

+

22, 44,

+

Published

(3)

+

9, 15, 18,

+

Publishing

(8)

+

5, 6, 11, 18, 32, 43,

+

Purpose

(1)

+

44,

+

Purposes

(3)

+

18, 43, 44,

+

Quite

(1)

+

45,

+

Ralph

(1)

+

[H]1,

+

Rather

(3)

+

10, 43, 44,

+

Read

(1)

+

12,

+

Readable

(1)

+

21,

+

Reasonably

(1)

+

23,

+

Reasons

(1)

+

36,

+

Reference

(3)

+

9, 15, 32,

+

Referenced

(1)

+

9,

+

Regardless

(1)

+

32,

+

Regenerated

(1)

+

12,

+

Relate

(1)

+

45,

+

Related

(6)

+

7, 10, 12, 18, 22, 31,

+

Relation

(1)

+

18,

+

Relational

(1)

+

44,

+

Relatively

(1)

+

12,

+

Relevant

(2)

+

11, 33,

+

Reliably

(1)

+

15,

+

Relies

(1)

+

12,

+

Remain

(1)

+

12,

+

Remote

(1)

+

39,

+

Repeated

(1)

+

36,

+

Repeatedly

(1)

+

12,

+

Represent

(1)

+

11,

+

Representation

(2)

+

8, 43,

+

Representations

(7)

+

9, 14, 21, 34, 36, 43, 45,

+

Representing

(5)

+

18, 22, 23, 44,

+

Requested

(1)

+

10,

+

Require

(1)

+

20,

+

Required

(5)

+

12, 22, 26, 35,

+

Research

(1)

+

14,

+

Rest

(1)

+

10,

+

Results

(1)

+

8,

+

Returned

(1)

+

9,

+

Rights

(1)

+

18,

+

Rogers

(1)

+

14,

+

Roughly

(1)

+

33,

+

Ruby

(1)

+

40,

+

Run

(1)

+

12,

+

Running

(2)

+

9,

+

Same

(2)

+

21, 30,

+

Saved

(3)

+

10, 45,

+

Sax

(1)

+

26,

+

Say

(1)

+

44,

+

Screen

(1)

+

32,

+

Scrollable

(1)

+

24,

+

Search

(16)

+

5, 6, 7, 8, 9, 11, 18, 22, 31, 32, 33, 35, 43, 44,

+

Searchable

(1)

+

33,

+

Searches

(2)

+

8, 9,

+

Security

(1)

+

12,

+

Seeks

(1)

+

32,

+

Segmented

(1)

+

24,

+

Selected

(1)

+

32,

+

Semantic

(2)

+

10, 22,

+

Sent

(1)

+

38,

+

Separately

(1)

+

9,

+

Serialized

(2)

+

6, 45,

+

Serializes

(1)

+

18,

+

Sets

(1)

+

7,

+

Several

(1)

+

8,

+

Sha256

(1)

+

31,

+

Share

(4)

+

6, 8, 9, 32,

+

Shared

(2)

+

37, 38,

+

Short

(1)

+

12,

+

Shown

(1)

+

8,

+

Significant

(1)

+

11,

+

Significantly

(1)

+

8,

+

Simpler

(1)

+

21,

+

Single

(3)

+

8, 20, 24,

+

Sisu

(10)

+

6, 8, 9, 10, 17, 32,

+

SiSU

(31)

+

[H]1, [H]2, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 18, 22, 42, 43,

+

Sisupod

(1)

+

38,

+

Site

(1)

+

13,

+

Sitemaps

(1)

+

31,

+

Sites

(1)

+

39,

+

Sized

(1)

+

9,

+

Software

(6)

+

7, 12, 40,

+

Solution

(1)

+

45,

+

Some

(2)

+

18, 44,

+

Sometime

(1)

+

34,

+

Source

(11)

+

7, 9, 12, 20, 21, 34, 37, 38,

+

Span

(1)

+

12,

+

Sparse

(3)

+

8, 20, 21,

+

Sparsely

(1)

+

34,

+

Specification

(2)

+

12,

+

SQL

(4)

+

8, 9, 33, 35,

+

Sql

(4)

+

22, 30,

+

Sqlite

(1)

+

32,

+

Standard

(11)

+

5, 6, 8, 9, 12, 22, 23, 27, 40,

+

Standards

(1)

+

8,

+

Starting

(1)

+

44,

+

Static

(2)

+

35, 36,

+

Step

(1)

+

9,

+

Storage

(1)

+

27,

+

Strengths

(6)

+

11, 18, 22, 23, 31, 44,

+

Strike

(1)

+

22,

+

Structural

(1)

+

45,

+

Structure

(11)

+

6, 8, 10, 11, 14, 18, 22,

+

Structured

(1)

+

6,

+

Structures

(1)

+

26,

+

Structuring

(2)

+

6,

+

Style

(1)

+

26,

+

Submitted

(1)

+

12,

+

Subsequently

(1)

+

9,

+

Substance

(1)

+

15,

+

Substantive

(2)

+

10, 18,

+

Such

(3)

+

14, 15, 18,

+

Suitable

(1)

+

9,

+

Suited

(1)

+

11,

+

Sum

(1)

+

18,

+

Summary

(1)

+

19,

+

Sums

(1)

+

18,

+

Supported

(1)

+

23,

+

Syntax

(6)

+

6, 8, 9, 20, 42,

+

System

(8)

+

5, 6, 8, 9, 13, 15, 32,

+

Tables

(3)

+

9, 11, 33,

+

Take

(5)

+

11, 15, 18, 44,

+

Takes

(2)

+

23, 31,

+

Taking

(1)

+

22,

+

Target

(1)

+

12,

+

Technologies

(2)

+

7, 15,

+

Technology

(1)

+

36,

+

Term

(2)

+

6, 34,

+

Terms

(1)

+

12,

+

Tetex

(1)

+

40,

+

Texlive

(1)

+

40,

+

Text

(19)

+

6, 8, 9, 10, 11, 12, 18, 22, 24, 30, 32, 34, 42,

+

Texts

(3)

+

9, 20, 34,

+

Than

(4)

+

8, 10, 21, 43,

+

That

(27)

+

6, 8, 9, 10, 11, 12, 22, 30, 32, 33, 40, 43, 44, 45,

+

The

(105)

+

6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 18, 20, 21, 22, 23, 27, 30, 31, 32, 33, 37, 38, 40, 44, 45,

+

Their

(3)

+

18, 45,

+

Them

(2)

+

12,

+

There

(1)

+

34,

+

Thesaurus

(1)

+

14,

+

These

(7)

+

8, 9, 11, 31, 38,

+

They

(2)

+

9, 12,

+

This

(10)

+

9, 10, 11, 18, 21, 22, 32, 36, 40, 44,

+

Those

(1)

+

45,

+

Through

(1)

+

22,

+

Tied

(1)

+

9,

+

Time

(2)

+

12,

+

Today

(1)

+

12,

+

Together

(3)

+

11, 14, 38,

+

Too

(1)

+

38,

+

Tool

(1)

+

41,

+

Tools

(3)

+

13, 33, 40,

+

Topic

(1)

+

14,

+

Tracking

(1)

+

45,

+

Two

(1)

+

9,

+

Type

(1)

+

8,

+

Typeface

(1)

+

18,

+

Types

(3)

+

11, 31,

+

Typesetting

(1)

+

31,

+

Typical

(1)

+

20,

+

Uncomplicated

(1)

+

12,

+

Under

(4)

+

7, 12,

+

Underscore

(1)

+

22,

+

Units

(2)

+

6, 11,

+

Universe

(1)

+

6,

+

Unix

(2)

+

6, 40,

+

Updated

(9)

+

8, 9, 12, 36,

+

Upgradeable

(1)

+

34,

+

Use

(3)

+

11, 12, 40,

+

Used

(9)

+

10, 11, 12, 15, 28, 30, 32, 37, 43,

+

Useful

(2)

+

14, 32,

+

Users

(1)

+

12,

+

Using

(4)

+

9, 11, 20, 31,

+

Utf

(2)

+

20, 37,

+

UTF

(1)

+

20,

+

Utilized

(1)

+

32,

+

Values

(2)

+

18, 45,

+

Various

(3)

+

9, 23, 36,

+

Verse

(2)

+

9, 33,

+

Version

(2)

+

10,

+

Versions

(1)

+

38,

+

Very

(2)

+

31, 34,

+

Via

(1)

+

29,

+

Viewed

(1)

+

8,

+

Viewing

(2)

+

22, 44,

+

Vikki

(1)

+

14,

+

W3c

(1)

+

12,

+

Want

(1)

+

7,

+

War

(1)

+

20,

+

Was

(2)

+

12, 18,

+

Way

(6)

+

12, 32, 43,

+

Ways

(6)

+

11, 18, 22, 44,

+

Web

(3)

+

11, 12, 13,

+

Well

(2)

+

15, 33,

+

What

(4)

+

[H]2, 4, 12, 18,

+

When

(2)

+

12, 18,

+

Where

(1)

+

10,

+

Whether

(5)

+

13, 32, 43, 44,

+

Which

(26)

+

6, 7, 8, 9, 11, 12, 15, 18, 32, 33, 43, 45,

+

Whilst

(1)

+

12,

+

Who

(1)

+

18,

+

Wide

(1)

+

12,

+

Wikis

(1)

+

15,

+

Will

(3)

+

12,

+

With

(21)

+

7, 8, 9, 11, 12, 14, 15, 31, 33, 38, 43, 45,

+

Within

(12)

+

6, 8, 9, 11, 18, 30, 32, 33, 45,

+

Without

(3)

+

12, 34,

+

Work

(2)

+

17, 33,

+

Working

(1)

+

14,

+

Works

(6)

+

8, 9, 11, 15,

+

World

(2)

+

12, 34,

+

Would

(1)

+

12,

+

Written

(2)

+

12, 13,

+

XHTML

(1)

+

9,

+

Xhtml

(1)

+

25,

+

Xml

(4)

+

22, 26, 32, 44,

+

XML

(4)

+

9, 21, 26, 40,

+

Yahoo

(1)

+

13,

+

Years

(2)

+

12,

+

You

(5)

+

7, 10, 12, 40,

+

Your

(2)

+

8, 9,

+

Zip

(1)

+

38,

+ + + + + + +
+ +
+

+ + 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_introduction/digest.txt b/data/doc/manuals_generated/sisu_manual/sisu_introduction/digest.txt new file mode 100644 index 00000000..7c96422f --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_introduction/digest.txt @@ -0,0 +1,142 @@ +SiSU - Commands [0.58] +Ralph Amissah +sisu_introduction.sst +---------------------------------------------- +SiSU Document Content Certificate (Digest/DCC) +---------------------------------------------- + md5 digests +------------ +Sourcefile digest: b2a6da5bd22fa1eaa92a08d81f11d1c7 + source filename: sisu_introduction.sst +available outputs: http://www.jus.uio.no/sisu/sisu_manual/sisu_introduction/sisu_manifest.html + time generated: Sun Sep 23 04:10:58 +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 e3bf90d616a655294d70ce907b77b261 52fef05769a6fabfd5b0fc9fdf3dd1a0 + :B - 2 72ae85c23dc80bfae76c4ce37b6e4ed0 69113f989aa5ff0d1d71e99a0e8c986d + :C - 3 b5a7adde1af5c87d7fd797b6245c2a39 6bf580887ebb772a71733b69ac0b7a74 + 1 - 4 b0f01615a4565354c1af650bcd2a74bf 0af3e4addba13fa6e64266875122a6a3 + - 5 d656e6f5d897ebd83ffefb165ed1b6f5 550ab326f412b38d87cb29e081acfa6c + - 6 a4cac4cc04eb9861cd619a38f76a3d0d 9eb34e9763fcc2f7ace7a2077cbf1bab + [1] 80531713b93fa8bd7b8cba885141f0c7 + [2] 22dcc282aed2c5a781426f13c10acb95 + - 7 3688076676c476acd9cba6b368ec59e6 2f95b5020ae814f95368557972632799 + - 8 d8254c750f7cc833d27dd4cc27de672e f9c68a484610c483f76be4de62fb36ee + - 9 36965e07fcee48e4c67bbceedb89801a b1f3a20c72476a2121c7d2dd5ea938f6 + [3] c693e995e4b337e1a0be8219aaf16767 + - 10 e2385bf240243fc8b35874618bd33fba 3231e5a2d5a5e72995777f4f32b02d98 + [4] 80dc1e1a73e854be5e0e0c5a06643782 + - 11 8c4077bcc3731f71fd28ccb8b97235b4 83a9bfbf26309483e2f2169ef63c78f8 + [5] a4dfd0e519ef17707cd00420b16a4b63 + [6] 12ec9f12db292797854d580d66aa2c33 + - 12 92e232b316ea10d53ddb10e51d7537e5 7806592c011a51e539bf93e2c959d82c + [7] bf615122f77300b33fe341ebc6312e21 + [8] 7d106ec47e272995a23de7df463b19ac + - 13 36045f4093538d5b092891e139830f30 ef207ed5f9df5b9d61a5d0d0d46c45bb + - 14 bd63bb125ae11aa830d1bede0102c64f e928ef9ed3a57545fcaa42d004bbb497 + - 15 e8c86735f8f41e3667ff0fa397f7b6dd 66a0b4c9c9e479066e56b7e839abefcb + - 16 586b179b53a0fe074bf210a4a84a87ef fd6d7cced2084551f8230fa27869e702 + 1 - 17 aadab7024fb9cdfb12403d4c89a6a944 7c2d149ed26a9575f99ce5ac85e43d9d + - 18 69c10bd90e9a098c12128db6fafc255a ab7a2808aae62190e5373e89f8006f22 + 1 - 19 b9d37c5f477bc983f1fca2f7a527aa94 c4eea6f045c57cdc08017cb3daa1009f + - 20 f613b092c1b51b962e546f96a73254ab ecbe3a3a4438ebd4498eaf4f10d17883 + - 21 751bd415293a87d28cbe751f6c0ffedd 6d88a713787e03447c84ea8ebac081b4 + - 22 1a0d9ac5d8553f328f434f8331be7e97 bde0713435f5b083b76e1e0a7f3bf3c2 + - 23 db3addd2a00a06dbba27468a3ed4beda a0874c1b2e4b302a7774dae41dcfa23a + - 24 c4074398ce5034434ff19a6d06b3697a 5a4935f1e6c98b334a14f9651a6807ca + - 25 1eb4cb1ead2235ff18dc2efe9894e4f2 93bec90aafb36b6d290af783bc08fcc8 + - 26 0ef6d375acd8438add9fe45901a65040 d647789a49f484524d8d701f5c3abf53 + - 27 8fff8b865b2b5e22d1e8af6c3c289c27 fc2fd4b3e4e39ef9aba677e620e5cfed + - 28 c7ea15cc6520696981c9a8ed9d66e3a0 d9b1c769cf73f5278e837bf8ffb233a2 + - 29 79a587c3791c334809bf1477d19902f4 28b473bf11b1dd31fb0126e790037881 + - 30 2f925ae50305a4d5fde3c6f56e39b426 17fb145ea19f6eeef96533cb613d8501 + - 31 3f9736022cd99e9665463d69eb9a881f d40e5ae0831035c792138ee1b36e1fc7 + - 32 92e10c0f8c39fbf3869cc973f6867329 377c5d343f909c74e6878791dae7d2e1 + - 33 b3be0d874e2a9d25a09d5c9128d2c7e4 a8eefd3e89a1a1f2406a49c6abf8f678 + - 34 9bf05c9360fc29a4fcf4e7b61e329d65 31f0789603822dc426f2a14ebdc0823d + - 35 53a1073bf8748ec137dd35c7008febc1 29645317e8efb3d2e69504ff5ce2918e + - 36 a562a7cf2093a1bab66fbe2566845b02 db11cbed4622eec2d9a46e33d551f8fe + - 37 8c536736d3a0ac580f7457e3ba46a71f 10bc0105211e40043ec7a60120f87c27 + - 38 a08087d3ef22c85d8e7d3f733b326e47 a3e7b200d30e28d382af2238ff77e0ae + - 39 41e71153376dcb6aef6d2b3d4c666012 815815ac32401cfa1080bb2fe50acb6f + - 40 1c15d0e19702fa5169838af49a1e8a4c 4593f1fd00f9af9441fd8e54b7ace56d + - 41 d7244e88d26045932ba77e66eee6e930 7d9727ca04961c59fe6921a2c44a0c5e + - 42 dc52951a757b479cd4324fa3ca49994e 40e47d39cdea9b543cda275002762d0e + - 43 f15f344be7624f64e64525da8eaf3a7b 9d462d555e2ee2adc0fa636e39adb136 + - 44 fb5c2a3e408175c067fe06fb612c5018 6c12b2a98ff29b50bc1998733346465b + - 45 1ae909ec2450b96b76bd69b46dae2451 75dda2b43ae0598bd0ab8ed827b99a78 + 1 - 0 cc4947558ec26d67c755c76262f85131 c7a5392e3bd6d769d940d79b19a68e4c + :A - 0 5b23a6f796c80555992b9b68cfdbc2bb 5fbbfb7933004e25553d56929ed7e545 + 1 - 0 ce21470ab49d1d1976bc3dc72438c183 f2709633c4c07e46bf6aeef624e8a736 + - 0 74346df81a8da9784025ef3c254d96d8 c4ef0a89ee55120ac93fbd079df121fd + + - 0 3bca2a5af45d3d764dd73c03690cd66e ac56056f12b17cdaf50a68e61c70c01e + + - 0 ebd0aa03a5f7fa6f0e2d38b9676fb155 6f43d92a036c9944794c8582322b5875 + +dc title - 0 d49cb1e4bda0eaabeee865663d09925d 1108fb840fbb6c8c2c85940f17762055 + +dc creator - 0 0679b0c2bbba4dc8a8eea763236c903f e64313bcf0600cea90bc0935c74877cc + +dc rights - 0 0e230d9710d8294315f77233e2b11ef9 94f3688a12e01bb32bff91cf018e0aae + +dc type - 0 7ff1b8f5fc0daaa20ab922214e3a045c ff73c0e3a5d9de30b22e26cd2ad33690 + +dc date created - 0 cb35879552fc1bf1b910d906c181a1c0 449aac6b2dc0ececc07a37d174561d31 + +dc date issued - 0 73eb6864ff85079ef9dd3a08e07d320a c71b78ab67a35af417f840927614569a + +dc date available - 0 cde7f100c467fb089801f7e258d6cbe1 2040f1e6092e7d496e40b4ec26a58af7 + +dc date modified - 0 d325bb430d51f592e18ecd88b488cf97 0140c70c106aab09eb65289d8332dec0 + +dc date - 0 c8d7d2f3fe839d8e3a4f8f0abb18e8b1 0e048ac65f0bf92fba616933ffe7acbe + + - 0 9d11e23779d9604067dd20e359117573 3f883fb08147a237efaeb152bfaaa1ee + +sourcefile - 0 b0f9f9c18d38544f445a09c7e24d80bb cfa567c6f378d24e93b063e31d9fa12a + + - 0 17203f69248647e7b48ad6da99d5002c 7cbc2dd56f1601bfe10a607940b5ef6a + + - 0 d23e86b136182f660d20cd2ac8ce3fb0 b810c6ca17f2cb0c3f0ff47f6ee457bd + source b2a6da5bd22fa1eaa92a08d81f11d1c7 sisu_introduction.sst + + - 0 b57a2a5f0948b054d5b755c5b93cbdd6 94dcd9e8be6ede945e89ef2ae152fa9a + skin 20fc43cf3eb6590bc3399a1aef65c5a9 skin_sisu_manual.rb + + - 0 5c5f06440fcb85cd5c8cfafe32e34b78 d8f5595da03dd0c38d62b56492f5eb0f + +document (metaverse) last generated - 0 58eae0ee2b1e2b8cc9834218b6efb491 e046579afd9818c711f6954868258b88 + +generated by - 0 96f99dc6b8b2209e22e49bcdbb9e0497 1533ff37a88b9cb74747383c1a8b8598 + +ruby version - 0 37cf2ede6f4722230340c84e2753e412 4ccb32a8ff87fa8b6600884d16e2d685 +------------ +document structure[*] +:A + :B + :C + 1 + 1 + 1 + 1 +:A + 1 + [*] heading levels +------------ +document structure[*] +@ = 15 +:A = 2 +:B = 1 +:C = 1 +1 = 5 +objects (ocn) = 45 +endnotes = 7 + [*] 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_introduction/doc.html b/data/doc/manuals_generated/sisu_manual/sisu_introduction/doc.html new file mode 100644 index 00000000..1f078833 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_introduction/doc.html @@ -0,0 +1,1400 @@ + + + + + + SiSU + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ +
SiSU -->
+		 + + + + + + + + + + + + + + + +
+ + Full Text  scroll  + + + + + TOC linked  toc  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
+		 +   +
+

+ +

+ +
+ + +
+ +

SiSU +

+ +

Commands [0.58] +

+ +

Ralph Amissah +

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

Copyright ©  Ralph Amissah 2007, part of SiSU documentation, License GPL 3

+

+ +
+ +

+ SiSU - Commands [0.58],
Ralph Amissah +

+ +

+ What is SiSU? +

+ +

+ Description +

+ +

+ 1. Introduction - What is SiSU? +

+ +

+ 2. How does sisu work? +

+ +

+ 3. Summary of features +

+ +

+ +

+ +

+ Document Information (metadata) +

+ + + + +
+

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

+		 +

+   1 +

+
+ + + + +
+

+ + What is SiSU? +

+		 +

+   2 +

+
+ + + + +
+

+ + Description +

+		 +

+   3 +

+
+ + + + +
+

+ + 1. Introduction - What is SiSU? +

+		 +

+   4 +

+
+ + + + +
+

+ SiSU is a system for document markup, publishing (in multiple open standard formats) and search +

+		 +

+   5 +

+
+ + + + +
+

+ SiSU  1  is a  2  framework for document structuring, publishing and search, comprising of (a) a lightweight document structure and presentation markup syntax and (b) an accompanying engine for generating standard document format outputs from documents prepared in sisu markup syntax, which is able to produce multiple standard outputs that (can) share a common numbering system for the citation of text within a document. +

+		 +

+   6 +

+
+ + + + +
+

+ SiSU is developed under an open source, software libre license (GPL3). It has been developed in the context of coping with large document sets with evolving markup related technologies, for which you want multiple output formats, a common mechanism for cross-output-format citation, and search. +

+		 +

+   7 +

+
+ + + + +
+

+ SiSU both defines a markup syntax and provides an engine that produces open standards format outputs from documents prepared with SiSU markup. From a single lightly prepared document sisu custom builds several standard output formats which share a common (text object) numbering system for citation of content within a document (that also has implications for search). The sisu engine works with an abstraction of the document's structure and content from which it is possible to generate different forms of representation of the document. Significantly SiSU markup is more sparse than html and outputs which include html, LaTeX, landscape and portrait pdfs, Open Document Format (ODF), all of which can be added to and updated. SiSU is also able to populate SQL type databases at an object level, which means that searches can be made with that degree of granularity. Results of objects (primarily paragraphs and headings) can be viewed directly in the database, or just the object numbers shown - your search criteria is met in these documents and at these locations within each document. +

+		 +

+   8 +

+
+ + + + +
+

+ Source document preparation and output generation is a two step process: (i) document source is prepared, that is, marked up in sisu markup syntax and (ii) the desired output subsequently generated by running the sisu engine against document source. Output representations if updated (in the sisu engine) can be generated by re-running the engine against the prepared source. Using SiSU markup applied to a document, SiSU custom builds various standard open output formats including plain text, HTML, XHTML, XML, OpenDocument, LaTeX or PDF files, and populate an SQL database with objects  3  (equating generally to paragraph-sized chunks) so searches may be performed and matches returned with that degree of granularity ( e.g. your search criteria is met by these documents and at these locations within each document). Document output formats share a common object numbering system for locating content. This is particularly suitable for "published" works (finalized texts as opposed to works that are frequently changed or updated) for which it provides a fixed means of reference of content. +

+		 +

+   9 +

+
+ + + + +
+

+ In preparing a SiSU document you optionally provide semantic information related to the document in a document header, and in marking up the substantive text provide information on the structure of the document, primarily indicating heading levels and footnotes. You also provide information on basic text attributes where used. The rest is automatic, sisu from this information custom builds  4  the different forms of output requested. +

+		 +

+   10 +

+
+ + + + +
+

+ SiSU works with an abstraction of the document based on its structure which is comprised of its frame  5  and the objects  6  it contains, which enables SiSU to represent the document in many different ways, and to take advantage of the strengths of different ways of presenting documents. The objects are numbered, and these numbers can be used to provide a common base for citing material within a document across the different output format types. This is significant as page numbers are not suited to the digital age, in web publishing, changing a browser's default font or using a different browser means that text appears on different pages; and in publishing in different formats, html, landscape and portrait pdf etc. again page numbers are of no use to cite text in a manner that is relevant against the different output types. Dealing with documents at an object level together with object numbering also has implications for search. +

+		 +

+   11 +

+
+ + + + +
+

+ One of the challenges of maintaining documents is to keep them in a format that would allow users to use them without depending on a proprietary software popular at the time. Consider the ease of dealing with legacy proprietary formats today and what guarantee you have that old proprietary formats will remain (or can be read without proprietary software/equipment) in 15 years time, or the way the way in which html has evolved over its relatively short span of existence. SiSU provides the flexibility of outputing documents in multiple non-proprietary open formats including html, pdf  7  and the ISO standard ODF.  8  Whilst SiSU relies on software, the markup is uncomplicated and minimalistic which guarantees that future engines can be written to run against it. It is also easily converted to other formats, which means documents prepared in SiSU can be migrated to other document formats. Further security is provided by the fact that the software itself, SiSU is available under GPL3 a licence that guarantees that the source code will always be open, and free as in libre which means that that code base can be used updated and further developed as required under the terms of its license. Another challenge is to keep up with a moving target. SiSU permits new forms of output to be added as they become important, (Open Document Format text was added in 2006), and existing output to be updated (html has evolved and the related module has been updated repeatedly over the years, presumably when the World Wide Web Consortium (w3c) finalises html 5 which is currently under development, the html module will again be updated allowing all existing documents to be regenerated as html 5). +

+		 +

+   12 +

+
+ + + + +
+

+ The document formats are written to the file-system and available for indexing by independent indexing tools, whether off the web like Google and Yahoo or on the site like Lucene and Hyperestraier. +

+		 +

+   13 +

+
+ + + + +
+

+ SiSU also provides other features such as concordance files and document content certificates, and the working against an abstraction of document structure has further possibilities for the research and development of other document representations, the availability of objects is useful for example for topic maps and the commercial law thesaurus by Vikki Rogers and Al Krtizer, together with the flexibility of SiSU offers great possibilities. +

+		 +

+   14 +

+
+ + + + +
+

+ SiSU is primarily for published works, which can take advantage of the citation system to reliably reference its documents. SiSU works well in a complementary manner with such collaborative technologies as Wikis, which can take advantage of and be used to discuss the substance of content prepared in SiSU. +

+		 +

+   15 +

+
+ + + + +
+

+ <http://www.jus.uio.no/sisu> +

+		 +

+   16 +

+
+ + + + +
+

+ + 2. How does sisu work? +

+		 +

+   17 +

+
+ + + + +
+

+ SiSU markup is fairly minimalistic, it consists of: a (largely optional) document header, made up of information about the document (such as when it was published, who authored it, and granting what rights) and any processing instructions; and markup within the substantive text of the document, which is related to document structure and typeface. SiSU must be able to discern the structure of a document, (text headings and their levels in relation to each other), either from information provided in the document header or from markup within the text (or from a combination of both). Processing is done against an abstraction of the document comprising of information on the document's structure and its objects,[2] which the program serializes (providing the object numbers) and which are assigned hash sum values based on their content. This abstraction of information about document structure, objects, (and hash sums), provides considerable flexibility in representing documents different ways and for different purposes (e.g. search, document layout, publishing, content certification, concordance etc.), and makes it possible to take advantage of some of the strengths of established ways of representing documents, (or indeed to create new ones). +

+		 +

+   18 +

+
+ + + + +
+

+ + 3. Summary of features +

+		 +

+   19 +

+
+ + + + +
+
  • + sparse/minimal markup (clean utf-8 source texts). Documents are prepared in a single UTF-8 file using a minimalistic mnemonic syntax. Typical literature, documents like "War and Peace" require almost no markup, and most of the headers are optional. +
    • +    		 +

    +   20 +

    +
    + + + + +
    +
  • + markup is easily readable/parsable by the human eye, (basic markup is simpler and more sparse than the most basic HTML), [this may also be converted to XML representations of the same input/source document]. +
    • +    		 +

    +   21 +

    +
    + + + + +
    +
  • + markup defines document structure (this may be done once in a header pattern-match description, or for heading levels individually); basic text attributes (bold, italics, underscore, strike-through etc.) as required; and semantic information related to the document (header information, extended beyond the Dublin core and easily further extended as required); the headers may also contain processing instructions. SiSU markup is primarily an abstraction of document structure and document metadata to permit taking advantage of the basic strengths of existing alternative practical standard ways of representing documents [be that browser viewing, paper publication, sql search etc.] (html, xml, odf, latex, pdf, sql) +
    • +    		 +

    +   22 +

    +
    + + + + +
    +
  • + for output produces reasonably elegant output of established industry and institutionally accepted open standard formats.[3] takes advantage of the different strengths of various standard formats for representing documents, amongst the output formats currently supported are: +
    • +    		 +

    +   23 +

    +
    + + + + +
    +
  • + html - both as a single scrollable text and a segmented document +
    • +    		 +

    +   24 +

    +
    + + + + +
    +
  • + xhtml +
    • +    		 +

    +   25 +

    +
    + + + + +
    +
  • + XML - both in sax and dom style xml structures for further development as required +
    • +    		 +

    +   26 +

    +
    + + + + +
    +
  • + ODF - open document format, the iso standard for document storage +
    • +    		 +

    +   27 +

    +
    + + + + +
    +
  • + LaTeX - used to generate pdf +
    • +    		 +

    +   28 +

    +
    + + + + +
    +
  • + pdf (via LaTeX) +
    • +    		 +

    +   29 +

    +
    + + + + +
    +
  • + sql - population of an sql database, (at the same object level that is used to cite text within a document) +
    • +    		 +

    +   30 +

    +
    + + + + +
    +

    + Also produces: concordance files; document content certificates (md5 or sha256 digests of headings, paragraphs, images etc.) and html manifests (and sitemaps of content). (b) takes advantage of the strengths implicit in these very different output types, (e.g. PDFs produced using typesetting of LaTeX, databases populated with documents at an individual object/paragraph level, making possible granular search (and related possibilities)) +

    +    		 +

    +   31 +

    +
    + + + + +
    +
  • + ensuring content can be cited in a meaningful way regardless of selected output format. Online publishing (and publishing in multiple document formats) lacks a useful way of citing text internally within documents (important to academics generally and to lawyers) as page numbers are meaningless across browsers and formats. sisu seeks to provide a common way of pinpoint the text within a document, (which can be utilized for citation and by search engines). The outputs share a common numbering system that is meaningful (to man and machine) across all digital outputs whether paper, screen, or database oriented, (pdf, HTML, xml, sqlite, postgresql), this numbering system can be used to reference content. +
    • +    		 +

    +   32 +

    +
    + + + + +
    +
  • + Granular search within documents. SQL databases are populated at an object level (roughly headings, paragraphs, verse, tables) and become searchable with that degree of granularity, the output information provides the object/paragraph numbers which are relevant across all generated outputs; it is also possible to look at just the matching paragraphs of the documents in the database; [output indexing also work well with search indexing tools like hyperestraier]. +
    • +    		 +

    +   33 +

    +
    + + + + +
    +
  • + long term maintainability of document collections in a world of changing formats, having a very sparsely marked-up source document base. there is a considerable degree of future-proofing, output representations are "upgradeable", and new document formats may be added. e.g. addition of odf (open document text) module in 2006 and in future html5 output sometime in future, without modification of existing prepared texts +
    • +    		 +

    +   34 +

    +
    + + + + +
    +
  • + SQL search aside, documents are generated as required and static once generated. +
    • +    		 +

    +   35 +

    +
    + + + + +
    +
  • + documents produced are static files, and may be batch processed, this needs to be done only once but may be repeated for various reasons as desired (updated content, addition of new output formats, updated technology document presentations/representations) +
    • +    		 +

    +   36 +

    +
    + + + + +
    +
  • + document source (plaintext utf-8) if shared on the net may be used as input and processed locally to produce the different document outputs +
    • +    		 +

    +   37 +

    +
    + + + + +
    +
  • + document source may be bundled together (automatically) with associated documents (multiple language versions or master document with inclusions) and images and sent as a zip file called a sisupod, if shared on the net these too may be processed locally to produce the desired document outputs +
    • +    		 +

    +   38 +

    +
    + + + + +
    +
  • + generated document outputs may automatically be posted to remote sites. +
    • +    		 +

    +   39 +

    +
    + + + + +
    +
  • + for basic document generation, the only software dependency is Ruby, and a few standard Unix tools (this covers plaintext, HTML, XML, ODF, LaTeX). To use a database you of course need that, and to convert the LaTeX generated to pdf, a latex processor like tetex or texlive. +
    • +    		 +

    +   40 +

    +
    + + + + +
    +
  • + as a developers tool it is flexible and extensible +
    • +    		 +

    +   41 +

    +
    + + + + +
    +

    + Syntax highlighting for SiSU markup is available for a number of text editors. +

    +    		 +

    +   42 +

    +
    + + + + +
    +

    + SiSU is less about document layout than about finding a way with little markup to be able to construct an abstract representation of a document that makes it possible to produce multiple representations of it which may be rather different from each other and used for different purposes, whether layout and publishing, or search of content +

    +    		 +

    +   43 +

    +
    + + + + +
    +

    + i.e. to be able to take advantage from this minimal preparation starting point of some of the strengths of rather different established ways of representing documents for different purposes, whether for search (relational database, or indexed flat files generated for that purpose whether of complete documents, or say of files made up of objects), online viewing (e.g. html, xml, pdf), or paper publication (e.g. pdf)... +

    +    		 +

    +   44 +

    +
    + + + + +
    +

    + the solution arrived at is by extracting structural information about the document (about headings within the document) and by tracking objects (which are serialized and also given hash values) in the manner described. It makes possible representations that are quite different from those offered at present. For example objects could be saved individually and identified by their hashes, with an index of how the objects relate to each other to form a document. +

    +    		 +

    +   45 +

    +
    + + + + +
    +

    + + Endnotes +

    +    		 +

    +   0 +

    +
    + + + +
    + +

    +

    +

    		 +   +
    + + + + +
    +

    +  1. "SiSU information Structuring Universe" or "Structured information, Serialized Units".
    also chosen for the meaning of the Finnish term "sisu". +

    +    		 +   +
    + + + + +
    +

    +  2. Unix command line oriented +

    +    		 +   +
    + + + + +
    +

    +  3. objects include: headings, paragraphs, verse, tables, images, but not footnotes/endnotes which are numbered separately and tied to the object from which they are referenced. +

    +    		 +   +
    + + + + +
    +

    +  4. i.e. the html, pdf, odf outputs are each built individually and optimised for that form of presentation, rather than for example the html being a saved version of the odf, or the pdf being a saved version of the html. +

    +    		 +   +
    + + + + +
    +

    +  5. the different heading levels +

    +    		 +   +
    + + + + +
    +

    +  6. units of text, primarily paragraphs and headings, also any tables, poems, code-blocks +

    +    		 +   +
    + + + + +
    +

    +  7. Specification submitted by Adobe to ISO to become a full open ISO specification
    <http://www.linux-watch.com/news/NS7542722606.html> +

    +    		 +   +
    + + + + +
    +

    +  8. ISO/IEC 26300:2006 +

    +    		 +   +
    + + + + +
    +

    + + Document Information (metadata) +

    +    		 +

    +   0 +

    +
    + +

    + Metadata +

    + + +     + + + + + +
    +

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

    		 +
    + + + +
    +

    + Dublin Core (DC) +

    		 +
    + + + +
    +

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

    		 +
    + + + +
    +

    + DC Title: SiSU - Commands [0.58] +

    		 +
    + + + +
    +

    + DC Creator: Ralph Amissah +

    		 +
    + + + +
    +

    + DC Rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +

    		 +
    + + + +
    +

    + DC Type: information +

    		 +
    + + + +
    +

    + DC Date created: 2002-08-28 +

    		 +
    + + + +
    +

    + DC Date issued: 2002-08-28 +

    		 +
    + + + +
    +

    + DC Date available: 2002-08-28 +

    		 +
    + + + +
    +

    + DC Date modified: 2007-09-16 +

    		 +
    + + + +
    +

    + DC Date: 2007-09-16 +

    		 +
    + + + +
    +

    + Version Information +

    		 +
    + + + +
    +

    + Sourcefile: sisu_introduction.sst +

    		 +
    + + + +
    +

    + Filetype: SiSU text 0.58 +

    		 +
    + + + +
    +

    + Sourcefile Digest, MD5(sisu_introduction.sst)= b2a6da5bd22fa1eaa92a08d81f11d1c7 +

    		 +
    + + + +
    +

    + 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:10:58 +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_introduction/dom.xml b/data/doc/manuals_generated/sisu_manual/sisu_introduction/dom.xml new file mode 100644 index 00000000..644f61e1 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_introduction/dom.xml @@ -0,0 +1,617 @@ + + + + + + + + +
    + Title: + + SiSU - Commands [0.58] + +
    + +
    + Creator: + + Ralph Amissah + +
    + +
    + Rights: + + Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +
    + +
    + Type: + + information + +
    + +
    + Subject: + + ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +
    + +
    + Date created: + + 2002-08-28 + +
    + +
    + Date issued: + + 2002-08-28 + +
    + +
    + Date available: + + 2002-08-28 + +
    + +
    + Date modified: + + 2007-09-16 + +
    + +
    + Date: + + 2007-09-16 + +
    + + + + + + + + + + + + + + 1 + SiSU - Commands [0.58],
    Ralph Amissah     +     +     + + + + + 2 + What is SiSU? + + + + + + + 3 + ? + + Description + + + + + + + 4 + sisu_intro + + 1. Introduction - What is SiSU? + + + + + + + + 5 + + + SiSU is a system for document markup, publishing (in multiple open standard formats) and search + + + + + + + + 6 + + + SiSU1"SiSU information Structuring Universe" or "Structured information, Serialized Units".
    also chosen for the meaning of the Finnish term "sisu".     is a2Unix command line oriented framework for document structuring, publishing and search, comprising of (a) a lightweight document structure and presentation markup syntax and (b) an accompanying engine for generating standard document format outputs from documents prepared in sisu markup syntax, which is able to produce multiple standard outputs that (can) share a common numbering system for the citation of text within a document.     + +     + + + + + + 7 + + + SiSU is developed under an open source, software libre license (GPL3). It has been developed in the context of coping with large document sets with evolving markup related technologies, for which you want multiple output formats, a common mechanism for cross-output-format citation, and search. + + + + + + + + 8 + + + SiSU both defines a markup syntax and provides an engine that produces open standards format outputs from documents prepared with SiSU markup. From a single lightly prepared document sisu custom builds several standard output formats which share a common (text object) numbering system for citation of content within a document (that also has implications for search). The sisu engine works with an abstraction of the document's structure and content from which it is possible to generate different forms of representation of the document. Significantly SiSU markup is more sparse than html and outputs which include html, LaTeX, landscape and portrait pdfs, Open Document Format (ODF), all of which can be added to and updated. SiSU is also able to populate SQL type databases at an object level, which means that searches can be made with that degree of granularity. Results of objects (primarily paragraphs and headings) can be viewed directly in the database, or just the object numbers shown - your search criteria is met in these documents and at these locations within each document. + + + + + + + + 9 + + + Source document preparation and output generation is a two step process: (i) document source is prepared, that is, marked up in sisu markup syntax and (ii) the desired output subsequently generated by running the sisu engine against document source. Output representations if updated (in the sisu engine) can be generated by re-running the engine against the prepared source. Using SiSU markup applied to a document, SiSU custom builds various standard open output formats including plain text, HTML, XHTML, XML, OpenDocument, LaTeX or PDF files, and populate an SQL database with objects3objects include: headings, paragraphs, verse, tables, images, but not footnotes/endnotes which are numbered separately and tied to the object from which they are referenced. (equating generally to paragraph-sized chunks) so searches may be performed and matches returned with that degree of granularity ( e.g. your search criteria is met by these documents and at these locations within each document). Document output formats share a common object numbering system for locating content. This is particularly suitable for "published" works (finalized texts as opposed to works that are frequently changed or updated) for which it provides a fixed means of reference of content. + + + + + + + + 10 + + + In preparing a SiSU document you optionally provide semantic information related to the document in a document header, and in marking up the substantive text provide information on the structure of the document, primarily indicating heading levels and footnotes. You also provide information on basic text attributes where used. The rest is automatic, sisu from this information custom builds4i.e. the html, pdf, odf outputs are each built individually and optimised for that form of presentation, rather than for example the html being a saved version of the odf, or the pdf being a saved version of the html. the different forms of output requested. + + + + + + + + 11 + + + SiSU works with an abstraction of the document based on its structure which is comprised of its frame5the different heading levels and the objects6units of text, primarily paragraphs and headings, also any tables, poems, code-blocks it contains, which enables SiSU to represent the document in many different ways, and to take advantage of the strengths of different ways of presenting documents. The objects are numbered, and these numbers can be used to provide a common base for citing material within a document across the different output format types. This is significant as page numbers are not suited to the digital age, in web publishing, changing a browser's default font or using a different browser means that text appears on different pages; and in publishing in different formats, html, landscape and portrait pdf etc. again page numbers are of no use to cite text in a manner that is relevant against the different output types. Dealing with documents at an object level together with object numbering also has implications for search. + + + + + + + + 12 + + + One of the challenges of maintaining documents is to keep them in a format that would allow users to use them without depending on a proprietary software popular at the time. Consider the ease of dealing with legacy proprietary formats today and what guarantee you have that old proprietary formats will remain (or can be read without proprietary software/equipment) in 15 years time, or the way the way in which html has evolved over its relatively short span of existence. SiSU provides the flexibility of outputing documents in multiple non-proprietary open formats including html, pdf7Specification submitted by Adobe to ISO to become a full open ISO specification
    <http://www.linux-watch.com/news/NS7542722606.html>     and the ISO standard ODF.8ISO/IEC 26300:2006 Whilst SiSU relies on software, the markup is uncomplicated and minimalistic which guarantees that future engines can be written to run against it. It is also easily converted to other formats, which means documents prepared in SiSU can be migrated to other document formats. Further security is provided by the fact that the software itself, SiSU is available under GPL3 a licence that guarantees that the source code will always be open, and free as in libre which means that that code base can be used updated and further developed as required under the terms of its license. Another challenge is to keep up with a moving target. SiSU permits new forms of output to be added as they become important, (Open Document Format text was added in 2006), and existing output to be updated (html has evolved and the related module has been updated repeatedly over the years, presumably when the World Wide Web Consortium (w3c) finalises html 5 which is currently under development, the html module will again be updated allowing all existing documents to be regenerated as html 5).     + +     + + + + + + 13 + + + The document formats are written to the file-system and available for indexing by independent indexing tools, whether off the web like Google and Yahoo or on the site like Lucene and Hyperestraier. + + + + + + + + 14 + + + SiSU also provides other features such as concordance files and document content certificates, and the working against an abstraction of document structure has further possibilities for the research and development of other document representations, the availability of objects is useful for example for topic maps and the commercial law thesaurus by Vikki Rogers and Al Krtizer, together with the flexibility of SiSU offers great possibilities. + + + + + + + + 15 + + + SiSU is primarily for published works, which can take advantage of the citation system to reliably reference its documents. SiSU works well in a complementary manner with such collaborative technologies as Wikis, which can take advantage of and be used to discuss the substance of content prepared in SiSU. + + + + + + + + 16 + + + <http://www.jus.uio.no/sisu> + + + + +     + +     + + + + + 17 + sisu_how + + 2. How does sisu work? + + + + + + + + 18 + + + SiSU markup is fairly minimalistic, it consists of: a (largely optional) document header, made up of information about the document (such as when it was published, who authored it, and granting what rights) and any processing instructions; and markup within the substantive text of the document, which is related to document structure and typeface. SiSU must be able to discern the structure of a document, (text headings and their levels in relation to each other), either from information provided in the document header or from markup within the text (or from a combination of both). Processing is done against an abstraction of the document comprising of information on the document's structure and its objects,[2] which the program serializes (providing the object numbers) and which are assigned hash sum values based on their content. This abstraction of information about document structure, objects, (and hash sums), provides considerable flexibility in representing documents different ways and for different purposes (e.g. search, document layout, publishing, content certification, concordance etc.), and makes it possible to take advantage of some of the strengths of established ways of representing documents, (or indeed to create new ones). + + + + + + + + + + + + 19 + sisu_feature_summary + + 3. Summary of features + + + + + + + + 20 + + + sparse/minimal markup (clean utf-8 source texts). Documents are prepared in a single UTF-8 file using a minimalistic mnemonic syntax. Typical literature, documents like "War and Peace" require almost no markup, and most of the headers are optional. + + + + + + + + 21 + + + markup is easily readable/parsable by the human eye, (basic markup is simpler and more sparse than the most basic HTML), [this may also be converted to XML representations of the same input/source document]. + + + + + + + + 22 + + + markup defines document structure (this may be done once in a header pattern-match description, or for heading levels individually); basic text attributes (bold, italics, underscore, strike-through etc.) as required; and semantic information related to the document (header information, extended beyond the Dublin core and easily further extended as required); the headers may also contain processing instructions. SiSU markup is primarily an abstraction of document structure and document metadata to permit taking advantage of the basic strengths of existing alternative practical standard ways of representing documents [be that browser viewing, paper publication, sql search etc.] (html, xml, odf, latex, pdf, sql) + + + + + + + + 23 + + + for output produces reasonably elegant output of established industry and institutionally accepted open standard formats.[3] takes advantage of the different strengths of various standard formats for representing documents, amongst the output formats currently supported are: + + + + + + + + 24 + + + html - both as a single scrollable text and a segmented document + + + + + + + + 25 + + + xhtml + + + + + + + + 26 + + + XML - both in sax and dom style xml structures for further development as required + + + + + + + + 27 + + + ODF - open document format, the iso standard for document storage + + + + + + + + 28 + + + LaTeX - used to generate pdf + + + + + + + + 29 + + + pdf (via LaTeX) + + + + + + + + 30 + + + sql - population of an sql database, (at the same object level that is used to cite text within a document) + + + + + + + + 31 + + + Also produces: concordance files; document content certificates (md5 or sha256 digests of headings, paragraphs, images etc.) and html manifests (and sitemaps of content). (b) takes advantage of the strengths implicit in these very different output types, (e.g. PDFs produced using typesetting of LaTeX, databases populated with documents at an individual object/paragraph level, making possible granular search (and related possibilities)) + + + + + + + + 32 + + + ensuring content can be cited in a meaningful way regardless of selected output format. Online publishing (and publishing in multiple document formats) lacks a useful way of citing text internally within documents (important to academics generally and to lawyers) as page numbers are meaningless across browsers and formats. sisu seeks to provide a common way of pinpoint the text within a document, (which can be utilized for citation and by search engines). The outputs share a common numbering system that is meaningful (to man and machine) across all digital outputs whether paper, screen, or database oriented, (pdf, HTML, xml, sqlite, postgresql), this numbering system can be used to reference content. + + + + + + + + 33 + + + Granular search within documents. SQL databases are populated at an object level (roughly headings, paragraphs, verse, tables) and become searchable with that degree of granularity, the output information provides the object/paragraph numbers which are relevant across all generated outputs; it is also possible to look at just the matching paragraphs of the documents in the database; [output indexing also work well with search indexing tools like hyperestraier]. + + + + + + + + 34 + + + long term maintainability of document collections in a world of changing formats, having a very sparsely marked-up source document base. there is a considerable degree of future-proofing, output representations are "upgradeable", and new document formats may be added. e.g. addition of odf (open document text) module in 2006 and in future html5 output sometime in future, without modification of existing prepared texts + + + + + + + + 35 + + + SQL search aside, documents are generated as required and static once generated. + + + + + + + + 36 + + + documents produced are static files, and may be batch processed, this needs to be done only once but may be repeated for various reasons as desired (updated content, addition of new output formats, updated technology document presentations/representations) + + + + + + + + 37 + + + document source (plaintext utf-8) if shared on the net may be used as input and processed locally to produce the different document outputs + + + + + + + + 38 + + + document source may be bundled together (automatically) with associated documents (multiple language versions or master document with inclusions) and images and sent as a zip file called a sisupod, if shared on the net these too may be processed locally to produce the desired document outputs + + + + + + + + 39 + + + generated document outputs may automatically be posted to remote sites. + + + + + + + + 40 + + + for basic document generation, the only software dependency is Ruby, and a few standard Unix tools (this covers plaintext, HTML, XML, ODF, LaTeX). To use a database you of course need that, and to convert the LaTeX generated to pdf, a latex processor like tetex or texlive. + + + + + + + + 41 + + + as a developers tool it is flexible and extensible + + + + + + + + 42 + + + Syntax highlighting for SiSU markup is available for a number of text editors. + + + + + + + + 43 + + + SiSU is less about document layout than about finding a way with little markup to be able to construct an abstract representation of a document that makes it possible to produce multiple representations of it which may be rather different from each other and used for different purposes, whether layout and publishing, or search of content + + + + + + + + 44 + + + i.e. to be able to take advantage from this minimal preparation starting point of some of the strengths of rather different established ways of representing documents for different purposes, whether for search (relational database, or indexed flat files generated for that purpose whether of complete documents, or say of files made up of objects), online viewing (e.g. html, xml, pdf), or paper publication (e.g. pdf)... + + + + + + + + 45 + + + the solution arrived at is by extracting structural information about the document (about headings within the document) and by tracking objects (which are serialized and also given hash values) in the manner described. It makes possible representations that are quite different from those offered at present. For example objects could be saved individually and identified by their hashes, with an index of how the objects relate to each other to form a document. + + + + + + + + + + + + 0 + endnotes + + Endnotes + + + + + + + +     + +     + +     + + + +     + diff --git a/data/doc/manuals_generated/sisu_manual/sisu_introduction/endnotes.html b/data/doc/manuals_generated/sisu_manual/sisu_introduction/endnotes.html new file mode 100644 index 00000000..cd9e96d6 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_introduction/endnotes.html @@ -0,0 +1,508 @@ + + + + + + endnotes - + 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 +

    +

    + Commands [0.58] +

    +

    + Ralph Amissah + +

    + +
    +

    Endnotes

    + + +
    +

    +  1. "SiSU information Structuring Universe" or "Structured information, Serialized Units".
    also chosen for the meaning of the Finnish term "sisu". +

    +    		   +
    + + +
    +

    +  2. Unix command line oriented +

    +    		   +
    + + +
    +

    +  3. objects include: headings, paragraphs, verse, tables, images, but not footnotes/endnotes which are numbered separately and tied to the object from which they are referenced. +

    +    		   +
    + + +
    +

    +  4. i.e. the html, pdf, odf outputs are each built individually and optimised for that form of presentation, rather than for example the html being a saved version of the odf, or the pdf being a saved version of the html. +

    +    		   +
    + + +
    +

    +  5. the different heading levels +

    +    		   +
    + + +
    +

    +  6. units of text, primarily paragraphs and headings, also any tables, poems, code-blocks +

    +    		   +
    + + +
    +

    +  7. Specification submitted by Adobe to ISO to become a full open ISO specification
    <http://www.linux-watch.com/news/NS7542722606.html> +

    +    		   +
    + + +
    +

    +  8. ISO/IEC 26300:2006 +

    +    		   +

    +^

     
    + + + +
    + +
    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_introduction/index.html b/data/doc/manuals_generated/sisu_manual/sisu_introduction/index.html new file mode 100644 index 00000000..a0063954 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_introduction/index.html @@ -0,0 +1,522 @@ + + + + + + SiSU + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + +
    + +
    SiSU -->
    +    		 + + + + + + + + + + + + + + + +
    + + TOC linked  toc  + + + + + Full Text  scroll  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
    +    		 +   + next >> +   +
    +

    + +

    + +
    + + +
    + +

    SiSU +

    + +

    Commands [0.58] +

    + +

    Ralph Amissah +

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

    + SiSU - Commands [0.58],
    Ralph Amissah +

    + +

    + What is SiSU? +

    + +

    + Description +

    + +

    + + 1. Introduction - What is SiSU? + +

    + +

    + + 2. How does sisu work? + +

    + +

    + + 3. Summary of features + +

    + +

    + + Endnotes + +

    + +

    + Document Information (metadata) +

    + +

    Copyright ©  Ralph Amissah 2007, part of SiSU documentation, License GPL 3

    +

    + +

    + + + + + +
    + +
    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_introduction/landscape.pdf b/data/doc/manuals_generated/sisu_manual/sisu_introduction/landscape.pdf new file mode 100644 index 00000000..86dcb2c4 Binary files /dev/null and b/data/doc/manuals_generated/sisu_manual/sisu_introduction/landscape.pdf differ diff --git a/data/doc/manuals_generated/sisu_manual/sisu_introduction/metadata.html b/data/doc/manuals_generated/sisu_manual/sisu_introduction/metadata.html new file mode 100644 index 00000000..6195b11c --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_introduction/metadata.html @@ -0,0 +1,591 @@ + + + + + + - + SiSU + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + +
    + +
    SiSU -->
    +    		 + + + + + + + + + + + + + + + + + +
    + + + TOC linked  toc  + + + + + + Full Text  scroll  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
    +    		 + + + + + + +
    + + << previous + + + + TOC + + +
    +
    + + + + +
    + + < + + + + ^ + + + + > + +

    + SiSU +

    +

    + Commands [0.58] +

    +

    + Ralph Amissah + +

    +

    + copy @ + + SiSU + +

    + + +
    +

    + Document Information (metadata) +

    +    		   +

    +   0 +

    +
    + + +
    + +   +
    + + +
    +

    + + Metadata +

    +    		 +

    +   0 +

    +
    + +
    +

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

    		 +
    + +
    +

    + Dublin Core (DC) +

    		 +
    + +
    +

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

    		 +
    + +
    +

    + DC Title: SiSU - Commands [0.58] +

    		 +
    + +
    +

    + DC Creator: Ralph Amissah +

    		 +
    + +
    +

    + DC Rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +

    		 +
    + +
    +

    + DC Type: information +

    		 +
    + +
    +

    + DC Date created: 2002-08-28 +

    		 +
    + +
    +

    + DC Date issued: 2002-08-28 +

    		 +
    + +
    +

    + DC Date available: 2002-08-28 +

    		 +
    + +
    +

    + DC Date modified: 2007-09-16 +

    		 +
    + +
    +

    + DC Date: 2007-09-16 +

    		 +
    + +
    +

    + Version Information +

    		 +
    + +
    +

    + Sourcefile: sisu_introduction.sst +

    		 +
    + +
    +

    + Filetype: SiSU text 0.58 +

    		 +
    + +
    +

    + Sourcefile Digest, MD5(sisu_introduction.sst)= b2a6da5bd22fa1eaa92a08d81f11d1c7 +

    		 +
    + +
    +

    + 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:10:58 +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_introduction/opendocument.odt b/data/doc/manuals_generated/sisu_manual/sisu_introduction/opendocument.odt new file mode 100644 index 00000000..c0041e76 Binary files /dev/null and b/data/doc/manuals_generated/sisu_manual/sisu_introduction/opendocument.odt differ diff --git a/data/doc/manuals_generated/sisu_manual/sisu_introduction/plain.txt b/data/doc/manuals_generated/sisu_manual/sisu_introduction/plain.txt new file mode 100644 index 00000000..318b8292 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_introduction/plain.txt @@ -0,0 +1,460 @@ +SISU - COMMANDS [0.58], +RALPH AMISSAH +************************************** + +WHAT IS SISU? +============= + +DESCRIPTION +=========== + +1. INTRODUCTION - WHAT IS SISU? +------------------------------- + +*SiSU* is a system for document markup, publishing (in multiple open standard +formats) and search + + +*SiSU*[^1] is a[^2] framework for document structuring, publishing and search, +comprising of (a) a lightweight document structure and presentation markup +syntax and (b) an accompanying engine for generating standard document format +outputs from documents prepared in sisu markup syntax, which is able to produce +multiple standard outputs that (can) share a common numbering system for the +citation of text within a document. + + +- [1]: "*SiSU* information Structuring Universe" or "Structured information, + Serialized Units". + +- also chosen for the meaning of the Finnish term "sisu". + +- [2]: Unix command line oriented + +*SiSU* is developed under an open source, software libre license (GPL3). It has +been developed in the context of coping with large document sets with evolving +markup related technologies, for which you want multiple output formats, a +common mechanism for cross-output-format citation, and search. + + +*SiSU* both defines a markup syntax and provides an engine that produces open +standards format outputs from documents prepared with *SiSU* markup. From a +single lightly prepared document sisu custom builds several standard output +formats which share a common (text object) numbering system for citation of +content within a document (that also has implications for search). The sisu +engine works with an abstraction of the document's structure and content from +which it is possible to generate different forms of representation of the +document. Significantly *SiSU* markup is more sparse than html and outputs +which include html, LaTeX, landscape and portrait pdfs, Open Document Format +(ODF), all of which can be added to and updated. *SiSU* is also able to +populate SQL type databases at an object level, which means that searches can +be made with that degree of granularity. Results of objects (primarily +paragraphs and headings) can be viewed directly in the database, or just the +object numbers shown - your search criteria is met in these documents and at +these locations within each document. + + +Source document preparation and output generation is a two step process: (i) +document source is prepared, that is, marked up in sisu markup syntax and (ii) +the desired output subsequently generated by running the sisu engine against +document source. Output representations if updated (in the sisu engine) can be +generated by re-running the engine against the prepared source. Using *SiSU* +markup applied to a document, *SiSU* custom builds various standard open output +formats including plain text, HTML, XHTML, XML, OpenDocument, LaTeX or PDF +files, and populate an SQL database with objects[^3] (equating generally to +paragraph-sized chunks) so searches may be performed and matches returned with +that degree of granularity ( e.g. your search criteria is met by these +documents and at these locations within each document). Document output formats +share a common object numbering system for locating content. This is +particularly suitable for "published" works (finalized texts as opposed to +works that are frequently changed or updated) for which it provides a fixed +means of reference of content. + + +- [3]: objects include: headings, paragraphs, verse, tables, images, but not + footnotes/endnotes which are numbered separately and tied to the object from + which they are referenced. + +In preparing a *SiSU* document you optionally provide semantic information +related to the document in a document header, and in marking up the substantive +text provide information on the structure of the document, primarily indicating +heading levels and footnotes. You also provide information on basic text +attributes where used. The rest is automatic, sisu from this information custom +builds[^4] the different forms of output requested. + + +- [4]: i.e. the html, pdf, odf outputs are each built individually and optimised + for that form of presentation, rather than for example the html being a saved + version of the odf, or the pdf being a saved version of the html. + +*SiSU* works with an abstraction of the document based on its structure which +is comprised of its frame[^5] and the objects[^6] it contains, which enables +*SiSU* to represent the document in many different ways, and to take advantage +of the strengths of different ways of presenting documents. The objects are +numbered, and these numbers can be used to provide a common base for citing +material within a document across the different output format types. This is +significant as page numbers are not suited to the digital age, in web +publishing, changing a browser's default font or using a different browser +means that text appears on different pages; and in publishing in different +formats, html, landscape and portrait pdf etc. again page numbers are of no use +to cite text in a manner that is relevant against the different output types. +Dealing with documents at an object level together with object numbering also +has implications for search. + + +- [5]: the different heading levels + +- [6]: units of text, primarily paragraphs and headings, also any tables, poems, + code-blocks + +One of the challenges of maintaining documents is to keep them in a format that +would allow users to use them without depending on a proprietary software +popular at the time. Consider the ease of dealing with legacy proprietary +formats today and what guarantee you have that old proprietary formats will +remain (or can be read without proprietary software/equipment) in 15 years +time, or the way the way in which html has evolved over its relatively short +span of existence. *SiSU* provides the flexibility of outputing documents in +multiple non-proprietary open formats including html, pdf[^7] and the ISO +standard ODF.[^8] Whilst *SiSU* relies on software, the markup is uncomplicated +and minimalistic which guarantees that future engines can be written to run +against it. It is also easily converted to other formats, which means documents +prepared in *SiSU* can be migrated to other document formats. Further security +is provided by the fact that the software itself, *SiSU* is available under +GPL3 a licence that guarantees that the source code will always be open, and +free as in libre which means that that code base can be used updated and +further developed as required under the terms of its license. Another challenge +is to keep up with a moving target. *SiSU* permits new forms of output to be +added as they become important, (Open Document Format text was added in 2006), +and existing output to be updated (html has evolved and the related module has +been updated repeatedly over the years, presumably when the World Wide Web +Consortium (w3c) finalises html 5 which is currently under development, the +html module will again be updated allowing all existing documents to be +regenerated as html 5). + + +- [7]: Specification submitted by Adobe to ISO to become a full open ISO + specification + +- + +- [8]: ISO/IEC 26300:2006 + +The document formats are written to the file-system and available for indexing +by independent indexing tools, whether off the web like Google and Yahoo or on +the site like Lucene and Hyperestraier. + + +*SiSU* also provides other features such as concordance files and document +content certificates, and the working against an abstraction of document +structure has further possibilities for the research and development of other +document representations, the availability of objects is useful for example for +topic maps and the commercial law thesaurus by Vikki Rogers and Al Krtizer, +together with the flexibility of *SiSU* offers great possibilities. + + +*SiSU* is primarily for published works, which can take advantage of the +citation system to reliably reference its documents. *SiSU* works well in a +complementary manner with such collaborative technologies as Wikis, which can +take advantage of and be used to discuss the substance of content prepared in +*SiSU*. + + + + + +2. HOW DOES SISU WORK? +---------------------- + +*SiSU* markup is fairly minimalistic, it consists of: a (largely optional) +document header, made up of information about the document (such as when it was +published, who authored it, and granting what rights) and any processing +instructions; and markup within the substantive text of the document, which is +related to document structure and typeface. *SiSU* must be able to discern the +structure of a document, (text headings and their levels in relation to each +other), either from information provided in the document header or from markup +within the text (or from a combination of both). Processing is done against an +abstraction of the document comprising of information on the document's +structure and its objects,[2] which the program serializes (providing the +object numbers) and which are assigned hash sum values based on their content. +This abstraction of information about document structure, objects, (and hash +sums), provides considerable flexibility in representing documents different +ways and for different purposes (e.g. search, document layout, publishing, +content certification, concordance etc.), and makes it possible to take +advantage of some of the strengths of established ways of representing +documents, (or indeed to create new ones). + + +3. SUMMARY OF FEATURES +---------------------- + +* sparse/minimal markup (clean utf-8 source texts). Documents are prepared in a +single UTF-8 file using a minimalistic mnemonic syntax. Typical literature, +documents like "War and Peace" require almost no markup, and most of the +headers are optional. + + +* markup is easily readable/parsable by the human eye, (basic markup is simpler +and more sparse than the most basic HTML), [this may also be converted to XML +representations of the same input/source document]. + + +* markup defines document structure (this may be done once in a header +pattern-match description, or for heading levels individually); basic text +attributes (bold, italics, underscore, strike-through etc.) as required; and +semantic information related to the document (header information, extended +beyond the Dublin core and easily further extended as required); the headers +may also contain processing instructions. *SiSU* markup is primarily an +abstraction of document structure and document metadata to permit taking +advantage of the basic strengths of existing alternative practical standard +ways of representing documents [be that browser viewing, paper publication, sql +search etc.] (html, xml, odf, latex, pdf, sql) + + +* for output produces reasonably elegant output of established industry and +institutionally accepted open standard formats.[3] takes advantage of the +different strengths of various standard formats for representing documents, +amongst the output formats currently supported are: + + + * html - both as a single scrollable text and a segmented document + + + * xhtml + + + * XML - both in sax and dom style xml structures for further development as + required + + + * ODF - open document format, the iso standard for document storage + + + * LaTeX - used to generate pdf + + + * pdf (via LaTeX) + + + * sql - population of an sql database, (at the same object level that is used + to cite text within a document) + + +Also produces: concordance files; document content certificates (md5 or sha256 +digests of headings, paragraphs, images etc.) and html manifests (and sitemaps +of content). (b) takes advantage of the strengths implicit in these very +different output types, (e.g. PDFs produced using typesetting of LaTeX, +databases populated with documents at an individual object/paragraph level, +making possible granular search (and related possibilities)) + + +* ensuring content can be cited in a meaningful way regardless of selected +output format. Online publishing (and publishing in multiple document formats) +lacks a useful way of citing text internally within documents (important to +academics generally and to lawyers) as page numbers are meaningless across +browsers and formats. sisu seeks to provide a common way of pinpoint the text +within a document, (which can be utilized for citation and by search engines). +The outputs share a common numbering system that is meaningful (to man and +machine) across all digital outputs whether paper, screen, or database +oriented, (pdf, HTML, xml, sqlite, postgresql), this numbering system can be +used to reference content. + + +* Granular search within documents. SQL databases are populated at an object +level (roughly headings, paragraphs, verse, tables) and become searchable with +that degree of granularity, the output information provides the +object/paragraph numbers which are relevant across all generated outputs; it is +also possible to look at just the matching paragraphs of the documents in the +database; [output indexing also work well with search indexing tools like +hyperestraier]. + + +* long term maintainability of document collections in a world of changing +formats, having a very sparsely marked-up source document base. there is a +considerable degree of future-proofing, output representations are +"upgradeable", and new document formats may be added. e.g. addition of odf +(open document text) module in 2006 and in future html5 output sometime in +future, without modification of existing prepared texts + + +* SQL search aside, documents are generated as required and static once +generated. + + +* documents produced are static files, and may be batch processed, this needs +to be done only once but may be repeated for various reasons as desired +(updated content, addition of new output formats, updated technology document +presentations/representations) + + +* document source (plaintext utf-8) if shared on the net may be used as input +and processed locally to produce the different document outputs + + +* document source may be bundled together (automatically) with associated +documents (multiple language versions or master document with inclusions) and +images and sent as a zip file called a sisupod, if shared on the net these too +may be processed locally to produce the desired document outputs + + +* generated document outputs may automatically be posted to remote sites. + + +* for basic document generation, the only software dependency is *Ruby*, and a +few standard Unix tools (this covers plaintext, HTML, XML, ODF, LaTeX). To use +a database you of course need that, and to convert the LaTeX generated to pdf, +a latex processor like tetex or texlive. + + +* as a developers tool it is flexible and extensible + + +Syntax highlighting for *SiSU* markup is available for a number of text +editors. + + +*SiSU* is less about document layout than about finding a way with little +markup to be able to construct an abstract representation of a document that +makes it possible to produce multiple representations of it which may be rather +different from each other and used for different purposes, whether layout and +publishing, or search of content + + +i.e. to be able to take advantage from this minimal preparation starting point +of some of the strengths of rather different established ways of representing +documents for different purposes, whether for search (relational database, or +indexed flat files generated for that purpose whether of complete documents, or +say of files made up of objects), online viewing (e.g. html, xml, pdf), or +paper publication (e.g. pdf)... + + +the solution arrived at is by extracting structural information about the +document (about headings within the document) and by tracking objects (which +are serialized and also given hash values) in the manner described. It makes +possible representations that are quite different from those offered at +present. For example objects could be saved individually and identified by +their hashes, with an index of how the objects relate to each other to form a +document. + + +DOCUMENT INFORMATION (METADATA) +******************************* + +METADATA +-------- + +Document Manifest @ + + + +*Dublin Core* (DC) + + +/DC tags included with this document are provided here./ + + +DC Title: _SiSU - Commands [0.58]_ + + +DC Creator: _Ralph Amissah_ + + +DC Rights: _Copyright (C) Ralph Amissah 2007, part of SiSU documentation, +License GPL 3_ + + +DC Type: _information_ + + +DC Date created: _2002-08-28_ + + +DC Date issued: _2002-08-28_ + + +DC Date available: _2002-08-28_ + + +DC Date modified: _2007-09-16_ + + +DC Date: _2007-09-16_ + + +*Version Information* + + +Sourcefile: _sisu_introduction.sst_ + + +Filetype: _SiSU text 0.58_ + + +Sourcefile Digest, MD5(sisu_introduction.sst)= +_b2a6da5bd22fa1eaa92a08d81f11d1c7_ + + +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:10:58 +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 - Commands [0.58] + + creator: Ralph Amissah + + rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, + License GPL 3 + + type: information + + subject: ebook, epublishing, electronic book, electronic publishing, + electronic document, electronic citation, data structure, + citation systems, search + + date.created: 2002-08-28 + + date.issued: 2002-08-28 + + date.available: 2002-08-28 + + date.modified: 2007-09-16 + + date: 2007-09-16 + + + + + +============================================================================== +nil + +Other versions of this document: +manifest: + http://www.jus.uio.no/sisu/sisu_introduction/sisu_manifest.html +html: + http://www.jus.uio.no/sisu/sisu_introduction/toc.html +pdf: + http://www.jus.uio.no/sisu/sisu_introduction/portrait.pdf + http://www.jus.uio.no/sisu/sisu_introduction/landscape.pdf +plaintext (plain text): + http://www.jus.uio.no/sisu/sisu_introduction/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:49 +0100 2007 +* SiSU http://www.jus.uio.no/sisu diff --git a/data/doc/manuals_generated/sisu_manual/sisu_introduction/portrait.pdf b/data/doc/manuals_generated/sisu_manual/sisu_introduction/portrait.pdf new file mode 100644 index 00000000..735044ef Binary files /dev/null and b/data/doc/manuals_generated/sisu_manual/sisu_introduction/portrait.pdf differ diff --git a/data/doc/manuals_generated/sisu_manual/sisu_introduction/sax.xml b/data/doc/manuals_generated/sisu_manual/sisu_introduction/sax.xml new file mode 100644 index 00000000..2b0d3432 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_introduction/sax.xml @@ -0,0 +1,599 @@ + + + + + + + Title: + + SiSU - Commands [0.58] + +
    + Creator: + + Ralph Amissah + +
    + Rights: + + Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +
    + Type: + + information + +
    + Subject: + + ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +
    + Date created: + + 2002-08-28 + +
    + Date issued: + + 2002-08-28 + +
    + Date available: + + 2002-08-28 + +
    + Date modified: + + 2007-09-16 + +
    + Date: + + 2007-09-16 + +
    + + + + 1 + + SiSU - Commands [0.58],
    Ralph Amissah +     +     + + 2 + + What is SiSU? + + + + 3 + + Description + + + + 4 + + 1. Introduction - What is SiSU? + + + + 5 + + SiSU is a system for document markup, publishing (in multiple +open standard formats) and search + + + + 6 + + SiSU1 is a2 framework for document +structuring, publishing and search, comprising of (a) a lightweight +document structure and presentation markup syntax and (b) an +accompanying engine for generating standard document format outputs +from documents prepared in sisu markup syntax, which is able to produce +multiple standard outputs that (can) share a common numbering system +for the citation of text within a document. + + + 1 + + "SiSU information Structuring Universe" or "Structured +information, Serialized Units".
    also chosen for the meaning of +the Finnish term "sisu". +     +     + + 2 + + Unix command line oriented + + +     + + 7 + + SiSU is developed under an open source, software libre license +(GPL3). It has been developed in the context of coping with large +document sets with evolving markup related technologies, for which you +want multiple output formats, a common mechanism for +cross-output-format citation, and search. + + + + 8 + + SiSU both defines a markup syntax and provides an engine that +produces open standards format outputs from documents prepared with +SiSU markup. From a single lightly prepared document sisu custom +builds several standard output formats which share a common (text +object) numbering system for citation of content within a document +(that also has implications for search). The sisu engine works with an +abstraction of the document's structure and content from which it is +possible to generate different forms of representation of the document. +Significantly SiSU markup is more sparse than html and outputs +which include html, LaTeX, landscape and portrait pdfs, Open Document +Format (ODF), all of which can be added to and updated. SiSU is +also able to populate SQL type databases at an object level, which +means that searches can be made with that degree of granularity. +Results of objects (primarily paragraphs and headings) can be viewed +directly in the database, or just the object numbers shown - your +search criteria is met in these documents and at these locations within +each document. + + + + 9 + + Source document preparation and output generation is a two step +process: (i) document source is prepared, that is, marked up in sisu +markup syntax and (ii) the desired output subsequently generated by +running the sisu engine against document source. Output representations +if updated (in the sisu engine) can be generated by re-running the +engine against the prepared source. Using SiSU markup applied to +a document, SiSU custom builds various standard open output +formats including plain text, HTML, XHTML, XML, OpenDocument, LaTeX or +PDF files, and populate an SQL database with objects3 +(equating generally to paragraph-sized chunks) so searches may be +performed and matches returned with that degree of granularity ( e.g. +your search criteria is met by these documents and at these locations +within each document). Document output formats share a common object +numbering system for locating content. This is particularly suitable +for "published" works (finalized texts as opposed to works that are +frequently changed or updated) for which it provides a fixed means of +reference of content. + + + 3 + + objects include: headings, paragraphs, verse, tables, images, but not +footnotes/endnotes which are numbered separately and tied to the object +from which they are referenced. + + + + + 10 + + In preparing a SiSU document you optionally provide semantic +information related to the document in a document header, and in +marking up the substantive text provide information on the structure of +the document, primarily indicating heading levels and footnotes. You +also provide information on basic text attributes where used. The rest +is automatic, sisu from this information custom builds4 the +different forms of output requested. + + + 4 + + i.e. the html, pdf, odf outputs are each built individually and +optimised for that form of presentation, rather than for example the +html being a saved version of the odf, or the pdf being a saved version +of the html. + + + + + 11 + + SiSU works with an abstraction of the document based on its +structure which is comprised of its frame5 and the +objects6 it contains, which enables SiSU to represent +the document in many different ways, and to take advantage of the +strengths of different ways of presenting documents. The objects are +numbered, and these numbers can be used to provide a common base for +citing material within a document across the different output format +types. This is significant as page numbers are not suited to the +digital age, in web publishing, changing a browser's default font or +using a different browser means that text appears on different pages; +and in publishing in different formats, html, landscape and portrait +pdf etc. again page numbers are of no use to cite text in a manner that +is relevant against the different output types. Dealing with documents +at an object level together with object numbering also has implications +for search. + + + 5 + + the different heading levels + + + + 6 + + units of text, primarily paragraphs and headings, also any tables, +poems, code-blocks + + + + + 12 + + One of the challenges of maintaining documents is to keep them in a +format that would allow users to use them without depending on a +proprietary software popular at the time. Consider the ease of dealing +with legacy proprietary formats today and what guarantee you have that +old proprietary formats will remain (or can be read without proprietary +software/equipment) in 15 years time, or the way the way in which html +has evolved over its relatively short span of existence. SiSU +provides the flexibility of outputing documents in multiple +non-proprietary open formats including html, pdf7 and the ISO +standard ODF.8 Whilst SiSU relies on software, the +markup is uncomplicated and minimalistic which guarantees that future +engines can be written to run against it. It is also easily converted +to other formats, which means documents prepared in SiSU can be +migrated to other document formats. Further security is provided by the +fact that the software itself, SiSU is available under GPL3 a +licence that guarantees that the source code will always be open, and +free as in libre which means that that code base can be used updated +and further developed as required under the terms of its license. +Another challenge is to keep up with a moving target. SiSU +permits new forms of output to be added as they become important, (Open +Document Format text was added in 2006), and existing output to be +updated (html has evolved and the related module has been updated +repeatedly over the years, presumably when the World Wide Web +Consortium (w3c) finalises html 5 which is currently under development, +the html module will again be updated allowing all existing documents +to be regenerated as html 5). + + + 7 + + Specification submitted by Adobe to ISO to become a full open ISO +specification
    <http://www.linux-watch.com/news/NS7542722606.html> +     +     + + 8 + + ISO/IEC 26300:2006 + + +     + + 13 + + The document formats are written to the file-system and available for +indexing by independent indexing tools, whether off the web like Google +and Yahoo or on the site like Lucene and Hyperestraier. + + + + 14 + + SiSU also provides other features such as concordance files and +document content certificates, and the working against an abstraction +of document structure has further possibilities for the research and +development of other document representations, the availability of +objects is useful for example for topic maps and the commercial law +thesaurus by Vikki Rogers and Al Krtizer, together with the flexibility +of SiSU offers great possibilities. + + + + 15 + + SiSU is primarily for published works, which can take advantage +of the citation system to reliably reference its documents. SiSU +works well in a complementary manner with such collaborative +technologies as Wikis, which can take advantage of and be used to +discuss the substance of content prepared in SiSU. + + + + 16 + + <http://www.jus.uio.no/sisu> + + + + 17 + + 2. How does sisu work? + + + + 18 + + SiSU markup is fairly minimalistic, it consists of: a (largely +optional) document header, made up of information about the document +(such as when it was published, who authored it, and granting what +rights) and any processing instructions; and markup within the +substantive text of the document, which is related to document +structure and typeface. SiSU must be able to discern the +structure of a document, (text headings and their levels in relation to +each other), either from information provided in the document header or +from markup within the text (or from a combination of both). Processing +is done against an abstraction of the document comprising of +information on the document's structure and its objects,[2] which the +program serializes (providing the object numbers) and which are +assigned hash sum values based on their content. This abstraction of +information about document structure, objects, (and hash sums), +provides considerable flexibility in representing documents different +ways and for different purposes (e.g. search, document layout, +publishing, content certification, concordance etc.), and makes it +possible to take advantage of some of the strengths of established ways +of representing documents, (or indeed to create new ones). + + + + 19 + + 3. Summary of features + + + + 20 + + sparse/minimal markup (clean utf-8 source texts). Documents are +prepared in a single UTF-8 file using a minimalistic mnemonic syntax. +Typical literature, documents like "War and Peace" require almost no +markup, and most of the headers are optional. + + + + 21 + + markup is easily readable/parsable by the human eye, (basic markup is +simpler and more sparse than the most basic HTML), [this may also be +converted to XML representations of the same input/source document]. + + + + 22 + + markup defines document structure (this may be done once in a header +pattern-match description, or for heading levels individually); basic +text attributes (bold, italics, underscore, strike-through etc.) as +required; and semantic information related to the document (header +information, extended beyond the Dublin core and easily further +extended as required); the headers may also contain processing +instructions. SiSU markup is primarily an abstraction of +document structure and document metadata to permit taking advantage of +the basic strengths of existing alternative practical standard ways of +representing documents [be that browser viewing, paper publication, sql +search etc.] (html, xml, odf, latex, pdf, sql) + + + + 23 + + for output produces reasonably elegant output of established industry +and institutionally accepted open standard formats.[3] takes advantage +of the different strengths of various standard formats for representing +documents, amongst the output formats currently supported are: + + + + 24 + + html - both as a single scrollable text and a segmented document + + + + 25 + + xhtml + + + + 26 + + XML - both in sax and dom style xml structures for further +development as required + + + + 27 + + ODF - open document format, the iso standard for document storage + + + + 28 + + LaTeX - used to generate pdf + + + + 29 + + pdf (via LaTeX) + + + + 30 + + sql - population of an sql database, (at the same object level +that is used to cite text within a document) + + + + 31 + + Also produces: concordance files; document content certificates (md5 or +sha256 digests of headings, paragraphs, images etc.) and html manifests +(and sitemaps of content). (b) takes advantage of the strengths +implicit in these very different output types, (e.g. PDFs produced +using typesetting of LaTeX, databases populated with documents at an +individual object/paragraph level, making possible granular search (and +related possibilities)) + + + + 32 + + ensuring content can be cited in a meaningful way regardless of +selected output format. Online publishing (and publishing in multiple +document formats) lacks a useful way of citing text internally within +documents (important to academics generally and to lawyers) as page +numbers are meaningless across browsers and formats. sisu seeks to +provide a common way of pinpoint the text within a document, (which can +be utilized for citation and by search engines). The outputs share a +common numbering system that is meaningful (to man and machine) across +all digital outputs whether paper, screen, or database oriented, (pdf, +HTML, xml, sqlite, postgresql), this numbering system can be used to +reference content. + + + + 33 + + Granular search within documents. SQL databases are populated at an +object level (roughly headings, paragraphs, verse, tables) and become +searchable with that degree of granularity, the output information +provides the object/paragraph numbers which are relevant across all +generated outputs; it is also possible to look at just the matching +paragraphs of the documents in the database; [output indexing also work +well with search indexing tools like hyperestraier]. + + + + 34 + + long term maintainability of document collections in a world of +changing formats, having a very sparsely marked-up source document +base. there is a considerable degree of future-proofing, output +representations are "upgradeable", and new document formats may be +added. e.g. addition of odf (open document text) module in 2006 and in +future html5 output sometime in future, without modification of +existing prepared texts + + + + 35 + + SQL search aside, documents are generated as required and static once +generated. + + + + 36 + + documents produced are static files, and may be batch processed, this +needs to be done only once but may be repeated for various reasons as +desired (updated content, addition of new output formats, updated +technology document presentations/representations) + + + + 37 + + document source (plaintext utf-8) if shared on the net may be used as +input and processed locally to produce the different document outputs + + + + 38 + + document source may be bundled together (automatically) with associated +documents (multiple language versions or master document with +inclusions) and images and sent as a zip file called a sisupod, if +shared on the net these too may be processed locally to produce the +desired document outputs + + + + 39 + + generated document outputs may automatically be posted to remote sites. + + + + 40 + + for basic document generation, the only software dependency is +Ruby, and a few standard Unix tools (this covers plaintext, +HTML, XML, ODF, LaTeX). To use a database you of course need that, and +to convert the LaTeX generated to pdf, a latex processor like tetex or +texlive. + + + + 41 + + as a developers tool it is flexible and extensible + + + + 42 + + Syntax highlighting for SiSU markup is available for a number of +text editors. + + + + 43 + + SiSU is less about document layout than about finding a way with +little markup to be able to construct an abstract representation of a +document that makes it possible to produce multiple representations of +it which may be rather different from each other and used for different +purposes, whether layout and publishing, or search of content + + + + 44 + + i.e. to be able to take advantage from this minimal preparation +starting point of some of the strengths of rather different established +ways of representing documents for different purposes, whether for +search (relational database, or indexed flat files generated for that +purpose whether of complete documents, or say of files made up of +objects), online viewing (e.g. html, xml, pdf), or paper publication +(e.g. pdf)... + + + + 45 + + the solution arrived at is by extracting structural information about +the document (about headings within the document) and by tracking +objects (which are serialized and also given hash values) in the manner +described. It makes possible representations that are quite different +from those offered at present. For example objects could be saved +individually and identified by their hashes, with an index of how the +objects relate to each other to form a document. + + + + 0 + + Endnotes + + + +     diff --git a/data/doc/manuals_generated/sisu_manual/sisu_introduction/scroll.xhtml b/data/doc/manuals_generated/sisu_manual/sisu_introduction/scroll.xhtml new file mode 100644 index 00000000..538b7b60 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_introduction/scroll.xhtml @@ -0,0 +1,576 @@ + + + + + + + + Title: + + SiSU - Commands [0.58] + +
    + Creator: + + Ralph Amissah + +
    + Rights: + + Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +
    + Type: + + information + +
    + Subject: + + ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +
    + Date created: + + 2002-08-28 + +
    + Date issued: + + 2002-08-28 + +
    + Date available: + + 2002-08-28 + +
    + Date modified: + + 2007-09-16 + +
    + Date: + + 2007-09-16 + +
    + + + + + SiSU - Commands [0.58],
    Ralph Amissah +     + 1 +     + + + What is SiSU? + + 2 + + + + Description + + 3 + + + + 1. Introduction - What is SiSU? + + 4 + + + + SiSU is a system for document markup, publishing (in multiple +open standard formats) and search + + 5 + + + + SiSU1 is a2 framework for document +structuring, publishing and search, comprising of (a) a lightweight +document structure and presentation markup syntax and (b) an +accompanying engine for generating standard document format outputs +from documents prepared in sisu markup syntax, which is able to produce +multiple standard outputs that (can) share a common numbering system +for the citation of text within a document. + + + 1. "SiSU information Structuring Universe" or "Structured +information, Serialized Units".
    also chosen for the meaning of +the Finnish term "sisu". +     + + 2. Unix command line oriented + + 6 +     + + + SiSU is developed under an open source, software libre license +(GPL3). It has been developed in the context of coping with large +document sets with evolving markup related technologies, for which you +want multiple output formats, a common mechanism for +cross-output-format citation, and search. + + 7 + + + + SiSU both defines a markup syntax and provides an engine that +produces open standards format outputs from documents prepared with +SiSU markup. From a single lightly prepared document sisu custom +builds several standard output formats which share a common (text +object) numbering system for citation of content within a document +(that also has implications for search). The sisu engine works with an +abstraction of the document's structure and content from which it is +possible to generate different forms of representation of the document. +Significantly SiSU markup is more sparse than html and outputs +which include html, LaTeX, landscape and portrait pdfs, Open Document +Format (ODF), all of which can be added to and updated. SiSU is +also able to populate SQL type databases at an object level, which +means that searches can be made with that degree of granularity. +Results of objects (primarily paragraphs and headings) can be viewed +directly in the database, or just the object numbers shown - your +search criteria is met in these documents and at these locations within +each document. + + 8 + + + + Source document preparation and output generation is a two step +process: (i) document source is prepared, that is, marked up in sisu +markup syntax and (ii) the desired output subsequently generated by +running the sisu engine against document source. Output representations +if updated (in the sisu engine) can be generated by re-running the +engine against the prepared source. Using SiSU markup applied to +a document, SiSU custom builds various standard open output +formats including plain text, HTML, XHTML, XML, OpenDocument, LaTeX or +PDF files, and populate an SQL database with objects3 +(equating generally to paragraph-sized chunks) so searches may be +performed and matches returned with that degree of granularity ( e.g. +your search criteria is met by these documents and at these locations +within each document). Document output formats share a common object +numbering system for locating content. This is particularly suitable +for "published" works (finalized texts as opposed to works that are +frequently changed or updated) for which it provides a fixed means of +reference of content. + + + 3. objects include: headings, paragraphs, verse, tables, images, but not +footnotes/endnotes which are numbered separately and tied to the object +from which they are referenced. + + 9 + + + + In preparing a SiSU document you optionally provide semantic +information related to the document in a document header, and in +marking up the substantive text provide information on the structure of +the document, primarily indicating heading levels and footnotes. You +also provide information on basic text attributes where used. The rest +is automatic, sisu from this information custom builds4 the +different forms of output requested. + + + 4. i.e. the html, pdf, odf outputs are each built individually and +optimised for that form of presentation, rather than for example the +html being a saved version of the odf, or the pdf being a saved version +of the html. + + 10 + + + + SiSU works with an abstraction of the document based on its +structure which is comprised of its frame5 and the +objects6 it contains, which enables SiSU to represent +the document in many different ways, and to take advantage of the +strengths of different ways of presenting documents. The objects are +numbered, and these numbers can be used to provide a common base for +citing material within a document across the different output format +types. This is significant as page numbers are not suited to the +digital age, in web publishing, changing a browser's default font or +using a different browser means that text appears on different pages; +and in publishing in different formats, html, landscape and portrait +pdf etc. again page numbers are of no use to cite text in a manner that +is relevant against the different output types. Dealing with documents +at an object level together with object numbering also has implications +for search. + + + 5. the different heading levels + + + 6. units of text, primarily paragraphs and headings, also any tables, +poems, code-blocks + + 11 + + + + One of the challenges of maintaining documents is to keep them in a +format that would allow users to use them without depending on a +proprietary software popular at the time. Consider the ease of dealing +with legacy proprietary formats today and what guarantee you have that +old proprietary formats will remain (or can be read without proprietary +software/equipment) in 15 years time, or the way the way in which html +has evolved over its relatively short span of existence. SiSU +provides the flexibility of outputing documents in multiple +non-proprietary open formats including html, pdf7 and the ISO +standard ODF.8 Whilst SiSU relies on software, the +markup is uncomplicated and minimalistic which guarantees that future +engines can be written to run against it. It is also easily converted +to other formats, which means documents prepared in SiSU can be +migrated to other document formats. Further security is provided by the +fact that the software itself, SiSU is available under GPL3 a +licence that guarantees that the source code will always be open, and +free as in libre which means that that code base can be used updated +and further developed as required under the terms of its license. +Another challenge is to keep up with a moving target. SiSU +permits new forms of output to be added as they become important, (Open +Document Format text was added in 2006), and existing output to be +updated (html has evolved and the related module has been updated +repeatedly over the years, presumably when the World Wide Web +Consortium (w3c) finalises html 5 which is currently under development, +the html module will again be updated allowing all existing documents +to be regenerated as html 5). + + + 7. Specification submitted by Adobe to ISO to become a full open ISO +specification
    <http://www.linux-watch.com/news/NS7542722606.html> +     + + 8. ISO/IEC 26300:2006 + + 12 +     + + + The document formats are written to the file-system and available for +indexing by independent indexing tools, whether off the web like Google +and Yahoo or on the site like Lucene and Hyperestraier. + + 13 + + + + SiSU also provides other features such as concordance files and +document content certificates, and the working against an abstraction +of document structure has further possibilities for the research and +development of other document representations, the availability of +objects is useful for example for topic maps and the commercial law +thesaurus by Vikki Rogers and Al Krtizer, together with the flexibility +of SiSU offers great possibilities. + + 14 + + + + SiSU is primarily for published works, which can take advantage +of the citation system to reliably reference its documents. SiSU +works well in a complementary manner with such collaborative +technologies as Wikis, which can take advantage of and be used to +discuss the substance of content prepared in SiSU. + + 15 + + + + <http://www.jus.uio.no/sisu> + + 16 + + + + 2. How does sisu work? + + 17 + + + + SiSU markup is fairly minimalistic, it consists of: a (largely +optional) document header, made up of information about the document +(such as when it was published, who authored it, and granting what +rights) and any processing instructions; and markup within the +substantive text of the document, which is related to document +structure and typeface. SiSU must be able to discern the +structure of a document, (text headings and their levels in relation to +each other), either from information provided in the document header or +from markup within the text (or from a combination of both). Processing +is done against an abstraction of the document comprising of +information on the document's structure and its objects,[2] which the +program serializes (providing the object numbers) and which are +assigned hash sum values based on their content. This abstraction of +information about document structure, objects, (and hash sums), +provides considerable flexibility in representing documents different +ways and for different purposes (e.g. search, document layout, +publishing, content certification, concordance etc.), and makes it +possible to take advantage of some of the strengths of established ways +of representing documents, (or indeed to create new ones). + + 18 + + + + 3. Summary of features + + 19 + + + + sparse/minimal markup (clean utf-8 source texts). Documents are +prepared in a single UTF-8 file using a minimalistic mnemonic syntax. +Typical literature, documents like "War and Peace" require almost no +markup, and most of the headers are optional. + + 20 + + + + markup is easily readable/parsable by the human eye, (basic markup is +simpler and more sparse than the most basic HTML), [this may also be +converted to XML representations of the same input/source document]. + + 21 + + + + markup defines document structure (this may be done once in a header +pattern-match description, or for heading levels individually); basic +text attributes (bold, italics, underscore, strike-through etc.) as +required; and semantic information related to the document (header +information, extended beyond the Dublin core and easily further +extended as required); the headers may also contain processing +instructions. SiSU markup is primarily an abstraction of +document structure and document metadata to permit taking advantage of +the basic strengths of existing alternative practical standard ways of +representing documents [be that browser viewing, paper publication, sql +search etc.] (html, xml, odf, latex, pdf, sql) + + 22 + + + + for output produces reasonably elegant output of established industry +and institutionally accepted open standard formats.[3] takes advantage +of the different strengths of various standard formats for representing +documents, amongst the output formats currently supported are: + + 23 + + + + html - both as a single scrollable text and a segmented document + + 24 + + + + xhtml + + 25 + + + + XML - both in sax and dom style xml structures for further +development as required + + 26 + + + + ODF - open document format, the iso standard for document storage + + 27 + + + + LaTeX - used to generate pdf + + 28 + + + + pdf (via LaTeX) + + 29 + + + + sql - population of an sql database, (at the same object level +that is used to cite text within a document) + + 30 + + + + Also produces: concordance files; document content certificates (md5 or +sha256 digests of headings, paragraphs, images etc.) and html manifests +(and sitemaps of content). (b) takes advantage of the strengths +implicit in these very different output types, (e.g. PDFs produced +using typesetting of LaTeX, databases populated with documents at an +individual object/paragraph level, making possible granular search (and +related possibilities)) + + 31 + + + + ensuring content can be cited in a meaningful way regardless of +selected output format. Online publishing (and publishing in multiple +document formats) lacks a useful way of citing text internally within +documents (important to academics generally and to lawyers) as page +numbers are meaningless across browsers and formats. sisu seeks to +provide a common way of pinpoint the text within a document, (which can +be utilized for citation and by search engines). The outputs share a +common numbering system that is meaningful (to man and machine) across +all digital outputs whether paper, screen, or database oriented, (pdf, +HTML, xml, sqlite, postgresql), this numbering system can be used to +reference content. + + 32 + + + + Granular search within documents. SQL databases are populated at an +object level (roughly headings, paragraphs, verse, tables) and become +searchable with that degree of granularity, the output information +provides the object/paragraph numbers which are relevant across all +generated outputs; it is also possible to look at just the matching +paragraphs of the documents in the database; [output indexing also work +well with search indexing tools like hyperestraier]. + + 33 + + + + long term maintainability of document collections in a world of +changing formats, having a very sparsely marked-up source document +base. there is a considerable degree of future-proofing, output +representations are "upgradeable", and new document formats may be +added. e.g. addition of odf (open document text) module in 2006 and in +future html5 output sometime in future, without modification of +existing prepared texts + + 34 + + + + SQL search aside, documents are generated as required and static once +generated. + + 35 + + + + documents produced are static files, and may be batch processed, this +needs to be done only once but may be repeated for various reasons as +desired (updated content, addition of new output formats, updated +technology document presentations/representations) + + 36 + + + + document source (plaintext utf-8) if shared on the net may be used as +input and processed locally to produce the different document outputs + + 37 + + + + document source may be bundled together (automatically) with associated +documents (multiple language versions or master document with +inclusions) and images and sent as a zip file called a sisupod, if +shared on the net these too may be processed locally to produce the +desired document outputs + + 38 + + + + generated document outputs may automatically be posted to remote sites. + + 39 + + + + for basic document generation, the only software dependency is +Ruby, and a few standard Unix tools (this covers plaintext, +HTML, XML, ODF, LaTeX). To use a database you of course need that, and +to convert the LaTeX generated to pdf, a latex processor like tetex or +texlive. + + 40 + + + + as a developers tool it is flexible and extensible + + 41 + + + + Syntax highlighting for SiSU markup is available for a number of +text editors. + + 42 + + + + SiSU is less about document layout than about finding a way with +little markup to be able to construct an abstract representation of a +document that makes it possible to produce multiple representations of +it which may be rather different from each other and used for different +purposes, whether layout and publishing, or search of content + + 43 + + + + i.e. to be able to take advantage from this minimal preparation +starting point of some of the strengths of rather different established +ways of representing documents for different purposes, whether for +search (relational database, or indexed flat files generated for that +purpose whether of complete documents, or say of files made up of +objects), online viewing (e.g. html, xml, pdf), or paper publication +(e.g. pdf)... + + 44 + + + + the solution arrived at is by extracting structural information about +the document (about headings within the document) and by tracking +objects (which are serialized and also given hash values) in the manner +described. It makes possible representations that are quite different +from those offered at present. For example objects could be saved +individually and identified by their hashes, with an index of how the +objects relate to each other to form a document. + + 45 + + + + Endnotes + + 0 + + +     diff --git a/data/doc/manuals_generated/sisu_manual/sisu_introduction/sisu_feature_summary.html b/data/doc/manuals_generated/sisu_manual/sisu_introduction/sisu_feature_summary.html new file mode 100644 index 00000000..5622b1ae --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_introduction/sisu_feature_summary.html @@ -0,0 +1,781 @@ + + + + + + sisu_feature_summary - + 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 +

    +

    + Commands [0.58] +

    +

    + Ralph Amissah + +

    +

    + copy @ + + SiSU + +

    + + +
    +

    + SiSU - Commands [0.58],
    Ralph Amissah +

    +    		   +

    +   1 +

    +
    + + +
    + +   +

    +   2 +

    +
    + + +
    + +   +

    +   3 +

    +
    + + +
    + +   +
    + + +
    +

    + + 3. Summary of features +

    +    		 +

    +   19 +

    +
    + + +
    +
  • + sparse/minimal markup (clean utf-8 source texts). Documents are prepared in a single UTF-8 file using a minimalistic mnemonic syntax. Typical literature, documents like "War and Peace" require almost no markup, and most of the headers are optional. +
    • +    		 +

    +   20 +

    +
    + + +
    +
  • + markup is easily readable/parsable by the human eye, (basic markup is simpler and more sparse than the most basic HTML), [this may also be converted to XML representations of the same input/source document]. +
    • +    		 +

    +   21 +

    +
    + + +
    +
  • + markup defines document structure (this may be done once in a header pattern-match description, or for heading levels individually); basic text attributes (bold, italics, underscore, strike-through etc.) as required; and semantic information related to the document (header information, extended beyond the Dublin core and easily further extended as required); the headers may also contain processing instructions. SiSU markup is primarily an abstraction of document structure and document metadata to permit taking advantage of the basic strengths of existing alternative practical standard ways of representing documents [be that browser viewing, paper publication, sql search etc.] (html, xml, odf, latex, pdf, sql) +
    • +    		 +

    +   22 +

    +
    + + +
    +
  • + for output produces reasonably elegant output of established industry and institutionally accepted open standard formats.[3] takes advantage of the different strengths of various standard formats for representing documents, amongst the output formats currently supported are: +
    • +    		 +

    +   23 +

    +
    + + +
    +
  • + html - both as a single scrollable text and a segmented document +
    • +    		 +

    +   24 +

    +
    + + +
    +
  • + xhtml +
    • +    		 +

    +   25 +

    +
    + + +
    +
  • + XML - both in sax and dom style xml structures for further development as required +
    • +    		 +

    +   26 +

    +
    + + +
    +
  • + ODF - open document format, the iso standard for document storage +
    • +    		 +

    +   27 +

    +
    + + +
    +
  • + LaTeX - used to generate pdf +
    • +    		 +

    +   28 +

    +
    + + +
    +
  • + pdf (via LaTeX) +
    • +    		 +

    +   29 +

    +
    + + +
    +
  • + sql - population of an sql database, (at the same object level that is used to cite text within a document) +
    • +    		 +

    +   30 +

    +
    + + +
    +

    + Also produces: concordance files; document content certificates (md5 or sha256 digests of headings, paragraphs, images etc.) and html manifests (and sitemaps of content). (b) takes advantage of the strengths implicit in these very different output types, (e.g. PDFs produced using typesetting of LaTeX, databases populated with documents at an individual object/paragraph level, making possible granular search (and related possibilities)) +

    +    		 +

    +   31 +

    +
    + + +
    +
  • + ensuring content can be cited in a meaningful way regardless of selected output format. Online publishing (and publishing in multiple document formats) lacks a useful way of citing text internally within documents (important to academics generally and to lawyers) as page numbers are meaningless across browsers and formats. sisu seeks to provide a common way of pinpoint the text within a document, (which can be utilized for citation and by search engines). The outputs share a common numbering system that is meaningful (to man and machine) across all digital outputs whether paper, screen, or database oriented, (pdf, HTML, xml, sqlite, postgresql), this numbering system can be used to reference content. +
    • +    		 +

    +   32 +

    +
    + + +
    +
  • + Granular search within documents. SQL databases are populated at an object level (roughly headings, paragraphs, verse, tables) and become searchable with that degree of granularity, the output information provides the object/paragraph numbers which are relevant across all generated outputs; it is also possible to look at just the matching paragraphs of the documents in the database; [output indexing also work well with search indexing tools like hyperestraier]. +
    • +    		 +

    +   33 +

    +
    + + +
    +
  • + long term maintainability of document collections in a world of changing formats, having a very sparsely marked-up source document base. there is a considerable degree of future-proofing, output representations are "upgradeable", and new document formats may be added. e.g. addition of odf (open document text) module in 2006 and in future html5 output sometime in future, without modification of existing prepared texts +
    • +    		 +

    +   34 +

    +
    + + +
    +
  • + SQL search aside, documents are generated as required and static once generated. +
    • +    		 +

    +   35 +

    +
    + + +
    +
  • + documents produced are static files, and may be batch processed, this needs to be done only once but may be repeated for various reasons as desired (updated content, addition of new output formats, updated technology document presentations/representations) +
    • +    		 +

    +   36 +

    +
    + + +
    +
  • + document source (plaintext utf-8) if shared on the net may be used as input and processed locally to produce the different document outputs +
    • +    		 +

    +   37 +

    +
    + + +
    +
  • + document source may be bundled together (automatically) with associated documents (multiple language versions or master document with inclusions) and images and sent as a zip file called a sisupod, if shared on the net these too may be processed locally to produce the desired document outputs +
    • +    		 +

    +   38 +

    +
    + + +
    +
  • + generated document outputs may automatically be posted to remote sites. +
    • +    		 +

    +   39 +

    +
    + + +
    +
  • + for basic document generation, the only software dependency is Ruby, and a few standard Unix tools (this covers plaintext, HTML, XML, ODF, LaTeX). To use a database you of course need that, and to convert the LaTeX generated to pdf, a latex processor like tetex or texlive. +
    • +    		 +

    +   40 +

    +
    + + +
    +
  • + as a developers tool it is flexible and extensible +
    • +    		 +

    +   41 +

    +
    + + +
    +

    + Syntax highlighting for SiSU markup is available for a number of text editors. +

    +    		 +

    +   42 +

    +
    + + +
    +

    + SiSU is less about document layout than about finding a way with little markup to be able to construct an abstract representation of a document that makes it possible to produce multiple representations of it which may be rather different from each other and used for different purposes, whether layout and publishing, or search of content +

    +    		 +

    +   43 +

    +
    + + +
    +

    + i.e. to be able to take advantage from this minimal preparation starting point of some of the strengths of rather different established ways of representing documents for different purposes, whether for search (relational database, or indexed flat files generated for that purpose whether of complete documents, or say of files made up of objects), online viewing (e.g. html, xml, pdf), or paper publication (e.g. pdf)... +

    +    		 +

    +   44 +

    +
    + + +
    +

    + the solution arrived at is by extracting structural information about the document (about headings within the document) and by tracking objects (which are serialized and also given hash values) in the manner described. It makes possible representations that are quite different from those offered at present. For example objects could be saved individually and identified by their hashes, with an index of how the objects relate to each other to form a document. +

    +    		 +

    +   45 +

    +

    +^

     
    + + + +
    + +
    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_introduction/sisu_how.html b/data/doc/manuals_generated/sisu_manual/sisu_introduction/sisu_how.html new file mode 100644 index 00000000..830f1003 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_introduction/sisu_how.html @@ -0,0 +1,506 @@ + + + + + + sisu_how - + 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 +

    +

    + Commands [0.58] +

    +

    + Ralph Amissah + +

    +

    + copy @ + + SiSU + +

    + + +
    +

    + SiSU - Commands [0.58],
    Ralph Amissah +

    +    		   +

    +   1 +

    +
    + + +
    + +   +

    +   2 +

    +
    + + +
    + +   +

    +   3 +

    +
    + + +
    + +   +
    + + +
    +

    + + 2. How does sisu work? +

    +    		 +

    +   17 +

    +
    + + +
    +

    + SiSU markup is fairly minimalistic, it consists of: a (largely optional) document header, made up of information about the document (such as when it was published, who authored it, and granting what rights) and any processing instructions; and markup within the substantive text of the document, which is related to document structure and typeface. SiSU must be able to discern the structure of a document, (text headings and their levels in relation to each other), either from information provided in the document header or from markup within the text (or from a combination of both). Processing is done against an abstraction of the document comprising of information on the document's structure and its objects,[2] which the program serializes (providing the object numbers) and which are assigned hash sum values based on their content. This abstraction of information about document structure, objects, (and hash sums), provides considerable flexibility in representing documents different ways and for different purposes (e.g. search, document layout, publishing, content certification, concordance etc.), and makes it possible to take advantage of some of the strengths of established ways of representing documents, (or indeed to create new ones). +

    +    		 +

    +   18 +

    +

    +^

     
    + + + +
    + +
    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_introduction/sisu_intro.html b/data/doc/manuals_generated/sisu_manual/sisu_introduction/sisu_intro.html new file mode 100644 index 00000000..92ebc5ef --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_introduction/sisu_intro.html @@ -0,0 +1,699 @@ + + + + + + sisu_intro - + SiSU + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + +
    + +
    SiSU -->
    +    		 + + + + + + + + + + + + + + + + + +
    + + + TOC linked  toc  + + + + + + Full Text  scroll  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
    +    		 + + + + + + +
    + + TOC + + + + next >> + + +
    +
    + + + + +
    + + < + + + + ^ + + + + > + +

    + SiSU +

    +

    + Commands [0.58] +

    +

    + Ralph Amissah + +

    +

    + copy @ + + SiSU + +

    + + +
    +

    + SiSU - Commands [0.58],
    Ralph Amissah +

    +    		   +

    +   1 +

    +
    + + +
    + +   +

    +   2 +

    +
    + + +
    + +   +

    +   3 +

    +
    + + +
    + +   +
    + + +
    +

    + + 1. Introduction - What is SiSU? +

    +    		 +

    +   4 +

    +
    + + +
    +

    + SiSU is a system for document markup, publishing (in multiple open standard formats) and search +

    +    		 +

    +   5 +

    +
    + + +
    +

    + SiSU  1  is a  2  framework for document structuring, publishing and search, comprising of (a) a lightweight document structure and presentation markup syntax and (b) an accompanying engine for generating standard document format outputs from documents prepared in sisu markup syntax, which is able to produce multiple standard outputs that (can) share a common numbering system for the citation of text within a document. +

    +    		 +

    +   6 +

    +
    + + +
    +

    + SiSU is developed under an open source, software libre license (GPL3). It has been developed in the context of coping with large document sets with evolving markup related technologies, for which you want multiple output formats, a common mechanism for cross-output-format citation, and search. +

    +    		 +

    +   7 +

    +
    + + +
    +

    + SiSU both defines a markup syntax and provides an engine that produces open standards format outputs from documents prepared with SiSU markup. From a single lightly prepared document sisu custom builds several standard output formats which share a common (text object) numbering system for citation of content within a document (that also has implications for search). The sisu engine works with an abstraction of the document's structure and content from which it is possible to generate different forms of representation of the document. Significantly SiSU markup is more sparse than html and outputs which include html, LaTeX, landscape and portrait pdfs, Open Document Format (ODF), all of which can be added to and updated. SiSU is also able to populate SQL type databases at an object level, which means that searches can be made with that degree of granularity. Results of objects (primarily paragraphs and headings) can be viewed directly in the database, or just the object numbers shown - your search criteria is met in these documents and at these locations within each document. +

    +    		 +

    +   8 +

    +
    + + +
    +

    + Source document preparation and output generation is a two step process: (i) document source is prepared, that is, marked up in sisu markup syntax and (ii) the desired output subsequently generated by running the sisu engine against document source. Output representations if updated (in the sisu engine) can be generated by re-running the engine against the prepared source. Using SiSU markup applied to a document, SiSU custom builds various standard open output formats including plain text, HTML, XHTML, XML, OpenDocument, LaTeX or PDF files, and populate an SQL database with objects  3  (equating generally to paragraph-sized chunks) so searches may be performed and matches returned with that degree of granularity ( e.g. your search criteria is met by these documents and at these locations within each document). Document output formats share a common object numbering system for locating content. This is particularly suitable for "published" works (finalized texts as opposed to works that are frequently changed or updated) for which it provides a fixed means of reference of content. +

    +    		 +

    +   9 +

    +
    + + +
    +

    + In preparing a SiSU document you optionally provide semantic information related to the document in a document header, and in marking up the substantive text provide information on the structure of the document, primarily indicating heading levels and footnotes. You also provide information on basic text attributes where used. The rest is automatic, sisu from this information custom builds  4  the different forms of output requested. +

    +    		 +

    +   10 +

    +
    + + +
    +

    + SiSU works with an abstraction of the document based on its structure which is comprised of its frame  5  and the objects  6  it contains, which enables SiSU to represent the document in many different ways, and to take advantage of the strengths of different ways of presenting documents. The objects are numbered, and these numbers can be used to provide a common base for citing material within a document across the different output format types. This is significant as page numbers are not suited to the digital age, in web publishing, changing a browser's default font or using a different browser means that text appears on different pages; and in publishing in different formats, html, landscape and portrait pdf etc. again page numbers are of no use to cite text in a manner that is relevant against the different output types. Dealing with documents at an object level together with object numbering also has implications for search. +

    +    		 +

    +   11 +

    +
    + + +
    +

    + One of the challenges of maintaining documents is to keep them in a format that would allow users to use them without depending on a proprietary software popular at the time. Consider the ease of dealing with legacy proprietary formats today and what guarantee you have that old proprietary formats will remain (or can be read without proprietary software/equipment) in 15 years time, or the way the way in which html has evolved over its relatively short span of existence. SiSU provides the flexibility of outputing documents in multiple non-proprietary open formats including html, pdf  7  and the ISO standard ODF.  8  Whilst SiSU relies on software, the markup is uncomplicated and minimalistic which guarantees that future engines can be written to run against it. It is also easily converted to other formats, which means documents prepared in SiSU can be migrated to other document formats. Further security is provided by the fact that the software itself, SiSU is available under GPL3 a licence that guarantees that the source code will always be open, and free as in libre which means that that code base can be used updated and further developed as required under the terms of its license. Another challenge is to keep up with a moving target. SiSU permits new forms of output to be added as they become important, (Open Document Format text was added in 2006), and existing output to be updated (html has evolved and the related module has been updated repeatedly over the years, presumably when the World Wide Web Consortium (w3c) finalises html 5 which is currently under development, the html module will again be updated allowing all existing documents to be regenerated as html 5). +

    +    		 +

    +   12 +

    +
    + + +
    +

    + The document formats are written to the file-system and available for indexing by independent indexing tools, whether off the web like Google and Yahoo or on the site like Lucene and Hyperestraier. +

    +    		 +

    +   13 +

    +
    + + +
    +

    + SiSU also provides other features such as concordance files and document content certificates, and the working against an abstraction of document structure has further possibilities for the research and development of other document representations, the availability of objects is useful for example for topic maps and the commercial law thesaurus by Vikki Rogers and Al Krtizer, together with the flexibility of SiSU offers great possibilities. +

    +    		 +

    +   14 +

    +
    + + +
    +

    + SiSU is primarily for published works, which can take advantage of the citation system to reliably reference its documents. SiSU works well in a complementary manner with such collaborative technologies as Wikis, which can take advantage of and be used to discuss the substance of content prepared in SiSU. +

    +    		 +

    +   15 +

    +
    + + +
    +

    + <http://www.jus.uio.no/sisu> +

    +    		 +

    +   16 +

    +

    +^

    + + +
    +

    +  1. "SiSU information Structuring Universe" or "Structured information, Serialized Units". +

    +    		   +
    + + +
    +

    + also chosen for the meaning of the Finnish term "sisu". +

    +    		   +
    + + +
    +

    +  2. Unix command line oriented +

    +    		   +
    + + +
    +

    +  3. objects include: headings, paragraphs, verse, tables, images, but not footnotes/endnotes which are numbered separately and tied to the object from which they are referenced. +

    +    		   +
    + + +
    +

    +  4. i.e. the html, pdf, odf outputs are each built individually and optimised for that form of presentation, rather than for example the html being a saved version of the odf, or the pdf being a saved version of the html. +

    +    		   +
    + + +
    +

    +  5. the different heading levels +

    +    		   +
    + + +
    +

    +  6. units of text, primarily paragraphs and headings, also any tables, poems, code-blocks +

    +    		   +
    + + +
    +

    +  7. Specification submitted by Adobe to ISO to become a full open ISO specification +

    +    		   +
    + + +
    +

    + <http://www.linux-watch.com/news/NS7542722606.html> +

    +    		   +
    + + +
    +

    +  8. ISO/IEC 26300:2006 +

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

    +
    + + + + + +
    + \ No newline at end of file diff --git a/data/doc/manuals_generated/sisu_manual/sisu_introduction/sisu_introduction.sst b/data/doc/manuals_generated/sisu_manual/sisu_introduction/sisu_introduction.sst new file mode 100644 index 00000000..18b57394 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_introduction/sisu_introduction.sst @@ -0,0 +1,133 @@ +% SiSU 0.58 + +@title: SiSU + +@subtitle: Commands [0.58] + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2002-08-28 + +@date.issued: 2002-08-28 + +@date.available: 2002-08-28 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu_manual + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ +{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html +{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ +{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ +{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html +{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html +{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html +{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ +{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? What is SiSU? + +:C~? Description + +1~sisu_intro Introduction - What is SiSU? + +SiSU is a system for document markup, publishing (in multiple open standard formats) and search + +SiSU~{ "SiSU information Structuring Universe" or "Structured information, Serialized Units".
    also chosen for the meaning of the Finnish term "sisu". }~ is a~{ Unix command line oriented }~ framework for document structuring, publishing and search, comprising of (a) a lightweight document structure and presentation markup syntax and (b) an accompanying engine for generating standard document format outputs from documents prepared in sisu markup syntax, which is able to produce multiple standard outputs that (can) share a common numbering system for the citation of text within a document. + +SiSU is developed under an open source, software libre license (GPL3). It has been developed in the context of coping with large document sets with evolving markup related technologies, for which you want multiple output formats, a common mechanism for cross-output-format citation, and search. + +SiSU both defines a markup syntax and provides an engine that produces open standards format outputs from documents prepared with SiSU markup. From a single lightly prepared document sisu custom builds several standard output formats which share a common (text object) numbering system for citation of content within a document (that also has implications for search). The sisu engine works with an abstraction of the document's structure and content from which it is possible to generate different forms of representation of the document. Significantly SiSU markup is more sparse than html and outputs which include html, LaTeX, landscape and portrait pdfs, Open Document Format (ODF), all of which can be added to and updated. SiSU is also able to populate SQL type databases at an object level, which means that searches can be made with that degree of granularity. Results of objects (primarily paragraphs and headings) can be viewed directly in the database, or just the object numbers shown - your search criteria is met in these documents and at these locations within each document. + +Source document preparation and output generation is a two step process: (i) document source is prepared, that is, marked up in sisu markup syntax and (ii) the desired output subsequently generated by running the sisu engine against document source. Output representations if updated (in the sisu engine) can be generated by re-running the engine against the prepared source. Using SiSU markup applied to a document, SiSU custom builds various standard open output formats including plain text, HTML, XHTML, XML, OpenDocument, LaTeX or PDF files, and populate an SQL database with objects~{ objects include: headings, paragraphs, verse, tables, images, but not footnotes/endnotes which are numbered separately and tied to the object from which they are referenced. }~ (equating generally to paragraph-sized chunks) so searches may be performed and matches returned with that degree of granularity ( e.g. your search criteria is met by these documents and at these locations within each document). Document output formats share a common object numbering system for locating content. This is particularly suitable for "published" works (finalized texts as opposed to works that are frequently changed or updated) for which it provides a fixed means of reference of content. + +In preparing a SiSU document you optionally provide semantic information related to the document in a document header, and in marking up the substantive text provide information on the structure of the document, primarily indicating heading levels and footnotes. You also provide information on basic text attributes where used. The rest is automatic, sisu from this information custom builds~{ i.e. the html, pdf, odf outputs are each built individually and optimised for that form of presentation, rather than for example the html being a saved version of the odf, or the pdf being a saved version of the html. }~ the different forms of output requested. + +SiSU works with an abstraction of the document based on its structure which is comprised of its frame~{ the different heading levels }~ and the objects~{ units of text, primarily paragraphs and headings, also any tables, poems, code-blocks }~ it contains, which enables SiSU to represent the document in many different ways, and to take advantage of the strengths of different ways of presenting documents. The objects are numbered, and these numbers can be used to provide a common base for citing material within a document across the different output format types. This is significant as page numbers are not suited to the digital age, in web publishing, changing a browser's default font or using a different browser means that text appears on different pages; and in publishing in different formats, html, landscape and portrait pdf etc. again page numbers are of no use to cite text in a manner that is relevant against the different output types. Dealing with documents at an object level together with object numbering also has implications for search. + +One of the challenges of maintaining documents is to keep them in a format that would allow users to use them without depending on a proprietary software popular at the time. Consider the ease of dealing with legacy proprietary formats today and what guarantee you have that old proprietary formats will remain (or can be read without proprietary software/equipment) in 15 years time, or the way the way in which html has evolved over its relatively short span of existence. SiSU provides the flexibility of outputing documents in multiple non-proprietary open formats including html, pdf~{ Specification submitted by Adobe to ISO to become a full open ISO specification
    http://www.linux-watch.com/news/NS7542722606.html }~ and the ISO standard ODF.~{ ISO/IEC 26300:2006 }~ Whilst SiSU relies on software, the markup is uncomplicated and minimalistic which guarantees that future engines can be written to run against it. It is also easily converted to other formats, which means documents prepared in SiSU can be migrated to other document formats. Further security is provided by the fact that the software itself, SiSU is available under GPL3 a licence that guarantees that the source code will always be open, and free as in libre which means that that code base can be used updated and further developed as required under the terms of its license. Another challenge is to keep up with a moving target. SiSU permits new forms of output to be added as they become important, (Open Document Format text was added in 2006), and existing output to be updated (html has evolved and the related module has been updated repeatedly over the years, presumably when the World Wide Web Consortium (w3c) finalises html 5 which is currently under development, the html module will again be updated allowing all existing documents to be regenerated as html 5). + +The document formats are written to the file-system and available for indexing by independent indexing tools, whether off the web like Google and Yahoo or on the site like Lucene and Hyperestraier. + +SiSU also provides other features such as concordance files and document content certificates, and the working against an abstraction of document structure has further possibilities for the research and development of other document representations, the availability of objects is useful for example for topic maps and the commercial law thesaurus by Vikki Rogers and Al Krtizer, together with the flexibility of SiSU offers great possibilities. + +SiSU is primarily for published works, which can take advantage of the citation system to reliably reference its documents. SiSU works well in a complementary manner with such collaborative technologies as Wikis, which can take advantage of and be used to discuss the substance of content prepared in SiSU. + +http://www.jus.uio.no/sisu + +% SiSU is a way of preparing, publishing, managing and searching documents. + +1~sisu_how How does sisu work? + +SiSU markup is fairly minimalistic, it consists of: a (largely optional) document header, made up of information about the document (such as when it was published, who authored it, and granting what rights) and any processing instructions; and markup within the substantive text of the document, which is related to document structure and typeface. SiSU must be able to discern the structure of a document, (text headings and their levels in relation to each other), either from information provided in the document header or from markup within the text (or from a combination of both). Processing is done against an abstraction of the document comprising of information on the document's structure and its objects,[2] which the program serializes (providing the object numbers) and which are assigned hash sum values based on their content. This abstraction of information about document structure, objects, (and hash sums), provides considerable flexibility in representing documents different ways and for different purposes (e.g. search, document layout, publishing, content certification, concordance etc.), and makes it possible to take advantage of some of the strengths of established ways of representing documents, (or indeed to create new ones). + +1~sisu_feature_summary Summary of features + +_* sparse/minimal markup (clean utf-8 source texts). Documents are prepared in a single UTF-8 file using a minimalistic mnemonic syntax. Typical literature, documents like "War and Peace" require almost no markup, and most of the headers are optional. + +_* markup is easily readable/parsable by the human eye, (basic markup is simpler and more sparse than the most basic HTML), [this may also be converted to XML representations of the same input/source document]. + +_* markup defines document structure (this may be done once in a header pattern-match description, or for heading levels individually); basic text attributes (bold, italics, underscore, strike-through etc.) as required; and semantic information related to the document (header information, extended beyond the Dublin core and easily further extended as required); the headers may also contain processing instructions. SiSU markup is primarily an abstraction of document structure and document metadata to permit taking advantage of the basic strengths of existing alternative practical standard ways of representing documents [be that browser viewing, paper publication, sql search etc.] (html, xml, odf, latex, pdf, sql) + +_* for output produces reasonably elegant output of established industry and institutionally accepted open standard formats.[3] takes advantage of the different strengths of various standard formats for representing documents, amongst the output formats currently supported are: + +_1* html - both as a single scrollable text and a segmented document + +_1* xhtml + +_1* XML - both in sax and dom style xml structures for further development as required + +_1* ODF - open document format, the iso standard for document storage + +_1* LaTeX - used to generate pdf + +_1* pdf (via LaTeX) + +_1* sql - population of an sql database, (at the same object level that is used to cite text within a document) + +Also produces: concordance files; document content certificates (md5 or sha256 digests of headings, paragraphs, images etc.) and html manifests (and sitemaps of content). (b) takes advantage of the strengths implicit in these very different output types, (e.g. PDFs produced using typesetting of LaTeX, databases populated with documents at an individual object/paragraph level, making possible granular search (and related possibilities)) + +_* ensuring content can be cited in a meaningful way regardless of selected output format. Online publishing (and publishing in multiple document formats) lacks a useful way of citing text internally within documents (important to academics generally and to lawyers) as page numbers are meaningless across browsers and formats. sisu seeks to provide a common way of pinpoint the text within a document, (which can be utilized for citation and by search engines). The outputs share a common numbering system that is meaningful (to man and machine) across all digital outputs whether paper, screen, or database oriented, (pdf, HTML, xml, sqlite, postgresql), this numbering system can be used to reference content. + +_* Granular search within documents. SQL databases are populated at an object level (roughly headings, paragraphs, verse, tables) and become searchable with that degree of granularity, the output information provides the object/paragraph numbers which are relevant across all generated outputs; it is also possible to look at just the matching paragraphs of the documents in the database; [output indexing also work well with search indexing tools like hyperestraier]. + +_* long term maintainability of document collections in a world of changing formats, having a very sparsely marked-up source document base. there is a considerable degree of future-proofing, output representations are "upgradeable", and new document formats may be added. e.g. addition of odf (open document text) module in 2006 and in future html5 output sometime in future, without modification of existing prepared texts + +_* SQL search aside, documents are generated as required and static once generated. + +_* documents produced are static files, and may be batch processed, this needs to be done only once but may be repeated for various reasons as desired (updated content, addition of new output formats, updated technology document presentations/representations) + +_* document source (plaintext utf-8) if shared on the net may be used as input and processed locally to produce the different document outputs + +_* document source may be bundled together (automatically) with associated documents (multiple language versions or master document with inclusions) and images and sent as a zip file called a sisupod, if shared on the net these too may be processed locally to produce the desired document outputs + +_* generated document outputs may automatically be posted to remote sites. + +_* for basic document generation, the only software dependency is Ruby, and a few standard Unix tools (this covers plaintext, HTML, XML, ODF, LaTeX). To use a database you of course need that, and to convert the LaTeX generated to pdf, a latex processor like tetex or texlive. + +_* as a developers tool it is flexible and extensible + +Syntax highlighting for SiSU markup is available for a number of text editors. + +SiSU is less about document layout than about finding a way with little markup to be able to construct an abstract representation of a document that makes it possible to produce multiple representations of it which may be rather different from each other and used for different purposes, whether layout and publishing, or search of content + +i.e. to be able to take advantage from this minimal preparation starting point of some of the strengths of rather different established ways of representing documents for different purposes, whether for search (relational database, or indexed flat files generated for that purpose whether of complete documents, or say of files made up of objects), online viewing (e.g. html, xml, pdf), or paper publication (e.g. pdf)... + +the solution arrived at is by extracting structural information about the document (about headings within the document) and by tracking objects (which are serialized and also given hash values) in the manner described. It makes possible representations that are quite different from those offered at present. For example objects could be saved individually and identified by their hashes, with an index of how the objects relate to each other to form a document. + diff --git a/data/doc/manuals_generated/sisu_manual/sisu_introduction/sisu_manifest.html b/data/doc/manuals_generated/sisu_manual/sisu_introduction/sisu_manifest.html new file mode 100644 index 00000000..60a6e084 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_introduction/sisu_manifest.html @@ -0,0 +1,200 @@ + + + + +SiSU manifest: SiSU + + + + + + + + + + +
    SiSU -->

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

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

    SiSU - Commands [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_introduction/toc.html>

    16.2

    Full Text full length document (HTML)

    doc.html

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

    55.6

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

    portrait.pdf

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

    116.0

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

    landscape.pdf

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

    112.4

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

    opendocument.odt

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

    13.8

    full length document (XHTML)

    scroll.xhtml

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

    21.1

    full length document (XML SAX)

    sax.xml

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

    21.3

    full length document (XML DOM)

    dom.xml

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

    22.8

    full length document (plaintext (UTF-8))

    plain.txt

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

    18.0

    Concordance file (HTML - wordmap, alphabetical wordlist)

    concordance.html

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

    149.9

    Digest/DCC - Document Content Certificate (md5)

    digest.txt

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

    8.6

    + + +

    Markup (SiSU source)

    sisu_introduction.sst   b2a6da5bd22fa1eaa92a08d81f11d1c7
    <http://www.jus.uio.no/sisu/sisu_manual/sisu_introduction/sisu_introduction.sst>

    16.6

    +

    SiSU doc (zip)

    sisupod.zip   17bcc61360e166233393466783b17aec
    <http://www.jus.uio.no/sisu/sisu_manual/sisu_introduction/sisupod.zip>

    8.7

    +

    SiSU manifest of document metadata

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

    metadata

    description

    DC Title:

    SiSU - Commands [0.58]

    Title:

    SiSU

    Subtitle:

    Commands [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:

    Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3

    DC Date:

    2007-09-16

    DC Date created:

    2002-08-28

    DC Date issued:

    2002-08-28

    DC Date available:

    2002-08-28

    DC Date modified:

    2007-09-16

    DC Language:

    English

    DC Identifier:

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

    Sourcefile:

    sisu_introduction.sst

    Word Count approximate:

    2500

    Sourcefile Digest (md5):

    b2a6da5bd22fa1eaa92a08d81f11d1c7

    Document (metaverse) last generated:

    Sun Sep 23 04:13:41 +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_introduction/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_introduction/sisupod.zip b/data/doc/manuals_generated/sisu_manual/sisu_introduction/sisupod.zip new file mode 100644 index 00000000..5ee9f459 Binary files /dev/null and b/data/doc/manuals_generated/sisu_manual/sisu_introduction/sisupod.zip differ diff --git a/data/doc/manuals_generated/sisu_manual/sisu_introduction/sitemap.xml b/data/doc/manuals_generated/sisu_manual/sisu_introduction/sitemap.xml new file mode 100644 index 00000000..79e07aaa --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_introduction/sitemap.xml @@ -0,0 +1,30 @@ + + + + + + http://www.jus.uio.no/sisu/sisu_manual/sisu_introduction/toc.html + 2007-09-16 + monthly + 0.7 + + + http://www.jus.uio.no/sisu/sisu_manual/sisu_introduction/doc.html + 2007-09-16 + 0.5 + + + http://www.jus.uio.no/sisu/sisu_manual/sisu_introduction/sisu_manifest.html + 2007-09-16 + 0.5 + + diff --git a/data/doc/manuals_generated/sisu_manual/sisu_introduction/toc.html b/data/doc/manuals_generated/sisu_manual/sisu_introduction/toc.html new file mode 100644 index 00000000..a0063954 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_introduction/toc.html @@ -0,0 +1,522 @@ + + + + + + SiSU + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + +
    + +
    SiSU -->
    +    		 + + + + + + + + + + + + + + + +
    + + TOC linked  toc  + + + + + Full Text  scroll  + + + + + + PDF portrait +   pdf  + + + + + + PDF landscape +   pdf  + + + + + + ODF/ODT  odt  + + + + + + +   A-Z  + + + + + + Document Manifest  + + + + + @ +
    +    		 +   + next >> +   +
    +

    + +

    + +
    + + +
    + +

    SiSU +

    + +

    Commands [0.58] +

    + +

    Ralph Amissah +

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

    + SiSU - Commands [0.58],
    Ralph Amissah +

    + +

    + What is SiSU? +

    + +

    + Description +

    + +

    + + 1. Introduction - What is SiSU? + +

    + +

    + + 2. How does sisu work? + +

    + +

    + + 3. Summary of features + +

    + +

    + + Endnotes + +

    + +

    + Document Information (metadata) +

    + +

    Copyright ©  Ralph Amissah 2007, part of SiSU documentation, License GPL 3

    +

    + +

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