SiSU -->
[ document manifest ]
<< previous TOC next >>
< ^ >

SiSU - SiSU information Structuring Universe - Structured information, Serialized Units,
Ralph Amissah

Structured information, Serialized Units

SiSU - from less markup than the most elementary equivalent html, you can have more

1. Description

1.1 Outline
1.2 Short summary of features
1.3 How it works
1.4 Simple markup
1.4.1 Sparse markup requirement, try to get the most out of markup
1.4.2 Single markup file provides multiple output formats
1.4.3 Syntax relatively easy to read and remember
1.4.4 Kept simple by having a limited publishing feature set, and features identified as most important, are available across several document types
1.5 Designed with usability in mind
1.6 Code separate from content
1.7 Object citation numbering, a text or object positioning / citation system - "paragraph" (or text object) numbering, that remains same and usable across all output formats by people and machine
1.8 Handling of Dublin Core meta-tags making use of the Resource Description Framework
1.9 Easy directory management
1.10 Document Version Control Information
1.11 Table of contents
1.12 Auto-numbering of headings
1.13 Numbering and cross-hyperlinking of endnotes
1.14 "Skinnable"
1.15 Multiple Outputs
1.15.1 html - several presentations: full length & segmented; css & table based
1.15.2 EPUB
1.15.3 XML
1.15.4 ODT:ODF, Open Document Format - ISO/IEC 26300:2006
1.15.5 PDF - portrait and landscape, (through the generation of LaTeX output which is then transformed to pdf)
1.15.6 Search - loading/populating of relational database while retaining document structure information, object citation numbering and other features (currently PostgreSQL and/or SQLite)
1.15.7 Search - database frontend sample, utilising database and SiSU features, including object citation numbering (backend currently PostgreSQL)
1.15.8 Other forms
1.16 Concordance / Word Map or rudimentary index
1.17 Managed (document) directory, database, or site structure
1.18 Batch processing
1.19 Integration to superior Gnu/Linux and Unix tools
1.19.1 Backup and version control
1.19.2 Editor support
1.20 Modular design, need something new add a module

2. Markup and Output Examples

2.1 Markup examples
2.2 A few book (and other) examples
2.2.1 "Viral Spiral", David Bollier
"The Wealth of Networks", Yochai Benkler
"Two Bits", Christopher Kelty
"Free Culture", Lawrence Lessig
"CONTENT", Cory Doctorow
"Democratizing Innovation", by Eric von Hippel
"Free as in Freedom: Richard Stallman's Crusade for Free Software", by Sam Williams
"Free For All: How Linux and the Free Software Movement Undercut the High Tech Titans", by Peter Wayner
"The Cathedral and the Bazaar", by Eric S. Raymond
"Down and out in the Magic Kingdom", Cory Doctorow
"Little Brother", Cory Doctorow
"For the Win", Cory Doctorow
"Accelerando", Charles Stross
"Tainaron", Leena Krohn
"Sphinx or Robot", Leena Krohn
"War and Peace", Leo Tolstoy, PG Etext 2600
"Don Quixote", Miguel de Cervantes [Saavedra], translated by John Ormsby, PG Etext 996
"Gulliver's Travels", Jonathan Swift, transcribed from the 1892 George Bell and Sons edition by David Price, PG Etext 829
"Alice's Adventures in Wonderland", Lewis Carroll, PG Etext 11
"Through The Looking-Glass", Lewis Carroll, PG Etext 12
"Alice's Adventures in Wonderland" and "Through The Looking-Glass", Lewis Carroll, PG Etexts 11 and 12
"Gnu Public License 2", (GPL 2) Free Software Foundation
"Gnu Public License v3 - Third discussion draft", (GPLv3) Free Software Foundation
"Debian Social Contract"
"Debian Constitution v1.3", (simple/default markup)
"Debian Constitution v1.3", (markup adjusted for output to more closely match the original)
"Debian Constitution v1.2", (simple/default markup)
"Debian Constitution v1.2", (markup adjusted for output to more closely match the original)
"A Uniform Sales Terminology", Vikki Rogers and Albert Kritzer
"The Autonomous Contract" 1997 - markup sample
"The Autonomous Contract Revisited" - markup sample
"United Nations Convention on Contracts for the International Sale of Goods"
/PECL/ the "Principles of European Contract Law"
2.3 SQL - PostgreSQL, SQLite
2.4 Lex Mercatoria as an example
2.5 For good measure the markup for a document with lots of (simple) tables
2.6 And a link to the output of a reported case

