diff options
Diffstat (limited to 'data/doc/sisu/markup-samples/sisu_manual/sisu_description.sst')
| -rw-r--r-- | data/doc/sisu/markup-samples/sisu_manual/sisu_description.sst | 88 |
1 files changed, 43 insertions, 45 deletions
diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_description.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_description.sst index e924c433..9f8c1691 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_description.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_description.sst @@ -1,9 +1,10 @@ -% SiSU 3.0 +% SiSU 2.0 @title: SiSU - SiSU information Structuring Universe / Structured information, Serialized Units :subtitle: Description -@creator: :author: Amissah, Ralph +@creator: + :author: Amissah, Ralph @classify: :type: information @@ -12,7 +13,8 @@ % SiSU.ssm -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 @date: :created: 2002-11-12 @@ -29,22 +31,16 @@ :italics: /Linux|FreeBSD|Dragonfly|Perl|LaTeX|Postgresql|PostgreSQL|Postgres|sqlite|SQL|Reiserfs|PHP|xml|XML|Ion|g?vim|ascii|pdf|xhtml|pdflatex|pgsql|Postscript|texinfo|metadata|metatags|metaverse|rant|rake|YAML|object citation system|ocn|object citation numbering|granular search|Dublin Core|Lex Mercatoria|Project Gutenberg|Slashdot/i @links: - {What does SiSU do? Summary}../SiSU/1.html#summary - {Book Samples and Markup Examples}../SiSU/examples.html - {SiSU Markup Syntax}../sample - {*Citation System* Object Citation Numbering}../SiSU/1.html#citation - {*Granular Search*}../SiSU/1.html#search - {The Chart (pdf)}../diagram/sisu.chart.pdf - {Accompanying Diagrams}../diagram/sisu_provisional_patent_application_diagram_200408.pdf - {Standard}../SiSU/standard.html - {License}../SiSU/license.html - {man pages}../SiSU/3.html#man - {SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - {SiSU @ Freshmeat}http://freshmeat.net/projects/sisu/ - {SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - {SiSU @ Debian}http://packages.qa.debian.org/s/sisu.html - {Download}../SiSU/download.html - {Changelog}../SiSU/changelog.html + { SiSU Homepage }http://www.sisudoc.org/ + { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/ + { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary + { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU :A~? @title @creator @@ -54,7 +50,7 @@ 2~ Outline -SiSU is a flexible document preparation, generation publishing and search system.~{ This information was first placed on the web 12 November 2002; with predating material taken from http://www.jus.uio.no/lm/lm.information/toc.html part of a site started and developed since 1993. See document metadata section http://www.jus.uio.no/sisu/SiSU/metadata.html for information on this version. Dates related to the development of SiSU are mostly contained within the Chronology section of this document, e.g. http://www.jus.uio.no/sisu/sisu_chronology }~ +SiSU is a flexible document preparation, generation publishing and search system.~{ This information was first placed on the web 12 November 2002; with predating material taken from http://www.jus.uio.no/lm/lm.information/toc.html part of a site started and developed since 1993. See document metadata section http://www.jus.uio.no/sisu/SiSU/metadata.html or manifest page http://www.jus.uio.no/sisu/SiSU/sisu_manifest.html for information on this version. Dates related to the development of SiSU may be tracked in the http://www.jus.uio.no/sisu/SiSU/changelog.html or the Git repository http://git.sisudoc.org/?p=code/sisu.git;a=summary some of the more significant events may be contained within the Chronology section of this document http://www.jus.uio.no/sisu/sisu_chronology }~ SiSU ("SiSU information Structuring Universe" or "Structured information, Serialized Units"),~{ also chosen for the meaning of the Finnish term "sisu". }~ is a Unix command line oriented framework for document structuring, publishing and search. Featuring minimalistic markup, multiple standard outputs, a common citation system, and granular search. @@ -90,7 +86,7 @@ For more see the short summary of features provided below. SiSU processes files with minimal tagging to produce various document outputs including html, EPUB, ODF, LaTeX (which is converted to pdf) and if required loads the structured information into an SQL database (PostgreSQL and SQLite have been used for this). SiSU produces an intermediate processing format.~{ This proved to be the easiest way to develop syntax, changes could be made, or alternatives provided for the markup syntax whilst the intermediate markup syntax was largely held constant. There is actually an optional second intermediate markup format in YAML http://www.yaml.org/ }~ -SiSU is used in constructing Lex Mercatoria http://lexmercatoria.org/ or http://www.jus.uio.no/lm/ (one of the oldest law web sites), and considerable thought went into producing output that would be suitable for legal and academic writings (that do not have formulae) given the limitations of html, and publication in a wide variety of "formats", in particular in relation to the convenient and accurate citation of text. However, the construction of Lex Mercatoria uses only a fraction of the features available from SiSU today, /vis/ generation of flat file structures, rather than in addition the building of ("granular") SQL database content, (at an object level with relevant relational tables, and other outputs also available). +SiSU was originally used in constructing Lex Mercatoria http://lexmercatoria.org/ or http://www.jus.uio.no/lm/ (one of the oldest law web sites), and considerable thought went into producing output that would be suitable for legal and academic writings (that do not have formulae) given the limitations of html, and publication in a wide variety of "formats", in particular in relation to the convenient and accurate citation of text. However, the construction of Lex Mercatoria uses only a fraction of the features available from SiSU today, /vis/ generation of flat file structures, rather than in addition the building of ("granular") SQL database content, (at an object level with relevant relational tables, and other outputs also available). 2~ Short summary of features *~summary @@ -192,9 +188,7 @@ One of its strengths is that very small amounts of initial tagging is required f This is a basic markup example: -_* { basic markup example, text file - an international convention }http://www.jus.uio.no/sisu/sample/markup/un_contracts_international_sale_of_goods_convention_1980.sst ~{ http://www.jus.uio.no/sisu/sample/markup/un_contracts_international_sale_of_goods_convention_1980.sst output provided as example in the next section }~ - -_* { view basic markup, as it would be highlighted by vim editor }http://www.jus.uio.no/sisu/sample/syntax/un_contracts_international_sale_of_goods_convention_1980.sst.html ~{ http://www.jus.uio.no/sisu/sample/syntax/un_contracts_international_sale_of_goods_convention_1980.sst.html as it would appear with syntax highlighting (by vim) }~ +_* { basic markup example, text file - an international convention }http://www.jus.uio.no/sisu/src/un_contracts_international_sale_of_goods_convention_1980.sst ~{ http://www.jus.uio.no/sisu/src/un_contracts_international_sale_of_goods_convention_1980.sst output provided as example in the next section }~ Emphasis has been on simplicity and minimalism in markup requirements. Design philosophy is to try keep the amount of markup required low, for whatever has been determined to be acceptable output.~{ seems there are several "smart ASCIIs" available, primarily for ascii to html conversion, that make this, and reasonable looking ascii their goal<br /> http://webseitz.fluxent.com/wiki/SmartAscii <br> http://daringfireball.net/projects/markdown/ <br> http://www.textism.com/tools/textile/ }~ @@ -206,25 +200,29 @@ For each document, there is only one (input, minimalistically marked up) file fr Eg. the markup example: -_* {~^ original text file - an international convention }http://www.jus.uio.no/sisu/sample/markup/un_contracts_international_sale_of_goods_convention_1980.sst - -_* {~^ view as syntax would be highlighted by vim editor }http://www.jus.uio.no/sisu/sample/syntax/un_contracts_international_sale_of_goods_convention_1980.sst.html +_* {~^ original text file - an international convention }http://www.jus.uio.no/sisu/src/un_contracts_international_sale_of_goods_convention_1980.sst Produces the following output: +_* {~^ Manifest of output presentations generated }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/sisu_manifest.html + _* {~^ Segmented html version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/toc.html _* {~^ Full length html document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/doc.html -_* {~^ pdf landscape version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/landscape.pdf +_* {~^ EPUB version of document }http://www.jus.uio.no/sisu/epub/un_contracts_international_sale_of_goods_convention_1980.epub -_* {~^ pdf portrait version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/portrait.pdf +_* {~^ pdf landscape version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/landscape.letter.pdf -_* {~^ clean tex ascii version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/plain.txt +_* {~^ pdf portrait version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/portrait.letter.pdf -_* {~^ /xml/ sax version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/sax.xml +_* {~^ odt open document format text version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/opendocument.odt -_* {~^ /xml/ dom version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/dom.xml +_* {~^ xml sax version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/sax.xml + +_* {~^ xml dom version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/dom.xml + +_* {~^ clean tex ascii version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/plain.txt _* {~^ Concordance }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/concordance.html @@ -232,7 +230,7 @@ _* {~^ Concordance }http://www.jus.uio.no/sisu/un_contracts_international_sale_o 3~ Syntax relatively easy to read and remember -Syntax is kept simple and mnemonic.~{ SiSU markup syntax, an incomplete summary: http://www.jus.uio.no/sisu/sisu_markup_table/doc.html#h200306 <br>Visual check of elementary font face modifiers: *bold* *{bold}* !{emphasis}! /{italics}/ _{underscore}_ -{strikethrough}- ^{superscript}^ ,{subscript}, }~ +Syntax is kept simple and mnemonic.~{ SiSU markup syntax, an incomplete summary: http://www.jus.uio.no/sisu/sisu_markup/toc.html <br>Visual check of elementary font face modifiers: *bold* *{bold}* !{emphasis}! /{italics}/ _{underscore}_ -{strikethrough}- ^{superscript}^ ,{subscript}, }~ 3~ Kept simple by having a limited publishing feature set, and features identified as most important, are available across several document types @@ -282,7 +280,7 @@ SiSU is able to use meta tags based on the Dublin Core~{ http://dublincore.org/ This provides the means of providing semantic information about a document, both as computer processable meta-tags, and as human readable information that may be of value for classification purposes. -This information is provided both in html metatags, and (where available) under the section titled "Document Information - MetaData", near the end of a document, for example in the segmented html version of this text at: http://www.jus.uio.no/sisu/SiSU/metadata.html +This information is provided both in html metatags, and (where available) under the section titled "Document Information - Metadata", near the end of a document, for example in the segmented html version of this text at: http://www.jus.uio.no/sisu/SiSU/metadata.html 2~ Easy directory management @@ -371,7 +369,7 @@ Most documents are produced in single and segmented html versions, described bel !_ The Scroll (full length text presentations) -The full length of the text in a single scrollable document.~{ CISG http://www.jus.uio.no/lm/un_contracts_international_sale_of_goods_convention_1980/doc <br> The Unidroit Contract Principles http://www.jus.uio.no/lm/unidroit.contract.principles.1994/doc or <br> The Autonomous Contract http://www.jus.uio.no/lm/autonomous.contract.2000.amissah/doc }~ As a rule the files they are saved in are named: /doc/ or more precisely /{doc.html}/ +The full length of the text in a single scrollable document.~{ CISG http://www.jus.uio.no/lm/un.contracts.international.sale.of.goods.convention.1980/doc.html <br> The Unidroit Contract Principles http://www.jus.uio.no/lm/unidroit.contract.principles.1994/doc.html or <br> The Autonomous Contract http://www.jus.uio.no/lm/autonomous.contract.2000.amissah/doc.html }~ As a rule the files they are saved in are named: /doc/ or more precisely /{doc.html}/ For various reasons texts may only be provided in this form (such as this one which is short), though most are also provided as segmented texts. @@ -379,7 +377,7 @@ For various reasons texts may only be provided in this form (such as this one wh !_ The Segmented Text -The text divided into segments (such as articles or chapters depending on the text)~{ CISG http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980 <br>The Unidroit Principles http://www.jus.uio.no/lm/unidroit.contract.principles.1994 <br> The Autonomous Contract http://www.jus.uio.no/sisu/the.autonomous.contract.2000.amissah or <br> WTA 1994 http://www.jus.uio.no/lm/wta.1994 }~ As a rule the files they are saved in are named: /toc/ and /index/ or more precisely /{toc.html}/ and /{index.html}/ +The text divided into segments (such as articles or chapters depending on the text)~{ CISG http://www.jus.uio.no/lm/un.contracts.international.sale.of.goods.convention.1980/toc.html <br>The Unidroit Principles http://www.jus.uio.no/lm/unidroit.contract.principles.1994/toc.html <br> The Autonomous Contract http://www.jus.uio.no/lm/autonomous.contract.2000.amissah/toc.html or <br> WTA 1994 http://www.jus.uio.no/lm/wta.1994 }~ As a rule the files they are saved in are named: /toc/ and /index/ or more precisely /{toc.html}/ and /{index.html}/ If you know exactly what you are looking for, loading a segment of text is faster (the segments being smaller). Occasionally longer documents such as the WTA 1994 http://www.jus.uio.no/lm/wta.1994/toc are only provided in segmented form. @@ -488,25 +486,25 @@ SiSU can provide information on which documents are matched and at what location A few canned searches, showing object numbers. Search for: -{ English documents matching Linux OR Debian }http://search.sisudoc.org?s1=Linux%2BOR%2BDebian&lang=En&db=SiSU_sisu&view=index&a=1 +{ English documents matching Linux OR Debian }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=Linux%2BOR%2BDebian&db=SiSUv2c_sisu&view=index -{ GPL OR Richard Stallman }http://search.sisudoc.org?s1=GPL%2BOR%2BRichard%2BStallman&lang=En&db=SiSU_sisu&view=index&a=1 +{ GPL OR Stallman }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=GPL%2BOR%2BStallman&db=SiSUv2c_sisu&view=index -{ invention OR innovation in English language }http://search.sisudoc.org?s1=invention%2BOR%2Binnovation&lang=En&db=SiSU_sisu&view=index&a=1 +{ invention OR innovation }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=invention%2BOR%2Binnovation&db=SiSUv2c_sisu&view=index -{ copyright in English language documents }http://search.sisudoc.org?s1=copyright&lang=En&db=SiSU_sisu&view=index&a=1 +{ copyright in English language documents }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=copyright&db=SiSUv2c_sisu&view=index Note that the searches done in this form are case sensitive. Expand those same searches, showing the matching text in each document: -{ English documents matching Linux OR Debian }http://search.sisudoc.org?s1=Linux%2BOR%2BDebian&lang=En&db=SiSU_sisu&view=text&a=1 +{ English documents matching Linux OR Debian }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=Linux%2BOR%2BDebian&db=SiSUv2c_sisu&view=text -{ GPL OR Richard Stallman }http://search.sisudoc.org?s1=GPL%2BOR%2BRichard%2BStallman&lang=En&db=SiSU_sisu&view=text&a=1 +{ GPL OR Stallman }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=GPL%2BOR%2BStallman&db=SiSUv2c_sisu&view=text -{ invention OR innovation in English language }http://search.sisudoc.org?s1=invention%2BOR%2Binnovation&lang=En&db=SiSU_sisu&view=text&a=1 +{ invention OR innovation }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=invention%2BOR%2Binnovation&db=SiSUv2c_sisu&view=text -{ copyright in English language documents }http://search.sisudoc.org?s1=copyright&lang=En&db=SiSU_sisu&view=text&a=1 +{ copyright }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=copyright&db=SiSUv2c_sisu&view=text Note you may set results either for documents matched and object number locations within each matched document meeting the search criteria; or display the names of the documents matched along with the objects (paragraphs) that meet the search criteria.~{ of this feature when demonstrated to an IBM software innovations evaluator in 2004 he said to paraphrase: this could be of interest to us. We have large document management systems, you can search hundreds of thousands of documents and we can tell you which documents meet your search criteria, but there is no way we can tell you without opening each document where within each your matches are found. }~ @@ -554,7 +552,7 @@ Several backup tools exist. At the base level I tend to use rdiff. SiSU documents are prepared / marked up in utf-8 text _{you are free to use the text editor of your choice.}_ -Syntax highlighting for a number of editors are provided. Amongst them Vim, Kwrite, Kate, Gedit and diakonos. These may be found with configuration instructions at http://www.jus.uio.no/sisu/syntax_highlight. {~^ Vim }http://www.vim.org/ as of version 7 has built in sytax highlighting for SiSU. +Syntax highlighting for a number of editors are provided. Amongst them Vim, Kwrite, Kate, Gedit and diakonos. These may be found with configuration instructions at http://www.sisudoc.org/sisu/sisu_syntax_highlighting/doc.html {~^ Vim }http://www.vim.org/ as of version 7 has built in sytax highlighting for SiSU. 2~ Modular design, need something new add a module |