toc
scroll
pdf
odt
|
|
|
|
|
|
|
|
|
|
|
|
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 XML
1.15.3 ODT:ODF, Open Document Format - ISO/IEC 26300:2006
1.15.4 PDF - portrait and landscape, (through the generation of LaTeX output which is then transformed to pdf)
1.15.5 Search - loading/populating of relational database while retaining document structure information, object citation numbering and other features (currently PostgreSQL and/or SQLite)
1.15.6 Search - database frontend sample, utilising database and SiSU features, including object citation numbering (backend currently PostgreSQL)
1.15.7 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
"The Wealth of Networks", Yochai Benkler
"Two Bits", Christopher Kelty
"Free Culture", Lawrence Lessig
"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
"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
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 Synopsis
9.2 Description
9.3 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
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
FAQ, Howto, Installation, etc.
HowTo
34. Getting Help
34.1 SiSU "man" pages
34.2 SiSU built-in help
34.3 Command Line with Flags - Batch Processing
35. Setup, initialisation
35.1 initialise output directory
35.1.1 Use of search functionality, an example using sqlite
35.2 misc
35.2.1 url for output files -u -U
35.2.2 toggle screen color
35.2.3 verbose mode
35.2.4 quiet mode
35.2.5 maintenance mode intermediate files kept -M
35.2.6 start the webrick server
35.3 remote placement of output
36. Configuration Files
37. Markup
37.1 Headers
37.2 Font Face
37.2.1 Bold
37.2.2 Italics
37.2.3 Underscore
37.2.4 Strikethrough
37.3 Endnotes
37.4 Links
37.5 Number Titles
37.6 Line operations
37.7 Tables
37.8 Grouped Text
37.9 Composite Document
38. Change Appearance
38.1 Skins
38.2 CSS
Extracts from the README
39. README
39.1 Online Information, places to look
39.2 Installation
39.2.1 Debian
39.2.2 RPM
39.2.3 Source package .tgz
39.2.4 to use setup.rb
39.2.5 to use install (prapared with "Rake")
39.2.6 to use install (prapared with "Rant")
39.3 Dependencies
39.4 Quick start
39.5 Configuration files
39.6 Use General Overview
39.7 Help
39.8 Directory Structure
39.9 Configuration File
39.10 Markup
39.11 Additional Things
39.12 License
39.13 SiSU Standard
Extracts from man 8 sisu
40. Post Installation Setup
40.1 Post Installation Setup - Quick start
40.2 Document markup directory
40.2.1 Configuration files
40.2.2 Debian INSTALLATION Note
40.2.3 Document Resource Configuration
40.2.4 Skins
41. FAQ - Frequently Asked/Answered Questions
41.1 Why are urls produced with the -v (and -u) flag that point to a web server on port 8081?
41.2 I cannot find my output, where is it?
41.3 I do not get any pdf output, why?
41.4 Where is the latex (or some other interim) output?
41.5 Why isn't SiSU markup XML
41.6 LaTeX claims to be a document preparation system for high-quality typesetting. Can the same be said about SiSU?
41.7 Can the SiSU markup be used to prepare for a LaTex automatic building of an index to the work?
41.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?
41.9 How do I create GIN or GiST index in Postgresql for use in SiSU
41.10 Are there some examples of using Ferret Search with a SiSU repository?
41.11 Have you had any reports of building SiSU from tar on Mac OS 10.4?
41.12 Where is version 1.0?
Installation
42. Installation
42.1 Debian
42.2 Other Unix / Linux
42.2.1 source tarball
43. SiSU Components, Dependencies and Notes
43.1 sisu
43.2 sisu-complete
43.3 sisu-examples
43.4 sisu-pdf
43.5 sisu-postgresql
43.6 sisu-remote
43.7 sisu-sqlite
44. Quickstart - Getting Started Howto
44.1 Installation
44.1.1 Debian Installation
44.1.2 RPM Installation
44.1.3 Installation from source
44.2 Testing SiSU, generating output
44.2.1 basic text, plaintext, html, XML, ODF
44.2.2 LaTeX / pdf
44.2.3 relational database - postgresql, sqlite
44.3 Getting Help
44.3.1 The man pages
44.3.2 Built in help
44.3.3 The home page
44.4 Markup Samples
45. SiSU Components, Dependencies and Notes
46. 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
47. License
48. Things SiSU Standard
Download information
Download information
49. Download SiSU - Linux/Unix
SiSU Current Version - Linux/Unix
Source (tarball tar.gz)
Git (source control management)
Debian
RPM
Changelog - sisu
50. SiSU Version Manifest / changelog
Current version
0.70
Previous versions
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
51. Version Manifest / changelog - SiSU Markup Samples
Current version
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
1. Background
2. Definitions
3. Brief Descriptions of the Drawings
4. Detailed Description of the Preferred Embodiments
5. Document Processing, examples of subsequent steps
6. Advantages of the Invention
7. THE CLAIMS
Post Filing Appendix
52. Post Filing Appendix: Reasons for Abandonment of Patent Process Claim
Endnotes
Concordance (wordlist)
Manifest (alternative outputs)
Metadata
SiSU - SiSU information Structuring Universe
Structured information, Serialized Units
Ralph Amissah
copy @ SiSU
SiSU - SiSU information Structuring Universe - Structured information, Serialized Units,
Structured information, Serialized Units
Download information
SiSU Current Version - Linux/Unix
Source (tarball tar.gz)
Git (source control management)
Debian
RPM
Download the latest version of SiSU (and SiSU markup samples): 968
For installation notes see <http://sisudoc.org/sisu/sisu_manual/installation.html>
For more general use see <http://sisudoc.org/sisu/sisu_manual>
For changelogs see <http://www.jus.uio.no/sisu/SiSU/changelog.html>
Git repository currently at:
On using git, see
Git documentation: Git User's Manual, 972 Everyday GIT With 20 Commands Or So, 973 A tutorial introduction to git, 974 A tutorial introduction to git: part two 975
User contributed texts: The Git Community Book, 976 Git Magic, 977 Git From the Bottom Up (pdf) 978
This section contains information on the latest SiSU release. For installation notes see <http://sisudoc.org/sisu/sisu_manual/installation.html>
SiSU is updated fairly regularly in Debian testing and unstable, and should be available therefrom.
To add this archive, should you still choose to do so, add the following lines to your /etc/apt/sources.list
deb http://www.jus.uio.no/sisu/archive unstable main non-free
deb-src http://www.jus.uio.no/sisu/archive unstable main non-free
Debs
sisu_0.70.5-1_all.deb 982
sisu-complete_0.70.5-1_all.deb 983
sisu-pdf_0.70.5-1_all.deb 984
sisu-postgresql_0.70.5-1_all.deb 985
sisu-sqlite_0.70.5-1_all.deb 986
For changelogs see:
non-free
Book markup samples have been moved to non-free as the substantive text of the documents are available under the author or original publisher's license, and usually do not comply with the Debian Free Software Guidelines.
For changelogs see:
The RPM is generated from the source file using Alien. 989 Dependencies are not handled, not even that of the essential Ruby.
sudo rpm -i [package name]
For changelogs see:
968. Breakage and Fixes Report
<http://www.jus.uio.no/sisu/SiSU/breakage_and_fixes.html>
969. <http://www.jus.uio.no/sisu/pkg/src/sisu_0.70.5.orig.tar.gz>
5ab95108c9f1734fbb6dcca795d6c6e34445625adb296e797d97f0af1e73f985 1546846
970. <http://www.jus.uio.no/sisu/pkg/src/sisu-markup-samples_1.0.10.orig.tar.gz>
1e769b5c2c2d6135c3f5a14ede1d019f77588c7024168c756c7093510145c7dc 3442966
971. Reproduced with the kind permission of author and artist Leena Krohn, <http://www.kaapeli.fi/krohn> Tulva is from the work Sphinx or Robot <http://www.jus.uio.no/sisu/sphinx_or_robot.leena_krohn.1996> other works available online include Tainaron <http://www.jus.uio.no/sisu/tainaron.leena_krohn.1998>, these two works can be found in the book sample section <http://www.jus.uio.no/sisu/SiSU/examples.html#sample>
972. <http://www.kernel.org/pub/software/scm/git/docs/user-manual.html>
973. <http://www.kernel.org/pub/software/scm/git/docs/everyday.html>
974. <http://www.kernel.org/pub/software/scm/git/docs/v1.4.4.4/tutorial.html>
975. <http://www.kernel.org/pub/software/scm/git/docs/v1.4.4.4/tutorial-2.html>
976. <http://book.git-scm.com/index.html>
977. <http://www-cs-students.stanford.edu/~blynn/gitmagic/>
978. <http://www.newartisans.com/blog_assets/git.from.bottom.up.pdf>
979. <http://www.jus.uio.no/sisu/pkg/src/sisu_0.70.5.orig.tar.gz>
980. <http://www.jus.uio.no/sisu/pkg/src/sisu_0.70.5-1.diff.gz>
981. <http://www.jus.uio.no/sisu/pkg/src/sisu_0.70.5-1.dsc>
dc95471b171637fd3cbc9e627283254d1f71b655d1a7c2a24eb904cd4539d790 1151
982. <http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu_0.70.5-1_all.deb>
sisu, the base code, (the main package on which the others depend), without any dependencies other than ruby (and for convenience the ruby webrick web server), this generates a number of types of output on its own, other packages provide additional functionality, and have their dependencies
Depends: ruby (>=1.8.2), libwebrick-ruby
Recommends: sisu-pdf, sisu-sqlite, sisu-postgresql, sisu-examples, vim -sisu, librmagick-ruby, trang, tidy, libtidy, librexml-ruby, zip, unzip, openssl
983. <http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu-complete_0.70.5-1_all.deb>
a package that pulls in other packages to build the whole of sisu (excluding sisu-examples)
Depends: ruby (>=1.8.2), sisu, sisu-pdf, sisu-postgresql, sisu-remote, sisu-sqlite, vim -sisu
Recommends: sisu-examples
984. <http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu-pdf_0.70.5-1_all.deb>
dependencies used by sisu to produce pdf from LaTeX generated
Depends: sisu, tetex-bin, tetex-extra, latex-ucs
Suggests: evince, xpdf
985. <http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu-postgresql_0.70.5-1_all.deb>
dependencies used by sisu to populate postgresql database (further configuration is necessary)
Depends: sisu, postgresql-8.1, libdbi-ruby, libdbm-ruby, libdbd-pg-ruby
Suggests: pgaccess, libdbd-pgsql, postgresql-contrib-8.1
986. <http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu-sqlite_0.70.5-1_all.deb>
dependencies used by sisu to populate sqlite database
Depends: sisu, sqlite , libdbi-ruby, libdbm-ruby, libdbd-sqlite-ruby
Suggests: libdbd-sqlite
987. <http://www.jus.uio.no/sisu/archive/pool/non-free/s/sisu-markup-samples/sisu-markup-samples_1.0.10-1_all.deb>
marked up documents and other examples related to sisu, a larger package containing a number of texts
Depends: sisu
988. <http://www.jus.uio.no/sisu/pkg/src/sisu-markup-samples_1.0.10-1.dsc>
1fd20f69634682feee7d7c2d0fe0e05c493ee83c199bc5370459f6ad9fb606de 1076 sisu-markup-samples_1.0.10-1.dsc
989. <http://www.kitenet.net/programs/alien/>
990. <http://www.jus.uio.no/sisu/pkg/rpm/sisu-0.70.5-2.noarch.rpm>
9c991ebb416a0dd68bf28f29c90f9b910eba5bb2ea51235e84b1d61379195c80
created using alien
991. <http://www.jus.uio.no/sisu/pkg/rpm/sisu-markup-samples_1.0.6.orig-2.noarch.rpm>
1fd20f69634682feee7d7c2d0fe0e05c493ee83c199bc5370459f6ad9fb606de 1076
created using: alien -r sisu_0.70.5-1_all.deb
|
|
Output generated by
SiSU
0.70.5 2009-01-18 (2009w02/7)
|
SiSU using:
|
|
|
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.
|