3. A Checklist of Output Features

4. Introduction to SiSU Markup  114 

4.1 Summary
4.2 Markup Examples
4.2.1 Online
4.2.2 Installed

5. Markup of Headers

5.1 Sample Header
5.2 Available Headers

6. Markup of Substantive Text

6.1 Heading Levels
6.2 Font Attributes
6.3 Indentation and bullets
6.4 Footnotes / Endnotes
6.5 Links
6.5.1 Naked URLs within text, dealing with urls
6.5.2 Linking Text
6.5.3 Linking Images
6.6 Grouped Text
6.6.1 Tables
6.6.2 Poem
6.6.3 Group
6.6.4 Code
6.7 Book index

7. Composite documents markup

Markup Syntax History

8. Notes related to Files-types and Markup Syntax

9. Commands Summary

9.1 Description
9.2 Document Processing Command Flags

10. command line modifiers

11. database commands

12. Shortcuts, Shorthand for multiple flags

12.1 Command Line with Flags - Batch Processing

Technical Information

13. Technical notes

13.1 See abandoned U.S. Provisional Patent Application

14. Diagram / Chart

14.1 The Chart
14.2 I/O
14.3 The Program
14.4 Software utilised
14.4.1 SiSU
14.4.2 SiSU Modules

15. SiSU development environment and technologies of interest, including data formats

15.1 Development environment, Debian
15.2 Programming language, Ruby
15.3 SGML & XML Family
15.3.1 SGML
15.3.2 XML Family
15.4 TeX Family
15.5 Pdf
15.6 Relational Databases, SQL
15.7 Other Databases
15.8 Text Search
15.9 Character Encoding, Unicode
15.10 Information Visualization
15.11 Metadata - semantic
15.12 Syndication, Web feed formats
15.13 Other
15.14 Editors
15.15 Version Control
15.16 Licenses

A Summary of notable events

16. A history of SiSU and its outputs including search

A Chronological history of developments on SiSU

1993

1994

1995

1996

1997

1998

1999

2000

2001

2002

2003

January
February
March
April
June
July
August
September
November
December

2004

January
February
March
April
May
June
July
August
September
October
November
December

2005

January
February
March
April
May
June
July
August
September
October
November
December

2006

January
February
March
April
May
June
July
August
September
October
November
December

2007

January
February
March
April
May
June
July
August
September
November
December

2008

January
February
April
June
September
October
November
December

2009

January
December

2010

March

2010

March

FAQ, Howto, Installation, etc.

HowTo

17. Getting Help

17.1 SiSU "man" pages
17.2 SiSU built-in help
17.3 Command Line with Flags - Batch Processing

18. Setup, initialisation

18.1 initialise output directory
18.1.1 Use of search functionality, an example using sqlite
18.2 misc
18.2.1 url for output files -u -U
18.2.2 toggle screen color
18.2.3 verbose mode
18.2.4 quiet mode
18.2.5 maintenance mode intermediate files kept -M
18.2.6 start the webrick server
18.3 remote placement of output

19. Configuration Files

20. Markup

20.1 Headers
20.2 Font Face
20.2.1 Bold
20.2.2 Italics
20.2.3 Underscore
20.2.4 Strikethrough
20.3 Endnotes
20.4 Links
20.5 Number Titles
20.6 Line operations
20.7 Tables
20.8 Grouped Text
20.9 Composite Document

21. Change Appearance

21.1 Skins
21.2 CSS

Extracts from the README

22. README

22.1 Online Information, places to look
22.2 Installation
22.2.1 Debian
22.2.2 RPM
22.2.3 Source package .tgz
22.2.4 to use setup.rb
22.2.5 to use install (prapared with "Rake")
22.2.6 to use install (prapared with "Rant")
22.3 Dependencies
22.4 Quick start
22.5 Configuration files
22.6 Use General Overview
22.7 Help
22.8 Directory Structure
22.9 Configuration File
22.10 Markup
22.11 Additional Things
22.12 License
22.13 SiSU Standard

