|
|
|
|
|
|
|
|
|
|
|
|
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?
4.1 SiSU Manual
4.2 SiSU man pages
4.3 SiSU built-in interactive help
The most up to date information on sisu should be contained in the sisu_manual, available at:
The manual can be generated from source, found respectively, either within the SiSU tarball or installed locally at:
./data/doc/sisu/markup-samples/sisu_manual
/usr/share/doc/sisu/markup-samples/sisu_manual
move to the respective directory and type e.g.:
sisu sisu_manual.ssm
If SiSU is installed on your system usual man commands should be available, try:
man sisu
Most SiSU man pages are generated directly from sisu documents that are used to prepare the sisu manual, the sources files for which are located within the SiSU tarball at:
./data/doc/sisu/markup-samples/sisu_manual
Once installed, directory equivalent to:
/usr/share/doc/sisu/markup-samples/sisu_manual
Available man pages are converted back to html using man2html:
/usr/share/doc/sisu/html/
./data/doc/sisu/html
An online version of the sisu man page is available here:
This is particularly useful for getting the current sisu setup/environment information:
sisu --help
sisu --help [subject]
sisu --help commands
sisu --help markup
sisu --help env [for feedback on the way your system is setup with regard to sisu]
sisu -V [environment information, same as above command]
sisu (on its own provides version and some help information)
Apart from real-time information on your current configuration the SiSU manual and man pages are likely to contain more up-to-date information than the sisu interactive help (for example on commands and markup).
NOTE: Running the command sisu (alone without any flags, filenames or wildcards) brings up the interactive help, as does any sisu command that is not recognised. Enter to escape.