aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/sisu/v1/html/sisu.1.html
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2010-03-06 09:47:55 -0500
committerRalph Amissah <ralph@amissah.com>2010-03-06 09:47:55 -0500
commit306aed5b8a559aad2fb944a946ffdda9713f07ec (patch)
treecf627bc6438dba6103d4e05a1d5cff678f78df6f /data/doc/sisu/v1/html/sisu.1.html
parentskin_sisu utf-8 marker (diff)
introducing version 2, major patch, (version 1 libraries retained)sisu_2.0.0
Diffstat (limited to 'data/doc/sisu/v1/html/sisu.1.html')
-rw-r--r--data/doc/sisu/v1/html/sisu.1.html180
1 files changed, 86 insertions, 94 deletions
diff --git a/data/doc/sisu/v1/html/sisu.1.html b/data/doc/sisu/v1/html/sisu.1.html
index 01aafbb1..f0983e49 100644
--- a/data/doc/sisu/v1/html/sisu.1.html
+++ b/data/doc/sisu/v1/html/sisu.1.html
@@ -18,104 +18,96 @@ MANUAL, RALPH AMISSAH
<p> WHAT IS SISU?
<p> 1. INTRODUCTION - WHAT IS SISU?
-<p> <b>SiSU</b> is a framework for document structuring, publishing (in multiple
-open standard formats) and search, comprising of: (a) a lightweight document
-structure and presentation markup syntax; and (b) an accompanying engine
-for generating standard document format outputs from documents prepared
+<p> <b>SiSU</b> is a framework for document structuring, publishing (in
+multiple open standard formats) and search, comprising of: (a) a lightweight
+document structure and presentation markup syntax; and (b) an accompanying
+engine for generating standard document format outputs from documents prepared
in sisu markup syntax, which is able to produce multiple standard outputs
(including the population of sql databases) that (can) share a common numbering
-system for the citation of text within a document.
-<p> <b>SiSU</b> is developed under
-an open source, software libre license (GPL3). Its use case for development
-is to cope with medium to large document sets with evolving markup related
-technologies, which should be prepared once, and for which you want multiple
-output formats that can be updated and a common mechanism for cross-output-format
-citation, and search.
-<p> <b>SiSU</b> both defines a markup syntax and provides an
-engine that produces open standards format outputs from documents prepared
-with <b>SiSU</b> markup. From a single lightly prepared document sisu custom builds
-several standard output formats which share a common (text object) numbering
-system for citation of content within a document (that also has implications
-for search). The sisu engine works with an abstraction of the document&rsquo;s
-structure and content from which it is possible to generate different forms
-of representation of the document. Significantly <b>SiSU</b> markup is more sparse
-than html and outputs which include html, LaTeX, landscape and portrait
-pdfs, Open Document Format (ODF), all of which can be added to and updated.
-<b>SiSU</b> is also able to populate SQL type databases at an object level, which
-means that searches can be made with that degree of granularity.
-<p> Source
-document preparation and output generation is a two step process: (i) document
-source is prepared, that is, marked up in sisu markup syntax and (ii) the
-desired output subsequently generated by running the sisu engine against
-document source. Output representations if updated (in the sisu engine)
-can be generated by re-running the engine against the prepared source. Using
-<b>SiSU</b> markup applied to a document, <b>SiSU</b> custom builds (to take advantage
-of the strengths of different ways of representing documents) various standard
-open output formats including plain text, HTML, XHTML, XML, OpenDocument,
-LaTeX or PDF files, and populate an SQL database with objects[^1] (equating
-generally to paragraph-sized chunks) so searches may be performed and matches
-returned with that degree of granularity ( e.g. your search criteria is 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 works (finalized texts as opposed to
-works that are frequently changed or updated) for which it provides a fixed
-means of reference of content.
-<p> In preparing a <b>SiSU</b> document you optionally
-provide semantic information related to the document in a document header,
-and in marking up the substantive text provide information on the structure
-of the document, primarily indicating heading levels and footnotes. You
-also provide information on basic text attributes where used. The rest is
-automatic, sisu from this information custom builds[^2] the different forms
-of output requested.
-<p> <b>SiSU</b> works with an abstraction of the document based
-on its structure which is comprised of its structure (or frame)[^3] and
-the objects[^4] it contains, which enables <b>SiSU</b> to represent the document
-in many different ways, and to take advantage of the strengths of different
-ways of presenting documents. The objects are numbered, and these numbers
-can be used to provide a common base for citing material within a document
-across the different output format types. This is significant as page numbers
-are not well suited to the digital age, in web publishing, changing a browser&rsquo;s
+system for the citation of text within a document. <p> <b>SiSU</b> is
+developed under an open source, software libre license (GPL3). Its use case for
+development is to cope with medium to large document sets with evolving markup
+related technologies, which should be prepared once, and for which you want
+multiple output formats that can be updated and a common mechanism for
+cross-output-format citation, and search. <p> <b>SiSU</b> both defines a
+markup syntax and provides an engine that produces open standards format
+outputs from documents prepared with <b>SiSU</b> markup. From a single lightly
+prepared document sisu custom builds several standard output formats which
+share a common (text object) numbering system for citation of content within a
+document (that also has implications for search). The sisu engine works with an
+abstraction of the document&rsquo;s structure and content from which it is
+possible to generate different forms of representation of the document.
+Significantly <b>SiSU</b> markup is more sparse than html and outputs which
+include html, LaTeX, landscape and portrait pdfs, Open Document Format (ODF),
+all of which can be added to and updated. <b>SiSU</b> is also able to populate
+SQL type databases at an object level, which means that searches can be made
+with that degree of granularity. <p> Source document preparation and output
+generation is a two step process: (i) document source is prepared, that is,
+marked up in sisu markup syntax and (ii) the desired output subsequently
+generated by running the sisu engine against document source. Output
+representations if updated (in the sisu engine) can be generated by re-running
+the engine against the prepared source. Using <b>SiSU</b> markup applied to a
+document, <b>SiSU</b> custom builds (to take advantage of the strengths of
+different ways of representing documents) various standard open output formats
+including plain text, HTML, XHTML, XML, OpenDocument, LaTeX or PDF files, and
+populate an SQL database with objects[^1] (equating generally to
+paragraph-sized chunks) so searches may be performed and matches returned with
+that degree of granularity ( e.g. your search criteria is 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 works (finalized texts as opposed to works that are
+frequently changed or updated) for which it provides a fixed means of reference
+of content. <p> In preparing a <b>SiSU</b> document you optionally provide
+semantic information related to the document in a document header, and in
+marking up the substantive text provide information on the structure of the
+document, primarily indicating heading levels and footnotes. You also provide
+information on basic text attributes where used. The rest is automatic, sisu
+from this information custom builds[^2] the different forms of output
+requested. <p> <b>SiSU</b> works with an abstraction of the document based on
+its structure which is comprised of its structure (or frame)[^3] and the
+objects[^4] it contains, which enables <b>SiSU</b> to represent the document in
+many different ways, and to take advantage of the strengths of different ways
+of presenting documents. The objects are numbered, and these numbers can be
+used to provide a common base for citing material within a document across the
+different output format types. This is significant as page numbers are not well
+suited to the digital age, in web publishing, changing a browser&rsquo;s
default font or using a different browser means that text appears on different
-pages; and in publishing in different formats, html, landscape and portrait
-pdf etc. again page numbers are of no use to cite text in a manner that
-is relevant against the different output types. Dealing with documents at
-an object level together with object numbering also has implications for
-search.
-<p> One of the challenges of maintaining documents is to keep them
-in a format that would allow users to use them without depending on a proprietary
-software popular at the time. Consider the ease of dealing with legacy proprietary
-formats today and what guarantee you have that old proprietary formats
-will remain (or can be read without proprietary software/equipment) in
-15 years time, or the way the way in which html has evolved over its relatively
-short span of existence. <b>SiSU</b> provides the flexibility of outputing documents
-in multiple non-proprietary open formats including html, pdf[^5] and the
-ISO standard ODF.[^6] Whilst <b>SiSU</b> relies on software, the markup is uncomplicated
-and minimalistic which guarantees that future engines can be written to
-run against it. It is also easily converted to other formats, which means
-documents prepared in <b>SiSU</b> can be migrated to other document formats. Further
-security is provided by the fact that the software itself, <b>SiSU</b> is available
-under GPL3 a licence that guarantees that the source code will always be
-open, and free as in libre which means that that code base can be used,
+pages; and in publishing in different formats, html, landscape and portrait pdf
+etc. again page numbers are of no use to cite text in a manner that is relevant
+against the different output types. Dealing with documents at an object level
+together with object numbering also has implications for search. <p> One of
+the challenges of maintaining documents is to keep them in a format that would
+allow users to use them without depending on a proprietary software popular at
+the time. Consider the ease of dealing with legacy proprietary formats today
+and what guarantee you have that old proprietary formats will remain (or can be
+read without proprietary software/equipment) in 15 years time, or the way the
+way in which html has evolved over its relatively short span of existence.
+<b>SiSU</b> provides the flexibility of outputing documents in multiple
+non-proprietary open formats including html, pdf[^5] and the ISO standard
+ODF.[^6] Whilst <b>SiSU</b> relies on software, the markup is uncomplicated and
+minimalistic which guarantees that future engines can be written to run against
+it. It is also easily converted to other formats, which means documents
+prepared in <b>SiSU</b> can be migrated to other document formats. Further
+security is provided by the fact that the software itself, <b>SiSU</b> is
+available under GPL3 a licence that guarantees that the source code will always
+be open, and free as in libre which means that that code base can be used,
updated and further developed as required under the terms of its license.
-Another challenge is to keep up with a moving target. <b>SiSU</b> permits new forms
-of output to be added as they become important, (Open Document Format text
-was added in 2006 when it became an ISO standard for office applications
-and the archival of documents), and existing output to be updated (html
-has evolved and the related module has been updated repeatedly over the
-years, presumably when the World Wide Web Consortium (w3c) finalises html
-5 which is currently under development, the html module will again be updated
-allowing all existing documents to be regenerated as html 5).
-<p> The document
-formats are written to the file-system and available for indexing by independent
-indexing tools, whether off the web like Google and Yahoo or on the site
-like Lucene and Hyperestraier.
-<p> <b>SiSU</b> also provides other features such
-as concordance files and document content certificates, and the working
-against an abstraction of document structure has further possibilities
-for the research and development of other document representations, the
-availability of objects is useful for example for topic maps and the commercial
-law thesaurus by Vikki Rogers and Al Krtizer, together with the flexibility
-of <b>SiSU</b> offers great possibilities.
+Another challenge is to keep up with a moving target. <b>SiSU</b> permits new
+forms of output to be added as they become important, (Open Document Format
+text was added in 2006 when it became an ISO standard for office applications
+and the archival of documents), and existing output to be updated (html has
+evolved and the related module has been updated repeatedly over the years,
+presumably when the World Wide Web Consortium (w3c) finalises html 5 which is
+currently under development, the html module will again be updated allowing all
+existing documents to be regenerated as html 5). <p> The document formats are
+written to the file-system and available for indexing by independent indexing
+tools, whether off the web like Google and Yahoo or on the site like Lucene and
+Hyperestraier. <p> <b>SiSU</b> also provides other features such as
+concordance files and document content certificates, and the working against an
+abstraction of document structure has further possibilities for the research
+and development of other document representations, the availability of objects
+is useful for example for topic maps and thesauri, together with the
+flexibility of <b>SiSU</b> offers great possibilities.
<p> <b>SiSU</b> is primarily for published works,
which can take advantage of the citation system to reliably reference its
documents. <b>SiSU</b> works well in a complementary manner with such collaborative