Extracts from man 8 sisu

23. Post Installation Setup

23.1 Post Installation Setup - Quick start
23.2 Document markup directory
23.2.1 Configuration files
23.2.2 Debian INSTALLATION Note
23.2.3 Document Resource Configuration
23.2.4 Skins

24. FAQ - Frequently Asked/Answered Questions

24.1 Why are urls produced with the -v (and -u) flag that point to a web server on port 8081 ?
24.2 I cannot find my output, where is it?
24.3 I do not get any pdf output, why?
24.4 Where is the latex (or some other interim) output?
24.5 Why isn't SiSU markup XML
24.6 LaTeX claims to be a document preparation system for high-quality typesetting. Can the same be said about SiSU?
24.7 Can the SiSU markup be used to prepare for a LaTex automatic building of an index to the work?
24.8 Can the conversion from SiSU to LaTeX be modified if we have special needs for the LaTeX, or do we need to modify the LaTeX manually?
24.9 How do I create GIN or GiST index in Postgresql for use in SiSU
24.10 Are there some examples of using Ferret Search with a SiSU repository?
Have you had any reports of building SiSU from tar on Mac OS 10.4?
24.12 Where is version 1?
24.13 What is the difference between version 1 and 2?

Installation

25. Installation

25.1 Debian
25.2 Other Unix / Linux
25.2.1 source tarball

26. SiSU Components, Dependencies and Notes

26.1 sisu
26.2 sisu-complete
26.3 sisu-examples
26.4 sisu-pdf
26.5 sisu-postgresql
26.6 sisu-remote
26.7 sisu-sqlite

27. Quickstart - Getting Started Howto

27.1 Installation
27.1.1 Debian Installation
27.1.2 RPM Installation
27.1.3 Installation from source
27.2 Testing SiSU, generating output
27.2.1 basic text, plaintext, html, XML, ODF, EPUB
27.2.2 LaTeX / pdf
27.2.3 relational database - postgresql, sqlite
27.3 Getting Help
27.3.1 The man pages
27.3.2 Built in help
27.3.3 The home page
27.4 Markup Samples

28. SiSU Components, Dependencies and Notes

29. Breakage and Fixes

31st October 2006 - SiSU < 0.48.3 break against Ruby > 1.8.5-3, break on cyclic include; Fixed SiSU: >=0.48.3 (see notes)
21st September 2005 - Avoid ruby-1.8.3 (2005-09-21) and (2005-10-12), Ruby Segfaults; Fixed: later versions of Ruby (see notes)

License, Standard

30. License

31. Things SiSU Standard

Download information

Download information

32. Download SiSU - Linux/Unix

SiSU Current Version - Linux/Unix
Source (tarball tar.gz)
Git (source control management)
Debian
RPM

Changelog - sisu

33. SiSU Version Manifest / changelog

Current version
3.0
Previous versions
2.7
2.6
2.5
2.4
2.3
2.2
2.1
2.0
1.0
0.71
0.70
0.69
0.68
0.67
0.66
0.65
0.64
0.63
0.62
0.61
0.60
0.59
0.58
0.57
0.56
0.55
0.54
0.53
0.52
0.51
0.50
0.49
0.48
0.47
0.46
0.45
0.44
0.43
0.42
0.41
0.40
0.39
0.38
0.37
0.36
0.35
0.34
0.33
0.32
0.31
0.30
0.29
0.28
0.27
0.26
0.25
0.24
0.23
0.22
0.21
0.20
0.18
0.16
0.14
0.12
0.10
0.8
0.6
0.4
0.2
0.1
Release

Changelog - sisu-markup-samples

34. Version Manifest / changelog - SiSU Markup Samples

Current version
2.0
1.1
1.0

Method for providing digital documents including a common citation structure

[SiSU Provisional Patent Application of 2004 based on much older idea and work on SiSU, Abandoned]

The 'Invention' described (and diagrams) by Ralph Amissah.
Provisional patent application text prepared by Stephan Filipek of Winston & Strawn LLP

