Jump to content

SiSU: Difference between revisions

From Wikipedia, the free encyclopedia
Content deleted Content added
"History" is good enough -- doesn't need a modifier
Mikaelbook (talk | contribs)
Shortened the introduction and added section "Usage" with Doctorow-example and two references
Line 12: Line 12:
| website = [http://www.jus.uio.no/sisu www.jus.uio.no/sisu]
| website = [http://www.jus.uio.no/sisu www.jus.uio.no/sisu]
}}
}}
'''SiSU''' ("SiSU information Structuring Universe" or "Structured information, Serialized Units"),<ref>also chosen for the meaning of the [[Finnish language|Finnish]] term "[[sisu]]".</ref> is a [[Unix]] [[command line interface|command line]]-oriented framework for document structuring, publishing and search. Using [[Markup language|markup]] applied to a document, SiSU can produce [[plain text]], [[HTML]], [[XHTML]], [[EPUB]], [[XML]], [[OpenDocument]], [[LaTeX]] or [[Portable Document Format|PDF]] files, and populate an [[SQL]] database with ''objects'' (equating generally to paragraph-sized chunks) so searches may be performed and matches returned with that degree of granularity (e.g. your search criteria are met by these documents and at these locations within each document). Document output formats share a common object numbering system for locating content. This is particularly suitable for "published" works (finalized texts as opposed to works that are frequently changed or updated) for which it provides a fixed means of reference of content.
'''SiSU''' ("SiSU information Structuring Universe" or "Structured information, Serialized Units"),<ref>also chosen for the meaning of the [[Finnish language|Finnish]] term "[[sisu]]".</ref> is a [[Unix]] [[command line interface|command line]]-oriented framework for document structuring, publishing and search.

==Usage==

Using [[Markup language|markup]] applied to a document, or a collection of documents, SiSU can produce [[plain text]], [[HTML]], [[XHTML]], [[EPUB]], [[XML]], [[OpenDocument]], [[LaTeX]] or [[Portable Document Format|PDF]] files, and populate an [[SQL]] database.

* Document structuring

SiSU offers its user a way to structure plain text and to add graphics, hyperlinks, endnotes, footnotes etc. with simple text editing programs such as Notepad (Windows), TextEdit (Mac) or Gedit (GNU/Linux). The markup language is mnemonic and human readable.

To process the the marked up document(s) with SiSU, the user then issues a command via the [[Command-line interface|command-line]] of the computer terminal. The output can be rendered in multiple formats (html, pdf, epub, and others) with one single command.

* Publishing and self-publishing

A document, or a collection of documents, which has been processed by SiSU is technically ready to be published on the web, or printed on paper. Canadian author [[Cory Doctorow]], for instance, has used SiSU as a publishing tool and blogged about it.<ref>{{cite web|url=http://craphound.com/walh/e-book/browse-all-versions|title=Doctorow: With a Little Help|date=2010-10-03|accessdate=2011-08-11|work=Browse all versions}}</ref> In a newspaper article, Doctorow called SiSU an "automated ebook workflow tool".<ref>{{cite web|url=http://www.guardian.co.uk/technology/blog/2010/dec/17/internet-problem-choice-self-publishing|title=The Internet Problem: when an abundance of choice becomes an issue|last=Doctorow|first=Cory}}</ref>

* Search

SiSU can populate an [[SQL]] database with ''objects''(equating generally to paragraph-sized chunks) so searches may be performed and matches returned with that degree of granularity (e.g. your search criteria are met by these documents and at these locations within each document). Document output formats share a common object numbering system for locating content. This is particularly suitable for "published" works (finalized texts as opposed to works that are frequently changed or updated) for which it provides a fixed means of reference of content.


==History==
==History==
Line 22: Line 40:
==Notes and references==
==Notes and references==
<!--See http://en.wikipedia.org/wiki/Wikipedia:Footnotes for an explanation of how to generate footnotes using the <ref(erences/)> tags-->
<!--See http://en.wikipedia.org/wiki/Wikipedia:Footnotes for an explanation of how to generate footnotes using the <ref(erences/)> tags-->

{{Reflist|2}}
{{Reflist|2}}



Revision as of 07:53, 11 August 2011

SiSU
Developer(s)Ralph Amissah
Stable release
2.7.7 / October 17, 2010 (2010-10-17)
Repository
Operating systemUnix-like
TypeText Structuring, Publishing, Search
LicenseGPLv3
Websitewww.jus.uio.no/sisu

SiSU ("SiSU information Structuring Universe" or "Structured information, Serialized Units"),[1] is a Unix command line-oriented framework for document structuring, publishing and search.

Usage

Using markup applied to a document, or a collection of documents, SiSU can produce plain text, HTML, XHTML, EPUB, XML, OpenDocument, LaTeX or PDF files, and populate an SQL database.

  • Document structuring

SiSU offers its user a way to structure plain text and to add graphics, hyperlinks, endnotes, footnotes etc. with simple text editing programs such as Notepad (Windows), TextEdit (Mac) or Gedit (GNU/Linux). The markup language is mnemonic and human readable.

To process the the marked up document(s) with SiSU, the user then issues a command via the command-line of the computer terminal. The output can be rendered in multiple formats (html, pdf, epub, and others) with one single command.

  • Publishing and self-publishing

A document, or a collection of documents, which has been processed by SiSU is technically ready to be published on the web, or printed on paper. Canadian author Cory Doctorow, for instance, has used SiSU as a publishing tool and blogged about it.[2] In a newspaper article, Doctorow called SiSU an "automated ebook workflow tool".[3]

  • Search

SiSU can populate an SQL database with objects(equating generally to paragraph-sized chunks) so searches may be performed and matches returned with that degree of granularity (e.g. your search criteria are met by these documents and at these locations within each document). Document output formats share a common object numbering system for locating content. This is particularly suitable for "published" works (finalized texts as opposed to works that are frequently changed or updated) for which it provides a fixed means of reference of content.

History

SiSU has been under development since 1997, and written in Ruby since 2000. It was released under the GPL in January 2005. SiSU developed out of work done on a project started earlier on documents related to (primarily private) international commercial law and international trade law started in 1993 on a site known then as Ananse, and more recently as LexMercatoria

SiSU version 1 was released December 2009. SiSU version 2 was released March 2010. Version 2 features a new processing engine. Markup remains substantially identical between versions, apart from changes to the markup for document headers (which contain document metadata and processing instructions). Both version 1 and 2 text processing engines are available in the version 2 tarball. Development takes place on the version 2 branch. Version 1 is available to guarantee compatibility with older prepared texts (prior to the updating of document headers), and as an earlier reference implementation.

Notes and references

  1. ^ also chosen for the meaning of the Finnish term "sisu".
  2. ^ "Doctorow: With a Little Help". Browse all versions. 2010-10-03. Retrieved 2011-08-11.
  3. ^ Doctorow, Cory. "The Internet Problem: when an abundance of choice becomes an issue".