|
|
|
|
|
|
|
|
|
|
|
|
SiSU - Manual,
Ralph Amissah
What is SiSU?
1. Introduction - What is SiSU?
2. How does sisu work?
3. Summary of features
4. Help
4.1 SiSU Manual
4.2 SiSU man pages
4.3 SiSU built-in interactive help
5. Commands Summary
5.1 Description
5.2 Document Processing Command Flags
6. command line modifiers
7. database commands
8. Shortcuts, Shorthand for multiple flags
8.1 Command Line with Flags - Batch Processing
9. Introduction to SiSU Markup 10
9.1 Summary
9.2 Markup Examples
9.2.1 Online
9.2.2 Installed
10. Markup of Headers
10.1 Sample Header
10.2 Available Headers
11. Markup of Substantive Text
11.1 Heading Levels
11.2 Font Attributes
11.3 Indentation and bullets
11.4 Footnotes / Endnotes
11.5 Links
11.5.1 Naked URLs within text, dealing with urls
11.5.2 Linking Text
11.5.3 Linking Images
11.6 Grouped Text
11.6.1 Tables
11.6.2 Poem
11.6.3 Group
11.6.4 Code
11.7 Book index
12. Composite documents markup
Markup Syntax History
13. Notes related to Files-types and Markup Syntax
14. SiSU filetypes
14.1 .sst .ssm .ssi marked up plain text
14.1.1 sisu text - regular files (.sst)
14.1.2 sisu master files (.ssm)
14.1.3 sisu insert files (.ssi)
14.2 sisupod, zipped binary container (sisupod.zip, .ssp)
15. Experimental Alternative Input Representations
15.1 Alternative XML
15.1.1 XML SAX representation
15.1.2 XML DOM representation
15.1.3 XML Node representation
16. Configuration
16.1 Determining the Current Configuration
16.2 Configuration files (config.yml)
17. Skins
17.1 Document Skin
17.2 Directory Skin
17.3 Site Skin
17.4 Sample Skins
18. CSS - Cascading Style Sheets (for html, XHTML and XML)
19. Organising Content
19.1 Directory Structure and Mapping
19.1.1 General Directories
19.1.2 Remote Directories
19.1.3 Sisupod
19.2 Organising Content
20. Homepages
20.1 Home page and other custom built pages in a sub-directory
20.2 Home page within a skin
21. Markup and Output Examples
21.1 Markup examples
21.2 A few book (and other) examples
21.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"
21.3 SQL - PostgreSQL, SQLite
21.4 Lex Mercatoria as an example
21.5 For good measure the markup for a document with lots of (simple) tables
21.6 And a link to the output of a reported case
22. A Checklist of Output Features
23. SiSU Search - Introduction
24. SQL
24.1 populating SQL type databases
25. Postgresql
25.1 Name
25.2 Description
25.3 Synopsis
25.4 Commands
25.4.1 create and destroy database
25.4.2 import and remove documents
26. Sqlite
26.1 Name
26.2 Description
26.3 Synopsis
26.4 Commands
26.4.1 create and destroy database
26.4.2 import and remove documents
27. Introduction
27.1 Search - database frontend sample, utilising database and SiSU features, including object citation numbering (backend currently PostgreSQL)
27.2 Search Form
28. Hyperestraier
29. sisu_webrick
29.1 Name
29.2 Synopsis
29.3 Description
29.4 Summary of man page
29.5 Document processing command flags
29.6 Further information
29.7 Author
29.8 SEE ALSO
30. Remote Source Documents
Remote Document Output
31. Remote Output
31.1 commands
31.2 configuration
32. Remote Servers
Download information
33. Download SiSU - Linux/Unix
SiSU Current Version - Linux/Unix
Source (tarball tar.gz)
Git (source control management)
Debian
RPM
Installation
34. Installation
34.1 Debian
34.2 Other Unix / Linux
34.2.1 source tarball
35. SiSU Components, Dependencies and Notes
35.1 sisu
35.2 sisu-complete
35.3 sisu-examples
35.4 sisu-pdf
35.5 sisu-postgresql
35.6 sisu-remote
35.7 sisu-sqlite
36. Quickstart - Getting Started Howto
36.1 Installation
36.1.1 Debian Installation
36.1.2 RPM Installation
36.1.3 Installation from source
36.2 Testing SiSU, generating output
36.2.1 basic text, plaintext, html, XML, ODF, EPUB
36.2.2 LaTeX / pdf
36.2.3 relational database - postgresql, sqlite
36.3 Getting Help
36.3.1 The man pages
36.3.2 Built in help
36.3.3 The home page
36.4 Markup Samples
HowTo
37. Getting Help
37.1 SiSU "man" pages
37.2 SiSU built-in help
37.3 Command Line with Flags - Batch Processing
38. Setup, initialisation
38.1 initialise output directory
38.1.1 Use of search functionality, an example using sqlite
38.2 misc
38.2.1 url for output files -u -U
38.2.2 toggle screen color
38.2.3 verbose mode
38.2.4 quiet mode
38.2.5 maintenance mode intermediate files kept -M
38.2.6 start the webrick server
38.3 remote placement of output
39. Configuration Files
40. Markup
40.1 Headers
40.2 Font Face
40.2.1 Bold
40.2.2 Italics
40.2.3 Underscore
40.2.4 Strikethrough
40.3 Endnotes
40.4 Links
40.5 Number Titles
40.6 Line operations
40.7 Tables
40.8 Grouped Text
40.9 Composite Document
41. Change Appearance
41.1 Skins
41.2 CSS
Extracts from the README
42. README
42.1 Online Information, places to look
42.2 Installation
42.2.1 Debian
42.2.2 RPM
42.2.3 Source package .tgz
42.2.4 to use setup.rb
42.2.5 to use install (prapared with "Rake")
42.2.6 to use install (prapared with "Rant")
42.3 Dependencies
42.4 Quick start
42.5 Configuration files
42.6 Use General Overview
42.7 Help
42.8 Directory Structure
42.9 Configuration File
42.10 Markup
42.11 Additional Things
42.12 License
42.13 SiSU Standard
Extracts from man 8 sisu
43. Post Installation Setup
43.1 Post Installation Setup - Quick start
43.2 Document markup directory
43.2.1 Configuration files
43.2.2 Debian INSTALLATION Note
43.2.3 Document Resource Configuration
43.2.4 Skins
44. FAQ - Frequently Asked/Answered Questions
44.1 Why are urls produced with the -v (and -u) flag that point to a web server on port 8081 ?
44.2 I cannot find my output, where is it?
44.3 I do not get any pdf output, why?
44.4 Where is the latex (or some other interim) output?
44.5 Why isn't SiSU markup XML
44.6 LaTeX claims to be a document preparation system for high-quality typesetting. Can the same be said about SiSU?
44.7 Can the SiSU markup be used to prepare for a LaTex automatic building of an index to the work?
44.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?
44.9 How do I create GIN or GiST index in Postgresql for use in SiSU
44.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?
44.12 Where is version 1?
44.13 What is the difference between version 1 and 2?
45. Who might be interested in the SiSU feature set?
46. Work Needed
47. Wishlist
48. Editor Files, Syntax Highlighting
49. Help Sources
49.1 man pages
49.2 sisu generated output - links to html
49.2.1 www.sisudoc.org
49.3 man2html
49.3.1 locally installed
49.3.2 www.jus.uio.no/sisu
Endnotes
Endnotes
Metadata
SiSU Metadata, document information
Manifest
SiSU Manifest, alternative outputs etc.
SiSU - Manual,
What is SiSU?
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):
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, 68 Everyday GIT With 20 Commands Or So, 69 A tutorial introduction to git, 70 A tutorial introduction to git: part two 71
User contributed texts: The Git Community Book, 72 Git Magic, 73 Git From the Bottom Up (pdf) 74
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_3.0.4-1_all.deb 78
sisu-complete_3.0.4-1_all.deb 79
sisu-pdf_3.0.4-1_all.deb 80
sisu-postgresql_3.0.4-1_all.deb 81
sisu-sqlite_3.0.4-1_all.deb 82
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. 85 Dependencies are not handled, not even that of the essential Ruby. In the Howto section see the note on installing SiSU on Fedora 12 (2010-01-12).
sudo rpm -i [package name]
For changelogs see:
65. ‹http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.4.orig.tar.gz›
145c409526b26cb0a14b43f4c46219fb828dc41c8211d8f77bad486a98300678 1920526
66. ‹http://www.jus.uio.no/sisu/pkg/src/sisu-markup-samples_3.0.0.orig.tar.gz›
999f3cc572d0558a6af4539db0c51691dcff3371d4f92e096cbf5835806aeed4 8446814
67. 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›
68. ‹http://www.kernel.org/pub/software/scm/git/docs/user-manual.html›
69. ‹http://www.kernel.org/pub/software/scm/git/docs/everyday.html›
70. ‹http://www.kernel.org/pub/software/scm/git/docs/v1.4.4.4/tutorial.html›
71. ‹http://www.kernel.org/pub/software/scm/git/docs/v1.4.4.4/tutorial-2.html›
72. ‹http://book.git-scm.com/index.html›
73. ‹http://www-cs-students.stanford.edu/~blynn/gitmagic/›
74. ‹http://www.newartisans.com/blog_assets/git.from.bottom.up.pdf›
75. ‹http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.4.orig.tar.gz›
76. ‹http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.4-1.diff.gz›
77. ‹http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.4-1.dsc›
4886196e536e3ad48b29d27b1f0664f77b58ee4b4b21e41c0351c6b3a33dd156 1216
78. ‹http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu_3.0.4-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
79. ‹http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu-complete_3.0.4-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
80. ‹http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu-pdf_3.0.4-1_all.deb›
dependencies used by sisu to produce pdf from LaTeX generated
Depends: sisu, tetex-bin, tetex-extra, latex-ucs
Suggests: evince, xpdf
81. ‹http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu-postgresql_3.0.4-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
82. ‹http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu-sqlite_3.0.4-1_all.deb›
dependencies used by sisu to populate sqlite database
Depends: sisu, sqlite, libdbi-ruby, libdbm-ruby, libdbd-sqlite-ruby
Suggests: libdbd-sqlite
83. ‹http://www.jus.uio.no/sisu/archive/pool/non-free/s/sisu-markup-samples/sisu-markup-samples_3.0.0-1_all.deb›
marked up documents and other examples related to sisu, a larger package containing a number of texts
Depends: sisu
84. ‹http://www.jus.uio.no/sisu/pkg/src/sisu-markup-samples_3.0.0-1.dsc›
7d9d434c74a1e96da3732e420d483466d7ca1266d4e6fba4bf7f21b9e3f73aad 1307 sisu-markup-samples_3.0.0-1.dsc
85. ‹http://www.kitenet.net/programs/alien/›
86. ‹http://www.jus.uio.no/sisu/pkg/rpm/sisu-1.0.3-2.noarch.rpm›
*
created using alien
87. ‹http://www.jus.uio.no/sisu/pkg/rpm/sisu-markup-samples_2.0.3.orig-2.noarch.rpm›
***
created using: alien -r sisu_1.0.3-1_all.deb