35. 1. Background

36. 2. Definitions

37. 3. Brief Descriptions of the Drawings

38. 4. Detailed Description of the Preferred Embodiments

39. 5. Document Processing, examples of subsequent steps

40. 6. Advantages of the Invention

41. 7. THE CLAIMS

Post Filing Appendix

42. Post Filing Appendix: Reasons for Abandonment of Patent Process Claim

Endnotes

Endnotes

Metadata

SiSU Metadata, document information

Manifest

SiSU Manifest, alternative outputs etc.

SiSU - SiSU information Structuring Universe - Structured information, Serialized Units,
Ralph Amissah

Structured information, Serialized Units

Technical Information

15. SiSU development environment and technologies of interest, including data formats

15.1 Development environment, Debian
15.2 Programming language, Ruby
15.3 SGML & XML Family
15.3.1 SGML
15.3.2 XML Family
15.4 TeX Family
15.5 Pdf
15.6 Relational Databases, SQL
15.7 Other Databases
15.8 Text Search
15.9 Character Encoding, Unicode
15.10 Information Visualization
15.11 Metadata - semantic
15.12 Syndication, Web feed formats
15.13 Other
15.14 Editors
15.15 Version Control
15.16 Licenses

SiSU started as a way to make html manageable, together with the core concept of making text citable through the use of object character numbering. LaTeX/pdf provided a way of making near print quality output, and demonstrating how conveniently the concept worked across different output formats. Relational database storage using the same concept underscored this and the concept makes database search results relevant, to locating results quickly in all output formats that use object character numbers.

There are a number of data formats and technologies that are of particular interest to SiSU, and to keep an eye on more generally. These links are kept here for convenience. Note that whilst all the technologies mentioned are of interest in the context of SiSU, not all of them are supported by SiSU.

