diff options
Diffstat (limited to 'data')
17 files changed, 591 insertions, 490 deletions
diff --git a/data/doc/sisu/v1/CHANGELOG b/data/doc/sisu/v1/CHANGELOG index e0e51800..f53c5095 100644 --- a/data/doc/sisu/v1/CHANGELOG +++ b/data/doc/sisu/v1/CHANGELOG @@ -12,7 +12,7 @@ Reverse Chronological: %% STABLE MANIFEST -%% 2.0.0.orig.tar.gz (2009-07-04:26/6) +%% 2.0.0.orig.tar.gz (2010-03-06:09/6) http://www.jus.uio.no/sisu/pkg/src/sisu_2.0.0.orig.tar.gz sisu_2.0.0.orig.tar.gz sisu_2.0.0-1.dsc diff --git a/data/doc/sisu/v2/CHANGELOG b/data/doc/sisu/v2/CHANGELOG index b5bf00c5..b49cd17a 100644 --- a/data/doc/sisu/v2/CHANGELOG +++ b/data/doc/sisu/v2/CHANGELOG @@ -12,11 +12,27 @@ Reverse Chronological: %% Development branch UNSTABLE +%% 2.0.1.orig.tar.gz (2010-03-17:11/3) +http://www.jus.uio.no/sisu/pkg/src/sisu_2.0.1.orig.tar.gz + sisu_2.0.1.orig.tar.gz + sisu_2.0.1-1.dsc + sisu_2.0.1-1.diff.gz + + * bug fixes + * html, tables fix + * sysenv, html_promo, db name prefix from constants (now SiSUv2_) + * texpdf_format, where image missing, escape image markup loop + * epub, html: make robust where missing param values + + * vim syntax minor update in v2 + + * docs, add epub, more to be done + %% 2.0.0.orig.tar.gz (2010-03-06:09/6) http://www.jus.uio.no/sisu/pkg/src/sisu_2.0.0.orig.tar.gz - sisu_2.0.0.orig.tar.gz - sisu_2.0.0-1.dsc - sisu_2.0.0-1.diff.gz + 4fc214d40542e0d2ba7447e9ff06de3612d857d9015e8233877f9b4f93a9875f 2733550 sisu_2.0.0.orig.tar.gz + 6a157cbfc838f8141b352ab1513ac67bb43802db22f62902275df48ba41c5a0f 1145 sisu_2.0.0-1.dsc + 799b5b0b47df7356d774ac6c26529dcc57d7195a86401981cb2e89028cd795ea 275302 sisu_2.0.0-1.diff.gz * sisu v2 diff --git a/data/doc/sisu/v2/html/sisu.1.html b/data/doc/sisu/v2/html/sisu.1.html index d0af5d5b..9a56e017 100644 --- a/data/doc/sisu/v2/html/sisu.1.html +++ b/data/doc/sisu/v2/html/sisu.1.html @@ -13,137 +13,134 @@ sisu - documents: markup, structuring, publishing in multiple standard formats, and search <h2><a name='sect1' href='#toc1'>Synopsis</a></h2> sisu [-abcDdFehIiMmNnopqRrSsTtUuVvwXxYyZz0-9] -[filename/wildcard ] sisu [-Ddcv] [instruction] sisu [-CcFLSVvW] sisu ---v2 [operations] sisu --v1 [operations] SISU - MANUAL, RALPH AMISSAH -<p> WHAT -IS SISU? +[filename/wildcard] +<p> sisu [-Ddcv] [instruction] [filename/wildcard] +<p> sisu +[-CcFLSVvW] +<p> sisu --v2 [operations] +<p> sisu --v1 [operations] SISU - 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 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’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, +<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 work with medium to large document sets and cope with evolving document +formats/ representation technologies. Documents are prepared once, and generated +as need be to update the technical presentation or add additional output +formats. Various output formats (including search related output) share +a common mechanism for cross-output-format citation. +<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’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, EPUB, 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’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, 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 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 -technologies as Wikis, which can take advantage of and be used to discuss -the substance of content prepared in <b>SiSU</b> -<p> <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> +plain text, HTML, XHTML, XML, EPUB, 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 "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. +<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 headings[^3] and objects[^4], +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 +basis 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’s default font or +using a different browser can mean that text will appear on a different +page; and publishing in different formats, html, landscape and portrait +pdf etc. again page numbers are not useful to cite text. Dealing with documents +at an object level together with object numbering also has implications +for search that <b>SiSU</b> is able to take advantage of. +<p> One of the challenges +of maintaining documents is to keep them in a format that allows use of +them independently of proprietary platforms. Consider issues related to +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 producing documents in multiple non-proprietary open formats +including html, pdf[^5] ODF,[^6] and EPUB.[^7] 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), EPUB was introduced +in 2009; and allows the technical representations 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 technologies as Wikis, which can take advantage +of and be used to discuss the substance of content prepared in <b>SiSU</b> +<p> +<<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> > -<p> 2. -COMMANDS SUMMARY -<p> 2.1 SYNOPSIS -<p> <b>SiSU</b> - Structured information, Serialized -Units - a document publishing system -<p> sisu [ -abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0-9 - ] [ filename/ wildcard ] -<p> sisu [ -Ddcv ] [ instruction ] -<p> sisu [ -CcFLSVvW - ] -<p> Note: commands should be issued from within the directory that contains -the marked up files, cd to markup directory. -<p> 2.2 DESCRIPTION +<p> 2. COMMANDS SUMMARY +<p> 2.1 DESCRIPTION <p> <b>SiSU</b> <b>SiSU</b> is a document publishing system, that from a simple single marked-up document, -produces multiple of output formats including: plaintext, html, LaTeX, -pdf, xhtml, XML, info, and SQL (PostgreSQL and SQLite), which share numbered -text objects ( structure information. For more see: <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> +produces multiple of output formats including: plaintext, html, xhtml, +XML, epub, odt (odf text), LaTeX, pdf, info, and SQL (PostgreSQL and SQLite), +which share numbered text objects ("object citation numbering") and the +same document structure information. For more see: <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> > -<p> 2.3 DOCUMENT PROCESSING COMMAND FLAGS +<p> 2.2 DOCUMENT PROCESSING COMMAND FLAGS <p> <dl> @@ -283,19 +280,19 @@ file format (opendocument.odt). <dd>produces LaTeX pdf (portrait.pdf & landscape.pdf). Default paper size is set in config file, or document header, or provided with additional command line parameter, e.g. ---papersize-a4 preset sizes include: ’A4’, U.S. ’letter’ and ’legal’ and book sizes -’A5’ and ’B5’ (system defaults to A4). +--papersize-a4 preset sizes include: ’A4’, U.S. ’letter’ and <p> </dd> -<dt><b>-q [filename/wildcard]</b> </dt> -<dd>quiet less output -to screen. +<dt><b>-q [filename/wildcard]</b> +</dt> +<dd>quiet less output to screen. <p> </dd> <dt><b>-R [filename/wildcard]</b> </dt> -<dd>copies sisu output files to remote host -using rsync. This requires that sisurc.yml has been provided with information -on hostname and username, and that you have your different if -R is used +<dd>copies sisu output files +to remote host using rsync. This requires that sisurc.yml has been provided +with information on hostname and username, and that you have your "keys" +and ssh agent in place. Note the behavior of rsync different if -R is used with other flags from if used alone. Alone the rsync --delete parameter is sent, useful for cleaning the remote directory (when -R is used together with other flags, it is not). Also see -r @@ -305,16 +302,15 @@ with other flags, it is not). Also see -r <dd>copies sisu output files to remote host using scp. This requires that sisurc.yml has been provided with information on hostname and username, and that you have - -<p>your +your "keys" and ssh agent in place. Also see -R <p> </dd> <dt><b>-S</b> </dt> -<dd>produces a sisupod a zipped sisu directory of markup files including -sisu markup source files and the directories local configuration file, -images and skins. Note: this only includes the configuration files or skins -contained in ./_sisu not those in ~/.sisu -S [filename/wildcard] option. Note: -(this<br> +<dd>produces a sisupod a zipped +sisu directory of markup files including sisu markup source files and the +directories local configuration file, images and skins. Note: this only +includes the configuration files or skins contained in ./_sisu not those +in ~/.sisu -S [filename/wildcard] option. Note: (this<br> option is tested only with zsh). <p> </dd> @@ -392,7 +388,7 @@ created for each of the processing flag requests. See also -V webrick webserver points at sisu output directories, the default port is set to 8081 and can be changed in the resource configuration files. [tip: the webrick server requires link suffixes, so html output should be created - using the -h option rather than and search -H; also, note -F webrick ]. + using the -h option rather than and search -H ; also, note -F webrick ]. <p> </dd> <dt><b>-w @@ -515,42 +511,43 @@ data to postgresql db (rb.dbi) [ -d --remove sqlite equi <dt><b>-D --dropall</b> </dt> -<dd>kills data --dropall sqlite equivalent] -<p> The v in e.g. -Dv is for verbose output. - +<dd>kills data" and drops (postgresql or sqlite) db, tables & indexes [ -d --dropall + sqlite equivalent] +<p> The v in e.g. -Dv is for verbose output. <p> </dd> </dl> -5. SHORTCUTS, SHORTHAND FOR MULTIPLE FLAGS +5. SHORTCUTS, +SHORTHAND FOR MULTIPLE FLAGS <p> <dl> -<dt><b>--update [filename/wildcard]</b> -</dt> -<dd>Checks existing file output and runs the flags required to update this -output. This means that if only html and pdf output was requested on previous -runs, only the -hp files will be applied, and only these will be generated -this time, together with the summary. This can be very convenient, if you -offer different outputs of different files, and just want to do the same -again. +<dt><b>--update [filename/wildcard]</b> </dt> +<dd>Checks existing +file output and runs the flags required to update this output. This means +that if only html and pdf output was requested on previous runs, only the +-hp files will be applied, and only these will be generated this time, together +with the summary. This can be very convenient, if you offer different outputs +of different files, and just want to do the same again. <p> </dd> -<dt><b>-0 to -5 [filename or wildcard]</b> </dt> -<dd>Default shorthand mappings (note that -the defaults can be changed/configured in the sisurc.yml file): +<dt><b>-0 to -5 [filename + or wildcard]</b> </dt> +<dd>Default shorthand mappings (note that the defaults can be +changed/configured in the sisurc.yml file): <p> </dd> <dt><b>-0</b> </dt> -<dd>-mNhwpAobxXyYv -[this is the default action run when no i.e. on ’sisu [filename]’] +<dd>-mNhwpAobxXyYv [this is the + default action run when no i.e. on ’sisu [filename]’] <p> </dd> <dt><b>-1</b> </dt> -<dd>-mhewpy - +<dd>-mhewpy <p> </dd> <dt><b>-2</b> </dt> -<dd>-mhewpaoy +<dd>-mhewpaoy + <p> </dd> <dt><b>-3</b> </dt> @@ -562,27 +559,26 @@ the defaults can be changed/configured in the sisurc.yml file): <p> </dd> <dt><b>-5</b> </dt> -<dd>-mhewpAobxXDyY --update - -<p> add -v for verbose mode and -c for color, e.g. sisu -2vc [filename or -<p> consider +<dd>-mhewpAobxXDyY --update +<p> add -v +for verbose mode and -c for color, e.g. sisu -2vc [filename or +<p> consider -u -<p>- -<p>u for appended url info or -v for verbose output +<p>for appended url info or -v for verbose output <p> </dd> </dl> 5.1 COMMAND LINE WITH FLAGS - BATCH PROCESSING <p> In the data directory run sisu -mh filename or wildcard -eg. cisg.sst documents. -<p> Running 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. +eg. "sisu -h cisg.sst" or "sisu -h *.{sst,ssm}" to produce html version of all +documents. +<p> Running 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. <p> 6. HELP <p> 6.1 SISU MANUAL -<p> The most -up to date information on sisu should be contained in the sisu_manual, -available at: +<p> The most up to date information +on sisu should be contained in the sisu_manual, available at: <p> <<a href='http://sisudoc.org/sisu/sisu_manual/'>http://sisudoc.org/sisu/sisu_manual/</a> ><br> @@ -620,10 +616,10 @@ within the <b>SiSU</b> tarball at: <p> An online version of the sisu man page is available here: <p> * various sisu man pages <<a href='http://www.jus.uio.no/sisu/man/'>http://www.jus.uio.no/sisu/man/</a> -> [^7] +> [^8] <p> * sisu.1 <<a href='http://www.jus.uio.no/sisu/man/sisu.1.html'>http://www.jus.uio.no/sisu/man/sisu.1.html</a> > -[^8] +[^9] <p> 6.3 SISU BUILT-IN INTERACTIVE HELP <p> This is particularly useful for getting the current sisu setup/environment information: @@ -661,10 +657,10 @@ see: <p> <<a href='http://sisudoc.org/sisu/sisu_help_sources/index.html'>http://sisudoc.org/sisu/sisu_help_sources/index.html</a> ><br> -<p> 7. INTRODUCTION TO SISU MARKUP[^9] +<p> 7. INTRODUCTION TO SISU MARKUP[^10] <p> 7.1 SUMMARY <p> <b>SiSU</b> source documents -are plaintext (UTF-8)[^10] files +are plaintext (UTF-8)[^11] files <p> All paragraphs are separated by an empty line. <p> Markup is comprised of: @@ -741,8 +737,8 @@ followed by a space and the comment: <pre> % this would be a comment </pre> <p> 8.1 SAMPLE HEADER -<p> This current document has a header similar to this -one (without the comments): +<p> This current document is loaded by a master document +that has a header similar to this one: <p> <p> <br> <pre> % SiSU master 2.0 @@ -784,7 +780,7 @@ one (without the comments): { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ -</pre></pre> +</pre> <p> 8.2 AVAILABLE HEADERS <p> Header tags appear at the beginning of a document and provide meta information on the document (such as the Dublin Core), @@ -804,21 +800,18 @@ and can be useful to know. <p> <p> <br> <pre> % SiSU 2.0 [declared file-type identifier with markup version] -</pre></pre> -<p> +</pre> <p> <br> <pre> @title: [title text] [this header is the only one that is mandatory] :subtitle: [subtitle if any] :language: English -</pre></pre> -<p> +</pre> <p> <br> <pre> @creator: :author: [Lastname, First names] :illustrator: [Lastname, First names] :translator: [Lastname, First names] :prepared_by: [Lastname, First names] -</pre></pre> -<p> +</pre> <p> <br> <pre> @date: :published: [year or yyyy-mm-dd] :created: [year or yyyy-mm-dd] @@ -828,16 +821,14 @@ and can be useful to know. :valid: [year or yyyy-mm-dd] :added_to_site: [year or yyyy-mm-dd] :translated: [year or yyyy-mm-dd] -</pre></pre> -<p> +</pre> <p> <br> <pre> @rights: :copyright: Copyright (C) [Year and Holder] :license: [Use License granted] :text: [Year and Holder] :translation: [Name, Year] :illustrations: [Name, Year] -</pre></pre> -<p> +</pre> <p> <br> <pre> @classify: :topic_register: SiSU:markup sample:book;book:novel:fantasy @@ -850,13 +841,11 @@ and can be useful to know. :loc: [Library of Congress classification] :dewey: [Dewey classification :pg: [Project Gutenberg text number] -</pre></pre> -<p> +</pre> <p> <br> <pre> @links: { SiSU }http://www.jus.uio.no/sisu/ { FSF }http://www.fsf.org -</pre></pre> -<p> +</pre> <p> <br> <pre> @make: :skin: skin_name @@ -870,16 +859,14 @@ generated] :promo: sisu, ruby, sisu_search_libre, open_society :bold: [regular expression of words/phrases to be made bold] :italics: [regular expression of words/phrases to italicise] -</pre></pre> -<p> +</pre> <p> <br> <pre> @original: :language: [language] -</pre></pre> -<p> +</pre> <p> <br> <pre> @notes: :comment: :prefix: [prefix is placed just after table of contents] -</pre></pre> +</pre> <p> 9. MARKUP OF SUBSTANTIVE TEXT <p> 9.1 HEADING LEVELS <p> Heading levels are @@ -991,22 +978,22 @@ html <p> 9.4 FOOTNOTES / ENDNOTES <p> Footnotes and endnotes not distinguished in markup. They are automatically numbered. Depending on the output file format -(html, odf, pdf etc.), the document output selected will have either footnotes -or endnotes. +(html, EPUB, odf, pdf etc.), the document output selected will have either +footnotes or endnotes. <p> <b>markup example:</b> <p> <p> <br> <pre> ~{ a footnote or endnote }~ </pre> <p> <b>resulting output:</b> -<p> [^11] +<p> [^12] <p> <b>markup example:</b> <p> <p> <br> <pre> normal text~{ self contained endnote marker & endnote in one }~ continues </pre> <p> <b>resulting output:</b> -<p> normal text[^12] continues +<p> normal text[^13] continues <p> <b>markup example:</b> <p> <p> <br> @@ -1104,11 +1091,11 @@ block is used there is neither decoration nor hyperlinking, code blocks <pre> about {~^ SiSU }http://url.org markup </pre> <p> <b>resulting output:</b> -<p> about SiSU <<a href='http://www.jus.uio.no/sisu/'>http://www.jus.uio.no/sisu/</a> -> [^13] markup -<p> +<p> aboutSiSU <<a href='http://www.jus.uio.no/sisu/'>http://www.jus.uio.no/sisu/</a> +> [^14] markup +<p> 9.5.3 -<p>9.5.3 LINKING IMAGES +<p>LINKING IMAGES <p> <b>markup example:</b> <p> <p> <br> @@ -1122,7 +1109,7 @@ block is used there is neither decoration nor hyperlinking, code blocks <p> [ tux.png ] <p> tux.png 64x80 <p> [ ruby_logo (png missing) - ] [^14] + ] [^15] <p> GnuDebianLinuxRubyBetterWay.png 100x101 and Ruby <p> <b>linked url footnote @@ -1165,7 +1152,7 @@ auto-heading numbering, without further intervention. <p> a second form may be easier to work with in cases where there is not <p>much information in each column -<p> <b>markup example:</b> [^15] +<p> <b>markup example:</b> [^16] <p> <p> <br> <pre> !_ Table 3.1: Contributors to Wikipedia, January 2001 - June 2005 @@ -1708,7 +1695,7 @@ and processing will occur normally if a .sst file is renamed .ssm without requiring any other documents; the .ssm marker flags that the document may contain other documents. <p> Note: a secondary file of the composite document -is built prior to processing with the same prefix and the suffix ._sst [^16] +is built prior to processing with the same prefix and the suffix ._sst [^17] <p> <<a href='http://www.jus.uio.no/sisu/sisu_markup'>http://www.jus.uio.no/sisu/sisu_markup</a> > @@ -1895,90 +1882,90 @@ and symbolic links as needed from the site, or dir directories as required. <p> With <b>SiSU</b> installed sample skins may be found in: <p> /etc/sisu/skin/doc and<br> - /usr/share/doc/sisu/v1/sisu_markup_samples/dfsg/_sisu/skin/doc<br> + /usr/share/doc/sisu/v2/sisu_markup_samples/samples/_sisu/skin/doc<br> <p> (or equivalent directory) and if sisu-markup-samples is installed also under: -<p> /usr/share/doc/sisu/v1/sisu_markup_samples/non-free/_sisu/skin/doc<br> +<p> /usr/share/doc/sisu-markup-samples/v2/samples/_sisu/skin/doc<br> <p> Samples of list.yml and promo.yml (which are used to create the right column list) may be found in: -<p> /usr/share/doc/sisu/v1/sisu_markup_samples/dfsg/_sisu/skin/yml +<p> /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml (or equivalent<br> directory)<br> <p> 16. CSS - CASCADING STYLE SHEETS (FOR HTML, XHTML AND XML) <p> CSS files to modify the appearance of <b>SiSU</b> html, XHTML or XML may be placed in the -configuration directory: ./_sisu/css; ~/.sisu/css or; /etc/sisu/css and -these will be copied to the<br> - output directories with the command sisu -CC. -<p> The basic CSS file for html -output is html.css, placing a file of that name in directory _sisu/css or -equivalent will result in the default file of that name being overwritten. +configuration directory: ./_sisu/css ; ~/.sisu/css or; /etc/sisu/css and +these will be copied to the output directories with the command sisu -CC. +<p> The basic CSS file for html output is html.css, placing a file of that +name in directory _sisu/css or equivalent will result in the default file +of that name being overwritten. <p> HTML: html.css <p> XML DOM: dom.css -<p> XML SAX: sax.css +<p> XML +SAX: sax.css <p> XHTML: xhtml.css -<p> - The default homepage may use homepage.css or html.css -<p> Under consideration -is to permit the placement of a CSS file with a different name in directory -_sisu/css directory or equivalent, and change the default CSS file that -is looked for in a skin.[^17] -<p> 17. ORGANISING CONTENT -<p> 17.1 DIRECTORY STRUCTURE - -<p>AND MAPPING -<p> The output directory root can be set in the sisurc.yml file. -Under the root, subdirectories are made for each directory in which a document -set resides. If you have a directory named poems or conventions, that directory -will be created under the output directory root and the output for all -documents contained in the directory of a particular name will be generated -to subdirectories beneath that directory (poem or conventions). A document -will be placed in a subdirectory of the same name as the document with -the filetype identifier stripped (.sst .ssm) -<p> The last part of a directory -path, representing the sub-directory in which a document set resides, is -the directory name that will be used for the output directory. This has -implications for the organisation of document collections as it could make -sense to place documents of a particular subject, or type within a directory -identifying them. This grouping as suggested could be by subject (sales_law, -english_literature); or just as conveniently by some other classification -(X University). The mapping means it is also possible to place in the same -output directory documents that are for organisational purposes kept separately, -for example documents on a given subject of two different institutions -may be kept in two different directories of the same name, under a directory -named after each institution, and these would be output to the same output -directory. Skins could be associated with each institution on a directory -basis and resulting documents will take on the appropriate different appearance. - +<p> The default homepage may use homepage.css + +<p>or html.css +<p> Under consideration is to permit the placement of a CSS file +with a different name in directory _sisu/css directory or equivalent, and +change the default CSS file that is looked for in a skin.[^18] +<p> 17. ORGANISING +CONTENT +<p> 17.1 DIRECTORY STRUCTURE AND MAPPING +<p> The output directory root +can be set in the sisurc.yml file. Under the root, subdirectories are made +for each directory in which a document set resides. If you have a directory +named poems or conventions, that directory will be created under the output +directory root and the output for all documents contained in the directory +of a particular name will be generated to subdirectories beneath that directory +(poem or conventions). A document will be placed in a subdirectory of the +same name as the document with the filetype identifier stripped (.sst .ssm) + +<p> The last part of a directory path, representing the sub-directory in which +a document set resides, is the directory name that will be used for the +output directory. This has implications for the organisation of document +collections as it could make sense to place documents of a particular subject, +or type within a directory identifying them. This grouping as suggested +could be by subject (sales_law, english_literature); or just as conveniently +by some other classification (X University). The mapping means it is also +possible to place in the same output directory documents that are for organisational +purposes kept separately, for example documents on a given subject of two +different institutions may be kept in two different directories of the +same name, under a directory named after each institution, and these would +be output to the same output directory. Skins could be associated with each +institution on a directory basis and resulting documents will take on the +appropriate different appearance. <p> <p> 18. HOMEPAGES -<p> <b>SiSU</b> is about the ability to auto-generate documents. Home -pages are regarded as custom built items, and are not created by <b>SiSU</b> -<b>SiSU</b> has a default home page, which will not be appropriate for use with -other sites, and the means to provide your own home page instead in one -of two ways as part of a site’s configuration, these being: -<p> 1. through -placing your home page and other custom built documents in the subdirectory -_sisu/home/ (this probably being the easier and more convenient option) - -<p> 2. through providing what you want as the home page in a skin, -<p> Document -sets are contained in directories, usually organised by site or subject. -Each directory can/should have its own homepage. See the section on directory -structure and organisation of content. -<p> 18.1 HOME PAGE AND OTHER CUSTOM BUILT - -<p>PAGES IN A SUB-DIRECTORY -<p> Custom built pages, including the home page index.html -may be placed within the configuration directory _sisu/home/ in any of -the locations that is searched for the configuration directory, namely -./_sisu; ~/_sisu; /etc/sisu From there they are copied to the root of the -output directory with the command: -<p> sisu -CC<br> +<p> <b>SiSU</b> is about the ability +to auto-generate documents. Home pages are regarded as custom built items, +and are not created by <b>SiSU</b> <b>SiSU</b> has a default home page, which will not +be appropriate for use with other sites, and the means to provide your +own home page instead in one of two ways as part of a site’s configuration, +these being: +<p> 1. through placing your home page and other custom built +documents in the subdirectory _sisu/home/ (this probably being the easier +and more convenient option) +<p> 2. through providing what you want as the +home page in a skin, +<p> Document sets are contained in directories, usually +organised by site or subject. Each directory can/should have its own homepage. +See the section on directory structure and organisation of content. +<p> 18.1 + +<p>HOME PAGE AND OTHER CUSTOM BUILT PAGES IN A SUB-DIRECTORY +<p> Custom built +pages, including the home page index.html may be placed within the configuration +directory _sisu/home/ in any of the locations that is searched for the +configuration directory, namely ./_sisu ; ~/_sisu ; /etc/sisu From there +they are copied to the root of the output directory with the command: +<p> + sisu -CC<br> <p> 18.2 HOME PAGE WITHIN A SKIN <p> Skins are described in a separate section, @@ -2040,8 +2027,8 @@ or in various output formats. <p> 21. SQL <p> 21.1 POPULATING SQL TYPE DATABASES -<p> <b>SiSU</b> feeds sisu markupd documents into sql type databases PostgreSQL[^18] -and/or SQLite[^19] database together with information related to document +<p> <b>SiSU</b> feeds sisu markupd documents into sql type databases PostgreSQL[^19] +and/or SQLite[^20] database together with information related to document structure. <p> This is one of the more interesting output forms, as all the structural data of the documents are retained (though can be ignored by @@ -2051,7 +2038,8 @@ are (currently) streamed to four tables: (and other) headers, including, title, author,<br> subject, (the Dublin Core...);<br> -<p> * another the substantive texts by individual<br> +<p> * another the substantive texts by individual "paragraph" (or object) +-<br> along with structural information, each paragraph being identifiable by its<br> paragraph number (if it has one which almost all of them do), and the<br> @@ -2256,20 +2244,20 @@ DATABASE AND SISU FEATURES, INCLUDING OBJECT CITATION NUMBERING (BACKEND CURRENTLY POSTGRESQL) <p> Sample search frontend <<a href='http://search.sisudoc.org'>http://search.sisudoc.org</a> > -[^20] A small database and sample query front-end (search from) that makes -use of the citation system, <i>object</i> citation numbering to demonstrates functionality.[^21] +[^21] A small database and sample query front-end (search from) that makes +use of the citation system, <i>object</i> citation numbering to demonstrates functionality.[^22] <p> <b>SiSU</b> can provide information on which documents are matched and at what locations within each document the matches are found. These results are relevant across all outputs using object citation numbering, which includes -html, XML, LaTeX, PDF and indeed the SQL database. You can then refer to -one of the other outputs or in the SQL database expand the text within +html, XML, EPUB, LaTeX, PDF and indeed the SQL database. You can then refer +to one of the other outputs or in the SQL database expand the text within the matched objects (paragraphs) in the documents matched. <p> 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.[^22] +the search criteria.[^23] <p> <dl> @@ -2621,11 +2609,11 @@ and a rant(by Stefan Lang) built install file, in either case: the first steps are the same, download and unpack the source file: <p> For basic use <b>SiSU</b> is only dependent on the programming language in which it is written -<b>Ruby</b> , and <b>SiSU</b> will be able to generate html, various XMLs, including +<b>Ruby</b> , and <b>SiSU</b> will be able to generate html, EPUB, various XMLs, including ODF (and will also produce LaTeX). Dependencies required for further actions, though it relies on the installation of additional dependencies which the source tarball does not take care of, for things like using a database -(postgresql or sqlite)[^23] or converting LaTeX to pdf. +(postgresql or sqlite)[^24] or converting LaTeX to pdf. <p> <b>setup.rb</b> <p> This is a standard ruby installer, using setup.rb is a three step process. In @@ -2686,9 +2674,9 @@ a number of markup sample files may be found either in the directory: <p> change directory to the appropriate one: <p> cd /usr/share/doc/sisu/sisu_markup_samples/dfsg -<p> 30.2.1 BASIC TEXT, PLAINTEXT, HTML, XML, ODF -<p> Having moved to the directory -that contains the markup samples (see instructions above if necessary), +<p> 30.2.1 BASIC TEXT, PLAINTEXT, HTML, XML, ODF, EPUB +<p> Having moved to the +directory that contains the markup samples (see instructions above if necessary), <p>choose a file and run sisu against it <p> sisu -NhwoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst @@ -2735,12 +2723,12 @@ create the database and write to it when you run sisu. to date as within the package itself: <p> * sisu.1 <<a href='http://www.jus.uio.no/sisu/man/sisu.1'>http://www.jus.uio.no/sisu/man/sisu.1</a> > -[^24] +[^25] <p> * sisu.8 <<a href='http://www.jus.uio.no/sisu/man/sisu.8'>http://www.jus.uio.no/sisu/man/sisu.8</a> -> [^25] +> [^26] <p> * man directory <<a href='http://www.jus.uio.no/sisu/man'>http://www.jus.uio.no/sisu/man</a> -> [^26] +> [^27] <p> 30.3.2 BUILT IN HELP <p> sisu --help <p> sisu @@ -2765,7 +2753,7 @@ to date as within the package itself: <p> Additional markup samples are packaged separately in the file: <p> <b>*</b> <p> -On <b>Debian</b> they are available in non-free[^27] to include them it is necessary +On <b>Debian</b> they are available in non-free[^28] to include them it is necessary to include non-free in your /etc/apt/source.list or obtain them from the sisu home site. <p> 31. EDITOR FILES, SYNTAX HIGHLIGHTING @@ -2919,16 +2907,19 @@ may also contain processing instructions. <b>SiSU</b> markup is primarily an abs of document structure and document metadata to permit taking advantage of the basic strengths of existing alternative practical standard ways of representing documents [be that paper publication, sql search etc.] (html, -xml, odf, latex, pdf, sql) -<p> * for output produces reasonably elegant output -of established industry and institutionally accepted open standard formats.[3] -takes advantage of the different strengths of various standard formats -for representing documents, amongst the output formats currently supported -are: -<p> * html - both as a single scrollable text and a segmented document<br> +epub, xml, odf, latex, pdf, sql) +<p> * for output produces reasonably elegant +output of established industry and institutionally accepted open standard +formats.[3] takes advantage of the different strengths of various standard +formats for representing documents, amongst the output formats currently +supported are: +<p> * html - both as a single scrollable text and a segmented +document<br> <p> * xhtml<br> +<p> * epub<br> + <p> * XML - both in sax and dom style xml structures for further development as<br> required<br> @@ -2958,74 +2949,71 @@ across browsers and formats. sisu seeks to provide a common way of pinpoint the text within a document, (which can be utilized for citation and by search engines). The outputs share a common numbering system that is meaningful (to man and machine) across all digital outputs whether paper, screen, -or database oriented, (pdf, HTML, xml, sqlite, postgresql), this numbering -system can be used to reference content. -<p> * Granular search within documents. -SQL databases are populated at an object level (roughly headings, paragraphs, -verse, tables) and become searchable with that degree of granularity, the -output information provides the object/paragraph numbers which are relevant -across all generated outputs; it is also possible to look at just the matching -paragraphs of the documents in the database; [output indexing also work - well with search indexing tools like hyperestraier]. -<p> * long term maintainability -of document collections in a world of changing formats, having a very sparsely -marked-up source document base. there is a considerable degree of future-proofing, -output representations are upgradeable (open document text) module in 2006 -and in future html5 output sometime in future, without modification of - -<p>existing prepared texts -<p> * SQL search aside, documents are generated as -required and static once generated. -<p> * documents produced are static files, -and may be batch processed, this needs to be done only once but may be -repeated for various reasons as desired (updated content, addition of new -output formats, updated technology document presentations/representations) - -<p> * document source (plaintext utf-8) if shared on the net may be used as - -<p>input and processed locally to produce the different document outputs -<p> - * document source may be bundled together (automatically) with associated -documents (multiple language versions or master document with inclusions) -and images and sent as a zip file called a sisupod, if shared on the net - -<p>these too may be processed locally to produce the desired document outputs - -<p> * generated document outputs may automatically be posted to remote sites. - -<p> * for basic document generation, the only software dependency is <b>Ruby</b> -, and a few standard Unix tools (this covers plaintext, HTML, XML, ODF, -LaTeX). To use a database you of course need that, and to convert the LaTeX -generated to pdf, a latex processor like tetex or texlive. -<p> * as a developers - -<p>tool it is flexible and extensible -<p> Syntax highlighting for <b>SiSU</b> markup -is available for a number of text editors. -<p> <b>SiSU</b> is less about document -layout than about finding a way with little markup to be able to construct -an abstract representation of a document that makes it possible to produce -multiple representations of it which may be rather different from each -other and used for different purposes, whether layout and publishing, or - -<p>search of content -<p> i.e. to be able to take advantage from this minimal preparation -starting point of some of the strengths of rather different established -ways of representing documents for different purposes, whether for search -(relational database, or indexed flat files generated for that purpose -whether of complete documents, or say of files made up of objects), online -viewing (e.g. html, xml, pdf), or paper publication (e.g. pdf)... -<p> the solution -arrived at is by extracting structural information about the document (about -headings within the document) and by tracking objects (which are serialized -and also given hash values) in the manner described. It makes possible representations -that are quite different from those offered at present. For example objects -could be saved individually and identified by their hashes, with an index -of how the objects relate to each other to form a document. -<p> 34. HELP SOURCES - -<p> For a summary of alternative ways to get help on <b>SiSU</b> try one of the -following: +or database oriented, (pdf, HTML, EPUB, xml, sqlite, postgresql), this +numbering system can be used to reference content. +<p> * Granular search within +documents. SQL databases are populated at an object level (roughly headings, +paragraphs, verse, tables) and become searchable with that degree of granularity, +the output information provides the object/paragraph numbers which are +relevant across all generated outputs; it is also possible to look at just +the matching paragraphs of the documents in the database; [output indexing + also work well with search indexing tools like hyperestraier]. +<p> <b>*</b>long<b>term</b>maintainability<b>of</b>document<b>collections</b>in<b>a</b>world<b>of</b>changing +formats, having a very sparsely marked-up source document base. there is +a considerable degree of future-proofing, output representations are upgradeable +(open document text) module in 2006, epub in 2009 and in future html5 output +sometime in future, without modification of existing prepared texts +<p> * +SQL search aside, documents are generated as required and static once generated. + +<p> * documents produced are static files, and may be batch processed, this +needs to be done only once but may be repeated for various reasons as desired +(updated content, addition of new output formats, updated technology document +presentations/representations) +<p> * document source (plaintext utf-8) if + +<p>shared on the net may be used as input and processed locally to produce + +<p>the different document outputs +<p> * document source may be bundled together +(automatically) with associated documents (multiple language versions or +master document with inclusions) and images and sent as a zip file called +a sisupod, if shared on the net these too may be processed locally to produce + +<p>the desired document outputs +<p> * generated document outputs may automatically +be posted to remote sites. +<p> * for basic document generation, the only software +dependency is <b>Ruby</b> , and a few standard Unix tools (this covers plaintext, +HTML, EPUB, XML, ODF, LaTeX). To use a database you of course need that, +and to convert the LaTeX generated to pdf, a latex processor like tetex +or texlive. +<p> * as a developers tool it is flexible and extensible +<p> Syntax +highlighting for <b>SiSU</b> markup is available for a number of text editors. + +<p> <b>SiSU</b> is less about document layout than about finding a way with little +markup to be able to construct an abstract representation of a document +that makes it possible to produce multiple representations of it which +may be rather different from each other and used for different purposes, +whether layout and publishing, or search of content +<p> i.e. to be able to +take advantage from this minimal preparation starting point of some of +the strengths of rather different established ways of representing documents +for different purposes, whether for search (relational database, or indexed +flat files generated for that purpose whether of complete documents, or +say of files made up of objects), online viewing (e.g. html, xml, pdf), or +paper publication (e.g. pdf)... +<p> the solution arrived at is by extracting structural +information about the document (about headings within the document) and +by tracking objects (which are serialized and also given hash values) in +the manner described. It makes possible representations that are quite different +from those offered at present. For example objects could be saved individually +and identified by their hashes, with an index of how the objects relate +to each other to form a document. +<p> 34. HELP SOURCES +<p> For a summary of alternative +ways to get help on <b>SiSU</b> try one of the following: <p> <b>man page</b> <p> man sisu_help<br> @@ -3064,8 +3052,8 @@ listed here: <p> 34.2 SISU GENERATED OUTPUT - LINKS TO HTML <p> Note <b>SiSU</b> documentation is prepared in <b>SiSU</b> and output is available in multiple formats including -amongst others html, pdf, and odf which may be also be accessed via the -html pages[^28] +amongst others html, pdf, odf and epub which may be also be accessed via +the html pages[^28] <p> 34.2.1 WWW.SISUDOC.ORG <p> <<a href='http://sisudoc.org/sisu/sisu_manual/index.html'>http://sisudoc.org/sisu/sisu_manual/index.html</a> > @@ -3152,15 +3140,15 @@ html pages[^28] <p> <file:///usr/share/doc/sisu/v2/html/sisu_help.1.html> <p> <file:///usr/share/doc/sisu/v2/html/sisu_help_sources.1.html> -<p> /usr/share/doc/sisu/html/v2/sisu.1.html<br> +<p> /usr/share/doc/sisu/v2/html/sisu.1.html<br> -<p> /usr/share/doc/sisu/html/v2/sisu_pdf.7.html<br> +<p> /usr/share/doc/sisu/v2/html/sisu_pdf.7.html<br> -<p> /usr/share/doc/sisu/html/v2/sisu_postgresql.7.html<br> +<p> /usr/share/doc/sisu/v2/html/sisu_postgresql.7.html<br> -<p> /usr/share/doc/sisu/html/v2/sisu_sqlite.7.html<br> +<p> /usr/share/doc/sisu/v2/html/sisu_sqlite.7.html<br> -<p> /usr/share/doc/sisu/html/v2/sisu_webrick.1.html<br> +<p> /usr/share/doc/sisu/v2/html/sisu_webrick.1.html<br> <p> 34.3.2 WWW.JUS.UIO.NO/SISU <p> <<a href='http://www.jus.uio.no/sisu/man/sisu.1.html'>http://www.jus.uio.no/sisu/man/sisu.1.html</a> @@ -3187,29 +3175,33 @@ html pages[^28] <ol> <b>.</b><li>objects include: headings, paragraphs, verse, tables, images, but not footnotes/endnotes which are numbered separately and tied to the object -from which they are referenced. </li><b>.</b><li>i.e. the html, pdf, odf outputs are each built -individually and optimised for that form of presentation, rather than for -example the html being a saved version of the odf, or the pdf being a saved -version of the html. </li><b>.</b><li>the different heading levels </li><b>.</b><li>units of text, primarily -paragraphs and headings, also any tables, poems, code-blocks </li><b>.</b><li>Specification -submitted by Adobe to ISO to become a full open ISO specification <<a href='http://www.linux-watch.com/news/NS7542722606.html'>http://www.linux-watch.com/news/NS7542722606.html</a> -> -</li><b>.</b><li>ISO/IEC 26300:2006 </dd> +from which they are referenced. </li><b>.</b><li>i.e. the html, pdf, epub, odf outputs are +each built individually and optimised for that form of presentation, rather +than for example the html being a saved version of the odf, or the pdf +being a saved version of the html. +<p> </li><b>.</b><li>the different heading levels </li><b>.</b><li>units +of text, primarily paragraphs and headings, also any tables, poems, code-blocks +</li><b>.</b><li>Specification submitted by Adobe to ISO to become a full open ISO specification +<<a href='http://www.linux-watch.com/news/NS7542722606.html'>http://www.linux-watch.com/news/NS7542722606.html</a> +> </li><b>.</b><li>ISO standard ISO/IEC 26300:2006 + +<p> </li><b>.</b><li>An open standard format for e-books +<p> </dd> <dt><b>*1.</b> </dt> <dd>square brackets </dd> <dt><b>*2.</b> </dt> -<dd>square brackets </dd> +<dd>square brackets +</dd> <dt><b>+1.</b> </dt> -<dd>square brackets -</li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man/'>http://www.jus.uio.no/sisu/man/</a> +<dd>square brackets </li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man/'>http://www.jus.uio.no/sisu/man/</a> > </li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man/sisu.1.html'>http://www.jus.uio.no/sisu/man/sisu.1.html</a> -> </li><b>.</b><li>From -sometime after SiSU 0.58 it should be possible to describe SiSU markup using -SiSU, which though not an original design goal is useful. </li><b>.</b><li>files should be -prepared using UTF-8 character encoding </li><b>.</b><li>a footnote or endnote </li><b>.</b><li>self contained +> +</li><b>.</b><li>From sometime after SiSU 0.58 it should be possible to describe SiSU markup +using SiSU, which though not an original design goal is useful. </li><b>.</b><li>files should +be prepared using UTF-8 character encoding </li><b>.</b><li>a footnote or endnote </li><b>.</b><li>self contained endnote marker & endnote in one </dd> <dt><b>*.</b> </dt> @@ -3234,22 +3226,19 @@ notes, numbered asterisk footnote/endnote series </li><b>.</b><li><<a href='h is under consideration but ._sst makes clear that this is not a regular file to be worked on, and thus less likely that people will have processing. It may be however that when the resulting file is shared .ssc is an appropriate -suffix to use. </li><b>.</b><li>.B SiSU has worked this way in the past, though this was dropped -as it was thought the complexity outweighed the flexibility, however, the -balance was rather fine and this behaviour could be reinstated. </li><b>.</b><li><<a href='http://www.postgresql.org/'>http://www.postgresql.org/</a> -> -<<a href='http://advocacy.postgresql.org/'>http://advocacy.postgresql.org/</a> +suffix to use. </li><b>.</b><li><<a href='http://www.postgresql.org/'>http://www.postgresql.org/</a> +> <<a href='http://advocacy.postgresql.org/'>http://advocacy.postgresql.org/</a> > <<a href='http://en.wikipedia.org/wiki/Postgresql'>http://en.wikipedia.org/wiki/Postgresql</a> -> </li><b>.</b><li><<a href='http://www.hwaci.com/sw/sqlite/'>http://www.hwaci.com/sw/sqlite/</a> > -<<a href='http://en.wikipedia.org/wiki/Sqlite'>http://en.wikipedia.org/wiki/Sqlite</a> +</li><b>.</b><li><<a href='http://www.hwaci.com/sw/sqlite/'>http://www.hwaci.com/sw/sqlite/</a> +> <<a href='http://en.wikipedia.org/wiki/Sqlite'>http://en.wikipedia.org/wiki/Sqlite</a> > </li><b>.</b><li><<a href='http://search.sisudoc.org'>http://search.sisudoc.org</a> -> </li><b>.</b><li>(which could -be extended further with current back-end). As regards scaling of the database, -it is as scalable as the database (here Postgresql) and hardware allow. -</li><b>.</b><li>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 +> +</li><b>.</b><li>(which could be extended further with current back-end). As regards scaling +of the database, it is as scalable as the database (here Postgresql) and +hardware allow. </li><b>.</b><li>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. </li><b>.</b><li>There is nothing to stop MySQL support @@ -3316,7 +3305,7 @@ are authors’ works that while freely distributable are not freely changeab <p> </dd> <dt>Source digest: </dt> -<dd><i>MD5(sisu.ssm.sst)=</i> 2a794c5f8a7df8d6a216025243d432d6 +<dd><i>MD5(sisu.ssm.sst)=</i> fd741a3ccf160aa55b942d76bd4e3f2a <p> </dd> @@ -3332,7 +3321,7 @@ are authors’ works that while freely distributable are not freely changeab <dt>Document (dal) last generated: </dt> <dd> -<p><i>Fri</i> Mar 05 20:04:20 -0500 2010 +<p><i>Wed</i> Mar 17 13:34:15 -0400 2010 <p> </dd> <dt>Other versions of this document: </dt> @@ -3350,31 +3339,37 @@ are authors’ works that while freely distributable are not freely changeab </dt> <dd></dd> -<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu/portrait.pdf'>http://www.jus.uio.no/sisu/sisu/portrait.pdf</a> +<dt>epub: <<a href='http://www.jus.uio.no/sisu/epub/sisu.epub'><a href='http://www.jus.uio.no/sisu/epub/sisu.epub'>http://www.jus.uio.no/sisu/epub/sisu.epub</a> </a> > </dt> <dd></dd> -<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu/landscape.pdf'>http://www.jus.uio.no/sisu/sisu/landscape.pdf</a> +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu/portrait.pdf'>http://www.jus.uio.no/sisu/sisu/portrait.pdf</a> </a> > </dt> +<dd></dd> + +<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu/landscape.pdf'>http://www.jus.uio.no/sisu/sisu/landscape.pdf</a> +</a> +> </dt> <dd> </dd> <dt>at: <<a href='http://www.jus.uio.no/sisu'><a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> </a> -> </dt> +> +</dt> <dd></dd> -<dt>* Generated by: SiSU 0.70.2 of 2008w50/2 (2008-12-16) -</dt> +<dt>* Generated by: SiSU 2.0.0 of 2010w09/6 (2010-03-06) </dt> <dd></dd> -<dt>* Ruby version: ruby 1.8.7 (2008-08-11 patchlevel 72) [i486-linux] </dt> +<dt>* Ruby version: ruby 1.8.7 +(2010-01-10 patchlevel 249) [i486-linux] </dt> <dd></dd> -<dt>* Last Generated -on: Tue Dec 16 00:16:50 -0500 2008 </dt> +<dt>* Last Generated on: Wed Mar 17 13:34:17 +-0400 2010 </dt> <dd></dd> <dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> diff --git a/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu.ssm b/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu.ssm index 2f8392f1..230c247c 100644 --- a/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu.ssm +++ b/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu.ssm @@ -26,7 +26,7 @@ :breaks: new=C; break=1 :skin: skin_sisu_manual :bold: /Gnu|Debian|Ruby|SiSU/ - :manpage: name=sisu - documents: markup, structuring, publishing in multiple standard formats, and search; synopsis=sisu [-abcDdFehIiMmNnopqRrSsTtUuVvwXxYyZz0-9] [filename/wildcard ] . sisu [-Ddcv] [instruction] . sisu [-CcFLSVvW] . sisu --v2 [operations] . sisu --v1 [operations] + :manpage: name=sisu - documents: markup, structuring, publishing in multiple standard formats, and search; synopsis=sisu [-abcDdFehIiMmNnopqRrSsTtUuVvwXxYyZz0-9] [filename/wildcard] . sisu [-Ddcv] [instruction] [filename/wildcard] . sisu [-CcFLSVvW] . sisu --v2 [operations] . sisu --v1 [operations] @links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ @@ -44,6 +44,8 @@ :B~ What is SiSU? +% << sisu_synopsis.ssi + << sisu_introduction.sst % :B~? SiSU Commands diff --git a/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_commands.sst b/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_commands.sst index d60a1cc8..9e4417ea 100644 --- a/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_commands.sst +++ b/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_commands.sst @@ -45,21 +45,9 @@ 1~commands Commands Summary -2~ Synopsis - -SiSU - Structured information, Serialized Units - a document publishing system - -sisu [ -abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0-9 ] [ filename/ wildcard ] - -sisu [ -Ddcv ] [ instruction ] - -sisu [ -CcFLSVvW ] - -Note: commands should be issued from within the directory that contains the marked up files, cd to markup directory. - 2~ Description -SiSU SiSU is a document publishing system, that from a simple single marked-up document, produces multiple of output formats including: plaintext, html, LaTeX, pdf, xhtml, XML, info, and SQL (PostgreSQL and SQLite), which share numbered text objects ("object citation numbering") and the same document structure information. For more see: http://www.jus.uio.no/sisu +SiSU SiSU is a document publishing system, that from a simple single marked-up document, produces multiple of output formats including: plaintext, html, xhtml, XML, epub, odt (odf text), LaTeX, pdf, info, and SQL (PostgreSQL and SQLite), which share numbered text objects ("object citation numbering") and the same document structure information. For more see: http://www.jus.uio.no/sisu % 2~ Summary of man page diff --git a/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_description.sst b/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_description.sst index 5cd8c602..fe3b5c46 100644 --- a/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_description.sst +++ b/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_description.sst @@ -58,15 +58,15 @@ SiSU is a flexible document preparation, generation publishing and search system 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. -Using markup applied to a document, SiSU can produce plain text, HTML, XHTML, XML, OpenDocument, LaTeX or PDF files, and populate an SQL database with objects~{ objects include: headings, paragraphs, verse, tables, images, but not footnotes/endnotes which are numbered separately and tied to the object from which they are referenced. }~ (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 "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. +Using markup applied to a document, SiSU can produce plain text, HTML, XHTML, XML, OpenDocument, EPUB, LaTeX or PDF files, and populate an SQL database with objects~{ objects include: headings, paragraphs, verse, tables, images, but not footnotes/endnotes which are numbered separately and tied to the object from which they are referenced. }~ (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 "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 is the data/information structuring and transforming tool, that has resulted from work on one of the oldest law web projects. It makes possible the one time, simple human readable markup of documents, that SiSU can then publish in various forms, suitable for paper~{ pdf via LaTeX or lout }~, web~{ currently html (two forms of html presentation one based on css the other on tables), and /PHP/; potentially structured XML }~ and relational database~{ any SQL - currently PostgreSQL and /sqlite/ (for portability, testing and development) }~ presentations, retaining common data-structure and meta-information across the output/presentation formats. Several requirements of legal and scholarly publication on the web have been addressed, including the age old need to be able to reliably cite/pinpoint text within a document, to easily make footnotes/endnotes, to allow for semantic document meta-tagging, and to keep required markup to a minimum. These and other features of interest are listed and described below. A few points are worth making early (and will be repeated a number of times): +SiSU is the data/information structuring and transforming tool, that has resulted from work on one of the oldest law web projects. It makes possible the one time, simple human readable markup of documents, that SiSU can then publish in various forms, suitable for paper~{ pdf via LaTeX }~, web~{ currently html (two forms of html presentation one based on css the other on tables), and /PHP/; potentially structured XML }~ and relational database~{ any SQL - currently PostgreSQL and /sqlite/ (for portability, testing and development) }~ presentations, retaining common data-structure and meta-information across the output/presentation formats. Several requirements of legal and scholarly publication on the web have been addressed, including the age old need to be able to reliably cite/pinpoint text within a document, to easily make footnotes/endnotes, to allow for semantic document meta-tagging, and to keep required markup to a minimum. These and other features of interest are listed and described below. A few points are worth making early (and will be repeated a number of times): _1 (i) The SiSU document generator was the first to place material on the web with a system that makes possible citation across different document types, with paragraph, or rather object citation numbering~{ previously called "text object numbering" }~ a text positioning system, available for the pinpointing of text, 1997, a simple idea from which much benefit, and SiSU remains today, to the best of my knowledge, the only multiple format e-book/ electronic-document system on the web that gives you this possibility (including for relational databases). _1 (ii) Markup is done once for the multiple formats produced. -_1 (iii) Markup is simple, and human readable (with a little practice), in almost all cases there is less and simpler markup required than basic html. In any event the markup required is very much simpler than the html, LaTeX, [lout], structured XML, ODF (OpenDocument), PostgreSQL or SQLite feed etc. that you can have SiSU generate for you. +_1 (iii) Markup is simple, and human readable (with a little practice), in almost all cases there is less and simpler markup required than basic html. In any event the markup required is very much simpler than the html, EPUB, LaTeX, [lout], structured XML, ODF (OpenDocument), PostgreSQL or SQLite feed etc. that you can have SiSU generate for you. _1 (iv) SiSU is a batch processor, dealing with as many files as you need to generate at a time. @@ -76,11 +76,11 @@ SiSU Sabaki~{ SiSU Sabaki, release version. Pre-release version SiSU Scribe, and SiSU was born of the need to find a way, with minimal effort, and for as wide a range of document types as possible, to produce high quality publishing output in a variety of document formats. As such it was necessary to find a simple document representation that would work across a large number of document types, and the most convenient way(s) to produce acceptable output formats. The project leading to this program was started in 1993 (together with the trade law project now known as Lex Mercatoria) as an investigation of how to effectively/efficiently place documents on the web. The unified document handling, together with features such as paragraph numbering, endnote handling and tables... appeared in 1996/97. SiSU was originally written in Perl,~{ http://www.perl.org/ }~ and converted to Ruby,~{ http://www.ruby-lang.org/en/ }~ in 2000, one of the most impressive programming languages in existence! In its current form it has been written to run on the Gnu/Linux platform, and in particular on Debian,~{ http://www.debian.org/ }~ taking advantage of many of the wonderful projects that are available there. -SiSU markup is based on requiring the minimum markup needed to determine the structure of a document. (This can be as little as saying in a header to look for the word Book at a specified level and the word Chapter at another level). SiSU then breaks a document into its smallest parts (at a heading, and paragraph level) while retaining all structural information. This break up of the document and information on its structure is taken advantage of in the transformations made in generating the very different output types that can be created, and in providing as much as can be for what each output type is best at doing, e.g. LaTeX (professional document typesetting, easy conversion to pdf or Postscript), XML (in this case, structural representation), ODF (OpenDocument [experimental]), SQL (e.g. document search; representing constituent parts of documents based on their structure, headings, chapters, paragraphs as required; user control).~{ where explicit structure is provided through the use of tagging headings, it could be reduced (still) further, for example by reducing the number of characters used to identify heading levels; but in many cases even that information is not required as regular expressions can be used to extract the implicit structure. }~ +SiSU markup is based on requiring the minimum markup needed to determine the structure of a document. (This can be as little as saying in a header to look for the word Book at a specified level and the word Chapter at another level). SiSU then breaks a document into its smallest parts (at a heading, and paragraph level) while retaining all structural information. This break up of the document and information on its structure is taken advantage of in the transformations made in generating the very different output types that can be created, and in providing as much as can be for what each output type is best at doing, e.g. LaTeX (professional document typesetting, easy conversion to pdf or Postscript), EPUB, XML (in this case, structural representation), ODF (OpenDocument [experimental]), SQL (e.g. document search; representing constituent parts of documents based on their structure, headings, chapters, paragraphs as required; user control).~{ where explicit structure is provided through the use of tagging headings, it could be reduced (still) further, for example by reducing the number of characters used to identify heading levels; but in many cases even that information is not required as regular expressions can be used to extract the implicit structure. }~ From markup that is simpler and more sparse than html you get: -_* far greater output possibilities, including html, XML, ODF (OpenDocument), LaTeX (pdf), and SQL; +_* far greater output possibilities, including html, EPUB, XML, ODF (OpenDocument), LaTeX (pdf), and SQL; _* the advantages implicit in the very different output possibilities; @@ -88,7 +88,7 @@ _* a common citation system (for all outputs - including the relational database For more see the short summary of features provided below. -SiSU processes files with minimal tagging to produce various document outputs including html, LaTeX or lout (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 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). @@ -109,10 +109,10 @@ notes: * markup defines document structure (this may be done once in a header pattern-match description, or for heading levels individually); basic text attributes (bold, italics, underscore, strike-through etc.) as required; and semantic information related to the document (header information, extended beyond the Dublin core and easily further extended as required); the headers may also contain processing instructions. !_ (iii) -(a) multiple outputs primarily industry established and institutionally accepted open standard formats, include amongst others: plaintext (UTF-8); html; (structured) XML; ODF (Open Document text)l; LaTeX; PDF (via LaTeX); SQL type databases (currently PostgreSQL and SQLite). Also produces: concordance files; document content certificates (md5 or sha256 digests of headings, paragraphs, images etc.) and html manifests (and sitemaps of content). (b) takes advantage of the strengths implicit in these very different output types, (e.g. PDFs produced using typesetting of LaTeX, databases populated with documents at an individual object/paragraph level, making possible granular search (and related possibilities)) +(a) multiple outputs primarily industry established and institutionally accepted open standard formats, include amongst others: plaintext (UTF-8); html; EPUB; (structured) XML; ODF (Open Document text)l; LaTeX; PDF (via LaTeX); SQL type databases (currently PostgreSQL and SQLite). Also produces: concordance files; document content certificates (md5 or sha256 digests of headings, paragraphs, images etc.) and html manifests (and sitemaps of content). (b) takes advantage of the strengths implicit in these very different output types, (e.g. PDFs produced using typesetting of LaTeX, databases populated with documents at an individual object/paragraph level, making possible granular search (and related possibilities)) !_ (iv) -outputs share a common numbering system (dubbed "object citation numbering" (ocn)) that is meaningful (to man and machine) across various digital outputs whether paper, screen, or database oriented, (PDF, html, XML, sqlite, postgresql), this numbering system can be used to reference content. +outputs share a common numbering system (dubbed "object citation numbering" (ocn)) that is meaningful (to man and machine) across various digital outputs whether paper, screen, or database oriented, (PDF, html, EPUB, XML, Opendocument, sqlite, postgresql), this numbering system can be used to reference content. !_ (v) SQL databases are populated at an object level (roughly headings, paragraphs, verse, tables) and become searchable with that degree of granularity, the output information provides the object/paragraph numbers which are relevant across all generated outputs; it is also possible to look at just the matching paragraphs of the documents in the database; [output indexing also work well with search indexing tools like hyperesteier]. @@ -147,7 +147,7 @@ possible to pre-process, which permits: the easy creation of standard form docum there is a considerable degree of future-proofing, output representations are "upgradeable", and new document formats may be added. !_ (xv) -there is a considerable degree of future-proofing, output representations are "upgradeable", and new document formats may be added: (a) modular, (thanks in no small part to Ruby) another output format required, write another module.... (b) easy to update output formats (eg html, XHTML, LaTeX/PDF produced can be updated in program and run against whole document set), (c) easy to add, modify, or have alternative syntax rules for input, should you need to, +there is a considerable degree of future-proofing, output representations are "upgradeable", and new document formats may be added: (a) modular, (thanks in no small part to Ruby) another output format required, write another module.... (b) easy to update output formats (eg html, XHTML, EPUB, LaTeX/PDF produced can be updated in program and run against whole document set), (c) easy to add, modify, or have alternative syntax rules for input, should you need to, !_ (xvi) scalability, dependent on your file-system (ext3, Reiserfs, XFS, whatever) and on the relational database used (currently Postgresql and SQLite), and your hardware, @@ -168,7 +168,7 @@ remote operations: (a) run SiSU on a remote server, (having prepared sisu markup document source may be bundled together (automatically) with associated documents (multiple language versions or master document with inclusions) and images and sent as a zip file called a sisupod, if shared on the net these too may be processed locally to produce the desired document outputs, these may be downloaded, shared as email attachments, or processed by running sisu against them, either using a url or the filename. !_ (xxii) -for basic document generation, the only software dependency is Ruby, and a few standard Unix tools (this covers plaintext, html, XML, ODF, LaTeX). To use a database you of course need that, and to convert the LaTeX generated to PDF, a LaTeX processor like tetex or texlive. +for basic document generation, the only software dependency is Ruby, and a few standard Unix tools (this covers plaintext, html, EPUB, XML, ODF, LaTeX). To use a database you of course need that, and to convert the LaTeX generated to PDF, a LaTeX processor like tetex or texlive. as a developers tool it is flexible and extensible @@ -176,7 +176,7 @@ SiSU was developed in relation to legal documents, and is strong across a wide v SiSU has been developed and has been in use for several years. Requirements to cover a wide range of documents within its use domain have been explored. -Some modules are more mature than others, the most mature being Html and LaTeX / pdf. PostgreSQL and search functions are useable and together with /ocn/ unique (to the best of my knowledge). The XML output document set is "well formed" but largely proof of concept. +Some modules are more mature than others, the most mature being html and LaTeX / pdf. PostgreSQL and search functions are useable and together with /ocn/ unique (to the best of my knowledge). The XML output document set is "well formed" but largely proof of concept. 2~ How it works @@ -184,7 +184,7 @@ SiSU markup is fairly minimalistic, it consists of: a (largely optional) documen 2~ Simple markup -SiSU markup is based on requiring the minimum markup needed to determine the structure of a document. (This can be as little as saying in a header to look for the word Book at a specified level and the word Chapter at another level). SiSU then breaks a document into its smallest parts (at a heading, and paragraph level) while retaining all structural information. This break up of the document and information on its structure is taken advantage of in the transformations made in generating the very different output types that can be created, and in providing as much as can be for what each output type is best at doing, e.g. LaTeX (professional document typesetting, easy conversion to pdf or Postscript), XML (in this case, structural representation), ODF (OpenDocument), SQL (e.g. document search; representing constituent parts of documents based on their structure, headings, chapters, paragraphs as required; user control).~{ where explicit structure is provided through the use of tagging headings, it could be reduced (still) further, for example by reducing the number of characters used to identify heading levels; but in many cases even that information is not required as regular expressions can be used to extract the implicit structure. }~ +SiSU markup is based on requiring the minimum markup needed to determine the structure of a document. (This can be as little as saying in a header to look for the word Book at a specified level and the word Chapter at another level). SiSU then breaks a document into its smallest parts (at a heading, and paragraph level) while retaining all structural information. This break up of the document and information on its structure is taken advantage of in the transformations made in generating the very different output types that can be created, and in providing as much as can be for what each output type is best at doing, e.g. LaTeX (professional document typesetting, easy conversion to pdf or Postscript), EPUB, XML (in this case, structural representation), ODF (OpenDocument), SQL (e.g. document search; representing constituent parts of documents based on their structure, headings, chapters, paragraphs as required; user control).~{ where explicit structure is provided through the use of tagging headings, it could be reduced (still) further, for example by reducing the number of characters used to identify heading levels; but in many cases even that information is not required as regular expressions can be used to extract the implicit structure. }~ 3~ Sparse markup requirement, try to get the most out of markup @@ -270,7 +270,7 @@ The object citation number markers contain additional numbering information with An advantage is that the numbering remains the same regardless of document structure. -Text object ("paragraph") numbering is the same for all output versions of the same document, vis html, pdf, pgsql, yaml etc. +Text object ("paragraph") numbering is the same for all output versions of the same document, vis html, epub, pdf, pgsql, etc. In the relational database, as individual text objects of a document stored (and indexed) together with object numbers, and all versions of the document have the same numbering, the results of searches may be tailored just to provide the location of the search result in all available document formats. @@ -431,6 +431,10 @@ _* {~^ *w3m* }http://w3m.sourceforge.net/ The html tables output is rendered more accurately across a wider variety set and older versions of browsers (than the html css output). +3~ EPUB + +SiSU generates EPUB documents. + 3~ XML SiSU generates well formed XML, and multiple versions. An XML SAX version with a flat/shallow structure, and XML DOM version with a deeper (embedded) structure. There is also a released working xhtml module. Examples of SAX and DOM versions are provided within this document. @@ -478,7 +482,7 @@ This is a larger scale project, (with little development on the front end largel {~^ Sample search frontend }http://search.sisudoc.org A small database and sample query front-end (search from) that makes use of the citation system, _{object citation numbering}_ to demonstrates functionality.~{ (which could be extended further with current back-end). As regards scaling of the database, it is as scalable as the database (here Postgresql) and hardware allow. }~ -SiSU can provide information on which documents are matched and at what locations within each document the matches are found. These results are relevant across all outputs using object citation numbering, which includes html, XML, LaTeX, PDF and indeed the SQL database. You can then refer to one of the other outputs or in the SQL database expand the text within the matched objects (paragraphs) in the documents matched. +SiSU can provide information on which documents are matched and at what locations within each document the matches are found. These results are relevant across all outputs using object citation numbering, which includes html, EPUB, XML, LaTeX, PDF and indeed the SQL database. You can then refer to one of the other outputs or in the SQL database expand the text within the matched objects (paragraphs) in the documents matched. (further work needs to be done on the sample search form, which is rudimentary and only passes simple booleans correctly at present to the SQL engine) @@ -507,7 +511,7 @@ Expand those same searches, showing the matching text in each document: 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. }~ !_ OCN index mode, -(object citation number) the numbers displayed are relevant (and may be used to reference the match) in any sisu generated rendition of the text~{ OCN are provided for HTML, XML, pdf ... though currently omitted in plain-text and opendocument format output }~ the links provided are to the locations of matches within the html generated by SiSU. +(object citation number) the numbers displayed are relevant (and may be used to reference the match) in any sisu generated rendition of the text~{ OCN are provided for HTML, XML, EPUB, pdf ... though currently omitted in plain-text and opendocument format output }~ the links provided are to the locations of matches within the html generated by SiSU. !_ Paragraph mode, you may alternatively display the text of each paragraph in which the match was made, again the object/paragraph numbers are relevant to any SiSU generated/published text. diff --git a/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_help_sources.sst b/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_help_sources.sst index 12e75603..edd4699e 100644 --- a/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_help_sources.sst +++ b/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_help_sources.sst @@ -87,7 +87,7 @@ _1 man sisu_webrick 2~ sisu generated output - links to html -Note SiSU documentation is prepared in SiSU and output is available in multiple formats including amongst others html, pdf, and odf which may be also be accessed via the html pages~{ named index.html or more extensively through sisu_manifest.html }~ +Note SiSU documentation is prepared in SiSU and output is available in multiple formats including amongst others html, pdf, odf and epub, which may be also be accessed via the html pages~{ named index.html or more extensively through sisu_manifest.html }~ 3~ www.sisudoc.org @@ -147,21 +147,21 @@ _1 http://sisudoc.org/sisu/sisu_webrick/index.html 3~ locally installed -file:///usr/share/doc/sisu/html/sisu.1.html +file:///usr/share/doc/sisu/v2/html/sisu.1.html -file:///usr/share/doc/sisu/html/sisu_help.1.html +file:///usr/share/doc/sisu/v2/html/sisu_help.1.html -file:///usr/share/doc/sisu/html/sisu_help_sources.1.html +file:///usr/share/doc/sisu/v2/html/sisu_help_sources.1.html -_1 /usr/share/doc/sisu/html/sisu.1.html +_1 /usr/share/doc/sisu/v2/html/sisu.1.html -_1 /usr/share/doc/sisu/html/sisu_pdf.7.html +_1 /usr/share/doc/sisu/v2/html/sisu_pdf.7.html -_1 /usr/share/doc/sisu/html/sisu_postgresql.7.html +_1 /usr/share/doc/sisu/v2/html/sisu_postgresql.7.html -_1 /usr/share/doc/sisu/html/sisu_sqlite.7.html +_1 /usr/share/doc/sisu/v2/html/sisu_sqlite.7.html -_1 /usr/share/doc/sisu/html/sisu_webrick.1.html +_1 /usr/share/doc/sisu/v2/html/sisu_webrick.1.html 3~ www.jus.uio.no/sisu diff --git a/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_howto.sst b/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_howto.sst index 991244dc..597dfbc3 100644 --- a/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_howto.sst +++ b/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_howto.sst @@ -139,7 +139,7 @@ aptitude install sisu-sqlite ideally copy the sisu-examples directory to your home directory (because the directory in which you run this example should be writable) -cp -rv /usr/share/sisu-examples/sample/document_samples_sisu_markup ~/. +cp -rv /usr/share/doc/sisu-markup-samples/v2/samples /. !_ (3) use sisu to create an sqlite database @@ -180,7 +180,7 @@ sisu -F webrick the string should be provided as output from the previous command -sudo cp -vi /usr/share/sisu-examples/sample/document_samples_sisu_markup/sisu_sqlite.cgi /usr/lib/cgi-bin +sudo cp -vi /usr/share/doc/sisu-markup-samples/v2/samples/sisu_sqlite.cgi /usr/lib/cgi-bin sudo chmod -v 755 /usr/lib/cgi-bin/sisu_sqlite.cgi @@ -301,7 +301,7 @@ _1 data/sisu-examples/sample/document_samples_sisu_markup/ or the same once source is installed (or sisu-examples) under: -_1 /usr/share/sisu-examples/sample/document_samples_sisu_markup/ +_1 /usr/share/doc/sisu-markup-samples/v2/samples Some notes are contained within the man page, *{man sisu}* and within sisu help via the commands *{sisu help markup}* and *{sisu help headers}* @@ -572,7 +572,7 @@ and on installation under: _1 /etc/sisu/skin/doc/ -_1 /usr/share/sisu-examples/sample/document_samples_sisu_markup/_sisu/skin/doc +_1 /usr/share/doc/sisu-markup-samples/v2/samples/_sisu/skin/doc The following paths are searched: @@ -630,7 +630,7 @@ Homepage: http://www.jus.uio.no/sisu SiSU is lightweight markup based document creation and publishing framework that is controlled from the command line. Prepare documents for SiSU using your text editor of choice, then use SiSU to generate various output document formats. -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. +With minimal preparation of a plain-text (UTF-8) file using its native markup-syntax, SiSU produces: plain-text, HTML, XHTML, EPUB, 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. Outputs share a common citation numbering system, and any semantic meta-data provided about the document. @@ -874,17 +874,16 @@ Description: documents - structuring, publishing in multiple formats and search structuring, publishing and search framework for document collections. . With minimal preparation of a plain-text, (UTF-8) file, using its native - markup syntax in your text editor of choice, SiSU can generate various - document formats (most of which share a common object numbering system for - locating content), including plain text, HTML, XHTML, XML, OpenDocument text - (ODF:ODT), LaTeX, PDF files, and populate an SQL database with objects - (roughly paragraph-sized chunks) so searches may be performed and matches - returned with that degree of granularity: your search criteria is met by these - documents and at these locations within each document. Object numbering 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. Document outputs also share semantic meta-data - provided. +markup syntax in your text editor of choice, SiSU can generate various document +formats (most of which share a common object numbering system for locating +content), including plain text, HTML, XHTML, EPUB, XML, OpenDocument text +(ODF:ODT), LaTeX, PDF files, and populate an SQL database with objects (roughly +paragraph-sized chunks) so searches may be performed and matches returned with +that degree of granularity: your search criteria is met by these documents and +at these locations within each document. Object numbering 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. Document outputs also share semantic meta-data provided. . SiSU also provides concordance files, document content certificates and manifests of generated output. @@ -1014,7 +1013,7 @@ the first document). After installation of sisu-complete, move to the document samples directory -_1 cd /usr/share/doc/sisu/sisu_markup_samples/dfsg +_1 cd /usr/share/doc/sisu/v2/sisu_markup_samples/samples and run @@ -1169,7 +1168,7 @@ _1 ./data/doc/sisu/sisu_markup_samples/dfsg These are installed on the system usually at: -_1 /usr/share/doc/sisu/sisu_markup_samples/dfsg +_1 /usr/share/doc/sisu/v2/sisu_markup_samples/samples More markup samples are available in the package sisu-markup-samples @@ -1187,7 +1186,7 @@ _1 ./data/sisu/conf/syntax usually installed to: -_1 /usr/share/sisu/conf/syntax +_1 /usr/share/sisu/v2/conf/syntax 2~ License @@ -1231,7 +1230,7 @@ _1 http://www.jus.uio.no/sisu/SiSU/changelog_markup_samples.html After installation of sisu-complete, move to the document samples directory, -_1 cd /usr/share/doc/sisu/sisu_markup_samples/dfsg +_1 cd /usr/share/doc/sisu/v2/sisu_markup_samples/samples [this is not where you would normally work but provides sample documents for testing, you may prefer instead to copy the contents of that directory to a local @@ -1303,7 +1302,7 @@ _1 mkdir ~/sisu_test _1 cd ~/sisu_test -_1 cp -a /usr/share/doc/sisu/sisu_markup_samples/dfsg/* ~/sisu_test/. +_1 cp -a /usr/share/doc/sisu/v2/sisu_markup_samples/samples/* ~/sisu_test/. !_ Tip: the markup syntax examples may be of interest @@ -1349,7 +1348,7 @@ Package: sisu SiSU is a lightweight markup based, command line oriented, document structuring, publishing and search framework for document collections. -With minimal preparation of a plain-text, (UTF-8) file, using its native markup syntax in your text editor of choice, SiSU can generate various document formats (most of which share a common object numbering system for locating content), including plain text, HTML, XHTML, XML, OpenDocument text (ODF:ODT), LaTeX, PDF files, and populate an SQL database with objects (roughly paragraph-sized chunks) so searches may be performed and matches returned with that degree of granularity: your search criteria is met by these documents and at these locations within each document. Object numbering 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. Document outputs also share semantic meta-data provided. +With minimal preparation of a plain-text, (UTF-8) file, using its native markup syntax in your text editor of choice, SiSU can generate various document formats (most of which share a common object numbering system for locating content), including plain text, HTML, XHTML, XML, OpenDocument text (ODF:ODT), EPUB, LaTeX, PDF files, and populate an SQL database with objects (roughly paragraph-sized chunks) so searches may be performed and matches returned with that degree of granularity: your search criteria is met by these documents and at these locations within each document. Object numbering 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. Document outputs also share semantic meta-data provided. SiSU also provides concordance files, document content certificates and manifests of generated output. diff --git a/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_introduction.sst b/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_introduction.sst index bd4af2ae..e2df51d0 100644 --- a/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_introduction.sst +++ b/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_introduction.sst @@ -48,17 +48,17 @@ SiSU 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. -SiSU 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. +SiSU is developed under an open source, software libre license (GPL3). Its use case for development is work with medium to large document sets and cope with evolving document formats/ representation technologies. Documents are prepared once, and generated as need be to update the technical presentation or add additional output formats. Various output formats (including search related output) share a common mechanism for cross-output-format citation. -SiSU both defines a markup syntax and provides an engine that produces open standards format outputs from documents prepared with SiSU 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's structure and content from which it is possible to generate different forms of representation of the document. Significantly SiSU 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. SiSU is also able to populate SQL type databases at an object level, which means that searches can be made with that degree of granularity. +SiSU both defines a markup syntax and provides an engine that produces open standards format outputs from documents prepared with SiSU 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's structure and content from which it is possible to generate different forms of representation of the document. Significantly SiSU markup is more sparse than html and outputs which include html, EPUB, LaTeX, landscape and portrait pdfs, Open Document Format (ODF), all of which can be added to and updated. SiSU is also able to populate SQL type databases at an object level, which means that searches can be made with that degree of granularity. -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 SiSU markup applied to a document, SiSU 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~{ objects include: headings, paragraphs, verse, tables, images, but not footnotes/endnotes which are numbered separately and tied to the object from which they are referenced. }~ (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 "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. +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 SiSU markup applied to a document, SiSU 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, EPUB, OpenDocument, LaTeX or PDF files, and populate an SQL database with objects~{ objects include: headings, paragraphs, verse, tables, images, but not footnotes/endnotes which are numbered separately and tied to the object from which they are referenced. }~ (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 "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. -In preparing a SiSU 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~{ i.e. the html, pdf, odf outputs are each built individually and optimised for that form of presentation, rather than for example the html being a saved version of the odf, or the pdf being a saved version of the html. }~ the different forms of output requested. +In preparing a SiSU 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~{ i.e. the html, pdf, epub, odf outputs are each built individually and optimised for that form of presentation, rather than for example the html being a saved version of the odf, or the pdf being a saved version of the html. }~ the different forms of output requested. -SiSU works with an abstraction of the document based on its structure which is comprised of its structure (or frame)~{ the different heading levels }~ and the objects~{ units of text, primarily paragraphs and headings, also any tables, poems, code-blocks }~ it contains, which enables SiSU 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'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. +SiSU works with an abstraction of the document based on its structure which is comprised of its headings~{ the different heading levels }~ and objects~{ units of text, primarily paragraphs and headings, also any tables, poems, code-blocks }~, which enables SiSU 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 basis 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's default font or using a different browser can mean that text will appear on a different page; and publishing in different formats, html, landscape and portrait pdf etc. again page numbers are not useful to cite text. Dealing with documents at an object level together with object numbering also has implications for search that SiSU is able to take advantage of. -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. SiSU provides the flexibility of outputing documents in multiple non-proprietary open formats including html, pdf~{ Specification submitted by Adobe to ISO to become a full open ISO specification <br> http://www.linux-watch.com/news/NS7542722606.html }~ and the ISO standard ODF.~{ ISO/IEC 26300:2006 }~ Whilst SiSU 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 SiSU can be migrated to other document formats. Further security is provided by the fact that the software itself, SiSU 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. SiSU 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). +One of the challenges of maintaining documents is to keep them in a format that allows use of them independently of proprietary platforms. Consider issues related to 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. SiSU provides the flexibility of producing documents in multiple non-proprietary open formats including html, pdf~{ Specification submitted by Adobe to ISO to become a full open ISO specification <br> http://www.linux-watch.com/news/NS7542722606.html }~ ODF,~{ ISO standard ISO/IEC 26300:2006 }~ and EPUB.~{ An open standard format for e-books }~ Whilst SiSU 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 SiSU can be migrated to other document formats. Further security is provided by the fact that the software itself, SiSU 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. SiSU 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), EPUB was introduced in 2009; and allows the technical representations 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). 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. diff --git a/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_markup.sst b/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_markup.sst index 5b6ac4aa..c155e027 100644 --- a/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_markup.sst +++ b/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_markup.sst @@ -436,7 +436,7 @@ _# numbered list numbered list indented a., b., c., d., etc. 2~ Footnotes / Endnotes -Footnotes and endnotes not distinguished in markup. They are automatically numbered. Depending on the output file format (html, odf, pdf etc.), the document output selected will have either footnotes or endnotes. +Footnotes and endnotes not distinguished in markup. They are automatically numbered. Depending on the output file format (html, EPUB, odf, pdf etc.), the document output selected will have either footnotes or endnotes. !_ markup example: diff --git a/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_output_overview.sst b/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_output_overview.sst index fcf35855..ea995c36 100644 --- a/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_output_overview.sst +++ b/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_output_overview.sst @@ -50,7 +50,7 @@ This table gives an indication of the features that are available for various forms of output of SiSU. -!_ sisu-0.72.0 on 2009-10-28 +!_ sisu-2.0.0 on 2010-03-06 {table~h 28} feature |txt|ltx/pdf|HTML|EPUB|XML/s|XML/d|ODF|SQLite|pgSQL @@ -81,6 +81,37 @@ auto-heading numbers | * | * | * | * | * | * | * | * | * minor list numbering | * | * | * | * | * | * | * | * | * special characters | . | . | . | . | | | | | +!_ sisu-1.0.0 on 2009-10-28 + +{table~h 28} +feature |txt|ltx/pdf|HTML|XML/s|XML/d|ODF|SQLite|pgSQL +headings | * | * | * | * | * | * | * | * +footnotes | * | * | * | * | * | * | * | * +bold, underscore, italics | . | * | * | * | * | * | * | * +strikethrough | . | * | * | * | * | * | | +superscript, subscript | . | * | * | * | * | * | | +extended ascii set (utf-8)| * | * | * | * | * | * | | * +indents | * | * | * | * | * | * | | +bullets | . | * | * | * | * | . | | +groups | | | | | | | | +* tables | | * | * | . | . | . | . | . +* poem | * | * | * | . | . | * | . | . +* code | * | * | * | . | . | * | . | . +url | * | * | * | * | * | * | . | . +links | * | * | * | * | * | * | . | . +images | - | * | * | T | T | * | T | T +image caption | - | * | * | | | | | +table of contents | | * | * | * | * | . | | +page header/footer? | - | * | * | * | * | t | | +line break | * | * | * | * | * | * | | +page break | | * | | | | * | | +segments | | | * | | | | | +skins | * | * | * | * | * | | | +ocn | . | * | * | * | * | -?| * | * +auto-heading numbers | * | * | * | * | * | * | * | * +minor list numbering | * | * | * | * | * | * | * | * +special characters | . | . | . | | | | | + !_ sisu-0.36.6 on 2006-01-23 {table~h 28; 8; 8; 8; 8; 8; 8; 8; 8; 8;} diff --git a/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_quickstart.sst b/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_quickstart.sst index 1467bd47..a31c0f9f 100644 --- a/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_quickstart.sst +++ b/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_quickstart.sst @@ -126,7 +126,7 @@ _* Unpack the source Two alternative modes of installation from source are provided, setup.rb (by Minero Aoki) and a rant(by Stefan Lang) built install file, in either case: the first steps are the same, download and unpack the source file: -For basic use SiSU is only dependent on the programming language in which it is written Ruby, and SiSU will be able to generate html, various XMLs, including ODF (and will also produce LaTeX). Dependencies required for further actions, though it relies on the installation of additional dependencies which the source tarball does not take care of, for things like using a database (postgresql or sqlite)~{ There is nothing to stop MySQL support being added in future. }~ or converting LaTeX to pdf. +For basic use SiSU is only dependent on the programming language in which it is written Ruby, and SiSU will be able to generate html, EPUB, various XMLs, including ODF (and will also produce LaTeX). Dependencies required for further actions, though it relies on the installation of additional dependencies which the source tarball does not take care of, for things like using a database (postgresql or sqlite)~{ There is nothing to stop MySQL support being added in future. }~ or converting LaTeX to pdf. !_ setup.rb @@ -193,7 +193,7 @@ change directory to the appropriate one: cd /usr/share/doc/sisu/sisu_markup_samples/dfsg -3~ basic text, plaintext, html, XML, ODF +3~ basic text, plaintext, html, XML, ODF, EPUB Having moved to the directory that contains the markup samples (see instructions above if necessary), choose a file and run sisu against it diff --git a/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_search_cgi.ssi b/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_search_cgi.ssi index 982a6c54..e93f1e2b 100644 --- a/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_search_cgi.ssi +++ b/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_search_cgi.ssi @@ -51,7 +51,7 @@ {~^ Sample search frontend }http://search.sisudoc.org A small database and sample query front-end (search from) that makes use of the citation system, _{object citation numbering}_ to demonstrates functionality.~{ (which could be extended further with current back-end). As regards scaling of the database, it is as scalable as the database (here Postgresql) and hardware allow. }~ -SiSU can provide information on which documents are matched and at what locations within each document the matches are found. These results are relevant across all outputs using object citation numbering, which includes html, XML, LaTeX, PDF and indeed the SQL database. You can then refer to one of the other outputs or in the SQL database expand the text within the matched objects (paragraphs) in the documents matched. +SiSU can provide information on which documents are matched and at what locations within each document the matches are found. These results are relevant across all outputs using object citation numbering, which includes html, XML, EPUB, LaTeX, PDF and indeed the SQL database. You can then refer to one of the other outputs or in the SQL database expand the text within the matched objects (paragraphs) in the documents matched. 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. }~ diff --git a/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_short_feature_summary.ssi b/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_short_feature_summary.ssi index 72ec2370..0009352e 100644 --- a/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_short_feature_summary.ssi +++ b/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_short_feature_summary.ssi @@ -51,7 +51,7 @@ _* sparse/minimal markup (clean utf-8 source texts). Documents are prepared in a _* markup is easily readable/parsable by the human eye, (basic markup is simpler and more sparse than the most basic HTML), [this may also be converted to XML representations of the same input/source document]. -_* markup defines document structure (this may be done once in a header pattern-match description, or for heading levels individually); basic text attributes (bold, italics, underscore, strike-through etc.) as required; and semantic information related to the document (header information, extended beyond the Dublin core and easily further extended as required); the headers may also contain processing instructions. SiSU markup is primarily an abstraction of document structure and document metadata to permit taking advantage of the basic strengths of existing alternative practical standard ways of representing documents [be that browser viewing, paper publication, sql search etc.] (html, xml, odf, latex, pdf, sql) +_* markup defines document structure (this may be done once in a header pattern-match description, or for heading levels individually); basic text attributes (bold, italics, underscore, strike-through etc.) as required; and semantic information related to the document (header information, extended beyond the Dublin core and easily further extended as required); the headers may also contain processing instructions. SiSU markup is primarily an abstraction of document structure and document metadata to permit taking advantage of the basic strengths of existing alternative practical standard ways of representing documents [be that browser viewing, paper publication, sql search etc.] (html, epub, xml, odf, latex, pdf, sql) _* for output produces reasonably elegant output of established industry and institutionally accepted open standard formats.[3] takes advantage of the different strengths of various standard formats for representing documents, amongst the output formats currently supported are: @@ -59,6 +59,8 @@ _1* html - both as a single scrollable text and a segmented document _1* xhtml +_1* epub + _1* XML - both in sax and dom style xml structures for further development as required _1* ODF - open document format, the iso standard for document storage @@ -71,11 +73,11 @@ _1* sql - population of an sql database, (at the same object level that is used Also produces: concordance files; document content certificates (md5 or sha256 digests of headings, paragraphs, images etc.) and html manifests (and sitemaps of content). (b) takes advantage of the strengths implicit in these very different output types, (e.g. PDFs produced using typesetting of LaTeX, databases populated with documents at an individual object/paragraph level, making possible granular search (and related possibilities)) -_* ensuring content can be cited in a meaningful way regardless of selected output format. Online publishing (and publishing in multiple document formats) lacks a useful way of citing text internally within documents (important to academics generally and to lawyers) as page numbers are meaningless across browsers and formats. sisu seeks to provide a common way of pinpoint the text within a document, (which can be utilized for citation and by search engines). The outputs share a common numbering system that is meaningful (to man and machine) across all digital outputs whether paper, screen, or database oriented, (pdf, HTML, xml, sqlite, postgresql), this numbering system can be used to reference content. +_* ensuring content can be cited in a meaningful way regardless of selected output format. Online publishing (and publishing in multiple document formats) lacks a useful way of citing text internally within documents (important to academics generally and to lawyers) as page numbers are meaningless across browsers and formats. sisu seeks to provide a common way of pinpoint the text within a document, (which can be utilized for citation and by search engines). The outputs share a common numbering system that is meaningful (to man and machine) across all digital outputs whether paper, screen, or database oriented, (pdf, HTML, EPUB, xml, sqlite, postgresql), this numbering system can be used to reference content. _* Granular search within documents. SQL databases are populated at an object level (roughly headings, paragraphs, verse, tables) and become searchable with that degree of granularity, the output information provides the object/paragraph numbers which are relevant across all generated outputs; it is also possible to look at just the matching paragraphs of the documents in the database; [output indexing also work well with search indexing tools like hyperestraier]. -_* long term maintainability of document collections in a world of changing formats, having a very sparsely marked-up source document base. there is a considerable degree of future-proofing, output representations are "upgradeable", and new document formats may be added. e.g. addition of odf (open document text) module in 2006 and in future html5 output sometime in future, without modification of existing prepared texts +_* long term maintainability of document collections in a world of changing formats, having a very sparsely marked-up source document base. there is a considerable degree of future-proofing, output representations are "upgradeable", and new document formats may be added. e.g. addition of odf (open document text) module in 2006, epub in 2009 and in future html5 output sometime in future, without modification of existing prepared texts _* SQL search aside, documents are generated as required and static once generated. @@ -87,7 +89,7 @@ _* document source may be bundled together (automatically) with associated docum _* generated document outputs may automatically be posted to remote sites. -_* for basic document generation, the only software dependency is Ruby, and a few standard Unix tools (this covers plaintext, HTML, XML, ODF, LaTeX). To use a database you of course need that, and to convert the LaTeX generated to pdf, a latex processor like tetex or texlive. +_* for basic document generation, the only software dependency is Ruby, and a few standard Unix tools (this covers plaintext, HTML, EPUB, XML, ODF, LaTeX). To use a database you of course need that, and to convert the LaTeX generated to pdf, a latex processor like tetex or texlive. _* as a developers tool it is flexible and extensible diff --git a/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_skin.sst b/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_skin.sst index dfc5c4a6..9cff0ed7 100644 --- a/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_skin.sst +++ b/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_skin.sst @@ -92,11 +92,11 @@ A site skin, modifies the program default skin. With SiSU installed sample skins may be found in: -_1 /etc/sisu/skin/doc and /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc +_1 /etc/sisu/skin/doc and /usr/share/doc/sisu/v2/sisu_markup_samples/samples/_sisu/skin/doc (or equivalent directory) and if sisu-markup-samples is installed also under: -_1 /usr/share/doc/sisu/sisu_markup_samples/non-free/_sisu/skin/doc +_1 /usr/share/doc/sisu-markup-samples/v2/samples/_sisu/skin/doc Samples of list.yml and promo.yml (which are used to create the right column list) may be found in: diff --git a/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_synopsis.ssi b/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_synopsis.ssi new file mode 100644 index 00000000..909cb2c2 --- /dev/null +++ b/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_synopsis.ssi @@ -0,0 +1,64 @@ +% SiSU 2.0 + +@title: SiSU + :subtitle: Commands + +@creator: :author: Amissah, Ralph + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@classify: + :type: information + :topic_register: electronic documents:SiSU:document:commands;SiSU:manual:commands;electronic documents:SiSU:manual:commands;SiSU:document:commands;SiSU:document:commands + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +% used_by: sisu_manual SiSU.ssm + +@date: + :created: 2002-08-28 + :issued: 2002-08-28 + :available: 2002-08-28 + :published: 2007-09-16 + :modified: 2009-12-16 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { 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 + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? SiSU Commands + +1~ Synopsis + +SiSU - Structured information, Serialized Units - a document publishing system + +sisu [ -abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0-9 ] [ filename/ wildcard ] + +sisu [ -Ddcv ] [ instruction ] + +sisu [ -CcFLSVvW ] + +Note: commands should be issued from within the directory that contains the marked up files, cd to markup directory. + +sisu is at version 2, to use sisu version 1 + +sisu --v1 [and options/operations as above] + +for settings see sisu --help env + +sisu [ filename/ wildcard] == sisu -0 [filename/wildcard] diff --git a/data/sisu/v2/conf/editor-syntax-etc/vim/syntax/sisu.vim b/data/sisu/v2/conf/editor-syntax-etc/vim/syntax/sisu.vim index 23f557bf..d1b1fcc6 100644 --- a/data/sisu/v2/conf/editor-syntax-etc/vim/syntax/sisu.vim +++ b/data/sisu/v2/conf/editor-syntax-etc/vim/syntax/sisu.vim @@ -34,7 +34,7 @@ if !exists("sisu_no_identifiers") syn match sisu_sub_header_classify "^\s\+:\(type\|subject\|topic_register\|keywords\|coverage\|relation\|format\|identifier\|isbn\|dewey\|loc\|pg\):\s" syn match sisu_sub_header_dates "^\s\+:\(published\|available\|created\|issued\|valid\|modified\|added_to_site\|translated\|original_publication\):\s" syn match sisu_sub_header_original "^\s\+:\(publisher\|date\|language\|institution\|nationality\|source\):\s" - syn match sisu_sub_header_make "^\s\+:\(headings\|num_top\|breaks\|italics\|bold\|skin\|promo\|ad\|manpage\):\s" + syn match sisu_sub_header_make "^\s\+:\(headings\|num_top\|breaks\|italics\|bold\|skin\|stamp\|promo\|ad\|manpage\):\s" syn match sisu_sub_header_notes "^\s\+:\(comment\|abstract\|description\|history\|prefix\|prefix_[ab]\):\s" syn match sisu_sem_marker ";{\|};[a-z._]*[a-z]" syn match sisu_sem_marker_block "\([a-z][a-z._]*\|\):{\|}:[a-z._]*[a-z]" |