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.

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]

Post Filing Appendix

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

On 17th June 2005, the anniversary of my meeting with IBM,   1589  an interesting event, which led to a chain of other interesting events, I posted this copy of my abandoned U.S. provisional patent application   1590 

My reasons for abandoning it may be summarised as follows:

1. I have serious reservations about software patents, and the conflict between their claimed intended purpose (encourage invention) and what they actually do, or are used to do (hinder, slow down innovation).

a. After having used Gnu/Linux for several years, (and this experience in relation to software patents), my conclusion on Software Patents and their effect on software innovation, software quality and reliability, is that they are problematic and do more to hinder than to promote innovation.

b. More software innovation and software diversity occurs in the space that exists without them, and the software that results is frequently more reliable and of higher quality. The GPL ultimately secures this space for software.

2. I also had problems with my starting the patent process so late in the development of SiSU. Had I intended to go this route, I should have started the process several years ago.

a. SiSU is based on ideas that date back to my time at the University of Tromsø.  1591  Indeed with the basic idea, I went about equipping myself with the best tools I could find to implement it.  1592 

b. The question of publication was in issue. I was always open about what I was trying to do: I gave presentations of SiSU from the start (though it had not yet been named) to whoever was interested, and at a couple of convenentions; I published the first versions of this web page on the subject in November 2002 describing SiSU in considerable detail, and; prior to that there were notes on the website lexmercatoria,  1593  and; the output of lexmercatoria gave some indication of what SiSU was trying to achieve. I took the ultimate step in publishing SiSU _sauce_ on January 4th, 2005 when the source code for SiSU was placed to the Net and announced on ruby-talk.

3. The cost of acquiring a Patent is high (tens of thousands of US dollars),  1594  and the cost of defending a Patent, should it be violated is prohibitive (hundreds of thousands of US dollars). There is a high threshold of entry into the Patent game. Patents are primarily for large players, or those that can afford to play, and/or wish to sell to larger players.

Why then did I start the process in the first place? A good question. The short answer would be, to give myself time to think.  1595 

A longer answer. After the meeting with the IBM software innovations evaluator,  1596  it was indicated that this idea could be of value to them.  1597  He also indicated that to be prepared to pay anything substantial for this technology coming from me, there would have to be a patent, otherwise they would prefer to prepare their in-house equivalent, and they would not mind employing the number of coders it took for the time it took, he explained that this was their way. This led to interesting discussions on the subject of Software Patents. He thought they might actually prefer to (have to) pay a substantial amount for such a Patent, because it gave control over the technology, i.e. they could prevent competitors from doing the same. The choice for me it seemed was between much or little, and I needed time to think. The provisional patent approach cost least and gave me a year within which to file for the Patent... but I had all the reservations about Software Patents mentioned previously.

Taking the first step on the road to procuring a Patent, resulted in some interesting thinking and correspondence. One idea was an "FSF Patent" Trust

The idea was to acquire a Patent and to grant free use of it, with the scope of free use defined as use compatible with the GPL   1598  so for all Free Software Foundation   1599  approved software licenses, and "guaranteed" by some form of trust that was held by an independent third party institution. The beneficiary in the event that the software was licensed for non-free use would be the inventor. It remains of academic (intellectual and legal) interest, whether and how such a device could have been made to work.

The potential offered by the ideas behind SiSU are interesting. The Patent would have gone for the jugular, as patents seek to do, covering a wide range of potential application, based at heart on a simple but essential idea.

SiSU is available for download and use on the Gnu/Linux and Unix operating systems under the terms of the GPL   1600  (with the possibility of an alternative license for developers unable to use the GPL. (this dual license, being what I would have sought to be able to control more effectively through a Patent held in trust).

...




 1589.http://www.jus.uio.no/sisu/SiSU/2004#ibm

 1590.

Filed August 17, 2004, Application Number 60/602,290, Filing Recept OC00000001 37841 68 [this is a late version of the document filed, verify that it is the same]

 1591. Rudimentary implementations have existed for as long, and have been used in the building of the web site lexmercatoria aka. Ananse, the International Trade Law Project and the International Trade Law Monitor; and major parts of the implementation have been complete since 2002, ‹http://www.jus.uio.no/sisu/diagram/sisu.chart

 1592. ending up with a work environment based on debian/gnu/linux or unix, ruby, postgresql, vim, zsh, screen, ion etc. (plus broadband and a laptop with a high resolution monitor)

 1593. aka. Ananse, the International Trade Law Project and the International Trade Law Monitor.

 1594. and I had the benefit of a friend as attorney who worked pro bono

 1595. Filing a provisional patent application gave a year in which to decide whether to proceed with the patent process.

 1596.http://www.jus.uio.no/sisu/SiSU/2004#ibm› shared sovenir email.

 1597. They had existing document management systems which he thought could benefit from the logic in the code demonstrated. In particular, they were interested in the document search possibilities, as their product was only able to return information on the documents which matched the search criterion.

SiSU when used with a database provides this at a "paragraph" (text or other object) level, and will return the documents matched together with the locations within each document of the match, or the documents matched together with the objects in which the match was found.

 1598.http://www.gnu.org/copyleft/gpl.html

 1599.http://www.fsf.org/

 1600.http://www.gnu.org/copyleft/gpl.html


[ 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