summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2010-02-04 22:45:16 +0000
committerRalph Amissah <ralph@amissah.com>2010-02-04 22:45:16 +0000
commitff555f6a7459ca2e925aefe0821d7057cec76e51 (patch)
treeeed591b2fad690a3f0a0ec73d9dd6b2f922d2f7a /README
parent blob update, odt.zip fixes heading bug in odt representations (diff)
downloadsisu-ff555f6a7459ca2e925aefe0821d7057cec76e51.zip
sisu-ff555f6a7459ca2e925aefe0821d7057cec76e51.tar.xz
CHANGELOG & README ...
Diffstat (limited to 'README')
-rw-r--r--README36
1 files changed, 19 insertions, 17 deletions
diff --git a/README b/README
index a3f29f7..d1bd687 100644
--- a/README
+++ b/README
@@ -13,22 +13,23 @@ Homepage: <http://www.jus.uio.no/sisu>
With minimal preparation of a plain-text (UTF-8) file using its native
markup-syntax, SiSU produces: plain-text, HTML, XHTML, XML, ODF:ODT
(Opendocument), LaTeX, PDF, and populates an SQL database (PostgreSQL or
- SQLite) in paragraph sized chunks so that document searches are done at this
- "atomic" level of granularity.
+ SQLite) with text objects, roughly, paragraph sized chunks so that document
+ searches are done at this level of granularity.
- Outputs share a common citation numbering system, and any semantic meta-data
- provided about the document.
+ Outputs share a common citation numbering system, associated with text
+ objects and any semantic meta-data provided about the document.
SiSU also provides concordance files, document content certificates and
- manifests of generated output.
+ manifests of generated output. Book indexes may be made.
SiSU takes advantage of well established open standard ways of representing
text, and provides a bridge to take advantage of the strengths of each,
- while remaining simple. SiSU implements across document formats a "useful
- common feature set" [coming from a humanities, law, and possibly social
- sciences perspective, rather than technical or scientific writing] ...
- focus is primarily on content and data integrity rather than appearance,
- (though outputs in the various formats are respectable).
+ while retaining minimal markup requirement. SiSU implements a "useful
+ common feature set" across document formats [coming from a humanities, law,
+ and possibly social sciences perspective, rather than technical or
+ scientific writing] ... focus is primarily on content and data integrity
+ rather than appearance, (though outputs in the various formats are
+ respectable).
Syntax highlighting files for a number of editors are provided.
A vim syntax highlighting file and an ftplugin with folds for sisu markup is
@@ -56,22 +57,23 @@ SiSU can be used for Internet, Intranet, local filesystem or cd publishing.
SiSU can be used directly off the filesystem, or from a database.
-SiSU's scalability, is be dependent on your hardware, and filesystem (in my
-case Reiserfs), and/or database Postgresql.
+SiSU's scalability, is be dependent on your hardware, and filesystem and/or
+database Postgresql.
Amongst it's characteristics are:
* simple mnemonoic markup style,
-* the ability to produce multiple output formats, including
-html, structured XML, LaTeX, pdf (via LaTeX), stream to a relational database
-whilst retaining document structure - Postgresql and Sqlite,
+* the ability to produce multiple output formats, including html, XML, LaTeX,
+pdf (via LaTeX), stream to a relational database whilst retaining document
+structure - Postgresql and Sqlite,
* that all share a common citation system (a simple idea from which much good),
possibly most exciting, the following: if fed into a relational database (as it
can be automatically), the document set is searchable, with results displayed
-at a paragraph level, or the possibility of an indexed display of documents in
-which the match is found together with a hyperlinked listing for each of each
+at a paragraph level, or the possibility of an indexed display of documents
+identifying the paragraph in which the match is found (using the object
+citation numbering system) together with a hyperlinked listing for each of each
paragraph in which the match is found. In any event citations using this system
(with or without the relational database) are relevant for all output formats.