785
  • *Debian*,   122  wikipedia entry,   123  social contract   124  Debian is one of the largest software integration projects with over 15,000 packages available and is probably the most technically sophisticated of the linux distributions. It is built for multiple hardware architectures, and is the base distribution for somewhere around 130 Debian derirvative linux distributions.
  • *Unix*
  • 792

    Organisations

    Information

    797
  • *SGML* - Standard Generalized Markup Language (of which XML is part of the family), wikipedia entry   136 
  • *LaTeX* a document preparation system for the TeX typesetting program, wikipedia entry   181 
  • 814
  • *PDF* - Portable Document Format, wikipedia entry   184  pdflatex, pdftex,   185 
  • 819
  • *SQL* - Structured Query Language, wikipedia entry   189 
  • 823
  • *CouchDB*   200  looks fascinating, work in progress, book in progress Relax with CouchDB   201  an interview with it's author,   202  wikipedia entry   203  makes use of JSON: wikipedia entry   204 
  • information visualization toolkit prefuse   216 
  • 837
  • *DC* - Dublin Core, wikipedia entry   220 
  • *sitemap*   230  - standard web index information protocol backed by Google, Yahoo and Microsoft wikipedia entry   231 
  • RDF - Resource Description Framework wikipedia entry   232 
  • 844
  • RSS - Really Simple Syndication / Rich Site Summary wikipedia entry   233  rss 2.0 specification   234  media rss   235 
  • 848

    Organisations

    Technologies

  • *HDF* - Hierarchical Data Format, wikipedia entry   240 
  • 866

    Organisations

    Licenses




     122.http://www.debian.org/

     123.http://en.wikipedia.org/wiki/Debian

     124.http://www.debian.org/social_contract

     125.http://www.gnu.org/

     126.http://en.wikipedia.org/wiki/GNU

     127.http://distrowatch.com/

     128.http://www.ruby-lang.org/en/

     129.http://en.wikipedia.org/wiki/Ruby_language

     130.http://packages.debian.org/unstable/interpreters/ruby1.8

     131.http://microjet.ath.cx/WebWiki/RubyOnDebian.html

     132.http://www.oasis-open.org/home/index.php

     133.http://en.wikipedia.org/wiki/OASIS_%28organization%29

     134.http://www.w3.org/

     135.http://en.wikipedia.org/wiki/World_Wide_Web_Consortium

     136.http://en.wikipedia.org/wiki/Sgml

     137.http://xml.coverpages.org/

     138.http://en.wikipedia.org/wiki/HTML

     139.http://galeon.sourceforge.net/

     140.http://www.microsoft.com/windows/ie/default.asp

     141.http://www.konqueror.org/

     142.http://www.mozilla.org/

     143.http://home.netscape.com/comprod/mirror/client_download.html

     144.http://www.opera.com/

     145.http://www.mozilla.org/products/firefox/

     146.http://www.dillo.org/

     147.http://www.gnome.org/projects/epiphany/

     148.http://elinks.or.cz/

     149.http://links.twibright.com/

     150.http://w3m.sourceforge.net/

     151.http://www.w3.org/MarkUp/

     152.http://en.wikipedia.org/wiki/XHTML

     153.http://www.w3.org/XML/

     154.http://en.wikipedia.org/wiki/Xml

     155.http://relaxng.org/

     156.http://en.wikipedia.org/wiki/RELAX_NG

     157.http://books.xmlschemata.org/relaxng/page2.html

     158.http://www.w3.org/Style/CSS/

     159.http://en.wikipedia.org/wiki/Cascading_Style_Sheets

     160.http://www.csszengarden.com/

     161.http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=office

     162.http://en.wikipedia.org/wiki/Open_Document

     163.http://xml.coverpages.org/odf.html

     164.http://www.oasis-open.org/committees/download.php/12572/OpenDocument-v1.0-os.pdf

     165.http://www.openoffice.org/

     166.http://www.docbook.org/

     167.http://en.wikipedia.org/wiki/Docbook

     168.http://xml.coverpages.org/docBook.html

     169.http://wiki.docbook.org/topic/DocBook

     170.http://www.oasis-open.org/docbook/

     171.http://docbook.org/tdg/en/html/docbook.html

     172.http://www.oasis-open.org/docbook/

     173.http://www.tei-c.org/

     174.http://en.wikipedia.org/wiki/Text_Encoding_Initiative

     175.http://xml.coverpages.org/tei.html

     176.http://www.tei-c.org/P4X/index.html

     177.http://www.tei-c.org/Sample_Manuals/mueller-index.htm

     178.http://www.etext.leeds.ac.uk/cocoon/epb/lect/tei.xml

     179.http://etext.lib.virginia.edu/standards/tei/uvatei.html

     180.http://en.wikipedia.org/wiki/Tex

     181.http://en.wikipedia.org/wiki/LaTeX

     182.http://www.tug.org/texlive/

     183.http://miktex.org/

     184.http://en.wikipedia.org/wiki/Pdf

     185.http://www.tug.org/applications/pdftex/

     186.http://www.adobe.com/products/acrobat/readstep2.html

     187.http://www.gnome.org/projects/evince/

     188.http://www.foolabs.com/xpdf/

     189.http://en.wikipedia.org/wiki/Structured_Query_Language

     190.http://www.postgresql.org/

     191.http://en.wikipedia.org/wiki/Postgresql

     192.http://www.postgresql.org/docs/

     193.http://www.postgresql.org/docs/current/static/

     194.http://www.sai.msu.su/~megera/wiki/tsearch2slides

     195.http://archives.postgresql.org/pgsql-hackers/2006-04/msg00960.php

     196.http://pgfoundry.org/projects/pgestraier/

    http://pgestraier.projects.postgresql.org/

     197.http://www.sqlite.org/

     198.http://en.wikipedia.org/wiki/Sqlite

     199.http://www.sqlite.org/docs.html

     200.http://couchdb.apache.org

     201.http://books.couchdb.org

     202.http://on-ruby.blogspot.com/2008/12/author-interview-relax-with-couchdb.html

     203.http://en.wikipedia.org/wiki/CouchDB

     204.http://en.wikipedia.org/wiki/Json

     205.http://estraier.sourceforge.net/

     206.http://hyperestraier.sourceforge.net/

     207.http://lucene.apache.org/java/docs/

     208.http://ferret.davebalmain.com/trac/

     209.http://ferret.davebalmain.com/api/

     210.http://qdbm.sourceforge.net/

     211.http://qdbm.sourceforge.net/rbspex.html

     212.http://www.zedshaw.com/projects/ruby_odeum/

     213.http://en.wikipedia.org/wiki/Unicode

     214.http://en.wikipedia.org/wiki/UTF-8

     215.http://www.visual-literacy.org/periodic_table/periodic_table.html

     216.http://prefuse.org/

     217.http://processing.org/

     218.http://en.wikipedia.org/wiki/Topic_maps

     219.http://www.techquila.com/tm4j.html

     220.http://en.wikipedia.org/wiki/Dublin_core

     221.http://www.loc.gov/standards/mets/

     222.http://xml.coverpages.org/mets.html

     223.http://www.loc.gov/standards/mets/METSOverview.v2.html

     224.http://www.openarchives.org/OAI/openarchivesprotocol.html

     225.http://en.wikipedia.org/wiki/OAI-PMH

     226.http://www.openarchives.org/OAI/2.0/guidelines-static-repository.htm

     227.http://www.openarchives.org/pipermail/oai-implementers/2004-September/001296.html

     228.http://www.openarchives.org/OAI/2.0/guidelines-static-repository.htm

     229.http://www.opensearch.org/Specifications/OpenSearch/1.1

     230.http://www.sitemaps.org/protocol.html

     231.http://en.wikipedia.org/wiki/Sitemap

     232.http://en.wikipedia.org/wiki/Resource_Description_Framework

     233.http://en.wikipedia.org/wiki/RSS_%28file_format%29

     234.http://blogs.law.harvard.edu/tech/rss

     235.http://search.yahoo.com/mrss

     236.http://en.wikipedia.org/wiki/Atom_%28standard%29

     237.http://en.wikipedia.org/wiki/OPML

     238.http://www.ncsa.uiuc.edu/

     239.http://en.wikipedia.org/wiki/National_Center_for_Supercomputing_Applications

     240.http://en.wikipedia.org/wiki/Hierarchical_Data_Format

     241.http://www.vim.org/

     242.http://en.wikipedia.org/wiki/Vim_%28text_editor%29

     243.http://www.gnu.org/software/emacs/emacs.html

     244.http://www.emacswiki.org/cgi-bin/wiki

     245.http://en.wikipedia.org/wiki/Emacs

     246.http://gedit.sourceforge.net/

     247.http://kate.kde.org/

     248.http://www.nedit.org/

     249.http://purepistos.net/diakonos/

     250.http://www.nano-editor.org/

     251.http://sourceforge.net/projects/joe-editor/

     252.http://www.scintilla.org/SciTE.html

     253.http://www.abridgegame.org/darcs/

     254.http://darcs.net/DarcsWiki

     255.http://www.selenic.com/mercurial/wiki/index.cgi

     256.http://www.fsf.org/

     257.http://en.wikipedia.org/wiki/Free_Software_Foundation

     258.http://creativecommons.org/

     259.http://en.wikipedia.org/wiki/Creative_commons

     260.http://www.fsf.org/licensing/licenses/gpl.html

     261.http://www.gnu.org/licenses/gpl.html

     262.http://en.wikipedia.org/wiki/Gpl


    [ document manifest ]
    << previous TOC next >>
    < ^ >





    SiSU


    The Wealth of Networks - How Social Production Transforms Markets and Freedom

    Yochai Benkler

    2006


    Free Culture - How Big Media Uses Technology and the Law to Lock Down Culture and Control Creativity

    Lawrence Lessig

    2004


    CONTENT - Selected Essays on Technology, Creativity, Copyright and the Future of the Future

    Cory Doctorow

    2008


    Free As In Freedom - Richard Stallman's Crusade for Free Software

    Sam Williams

    2002


    Two Bits - The Cultural Significance of Free Software

    Christopher Kelty

    2008


    The Cathedral & the Bazaar - Musings on Linux and Open Source by an Accidental Revolutionary

    Erik S. Raymond

    1999


    Free For All - How Linux and the Free Software Movement Undercut the High Tech Titans

    Peter Wayner

    2002


    Little Brother

    Cory Doctorow

    2008


    Free Software Foundation - FSF