diff options
| author | Ralph Amissah <ralph@amissah.com> | 2011-03-10 09:07:26 -0500 |
|---|---|---|
| committer | Ralph Amissah <ralph@amissah.com> | 2011-03-10 09:07:26 -0500 |
| commit | 57ad1a1e1e5c31669eedd8c319f9ba5feb1aab6f (patch) | |
| tree | c7ac0716f007aea6da3b79a5ccafde6efd6fed37 | |
| parent | documentation more link fixes (remove redundant), remove repeated skin (diff) | |
manpage: sisu.1 and html regenerated
| -rw-r--r-- | data/doc/sisu/html/sisu.1.html | 4734 | ||||
| -rw-r--r-- | man/man1/sisu.1 | 2452 |
2 files changed, 4001 insertions, 3185 deletions
diff --git a/data/doc/sisu/html/sisu.1.html b/data/doc/sisu/html/sisu.1.html index 1a598784..357adb3b 100644 --- a/data/doc/sisu/html/sisu.1.html +++ b/data/doc/sisu/html/sisu.1.html @@ -7,280 +7,310 @@ </head> <body bgcolor='white'> <a href='#toc'>Table of Contents</a><p> +<br> <h2><a name='sect0' href='#toc0'>Name</a></h2> -sisu - documents: markup, structuring, publishing in multiple standard -formats, and search +<br> +sisu - documents: markup, structuring, publishing in multiple standard formats, +and search <br> + <h2><a name='sect1' href='#toc1'>Synopsis</a></h2> -sisu [-abcDdFehIiMmNnopqRrSsTtUuVvwXxYyZz0-9] -[filename/wildcard] -<p> sisu [-Ddcv] [instruction] [filename/wildcard] -<p> sisu -[-CcFLSVvW] -<p> sisu --v2 [operations] -<p> sisu --v3 [operations] -<p> sisu3 [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 +<br> +sisu [-abcDdFehIiMmNnopqRrSsTtUuVvwXxYyZz0-9] [filename/wildcard] +<p> <br> +sisu [-Ddcv] [instruction] [filename/wildcard] +<p> <br> +sisu [-CcFLSVvW] +<p> <br> +sisu --v2 [operations] +<p> <br> +sisu --v3 [operations] +<p> <br> +sisu3 [operations] +<h2><a name='sect2' href='#toc2'>Sisu - Manual,</a></h2> +RALPH AMISSAH <br> + +<p> +<h2><a name='sect3' href='#toc3'>What is Sisu?</a></h2> +<br> + +<p> +<h2><a name='sect4' href='#toc4'>1. Introduction - What is Sisu?</a></h2> +<br> + +<p> <br> +<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, 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> +<p> <br> +<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> <br> +<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> <br> +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, 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> <br> +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> <br> +<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> <br> +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> <br> +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> <br> +<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> <br> +<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> <br> <<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> > -<p> <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> +<p> <br> +<<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> > -<p> 2. COMMANDS SUMMARY -<p> 2.1 - -<p>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, 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> +<h2><a name='sect5' href='#toc5'>2. Commands Summary</a></h2> +<br> + +<p> +<h2><a name='sect6' href='#toc6'>2.1 Description</a></h2> + +<p> <br> +<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, +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.2 DOCUMENT PROCESSING COMMAND FLAGS + +<p> +<h2><a name='sect7' href='#toc7'>2.2 Document Processing Command Flags</a></h2> + <p> <dl> -<dt><b>-a [filename/wildcard]</b> -</dt> -<dd>produces plaintext with Unix linefeeds and without markup, (object numbers -are omitted), has footnotes at end of each paragraph that contains them -[ -A for equivalent dos (linefeed) output file] [see -e for -A endnotes]. (Options -include: --endnotes for endnotes --footnotes for footnotes at the end of each -paragraph --unix for unix linefeed (default) --msdos for msdos linefeed) +<dt><b>-a [filename/wildcard]</b> </dt> +<dd>produces plaintext +with Unix linefeeds and without markup, (object numbers are omitted), has +footnotes at end of each paragraph that contains them [ -A for equivalent + dos (linefeed) output file] [see -e for -A endnotes]. (Options include: --endnotes +for endnotes --footnotes for footnotes at the end of each paragraph --unix +for unix linefeed (default) --msdos for msdos linefeed) <p> </dd> -<dt><b>-b -[filename/wildcard]</b> </dt> -<dd>see --xhtml +<dt><b>-b [filename/wildcard]</b> +</dt> +<dd> +<p>see --xhtml <p> </dd> <dt><b>--color-toggle [filename/wildcard]</b> </dt> -<dd>screen toggle -ansi screen colour on or off depending on default set (unless -c flag is -used: if sisurc colour default is set to ’true’, output to screen will be -with colour, if sisurc colour default is set to ’false’ or is undefined screen -output will be without colour). Alias -c +<dd>screen toggle ansi screen colour +on or off depending on default set (unless -c flag is used: if sisurc colour +default is set to ’true’, output to screen will be with colour, if sisurc +colour default is set to ’false’ or is undefined screen output will be without +colour). Alias -c <p> </dd> -<dt><b>--concordance [filename/wildcard]</b> -</dt> -<dd>produces concordance (wordmap) a rudimentary index of all the words in -a document. (Concordance files are not generated for documents of over 260,000 -words unless this limit is increased in the file sisurc.yml). Alias -w +<dt><b>--concordance [filename/wildcard]</b> </dt> +<dd>produces concordance (wordmap) +a rudimentary index of all the words in a document. (Concordance files are +not generated for documents of over 260,000 words unless this limit is +increased in the file sisurc.yml). Alias -w <p> </dd> -<dt><b>-C -[--init-site]</b> </dt> -<dd>configure/initialise shared output directory files initialize -shared output directory (config files such as css and dtd files are not -updated if they already exist unless modifier is used). -C --init-site configure/initialise -site more extensive than -C on its own, shared output directory files/force -update, existing shared output config files such as css and dtd files are -updated if this modifier is used. +<dt><b>-C [--init-site]</b> </dt> +<dd>configure/initialise +shared output directory files initialize shared output directory (config +files such as css and dtd files are not updated if they already exist unless +modifier is used). -C --init-site configure/initialise site more extensive than +-C on its own, shared output directory files/force update, existing shared +output config files such as css and dtd files are updated if this modifier +is used. <p> </dd> <dt><b>-CC</b> </dt> -<dd>configure/initialise shared output -directory files initialize shared output directory (config files such as -css and dtd files are not updated if they already exist unless modifier -is used). The equivalent of: -C --init-site configure/initialise site, more -extensive than -C on its own, shared output directory files/force update, -existing shared output config files such as css and dtd files are updated -if -CC is used. -<p> </dd> - -<dt><b>-c [filename/wildcard]</b> </dt> -<dd>see --color-toggle +<dd>configure/initialise shared output directory files initialize +shared output directory (config files such as css and dtd files are not +updated if they already exist unless modifier is used). The equivalent of: +-C --init-site configure/initialise site, more extensive than -C on its own, +shared output directory files/force update, existing shared output config +files such as css and dtd files are updated if -CC is used. <p> </dd> -<dt><b>--dal [filename/wildcard/url]</b> +<dt><b>-c [filename/wildcard]</b> </dt> -<dd>assumed for most other flags, creates new intermediate files for processing -(document abstraction) that is used in all subsequent processing of other -output. This step is assumed for most processing flags. To skip it see -n. - -<p>Alias -m +<dd> +<p>see --color-toggle <p> </dd> -<dt><b>--delete [filename/wildcard]</b> </dt> -<dd>see --zap +<dt><b>--dal [filename/wildcard/url]</b> </dt> +<dd>assumed for most other flags, +creates new intermediate files for processing (document abstraction) that +is used in all subsequent processing of other output. This step is assumed +for most processing flags. To skip it see -n. Alias -m <p> </dd> -<dt><b>-D [instruction] [filename]</b> +<dt><b>--delete [filename/wildcard]</b> </dt> <dd> -<p>see --pg +<p>see --zap <p> </dd> -<dt><b>-d [--db-[database type (sqlite|pg)]] --[instruction] [filename]</b> </dt> -<dd>see --sqlite - +<dt><b>-D [instruction] [filename]</b> </dt> +<dd>see --pg <p> </dd> -<dt><b>--epub [filename/wildcard]</b> </dt> -<dd>produces an epub document, [sisu version 2 only] -(filename.epub). Alias -e +<dt><b>-d [--db-[database type (sqlite|pg)]] +--[instruction] [filename]</b> </dt> +<dd>see --sqlite <p> </dd> -<dt><b>-e [filename/wildcard]</b> </dt> -<dd>see --epub +<dt><b>--epub [filename/wildcard]</b> </dt> +<dd>produces +an epub document, [sisu version 2 only] (filename.epub). Alias -e <p> </dd> -<dt><b>-F [--webserv=webrick]</b> +<dt><b>-e [filename/wildcard]</b> </dt> <dd> -<p>see --sample-search-form +<p>see --epub <p> </dd> -<dt><b>--git [filename/wildcard]</b> </dt> -<dd>produces or updates markup -source file structure in a git repo (experimental and subject to change). +<dt><b>-F [--webserv=webrick]</b> </dt> +<dd>see --sample-search-form +<p> </dd> -<p>Alias -g +<dt><b>--git [filename/wildcard]</b> +</dt> +<dd>produces or updates markup source file structure in a git repo (experimental +and subject to change). Alias -g <p> </dd> <dt><b>-g [filename/wildcard]</b> </dt> <dd>see --git <p> </dd> -<dt><b>--harvest *.ss[tm]</b> </dt> -<dd>makes two lists -of sisu output based on the sisu markup documents in a directory: list -of author and authors works (year and titles), and; list by topic with -titles and author. Makes use of header metadata fields (author, title, date, -topic_register). Can be used with maintenance (-M) and remote placement (-R) -flags. +<dt><b>--harvest +*.ss[tm]</b> </dt> +<dd>makes two lists of sisu output based on the sisu markup documents +in a directory: list of author and authors works (year and titles), and; +list by topic with titles and author. Makes use of header metadata fields +(author, title, date, topic_register). Can be used with maintenance (-M) +and remote placement (-R) flags. <p> </dd> <dt><b>--help [topic]</b> </dt> -<dd>provides help on the selected topic, where topics (keywords) -include: list, (com)mands, short(cuts), (mod)ifiers, (env)ironment, markup, -syntax, headers, headings, endnotes, tables, example, customise, skin, -(dir)ectories, path, (lang)uage, db, install, setup, (conf)igure, convert, -termsheet, search, sql, features, license +<dd>provides help on the selected +topic, where topics (keywords) include: list, (com)mands, short(cuts), +(mod)ifiers, (env)ironment, markup, syntax, headers, headings, endnotes, +tables, example, customise, skin, (dir)ectories, path, (lang)uage, db, +install, setup, (conf)igure, convert, termsheet, search, sql, features, + +<p>license <p> </dd> <dt><b>--html [filename/wildcard]</b> </dt> -<dd>produces -html output, segmented text with table of contents (toc.html and index.html) -and the document in a single file (scroll.html). Alias -h +<dd>produces html output, segmented text +with table of contents (toc.html and index.html) and the document in a single +file (scroll.html). Alias -h <p> </dd> -<dt><b>-h [filename/wildcard]</b> -</dt> -<dd> -<p>see --html +<dt><b>-h [filename/wildcard]</b> </dt> +<dd>see --html <p> </dd> -<dt><b>-I [filename/wildcard]</b> </dt> -<dd>see --texinfo +<dt><b>-I [filename/wildcard]</b> +</dt> +<dd> +<p>see --texinfo <p> </dd> <dt><b>-i [filename/wildcard]</b> </dt> @@ -289,97 +319,97 @@ and the document in a single file (scroll.html). Alias -h <dt><b>-L</b> </dt> <dd>prints license information. + <p> </dd> -<dt><b>--machine [filename/wildcard/url]</b> -</dt> +<dt><b>--machine [filename/wildcard/url]</b> </dt> <dd>see --dal (document abstraction level/layer) + <p> </dd> -<dt><b>--maintenance [filename/wildcard/url]</b> -</dt> -<dd>maintenance mode files created for processing preserved and their locations -indicated. (also see -V). Alias -M +<dt><b>--maintenance [filename/wildcard/url]</b> </dt> +<dd>maintenance mode files created for +processing preserved and their locations indicated. (also see -V). Alias -M + <p> </dd> <dt><b>--manpage [filename/wildcard]</b> </dt> -<dd>produces man -page of file, not suitable for all outputs. Alias -i +<dd>produces man page of file, not suitable for +all outputs. Alias -i <p> </dd> -<dt><b>-M [filename/wildcard/url]</b> -</dt> -<dd> -<p>see --maintenance +<dt><b>-M [filename/wildcard/url]</b> </dt> +<dd>see --maintenance <p> </dd> -<dt><b>-m [filename/wildcard/url]</b> </dt> -<dd>see --dal (document abstraction -level/layer) +<dt><b>-m [filename/wildcard/url]</b> +</dt> +<dd>see --dal (document abstraction level/layer) <p> </dd> <dt><b>--no-ocn</b> </dt> -<dd>[with --html --pdf or --epub] switches off object citation -numbering. Produce output without identifying numbers in margins of html -or LaTeX/pdf output. +<dd>[with --html --pdf or --epub] +switches off object citation numbering. Produce output without identifying +numbers in margins of html or LaTeX/pdf output. <p> </dd> -<dt><b>-N [filename/wildcard/url]</b> </dt> -<dd>document digest or document -content certificate ( DCC ) as md5 digest tree of the document: the digest -for the document, and digests for each object contained within the document -(together with information on software versions that produced it) (digest.txt). --NV for verbose digest output to screen. +<dt><b>-N [filename/wildcard/url]</b> +</dt> +<dd>document digest or document content certificate ( DCC ) as md5 digest tree +of the document: the digest for the document, and digests for each object +contained within the document (together with information on software versions +that produced it) (digest.txt). -NV for verbose digest output to screen. <p> </dd> -<dt><b>-n [filename/wildcard/url]</b> </dt> -<dd>skip -the creation of intermediate processing files (document abstraction) if -they already exist, this skips the equivalent of -m which is otherwise assumed -by most processing flags. +<dt><b>-n +[filename/wildcard/url]</b> </dt> +<dd>skip the creation of intermediate processing files +(document abstraction) if they already exist, this skips the equivalent +of -m which is otherwise assumed by most processing flags. <p> </dd> -<dt><b>--odf [filename/wildcard/url]</b> </dt> -<dd>see --odt -<p> </dd> - -<dt><b>--odt [filename/wildcard/url]</b> +<dt><b>--odf [filename/wildcard/url]</b> </dt> -<dd>output basic document in opendocument file format (opendocument.odt). Alias +<dd> +<p>see --odt +<p> </dd> -<p>- -<p>o +<dt><b>--odt [filename/wildcard/url]</b> </dt> +<dd>output basic document in opendocument +file format (opendocument.odt). Alias -o <p> </dd> <dt><b>-o [filename/wildcard/url]</b> </dt> <dd>see --odt + <p> </dd> <dt><b>--pdf [filename/wildcard]</b> </dt> -<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 +<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 <p> </dd> -<dt><b>--pg [instruction] -[filename]</b> </dt> -<dd>database postgresql ( --pgsql may be used instead) possible instructions, -include: --createdb; --create; --dropall; --import [filename]; --update [filename]; ---remove [filename]; see database section below. Alias -D +<dt><b>--pg [instruction] [filename]</b> </dt> +<dd>database postgresql ( --pgsql +may be used instead) possible instructions, include: --createdb; --create; +--dropall; --import [filename]; --update [filename]; --remove [filename]; see database +section below. Alias -D <p> </dd> -<dt><b>--po [language_directory/filename - language_directory]</b> </dt> -<dd>see --po4a +<dt><b>--po [language_directory/filename language_directory]</b> +</dt> +<dd> +<p>see --po4a <p> </dd> -<dt><b>--po4a [language_directory/filename language_directory]</b> -</dt> -<dd>produces .pot and po files for the file in the languages specified by the -language directory. <b>SiSU</b> markup is placed in subdirectories named with the -language code, e.g. en/ fr/ es/. The sisu config file must set the output -directory structure to multilingual. v3, experimental +<dt><b>--po4a [language_directory/filename language_directory]</b> </dt> +<dd>produces +.pot and po files for the file in the languages specified by the language +directory. <b>SiSU</b> markup is placed in subdirectories named with the language +code, e.g. en/ fr/ es/. The sisu config file must set the output directory +structure to multilingual. v3, experimental <p> </dd> <dt><b>-P [language_directory/filename @@ -661,12 +691,14 @@ combination of -[mMvVq]), will remove the related document output directory. <dd>see --zap <p> </dd> </dl> -3. COMMAND LINE MODIFIERS + +<h2><a name='sect8' href='#toc8'>3. Command Line Modifiers</a></h2> +<br> + <p> <dl> -<dt><b>--no-ocn</b> -</dt> +<dt><b>--no-ocn</b> </dt> <dd>[with --html --pdf or --epub] switches off object citation numbering. Produce output without identifying numbers in margins of html or LaTeX/pdf output. @@ -690,20 +722,24 @@ output without identifying numbers in margins of html or LaTeX/pdf output. <p>denoted by dagger/plus sign <p> </dd> </dl> -4. DATABASE COMMANDS -<p> dbi - database interface -<p> -D or --pgsql set for postgresql -d or --sqlite default set for sqlite -d is -modifiable with --db=[database type (pgsql or sqlite)] +<h2><a name='sect9' href='#toc9'>4. Database Commands</a></h2> +<br> + +<p> <br> +dbi - database interface +<p> <br> +-D or --pgsql set for postgresql -d or --sqlite default set for sqlite -d is modifiable +with --db=[database type (pgsql or sqlite)] <p> <dl> <dt><b>--pg -v --createall</b> </dt> -<dd>initial -step, creates required relations (tables, indexes) in existing postgresql -database (a database should be created manually and given the same name -as working directory, as requested) (rb.dbi) [ -dv --createall it may be necessary -to run sisu -Dv --createdb initially NOTE: at the present time for postgresql +<dd>initial step, +creates required relations (tables, indexes) in existing postgresql database +(a database should be created manually and given the same name as working +directory, as requested) (rb.dbi) [ -dv --createall it may be necessary to +run sisu -Dv --createdb initially NOTE: at the present time for postgresql it may be necessary to manually create the database. The command would be ’createdb [database name]’ where database name would be SiSU_[present working directory name (without path)]. Please use only alphanumerics and underscores. @@ -730,10 +766,13 @@ db (rb.dbi) [ -d --remove sqlite equivalent] <dd>kills data" and drops (postgresql or sqlite) db, tables & indexes [ -d --dropall sqlite equivalent] -<p> The -v is for verbose output. +<p> <br> +The -v is for verbose output. <p> </dd> </dl> -5. SHORTCUTS, SHORTHAND FOR MULTIPLE FLAGS + +<h2><a name='sect10' href='#toc10'>5. Shortcuts, Shorthand for Multiple Flags</a></h2> +<br> <p> <dl> @@ -780,190 +819,239 @@ the sisurc.yml file): <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 -u for appended url info or -v for verbose +<p> <br> +add -v for verbose mode and -c for color, e.g. sisu -2vc [filename or +<p> <br> -<p>output +<p>consider -u 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. "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 - -<p>MANUAL -<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> -<p> The manual can be generated from source, found respectively, either -within the <b>SiSU</b> tarball or installed locally at: -<p> ./data/doc/sisu/markup-samples/sisu_manual<br> +<h2><a name='sect11' href='#toc11'>5.1 Command Line +with Flags - Batch Processing</a></h2> -<p> /usr/share/doc/sisu/markup-samples/sisu_manual<br> +<p> <br> +In the data directory run sisu -mh filename or wildcard eg. "sisu -h cisg.sst" +or "sisu -h *.{sst,ssm}" to produce html version of all documents. +<p> <br> +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> +<h2><a name='sect12' href='#toc12'>6. Help</a></h2> +<br> -<p> move to the respective directory and type e.g.: -<p> sisu sisu_manual.ssm<br> +<p> +<h2><a name='sect13' href='#toc13'>6.1 Sisu Manual</a></h2> + +<p> <br> +The most up to date information on sisu should be contained in the sisu_manual, +available at: +<p> <br> + <<a href='http://sisudoc.org/sisu/sisu_manual/'>http://sisudoc.org/sisu/sisu_manual/</a> +><br> -<p> 6.2 SISU MAN PAGES -<p> If <b>SiSU</b> is installed on your system usual man commands -should be available, try: -<p> man sisu<br> +<p> <br> +The manual can be generated from source, found respectively, either within +the <b>SiSU</b> tarball or installed locally at: +<p> <br> + ./data/doc/sisu/markup-samples/sisu_manual<br> -<p> man sisu_markup<br> +<p> <br> + /usr/share/doc/sisu/markup-samples/sisu_manual<br> -<p> man sisu_commands<br> +<p> <br> +move to the respective directory and type e.g.: +<p> <br> + sisu sisu_manual.ssm<br> -<p> Most <b>SiSU</b> man pages are generated directly from sisu documents that -are used to prepare the sisu manual, the sources files for which are located +<p> +<h2><a name='sect14' href='#toc14'>6.2 Sisu Man Pages</a></h2> + +<p> <br> +If <b>SiSU</b> is installed on your system usual man commands should be available, +try: +<p> <br> + man sisu<br> + +<p> <br> +Most <b>SiSU</b> man pages are generated directly from sisu documents that are +used to prepare the sisu manual, the sources files for which are located within the <b>SiSU</b> tarball at: -<p> ./data/doc/sisu/markup-samples/sisu_manual<br> +<p> <br> + ./data/doc/sisu/markup-samples/sisu_manual<br> -<p> Once installed, directory equivalent to: -<p> /usr/share/doc/sisu/markup-samples/sisu_manual<br> +<p> <br> +Once installed, directory equivalent to: +<p> <br> + /usr/share/doc/sisu/markup-samples/sisu_manual<br> -<p> Available man pages are converted back to html using man2html: -<p> /usr/share/doc/sisu/html/<br> +<p> <br> +Available man pages are converted back to html using man2html: +<p> <br> + /usr/share/doc/sisu/html/<br> -<p> ./data/doc/sisu/html<br> +<p> <br> + ./data/doc/sisu/html<br> -<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> +<p> <br> +An online version of the sisu man page is available here: +<p> <br> +* various sisu man pages <<a href='http://www.jus.uio.no/sisu/man/'>http://www.jus.uio.no/sisu/man/</a> > [^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> -> -[^9] -<p> 6.3 SISU BUILT-IN INTERACTIVE HELP -<p> This is particularly useful for -getting the current sisu setup/environment information: -<p> sisu --help<br> +<p> <br> +* 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> +> [^9] +<p> +<h2><a name='sect15' href='#toc15'>6.3 Sisu Built-in Interactive +Help</a></h2> -<p> sisu --help [subject]<br> +<p> <br> +This is particularly useful for getting the current sisu setup/environment +information: +<p> <br> + sisu --help<br> -<p> sisu --help commands<br> +<p> <br> + sisu --help [subject]<br> -<p> sisu --help markup<br> +<p> <br> + sisu --help commands<br> -<p> sisu --help env [for feedback on the way your system is <br> +<p> <br> + sisu --help markup<br> + +<p> <br> + sisu --help env [for feedback on the way your system is <br> setup with regard to sisu]<br> -<p> sisu -V [environment information, same as above command]<br> +<p> <br> + sisu -V [environment information, same as above command]<br> -<p> sisu (on its own provides version and some help information)<br> +<p> <br> + sisu (on its own provides version and some help information)<br> -<p> Apart from real-time information on your current configuration the <b>SiSU</b> +<p> <br> +Apart from real-time information on your current configuration the <b>SiSU</b> manual and man pages are likely to contain more up-to-date information than the sisu interactive help (for example on commands and markup). -<p> NOTE: -Running the command sisu (alone without any flags, filenames or wildcards) +<p> <br> +NOTE: Running the command 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.4 HELP SOURCES -<p> For lists of alternative help sources, -see: -<p> <b>man page</b> -<p> man sisu_help_sources<br> +<p> +<h2><a name='sect16' href='#toc16'>7. Introduction to Sisu Markup[^10]</a></h2> +<br> -<p> <b>man2html</b> -<p> /usr/share/doc/sisu/v2/html/sisu.1.html<br> +<p> +<h2><a name='sect17' href='#toc17'>7.1 Summary</a></h2> -<p> <b>sisu generated html</b> -<p> /usr/share/doc/sisu/html/sisu_help_sources/index.html<br> +<p> <br> +<b>SiSU</b> source documents are plaintext (UTF-8)[^11] files +<p> <br> +All paragraphs are separated by an empty line. +<p> <br> +Markup is comprised of: +<p> <br> +* at the top of a document, the document header made up of semantic meta-data +about the document and if desired additional processing instructions (such +an instruction to automatically number headings from a particular level +down) +<p> <br> +* followed by the prepared substantive text of which the most important +single characteristic is the markup of different heading levels, which +define the primary outline of the document structure. Markup of substantive +text includes: +<p> <br> + * heading levels defines document structure<br> -<p> <<a href='http://sisudoc.org/sisu/sisu_help_sources/index.html'>http://sisudoc.org/sisu/sisu_help_sources/index.html</a> -><br> +<p> <br> + * text basic attributes, italics, bold etc.<br> -<p> 7. INTRODUCTION TO SISU MARKUP[^10] -<p> 7.1 SUMMARY -<p> <b>SiSU</b> source documents -are plaintext (UTF-8)[^11] files -<p> All paragraphs are separated by an empty -line. -<p> Markup is comprised of: -<p> * at the top of a document, the document -header made up of semantic meta-data about the document and if desired additional -processing instructions (such an instruction to automatically number headings -from a particular level down) -<p> * followed by the prepared substantive -text of which the most important single characteristic is the markup of -different heading levels, which define the primary outline of the document -structure. Markup of substantive text includes: -<p> * heading levels defines -document structure<br> - -<p> * text basic attributes, italics, bold etc.<br> - -<p> * grouped text (objects), which are to be treated differently, such -as code<br> +<p> <br> + * grouped text (objects), which are to be treated differently, such as +code<br> blocks or poems.<br> -<p> * footnotes/endnotes<br> +<p> <br> + * footnotes/endnotes<br> -<p> * linked text and images<br> +<p> <br> + * linked text and images<br> -<p> * paragraph actions, such as indent, bulleted, numbered-lists, etc.<br> +<p> <br> + * paragraph actions, such as indent, bulleted, numbered-lists, etc.<br> -<p> Some interactive help on markup is available, by typing sisu and selecting +<p> <br> +Some interactive help on markup is available, by typing sisu and selecting <p>markup or sisu --help markup -<p> To check the markup in a file: -<p> sisu --identify -[filename].sst<br> +<p> <br> +To check the markup in a file: +<p> <br> + sisu --identify [filename].sst<br> -<p> For brief descriptive summary of markup history -<p> sisu --query-history<br> +<p> <br> -<p> or if for a particular version: -<p> sisu --query-0.38<br> +<p>For brief descriptive summary of markup history +<p> <br> + sisu --query-history<br> -<p> 7.2 MARKUP EXAMPLES -<p> 7.2.1 ONLINE -<p> Online markup examples are available -together with the respective outputs produced from <<a href='http://www.jus.uio.no/sisu/SiSU/examples.html'>http://www.jus.uio.no/sisu/SiSU/examples.html</a> -> -or from <<a href='http://www.jus.uio.no/sisu/sisu_examples/'>http://www.jus.uio.no/sisu/sisu_examples/</a> -> -<p> There is of course this -document, which provides a cursory overview of sisu markup and the respective -output produced: <<a href='http://www.jus.uio.no/sisu/sisu_markup/'>http://www.jus.uio.no/sisu/sisu_markup/</a> -> -<p> Some example marked -up files are available as html with syntax highlighting for viewing: <<a href='http://www.jus.uio.no/sisu/sample/syntax'>http://www.jus.uio.no/sisu/sample/syntax</a> +<p> <br> +or if for a particular version: +<p> <br> + sisu --query-0.38<br> + +<p> +<h2><a name='sect18' href='#toc18'>7.2 Markup Examples</a></h2> + +<p> +<h2><a name='sect19' href='#toc19'>7.2.1 Online</a></h2> + +<p> <br> +Online markup examples are available together with the respective outputs +produced from <<a href='http://www.jus.uio.no/sisu/SiSU/examples.html'>http://www.jus.uio.no/sisu/SiSU/examples.html</a> +> or from <<a href='http://www.jus.uio.no/sisu/sisu_examples/'>http://www.jus.uio.no/sisu/sisu_examples/</a> > -<p> an alternative presentation of markup syntax: <<a href='http://www.jus.uio.no/sisu/sample/on_markup.txt'>http://www.jus.uio.no/sisu/sample/on_markup.txt</a> +<p> <br> +There is of course this document, which provides a cursory overview of +sisu markup and the respective output produced: <<a href='http://www.jus.uio.no/sisu/sisu_markup/'>http://www.jus.uio.no/sisu/sisu_markup/</a> > -<p> 7.2.2 INSTALLED -<p> With <b>SiSU</b> installed sample skins may be found in: /usr/share/doc/sisu/sisu_markup_samples/dfsg +<p> <br> +an alternative presentation of markup syntax: /usr/share/doc/sisu/on_markup.txt.gz + +<p> +<h2><a name='sect20' href='#toc20'>7.2.2 Installed</a></h2> + +<p> <br> +With <b>SiSU</b> installed sample skins may be found in: /usr/share/doc/sisu/markup-samples (or equivalent directory) and if sisu-markup-samples is installed also under: -<p>/usr/share/doc/sisu/sisu_markup_samples/non-free -<p> 8. MARKUP OF HEADERS +<p>/usr/share/doc/sisu/markup-samples-non-free <p> - Headers contain either: semantic meta-data about a document, which can -be used by any output module of the program, or; processing instructions. +<h2><a name='sect21' href='#toc21'>8. Markup of Headers</a></h2> +<br> -<p> Note: the first line of a document may include information on the markup +<p> <br> +Headers contain either: semantic meta-data about a document, which can be +used by any output module of the program, or; processing instructions. +<p> +<br> +Note: the first line of a document may include information on the markup version used in the form of a comment. Comments are a percentage mark at the start of a paragraph (and as the first character in a line of text) followed by a space and the comment: -<p> <p> <br> <pre> % this would be a comment </pre> -<p> 8.1 SAMPLE HEADER -<p> This current document is loaded by a master document -that has a header similar to this one: <p> +<h2><a name='sect22' href='#toc22'>8.1 Sample Header</a></h2> + +<p> <br> +This current document is loaded by a master document that has a header +similar to this one: <p> <br> <pre> % SiSU master 2.0 @title: SiSU @@ -977,12 +1065,14 @@ that has a header similar to this one: electronic document, electronic citation, data structure, citation systems, search % used_by: manual - @date: :published: 2008-05-22 + @date: + :published: 2008-05-22 :created: 2002-08-28 :issued: 2002-08-28 :available: 2002-08-28 :modified: 2010-03-03 - @make: :num_top: 1 + @make: + :num_top: 1 :breaks: new=C; break=1 :skin: skin_sisu_manual :bold: /Gnu|Debian|Ruby|SiSU/ @@ -993,36 +1083,41 @@ that has a header similar to this one: . sisu [-Ddcv] [instruction] . sisu [-CcFLSVvW] . sisu --v2 [operations] - . sisu --v1 [operations] - @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/ -</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), -or information as to how the document as a whole is to be processed. All -header instructions take the form @headername: or on the next line and -indented by once space :subheadername: All Dublin Core meta tags are available - -<p> <b>@indentifier:</b> information or instructions -<p> where the "identifier" is -a tag recognised by the program, and the "information" or "instructions" - -<p>belong to the tag/indentifier specified -<p> Note: a header where used should -only be used once; all headers apart from @title: are optional; the @structure: -header is used to describe document structure, and can be useful to know. - -<p> This is a sample header + . sisu --v3 [operations] + @links: + { SiSU Homepage }http://www.sisudoc.org/ + { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/ + { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary + { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +</pre> <p> +<h2><a name='sect23' href='#toc23'>8.2 Available Headers</a></h2> + +<p> <br> +Header tags appear at the beginning of a document and provide meta information +on the document (such as the Dublin Core), or information as to how the +document as a whole is to be processed. All header instructions take the +form @headername: or on the next line and indented by once space :subheadername: + +<p>All Dublin Core meta tags are available +<p> <br> +<b>@indentifier:</b> information or instructions +<p> <br> +where the "identifier" is a tag recognised by the program, and the "information" +or "instructions" belong to the tag/indentifier specified +<p> <br> +Note: a header where used should only be used once; all headers apart from +@title: are optional; the @structure: header is used to describe document +structure, and can be useful to know. +<p> <br> + +<p>This is a sample header <p> <br> <pre> % SiSU 2.0 [declared file-type identifier with markup version] </pre> @@ -1032,13 +1127,15 @@ header is used to describe document structure, and can be useful to know. :language: English </pre> <p> <br> -<pre> @creator: :author: [Lastname, First names] +<pre> @creator: + :author: [Lastname, First names] :illustrator: [Lastname, First names] :translator: [Lastname, First names] :prepared_by: [Lastname, First names] </pre> <p> <br> -<pre> @date: :published: [year or yyyy-mm-dd] +<pre> @date: + :published: [year or yyyy-mm-dd] :created: [year or yyyy-mm-dd] :issued: [year or yyyy-mm-dd] :available: [year or yyyy-mm-dd] @@ -1048,7 +1145,8 @@ header is used to describe document structure, and can be useful to know. :translated: [year or yyyy-mm-dd] </pre> <p> <br> -<pre> @rights: :copyright: Copyright (C) [Year and Holder] +<pre> @rights: + :copyright: Copyright (C) [Year and Holder] :license: [Use License granted] :text: [Year and Holder] :translation: [Name, Year] @@ -1064,8 +1162,8 @@ header is used to describe document structure, and can be useful to know. :abstract: :isbn: [ISBN] :loc: [Library of Congress classification] - :dewey: [Dewey classification - :pg: [Project Gutenberg text number] + :dewey: [Dewey classification] + :pg: [Project Gutenberg text number] </pre> <p> <br> <pre> @links: { SiSU }http://www.sisudoc.org @@ -1086,41 +1184,52 @@ generated] :italics: [regular expression of words/phrases to italicise] </pre> <p> <br> -<pre> @original: :language: [language] +<pre> @original: + :language: [language] </pre> <p> <br> -<pre> @notes: :comment: +<pre> @notes: + :comment: :prefix: [prefix is placed just after table of contents] </pre> -<p> 9. MARKUP OF SUBSTANTIVE TEXT -<p> 9.1 HEADING LEVELS -<p> Heading levels are -:A~ ,:B~ ,:C~ ,1~ ,2~ ,3~ ... :A - :C being part / section headings, followed -by other heading levels, and 1 -6 being headings followed by substantive -text or sub-headings. :A~ usually the title :A~? conditional level 1 heading -(used where a stand-alone document may be imported into another) -<p> <b>:A~ [heading - text]</b> Top level heading [this usually has similar content to the title - @title: ] NOTE: the heading levels described here are in 0.38 notation, - -<p>see heading -<p> <b>:B~ [heading text]</b> Second level heading [this is a heading - level divider] -<p> <b>:C~ [heading text]</b> Third level heading [this is a heading - level divider] -<p> <b>1~ [heading text]</b> Top level heading preceding substantive -text of document or sub-heading 2, the heading level that would normally -be marked 1. or 2. or 3. etc. in a document, and the level on which sisu by -default would break html output into named segments, names are provided -automatically if none are given (a number), otherwise takes the form 1~my_filename_for_this_segment - -<p> <b>2~ [heading text]</b> Second level heading preceding substantive text of -document or sub-heading 3 , the heading level that would normally be marked -1.1 or 1.2 or 1.3 or 2.1 etc. in a document. -<p> <b>3~ [heading text]</b> Third level -heading preceding substantive text of document, that would normally be -marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a document <p> +<h2><a name='sect24' href='#toc24'>9. Markup of Substantive Text</a></h2> +<br> + +<p> +<h2><a name='sect25' href='#toc25'>9.1 Heading Levels</a></h2> + +<p> <br> +Heading levels are :A~ ,:B~ ,:C~ ,1~ ,2~ ,3~ ... :A - :C being part / section +headings, followed by other heading levels, and 1 -6 being headings followed +by substantive text or sub-headings. :A~ usually the title :A~? conditional +level 1 heading (used where a stand-alone document may be imported into +another) +<p> <br> +<b>:A~ [heading text]</b> Top level heading [this usually has similar content + to the title @title: ] NOTE: the heading levels described here are in 0.38 +notation, see heading +<p> <br> +<b>:B~ [heading text]</b> Second level heading [this is a heading level divider] + +<p> <br> +<b>:C~ [heading text]</b> Third level heading [this is a heading level divider] + +<p> <br> +<b>1~ [heading text]</b> Top level heading preceding substantive text of document +or sub-heading 2, the heading level that would normally be marked 1. or 2. +or 3. etc. in a document, and the level on which sisu by default would break +html output into named segments, names are provided automatically if none +are given (a number), otherwise takes the form 1~my_filename_for_this_segment + +<p> <br> +<b>2~ [heading text]</b> Second level heading preceding substantive text of document +or sub-heading 3 , the heading level that would normally be marked 1.1 or +1.2 or 1.3 or 2.1 etc. in a document. +<p> <br> +<b>3~ [heading text]</b> Third level heading preceding substantive text of document, +that would normally be marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a document + <p> <br> <pre> 1~filename level 1 heading, % the primary division such as Chapter that is followed by substantive @@ -1129,249 +1238,340 @@ text, html % segments are made) </pre> -<p> 9.2 FONT ATTRIBUTES -<p> <b>markup example:</b> <p> +<h2><a name='sect26' href='#toc26'>9.2 Font Attributes</a></h2> + +<p> <br> +<b>markup example:</b> <p> <br> <pre> normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}", ^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}-, #{monospace}# normal text + *{emphasis}* [note: can be configured to be represented by bold, italics or underscore] + !{bold text}! + _{underscore}_ + /{italics}/ + "{citation}" + ^{superscript}^ + ,{subscript}, + +{inserted text}+ + -{strikethrough}- + #{monospace}# </pre> -<p> <b>resulting output:</b> -<p> normal text, <b>emphasis</b> , <b>bold text</b> , <i>italics</i> , <i>underscore</i> -, "citation", ^superscript^, [subscript], ++inserted text++, --strikethrough--, +<p> <br> +<b>resulting output:</b> +<p> <br> +normal text, <b>emphasis</b> , <b>bold text</b> , <i>italics</i> , <i>underscore</i> , "citation", +^superscript^, [subscript], ++inserted text++, --strikethrough--, monospace +<p> +<br> -<p>monospace -<p> normal text -<p> <b>emphasis</b> [note: can be configured to be represented - by bold, italics or underscore] -<p> <b>bold text</b> -<p> <i>italics</i> -<p> <i>underscore</i> -<p> "citation" +<p>normal text +<p> <br> +<b>emphasis</b> [note: can be configured to be represented by bold, italics or + underscore] +<p> <br> + +<p><b>bold text</b> +<p> <br> + +<p><i>italics</i> +<p> <br> -<p> ^superscript^ -<p> [subscript] -<p> ++inserted text++ -<p> --strikethrough-- -<p> monospace +<p><i>underscore</i> +<p> <br> +"citation" +<p> <br> +^superscript^ +<p> <br> +[subscript] +<p> <br> +++inserted text++ +<p> <br> +--strikethrough-- +<p> <br> -<p> 9.3 INDENTATION AND BULLETS -<p> <b>markup example:</b> +<p>monospace <p> +<h2><a name='sect27' href='#toc27'>9.3 Indentation and Bullets</a></h2> + +<p> <br> +<b>markup example:</b> <p> <br> <pre> ordinary paragraph + _1 indent paragraph one step + _2 indent paragraph two steps + _9 indent paragraph nine steps </pre> -<p> -<p> <b>resulting output:</b> -<p> ordinary paragraph -<p> indent paragraph one step<br> +<p> <br> +<b>resulting output:</b> +<p> <br> -<p> indent paragraph two steps<br> +<p>ordinary paragraph +<p> <br> + indent paragraph one step<br> -<p> indent paragraph nine steps<br> +<p> <br> + indent paragraph two steps<br> -<p> <b>markup example:</b> -<p> +<p> <br> + indent paragraph nine steps<br> + +<p> <br> +<b>markup example:</b> <p> <br> <pre> _* bullet text + _1* bullet text, first indent + _2* bullet text, two step indent </pre> -<p> <b>resulting output:</b> -<p> * bullet text -<p> * bullet text, first indent<br> +<p> <br> +<b>resulting output:</b> +<p> <br> +* bullet text +<p> <br> + * bullet text, first indent<br> -<p> * bullet text, two step indent<br> +<p> <br> + * bullet text, two step indent<br> -<p> Numbered List (not to be confused with headings/titles, (document structure)) +<p> <br> +Numbered List (not to be confused with headings/titles, (document structure)) -<p> <b>markup example:</b> -<p> +<p> <br> +<b>markup example:</b> <p> <br> <pre> # numbered list numbered list 1., 2., 3, etc. + _# numbered list numbered list indented a., b., c., d., etc. </pre> -<p> 9.4 FOOTNOTES / ENDNOTES -<p> Footnotes and endnotes are marked up at the -location where they would be indicated within a text. They are automatically -numbered. The output type determines whether footnotes or endnotes will - -<p>be produced -<p> <b>markup example:</b> <p> +<h2><a name='sect28' href='#toc28'>9.4 Footnotes / Endnotes</a></h2> + +<p> <br> +Footnotes and endnotes are marked up at the location where they would be +indicated within a text. They are automatically numbered. The output type + +<p>determines whether footnotes or endnotes will be produced +<p> <br> +<b>markup example:</b> <p> <br> <pre> ~{ a footnote or endnote }~ </pre> -<p> <b>resulting output:</b> -<p> [^12] -<p> <b>markup example:</b> -<p> +<p> <br> +<b>resulting output:</b> +<p> <br> +[^12] +<p> <br> +<b>markup example:</b> <p> <br> <pre> normal text~{ self contained endnote marker & endnote in one }~ continues </pre> -<p> <b>resulting output:</b> -<p> normal text[^13] continues -<p> <b>markup example:</b> -<p> +<p> <br> +<b>resulting output:</b> +<p> <br> +normal text[^13] continues +<p> <br> +<b>markup example:</b> <p> <br> <pre> normal text ~{* unnumbered asterisk footnote/endnote, insert multiple asterisks if required }~ continues + normal text ~{** another unnumbered asterisk footnote/endnote }~ continues </pre> -<p> <b>resulting output:</b> -<p> normal text [^*] continues -<p> normal text [^**] continues - -<p> <b>markup example:</b> -<p> +<p> <br> +<b>resulting output:</b> +<p> <br> +normal text [^*] continues +<p> <br> +normal text [^**] continues +<p> <br> +<b>markup example:</b> <p> <br> <pre> normal text ~[* editors notes, numbered asterisk footnote/endnote series ]~ continues + normal text ~[+ editors notes, numbered asterisk footnote/endnote series ]~ continues </pre> -<p> <b>resulting output:</b> -<p> normal text [^*3] continues -<p> normal text [^+2] continues - -<p> <b>Alternative endnote pair notation for footnotes/endnotes:</b> -<p> +<p> <br> +<b>resulting output:</b> +<p> <br> +normal text [^*3] continues +<p> <br> +normal text [^+2] continues +<p> <br> +<b>Alternative endnote pair notation for footnotes/endnotes:</b> <p> <br> <pre> % note the endnote marker "~^" normal text~^ continues + ^~ endnote text following the paragraph in which the marker occurs </pre> -<p> the standard and pair notation cannot be mixed in the same document +<p> <br> + +<p>the standard and pair notation cannot be mixed in the same document <p> +<h2><a name='sect29' href='#toc29'>9.5 +Links</a></h2> -<p>9.5 LINKS -<p> 9.5.1 NAKED URLS WITHIN TEXT, DEALING WITH URLS -<p> urls found within -text are marked up automatically. A url within text is automatically hyperlinked -to itself and by default decorated with angled braces, unless they are -contained within a code block (in which case they are passed as normal -text), or escaped by a preceding underscore (in which case the decoration -is omitted). -<p> <b>markup example:</b> <p> +<h2><a name='sect30' href='#toc30'>9.5.1 Naked Urls Within Text, Dealing with Urls</a></h2> + +<p> <br> +urls found within text are marked up automatically. A url within text is +automatically hyperlinked to itself and by default decorated with angled +braces, unless they are contained within a code block (in which case they +are passed as normal text), or escaped by a preceding underscore (in which +case the decoration is omitted). +<p> <br> +<b>markup example:</b> <p> <br> <pre> normal text http://www.sisudoc.org/ continues </pre> -<p> <b>resulting output:</b> -<p> normal text <<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> +<p> <br> +<b>resulting output:</b> +<p> <br> +normal text <<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> > continues -<p> An +<p> <br> -<p>escaped url without decoration -<p> <b>markup example:</b> -<p> +<p>An escaped url without decoration +<p> <br> +<b>markup example:</b> <p> <br> <pre> normal text _http://www.sisudoc.org/ continues deb http://www.jus.uio.no/sisu/archive unstable main non-free </pre> -<p> <b>resulting output:</b> -<p> normal text <_<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> +<p> <br> +<b>resulting output:</b> +<p> <br> +normal text <_<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> > continues -<p> deb -<_<a href='http://www.jus.uio.no/sisu/archive'>http://www.jus.uio.no/sisu/archive</a> +<p> <br> +deb <_<a href='http://www.jus.uio.no/sisu/archive'>http://www.jus.uio.no/sisu/archive</a> > unstable main non-free -<p> where a code block -is used there is neither decoration nor hyperlinking, code blocks are discussed +<p> <br> +where a code block is used there is neither decoration nor hyperlinking, -<p>later in this document -<p> <b>resulting output:</b> -<p> +<p>code blocks are discussed later in this document +<p> <br> +<b>resulting output:</b> <p> <br> <pre> deb http://www.jus.uio.no/sisu/archive unstable main non-free + deb-src http://www.jus.uio.no/sisu/archive unstable main non-free </pre> -<p> 9.5.2 LINKING TEXT -<p> To link text or an image to a url the markup is as - -<p>follows -<p> <b>markup example:</b> <p> +<h2><a name='sect31' href='#toc31'>9.5.2 Linking Text</a></h2> + +<p> <br> + +<p>To link text or an image to a url the markup is as follows +<p> <br> +<b>markup example:</b> <p> <br> <pre> about { SiSU }http://url.org markup </pre> -<p> <b>resulting output:</b> -<p> aboutSiSU <<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> +<p> <br> +<b>resulting output:</b> +<p> <br> +aboutSiSU <<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> > markup -<p> A shortcut +<p> <br> -<p>notation is available so the url link may also be provided automatically +<p>A shortcut notation is available so the url link may also be provided automatically <p>as a footnote -<p> <b>markup example:</b> -<p> +<p> <br> +<b>markup example:</b> <p> <br> <pre> about {~^ SiSU }http://url.org markup </pre> -<p> <b>resulting output:</b> -<p> about SiSU <<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> +<p> <br> +<b>resulting output:</b> +<p> <br> +about SiSU <<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> > [^14] markup -<p> 9.5.3 - -<p>LINKING IMAGES -<p> <b>markup example:</b> <p> +<h2><a name='sect32' href='#toc32'>9.5.3 Linking Images</a></h2> + +<p> <br> +<b>markup example:</b> <p> <br> <pre> { tux.png 64x80 }image + % various url linked images + {tux.png 64x80 "a better way" }http://www.sisudoc.org/ + + {GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian and Ruby" }http://www.sisudoc.org/ + + {~^ ruby_logo.png "Ruby" }http://www.ruby-lang.org/en/ + + </pre> -<p> <b>resulting output:</b> -<p> [ tux.png ] -<p> tux.png 64x80 "Gnu/Linux - a better way" -<<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> +<p> <br> +<b>resulting output:</b> +<p> <br> +[ tux.png ] +<p> <br> +tux.png 64x80 "Gnu/Linux - a better way" <<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> > -<p> [ ruby_logo (png missing) ] [^15] -<p> GnuDebianLinuxRubyBetterWay.png -100x101 "Way Better - with Gnu/Linux, Debian and Ruby" <<a href='http://www.jus.uio.no/sisu/'>http://www.jus.uio.no/sisu/</a> +<p> <br> +[ ruby_logo (png missing) ] [^15] +<p> <br> +GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian +and Ruby" <<a href='http://www.jus.uio.no/sisu/'>http://www.jus.uio.no/sisu/</a> > +<p> <br> -<p> <b>linked url footnote shortcut</b> -<p> +<p><b>linked url footnote shortcut</b> <p> <br> <pre> {~^ [text to link] }http://url.org % maps to: { [text to link] }http://url.org ~{ http://url.org }~ % which produces hyper-linked text within a document/paragraph, - with an endnote providing the url for the text location used in the hyperlink + % with an endnote providing the url for the text location used in the +hyperlink </pre> -<p> <p> <br> <pre> text marker *~name </pre> -<p> note at a heading level the same is automatically achieved by providing +<p> <br> +note at a heading level the same is automatically achieved by providing names to headings 1, 2 and 3 i.e. 2~[name] and 3~[name] or in the case of auto-heading numbering, without further intervention. -<p> 9.6 GROUPED TEXT -<p> 9.6.1 - -<p>TABLES -<p> Tables may be prepared in two either of two forms -<p> <b>markup example:</b> +<p> +<h2><a name='sect33' href='#toc33'>9.6 Grouped Text</a></h2> <p> +<h2><a name='sect34' href='#toc34'>9.6.1 +Tables</a></h2> + +<p> <br> + +<p>Tables may be prepared in two either of two forms +<p> <br> +<b>markup example:</b> <p> <br> <pre> table{ c3; 40; 30; 30; This is a table @@ -1382,14 +1582,17 @@ auto-heading numbering, without further intervention. column three of row two, and so on }table </pre> -<p> <b>resulting output:</b> +<p> <br> +<b>resulting output:</b> <p> [table omitted, see other document formats]<br> -<p> a second form may be easier to work with in cases where there is not +<p> <br> + +<p>a second form may be easier to work with in cases where there is not much -<p>much information in each column -<p> <b>markup example:</b> [^16] -<p> +<p>information in each column +<p> <br> +<b>markup example:</b> [^16] <p> <br> <pre> !_ Table 3.1: Contributors to Wikipedia, January 2001 - June 2005 {table~h 24; 12; 12; 12; 12; 12; 12;} @@ -1408,24 +1611,29 @@ auto-heading numbering, without further intervention. \* Contributed at least ten times; \** at least 5 times in last month; \* more than 100 times in last month. </pre> -<p> <b>resulting output:</b> -<p> <b>Table 3.1: Contributors to Wikipedia, January 2001 -- June 2005</b> -<p> [table omitted, see other document formats]<br> +<p> <br> +<b>resulting output:</b> +<p> <br> +<b>Table 3.1: Contributors to Wikipedia, January 2001 - June 2005</b> +<p> [table + omitted, see other document formats]<br> -<p> * Contributed at least ten times; ** at least 5 times in last month; -*** more than 100 times in last month. -<p> 9.6.2 POEM -<p> <b>basic markup:</b> +<p> <br> +* Contributed at least ten times; ** at least 5 times in last month; *** +more than 100 times in last month. <p> +<h2><a name='sect35' href='#toc35'>9.6.2 Poem</a></h2> + +<p> <br> +<b>basic markup:</b> <p> <br> <pre> poem{ Your poem here }poem Each verse in a poem is given an object number. </pre> -<p> <b>markup example:</b> -<p> +<p> <br> +<b>markup example:</b> <p> <br> <pre> poem{ ‘Fury said to a @@ -1474,65 +1682,116 @@ auto-heading numbering, without further intervention. death."’ }poem </pre> -<p> <b>resulting output:</b> +<p> <br> +<b>resulting output:</b> <p> ‘Fury said to a<br> - mouse, That he<br> - met in the<br> - house,<br> - "Let us<br> - both go to<br> - law: I will<br> - prosecute<br> - YOU. --Come,<br> - I’ll take no<br> - denial; We<br> - must have a<br> - trial: For<br> - really this<br> - morning I’ve<br> - nothing<br> - to do."<br> - Said the<br> - mouse to the<br> - cur, "Such<br> - a trial,<br> - dear Sir,<br> - With<br> - no jury<br> - or judge,<br> - would be<br> - wasting<br> - our<br> - breath."<br> - "I’ll be<br> - judge, I’ll<br> - be jury,"<br> - Said<br> - cunning<br> - old Fury:<br> - "I’ll<br> - try the<br> - whole<br> - cause,<br> - and<br> - condemn<br> - you<br> - to<br> - death."’<br> - -<p> 9.6.3 GROUP -<p> <b>basic markup:</b> + <br> + mouse, That he<br> + <br> + met in the<br> + <br> + house,<br> + <br> + "Let us<br> + <br> + both go to<br> + <br> + law: I will<br> + <br> + prosecute<br> + <br> + YOU. --Come,<br> + <br> + I’ll take no<br> + <br> + denial; We<br> + <br> + must have a<br> + <br> + trial: For<br> + <br> + really this<br> + <br> + morning I’ve<br> + <br> + nothing<br> + <br> + to do."<br> + <br> + Said the<br> + <br> + mouse to the<br> + <br> + cur, "Such<br> + <br> + a trial,<br> + <br> + dear Sir,<br> + <br> + With<br> + <br> + no jury<br> + <br> + or judge,<br> + <br> + would be<br> + <br> + wasting<br> + <br> + our<br> + <br> + breath."<br> + <br> + "I’ll be<br> + <br> + judge, I’ll<br> + <br> + be jury,"<br> + <br> + Said<br> + <br> + cunning<br> + <br> + old Fury:<br> + <br> + "I’ll<br> + <br> + try the<br> + <br> + whole<br> + <br> + cause,<br> + <br> + and<br> + <br> + condemn<br> + <br> + you<br> + <br> + to<br> + <br> + death."’<br> + <br> + <p> +<h2><a name='sect36' href='#toc36'>9.6.3 Group</a></h2> + +<p> <br> +<b>basic markup:</b> <p> <br> <pre> group{ + Your grouped text here + }group + A group is treated as an object and given a single object number. </pre> -<p> <b>markup example:</b> -<p> +<p> <br> +<b>markup example:</b> <p> <br> <pre> group{ + ’Fury said to a mouse, That he met in the @@ -1579,63 +1838,111 @@ auto-heading numbering, without further intervention. death."’ }group </pre> -<p> <b>resulting output:</b> +<p> <br> +<b>resulting output:</b> <p> ‘Fury said to a<br> - mouse, That he<br> - met in the<br> - house,<br> - "Let us<br> - both go to<br> - law: I will<br> - prosecute<br> - YOU. --Come,<br> - I’ll take no<br> - denial; We<br> - must have a<br> - trial: For<br> - really this<br> - morning I’ve<br> - nothing<br> - to do."<br> - Said the<br> - mouse to the<br> - cur, "Such<br> - a trial,<br> - dear Sir,<br> - With<br> - no jury<br> - or judge,<br> - would be<br> - wasting<br> - our<br> - breath."<br> - "I’ll be<br> - judge, I’ll<br> - be jury,"<br> - Said<br> - cunning<br> - old Fury:<br> - "I’ll<br> - try the<br> - whole<br> - cause,<br> - and<br> - condemn<br> - you<br> - to<br> - death."’<br> - -<p> 9.6.4 CODE -<p> Code tags code{ ... }code (used as with other group tags described -above) are used to escape regular sisu markup, and have been used extensively + <br> + mouse, That he<br> + <br> + met in the<br> + <br> + house,<br> + <br> + "Let us<br> + <br> + both go to<br> + <br> + law: I will<br> + <br> + prosecute<br> + <br> + YOU. --Come,<br> + <br> + I’ll take no<br> + <br> + denial; We<br> + <br> + must have a<br> + <br> + trial: For<br> + <br> + really this<br> + <br> + morning I’ve<br> + <br> + nothing<br> + <br> + to do."<br> + <br> + Said the<br> + <br> + mouse to the<br> + <br> + cur, "Such<br> + <br> + a trial,<br> + <br> + dear Sir,<br> + <br> + With<br> + <br> + no jury<br> + <br> + or judge,<br> + <br> + would be<br> + <br> + wasting<br> + <br> + our<br> + <br> + breath."<br> + <br> + "I’ll be<br> + <br> + judge, I’ll<br> + <br> + be jury,"<br> + <br> + Said<br> + <br> + cunning<br> + <br> + old Fury:<br> + <br> + "I’ll<br> + <br> + try the<br> + <br> + whole<br> + <br> + cause,<br> + <br> + and<br> + <br> + condemn<br> + <br> + you<br> + <br> + to<br> + <br> + death."’<br> + <br> + +<p> +<h2><a name='sect37' href='#toc37'>9.6.4 Code</a></h2> + +<p> <br> +Code tags code{ ... }code (used as with other group tags described above) +are used to escape regular sisu markup, and have been used extensively within this document to provide examples of <b>SiSU</b> markup. You cannot however use code tags to escape code tags. They are however used in the same way as group or poem tags. -<p> A code-block is treated as an object and given a -single object number. [an some later time] -<p> <b>use of code tags instead of -poem compared, resulting output:</b> -<p> +<p> <br> +A code-block is treated as an object and given a single object number. [an +some later time] +<p> <br> +<b>use of code tags instead of poem compared, resulting output:</b> <p> <br> <pre> ‘Fury said to a mouse, That he @@ -1682,9 +1989,9 @@ poem compared, resulting output:</b> to death."’ </pre> -<p> From <b>SiSU</b> 2.7.7 on you can number codeblocks by placing a hash after the +<p> <br> +From <b>SiSU</b> 2.7.7 on you can number codeblocks by placing a hash after the opening code tag code{# as demonstrated here: -<p> <p> <br> <pre>1 | ‘Fury said to a 2 | mouse, That he @@ -1731,274 +2038,375 @@ opening code tag code{# as demonstrated here: 43 | to 44 | death."’ </pre> -<p> 9.7 BOOK INDEX -<p> To make an index append to paragraph the book index term -relates to it, using an equal sign and curly braces. -<p> Currently two levels -are provided, a main term and if needed a sub-term. Sub-terms are separated -from the main term by a colon. <p> +<h2><a name='sect38' href='#toc38'>9.7 Book Index</a></h2> + +<p> <br> +To make an index append to paragraph the book index term relates to it, +using an equal sign and curly braces. +<p> <br> +Currently two levels are provided, a main term and if needed a sub-term. +Sub-terms are separated from the main term by a colon. <p> <br> <pre> Paragraph containing main term and sub-term. ={Main term:sub-term} </pre> -<p> The index syntax starts on a new line, but there should not be an empty +<p> <br> +The index syntax starts on a new line, but there should not be an empty line between paragraph and index markup. -<p> The structure of the resulting -index would be: -<p> +<p> <br> +The structure of the resulting index would be: <p> <br> <pre> Main term, 1 sub-term, 1 </pre> -<p> Several terms may relate to a paragraph, they are separated by a semicolon. +<p> <br> +Several terms may relate to a paragraph, they are separated by a semicolon. If the term refers to more than one paragraph, indicate the number of paragraphs. -<p> <p> <br> <pre> Paragraph containing main term, second term and sub-term. ={first term; second term: sub-term} </pre> -<p> The structure of the resulting index would be: -<p> +<p> <br> +The structure of the resulting index would be: <p> <br> <pre> First term, 1, Second term, 1, sub-term, 1 </pre> -<p> If multiple sub-terms appear under one paragraph, they are separated under +<p> <br> +If multiple sub-terms appear under one paragraph, they are separated under the main term heading from each other by a pipe symbol. -<p> <p> <br> <pre> Paragraph containing main term, second term and sub-term. ={Main term:sub-term+1|second sub-term A paragraph that continues discussion of the first sub-term </pre> -<p> The plus one in the example provided indicates the first sub-term spans +<p> <br> +The plus one in the example provided indicates the first sub-term spans one additional paragraph. The logical structure of the resulting index would be: -<p> <p> <br> <pre> Main term, 1, sub-term, 1-3, second sub-term, 1, </pre> -<p> 10. COMPOSITE DOCUMENTS MARKUP -<p> It is possible to build a document by -creating a master document that requires other documents. The documents -required may be complete documents that could be generated independently, -or they could be markup snippets, prepared so as to be easily available -to be placed within another text. If the calling document is a master document -(built from other documents), it should be named with the suffix <b>.ssm</b> Within -this document you would provide information on the other documents that -should be included within the text. These may be other documents that would -be processed in a regular way, or markup bits prepared only for inclusion -within a master document <b>.sst</b> regular markup file, or <b>.ssi</b> (insert/information) - -<p>A secondary file of the composite document is built prior to processing - -<p>with the same prefix and the suffix <b>._sst</b> -<p> basic markup for importing a +<p> +<h2><a name='sect39' href='#toc39'>10. Composite Documents Markup</a></h2> +<br> -<p>document into a master document +<p> <br> +It is possible to build a document by creating a master document that requires +other documents. The documents required may be complete documents that could +be generated independently, or they could be markup snippets, prepared +so as to be easily available to be placed within another text. If the calling +document is a master document (built from other documents), it should be +named with the suffix <b>.ssm</b> Within this document you would provide information +on the other documents that should be included within the text. These may +be other documents that would be processed in a regular way, or markup +bits prepared only for inclusion within a master document <b>.sst</b> regular markup +file, or <b>.ssi</b> (insert/information) A secondary file of the composite document + +<p>is built prior to processing with the same prefix and the suffix <b>._sst</b> <p> +<br> + +<p>basic markup for importing a document into a master document <p> <br> <pre> << filename1.sst << filename2.ssi </pre> -<p> The form described above should be relied on. Within the Vim editor it -results in the text thus linked becoming hyperlinked to the document it -is calling in which is convenient for editing. Alternative markup for importation -of documents under consideration, and occasionally supported have been. - -<p> +<p> <br> +The form described above should be relied on. Within the Vim editor it results +in the text thus linked becoming hyperlinked to the document it is calling +in which is convenient for editing. Alternative markup for importation of +documents under consideration, and occasionally supported have been. <p> <br> <pre> << filename.ssi <<{filename.ssi} % using textlink alternatives << |filename.ssi|@|^| </pre> -<p> MARKUP SYNTAX HISTORY -<p> 11. NOTES RELATED TO FILES-TYPES AND MARKUP SYNTAX +<p> +<h2><a name='sect40' href='#toc40'>Markup Syntax History</a></h2> +<br> + +<p> +<h2><a name='sect41' href='#toc41'>11. Notes Related to Files-types and Markup Syntax</a></h2> +<br> <p> 2.0 introduced new headers and is therefore incompatible with 1.0 though otherwise the same with the addition of a couple of tags (i.e. a superset) -<p> 0.38 is substantially current for version 1.0 -<p> * sisu --query=[sisu version - [0.38] or ’history] -<p> provides a short history of changes to <b>SiSU</b> markup +<p> <br> + +<p>0.38 is substantially current for version 1.0 +<p> <br> +depreciated 0.16 supported, though file names were changed at 0.37 +<p> <br> +* sisu --query=[sisu version [0.38] or ’history] +<p> <br> -<p> <b>0.57</b> (2007w34/4) <b>SiSU</b> 0.57 is the same as 0.42 with the introduction of -some a shortcut to use the headers @title and @creator in the first heading +<p>provides a short history of changes to <b>SiSU</b> markup +<p> <br> +<b>SiSU 2.0</b> (2010-03-06:09/6) same as 1.0, apart from the changing of headers +and the addition of a monospace tag related headers now grouped, e.g. +<p> <br> +<pre> @title: + :subtitle: + @creator: + :author: + :translator: + :illustrator: + @rights: + :text: + :illustrations: +</pre> +<p> <br> +see document markup samples, and sisu --help headers +<p> <br> +the monospace tag takes the form of a hash ’#’ +<p> <br> +<pre> #{ this enclosed text would be monospaced }# +</pre> +<p> <br> +<b>1.0</b> (2009-12-19:50/6) same as 0.69 +<p> <br> +<b>0.69</b> (2008-09-16:37/2) (same as 1.0) and as previous (0.57) with the addition + +<p>of book index tags +<p> <br> +<pre> /^={.+?}$/ +</pre> +<p> <br> +e.g. appended to a paragraph, on a new-line (without a blank line in between) +logical structure produced assuming this is the first text "object" +<p> <br> +<pre> ={GNU/Linux community distribution:Debian+2|Fedora|Gentoo;Free Software +Foundation+5} +</pre> +<p> <br> +<pre> Free Software Foundation, 1-6 + GNU/Linux community distribution, 1 + Debian, 1-3 + Fedora, 1 + Gentoo, +</pre> +<p> <br> +<b>0.66</b> (2008-02-24:07/7) same as previous, adds semantic tags, [experimental + and not-used] +<p> <br> +<pre> /[:;]{.+?}[:;][a-z+]/ +</pre> +<p> <br> +<b>0.57</b> (2007w34/4) <b>SiSU</b> 0.57 is the same as 0.42 with the introduction of some +a shortcut to use the headers @title and @creator in the first heading [expanded using the and @author:] -<p> <p> <br> <pre> :A~ @title by @author </pre> -<p> <b>0.52</b> (2007w14/6) declared document type identifier at start of text/document: +<p> <br> +<b>0.52</b> (2007w14/6) declared document type identifier at start of text/document: -<p> .B SiSU<br> +<p> <br> + .B SiSU<br> 0.52 -<p> or, backward compatible using the comment marker: -<p> %<br> +<p> <br> +or, backward compatible using the comment marker: +<p> <br> + %<br> <b>SiSU</b> 0.38 -<p> variations include ’ <b>SiSU</b> (text|master|insert) [version]’ and ’sisu-[version]’ +<p> <br> +variations include ’ <b>SiSU</b> (text|master|insert) [version]’ and ’sisu-[version]’ -<p> <b>0.51</b> (2007w13/6) skins changed (simplified), markup unchanged -<p> <b>0.42</b> (2006w27/4) -* (asterisk) type endnotes, used e.g. in relation to author -<p> <b>SiSU</b> 0.42 is -the same as 0.38 with the introduction of some additional endnote types, +<p> <br> +<b>0.51</b> (2007w13/6) skins changed (simplified), markup unchanged +<p> <br> +<b>0.42</b> (2006w27/4) * (asterisk) type endnotes, used e.g. in relation to author -<p> Introduces some variations on endnotes, in particular the use of the +<p> <br> +<b>SiSU</b> 0.42 is the same as 0.38 with the introduction of some additional endnote +types, +<p> <br> +Introduces some variations on endnotes, in particular the use of the asterisk -<p>asterisk -<p> <p> <br> <pre> ~{* for example for describing an author }~ and ~{** for describing a second author }~ </pre> -<p> * for example for describing an author -<p> ** for describing a second author +<p> <br> +* for example for describing an author +<p> <br> +** for describing a second author +<p> <br> -<p> and -<p> +<p>and <p> <br> <pre> ~[* my note ]~ or ~[+ another note ]~ </pre> -<p> which numerically increments an asterisk and plus respectively -<p> *1 my +<p> <br> -<p>note +1 another note -<p> <b>0.38</b> (2006w15/7) introduced new/alternative notation -for headers, e.g. @title: (instead of 0~title), and accompanying document -structure markup, :A,:B,:C,1,2,3 (maps to previous 1,2,3,4,5,6) -<p> <b>SiSU</b> -0.38 introduced alternative experimental header and heading/structure markers, +<p>which numerically increments an asterisk and plus respectively +<p> <br> -<p> +<p>*1 my note +1 another note +<p> <br> +<b>0.38</b> (2006w15/7) introduced new/alternative notation for headers, e.g. @title: +(instead of 0~title), and accompanying document structure markup, :A,:B,:C,1,2,3 +(maps to previous 1,2,3,4,5,6) +<p> <br> +<b>SiSU</b> 0.38 introduced alternative experimental header and heading/structure +markers, <p> <br> <pre> @headername: and headers :A~ :B~ :C~ 1~ 2~ 3~ </pre> -<p> as the equivalent of: -<p> +<p> <br> +as the equivalent of: <p> <br> <pre> 0~headername and headers 1~ 2~ 3~ 4~ 5~ 6~ </pre> -<p> The internal document markup of <b>SiSU</b> 0.16 remains valid and standard Though +<p> <br> + +<p>The internal document markup of <b>SiSU</b> 0.16 remains valid and standard Though <p>note that <b>SiSU</b> 0.37 introduced a new file naming convention -<p> <b>SiSU</b> has in -effect two sets of levels to be considered, using 0.38 notation A-C headings/levels, -pre-ordinary paragraphs /pre-substantive text, and 1-3 headings/levels, levels -which are followed by ordinary text. This may be conceptualised as levels -A,B,C, 1,2,3, and using such letter number notation, in effect: A must -exist, optional B and C may follow in sequence (not strict) 1 must exist, -optional 2 and 3 may follow in sequence i.e. there are two independent heading -level sequences A,B,C and 1,2,3 (using the 0.16 standard notation 1,2,3 -and 4,5,6) on the positive side: the 0.38 A,B,C,1,2,3 alternative makes -explicit an aspect of structuring documents in <b>SiSU</b> that is not otherwise +<p> <br> +<b>SiSU</b> has in effect two sets of levels to be considered, using 0.38 notation +A-C headings/levels, pre-ordinary paragraphs /pre-substantive text, and 1-3 +headings/levels, levels which are followed by ordinary text. This may be +conceptualised as levels A,B,C, 1,2,3, and using such letter number notation, +in effect: A must exist, optional B and C may follow in sequence (not strict) +1 must exist, optional 2 and 3 may follow in sequence i.e. there are two +independent heading level sequences A,B,C and 1,2,3 (using the 0.16 standard +notation 1,2,3 and 4,5,6) on the positive side: the 0.38 A,B,C,1,2,3 alternative +makes explicit an aspect of structuring documents in <b>SiSU</b> that is not otherwise obvious to the newcomer (though it appears more complicated, is more in your face and likely to be understood fairly quickly); the substantive text follows levels 1,2,3 and it is ’nice’ to do most work in those levels -<p> <b>0.37</b> (2006w09/7) introduced new file naming convention, .sst (text), .ssm +<p> <br> +<b>0.37</b> (2006w09/7) introduced new file naming convention, .sst (text), .ssm (master), .ssi (insert), markup syntax unchanged -<p> <b>SiSU</b> 0.37 introduced new -file naming convention, using the file extensions .sst .ssm and .ssi to replace -.s1 .s2 .s3 .r1 .r2 .r3 and .si<br> +<p> <br> +<b>SiSU</b> 0.37 introduced new file naming convention, using the file extensions +.sst .ssm and .ssi to replace .s1 .s2 .s3 .r1 .r2 .r3 and .si<br> -<p> this is captured by the following file ’rename’ instruction: -<p> +<p> <br> +this is captured by the following file ’rename’ instruction: <p> <br> <pre> rename ’s/.s[123]$/.sst/’ *.s{1,2,3} rename ’s/.r[123]$/.ssm/’ *.r{1,2,3} rename ’s/.si$/.ssi/’ *.si </pre> -<p> The internal document markup remains unchanged, from <b>SiSU</b> 0.16 -<p> <b>0.35</b> (2005w52/3) -sisupod, zipped content file introduced -<p> <b>0.23</b> (2005w36/2) utf-8 for markup - -<p>file -<p> <b>0.22</b> (2005w35/3) image dimensions may be omitted if rmagick is available +<p> <br> +The internal document markup remains unchanged, from <b>SiSU</b> 0.16 +<p> <br> +<b>0.35</b> (2005w52/3) sisupod, zipped content file introduced +<p> <br> +<b>0.23</b> (2005w36/2) utf-8 for markup file +<p> <br> +<b>0.22</b> (2005w35/3) image dimensions may be omitted if rmagick is available <p>to be relied upon -<p> <b>0.20.4</b> (2005w33/4) header 0~links -<p> <b>0.16</b> (2005w25/2) substantial -changes introduced to make markup cleaner, header 0~title type, and headings -[1-6]~ introduced, also percentage sign (%) at start of a text line as comment - -<p>marker -<p> <b>SiSU</b> 0.16 (0.15 development branch) introduced the use of -<p> the -header 0~ and headings/structure 1~ 2~ 3~ 4~ 5~ 6~ -<p> in place of the 0.1 -header, heading/structure notation -<p> <b>SiSU</b> 0.1 headers and headings structure -represented by header 0{~ and headings/structure 1{ 2{ 3{ 4{~ 5{ 6{ -<p> 12. -SISU FILETYPES -<p> <b>SiSU</b> has plaintext and binary filetypes, and can process -either type of document. -<p> 12.1 .SST .SSM .SSI MARKED UP PLAIN TEXT -<p> <b>SiSU</b> documents -are prepared as plain-text (utf-8) files with <b>SiSU</b> markup. They may make reference -to and contain images (for example), which are stored in the directory -beneath them _sisu/image. <b>SiSU</b> plaintext markup files are of three types -that may be distinguished by the file extension used: regular text .sst; -master documents, composite documents that incorporate other text, which -can be any regular text or text insert; and inserts the contents of which -are like regular text except these are marked .ssi and are not processed.<br> - -<p> <b>SiSU</b> processing can be done directly against a sisu documents; which -may be located locally or on a remote server for which a url is provided. - -<p> <b>SiSU</b> source markup can be shared with the command: -<p> sisu -s [filename]<br> - -<p> 12.1.1 SISU TEXT - REGULAR FILES (.SST) -<p> The most common form of document -in <b>SiSU</b> , see the section on <b>SiSU</b> markup. -<p> <<a href='http://www.sisudoc.org/sisu/sisu_markup'>http://www.sisudoc.org/sisu/sisu_markup</a> -> +<p> <br> +<b>0.20.4</b> (2005w33/4) header 0~links +<p> <br> +<b>0.16</b> (2005w25/2) substantial changes introduced to make markup cleaner, +header 0~title type, and headings [1-6]~ introduced, also percentage sign +(%) at start of a text line as comment marker +<p> <br> +<b>SiSU</b> 0.16 (0.15 development branch) introduced the use of +<p> <br> +the header 0~ and headings/structure 1~ 2~ 3~ 4~ 5~ 6~ +<p> <br> +in place of the 0.1 header, heading/structure notation +<p> <br> +<b>SiSU</b> 0.1 headers and headings structure represented by header 0{~ and headings/structure +1{ 2{ 3{ 4{~ 5{ 6{ +<p> +<h2><a name='sect42' href='#toc42'>12. Sisu Filetypes</a></h2> +<br> + +<p> <br> +<b>SiSU</b> has plaintext and binary filetypes, and can process either type of +document. +<p> +<h2><a name='sect43' href='#toc43'>12.1 .sst .ssm .ssi Marked Up Plain Text</a></h2> -<p> <<a href='http://www.sisudoc.org/sisu/sisu_manual'>http://www.sisudoc.org/sisu/sisu_manual</a> +<p> <br> +<b>SiSU</b> documents are prepared as plain-text (utf-8) files with <b>SiSU</b> markup. +They may make reference to and contain images (for example), which are +stored in the directory beneath them _sisu/image. <b>SiSU</b> plaintext markup +files are of three types that may be distinguished by the file extension +used: regular text .sst; master documents, composite documents that incorporate +other text, which can be any regular text or text insert; and inserts the +contents of which are like regular text except these are marked .ssi and +are not processed.<br> + +<p> <br> +<b>SiSU</b> processing can be done directly against a sisu documents; which may +be located locally or on a remote server for which a url is provided. +<p> <br> +<b>SiSU</b> source markup can be shared with the command: +<p> <br> + sisu -s [filename]<br> + +<p> +<h2><a name='sect44' href='#toc44'>12.1.1 Sisu Text - Regular Files (.sst)</a></h2> + +<p> <br> +The most common form of document in <b>SiSU</b> , see the section on <b>SiSU</b> markup. + +<p> <br> +<<a href='http://www.sisudoc.org/sisu/sisu_markup'>http://www.sisudoc.org/sisu/sisu_markup</a> +> +<p> <br> +<<a href='http://www.sisudoc.org/sisu/sisu_manual'>http://www.sisudoc.org/sisu/sisu_manual</a> > -<p> 12.1.2 SISU MASTER FILES (.SSM) <p> - Composite documents which incorporate other <b>SiSU</b> documents which may be +<h2><a name='sect45' href='#toc45'>12.1.2 Sisu Master Files (.ssm)</a></h2> + +<p> <br> +Composite documents which incorporate other <b>SiSU</b> documents which may be either regular <b>SiSU</b> text .sst which may be generated independently, or inserts prepared solely for the purpose of being incorporated into one or more master documents. -<p> The mechanism by which master files incorporate other -documents is described as one of the headings under under <b>SiSU</b> markup in -the <b>SiSU</b> manual. -<p> Note: Master documents may be prepared in a similar way -to regular documents, 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 [^17] -<p> <<a href='http://www.sisudoc.org/sisu/sisu_markup'>http://www.sisudoc.org/sisu/sisu_markup</a> +<p> <br> +The mechanism by which master files incorporate other documents is described +as one of the headings under under <b>SiSU</b> markup in the <b>SiSU</b> manual. +<p> <br> +Note: Master documents may be prepared in a similar way to regular documents, +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> <br> +Note: a secondary file of the composite document is built prior to processing +with the same prefix and the suffix ._sst [^17] +<p> <br> +<<a href='http://www.sisudoc.org/sisu/sisu_markup'>http://www.sisudoc.org/sisu/sisu_markup</a> > -<p> <<a href='http://www.sisudoc.org/sisu/sisu_manual'>http://www.sisudoc.org/sisu/sisu_manual</a> +<p> <br> +<<a href='http://www.sisudoc.org/sisu/sisu_manual'>http://www.sisudoc.org/sisu/sisu_manual</a> > +<p> +<h2><a name='sect46' href='#toc46'>12.1.3 Sisu Insert Files (.ssi)</a></h2> -<p> 12.1.3 SISU INSERT FILES (.SSI) -<p> Inserts are documents prepared solely for -the purpose of being incorporated into one or more master documents. They -resemble regular <b>SiSU</b> text files except they are ignored by the <b>SiSU</b> processor. -Making a file a .ssi file is a quick and convenient way of flagging that -it is not intended that the file should be processed on its own. -<p> 12.2 SISUPOD, -ZIPPED BINARY CONTAINER (SISUPOD.ZIP, .SSP) -<p> A sisupod is a zipped <b>SiSU</b> -text file or set of <b>SiSU</b> text files and any associated images that they -contain (this will be extended to include sound and multimedia-files) +<p> <br> +Inserts are documents prepared solely for the purpose of being incorporated +into one or more master documents. They resemble regular <b>SiSU</b> text files +except they are ignored by the <b>SiSU</b> processor. Making a file a .ssi file +is a quick and convenient way of flagging that it is not intended that +the file should be processed on its own. <p> +<h2><a name='sect47' href='#toc47'>12.2 Sisupod, Zipped Binary Container +(sisupod.zip, .ssp)</a></h2> + +<p> <br> +A sisupod is a zipped <b>SiSU</b> text file or set of <b>SiSU</b> text files and any +associated images that they contain (this will be extended to include sound +and multimedia-files) +<p> <br> <b>SiSU</b> plaintext files rely on a recognised directory structure to find contents such as images associated with documents, but all images for example for all documents contained in a directory are located in the sub-directory @@ -2006,212 +2414,306 @@ _sisu/image. Without the ability to create a sisupod it can be inconvenient to manually identify all other files associated with a document. A sisupod automatically bundles all associated files with the document that is turned into a pod. -<p> The structure of the sisupod is such that it may for example -contain a single document and its associated images; a master document -and its associated documents and anything else; or the zipped contents -of a whole directory of prepared <b>SiSU</b> documents. -<p> The command to create -a sisupod is: -<p> sisu -S [filename]<br> +<p> <br> +The structure of the sisupod is such that it may for example contain a +single document and its associated images; a master document and its associated +documents and anything else; or the zipped contents of a whole directory +of prepared <b>SiSU</b> documents. +<p> <br> +The command to create a sisupod is: +<p> <br> + sisu -S [filename]<br> -<p> Alternatively, make a pod of the contents of a whole directory: -<p> -sisu -S<br> +<p> <br> +Alternatively, make a pod of the contents of a whole directory: +<p> <br> + sisu -S<br> -<p> <b>SiSU</b> processing can be done directly against a sisupod; which may be -located locally or on a remote server for which a url is provided. -<p> <<a href='http://www.sisudoc.org/sisu/sisu_commands'>http://www.sisudoc.org/sisu/sisu_commands</a> +<p> <br> +<b>SiSU</b> processing can be done directly against a sisupod; which may be located +locally or on a remote server for which a url is provided. +<p> <br> +<<a href='http://www.sisudoc.org/sisu/sisu_commands'>http://www.sisudoc.org/sisu/sisu_commands</a> > - -<p> <<a href='http://www.sisudoc.org/sisu/sisu_manual'>http://www.sisudoc.org/sisu/sisu_manual</a> +<p> <br> +<<a href='http://www.sisudoc.org/sisu/sisu_manual'>http://www.sisudoc.org/sisu/sisu_manual</a> > -<p> 13. EXPERIMENTAL ALTERNATIVE INPUT -REPRESENTATIONS -<p> 13.1 ALTERNATIVE XML -<p> <b>SiSU</b> offers alternative XML input -representations of documents as a proof of concept, experimental feature. -They are however not strictly maintained, and incomplete and should be -handled with care. -<p> <b>convert from sst to simple xml representations (sax, -dom and node):</b> -<p> sisu --to-sax [filename/wildcard] or sisu --to-sxs [filename/wildcard]<br> +<p> +<h2><a name='sect48' href='#toc48'>13. Experimental Alternative Input +Representations</a></h2> +<br> -<p> sisu --to-dom [filename/wildcard] or sisu --to-sxd [filename/wildcard]<br> +<p> +<h2><a name='sect49' href='#toc49'>13.1 Alternative Xml</a></h2> -<p> sisu --to-node [filename/wildcard] or sisu --to-sxn [filename/wildcard]<br> +<p> <br> +<b>SiSU</b> offers alternative XML input representations of documents as a proof +of concept, experimental feature. They are however not strictly maintained, +and incomplete and should be handled with care. +<p> <br> +<b>convert from sst to simple xml representations (sax, dom and node):</b> +<p> <br> + sisu --to-sax [filename/wildcard] or sisu --to-sxs [filename/wildcard]<br> -<p> <b>convert to sst from any sisu xml representation (sax, dom and node):</b> +<p> <br> + sisu --to-dom [filename/wildcard] or sisu --to-sxd [filename/wildcard]<br> -<p> sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]<br> +<p> <br> + sisu --to-node [filename/wildcard] or sisu --to-sxn [filename/wildcard]<br> -<p> or the same: -<p> sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]<br> +<p> <br> +<b>convert to sst from any sisu xml representation (sax, dom and node):</b> +<p> <br> + sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]<br> -<p> 13.1.1 XML SAX REPRESENTATION -<p> To convert from sst to simple xml (sax) -representation: -<p> sisu --to-sax [filename/wildcard] or sisu --to-sxs [filename/wildcard]<br> +<p> <br> +or the same: +<p> <br> + sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]<br> -<p> To convert from any sisu xml representation back to sst -<p> sisu --from-xml2sst -[filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]<br> +<p> +<h2><a name='sect50' href='#toc50'>13.1.1 Xml Sax Representation</a></h2> -<p> or the same: -<p> sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]<br> +<p> <br> +To convert from sst to simple xml (sax) representation: +<p> <br> + sisu --to-sax [filename/wildcard] or sisu --to-sxs [filename/wildcard]<br> -<p> 13.1.2 XML DOM REPRESENTATION -<p> To convert from sst to simple xml (dom) -representation: -<p> sisu --to-dom [filename/wildcard] or sisu --to-sxd [filename/wildcard]<br> +<p> <br> -<p> To convert from any sisu xml representation back to sst -<p> sisu --from-xml2sst -[filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]<br> +<p>To convert from any sisu xml representation back to sst +<p> <br> + sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]<br> -<p> or the same: -<p> sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]<br> +<p> <br> +or the same: +<p> <br> + sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]<br> -<p> 13.1.3 XML NODE REPRESENTATION -<p> To convert from sst to simple xml (node) -representation: -<p> sisu --to-node [filename/wildcard] or sisu --to-sxn [filename/wildcard]<br> +<p> +<h2><a name='sect51' href='#toc51'>13.1.2 Xml Dom Representation</a></h2> -<p> To convert from any sisu xml representation back to sst -<p> sisu --from-xml2sst -[filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]<br> +<p> <br> +To convert from sst to simple xml (dom) representation: +<p> <br> + sisu --to-dom [filename/wildcard] or sisu --to-sxd [filename/wildcard]<br> -<p> or the same: -<p> sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]<br> +<p> <br> -<p> 14. CONFIGURATION -<p> 14.1 DETERMINING THE CURRENT CONFIGURATION -<p> Information -on the current configuration of <b>SiSU</b> should be available with the help -command: -<p> sisu -v<br> +<p>To convert from any sisu xml representation back to sst +<p> <br> + sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]<br> + +<p> <br> +or the same: +<p> <br> + sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]<br> + +<p> +<h2><a name='sect52' href='#toc52'>13.1.3 Xml Node Representation</a></h2> + +<p> <br> +To convert from sst to simple xml (node) representation: +<p> <br> + sisu --to-node [filename/wildcard] or sisu --to-sxn [filename/wildcard]<br> + +<p> <br> + +<p>To convert from any sisu xml representation back to sst +<p> <br> + sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]<br> + +<p> <br> +or the same: +<p> <br> + sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]<br> + +<p> +<h2><a name='sect53' href='#toc53'>14. Configuration</a></h2> +<br> + +<p> +<h2><a name='sect54' href='#toc54'>14.1 Determining the Current Configuration</a></h2> -<p> which is an alias for: -<p> sisu --help env<br> +<p> <br> +Information on the current configuration of <b>SiSU</b> should be available with +the help command: +<p> <br> + sisu -v<br> + +<p> <br> +which is an alias for: +<p> <br> + sisu --help env<br> -<p> Either of these should be executed from within a directory that contains +<p> <br> +Either of these should be executed from within a directory that contains sisu markup source documents. -<p> 14.2 CONFIGURATION FILES (CONFIG.YML) -<p> <b>SiSU</b> -configration parameters are adjusted in the configuration file, which can -be used to override the defaults set. This includes such things as which +<p> +<h2><a name='sect55' href='#toc55'>14.2 Configuration Files (config.yml)</a></h2> + +<p> <br> +<b>SiSU</b> configration parameters are adjusted in the configuration file, which +can be used to override the defaults set. This includes such things as which directory interim processing should be done in and where the generated output should be placed. -<p> The <b>SiSU</b> configuration file is a yaml file, which -means indentation is significant. -<p> <b>SiSU</b> resource configuration is determined -by looking at the following files if they exist: -<p> ./_sisu/sisurc.yml<br> +<p> <br> +The <b>SiSU</b> configuration file is a yaml file, which means indentation is +significant. +<p> <br> +<b>SiSU</b> resource configuration is determined by looking at the following files +if they exist: +<p> <br> + ./_sisu/sisurc.yml<br> -<p> ~/.sisu/sisurc.yml<br> +<p> <br> + ~/.sisu/sisurc.yml<br> -<p> /etc/sisu/sisurc.yml<br> +<p> <br> + /etc/sisu/sisurc.yml<br> -<p> The search is in the order listed, and the first one found is used. -<p> - In the absence of instructions in any of these it falls back to the internal +<p> <br> +The search is in the order listed, and the first one found is used. +<p> <br> +In the absence of instructions in any of these it falls back to the internal program defaults. -<p> Configuration determines the output and processing directories -and the database access details. -<p> If <b>SiSU</b> is installed a sample sisurc.yml +<p> <br> +Configuration determines the output and processing directories and the +database access details. +<p> <br> -<p>may be found in /etc/sisu/sisurc.yml -<p> 15. SKINS -<p> Skins modify the default -appearance of document output on a document, directory, or site wide basis. -Skins are looked for in the following locations: -<p> ./_sisu/skin<br> +<p>If <b>SiSU</b> is installed a sample sisurc.yml may be found in /etc/sisu/sisurc.yml -<p> ~/.sisu/skin<br> +<p> +<h2><a name='sect56' href='#toc56'>15. Skins</a></h2> +<br> + +<p> <br> +Skins modify the default appearance of document output on a document, directory, +or site wide basis. Skins are looked for in the following locations: +<p> <br> + ./_sisu/skin<br> -<p> /etc/sisu/skin<br> +<p> <br> + ~/.sisu/skin<br> + +<p> <br> + /etc/sisu/skin<br> -<p> <b>Within the skin directory</b> are the following the default sub-directories +<p> <br> +<b>Within the skin directory</b> are the following the default sub-directories for document skins: -<p> ./skin/doc<br> +<p> <br> + ./skin/doc<br> -<p> ./skin/dir<br> +<p> <br> + ./skin/dir<br> -<p> ./skin/site<br> +<p> <br> + ./skin/site<br> -<p> A skin is placed in the appropriate directory and the file named skin_[name].rb +<p> <br> -<p> The skin itself is a ruby file which modifies the default appearances -set in the program. -<p> 15.1 DOCUMENT SKIN -<p> Documents take on a document skin, -if the header of the document specifies a skin to be used. +<p>A skin is placed in the appropriate directory and the file named skin_[name].rb + +<p> <br> +The skin itself is a ruby file which modifies the default appearances set +in the program. <p> +<h2><a name='sect57' href='#toc57'>15.1 Document Skin</a></h2> + +<p> <br> +Documents take on a document skin, if the header of the document specifies +a skin to be used. <p> <br> <pre> @skin: skin_united_nations </pre> -<p> 15.2 DIRECTORY SKIN -<p> A directory may be mapped on to a particular skin, -so all documents within that directory take on a particular appearance. -If a skin exists in the skin/dir with the same name as the document directory, -it will automatically be used for each of the documents in that directory, -(except where a document specifies the use of another skin, in the skin/doc -directory). -<p> A personal habit is to place all skins within the doc directory, -and symbolic links as needed from the site, or dir directories as required. - -<p> 15.3 SITE SKIN -<p> A site skin, modifies the program default skin. -<p> 15.4 SAMPLE - -<p>SKINS -<p> With <b>SiSU</b> installed sample skins may be found in: -<p> /etc/sisu/skin/doc -and<br> +<p> +<h2><a name='sect58' href='#toc58'>15.2 Directory Skin</a></h2> + +<p> <br> +A directory may be mapped on to a particular skin, so all documents within +that directory take on a particular appearance. If a skin exists in the +skin/dir with the same name as the document directory, it will automatically +be used for each of the documents in that directory, (except where a document +specifies the use of another skin, in the skin/doc directory). +<p> <br> +A personal habit is to place all skins within the doc directory, and symbolic +links as needed from the site, or dir directories as required. +<p> +<h2><a name='sect59' href='#toc59'>15.3 Site +Skin</a></h2> + +<p> <br> +A site skin, modifies the program default skin. +<p> +<h2><a name='sect60' href='#toc60'>15.4 Sample Skins</a></h2> + +<p> <br> +With <b>SiSU</b> installed sample skins may be found in: +<p> <br> + /etc/sisu/skin/doc and<br> /usr/share/doc/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/markup-samples-non-free/samples/_sisu/skin/doc<br> +<p> <br> +(or equivalent directory) and if sisu-markup-samples is installed also under: + +<p> <br> + /usr/share/doc/sisu/markup-samples-non-free/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/markup-samples-non-free/samples/_sisu/skin/yml -(or<br> +<p> <br> +Samples of list.yml and promo.yml (which are used to create the right column +list) may be found in: +<p> <br> + /usr/share/doc/sisu/markup-samples-non-free/samples/_sisu/skin/yml (or<br> equivalent 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 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> XHTML: xhtml.css -<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 +<p> +<h2><a name='sect61' href='#toc61'>16. Css - Cascading Style Sheets (for Html, Xhtml and Xml)</a></h2> +<br> + +<p> <br> +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 output directories with the command sisu +-CC. +<p> <br> +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> <br> +HTML: html.css +<p> <br> +XML DOM: dom.css +<p> <br> +XML SAX: sax.css +<p> <br> +XHTML: xhtml.css +<p> <br> + +<p>The default homepage may use homepage.css or html.css +<p> <br> +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> +<h2><a name='sect62' href='#toc62'>17. Organising Content</a></h2> +<br> + +<p> +<h2><a name='sect63' href='#toc63'>17.1 Directory Structure and Mapping</a></h2> + +<p> <br> +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> <br> +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, @@ -2226,45 +2728,53 @@ 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 - -<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, -but basically are a file written in the programming language <b>Ruby</b> that -may be provided to change the defaults that are provided with sisu with -respect to individual documents, a directories contents or for a site. -<p> - If you wish to provide a homepage within a skin the skin should be in -the directory _sisu/skin/dir and have the name of the directory for which -it is to become the home page. Documents in the directory commercial_law -would have the homepage modified in skin_commercial law.rb; or the directory - -<p>poems in skin_poems.rb +<h2><a name='sect64' href='#toc64'>18. Homepages</a></h2> +<br> + +<p> <br> +<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> <br> +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> <br> +2. through providing what you want as the home page in a skin, +<p> <br> +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> +<h2><a name='sect65' href='#toc65'>18.1 Home Page and Other +Custom Built Pages in a Sub-directory</a></h2> + +<p> <br> +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> <br> + sisu -CC<br> + <p> +<h2><a name='sect66' href='#toc66'>18.2 Home Page Within a Skin</a></h2> + +<p> <br> +Skins are described in a separate section, but basically are a file written +in the programming language <b>Ruby</b> that may be provided to change the defaults +that are provided with sisu with respect to individual documents, a directories +contents or for a site. +<p> <br> +If you wish to provide a homepage within a skin the skin should be in the +directory _sisu/skin/dir and have the name of the directory for which it +is to become the home page. Documents in the directory commercial_law would +have the homepage modified in skin_commercial law.rb; or the directory poems + +<p>in skin_poems.rb <p> <br> <pre> class Home def homepage @@ -2280,46 +2790,63 @@ index.html end end </pre> -<p> 19. MARKUP AND OUTPUT EXAMPLES -<p> 19.1 MARKUP EXAMPLES -<p> Current markup examples -and document output samples are provided at <<a href='http://www.jus.uio.no/sisu/SiSU/examples.html'>http://www.jus.uio.no/sisu/SiSU/examples.html</a> +<p> +<h2><a name='sect67' href='#toc67'>19. Markup and Output Examples</a></h2> +<br> + +<p> +<h2><a name='sect68' href='#toc68'>19.1 Markup Examples</a></h2> + +<p> <br> +Current markup examples and document output samples are provided at <<a href='http://www.jus.uio.no/sisu/SiSU/examples.html'>http://www.jus.uio.no/sisu/SiSU/examples.html</a> > -<p> For some documents hardly any markup at all is required at all, other -than a header, and an indication that the levels to be taken into account -by the program in generating its output are. -<p> 20. SISU SEARCH - INTRODUCTION +<p> <br> +For some documents hardly any markup at all is required at all, other than +a header, and an indication that the levels to be taken into account by +the program in generating its output are. +<p> +<h2><a name='sect69' href='#toc69'>20. Sisu Search - Introduction</a></h2> +<br> -<p> <b>SiSU</b> output can easily and conveniently be indexed by a number of standalone +<p> <br> +<b>SiSU</b> output can easily and conveniently be indexed by a number of standalone indexing tools, such as Lucene, Hyperestraier. -<p> Because the document structure -of sites created is clearly defined, and the text object citation system -is available hypothetically at least, for all forms of output, it is possible -to search the sql database, and either read results from that database, -or just as simply map the results to the html output, which has richer -text markup. -<p> In addition to this <b>SiSU</b> has the ability to populate a relational -sql type database with documents at an object level, with objects numbers -that are shared across different output types, which make them searchable -with that degree of granularity. Basically, your match criteria is met by -these documents and at these locations within each document, which can -be viewed within the database directly 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[^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 the user of the database should they -so choose). All site texts/documents are (currently) streamed to four tables: - -<p> * one containing semantic (and other) headers, including, title, author,<br> +<p> <br> +Because the document structure of sites created is clearly defined, and +the text object citation system is available hypothetically at least, for +all forms of output, it is possible to search the sql database, and either +read results from that database, or just as simply map the results to the +html output, which has richer text markup. +<p> <br> +In addition to this <b>SiSU</b> has the ability to populate a relational sql type +database with documents at an object level, with objects numbers that are +shared across different output types, which make them searchable with that +degree of granularity. Basically, your match criteria is met by these documents +and at these locations within each document, which can be viewed within +the database directly or in various output formats. +<p> +<h2><a name='sect70' href='#toc70'>21. Sql</a></h2> +<br> + +<p> +<h2><a name='sect71' href='#toc71'>21.1 Populating Sql Type Databases</a></h2> + +<p> <br> +<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> <br> +This is one of the more interesting output forms, as all the structural +data of the documents are retained (though can be ignored by the user of +the database should they so choose). All site texts/documents are (currently) +streamed to four tables: +<p> <br> + * one containing semantic (and other) headers, including, title, author,<br> subject, (the Dublin Core...);<br> -<p> * another the substantive texts by individual "paragraph" (or object) +<p> <br> + * another the substantive texts by individual "paragraph" (or object) - along<br> 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> @@ -2327,85 +2854,103 @@ so choose). All site texts/documents are (currently) streamed to four tables: (both in<br> formatted and clean text versions for searching); and<br> -<p> * a third containing endnotes cross-referenced back to the paragraph -from<br> +<p> <br> + * a third containing endnotes cross-referenced back to the paragraph from<br> which they are referenced (both in formatted and clean text versions for<br> searching).<br> -<p> * a fourth table with a one to one relation with the headers table -contains<br> +<p> <br> + * a fourth table with a one to one relation with the headers table contains<br> full text versions of output, eg. pdf, html, xml, and ascii.<br> -<p> There is of course the possibility to add further structures. -<p> At this -level <b>SiSU</b> loads a relational database with documents chunked into objects, -their smallest logical structurally constituent parts, as text objects, -with their object citation number and all other structural information +<p> <br> +There is of course the possibility to add further structures. +<p> <br> +At this level <b>SiSU</b> loads a relational database with documents chunked into +objects, their smallest logical structurally constituent parts, as text +objects, with their object citation number and all other structural information needed to construct the document. Text is stored (at this text object level) with and without elementary markup tagging, the stripped version being so as to facilitate ease of searching. -<p> Being able to search a relational -database at an object level with the <b>SiSU</b> citation system is an effective -way of locating content generated by <b>SiSU</b> object numbers, and all versions -of the document have the same numbering, complex searches can be tailored -to return just the locations of the search results relevant for all available -output formats, with live links to the precise locations in the database -or in html/xml documents; or, the structural information provided makes -it possible to search the full contents of the database and have headings -in which search content appears, or to search only headings etc. (as the -Dublin Core is incorporated it is easy to make use of that as well). -<p> 22. -POSTGRESQL -<p> 22.1 NAME -<p> <b>SiSU</b> - Structured information, Serialized Units -- a document publishing system, postgresql dependency package -<p> 22.2 DESCRIPTION - -<p> Information related to using postgresql with sisu (and related to the -sisu_postgresql dependency package, which is a dummy package to install -dependencies needed for <b>SiSU</b> to populate a postgresql database, this being -part of <b>SiSU</b> - man sisu). -<p> 22.3 SYNOPSIS -<p> sisu -D [instruction] [filename/wildcard - if required]<br> - -<p> sisu -D --pg --[instruction] [filename/wildcard if required]<br> - -<p> 22.4 COMMANDS -<p> Mappings to two databases are provided by default, postgresql -and sqlite, the same commands are used within sisu to construct and populate -databases however -d (lowercase) denotes sqlite and -D (uppercase) denotes -postgresql, alternatively --sqlite or --pgsql may be used -<p> <b>-D or --pgsql</b> may -be used interchangeably. -<p> 22.4.1 CREATE AND DESTROY DATABASE +<p> <br> +Being able to search a relational database at an object level with the +<b>SiSU</b> citation system is an effective way of locating content generated +by <b>SiSU</b> object numbers, and all versions of the document have the same +numbering, complex searches can be tailored to return just the locations +of the search results relevant for all available output formats, with live +links to the precise locations in the database or in html/xml documents; +or, the structural information provided makes it possible to search the +full contents of the database and have headings in which search content +appears, or to search only headings etc. (as the Dublin Core is incorporated +it is easy to make use of that as well). +<p> +<h2><a name='sect72' href='#toc72'>22. Postgresql</a></h2> +<br> + +<p> +<h2><a name='sect73' href='#toc73'>22.1 Name</a></h2> + +<p> <br> +<b>SiSU</b> - Structured information, Serialized Units - a document publishing system, + +<p>postgresql dependency package +<p> +<h2><a name='sect74' href='#toc74'>22.2 Description</a></h2> + +<p> <br> +Information related to using postgresql with sisu (and related to the sisu_postgresql +dependency package, which is a dummy package to install dependencies needed +for <b>SiSU</b> to populate a postgresql database, this being part of <b>SiSU</b> - man +sisu). +<p> +<h2><a name='sect75' href='#toc75'>22.3 Synopsis</a></h2> + +<p> <br> + sisu -D [instruction] [filename/wildcard if required]<br> + +<p> <br> + sisu -D --pg --[instruction] [filename/wildcard if required]<br> + +<p> +<h2><a name='sect76' href='#toc76'>22.4 Commands</a></h2> + +<p> <br> +Mappings to two databases are provided by default, postgresql and sqlite, +the same commands are used within sisu to construct and populate databases +however -d (lowercase) denotes sqlite and -D (uppercase) denotes postgresql, + +<p>alternatively --sqlite or --pgsql may be used +<p> <br> +<b>-D or --pgsql</b> may be used interchangeably. <p> +<h2><a name='sect77' href='#toc77'>22.4.1 Create and Destroy Database</a></h2> + +<p> + <dl> -<dt><b>--pgsql --createall</b> -</dt> -<dd>initial step, creates required relations (tables, indexes) in existing -(postgresql) database (a database should be created manually and given -the same name as working directory, as requested) (rb.dbi) +<dt><b>--pgsql --createall</b> </dt> +<dd>initial step, creates required relations (tables, indexes) +in existing (postgresql) database (a database should be created manually +and given the same name as working directory, as requested) (rb.dbi) <p> </dd> -<dt><b>sisu -D --createdb</b> -</dt> -<dd> -<p>creates database where no database existed before +<dt><b>sisu +-D --createdb</b> </dt> +<dd>creates database where no database existed before <p> </dd> -<dt><b>sisu -D --create</b> </dt> -<dd>creates - -<p>database tables where no database tables existed before +<dt><b>sisu -D --create</b> +</dt> +<dd> +<p>creates database tables where no database tables existed before <p> </dd> -<dt><b>sisu -D --Dropall</b> -</dt> -<dd>destroys database (including all its content)! kills data and drops tables, -indexes and database associated with a given directory (and directories +<dt><b>sisu -D +--Dropall</b> </dt> +<dd>destroys database (including all its content)! kills data and drops +tables, indexes and database associated with a given directory (and directories of the same name). <p> </dd> @@ -2415,78 +2960,95 @@ of the same name). <p>a new empty database structure <p> </dd> </dl> -22.4.2 IMPORT AND REMOVE DOCUMENTS + +<h2><a name='sect78' href='#toc78'>22.4.2 Import and Remove Documents</a></h2> + <p> <dl> -<dt><b>sisu --D --import -v [filename/wildcard]</b> </dt> -<dd>populates database with the contents of -the file. Imports documents(s) specified to a postgresql database (at an -object level). +<dt><b>sisu -D +--import -v [filename/wildcard]</b> </dt> +<dd>populates database with the contents of the +file. Imports documents(s) specified to a postgresql database (at an object +level). <p> </dd> <dt><b>sisu -D --update -v [filename/wildcard]</b> </dt> -<dd>updates file contents +<dd>updates file contents in database -<p>in database <p> </dd> <dt><b>sisu -D --remove -v [filename/wildcard]</b> </dt> -<dd>removes specified document -from postgresql database. +<dd>removes specified document from postgresql +database. <p> </dd> </dl> -23. SQLITE -<p> 23.1 NAME -<p> <b>SiSU</b> - Structured information, -Serialized Units - a document publishing system. -<p> 23.2 DESCRIPTION -<p> Information -related to using sqlite with sisu (and related to the sisu_sqlite dependency -package, which is a dummy package to install dependencies needed for <b>SiSU</b> -to populate an sqlite database, this being part of <b>SiSU</b> - man sisu). -<p> 23.3 - -<p>SYNOPSIS -<p> sisu -d [instruction] [filename/wildcard if required]<br> - -<p> sisu -d --(sqlite|pg) --[instruction] [filename/wildcard if required]<br> - -<p> 23.4 COMMANDS -<p> Mappings to two databases are provided by default, postgresql -and sqlite, the same commands are used within sisu to construct and populate -databases however -d (lowercase) denotes sqlite and -D (uppercase) denotes -postgresql, alternatively --sqlite or --pgsql may be used -<p> <b>-d or --sqlite</b> may -be used interchangeably. -<p> 23.4.1 CREATE AND DESTROY DATABASE + +<h2><a name='sect79' href='#toc79'>23. Sqlite</a></h2> +<br> + +<p> +<h2><a name='sect80' href='#toc80'>23.1 Name</a></h2> + +<p> <br> +<b>SiSU</b> - Structured information, Serialized Units - a document publishing system. + +<p> +<h2><a name='sect81' href='#toc81'>23.2 Description</a></h2> + +<p> <br> +Information related to using sqlite with sisu (and related to the sisu_sqlite +dependency package, which is a dummy package to install dependencies needed +for <b>SiSU</b> to populate an sqlite database, this being part of <b>SiSU</b> - man sisu). + +<p> +<h2><a name='sect82' href='#toc82'>23.3 Synopsis</a></h2> + +<p> <br> + sisu -d [instruction] [filename/wildcard if required]<br> + +<p> <br> + sisu -d --(sqlite|pg) --[instruction] [filename/wildcard if required]<br> + +<p> +<h2><a name='sect83' href='#toc83'>23.4 Commands</a></h2> + +<p> <br> +Mappings to two databases are provided by default, postgresql and sqlite, +the same commands are used within sisu to construct and populate databases +however -d (lowercase) denotes sqlite and -D (uppercase) denotes postgresql, + +<p>alternatively --sqlite or --pgsql may be used +<p> <br> +<b>-d or --sqlite</b> may be used interchangeably. +<p> +<h2><a name='sect84' href='#toc84'>23.4.1 Create and Destroy Database</a></h2> + <p> + <dl> -<dt><b>--sqlite --createall</b> -</dt> -<dd>initial step, creates required relations (tables, indexes) in existing -(sqlite) database (a database should be created manually and given the -same name as working directory, as requested) (rb.dbi) +<dt><b>--sqlite --createall</b> </dt> +<dd>initial step, creates required relations (tables, indexes) +in existing (sqlite) database (a database should be created manually and +given the same name as working directory, as requested) (rb.dbi) <p> </dd> -<dt><b>sisu -d --createdb</b> -</dt> -<dd> -<p>creates database where no database existed before +<dt><b>sisu -d +--createdb</b> </dt> +<dd>creates database where no database existed before <p> </dd> -<dt><b>sisu -d --create</b> </dt> -<dd>creates - -<p>database tables where no database tables existed before +<dt><b>sisu -d --create</b> +</dt> +<dd> +<p>creates database tables where no database tables existed before <p> </dd> -<dt><b>sisu -d --dropall</b> -</dt> -<dd>destroys database (including all its content)! kills data and drops tables, -indexes and database associated with a given directory (and directories +<dt><b>sisu -d +--dropall</b> </dt> +<dd>destroys database (including all its content)! kills data and drops +tables, indexes and database associated with a given directory (and directories of the same name). <p> </dd> @@ -2496,14 +3058,16 @@ of the same name). <p>a new empty database structure <p> </dd> </dl> -23.4.2 IMPORT AND REMOVE DOCUMENTS + +<h2><a name='sect85' href='#toc85'>23.4.2 Import and Remove Documents</a></h2> + <p> <dl> -<dt><b>sisu --d --import -v [filename/wildcard]</b> </dt> -<dd>populates database with the contents of -the file. Imports documents(s) specified to an sqlite database (at an object +<dt><b>sisu -d +--import -v [filename/wildcard]</b> </dt> +<dd>populates database with the contents of the +file. Imports documents(s) specified to an sqlite database (at an object level). <p> </dd> @@ -2517,38 +3081,44 @@ level). database. <p> </dd> </dl> -24. INTRODUCTION -<p> 24.1 SEARCH - DATABASE FRONTEND SAMPLE, UTILISING -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> -> -[^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 +<h2><a name='sect86' href='#toc86'>24. Introduction</a></h2> +<br> + +<p> +<h2><a name='sect87' href='#toc87'>24.1 Search - Database Frontend Sample, Utilising Database and Sisu Features,</a></h2> +INCLUDING +OBJECT CITATION NUMBERING (BACKEND CURRENTLY POSTGRESQL) +<p> <br> +Sample search frontend <<a href='http://search.sisudoc.org'>http://search.sisudoc.org</a> +> [^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> <br> +<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, 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.[^23] +<p> <br> +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.[^23] <p> <dl> <dt><b>sisu -F --webserv-webrick</b> </dt> -<dd>builds a cgi web search +<dd>builds a cgi web -<p>frontend for the database created -<p> The following is feedback on the setup -on a machine provided by the help command: -<p> sisu --help sql<br> +<p>search frontend for the database created +<p> <br> +The following is feedback on the setup on a machine provided by the help +command: +<p> <br> + sisu --help sql<br> -<p> <p> <br> <pre> Postgresql user: ralph @@ -2559,30 +3129,35 @@ on a machine provided by the help command: current db set: /home/ralph/sisu_www/sisu/sisu_sqlite.db dbi connect DBI:SQLite:/home/ralph/sisu_www/sisu/sisu_sqlite.db </pre> -<p> Note on databases built -<p> By default, [unless otherwise specified] databases -are built on a directory basis, from collections of documents within that -directory. The name of the directory you choose to work from is used as -the database name, i.e. if you are working in a directory called /home/ralph/ebook -the database SiSU_ebook is used. [otherwise a manual mapping for the collection - is +<p> <br> + +<p>Note on databases built +<p> <br> +By default, [unless otherwise specified] databases are built on a directory +basis, from collections of documents within that directory. The name of +the directory you choose to work from is used as the database name, i.e. +if you are working in a directory called /home/ralph/ebook the database +SiSU_ebook is used. [otherwise a manual mapping for the collection is <p> </dd> </dl> -24.2 SEARCH FORM + +<h2><a name='sect88' href='#toc88'>24.2 +Search Form</a></h2> + <p> <dl> <dt><b>sisu -F</b> </dt> -<dd>generates a sample search form, which must +<dd>generates a sample search form, which must be copied -<p>be copied to the web-server cgi directory +<p>to the web-server cgi directory <p> </dd> <dt><b>sisu -F --webserv-webrick</b> </dt> -<dd>generates -a sample search form for use with the webrick server, which must be copied +<dd>generates a sample +search form for use with the webrick server, which must be copied to the -<p>to the web-server cgi directory +<p>web-server cgi directory <p> </dd> <dt><b>sisu -Fv</b> </dt> @@ -2595,196 +3170,265 @@ a sample search form for use with the webrick server, which must be copied <dd>starts the webrick server which should <p>be available wherever sisu is properly installed -<p> The generated search +<p> <br> -<p>form must be copied manually to the webserver directory as instructed -<p> -</dd> +<p>The generated search form must be copied manually to the webserver directory + +<p>as instructed +<p> </dd> </dl> -25. HYPERESTRAIER -<p> See the documentation for hyperestraier: -<p> <<a href='http://hyperestraier.sourceforge.net/'>http://hyperestraier.sourceforge.net/</a> + +<h2><a name='sect89' href='#toc89'>25. Hyperestraier</a></h2> +<br> + +<p> <br> +See the documentation for hyperestraier: +<p> <br> + <<a href='http://hyperestraier.sourceforge.net/'>http://hyperestraier.sourceforge.net/</a> ><br> -<p> /usr/share/doc/hyperestraier/index.html<br> +<p> <br> + /usr/share/doc/hyperestraier/index.html<br> -<p> man estcmd<br> +<p> <br> + man estcmd<br> -<p> NOTE: the examples that follow assume that sisu output is placed in +<p> <br> +NOTE: the examples that follow assume that sisu output is placed in the -<p>the directory /home/ralph/sisu_www -<p> (A) to generate the index within the -webserver directory to be indexed: -<p> estcmd gather -sd [index name] [directory - path to index]<br> +<p>directory /home/ralph/sisu_www +<p> <br> +(A) to generate the index within the webserver directory to be indexed: -<p> the following are examples that will need to be tailored according to -your needs: -<p> cd /home/ralph/sisu_www<br> +<p> <br> + estcmd gather -sd [index name] [directory path to index]<br> -<p> estcmd gather -sd casket /home/ralph/sisu_www<br> +<p> <br> +the following are examples that will need to be tailored according to your +needs: +<p> <br> + cd /home/ralph/sisu_www<br> -<p> you may use the ’find’ command together with ’egrep’ to limit indexing to -particular document collection directories within the web server directory: +<p> <br> + estcmd gather -sd casket /home/ralph/sisu_www<br> -<p> find /home/ralph/sisu_www -type f | egrep<br> +<p> <br> +you may use the ’find’ command together with ’egrep’ to limit indexing to particular +document collection directories within the web server directory: +<p> <br> + find /home/ralph/sisu_www -type f | egrep<br> ’/home/ralph/sisu_www/sisu/.+?.html$’ |estcmd gather -sd casket -<br> -<p> Check which directories in the webserver/output directory (~/sisu_www -or elsewhere depending on configuration) you wish to include in the search +<p> <br> +Check which directories in the webserver/output directory (~/sisu_www or +elsewhere depending on configuration) you wish to include in the search index. -<p> As sisu duplicates output in multiple file formats, it it is probably -preferable to limit the estraier index to html output, and as it may also -be desirable to exclude files ’plain.txt’, ’toc.html’ and ’concordance.html’, as -these duplicate information held in other html output e.g. -<p> find /home/ralph/sisu_www --type f | egrep<br> +<p> <br> +As sisu duplicates output in multiple file formats, it it is probably preferable +to limit the estraier index to html output, and as it may also be desirable +to exclude files ’plain.txt’, ’toc.html’ and ’concordance.html’, as these duplicate +information held in other html output e.g. +<p> <br> + find /home/ralph/sisu_www -type f | egrep<br> ’/sisu_www/(sisu|bookmarks)/.+?.html$’ | egrep -v ’(doc|concordance).html$’<br> |estcmd gather -sd casket -<br> -<p> from your current document preparation/markup directory, you would construct +<p> <br> +from your current document preparation/markup directory, you would construct a rune along the following lines: -<p> find /home/ralph/sisu_www -type f -| egrep ’/home/ralph/sisu_www/([specify <br> +<p> <br> + find /home/ralph/sisu_www -type f | egrep ’/home/ralph/sisu_www/([specify +<br> first directory for inclusion]|[specify second directory for <br> inclusion]|[another directory for inclusion? ...])/.+?.html$’ |<br> egrep -v ’(doc|concordance).html$’ |estcmd gather -sd<br> /home/ralph/sisu_www/casket -<br> -<p> (B) to set up the search form -<p> (i) copy estseek.cgi to your cgi directory -and set file permissions to 755: -<p> sudo cp -vi /usr/lib/estraier/estseek.cgi -/usr/lib/cgi-bin<br> +<p> <br> +(B) to set up the search form +<p> <br> +(i) copy estseek.cgi to your cgi directory and set file permissions to 755: -<p> sudo chmod -v 755 /usr/lib/cgi-bin/estseek.cgi<br> +<p> <br> + sudo cp -vi /usr/lib/estraier/estseek.cgi /usr/lib/cgi-bin<br> -<p> sudo cp -v /usr/share/hyperestraier/estseek.* /usr/lib/cgi-bin<br> +<p> <br> + sudo chmod -v 755 /usr/lib/cgi-bin/estseek.cgi<br> + +<p> <br> + sudo cp -v /usr/share/hyperestraier/estseek.* /usr/lib/cgi-bin<br> -<p> [see estraier documentation for paths]<br> +<p> <br> + [see estraier documentation for paths]<br> -<p> (ii) edit estseek.conf, with attention to the lines starting ’indexname:’ +<p> <br> +(ii) edit estseek.conf, with attention to the lines starting ’indexname:’ and -<p> indexname: /home/ralph/sisu_www/casket<br> +<p> <br> + indexname: /home/ralph/sisu_www/casket<br> -<p> replace: ^file:///home/ralph/sisu_www{{!}}<a href='http://localhost'>http://localhost</a> +<p> <br> + replace: ^file:///home/ralph/sisu_www{{!}}<a href='http://localhost'>http://localhost</a> <br> -<p> replace: /index.html?${{!}}/<br> +<p> <br> + replace: /index.html?${{!}}/<br> -<p> (C) to test using webrick, start webrick: -<p> sisu -W<br> +<p> <br> +(C) to test using webrick, start webrick: +<p> <br> + sisu -W<br> -<p> and try open the url: <<a href='http://localhost:8081/cgi-bin/estseek.cgi'>http://localhost:8081/cgi-bin/estseek.cgi</a> -> -<p> 26. SISU_WEBRICK - -<p> 26.1 NAME -<p> <b>SiSU</b> - Structured information, Serialized Units - a document - -<p>publishing system -<p> 26.2 SYNOPSIS -<p> sisu_webrick [port] -<p> or -<p> sisu -W [port] - -<p> 26.3 DESCRIPTION -<p> sisu_webrick is part of <b>SiSU</b> (man sisu) sisu_webrick -starts <b>Ruby</b> <b>SiSU</b> output is written, providing a list of these directories -(assuming <b>SiSU</b> is in use and they exist). -<p> The default port for sisu_webrick -is set to 8081, this may be modified in the yaml file: ~/.sisu/sisurc.yml -a sample of which is provided as /etc/sisu/sisurc.yml (or in the equivalent -directory on your system). -<p> 26.4 SUMMARY OF MAN PAGE -<p> sisu_webrick, may -be started on it’s own with the command: sisu_webrick [port] or using the -sisu command with the -W flag: sisu -W [port] -<p> where no port is given and - -<p>settings are unchanged the default port is 8081 -<p> 26.5 DOCUMENT PROCESSING - -<p>COMMAND FLAGS -<p> sisu -W [port] starts <b>Ruby</b> Webrick web-server, serving <b>SiSU</b> -output directories, on the port provided, or if no port is provided and - -<p>the defaults have not been changed in ~/.sisu/sisurc.yaml then on port 8081 - -<p> 26.6 FURTHER INFORMATION -<p> For more information on <b>SiSU</b> see: <<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> +<p> <br> +and try open the url: <<a href='http://localhost:8081/cgi-bin/estseek.cgi'>http://localhost:8081/cgi-bin/estseek.cgi</a> > -or <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> +<p> +<h2><a name='sect90' href='#toc90'>26. Sisu_webrick</a></h2> +<br> + +<p> +<h2><a name='sect91' href='#toc91'>26.1 Name</a></h2> + +<p> <br> +<b>SiSU</b> - Structured information, Serialized Units - a document publishing system + +<p> +<h2><a name='sect92' href='#toc92'>26.2 Synopsis</a></h2> + +<p> <br> +sisu_webrick [port] +<p> <br> + +<p>or +<p> <br> +sisu -W [port] +<p> +<h2><a name='sect93' href='#toc93'>26.3 Description</a></h2> + +<p> <br> +sisu_webrick is part of <b>SiSU</b> (man sisu) sisu_webrick starts <b>Ruby</b> <b>SiSU</b> +output is written, providing a list of these directories (assuming <b>SiSU</b> +is in use and they exist). +<p> <br> +The default port for sisu_webrick is set to 8081, this may be modified +in the yaml file: ~/.sisu/sisurc.yml a sample of which is provided as /etc/sisu/sisurc.yml +(or in the equivalent directory on your system). +<p> +<h2><a name='sect94' href='#toc94'>26.4 Summary of Man Page</a></h2> + +<p> +<br> +sisu_webrick, may be started on it’s own with the command: sisu_webrick +[port] or using the sisu command with the -W flag: sisu -W [port] +<p> <br> + +<p>where no port is given and settings are unchanged the default port is 8081 + +<p> +<h2><a name='sect95' href='#toc95'>26.5 Document Processing Command Flags</a></h2> + +<p> <br> +sisu -W [port] starts <b>Ruby</b> Webrick web-server, serving <b>SiSU</b> output directories, +on the port provided, or if no port is provided and the defaults have not + +<p>been changed in ~/.sisu/sisurc.yaml then on port 8081 +<p> +<h2><a name='sect96' href='#toc96'>26.6 Further Information</a></h2> + +<p> +<br> +For more information on <b>SiSU</b> see: <<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> +> or <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> > -<p> or man sisu -<p> 26.7 AUTHOR -<p> Ralph Amissah ralph@amissah.com -<p>or ralph.amissah@gmail.com -<p> 26.8 SEE ALSO -<p> <a href='http:~/bin/man2html?sisu:1'>sisu(1)</a> +<p> <br> + +<p>or man sisu +<p> +<h2><a name='sect97' href='#toc97'>26.7 Author</a></h2> + +<p> <br> +Ralph Amissah <ralph@amissah.com> or <ralph.amissah@gmail.com> +<p> +<h2><a name='sect98' href='#toc98'>26.8 See Also</a></h2> + +<p> <br> + <a href='http:~/bin/man2html?sisu:1'>sisu(1)</a> <br> -<p> <a href='http:~/bin/man2html?sisu_vim:7'>sisu_vim(7)</a> +<p> <br> + <a href='http:~/bin/man2html?sisu_vim:7'>sisu_vim(7)</a> <br> -<p> <a href='http:~/bin/man2html?sisu:8'>sisu(8)</a> +<p> +<h2><a name='sect99' href='#toc99'>27. Remote Source Documents</a></h2> <br> -<p> 27. REMOTE SOURCE DOCUMENTS -<p> <b>SiSU</b> processing instructions can be run -against remote source documents by providing the url of the documents against -which the processing instructions are to be carried out. The remote <b>SiSU</b> -documents can either be sisu marked up files in plaintext .sst or .ssm or; -zipped sisu files, sisupod.zip or filename.ssp -<p> <b>.sst / .ssm - sisu text files</b> +<p> <br> +<b>SiSU</b> processing instructions can be run against remote source documents +by providing the url of the documents against which the processing instructions +are to be carried out. The remote <b>SiSU</b> documents can either be sisu marked +up files in plaintext .sst or .ssm or; zipped sisu files, sisupod.zip or filename.ssp -<p> <b>SiSU</b> can be run against source text files on a remote machine, provide +<p> <br> +<b>.sst / .ssm - sisu text files</b> +<p> <br> +<b>SiSU</b> can be run against source text files on a remote machine, provide the processing instruction and the url. The source file and any associated parts (such as images) will be downloaded and generated locally. -<p> <p> <br> <pre> sisu -3 http://[provide url to valid .sst or .ssm file] </pre> -<p> Any of the source documents in the sisu examples page can be used in -this way, see <<a href='http://www.jus.uio.no/sisu/SiSU/examples.html'>http://www.jus.uio.no/sisu/SiSU/examples.html</a> -> and use the url -to the .sst for the desired document.<br> +<p> <br> +Any of the source documents in the sisu examples page can be used in this +way, see <<a href='http://www.jus.uio.no/sisu/SiSU/examples.html'>http://www.jus.uio.no/sisu/SiSU/examples.html</a> +> and use the url to the + .sst for the desired document.<br> -<p> NOTE: to set up a remote machine to serve <b>SiSU</b> documents in this way, +<p> <br> +NOTE: to set up a remote machine to serve <b>SiSU</b> documents in this way, images -<p>images should be in the directory relative to the document source ../_sisu/image +<p>should be in the directory relative to the document source ../_sisu/image -<p> <b>sisupod - zipped sisu files</b> -<p> A sisupod is the zipped content of a sisu -marked up text or texts and any other associated parts to the document -such as images. -<p> <b>SiSU</b> can be run against a sisupod on a (local or) remote -machine, provide the processing instruction and the url, the sisupod will -be downloaded and the documents it contains generated locally. -<p> +<p> <br> +<b>sisupod - zipped sisu files</b> +<p> <br> +A sisupod is the zipped content of a sisu marked up text or texts and any +other associated parts to the document such as images. +<p> <br> +<b>SiSU</b> can be run against a sisupod on a (local or) remote machine, provide +the processing instruction and the url, the sisupod will be downloaded +and the documents it contains generated locally. <p> <br> <pre> sisu -3 http://[provide url to valid sisupod.zip or .ssp file] </pre> -<p> Any of the source documents in the sisu examples page can be used in -this way, see <<a href='http://www.jus.uio.no/sisu/SiSU/examples.html'>http://www.jus.uio.no/sisu/SiSU/examples.html</a> -> and use the url -for the desired document. -<p> REMOTE DOCUMENT OUTPUT -<p> 28. REMOTE OUTPUT +<p> <br> +Any of the source documents in the sisu examples page can be used in this +way, see <<a href='http://www.jus.uio.no/sisu/SiSU/examples.html'>http://www.jus.uio.no/sisu/SiSU/examples.html</a> +> and use the url for +the desired document. <p> +<h2><a name='sect100' href='#toc100'>Remote Document Output</a></h2> +<br> + +<p> +<h2><a name='sect101' href='#toc101'>28. Remote Output</a></h2> +<br> + +<p> <br> Once properly configured <b>SiSU</b> output can be automatically posted once generated to a designated remote machine using either rsync, or scp. -<p> In order to -do this some ssh authentication agent and keychain or similar tool will -need to be configured. Once that is done the placement on a remote host -can be done seamlessly with the -r (for scp) or -R (for rsync) flag, which -may be used in conjunction with other processing flags, e.g. -<p> +<p> <br> +In order to do this some ssh authentication agent and keychain or similar +tool will need to be configured. Once that is done the placement on a remote +host can be done seamlessly with the -r (for scp) or -R (for rsync) flag, +which may be used in conjunction with other processing flags, e.g. <p> <br> <pre> sisu -3R sisu_remote.sst </pre> -<p> 28.1 COMMANDS +<p> +<h2><a name='sect102' href='#toc102'>28.1 Commands</a></h2> + <p> <dl> @@ -2805,429 +3449,602 @@ information on hostname and username, and that you have your "keys" and ssh agent in place. Also see -R <p> </dd> </dl> -28.2 CONFIGURATION -<p> [expand on the setting - up of an ssh-agent / keychain] -<p> 29. REMOTE SERVERS -<p> As <b>SiSU</b> is generally -operated using the command line, and works within a Unix type environment, -<b>SiSU</b> the program and all documents can just as easily be on a remote server, -to which you are logged on using a terminal, and commands and operations -would be pretty much the same as they would be on your local machine. -<p> 30. -QUICKSTART - GETTING STARTED HOWTO -<p> 30.1 INSTALLATION -<p> Installation is -currently most straightforward and tested on the <b>Debian</b> platform, as there -are packages for the installation of sisu and all requirements for what -it does. -<p> 30.1.1 DEBIAN INSTALLATION -<p> <b>SiSU</b> is available directly from the -<b>Debian</b> Sid and testing archives (and possibly Ubuntu), assuming your /etc/apt/sources.list -is set accordingly: + +<h2><a name='sect103' href='#toc103'>28.2 Configuration</a></h2> + +<p> <br> +[expand on the setting up of an ssh-agent / keychain] <p> +<h2><a name='sect104' href='#toc104'>29. Remote Servers</a></h2> +<br> + +<p> <br> +As <b>SiSU</b> is generally operated using the command line, and works within +a Unix type environment, <b>SiSU</b> the program and all documents can just as +easily be on a remote server, to which you are logged on using a terminal, +and commands and operations would be pretty much the same as they would +be on your local machine. +<p> +<h2><a name='sect105' href='#toc105'>30. Quickstart - Getting Started Howto</a></h2> +<br> + +<p> +<h2><a name='sect106' href='#toc106'>30.1 Installation</a></h2> + +<p> <br> +Installation is currently most straightforward and tested on the <b>Debian</b> +platform, as there are packages for the installation of sisu and all requirements +for what it does. +<p> +<h2><a name='sect107' href='#toc107'>30.1.1 Debian Installation</a></h2> + +<p> <br> +<b>SiSU</b> is available directly from the <b>Debian</b> Sid and testing archives (and +possibly Ubuntu), assuming your /etc/apt/sources.list is set accordingly: + <p> <br> <pre> aptitude update aptitude install sisu-complete </pre> -<p> The following /etc/apt/sources.list setting permits the download of additional +<p> <br> +The following /etc/apt/sources.list setting permits the download of additional markup samples: -<p> <p> <br> <pre> #/etc/apt/sources.list + deb http://ftp.fi.debian.org/debian/ unstable main non-free contrib + deb-src http://ftp.fi.debian.org/debian/ unstable main non-free contrib + </pre> -<p> The aptitude commands become: -<p> +<p> <br> +The aptitude commands become: <p> <br> <pre> aptitude update + aptitude install sisu-complete sisu-markup-samples </pre> -<p> If there are newer versions of <b>SiSU</b> upstream of the <b>Debian</b> archives, +<p> <br> +If there are newer versions of <b>SiSU</b> upstream of the <b>Debian</b> archives, they -<p>they will be available by adding the following to your /etc/apt/sources.list +<p>will be available by adding the following to your /etc/apt/sources.list -<p> <p> <br> <pre> #/etc/apt/sources.list deb http://www.jus.uio.no/sisu/archive unstable main non-free deb-src http://www.jus.uio.no/sisu/archive unstable main non-free </pre> -<p> repeat the aptitude commands -<p> +<p> <br> + +<p>repeat the aptitude commands <p> <br> <pre> aptitude update aptitude install sisu-complete sisu-markup-samples </pre> -<p> Note however that it is not necessary to install sisu-complete if not -all components of sisu are to be used. Installing just the package sisu -will provide basic functionality. -<p> 30.1.2 RPM INSTALLATION -<p> RPMs are provided -though untested, they are prepared by running alien against the source -package, and against the debs. -<p> They may be downloaded from: -<p> <<a href='http://www.jus.uio.no/sisu/SiSU/download.html#rpm'>http://www.jus.uio.no/sisu/SiSU/download.html#rpm</a> +<p> <br> +Note however that it is not necessary to install sisu-complete if not all +components of sisu are to be used. Installing just the package sisu will +provide basic functionality. +<p> +<h2><a name='sect108' href='#toc108'>30.1.2 Rpm Installation</a></h2> + +<p> <br> +RPMs are provided though untested, they are prepared by running alien against +the source package, and against the debs. +<p> <br> +They may be downloaded from: +<p> <br> + <<a href='http://www.jus.uio.no/sisu/SiSU/download.html#rpm'>http://www.jus.uio.no/sisu/SiSU/download.html#rpm</a> ><br> -<p> as root type: -<p> rpm -i [rpm package name]<br> +<p> <br> +as root type: +<p> <br> + rpm -i [rpm package name]<br> -<p> 30.1.3 INSTALLATION FROM SOURCE -<p> To install <b>SiSU</b> from source check information -at: -<p> <<a href='http://www.jus.uio.no/sisu/SiSU/download.html#current'>http://www.jus.uio.no/sisu/SiSU/download.html#current</a> +<p> +<h2><a name='sect109' href='#toc109'>30.1.3 Installation from Source</a></h2> + +<p> <br> +To install <b>SiSU</b> from source check information at: +<p> <br> + <<a href='http://www.jus.uio.no/sisu/SiSU/download.html#current'>http://www.jus.uio.no/sisu/SiSU/download.html#current</a> ><br> -<p> * download the source package -<p> * Unpack the source -<p> 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: -<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, 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)[^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 -the root directory of the unpacked <b>SiSU</b> as root type: -<p> +<p> <br> +* download the source package +<p> <br> +* Unpack the source +<p> <br> +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: + +<p> <br> +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, 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)[^24] or converting LaTeX to +pdf. +<p> <br> + +<p><b>setup.rb</b> +<p> <br> +This is a standard ruby installer, using setup.rb is a three step process. +In the root directory of the unpacked <b>SiSU</b> as root type: <p> <br> <pre> ruby setup.rb config ruby setup.rb setup #[and as root:] ruby setup.rb install </pre> -<p> further information on setup.rb is available from: -<p> <<a href='http://i.loveruby.net/en/projects/setup/'>http://i.loveruby.net/en/projects/setup/</a> +<p> <br> +further information on setup.rb is available from: +<p> <br> + <<a href='http://i.loveruby.net/en/projects/setup/'>http://i.loveruby.net/en/projects/setup/</a> ><br> -<p> <<a href='http://i.loveruby.net/en/projects/setup/doc/usage.html'>http://i.loveruby.net/en/projects/setup/doc/usage.html</a> +<p> <br> + <<a href='http://i.loveruby.net/en/projects/setup/doc/usage.html'>http://i.loveruby.net/en/projects/setup/doc/usage.html</a> ><br> -<p> <b>install</b> -<p> The "install" file provided is an installer prepared using -"rant". In the root directory of the unpacked <b>SiSU</b> as root type: -<p> ruby -install base<br> - -<p> or for a more complete installation: -<p> ruby install<br> - -<p> or -<p> ruby install base<br> - -<p> This makes use of Rant (by Stefan Lang) and the provided Rantfile. It -has been configured to do post installation setup setup configuration and -generation of first test file. Note however, that additional external package -dependencies, such as tetex-extra are not taken care of for you. -<p> Further -information on "rant" is available from: -<p> <<a href='http://make.rubyforge.org/'>http://make.rubyforge.org/</a> +<p> <br> + +<p><b>install</b> +<p> <br> +The "install" file provided is an installer prepared using "rant". In the +root directory of the unpacked <b>SiSU</b> as root type: +<p> <br> + ruby install base<br> + +<p> <br> +or for a more complete installation: +<p> <br> + ruby install<br> + +<p> <br> + +<p>or +<p> <br> + ruby install base<br> + +<p> <br> +This makes use of Rant (by Stefan Lang) and the provided Rantfile. It has +been configured to do post installation setup setup configuration and generation +of first test file. Note however, that additional external package dependencies, +such as tetex-extra are not taken care of for you. +<p> <br> +Further information on "rant" is available from: +<p> <br> + <<a href='http://make.rubyforge.org/'>http://make.rubyforge.org/</a> ><br> -<p> <<a href='http://rubyforge.org/frs/?group_id=615'>http://rubyforge.org/frs/?group_id=615</a> +<p> <br> + <<a href='http://rubyforge.org/frs/?group_id=615'>http://rubyforge.org/frs/?group_id=615</a> ><br> -<p> For a list of alternative actions you may type: -<p> ruby install help<br> +<p> <br> +For a list of alternative actions you may type: +<p> <br> + ruby install help<br> -<p> ruby install -T<br> +<p> <br> + ruby install -T<br> -<p> 30.2 TESTING SISU, GENERATING OUTPUT -<p> To check which version of sisu -is installed: -<p> sisu -v -<p> Depending on your mode of installation one or -a number of markup sample files may be found either in the directory: <p> +<h2><a name='sect110' href='#toc110'>30.2 Testing Sisu, Generating Output</a></h2> -<p> or +<p> <br> +To check which version of sisu is installed: +<p> <br> + +<p>sisu -v +<p> <br> +Depending on your mode of installation one or a number of markup sample +files may be found either in the directory: +<p> <br> + +<p> <br> + +<p>or +<p> <br> + +<p> <br> +change directory to the appropriate one: +<p> <br> + +<p>cd /usr/share/doc/sisu/markup-samples/samples <p> -<p> change directory to the appropriate one: -<p> cd /usr/share/doc/sisu/sisu_markup_samples/dfsg +<h2><a name='sect111' href='#toc111'>30.2.1 Basic Text, Plaintext, +Html, Xml, Odf, Epub</a></h2> -<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> <br> +Having moved to the directory that contains the markup samples (see instructions +above if necessary), choose a file and run sisu against it +<p> <br> -<p>choose a file and run sisu against it -<p> sisu -NhwoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst +<p>sisu -NhwoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst -<p> this will generate html including a concordance file, opendocument text +<p> <br> +this will generate html including a concordance file, opendocument text format, plaintext, XHTML and various forms of XML, and OpenDocument text -<p> 30.2.2 LATEX / PDF -<p> Assuming a LaTeX engine such as tetex or texlive is -installed with the required modules (done automatically on selection of -sisu-pdf in <b>Debian</b> ) -<p> Having moved to the directory that contains the markup -samples (see instructions above if necessary), choose a file and run sisu +<p> +<h2><a name='sect112' href='#toc112'>30.2.2 LaTeX / Pdf</a></h2> -<p>against it -<p> sisu -pv free_as_in_freedom.rms_and_free_software.sam_williams.sst +<p> <br> +Assuming a LaTeX engine such as tetex or texlive is installed with the +required modules (done automatically on selection of sisu-pdf in <b>Debian</b> +) +<p> <br> +Having moved to the directory that contains the markup samples (see instructions +above if necessary), choose a file and run sisu against it +<p> <br> + +<p>sisu -pv free_as_in_freedom.rms_and_free_software.sam_williams.sst +<p> <br> -<p> sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst -<p> should -generate most available output formats: html including a concordance file, -opendocument text format, plaintext, XHTML and various forms of XML, and +<p>sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst +<p> <br> +should generate most available output formats: html including a concordance +file, opendocument text format, plaintext, XHTML and various forms of XML, -<p>OpenDocument text and pdf -<p> 30.2.3 RELATIONAL DATABASE - POSTGRESQL, SQLITE +<p>and OpenDocument text and pdf +<p> +<h2><a name='sect113' href='#toc113'>30.2.3 Relational Database - Postgresql, Sqlite</a></h2> -<p> Relational databases need some setting up - you must have permission to +<p> +<br> +Relational databases need some setting up - you must have permission to create the database and write to it when you run sisu. -<p> Assuming you have +<p> <br> + +<p>Assuming you have the database installed and the requisite permissions -<p>the database installed and the requisite permissions -<p> sisu --sqlite --recreate +<p> <br> -<p> sisu --sqlite -v --import free_as_in_freedom.rms_and_free_software.sam_williams.sst +<p>sisu --sqlite --recreate +<p> <br> -<p> sisu --pgsql --recreate -<p> sisu --pgsql -v --import free_as_in_freedom.rms_and_free_software.sam_williams.sst +<p>sisu --sqlite -v --import free_as_in_freedom.rms_and_free_software.sam_williams.sst -<p> 30.3 GETTING HELP -<p> 30.3.1 THE MAN PAGES -<p> Type: -<p> man sisu<br> +<p> <br> -<p> The man pages are also available online, though not always kept as up -to date as within the package itself: -<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> -> -[^25] -<p> * sisu.8 <<a href='http://www.jus.uio.no/sisu/man/sisu.8.html'>http://www.jus.uio.no/sisu/man/sisu.8.html</a> +<p>sisu --pgsql --recreate +<p> <br> + +<p>sisu --pgsql -v --import free_as_in_freedom.rms_and_free_software.sam_williams.sst + +<p> +<h2><a name='sect114' href='#toc114'>30.3 Getting Help</a></h2> + +<p> +<h2><a name='sect115' href='#toc115'>30.3.1 the Man Pages</a></h2> + +<p> <br> +Type: +<p> <br> + man sisu<br> + +<p> <br> +The man pages are also available online, though not always kept as up to +date as within the package itself: +<p> <br> +* 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> +> [^25] +<p> <br> +* sisu.8 <<a href='http://www.jus.uio.no/sisu/man/sisu.8.html'>http://www.jus.uio.no/sisu/man/sisu.8.html</a> > [^26] -<p> * man directory -<<a href='http://www.jus.uio.no/sisu/man'>http://www.jus.uio.no/sisu/man</a> +<p> <br> +* man directory <<a href='http://www.jus.uio.no/sisu/man'>http://www.jus.uio.no/sisu/man</a> > [^27] -<p> 30.3.2 BUILT IN HELP -<p> sisu --help -<p> sisu +<p> +<h2><a name='sect116' href='#toc116'>30.3.2 Built in Help</a></h2> -<p>- -<p>- -<p>help --env -<p> sisu --help --commands -<p> sisu --help --markup -<p> 30.3.3 THE HOME PAGE +<p> <br> + +<p>sisu --help +<p> <br> + +<p>sisu --help --env +<p> <br> + +<p>sisu --help --commands +<p> <br> + +<p>sisu --help --markup <p> +<h2><a name='sect117' href='#toc117'>30.3.3 the Home Page</a></h2> + +<p> <br> <<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> > -<p> <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> +<p> <br> +<<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> > -<p> <<a href='http://www.jus.uio.no/sisu/SiSU'>http://www.jus.uio.no/sisu/SiSU</a> +<p> <br> +<<a href='http://www.jus.uio.no/sisu/SiSU'>http://www.jus.uio.no/sisu/SiSU</a> > +<p> +<h2><a name='sect118' href='#toc118'>30.4 Markup Samples</a></h2> -<p> 30.4 MARKUP SAMPLES -<p> A number of markup samples (along with output) are -available off: -<p> <<a href='http://www.jus.uio.no/sisu/SiSU/examples.html'>http://www.jus.uio.no/sisu/SiSU/examples.html</a> +<p> <br> +A number of markup samples (along with output) are available off: +<p> <br> +<<a href='http://www.jus.uio.no/sisu/SiSU/examples.html'>http://www.jus.uio.no/sisu/SiSU/examples.html</a> > -<p> Additional -markup samples are packaged separately in the file: -<p> <b>*</b> -<p> 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> <br> +Additional markup samples are packaged separately in the file: +<p> <br> +*** +<p> <br> +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> +<h2><a name='sect119' href='#toc119'>31. Editor Files, Syntax Highlighting</a></h2> +<br> -<p> 31. EDITOR FILES, SYNTAX HIGHLIGHTING -<p> The directory: -<p> ./data/sisu/v2/conf/editor-syntax-etc/<br> +<p> <br> +The directory: +<p> <br> + ./data/sisu/v2/conf/editor-syntax-etc/<br> -<p> ./data/sisu/v3/conf/editor-syntax-etc/<br> +<p> <br> + ./data/sisu/v3/conf/editor-syntax-etc/<br> -<p> /usr/share/sisu/v2/conf/editor-syntax-etc<br> +<p> <br> + /usr/share/sisu/v2/conf/editor-syntax-etc<br> -<p> /usr/share/sisu/v3/conf/editor-syntax-etc<br> +<p> <br> + /usr/share/sisu/v3/conf/editor-syntax-etc<br> -<p> contains rudimentary sisu syntax highlighting files for: -<p> * (g)vim -<<a href='http://www.vim.org'>http://www.vim.org</a> +<p> <br> +contains rudimentary sisu syntax highlighting files for: +<p> <br> +* (g)vim <<a href='http://www.vim.org'>http://www.vim.org</a> > -<p> package: sisu-vim<br> +<p> <br> + package: sisu-vim<br> -<p> status: largely done -<p> there is a vim syntax highlighting and folds -component<br> +<p> <br> +status: largely done +<p> <br> + there is a vim syntax highlighting and folds component<br> -<p> * gedit <<a href='http://www.gnome.org/projects/gedit'>http://www.gnome.org/projects/gedit</a> +<p> <br> +* gedit <<a href='http://www.gnome.org/projects/gedit'>http://www.gnome.org/projects/gedit</a> > -<p> * gobby <<a href='http://gobby.0x539.de/'>http://gobby.0x539.de/</a> +<p> <br> +* gobby <<a href='http://gobby.0x539.de/'>http://gobby.0x539.de/</a> > +<p> <br> + file: sisu.lang<br> -<p> file: sisu.lang<br> +<p> <br> +place in: +<p> <br> + /usr/share/gtksourceview-1.0/language-specs<br> -<p> place in: -<p> /usr/share/gtksourceview-1.0/language-specs<br> +<p> <br> -<p> or -<p> ~/.gnome2/gtksourceview-1.0/language-specs<br> +<p>or +<p> <br> + ~/.gnome2/gtksourceview-1.0/language-specs<br> -<p> status: very basic syntax highlighting<br> +<p> <br> + status: very basic syntax highlighting<br> -<p> comments: this editor features display line wrap and is used by Goby!<br> +<p> <br> + comments: this editor features display line wrap and is used by Goby!<br> -<p> * nano <<a href='http://www.nano-editor.org'>http://www.nano-editor.org</a> +<p> <br> +* nano <<a href='http://www.nano-editor.org'>http://www.nano-editor.org</a> > -<p> file: nanorc<br> +<p> <br> + file: nanorc<br> -<p> save as: -<p> ~/.nanorc<br> +<p> <br> +save as: +<p> <br> + ~/.nanorc<br> -<p> status: basic syntax highlighting<br> +<p> <br> + status: basic syntax highlighting<br> -<p> comments: assumes dark background; no display line-wrap; does line -breaks<br> +<p> <br> + comments: assumes dark background; no display line-wrap; does line breaks<br> -<p> * diakonos (an editor written in ruby) <<a href='http://purepistos.net/diakonos'>http://purepistos.net/diakonos</a> +<p> <br> +* diakonos (an editor written in ruby) <<a href='http://purepistos.net/diakonos'>http://purepistos.net/diakonos</a> > +<p> <br> +file: diakonos.conf +<p> <br> +save as: +<p> <br> + ~/.diakonos/diakonos.conf<br> -<p> file: diakonos.conf -<p> save as: -<p> ~/.diakonos/diakonos.conf<br> - -<p> includes: -<p> status: basic syntax highlighting<br> +<p> <br> +includes: +<p> <br> + status: basic syntax highlighting<br> -<p> comments: assumes dark background; no display line-wrap -<p> * kate & kwrite -<<a href='http://kate.kde.org'>http://kate.kde.org</a> +<p> <br> +comments: assumes dark background; no display line-wrap +<p> <br> +* kate & kwrite <<a href='http://kate.kde.org'>http://kate.kde.org</a> > -<p> file: sisu.xml<br> +<p> <br> + file: sisu.xml<br> -<p> place in:<br> +<p> <br> + place in:<br> -<p> /usr/share/apps/katepart/syntax<br> +<p> <br> + /usr/share/apps/katepart/syntax<br> -<p> or<br> +<p> <br> + or<br> -<p> ~/.kde/share/apps/katepart/syntax<br> +<p> <br> + ~/.kde/share/apps/katepart/syntax<br> -<p> [settings::configure kate::{highlighting,filetypes}]<br> +<p> <br> + [settings::configure kate::{highlighting,filetypes}]<br> -<p> [tools::highlighting::{markup,scripts}:: .B SiSU ]<br> +<p> <br> + [tools::highlighting::{markup,scripts}:: .B SiSU ]<br> -<p> * nedit <<a href='http://www.nedit.org'>http://www.nedit.org</a> +<p> <br> +* nedit <<a href='http://www.nedit.org'>http://www.nedit.org</a> > -<p> file: sisu_nedit.pats<br> +<p> <br> + file: sisu_nedit.pats<br> -<p> nedit -import sisu_nedit.pats<br> +<p> <br> + nedit -import sisu_nedit.pats<br> -<p> status: a very clumsy first attempt [not really done]<br> +<p> <br> + status: a very clumsy first attempt [not really done]<br> -<p> comments: this editor features display line wrap<br> +<p> <br> + comments: this editor features display line wrap<br> -<p> * emacs <<a href='http://www.gnu.org/software/emacs/emacs.html'>http://www.gnu.org/software/emacs/emacs.html</a> +<p> <br> +* emacs <<a href='http://www.gnu.org/software/emacs/emacs.html'>http://www.gnu.org/software/emacs/emacs.html</a> > -<p> files: sisu-mode.el<br> +<p> <br> + files: sisu-mode.el<br> -<p> to file ~/.emacs add the following 2 lines:<br> +<p> <br> + to file ~/.emacs add the following 2 lines:<br> -<p> (add-to-list ’load-path<br> +<p> <br> + (add-to-list ’load-path<br> "/usr/share/sisu/v2/conf/editor-syntax-etc/emacs")<br> -<p> (require ’sisu-mode.el)<br> +<p> <br> + (require ’sisu-mode.el)<br> -<p> [not done / not yet included]<br> +<p> <br> + [not done / not yet included]<br> -<p> * vim & gvim <<a href='http://www.vim.org'>http://www.vim.org</a> +<p> <br> +* vim & gvim <<a href='http://www.vim.org'>http://www.vim.org</a> > -<p> files:<br> +<p> <br> + files:<br> -<p> package is the most comprehensive sisu syntax highlighting and editor<br> +<p> <br> + package is the most comprehensive sisu syntax highlighting and editor<br> environment provided to date (is for vim/ gvim, and is separate from the<br> contents of this directory)<br> -<p> status: this includes: syntax highlighting; vim folds; some error -checking<br> - -<p> comments: this editor features display line wrap<br> - -<p> NOTE: -<p> [ .B SiSU parses files with long lines or line breaks, display - linewrap (without line-breaks) is a convenient editor feature to have for - sisu markup] -<p> 32. HOW DOES SISU WORK? -<p> <b>SiSU</b> markup is fairly minimalistic, -it consists of: a (largely optional) document header, made up of information -about the document (such as when it was published, who authored it, and -granting what rights) and any processing instructions; and markup within -the substantive text of the document, which is related to document structure -and typeface. <b>SiSU</b> must be able to discern the structure of a document, -(text headings and their levels in relation to each other), either from -information provided in the document header or from markup within the text -(or from a combination of both). Processing is done against an abstraction -of the document comprising of information on the document’s structure and -its objects,[2] which the program serializes (providing the object numbers) -and which are assigned hash sum values based on their content. This abstraction -of information about document structure, objects, (and hash sums), provides -considerable flexibility in representing documents different ways and for -different purposes (e.g. search, document layout, publishing, content certification, -concordance etc.), and makes it possible to take advantage of some of the -strengths of established ways of representing documents, (or indeed to -create new ones). -<p> 33. SUMMARY OF FEATURES -<p> * sparse/minimal markup (clean -utf-8 source texts). Documents are prepared in a single UTF-8 file using a -minimalistic mnemonic syntax. Typical literature, documents like "War and -Peace" require almost no markup, and most of the headers are optional. -<p> - * markup is easily readable/parsable by the human eye, (basic markup is +<p> <br> + status: this includes: syntax highlighting; vim folds; some error checking<br> + +<p> <br> + comments: this editor features display line wrap<br> + +<p> <br> +NOTE: +<p> <br> +[ .B SiSU parses files with long lines or line breaks, display linewrap + (without line-breaks) is a convenient editor feature to have for sisu markup] + +<p> +<h2><a name='sect120' href='#toc120'>32. How Does Sisu Work?</a></h2> +<br> + +<p> <br> +<b>SiSU</b> markup is fairly minimalistic, it consists of: a (largely optional) +document header, made up of information about the document (such as when +it was published, who authored it, and granting what rights) and any processing +instructions; and markup within the substantive text of the document, which +is related to document structure and typeface. <b>SiSU</b> must be able to discern +the structure of a document, (text headings and their levels in relation +to each other), either from information provided in the document header +or from markup within the text (or from a combination of both). Processing +is done against an abstraction of the document comprising of information +on the document’s structure and its objects,[2] which the program serializes +(providing the object numbers) and which are assigned hash sum values based +on their content. This abstraction of information about document structure, +objects, (and hash sums), provides considerable flexibility in representing +documents different ways and for different purposes (e.g. search, document +layout, publishing, content certification, concordance etc.), and makes +it possible to take advantage of some of the strengths of established ways +of representing documents, (or indeed to create new ones). +<p> +<h2><a name='sect121' href='#toc121'>33. Summary of +Features</a></h2> +<br> + +<p> <br> +* sparse/minimal markup (clean utf-8 source texts). Documents are prepared +in a single UTF-8 file using a minimalistic mnemonic syntax. Typical literature, +documents like "War and Peace" require almost no markup, and most of the +headers are optional. +<p> <br> +* 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]. -<p> * 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. <b>SiSU</b> 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 paper publication, sql search etc.] (html, 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 +<p> <br> +* 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. <b>SiSU</b> 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 paper publication, sql search etc.] (html, +epub, xml, odf, latex, pdf, sql) +<p> <br> +* 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> <br> + * html - both as a single scrollable text and a segmented document<br> + +<p> <br> + * xhtml<br> + +<p> <br> + * epub<br> + +<p> <br> + * XML - both in sax and dom style xml structures for further development as<br> required<br> -<p> * ODF - open document format, the iso standard for document storage<br> +<p> <br> + * ODF - open document format, the iso standard for document storage<br> -<p> * LaTeX - used to generate pdf<br> +<p> <br> + * LaTeX - used to generate pdf<br> -<p> * pdf (via LaTeX)<br> +<p> <br> + * pdf (via LaTeX)<br> -<p> * sql - population of an sql database, (at the same object level that +<p> <br> + * sql - population of an sql database, (at the same object level that is used<br> to cite text within a document)<br> -<p> Also produces: concordance files; document content certificates (md5 -or sha256 digests of headings, paragraphs, images etc.) and html manifests +<p> <br> +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)) -<p> * -ensuring content can be cited in a meaningful way regardless of selected +<p> <br> +* 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 @@ -3237,266 +4054,320 @@ 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. -<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", 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, - -<p>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 shared on the net may be used as +<p> <br> +* 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> <br> +* 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 +<p> <br> +* SQL search aside, documents are generated as required and static once +generated. +<p> <br> +* 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> <br> +* 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 +<br> +* 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> <br> +* 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, +<p> <br> +* 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 - -<p>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, - -<p>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 +<p> <br> +* as a developers tool it is flexible and extensible +<p> <br> +Syntax highlighting for <b>SiSU</b> markup is available for a number of text editors. + +<p> <br> +<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> <br> +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> <br> +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> - -<p> <b>man2html</b> -<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_help.1.html'>http://www.jus.uio.no/sisu/man/sisu_help.1.html</a> -><br> +<p> +<h2><a name='sect122' href='#toc122'>34. Help Sources</a></h2> +<br> -<p> <b>sisu generated output - links to html</b> -<p> <<a href='http://sisudoc.org/sisu/sisu_help/index.html'>http://sisudoc.org/sisu/sisu_help/index.html</a> -><br> +<p> +<h2><a name='sect123' href='#toc123'>34.1 Man Pages</a></h2> -<p> <b>help sources lists</b> -<p> Alternative sources for this help sources page -listed here: -<p> man sisu_help_sources<br> +<p> <br> + man sisu<br> -<p> <<a href='http://sisudoc.org/sisu/sisu_help_sources/index.html'>http://sisudoc.org/sisu/sisu_help_sources/index.html</a> -><br> +<p> <br> + man sisu-concordance<br> -<p> 34.1 MAN PAGES -<p> 34.1.1 MAN -<p> man sisu<br> +<p> <br> + man sisu-epub<br> -<p> man sisu-concordance<br> +<p> <br> + man sisu-git<br> -<p> man sisu-epub<br> +<p> <br> + man sisu-harvest<br> -<p> man sisu-git<br> +<p> <br> + man sisu-html<br> -<p> man sisu-harvest<br> +<p> <br> + man sisu-odf<br> -<p> man sisu-html<br> +<p> <br> + man sisu-pdf<br> -<p> man sisu-odf<br> +<p> <br> + man sisu-pg<br> -<p> man sisu-pdf<br> +<p> <br> + man sisu-po<br> -<p> man sisu-pg<br> +<p> <br> + man sisu-sqlite<br> -<p> man sisu-po<br> +<p> <br> + man sisu-txt<br> -<p> man sisu-sqlite<br> +<p> <br> + man 7 sisu_complete<br> -<p> man sisu-txt<br> +<p> <br> + man 7 sisu_pdf<br> -<p> man 7 sisu_complete<br> +<p> <br> + man 7 sisu_postgresql<br> -<p> man 7 sisu_pdf<br> +<p> <br> + man 7 sisu_sqlite<br> -<p> man 7 sisu_postgresql<br> +<p> <br> + man sisu_termsheet<br> -<p> man 7 sisu_sqlite<br> +<p> <br> + man sisu_webrick<br> -<p> man sisu_termsheet<br> +<p> +<h2><a name='sect124' href='#toc124'>34.2 Sisu Generated Output - Links to HTML</a></h2> -<p> man sisu_webrick<br> +<p> <br> +Note <b>SiSU</b> documentation is prepared in <b>SiSU</b> 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[^29] +<p> +<h2><a name='sect125' href='#toc125'>34.2.1 Www.sisudoc.org</a></h2> -<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, odf and epub, which may be also be accessed via -the html pages[^29] -<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> +<p> <br> +<<a href='http://sisudoc.org/sisu/sisu_manual/index.html'>http://sisudoc.org/sisu/sisu_manual/index.html</a> > - -<p> <<a href='http://sisudoc.org/sisu/sisu_manual/index.html'>http://sisudoc.org/sisu/sisu_manual/index.html</a> +<p> <br> + <<a href='http://sisudoc.org/sisu/sisu_manual/index.html'>http://sisudoc.org/sisu/sisu_manual/index.html</a> ><br> -<p> 34.3 MAN2HTML -<p> 34.3.1 LOCALLY INSTALLED -<p> file:///usr/share/doc/sisu/html/sisu.1.html +<p> +<h2><a name='sect126' href='#toc126'>34.3 Man2html</a></h2> -<p> file:///usr/share/doc/sisu/html/sisu.1.html<br> +<p> +<h2><a name='sect127' href='#toc127'>34.3.1 Locally Installed</a></h2> -<p> file:///usr/share/doc/sisu/html/sisu_pdf.7.html<br> +<p> <br> -<p> file:///usr/share/doc/sisu/html/sisu_postgresql.7.html<br> +<p>file:///usr/share/doc/sisu/html/sisu.1.html +<p> <br> + file:///usr/share/doc/sisu/html/sisu.1.html<br> -<p> file:///usr/share/doc/sisu/html/sisu_sqlite.7.html<br> +<p> <br> + /usr/share/doc/sisu/html/sisu_pdf.7.html<br> -<p> file:///usr/share/doc/sisu/html/sisu_webrick.1.html<br> +<p> <br> + /usr/share/doc/sisu/html/sisu_postgresql.7.html<br> + +<p> <br> + /usr/share/doc/sisu/html/sisu_sqlite.7.html<br> + +<p> <br> + /usr/share/doc/sisu/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> +<p> +<h2><a name='sect128' href='#toc128'>34.3.2 WWW.jus.uio.no/sisu</a></h2> + +<p> <br> +<<a href='http://www.jus.uio.no/sisu/man/sisu.1.html'>http://www.jus.uio.no/sisu/man/sisu.1.html</a> > -<p> <<a href='http://www.jus.uio.no/sisu/man/sisu.1.html'>http://www.jus.uio.no/sisu/man/sisu.1.html</a> +<p> <br> + <<a href='http://www.jus.uio.no/sisu/man/sisu.1.html'>http://www.jus.uio.no/sisu/man/sisu.1.html</a> ><br> -<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_complete.7.html'>http://www.jus.uio.no/sisu/man/sisu_complete.7.html</a> +<p> <br> + <<a href='http://www.jus.uio.no/sisu/man/sisu_complete.7.html'>http://www.jus.uio.no/sisu/man/sisu_complete.7.html</a> ><br> -<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_pdf.7.html'>http://www.jus.uio.no/sisu/man/sisu_pdf.7.html</a> +<p> <br> + <<a href='http://www.jus.uio.no/sisu/man/sisu_pdf.7.html'>http://www.jus.uio.no/sisu/man/sisu_pdf.7.html</a> ><br> -<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_postgresql.7.html'>http://www.jus.uio.no/sisu/man/sisu_postgresql.7.html</a> +<p> <br> + <<a href='http://www.jus.uio.no/sisu/man/sisu_postgresql.7.html'>http://www.jus.uio.no/sisu/man/sisu_postgresql.7.html</a> ><br> -<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_sqlite.7.html'>http://www.jus.uio.no/sisu/man/sisu_sqlite.7.html</a> +<p> <br> + <<a href='http://www.jus.uio.no/sisu/man/sisu_sqlite.7.html'>http://www.jus.uio.no/sisu/man/sisu_sqlite.7.html</a> ><br> -<p> <<a href='http://www.jus.uio.no/sisu/man/sisu_webrick.1.html'>http://www.jus.uio.no/sisu/man/sisu_webrick.1.html</a> +<p> <br> + <<a href='http://www.jus.uio.no/sisu/man/sisu_webrick.1.html'>http://www.jus.uio.no/sisu/man/sisu_webrick.1.html</a> ><br> -<p> -<ol> -<b>.</b><li>objects include: headings, paragraphs, verse, tables, images, but not +<p> 1. 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, 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> +from which they are referenced. +<p> <br> +2. 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. -<dt><b>*2.</b> </dt> -<dd>square brackets -</dd> +<p> <br> +3. the different heading levels +<p> <br> +4. units of text, primarily paragraphs and headings, also any tables, poems, -<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> -> </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> +<p>code-blocks +<p> <br> +5. 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>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> -<dd>unnumbered asterisk footnote/endnote, -insert multiple asterisks if required </dd> - -<dt><b>**.</b> </dt> -<dd>another unnumbered asterisk footnote/endnote -</dd> - -<dt><b>*3.</b> </dt> -<dd>editors notes, numbered asterisk footnote/endnote series </dd> - -<dt><b>+2.</b> </dt> -<dd>editors -notes, numbered asterisk footnote/endnote series </li><b>.</b><li><<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> +<p> <br> +6. ISO standard ISO/IEC 26300:2006 +<p> <br> +7. An open standard format for e-books +<p> <br> +*1. square brackets +<p> <br> +*2. square brackets +<p> <br> ++1. square brackets +<p> <br> +8. <<a href='http://www.jus.uio.no/sisu/man/'>http://www.jus.uio.no/sisu/man/</a> > +<p> <br> +9. <<a href='http://www.jus.uio.no/sisu/man/sisu.1.html'>http://www.jus.uio.no/sisu/man/sisu.1.html</a> +> +<p> <br> +10. 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. +<p> +<br> +11. files should be prepared using UTF-8 character encoding +<p> <br> +12. a footnote or endnote +<p> <br> +13. self contained endnote marker & endnote in one +<p> <br> +* unnumbered asterisk footnote/endnote, insert multiple asterisks if required -<p> </li><b>.</b><li><<a href='http://www.ruby-lang.org/en/'>http://www.ruby-lang.org/en/</a> -> </li><b>.</b><li>Table from the Wealth of Networks by Yochai -Benkler <<a href='http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler'>http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler</a> -> </li><b>.</b><li>.ssc -(for composite) 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 "accidents", working on a .ssc file that is overwritten by subsequent -processing. It may be however that when the resulting file is shared .ssc -is an appropriate 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> +<p> <br> +** another unnumbered asterisk footnote/endnote +<p> <br> +*3. editors notes, numbered asterisk footnote/endnote series +<p> <br> ++2. editors notes, numbered asterisk footnote/endnote series +<p> <br> +14 <<a href='http://www.sisudoc.org/'>http://www.sisudoc.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> +<p> <br> +15. <<a href='http://www.ruby-lang.org/en/'>http://www.ruby-lang.org/en/</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 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 being added in future. </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> +<p> <br> +16. Table from the Wealth of Networks by Yochai Benkler <<a href='http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler'>http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler</a> > -<p> </li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man/sisu.8.html'>http://www.jus.uio.no/sisu/man/sisu.8.html</a> +<p> <br> +17. .ssc (for composite) 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 subsequent processing. It may be however that when the resulting +file is shared +<p> <br> +19. <<a href='http://www.postgresql.org/'>http://www.postgresql.org/</a> +> <br> +<<a href='http://advocacy.postgresql.org/'>http://advocacy.postgresql.org/</a> +> <br> +<<a href='http://en.wikipedia.org/wiki/Postgresql'>http://en.wikipedia.org/wiki/Postgresql</a> +> <br> +20. <<a href='http://www.hwaci.com/sw/sqlite/'>http://www.hwaci.com/sw/sqlite/</a> +> <br> +<<a href='http://en.wikipedia.org/wiki/Sqlite'>http://en.wikipedia.org/wiki/Sqlite</a> +> <br> +21. <<a href='http://search.sisudoc.org'>http://search.sisudoc.org</a> +> +<p> <br> +22. (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. +<p> <br> +23. 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. +<p> <br> +24. There is nothing to stop MySQL support being added in future. +<p> <br> +25. <<a href='http://www.jus.uio.no/sisu/man/sisu.1.html'>http://www.jus.uio.no/sisu/man/sisu.1.html</a> > -<p> </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>the <b>Debian</b> Free Software guidelines require that everything distributed +<p> <br> +26. <<a href='http://www.jus.uio.no/sisu/man/sisu.8.html'>http://www.jus.uio.no/sisu/man/sisu.8.html</a> +> +<p> <br> +27. <<a href='http://www.jus.uio.no/sisu/man'>http://www.jus.uio.no/sisu/man</a> +> +<p> <br> +28. the <b>Debian</b> Free Software guidelines require that everything distributed within <b>Debian</b> can be changed - and the documents are authors’ works that -while freely distributable are not freely changeable. </li><b>.</b><li>named index.html or - -<p>more extensively through sisu_manifest.html -<p> </li> -</ol> +while freely distributable are not freely changeable. +<p> <br> +29. named index.html or more extensively through sisu_manifest.html <br> -<h2><a name='sect2' href='#toc2'>See Also</a></h2> +<p> +<h2><a name='sect129' href='#toc129'>See Also</a></h2> +<br> <a href='http:~/bin/man2html?sisu:1'><i>sisu</i>(1)</a> , <br> <a href='http:~/bin/man2html?sisu-epub:1'><i>sisu-epub</i>(1)</a> @@ -3518,22 +4389,151 @@ while freely distributable are not freely changeable. </li><b>.</b><li>named ind <a href='http:~/bin/man2html?sisu_vim:7'><i>sisu_vim</i>(7)</a> <p> -<h2><a name='sect3' href='#toc3'>Homepage</a></h2> +<h2><a name='sect130' href='#toc130'>Homepage</a></h2> +<br> More information about <b>SiSU</b> can be found at <<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a> +> or <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> >. <p> -<h2><a name='sect4' href='#toc4'>Author</a></h2> -<b>SiSU</b> was written by Ralph Amissah <<i>ralph@amissah.com</i>>. <p> +<h2><a name='sect131' href='#toc131'>Author</a></h2> +<b>SiSU</b> is written by Ralph Amissah <<i>ralph@amissah.com</i>>. <p> <hr><p> <a name='toc'><b>Table of Contents</b></a><p> <ul> <li><a name='toc0' href='#sect0'>Name</a></li> <li><a name='toc1' href='#sect1'>Synopsis</a></li> -<li><a name='toc2' href='#sect2'>See Also</a></li> -<li><a name='toc3' href='#sect3'>Homepage</a></li> -<li><a name='toc4' href='#sect4'>Author</a></li> +<li><a name='toc2' href='#sect2'>Sisu - Manual,</a></li> +<li><a name='toc3' href='#sect3'>What is Sisu?</a></li> +<li><a name='toc4' href='#sect4'>1. Introduction - What is Sisu?</a></li> +<li><a name='toc5' href='#sect5'>2. Commands Summary</a></li> +<li><a name='toc6' href='#sect6'>2.1 Description</a></li> +<li><a name='toc7' href='#sect7'>2.2 Document Processing Command Flags</a></li> +<li><a name='toc8' href='#sect8'>3. Command Line Modifiers</a></li> +<li><a name='toc9' href='#sect9'>4. Database Commands</a></li> +<li><a name='toc10' href='#sect10'>5. Shortcuts, Shorthand for Multiple Flags</a></li> +<li><a name='toc11' href='#sect11'>5.1 Command Line with Flags - Batch Processing</a></li> +<li><a name='toc12' href='#sect12'>6. Help</a></li> +<li><a name='toc13' href='#sect13'>6.1 Sisu Manual</a></li> +<li><a name='toc14' href='#sect14'>6.2 Sisu Man Pages</a></li> +<li><a name='toc15' href='#sect15'>6.3 Sisu Built-in Interactive Help</a></li> +<li><a name='toc16' href='#sect16'>7. Introduction to Sisu Markup[^10]</a></li> +<li><a name='toc17' href='#sect17'>7.1 Summary</a></li> +<li><a name='toc18' href='#sect18'>7.2 Markup Examples</a></li> +<li><a name='toc19' href='#sect19'>7.2.1 Online</a></li> +<li><a name='toc20' href='#sect20'>7.2.2 Installed</a></li> +<li><a name='toc21' href='#sect21'>8. Markup of Headers</a></li> +<li><a name='toc22' href='#sect22'>8.1 Sample Header</a></li> +<li><a name='toc23' href='#sect23'>8.2 Available Headers</a></li> +<li><a name='toc24' href='#sect24'>9. Markup of Substantive Text</a></li> +<li><a name='toc25' href='#sect25'>9.1 Heading Levels</a></li> +<li><a name='toc26' href='#sect26'>9.2 Font Attributes</a></li> +<li><a name='toc27' href='#sect27'>9.3 Indentation and Bullets</a></li> +<li><a name='toc28' href='#sect28'>9.4 Footnotes / Endnotes</a></li> +<li><a name='toc29' href='#sect29'>9.5 Links</a></li> +<li><a name='toc30' href='#sect30'>9.5.1 Naked Urls Within Text, Dealing with Urls</a></li> +<li><a name='toc31' href='#sect31'>9.5.2 Linking Text</a></li> +<li><a name='toc32' href='#sect32'>9.5.3 Linking Images</a></li> +<li><a name='toc33' href='#sect33'>9.6 Grouped Text</a></li> +<li><a name='toc34' href='#sect34'>9.6.1 Tables</a></li> +<li><a name='toc35' href='#sect35'>9.6.2 Poem</a></li> +<li><a name='toc36' href='#sect36'>9.6.3 Group</a></li> +<li><a name='toc37' href='#sect37'>9.6.4 Code</a></li> +<li><a name='toc38' href='#sect38'>9.7 Book Index</a></li> +<li><a name='toc39' href='#sect39'>10. Composite Documents Markup</a></li> +<li><a name='toc40' href='#sect40'>Markup Syntax History</a></li> +<li><a name='toc41' href='#sect41'>11. Notes Related to Files-types and Markup Syntax</a></li> +<li><a name='toc42' href='#sect42'>12. Sisu Filetypes</a></li> +<li><a name='toc43' href='#sect43'>12.1 .sst .ssm .ssi Marked Up Plain Text</a></li> +<li><a name='toc44' href='#sect44'>12.1.1 Sisu Text - Regular Files (.sst)</a></li> +<li><a name='toc45' href='#sect45'>12.1.2 Sisu Master Files (.ssm)</a></li> +<li><a name='toc46' href='#sect46'>12.1.3 Sisu Insert Files (.ssi)</a></li> +<li><a name='toc47' href='#sect47'>12.2 Sisupod, Zipped Binary Container (sisupod.zip, .ssp)</a></li> +<li><a name='toc48' href='#sect48'>13. Experimental Alternative Input Representations</a></li> +<li><a name='toc49' href='#sect49'>13.1 Alternative Xml</a></li> +<li><a name='toc50' href='#sect50'>13.1.1 Xml Sax Representation</a></li> +<li><a name='toc51' href='#sect51'>13.1.2 Xml Dom Representation</a></li> +<li><a name='toc52' href='#sect52'>13.1.3 Xml Node Representation</a></li> +<li><a name='toc53' href='#sect53'>14. Configuration</a></li> +<li><a name='toc54' href='#sect54'>14.1 Determining the Current Configuration</a></li> +<li><a name='toc55' href='#sect55'>14.2 Configuration Files (config.yml)</a></li> +<li><a name='toc56' href='#sect56'>15. Skins</a></li> +<li><a name='toc57' href='#sect57'>15.1 Document Skin</a></li> +<li><a name='toc58' href='#sect58'>15.2 Directory Skin</a></li> +<li><a name='toc59' href='#sect59'>15.3 Site Skin</a></li> +<li><a name='toc60' href='#sect60'>15.4 Sample Skins</a></li> +<li><a name='toc61' href='#sect61'>16. Css - Cascading Style Sheets (for Html, Xhtml and Xml)</a></li> +<li><a name='toc62' href='#sect62'>17. Organising Content</a></li> +<li><a name='toc63' href='#sect63'>17.1 Directory Structure and Mapping</a></li> +<li><a name='toc64' href='#sect64'>18. Homepages</a></li> +<li><a name='toc65' href='#sect65'>18.1 Home Page and Other Custom Built Pages in a Sub-directory</a></li> +<li><a name='toc66' href='#sect66'>18.2 Home Page Within a Skin</a></li> +<li><a name='toc67' href='#sect67'>19. Markup and Output Examples</a></li> +<li><a name='toc68' href='#sect68'>19.1 Markup Examples</a></li> +<li><a name='toc69' href='#sect69'>20. Sisu Search - Introduction</a></li> +<li><a name='toc70' href='#sect70'>21. Sql</a></li> +<li><a name='toc71' href='#sect71'>21.1 Populating Sql Type Databases</a></li> +<li><a name='toc72' href='#sect72'>22. Postgresql</a></li> +<li><a name='toc73' href='#sect73'>22.1 Name</a></li> +<li><a name='toc74' href='#sect74'>22.2 Description</a></li> +<li><a name='toc75' href='#sect75'>22.3 Synopsis</a></li> +<li><a name='toc76' href='#sect76'>22.4 Commands</a></li> +<li><a name='toc77' href='#sect77'>22.4.1 Create and Destroy Database</a></li> +<li><a name='toc78' href='#sect78'>22.4.2 Import and Remove Documents</a></li> +<li><a name='toc79' href='#sect79'>23. Sqlite</a></li> +<li><a name='toc80' href='#sect80'>23.1 Name</a></li> +<li><a name='toc81' href='#sect81'>23.2 Description</a></li> +<li><a name='toc82' href='#sect82'>23.3 Synopsis</a></li> +<li><a name='toc83' href='#sect83'>23.4 Commands</a></li> +<li><a name='toc84' href='#sect84'>23.4.1 Create and Destroy Database</a></li> +<li><a name='toc85' href='#sect85'>23.4.2 Import and Remove Documents</a></li> +<li><a name='toc86' href='#sect86'>24. Introduction</a></li> +<li><a name='toc87' href='#sect87'>24.1 Search - Database Frontend Sample, Utilising Database and Sisu Features,</a></li> +<li><a name='toc88' href='#sect88'>24.2 Search Form</a></li> +<li><a name='toc89' href='#sect89'>25. Hyperestraier</a></li> +<li><a name='toc90' href='#sect90'>26. Sisu_webrick</a></li> +<li><a name='toc91' href='#sect91'>26.1 Name</a></li> +<li><a name='toc92' href='#sect92'>26.2 Synopsis</a></li> +<li><a name='toc93' href='#sect93'>26.3 Description</a></li> +<li><a name='toc94' href='#sect94'>26.4 Summary of Man Page</a></li> +<li><a name='toc95' href='#sect95'>26.5 Document Processing Command Flags</a></li> +<li><a name='toc96' href='#sect96'>26.6 Further Information</a></li> +<li><a name='toc97' href='#sect97'>26.7 Author</a></li> +<li><a name='toc98' href='#sect98'>26.8 See Also</a></li> +<li><a name='toc99' href='#sect99'>27. Remote Source Documents</a></li> +<li><a name='toc100' href='#sect100'>Remote Document Output</a></li> +<li><a name='toc101' href='#sect101'>28. Remote Output</a></li> +<li><a name='toc102' href='#sect102'>28.1 Commands</a></li> +<li><a name='toc103' href='#sect103'>28.2 Configuration</a></li> +<li><a name='toc104' href='#sect104'>29. Remote Servers</a></li> +<li><a name='toc105' href='#sect105'>30. Quickstart - Getting Started Howto</a></li> +<li><a name='toc106' href='#sect106'>30.1 Installation</a></li> +<li><a name='toc107' href='#sect107'>30.1.1 Debian Installation</a></li> +<li><a name='toc108' href='#sect108'>30.1.2 Rpm Installation</a></li> +<li><a name='toc109' href='#sect109'>30.1.3 Installation from Source</a></li> +<li><a name='toc110' href='#sect110'>30.2 Testing Sisu, Generating Output</a></li> +<li><a name='toc111' href='#sect111'>30.2.1 Basic Text, Plaintext, Html, Xml, Odf, Epub</a></li> +<li><a name='toc112' href='#sect112'>30.2.2 LaTeX / Pdf</a></li> +<li><a name='toc113' href='#sect113'>30.2.3 Relational Database - Postgresql, Sqlite</a></li> +<li><a name='toc114' href='#sect114'>30.3 Getting Help</a></li> +<li><a name='toc115' href='#sect115'>30.3.1 the Man Pages</a></li> +<li><a name='toc116' href='#sect116'>30.3.2 Built in Help</a></li> +<li><a name='toc117' href='#sect117'>30.3.3 the Home Page</a></li> +<li><a name='toc118' href='#sect118'>30.4 Markup Samples</a></li> +<li><a name='toc119' href='#sect119'>31. Editor Files, Syntax Highlighting</a></li> +<li><a name='toc120' href='#sect120'>32. How Does Sisu Work?</a></li> +<li><a name='toc121' href='#sect121'>33. Summary of Features</a></li> +<li><a name='toc122' href='#sect122'>34. Help Sources</a></li> +<li><a name='toc123' href='#sect123'>34.1 Man Pages</a></li> +<li><a name='toc124' href='#sect124'>34.2 Sisu Generated Output - Links to HTML</a></li> +<li><a name='toc125' href='#sect125'>34.2.1 Www.sisudoc.org</a></li> +<li><a name='toc126' href='#sect126'>34.3 Man2html</a></li> +<li><a name='toc127' href='#sect127'>34.3.1 Locally Installed</a></li> +<li><a name='toc128' href='#sect128'>34.3.2 WWW.jus.uio.no/sisu</a></li> +<li><a name='toc129' href='#sect129'>See Also</a></li> +<li><a name='toc130' href='#sect130'>Homepage</a></li> +<li><a name='toc131' href='#sect131'>Author</a></li> </ul> </body> </html> diff --git a/man/man1/sisu.1 b/man/man1/sisu.1 index e90d76c0..c0676d20 100644 --- a/man/man1/sisu.1 +++ b/man/man1/sisu.1 @@ -1,37 +1,38 @@ -.TH "sisu" "1" "2011-03-05" "2.8.1" "SiSU" +.TH "sisu" "1" "2011-03-09" "3.0.3-beta-rb1.9.2p180" "SiSU" +.br .SH NAME +.br sisu - documents: markup, structuring, publishing in multiple standard formats, and search +.br .SH SYNOPSIS +.br sisu [-abcDdFehIiMmNnopqRrSsTtUuVvwXxYyZz0-9] [filename/wildcard] -.BR +.br sisu [-Ddcv] [instruction] [filename/wildcard] -.BR +.br sisu [-CcFLSVvW] -.BR +.br sisu --v2 [operations] -.BR +.br sisu --v3 [operations] -.BR +.br sisu3 [operations] -.SH -SISU - MANUAL, +.SH SISU - MANUAL, RALPH AMISSAH -.BR +.br -.SH -WHAT IS SISU? -.BR +.SH WHAT IS SISU? +.br -.SH -1. INTRODUCTION - WHAT IS SISU? -.BR +.SH 1. INTRODUCTION - WHAT IS SISU? +.br -.BR +.br .B SiSU is a framework for document structuring, publishing (in multiple open standard formats) and search, comprising of: (a) a lightweight document @@ -41,7 +42,7 @@ 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. -.BR +.br .B 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 @@ -50,7 +51,7 @@ 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. -.BR +.br .B SiSU both defines a markup syntax and provides an engine that produces open standards format outputs from documents prepared with @@ -69,7 +70,7 @@ added to and updated. is also able to populate SQL type databases at an object level, which means that searches can be made with that degree of granularity. -.BR +.br 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 @@ -89,7 +90,7 @@ 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. -.BR +.br In preparing a .B SiSU document you optionally provide semantic information related to the document @@ -99,7 +100,7 @@ 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. -.BR +.br .B SiSU works with an abstraction of the document based on its structure which is comprised of its headings[^3] and objects[^4], which enables @@ -117,7 +118,7 @@ object numbering also has implications for search that .B SiSU is able to take advantage of. -.BR +.br 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 @@ -149,12 +150,12 @@ 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). -.BR +.br 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. -.BR +.br .B SiSU also provides other features such as concordance files and document content certificates, and the working against an abstraction of document structure has @@ -164,7 +165,7 @@ maps and thesauri, together with the flexibility of .B SiSU offers great possibilities. -.BR +.br .B SiSU is primarily for published works, which can take advantage of the citation system to reliably reference its documents. @@ -175,20 +176,18 @@ content prepared in .B SiSU . -.BR +.br <http://www.sisudoc.org/> -.BR +.br <http://www.jus.uio.no/sisu> -.SH -2. COMMANDS SUMMARY -.BR +.SH 2. COMMANDS SUMMARY +.br -.SH -2.1 DESCRIPTION +.SH 2.1 DESCRIPTION -.BR +.br .B SiSU .B SiSU is a document publishing system, that from a simple single marked-up @@ -198,8 +197,7 @@ SQLite), which share numbered text objects ("object citation numbering") and the same document structure information. For more see: <http://www.jus.uio.no/sisu> -.SH -2.2 DOCUMENT PROCESSING COMMAND FLAGS +.SH 2.2 DOCUMENT PROCESSING COMMAND FLAGS .TP .B -a [filename/wildcard] @@ -651,9 +649,8 @@ will remove the related document output directory. Alias -Z .B -Z [filename/wildcard] see --zap -.SH -3. COMMAND LINE MODIFIERS -.BR +.SH 3. COMMAND LINE MODIFIERS +.br .TP .B --no-ocn @@ -674,14 +671,13 @@ strips output text of editor endnotes[^*2] denoted by asterisk sign .B --no-dagger strips output text of editor endnotes[^+1] denoted by dagger/plus sign -.SH -4. DATABASE COMMANDS -.BR +.SH 4. DATABASE COMMANDS +.br -.BR +.br dbi - database interface -.BR +.br -D or --pgsql set for postgresql -d or --sqlite default set for sqlite -d is modifiable with --db=[database \ type \ (pgsql \ or \ sqlite)] @@ -716,12 +712,11 @@ Please use only alphanumerics and underscores. kills data" and drops (postgresql or sqlite) db, tables & indexes [ \ -d \ --dropall \ sqlite \ equivalent] -.BR +.br The -v is for verbose output. -.SH -5. SHORTCUTS, SHORTHAND FOR MULTIPLE FLAGS -.BR +.SH 5. SHORTCUTS, SHORTHAND FOR MULTIPLE FLAGS +.br .TP .B --update [filename/wildcard] @@ -761,74 +756,64 @@ options \ are \ give, \ i.e. \ on \ 'sisu \ [filename]'] .B -5 -mhewpAobxXDyY --update -.BR +.br add -v for verbose mode and -c for color, e.g. sisu -2vc [filename \ or \ wildcard] -.BR +.br consider -u for appended url info or -v for verbose output -.SH -5.1 COMMAND LINE WITH FLAGS - BATCH PROCESSING +.SH 5.1 COMMAND LINE WITH FLAGS - BATCH PROCESSING -.BR +.br In the data directory run sisu -mh filename or wildcard eg. "sisu -h cisg.sst" or "sisu -h *.{sst,ssm}" to produce html version of all documents. -.BR +.br 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. -.SH -6. HELP -.BR +.SH 6. HELP +.br -.SH -6.1 SISU MANUAL +.SH 6.1 SISU MANUAL -.BR +.br The most up to date information on sisu should be contained in the sisu_manual, available at: -.BR +.br <http://sisudoc.org/sisu/sisu_manual/> -.BR +.br The manual can be generated from source, found respectively, either within the .B SiSU tarball or installed locally at: -.BR +.br ./data/doc/sisu/markup-samples/sisu_manual -.BR +.br /usr/share/doc/sisu/markup-samples/sisu_manual -.BR +.br move to the respective directory and type e.g.: -.BR +.br sisu sisu_manual.ssm -.SH -6.2 SISU MAN PAGES +.SH 6.2 SISU MAN PAGES -.BR +.br If .B SiSU is installed on your system usual man commands should be available, try: -.BR +.br man sisu -.BR - man sisu_markup - -.BR - man sisu_commands - -.BR +.br Most .B SiSU man pages are generated directly from sisu documents that are used to prepare @@ -836,224 +821,188 @@ the sisu manual, the sources files for which are located within the .B SiSU tarball at: -.BR +.br ./data/doc/sisu/markup-samples/sisu_manual -.BR +.br Once installed, directory equivalent to: -.BR +.br /usr/share/doc/sisu/markup-samples/sisu_manual -.BR +.br Available man pages are converted back to html using man2html: -.BR +.br /usr/share/doc/sisu/html/ -.BR +.br ./data/doc/sisu/html -.BR +.br An online version of the sisu man page is available here: -.BR +.br * various sisu man pages <http://www.jus.uio.no/sisu/man/> [^8] -.BR +.br * sisu.1 <http://www.jus.uio.no/sisu/man/sisu.1.html> [^9] -.SH -6.3 SISU BUILT-IN INTERACTIVE HELP +.SH 6.3 SISU BUILT-IN INTERACTIVE HELP -.BR +.br This is particularly useful for getting the current sisu setup/environment information: -.BR +.br sisu --help -.BR +.br sisu --help [subject] -.BR +.br sisu --help commands -.BR +.br sisu --help markup -.BR +.br sisu --help env [for \ feedback \ on \ the \ way \ your \ system \ is \ setup \ with \ regard \ to \ sisu] -.BR +.br sisu -V [environment \ information, \ same \ as \ above \ command] -.BR +.br sisu (on its own provides version and some help information) -.BR +.br Apart from real-time information on your current configuration the .B SiSU manual and man pages are likely to contain more up-to-date information than the sisu interactive help (for example on commands and markup). -.BR +.br NOTE: Running the command 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. -.SH -6.4 HELP SOURCES - -.BR -For lists of alternative help sources, see: - -.BR -.B man page - -.BR - man sisu_help_sources - -.BR -.B man2html - -.BR - /usr/share/doc/sisu/v2/html/sisu.1.html - -.BR - <http://sisudoc.org/sisu/sisu_help_sources/index.html> - -.SH -7. INTRODUCTION TO SISU MARKUP[^10] -.BR +.SH 7. INTRODUCTION TO SISU MARKUP[^10] +.br -.SH -7.1 SUMMARY +.SH 7.1 SUMMARY -.BR +.br .B SiSU source documents are plaintext (UTF-8)[^11] files -.BR +.br All paragraphs are separated by an empty line. -.BR +.br Markup is comprised of: -.BR +.br * at the top of a document, the document header made up of semantic meta-data about the document and if desired additional processing instructions (such an instruction to automatically number headings from a particular level down) -.BR +.br * followed by the prepared substantive text of which the most important single characteristic is the markup of different heading levels, which define the primary outline of the document structure. Markup of substantive text includes: -.BR +.br * heading levels defines document structure -.BR +.br * text basic attributes, italics, bold etc. -.BR +.br * grouped text (objects), which are to be treated differently, such as code blocks or poems. -.BR +.br * footnotes/endnotes -.BR +.br * linked text and images -.BR +.br * paragraph actions, such as indent, bulleted, numbered-lists, etc. -.BR +.br Some interactive help on markup is available, by typing sisu and selecting markup or sisu --help markup -.BR +.br To check the markup in a file: -.BR +.br sisu --identify [filename].sst -.BR +.br For brief descriptive summary of markup history -.BR +.br sisu --query-history -.BR +.br or if for a particular version: -.BR +.br sisu --query-0.38 -.SH -7.2 MARKUP EXAMPLES +.SH 7.2 MARKUP EXAMPLES -.SH -7.2.1 ONLINE +.SH 7.2.1 ONLINE -.BR +.br Online markup examples are available together with the respective outputs produced from <http://www.jus.uio.no/sisu/SiSU/examples.html> or from <http://www.jus.uio.no/sisu/sisu_examples/> -.BR +.br There is of course this document, which provides a cursory overview of sisu markup and the respective output produced: <http://www.jus.uio.no/sisu/sisu_markup/> -.BR -Some example marked up files are available as html with syntax highlighting for -viewing: <http://www.jus.uio.no/sisu/sample/syntax> - -.BR +.br an alternative presentation of markup syntax: -<http://www.jus.uio.no/sisu/sample/on_markup.txt> +/usr/share/doc/sisu/on_markup.txt.gz -.SH -7.2.2 INSTALLED +.SH 7.2.2 INSTALLED -.BR +.br With .B SiSU -installed sample skins may be found in: -/usr/share/doc/sisu/sisu_markup_samples/dfsg (or equivalent directory) and if -sisu-markup-samples is installed also under: -/usr/share/doc/sisu/sisu_markup_samples/non-free +installed sample skins may be found in: /usr/share/doc/sisu/markup-samples +(or equivalent directory) and if sisu-markup-samples is installed also under: +/usr/share/doc/sisu/markup-samples-non-free -.SH -8. MARKUP OF HEADERS -.BR +.SH 8. MARKUP OF HEADERS +.br -.BR +.br Headers contain either: semantic meta-data about a document, which can be used by any output module of the program, or; processing instructions. -.BR +.br Note: the first line of a document may include information on the markup version used in the form of a comment. Comments are a percentage mark at the start of a paragraph (and as the first character in a line of text) followed by a space and the comment: - .nf % this would be a comment .fi -.SH -8.1 SAMPLE HEADER +.SH 8.1 SAMPLE HEADER -.BR +.br This current document is loaded by a master document that has a header similar to this one: - .nf % SiSU master 2.0 @title: SiSU @@ -1067,12 +1016,14 @@ to this one: electronic document, electronic citation, data structure, citation systems, search % used_by: manual - @date: :published: 2008-05-22 + @date: + :published: 2008-05-22 :created: 2002-08-28 :issued: 2002-08-28 :available: 2002-08-28 :modified: 2010-03-03 - @make: :num_top: 1 + @make: + :num_top: 1 :breaks: new=C; break=1 :skin: skin_sisu_manual :bold: /Gnu|Debian|Ruby|SiSU/ @@ -1082,46 +1033,45 @@ to this one: . sisu \ [-Ddcv] \ [instruction] . sisu \ [-CcFLSVvW] . sisu --v2 \ [operations] - . sisu --v1 \ [operations] - @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/ + . sisu --v3 \ [operations] + @links: + { SiSU Homepage }http://www.sisudoc.org/ + { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/ + { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary + { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU .fi -.SH -8.2 AVAILABLE HEADERS +.SH 8.2 AVAILABLE HEADERS -.BR +.br Header tags appear at the beginning of a document and provide meta information on the document (such as the Dublin Core), or information as to how the document as a whole is to be processed. All header instructions take the form @headername: or on the next line and indented by once space :subheadername: All Dublin Core meta tags are available -.BR +.br .B @indentifier: information or instructions -.BR +.br where the "identifier" is a tag recognised by the program, and the "information" or "instructions" belong to the tag/indentifier specified -.BR +.br Note: a header where used should only be used once; all headers apart from @title: are optional; the @structure: header is used to describe document structure, and can be useful to know. -.BR +.br This is a sample header - .nf % SiSU 2.0 \ [declared \ file-type \ identifier \ with \ markup \ version] .fi @@ -1133,14 +1083,16 @@ This is a sample header .fi .nf - @creator: :author: \ [Lastname, \ First \ names] + @creator: + :author: \ [Lastname, \ First \ names] :illustrator: \ [Lastname, \ First \ names] :translator: \ [Lastname, \ First \ names] :prepared_by: \ [Lastname, \ First \ names] .fi .nf - @date: :published: \ [year \ or \ yyyy-mm-dd] + @date: + :published: \ [year \ or \ yyyy-mm-dd] :created: \ [year \ or \ yyyy-mm-dd] :issued: \ [year \ or \ yyyy-mm-dd] :available: \ [year \ or \ yyyy-mm-dd] @@ -1151,7 +1103,8 @@ This is a sample header .fi .nf - @rights: :copyright: Copyright (C) \ [Year \ and \ Holder] + @rights: + :copyright: Copyright (C) \ [Year \ and \ Holder] :license: \ [Use \ License \ granted] :text: \ [Year \ and \ Holder] :translation: \ [Name, \ Year] @@ -1168,8 +1121,8 @@ This is a sample header :abstract: :isbn: \ [ISBN] :loc: \ [Library \ of \ Congress \ classification] - :dewey: \ [Dewey \ classification - :pg: \ [Project \ Gutenberg \ text \ number] + :dewey: \ [Dewey \ classification] + :pg: \ [Project \ Gutenberg \ text \ number] .fi .nf @@ -1192,42 +1145,42 @@ This is a sample header .fi .nf - @original: :language: \ [language] + @original: + :language: \ [language] .fi .nf - @notes: :comment: + @notes: + :comment: :prefix: \ [prefix \ is \ placed \ just \ after \ table \ of \ contents] .fi -.SH -9. MARKUP OF SUBSTANTIVE TEXT -.BR +.SH 9. MARKUP OF SUBSTANTIVE TEXT +.br -.SH -9.1 HEADING LEVELS +.SH 9.1 HEADING LEVELS -.BR +.br Heading levels are :A~ ,:B~ ,:C~ ,1~ ,2~ ,3~ \... :A - :C being part / section headings, followed by other heading levels, and 1 -6 being headings followed by substantive text or sub-headings. :A~ usually the title :A~? conditional level 1 heading (used where a stand-alone document may be imported into another) -.BR +.br .B :A~ [heading \ text] Top level heading [this \ usually \ has \ similar \ content \ to \ the \ title \ @title: \ ] NOTE: the heading levels described here are in 0.38 notation, see heading -.BR +.br .B :B~ [heading \ text] Second level heading [this \ is \ a \ heading \ level \ divider] -.BR +.br .B :C~ [heading \ text] Third level heading [this \ is \ a \ heading \ level \ divider] -.BR +.br .B 1~ [heading \ text] Top level heading preceding substantive text of document or sub-heading 2, the heading level that would normally be marked 1. or 2. or 3. etc. in a @@ -1235,18 +1188,17 @@ document, and the level on which sisu by default would break html output into named segments, names are provided automatically if none are given (a number), otherwise takes the form 1~my_filename_for_this_segment -.BR +.br .B 2~ [heading \ text] Second level heading preceding substantive text of document or sub-heading 3 , the heading level that would normally be marked 1.1 or 1.2 or 1.3 or 2.1 etc. in a document. -.BR +.br .B 3~ [heading \ text] Third level heading preceding substantive text of document, that would normally be marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a document - .nf 1~filename level 1 heading, % the primary division such as Chapter that is followed by substantive text, @@ -1254,43 +1206,41 @@ normally be marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a document % segments are made) .fi -.SH -9.2 FONT ATTRIBUTES +.SH 9.2 FONT ATTRIBUTES -.BR +.br .B markup example: - .nf normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}", ^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}-, #{monospace}# normal text -.BR +.br *{emphasis}* \ [note: \ can \ be \ configured \ to \ be \ represented \ by \ bold, \ italics \ or \ underscore] -.BR +.br !{bold text}! -.BR +.br _{underscore}_ -.BR +.br /{italics}/ -.BR +.br "{citation}" -.BR +.br ^{superscript}^ -.BR +.br ,{subscript}, -.BR +.br +{inserted text}+ -.BR +.br \-{strikethrough}\- -.BR +.br #{monospace}# .fi -.BR +.br .B resulting output: -.BR +.br normal text, .B emphasis , @@ -1302,371 +1252,346 @@ normal text, , "citation", ^superscript^, [subscript], ++inserted text++, --strikethrough--, monospace -.BR +.br normal text -.BR +.br .B emphasis [note: \ can \ be \ configured \ to \ be \ represented \ by \ bold, \ italics \ or \ underscore] -.BR +.br .B bold text -.BR +.br .I italics -.BR +.br .I underscore -.BR +.br "citation" -.BR +.br ^superscript^ -.BR +.br [subscript] -.BR +.br ++inserted text++ -.BR +.br --strikethrough-- -.BR +.br monospace -.SH -9.3 INDENTATION AND BULLETS +.SH 9.3 INDENTATION AND BULLETS -.BR +.br .B markup example: - .nf ordinary paragraph -.BR +.br _1 indent paragraph one step -.BR +.br _2 indent paragraph two steps -.BR +.br _9 indent paragraph nine steps .fi - +.br .B resulting output: -.BR +.br ordinary paragraph -.BR +.br indent paragraph one step -.BR +.br indent paragraph two steps -.BR +.br indent paragraph nine steps -.BR +.br .B markup example: - .nf _* bullet text -.BR +.br _1* bullet text, first indent -.BR +.br _2* bullet text, two step indent .fi -.BR +.br .B resulting output: -.BR +.br * bullet text -.BR +.br * bullet text, first indent -.BR +.br * bullet text, two step indent -.BR +.br Numbered List (not to be confused with headings/titles, (document structure)) -.BR +.br .B markup example: - .nf # numbered list numbered list 1., 2., 3, etc. -.BR +.br _# numbered list numbered list indented a., b., c., d., etc. .fi -.SH -9.4 FOOTNOTES / ENDNOTES +.SH 9.4 FOOTNOTES / ENDNOTES -.BR +.br Footnotes and endnotes are marked up at the location where they would be indicated within a text. They are automatically numbered. The output type determines whether footnotes or endnotes will be produced -.BR +.br .B markup example: - .nf ~{ a footnote or endnote }~ .fi -.BR +.br .B resulting output: -.BR +.br [^12] -.BR +.br .B markup example: - .nf normal text~{ self contained endnote marker & endnote in one }~ continues .fi -.BR +.br .B resulting output: -.BR +.br normal text[^13] continues -.BR +.br .B markup example: - .nf normal text ~{* unnumbered asterisk footnote/endnote, insert multiple asterisks if required }~ continues -.BR +.br normal text ~{** another unnumbered asterisk footnote/endnote }~ continues .fi -.BR +.br .B resulting output: -.BR +.br normal text [^*] continues -.BR +.br normal text [^**] continues -.BR +.br .B markup example: - .nf normal text ~[* \ editors \ notes, \ numbered \ asterisk \ footnote/endnote \ series \ ]~ continues -.BR +.br normal text ~[+ \ editors \ notes, \ numbered \ asterisk \ footnote/endnote \ series \ ]~ continues .fi -.BR +.br .B resulting output: -.BR +.br normal text [^*3] continues -.BR +.br normal text [^+2] continues -.BR +.br .B Alternative endnote pair notation for footnotes/endnotes: - .nf % note the endnote marker "~^" normal text~^ continues -.BR +.br ^~ endnote text following the paragraph in which the marker occurs .fi -.BR +.br the standard and pair notation cannot be mixed in the same document -.SH -9.5 LINKS +.SH 9.5 LINKS -.SH -9.5.1 NAKED URLS WITHIN TEXT, DEALING WITH URLS +.SH 9.5.1 NAKED URLS WITHIN TEXT, DEALING WITH URLS -.BR +.br urls found within text are marked up automatically. A url within text is automatically hyperlinked to itself and by default decorated with angled braces, unless they are contained within a code block (in which case they are passed as normal text), or escaped by a preceding underscore (in which case the decoration is omitted). -.BR +.br .B markup example: - .nf normal text http://www.sisudoc.org/ continues .fi -.BR +.br .B resulting output: -.BR +.br normal text <http://www.sisudoc.org/> continues -.BR +.br An escaped url without decoration -.BR +.br .B markup example: - .nf normal text _http://www.sisudoc.org/ continues deb http://www.jus.uio.no/sisu/archive unstable main non-free .fi -.BR +.br .B resulting output: -.BR +.br normal text <_http://www.sisudoc.org/> continues -.BR +.br deb <_http://www.jus.uio.no/sisu/archive> unstable main non-free -.BR +.br where a code block is used there is neither decoration nor hyperlinking, code blocks are discussed later in this document -.BR +.br .B resulting output: - .nf deb http://www.jus.uio.no/sisu/archive unstable main non-free -.BR +.br deb-src http://www.jus.uio.no/sisu/archive unstable main non-free .fi -.SH -9.5.2 LINKING TEXT +.SH 9.5.2 LINKING TEXT -.BR +.br To link text or an image to a url the markup is as follows -.BR +.br .B markup example: - .nf about { SiSU }http://url.org markup .fi -.BR +.br .B resulting output: -.BR +.br aboutSiSU <http://www.sisudoc.org/> markup -.BR +.br A shortcut notation is available so the url link may also be provided automatically as a footnote -.BR +.br .B markup example: - .nf about {~^ SiSU }http://url.org markup .fi -.BR +.br .B resulting output: -.BR +.br about SiSU <http://www.sisudoc.org/> [^14] markup -.SH -9.5.3 LINKING IMAGES +.SH 9.5.3 LINKING IMAGES -.BR +.br .B markup example: - .nf { tux.png 64x80 }image -.BR +.br % various url linked images -.BR +.br {tux.png 64x80 "a better way" }http://www.sisudoc.org/ -.BR -.BR +.br +.br {GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian and Ruby" }http://www.sisudoc.org/ -.BR -.BR +.br +.br {~^ ruby_logo.png "Ruby" }http://www.ruby-lang.org/en/ -.BR -.BR +.br +.br .fi -.BR +.br .B resulting output: -.BR +.br [ tux.png ] -.BR +.br tux.png 64x80 "Gnu/Linux - a better way" <http://www.sisudoc.org/> -.BR +.br [ \ ruby_logo \ (png \ missing) \ ] [^15] -.BR +.br GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian and Ruby" <http://www.jus.uio.no/sisu/> -.BR +.br .B linked url footnote shortcut - .nf {~^ \ [text \ to \ link] }http://url.org % maps to: { \ [text \ to \ link] }http://url.org ~{ http://url.org }~ % which produces hyper-linked text within a document/paragraph, - with an endnote providing the url for the text location used in the hyperlink + % with an endnote providing the url for the text location used in the hyperlink .fi - .nf text marker *~name .fi -.BR +.br note at a heading level the same is automatically achieved by providing names to headings 1, 2 and 3 i.e. 2~[name] and 3~[name] or in the case of auto-heading numbering, without further intervention. -.SH -9.6 GROUPED TEXT +.SH 9.6 GROUPED TEXT -.SH -9.6.1 TABLES +.SH 9.6.1 TABLES -.BR +.br Tables may be prepared in two either of two forms -.BR +.br .B markup example: - .nf table{ c3; 40; 30; 30; This is a table @@ -1678,20 +1603,19 @@ Tables may be prepared in two either of two forms }table .fi -.BR +.br .B resulting output: [table omitted, see other document formats] -.BR +.br a second form may be easier to work with in cases where there is not much information in each column -.BR +.br .B markup example: [^16] - .nf !_ Table 3.1: Contributors to Wikipedia, January 2001 - June 2005 {table~h 24; 12; 12; 12; 12; 12; 12;} @@ -1704,25 +1628,23 @@ information in each column \\* Contributed at least ten times; \\** at least 5 times in last month; \\*\** more than 100 times in last month. .fi -.BR +.br .B resulting output: -.BR +.br .B Table 3.1: Contributors to Wikipedia, January 2001 - June 2005 [table omitted, see other document formats] -.BR +.br * Contributed at least ten times; ** at least 5 times in last month; *** more than 100 times in last month. -.SH -9.6.2 POEM +.SH 9.6.2 POEM -.BR +.br .B basic markup: - .nf poem{ Your poem here @@ -1730,10 +1652,9 @@ than 100 times in last month. Each verse in a poem is given an object number. .fi -.BR +.br .B markup example: - .nf poem{ `Fury said to a @@ -1783,122 +1704,119 @@ than 100 times in last month. }poem .fi -.BR +.br .B resulting output: `Fury said to a -.BR +.br mouse, That he -.BR +.br met in the -.BR +.br house, -.BR +.br "Let us -.BR +.br both go to -.BR +.br law: I will -.BR +.br prosecute -.BR +.br YOU. --Come, -.BR +.br I'll take no -.BR +.br denial; We -.BR +.br must have a -.BR +.br trial: For -.BR +.br really this -.BR +.br morning I've -.BR +.br nothing -.BR +.br to do." -.BR +.br Said the -.BR +.br mouse to the -.BR +.br cur, "Such -.BR +.br a trial, -.BR +.br dear Sir, -.BR +.br With -.BR +.br no jury -.BR +.br or judge, -.BR +.br would be -.BR +.br wasting -.BR +.br our -.BR +.br breath." -.BR +.br "I'll be -.BR +.br judge, I'll -.BR +.br be jury," -.BR +.br Said -.BR +.br cunning -.BR +.br old Fury: -.BR +.br "I'll -.BR +.br try the -.BR +.br whole -.BR +.br cause, -.BR +.br and -.BR +.br condemn -.BR +.br you -.BR +.br to -.BR +.br death."' -.BR +.br -.SH -9.6.3 GROUP +.SH 9.6.3 GROUP -.BR +.br .B basic markup: - .nf group{ -.BR +.br Your grouped text here -.BR +.br }group -.BR +.br A group is treated as an object and given a single object number. .fi -.BR +.br .B markup example: - .nf group{ -.BR +.br 'Fury said to a mouse, That he met in the @@ -1946,102 +1864,101 @@ than 100 times in last month. }group .fi -.BR +.br .B resulting output: `Fury said to a -.BR +.br mouse, That he -.BR +.br met in the -.BR +.br house, -.BR +.br "Let us -.BR +.br both go to -.BR +.br law: I will -.BR +.br prosecute -.BR +.br YOU. --Come, -.BR +.br I'll take no -.BR +.br denial; We -.BR +.br must have a -.BR +.br trial: For -.BR +.br really this -.BR +.br morning I've -.BR +.br nothing -.BR +.br to do." -.BR +.br Said the -.BR +.br mouse to the -.BR +.br cur, "Such -.BR +.br a trial, -.BR +.br dear Sir, -.BR +.br With -.BR +.br no jury -.BR +.br or judge, -.BR +.br would be -.BR +.br wasting -.BR +.br our -.BR +.br breath." -.BR +.br "I'll be -.BR +.br judge, I'll -.BR +.br be jury," -.BR +.br Said -.BR +.br cunning -.BR +.br old Fury: -.BR +.br "I'll -.BR +.br try the -.BR +.br whole -.BR +.br cause, -.BR +.br and -.BR +.br condemn -.BR +.br you -.BR +.br to -.BR +.br death."' -.BR +.br -.SH -9.6.4 CODE +.SH 9.6.4 CODE -.BR +.br Code tags code{ \... }code (used as with other group tags described above) are used to escape regular sisu markup, and have been used extensively within this document to provide examples of @@ -2049,15 +1966,14 @@ document to provide examples of markup. You cannot however use code tags to escape code tags. They are however used in the same way as group or poem tags. -.BR +.br A code-block is treated as an object and given a single object number. [an \ option \ to \ number \ each \ line \ of \ code \ may \ be \ considered \ at \ some \ later \ time] -.BR +.br .B use of code tags instead of poem compared, resulting output: - .nf `Fury said to a mouse, That he @@ -2105,13 +2021,12 @@ some \ later \ time] death."' .fi -.BR +.br From .B SiSU 2.7.7 on you can number codeblocks by placing a hash after the opening code tag code{# as demonstrated here: - .nf 1 | `Fury said to a 2 | mouse, That he @@ -2159,83 +2074,75 @@ tag code{# as demonstrated here: 44 | death."' .fi -.SH -9.7 BOOK INDEX +.SH 9.7 BOOK INDEX -.BR +.br To make an index append to paragraph the book index term relates to it, using an equal sign and curly braces. -.BR +.br Currently two levels are provided, a main term and if needed a sub-term. Sub-terms are separated from the main term by a colon. - .nf Paragraph containing main term and sub-term. ={Main term:sub-term} .fi -.BR +.br The index syntax starts on a new line, but there should not be an empty line between paragraph and index markup. -.BR +.br The structure of the resulting index would be: - .nf Main term, 1 sub-term, 1 .fi -.BR +.br Several terms may relate to a paragraph, they are separated by a semicolon. If the term refers to more than one paragraph, indicate the number of paragraphs. - .nf Paragraph containing main term, second term and sub-term. ={first term; second term: sub-term} .fi -.BR +.br The structure of the resulting index would be: - .nf First term, 1, Second term, 1, sub-term, 1 .fi -.BR +.br If multiple sub-terms appear under one paragraph, they are separated under the main term heading from each other by a pipe symbol. - .nf Paragraph containing main term, second term and sub-term. ={Main term:sub-term+1|second sub-term A paragraph that continues discussion of the first sub-term .fi -.BR +.br The plus one in the example provided indicates the first sub-term spans one additional paragraph. The logical structure of the resulting index would be: - .nf Main term, 1, sub-term, 1-3, second sub-term, 1, .fi -.SH -10. COMPOSITE DOCUMENTS MARKUP -.BR +.SH 10. COMPOSITE DOCUMENTS MARKUP +.br -.BR +.br It is possible to build a document by creating a master document that requires other documents. The documents required may be complete documents that could be generated independently, or they could be markup snippets, prepared so as to be @@ -2254,22 +2161,20 @@ regular markup file, or prior to processing with the same prefix and the suffix .B \._sst -.BR +.br basic markup for importing a document into a master document - .nf << filename1.sst << filename2.ssi .fi -.BR +.br The form described above should be relied on. Within the Vim editor it results in the text thus linked becoming hyperlinked to the document it is calling in which is convenient for editing. Alternative markup for importation of documents under consideration, and occasionally supported have been. - .nf << filename.ssi <<{filename.ssi} @@ -2277,29 +2182,97 @@ documents under consideration, and occasionally supported have been. << |filename.ssi|@|^| .fi -.SH -MARKUP SYNTAX HISTORY -.BR +.SH MARKUP SYNTAX HISTORY +.br -.SH -11. NOTES RELATED TO FILES\-TYPES AND MARKUP SYNTAX -.BR +.SH 11. NOTES RELATED TO FILES-TYPES AND MARKUP SYNTAX +.br 2.0 introduced new headers and is therefore incompatible with 1.0 though otherwise the same with the addition of a couple of tags (i.e. a superset) -.BR +.br 0.38 is substantially current for version 1.0 -.BR -* sisu \-\-query=[sisu \ version \ [0.38] or \'history] +.br +depreciated 0.16 supported, though file names were changed at 0.37 + +.br +* sisu --query=[sisu \ version \ [0.38] or 'history] -.BR +.br provides a short history of changes to .B SiSU markup -.BR +.br +.B SiSU 2.0 +(2010-03-06:09/6) same as 1.0, apart from the changing of headers and the +addition of a monospace tag related headers now grouped, e.g. + +.nf + @title: + :subtitle: + + @creator: + :author: + :translator: + :illustrator: + + @rights: + :text: + :illustrations: +.fi + +.br +see document markup samples, and sisu --help headers + +.br +the monospace tag takes the form of a hash '#' + +.nf + #{ this enclosed text would be monospaced }# +.fi + +.br +.B 1.0 +(2009-12-19:50/6) same as 0.69 + +.br +.B 0.69 +(2008-09-16:37/2) (same as 1.0) and as previous (0.57) with the addition of +book index tags + +.nf + /^={.+?}$/ +.fi + +.br +e.g. appended to a paragraph, on a new-line (without a blank line in between) +logical structure produced assuming this is the first text "object" + +.nf + ={GNU/Linux community distribution:Debian+2|Fedora|Gentoo;Free Software Foundation+5} +.fi + +.nf + Free Software Foundation, 1-6 + GNU/Linux community distribution, 1 + Debian, 1-3 + Fedora, 1 + Gentoo, +.fi + +.br +.B 0.66 +(2008-02-24:07/7) same as previous, adds semantic tags, [experimental \ and \ +not-used] + +.nf + /[:;]{.+?}[:;][a-z+]/ +.fi + +.br .B 0.57 (2007w34/4) .B SiSU @@ -2307,105 +2280,100 @@ markup headers @title and @creator in the first heading [expanded \ using \ the \ contents \ of \ the \ headers \ @title: \ and \ @author:] - .nf :A~ @title by @author .fi -.BR +.br .B 0.52 (2007w14/6) declared document type identifier at start of text/document: -.BR +.br .B SiSU 0.52 -.BR +.br or, backward compatible using the comment marker: -.BR +.br % .B SiSU 0.38 -.BR +.br variations include ' .B SiSU (text|master|insert) [version]' and 'sisu-[version]' -.BR +.br .B 0.51 (2007w13/6) skins changed (simplified), markup unchanged -.BR +.br .B 0.42 (2006w27/4) * (asterisk) type endnotes, used e.g. in relation to author -.BR +.br .B SiSU 0.42 is the same as 0.38 with the introduction of some additional endnote types, -.BR +.br Introduces some variations on endnotes, in particular the use of the asterisk - .nf ~{* for example for describing an author }~ and ~{** for describing a second author }~ .fi -.BR +.br * for example for describing an author -.BR +.br ** for describing a second author -.BR +.br and - .nf ~[* \ my \ note \ ]~ or ~[+ \ another \ note \ ]~ .fi -.BR +.br which numerically increments an asterisk and plus respectively -.BR +.br *1 my note +1 another note -.BR +.br .B 0.38 (2006w15/7) introduced new/alternative notation for headers, e.g. @title: (instead of 0~title), and accompanying document structure markup, :A,:B,:C,1,2,3 (maps to previous 1,2,3,4,5,6) -.BR +.br .B SiSU 0.38 introduced alternative experimental header and heading/structure markers, - .nf @headername: and headers :A~ :B~ :C~ 1~ 2~ 3~ .fi -.BR +.br as the equivalent of: - .nf 0~headername and headers 1~ 2~ 3~ 4~ 5~ 6~ .fi -.BR +.br The internal document markup of .B SiSU 0.16 remains valid and standard Though note that .B SiSU 0.37 introduced a new file naming convention -.BR +.br .B SiSU has in effect two sets of levels to be considered, using 0.38 notation A-C headings/levels, pre-ordinary paragraphs /pre-substantive text, and 1-3 @@ -2422,81 +2390,78 @@ complicated, is more in your face and likely to be understood fairly quickly); the substantive text follows levels 1,2,3 and it is 'nice' to do most work in those levels -.BR +.br .B 0.37 (2006w09/7) introduced new file naming convention, \.sst (text), \.ssm (master), \.ssi (insert), markup syntax unchanged -.BR +.br .B SiSU 0.37 introduced new file naming convention, using the file extensions \.sst \.ssm and \.ssi to replace \.s1 \.s2 \.s3 \.r1 \.r2 \.r3 and \.si -.BR +.br this is captured by the following file 'rename' instruction: - .nf rename 's/\.s[123]$/\.sst/' *.s{1,2,3} rename 's/\.r[123]$/\.ssm/' *.r{1,2,3} rename 's/\.si$/\.ssi/' *.si .fi -.BR +.br The internal document markup remains unchanged, from .B SiSU 0.16 -.BR +.br .B 0.35 (2005w52/3) sisupod, zipped content file introduced -.BR +.br .B 0.23 (2005w36/2) utf-8 for markup file -.BR +.br .B 0.22 (2005w35/3) image dimensions may be omitted if rmagick is available to be relied upon -.BR +.br .B 0.20.4 (2005w33/4) header 0~links -.BR +.br .B 0.16 (2005w25/2) substantial changes introduced to make markup cleaner, header 0~title type, and headings [1-6]~ introduced, also percentage sign (%) at start of a text line as comment marker -.BR +.br .B SiSU 0.16 (0.15 development branch) introduced the use of -.BR +.br the header 0~ and headings/structure 1~ 2~ 3~ 4~ 5~ 6~ -.BR +.br in place of the 0.1 header, heading/structure notation -.BR +.br .B SiSU 0.1 headers and headings structure represented by header 0{~ and headings/structure 1{ 2{ 3{ 4{~ 5{ 6{ -.SH -12. SISU FILETYPES -.BR +.SH 12. SISU FILETYPES +.br -.BR +.br .B SiSU has plaintext and binary filetypes, and can process either type of document. -.SH -12.1 \.SST \.SSM \.SSI MARKED UP PLAIN TEXT +.SH 12.1 \.SST \.SSM \.SSI MARKED UP PLAIN TEXT -.BR +.br .B SiSU documents are prepared as plain-text (utf-8) files with .B SiSU @@ -2509,38 +2474,36 @@ that incorporate other text, which can be any regular text or text insert; and inserts the contents of which are like regular text except these are marked \.ssi and are not processed. -.BR +.br .B SiSU processing can be done directly against a sisu documents; which may be located locally or on a remote server for which a url is provided. -.BR +.br .B SiSU source markup can be shared with the command: -.BR +.br sisu -s [filename] -.SH -12.1.1 SISU TEXT - REGULAR FILES (.SST) +.SH 12.1.1 SISU TEXT - REGULAR FILES (.SST) -.BR +.br The most common form of document in .B SiSU , see the section on .B SiSU markup. -.BR +.br <http://www.sisudoc.org/sisu/sisu_markup> -.BR +.br <http://www.sisudoc.org/sisu/sisu_manual> -.SH -12.1.2 SISU MASTER FILES (.SSM) +.SH 12.1.2 SISU MASTER FILES (.SSM) -.BR +.br Composite documents which incorporate other .B SiSU documents which may be either regular @@ -2548,7 +2511,7 @@ documents which may be either regular text \.sst which may be generated independently, or inserts prepared solely for the purpose of being incorporated into one or more master documents. -.BR +.br The mechanism by which master files incorporate other documents is described as one of the headings under under .B SiSU @@ -2556,26 +2519,25 @@ markup in the .B SiSU manual. -.BR +.br Note: Master documents may be prepared in a similar way to regular documents, 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. -.BR +.br Note: a secondary file of the composite document is built prior to processing with the same prefix and the suffix \._sst [^17] -.BR +.br <http://www.sisudoc.org/sisu/sisu_markup> -.BR +.br <http://www.sisudoc.org/sisu/sisu_manual> -.SH -12.1.3 SISU INSERT FILES (.SSI) +.SH 12.1.3 SISU INSERT FILES (.SSI) -.BR +.br Inserts are documents prepared solely for the purpose of being incorporated into one or more master documents. They resemble regular .B SiSU @@ -2584,10 +2546,9 @@ text files except they are ignored by the processor. Making a file a \.ssi file is a quick and convenient way of flagging that it is not intended that the file should be processed on its own. -.SH -12.2 SISUPOD, ZIPPED BINARY CONTAINER (SISUPOD.ZIP, \.SSP) +.SH 12.2 SISUPOD, ZIPPED BINARY CONTAINER (SISUPOD.ZIP, \.SSP) -.BR +.br A sisupod is a zipped .B SiSU text file or set of @@ -2595,7 +2556,7 @@ text file or set of text files and any associated images that they contain (this will be extended to include sound and multimedia-files) -.BR +.br .B SiSU plaintext files rely on a recognised directory structure to find contents such as images associated with documents, but all images for example for all @@ -2605,7 +2566,7 @@ manually identify all other files associated with a document. A sisupod automatically bundles all associated files with the document that is turned into a pod. -.BR +.br The structure of the sisupod is such that it may for example contain a single document and its associated images; a master document and its associated documents and anything else; or the zipped contents of a whole directory of @@ -2613,338 +2574,321 @@ prepared .B SiSU documents. -.BR +.br The command to create a sisupod is: -.BR +.br sisu -S [filename] -.BR +.br Alternatively, make a pod of the contents of a whole directory: -.BR +.br sisu -S -.BR +.br .B SiSU processing can be done directly against a sisupod; which may be located locally or on a remote server for which a url is provided. -.BR +.br <http://www.sisudoc.org/sisu/sisu_commands> -.BR +.br <http://www.sisudoc.org/sisu/sisu_manual> -.SH -13. EXPERIMENTAL ALTERNATIVE INPUT REPRESENTATIONS -.BR +.SH 13. EXPERIMENTAL ALTERNATIVE INPUT REPRESENTATIONS +.br -.SH -13.1 ALTERNATIVE XML +.SH 13.1 ALTERNATIVE XML -.BR +.br .B SiSU offers alternative XML input representations of documents as a proof of concept, experimental feature. They are however not strictly maintained, and incomplete and should be handled with care. -.BR +.br .B convert from sst to simple xml representations (sax, dom and node): -.BR +.br sisu --to-sax [filename/wildcard] or sisu --to-sxs [filename/wildcard] -.BR +.br sisu --to-dom [filename/wildcard] or sisu --to-sxd [filename/wildcard] -.BR +.br sisu --to-node [filename/wildcard] or sisu --to-sxn [filename/wildcard] -.BR +.br .B convert to sst from any sisu xml representation (sax, dom and node): -.BR +.br sisu --from-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] -.BR +.br or the same: -.BR +.br sisu --from-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] -.SH -13.1.1 XML SAX REPRESENTATION +.SH 13.1.1 XML SAX REPRESENTATION -.BR +.br To convert from sst to simple xml (sax) representation: -.BR +.br sisu --to-sax [filename/wildcard] or sisu --to-sxs [filename/wildcard] -.BR +.br To convert from any sisu xml representation back to sst -.BR +.br sisu --from-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] -.BR +.br or the same: -.BR +.br sisu --from-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] -.SH -13.1.2 XML DOM REPRESENTATION +.SH 13.1.2 XML DOM REPRESENTATION -.BR +.br To convert from sst to simple xml (dom) representation: -.BR +.br sisu --to-dom [filename/wildcard] or sisu --to-sxd [filename/wildcard] -.BR +.br To convert from any sisu xml representation back to sst -.BR +.br sisu --from-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] -.BR +.br or the same: -.BR +.br sisu --from-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] -.SH -13.1.3 XML NODE REPRESENTATION +.SH 13.1.3 XML NODE REPRESENTATION -.BR +.br To convert from sst to simple xml (node) representation: -.BR +.br sisu --to-node [filename/wildcard] or sisu --to-sxn [filename/wildcard] -.BR +.br To convert from any sisu xml representation back to sst -.BR +.br sisu --from-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] -.BR +.br or the same: -.BR +.br sisu --from-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] -.SH -14. CONFIGURATION -.BR +.SH 14. CONFIGURATION +.br -.SH -14.1 DETERMINING THE CURRENT CONFIGURATION +.SH 14.1 DETERMINING THE CURRENT CONFIGURATION -.BR +.br Information on the current configuration of .B SiSU should be available with the help command: -.BR +.br sisu -v -.BR +.br which is an alias for: -.BR +.br sisu --help env -.BR +.br Either of these should be executed from within a directory that contains sisu markup source documents. -.SH -14.2 CONFIGURATION FILES (CONFIG.YML) +.SH 14.2 CONFIGURATION FILES (CONFIG.YML) -.BR +.br .B SiSU configration parameters are adjusted in the configuration file, which can be used to override the defaults set. This includes such things as which directory interim processing should be done in and where the generated output should be placed. -.BR +.br The .B SiSU configuration file is a yaml file, which means indentation is significant. -.BR +.br .B SiSU resource configuration is determined by looking at the following files if they exist: -.BR +.br ./_sisu/sisurc.yml -.BR +.br ~/.sisu/sisurc.yml -.BR +.br /etc/sisu/sisurc.yml -.BR +.br The search is in the order listed, and the first one found is used. -.BR +.br In the absence of instructions in any of these it falls back to the internal program defaults. -.BR +.br Configuration determines the output and processing directories and the database access details. -.BR +.br If .B SiSU is installed a sample sisurc.yml may be found in /etc/sisu/sisurc.yml -.SH -15. SKINS -.BR +.SH 15. SKINS +.br -.BR +.br Skins modify the default appearance of document output on a document, directory, or site wide basis. Skins are looked for in the following locations: -.BR +.br ./_sisu/skin -.BR +.br ~/.sisu/skin -.BR +.br /etc/sisu/skin -.BR +.br .B Within the skin directory are the following the default sub-directories for document skins: -.BR +.br ./skin/doc -.BR +.br ./skin/dir -.BR +.br ./skin/site -.BR +.br A skin is placed in the appropriate directory and the file named skin_[name].rb -.BR +.br The skin itself is a ruby file which modifies the default appearances set in the program. -.SH -15.1 DOCUMENT SKIN +.SH 15.1 DOCUMENT SKIN -.BR +.br Documents take on a document skin, if the header of the document specifies a skin to be used. - .nf @skin: skin_united_nations .fi -.SH -15.2 DIRECTORY SKIN +.SH 15.2 DIRECTORY SKIN -.BR +.br A directory may be mapped on to a particular skin, so all documents within that directory take on a particular appearance. If a skin exists in the skin/dir with the same name as the document directory, it will automatically be used for each of the documents in that directory, (except where a document specifies the use of another skin, in the skin/doc directory). -.BR +.br A personal habit is to place all skins within the doc directory, and symbolic links as needed from the site, or dir directories as required. -.SH -15.3 SITE SKIN +.SH 15.3 SITE SKIN -.BR +.br A site skin, modifies the program default skin. -.SH -15.4 SAMPLE SKINS +.SH 15.4 SAMPLE SKINS -.BR +.br With .B SiSU installed sample skins may be found in: -.BR +.br /etc/sisu/skin/doc and /usr/share/doc/sisu/markup-samples/samples/_sisu/skin/doc -.BR +.br (or equivalent directory) and if sisu-markup-samples is installed also under: -.BR +.br /usr/share/doc/sisu/markup-samples-non-free/samples/_sisu/skin/doc -.BR +.br Samples of list.yml and promo.yml (which are used to create the right column list) may be found in: -.BR +.br /usr/share/doc/sisu/markup-samples-non-free/samples/_sisu/skin/yml (or equivalent directory) -.SH -16. CSS - CASCADING STYLE SHEETS (FOR HTML, XHTML AND XML) -.BR +.SH 16. CSS - CASCADING STYLE SHEETS (FOR HTML, XHTML AND XML) +.br -.BR +.br CSS files to modify the appearance of .B SiSU 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 output directories with the command sisu -CC. -.BR +.br 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. -.BR +.br HTML: html.css -.BR +.br XML DOM: dom.css -.BR +.br XML SAX: sax.css -.BR +.br XHTML: xhtml.css -.BR +.br The default homepage may use homepage.css or html.css -.BR +.br 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] -.SH -17. ORGANISING CONTENT -.BR +.SH 17. ORGANISING CONTENT +.br -.SH -17.1 DIRECTORY STRUCTURE AND MAPPING +.SH 17.1 DIRECTORY STRUCTURE AND MAPPING -.BR +.br 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 @@ -2954,7 +2898,7 @@ 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) -.BR +.br 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 @@ -2970,13 +2914,10 @@ output directory. Skins could be associated with each institution on a directory basis and resulting documents will take on the appropriate different appearance. -.SH - -.SH -18. HOMEPAGES -.BR +.SH 18. HOMEPAGES +.br -.BR +.br .B SiSU is about the ability to auto-generate documents. Home pages are regarded as custom built items, and are not created by @@ -2987,49 +2928,46 @@ 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: -.BR +.br 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) -.BR +.br 2. through providing what you want as the home page in a skin, -.BR +.br 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. -.SH -18.1 HOME PAGE AND OTHER CUSTOM BUILT PAGES IN A SUB-DIRECTORY +.SH 18.1 HOME PAGE AND OTHER CUSTOM BUILT PAGES IN A SUB-DIRECTORY -.BR +.br 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: -.BR +.br sisu -CC -.SH -18.2 HOME PAGE WITHIN A SKIN +.SH 18.2 HOME PAGE WITHIN A SKIN -.BR +.br Skins are described in a separate section, but basically are a file written in the programming language .B Ruby that may be provided to change the defaults that are provided with sisu with respect to individual documents, a directories contents or for a site. -.BR +.br If you wish to provide a homepage within a skin the skin should be in the directory _sisu/skin/dir and have the name of the directory for which it is to become the home page. Documents in the directory commercial_law would have the homepage modified in skin_commercial law.rb; or the directory poems in skin_poems.rb - .nf class Home def homepage @@ -3045,39 +2983,36 @@ skin_poems.rb end .fi -.SH -19. MARKUP AND OUTPUT EXAMPLES -.BR +.SH 19. MARKUP AND OUTPUT EXAMPLES +.br -.SH -19.1 MARKUP EXAMPLES +.SH 19.1 MARKUP EXAMPLES -.BR +.br Current markup examples and document output samples are provided at <http://www.jus.uio.no/sisu/SiSU/examples.html> -.BR +.br For some documents hardly any markup at all is required at all, other than a header, and an indication that the levels to be taken into account by the program in generating its output are. -.SH -20. SISU SEARCH - INTRODUCTION -.BR +.SH 20. SISU SEARCH - INTRODUCTION +.br -.BR +.br .B SiSU output can easily and conveniently be indexed by a number of standalone indexing tools, such as Lucene, Hyperestraier. -.BR +.br Because the document structure of sites created is clearly defined, and the text object citation system is available hypothetically at least, for all forms of output, it is possible to search the sql database, and either read results from that database, or just as simply map the results to the html output, which has richer text markup. -.BR +.br In addition to this .B SiSU has the ability to populate a relational sql type database with documents at @@ -3087,48 +3022,46 @@ your match criteria is met by these documents and at these locations within each document, which can be viewed within the database directly or in various output formats. -.SH -21. SQL -.BR +.SH 21. SQL +.br -.SH -21.1 POPULATING SQL TYPE DATABASES +.SH 21.1 POPULATING SQL TYPE DATABASES -.BR +.br .B SiSU feeds sisu markupd documents into sql type databases PostgreSQL[^19] and/or SQLite[^20] database together with information related to document structure. -.BR +.br This is one of the more interesting output forms, as all the structural data of the documents are retained (though can be ignored by the user of the database should they so choose). All site texts/documents are (currently) streamed to four tables: -.BR +.br * one containing semantic (and other) headers, including, title, author, subject, (the Dublin Core...); -.BR +.br * another the substantive texts by individual "paragraph" (or object) - along with structural information, each paragraph being identifiable by its paragraph number (if it has one which almost all of them do), and the substantive text of each paragraph quite naturally being searchable (both in formatted and clean text versions for searching); and -.BR +.br * a third containing endnotes cross-referenced back to the paragraph from which they are referenced (both in formatted and clean text versions for searching). -.BR +.br * a fourth table with a one to one relation with the headers table contains full text versions of output, eg. pdf, html, xml, and ascii. -.BR +.br There is of course the possibility to add further structures. -.BR +.br At this level .B SiSU loads a relational database with documents chunked into objects, their @@ -3138,7 +3071,7 @@ the document. Text is stored (at this text object level) with and without elementary markup tagging, the stripped version being so as to facilitate ease of searching. -.BR +.br Being able to search a relational database at an object level with the .B SiSU citation system is an effective way of locating content generated by @@ -3153,22 +3086,19 @@ database and have headings in which search content appears, or to search only headings etc. (as the Dublin Core is incorporated it is easy to make use of that as well). -.SH -22. POSTGRESQL -.BR +.SH 22. POSTGRESQL +.br -.SH -22.1 NAME +.SH 22.1 NAME -.BR +.br .B SiSU - Structured information, Serialized Units - a document publishing system, postgresql dependency package -.SH -22.2 DESCRIPTION +.SH 22.2 DESCRIPTION -.BR +.br Information related to using postgresql with sisu (and related to the sisu_postgresql dependency package, which is a dummy package to install dependencies needed for @@ -3177,30 +3107,27 @@ to populate a postgresql database, this being part of .B SiSU - man sisu). -.SH -22.3 SYNOPSIS +.SH 22.3 SYNOPSIS -.BR +.br sisu -D [instruction] [filename/wildcard \ if \ required] -.BR +.br sisu -D --pg --[instruction] [filename/wildcard \ if \ required] -.SH -22.4 COMMANDS +.SH 22.4 COMMANDS -.BR +.br Mappings to two databases are provided by default, postgresql and sqlite, the same commands are used within sisu to construct and populate databases however -d (lowercase) denotes sqlite and -D (uppercase) denotes postgresql, alternatively --sqlite or --pgsql may be used -.BR +.br .B -D or --pgsql may be used interchangeably. -.SH -22.4.1 CREATE AND DESTROY DATABASE +.SH 22.4.1 CREATE AND DESTROY DATABASE .TP .B --pgsql --createall @@ -3226,8 +3153,7 @@ same name). .B sisu -D --recreate destroys existing database and builds a new empty database structure -.SH -22.4.2 IMPORT AND REMOVE DOCUMENTS +.SH 22.4.2 IMPORT AND REMOVE DOCUMENTS .TP .B sisu -D --import -v [filename/wildcard] @@ -3242,21 +3168,18 @@ updates file contents in database .B sisu -D --remove -v [filename/wildcard] removes specified document from postgresql database. -.SH -23. SQLITE -.BR +.SH 23. SQLITE +.br -.SH -23.1 NAME +.SH 23.1 NAME -.BR +.br .B SiSU - Structured information, Serialized Units - a document publishing system. -.SH -23.2 DESCRIPTION +.SH 23.2 DESCRIPTION -.BR +.br Information related to using sqlite with sisu (and related to the sisu_sqlite dependency package, which is a dummy package to install dependencies needed for .B SiSU @@ -3264,30 +3187,27 @@ to populate an sqlite database, this being part of .B SiSU - man sisu). -.SH -23.3 SYNOPSIS +.SH 23.3 SYNOPSIS -.BR +.br sisu -d [instruction] [filename/wildcard \ if \ required] -.BR +.br sisu -d --(sqlite|pg) --[instruction] [filename/wildcard \ if \ required] -.SH -23.4 COMMANDS +.SH 23.4 COMMANDS -.BR +.br Mappings to two databases are provided by default, postgresql and sqlite, the same commands are used within sisu to construct and populate databases however -d (lowercase) denotes sqlite and -D (uppercase) denotes postgresql, alternatively --sqlite or --pgsql may be used -.BR +.br .B -d or --sqlite may be used interchangeably. -.SH -23.4.1 CREATE AND DESTROY DATABASE +.SH 23.4.1 CREATE AND DESTROY DATABASE .TP .B --sqlite --createall @@ -3313,8 +3233,7 @@ same name). .B sisu -d --recreate destroys existing database and builds a new empty database structure -.SH -23.4.2 IMPORT AND REMOVE DOCUMENTS +.SH 23.4.2 IMPORT AND REMOVE DOCUMENTS .TP .B sisu -d --import -v [filename/wildcard] @@ -3329,21 +3248,19 @@ updates file contents in database .B sisu -d --remove -v [filename/wildcard] removes specified document from sqlite database. -.SH -24. INTRODUCTION -.BR +.SH 24. INTRODUCTION +.br -.SH -24.1 SEARCH - DATABASE FRONTEND SAMPLE, UTILISING DATABASE AND SISU FEATURES, +.SH 24.1 SEARCH - DATABASE FRONTEND SAMPLE, UTILISING DATABASE AND SISU FEATURES, INCLUDING OBJECT CITATION NUMBERING (BACKEND CURRENTLY POSTGRESQL) -.BR +.br Sample search frontend <http://search.sisudoc.org> [^21] A small database and sample query front-end (search from) that makes use of the citation system, .I object citation numbering to demonstrates functionality.[^22] -.BR +.br .B 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 @@ -3352,7 +3269,7 @@ 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. -.BR +.br 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 @@ -3362,14 +3279,13 @@ meet the search criteria.[^23] .B sisu -F --webserv-webrick builds a cgi web search frontend for the database created -.BR +.br The following is feedback on the setup on a machine provided by the help command: -.BR +.br sisu --help sql - .nf Postgresql user: ralph @@ -3381,10 +3297,10 @@ command: dbi connect DBI:SQLite:/home/ralph/sisu_www/sisu/sisu_sqlite.db .fi -.BR +.br Note on databases built -.BR +.br By default, [unless \ otherwise \ specified] databases are built on a directory basis, from collections of documents within that directory. The name of the directory you choose to work from is used as the database name, i.e. if you are @@ -3392,8 +3308,7 @@ working in a directory called /home/ralph/ebook the database SiSU_ebook is used. [otherwise \ a \ manual \ mapping \ for \ the \ collection \ is \ necessary] -.SH -24.2 SEARCH FORM +.SH 24.2 SEARCH FORM .TP .B sisu -F @@ -3414,147 +3329,142 @@ as above, and provides some information on setting up hyperestraier starts the webrick server which should be available wherever sisu is properly installed -.BR +.br The generated search form must be copied manually to the webserver directory as instructed -.SH -25. HYPERESTRAIER -.BR +.SH 25. HYPERESTRAIER +.br -.BR +.br See the documentation for hyperestraier: -.BR +.br <http://hyperestraier.sourceforge.net/> -.BR +.br /usr/share/doc/hyperestraier/index.html -.BR +.br man estcmd -.BR +.br NOTE: the examples that follow assume that sisu output is placed in the directory /home/ralph/sisu_www -.BR +.br (A) to generate the index within the webserver directory to be indexed: -.BR +.br estcmd gather -sd [index \ name] [directory \ path \ to \ index] -.BR +.br the following are examples that will need to be tailored according to your needs: -.BR +.br cd /home/ralph/sisu_www -.BR +.br estcmd gather -sd casket /home/ralph/sisu_www -.BR +.br you may use the 'find' command together with 'egrep' to limit indexing to particular document collection directories within the web server directory: -.BR +.br find /home/ralph/sisu_www -type f | egrep '/home/ralph/sisu_www/sisu/.+?.html$' |estcmd gather -sd casket - -.BR +.br Check which directories in the webserver/output directory (~/sisu_www or elsewhere depending on configuration) you wish to include in the search index. -.BR +.br As sisu duplicates output in multiple file formats, it it is probably preferable to limit the estraier index to html output, and as it may also be desirable to exclude files 'plain.txt', 'toc.html' and 'concordance.html', as these duplicate information held in other html output e.g. -.BR +.br find /home/ralph/sisu_www -type f | egrep '/sisu_www/(sisu|bookmarks)/.+?.html$' | egrep -v '(doc|concordance).html$' |estcmd gather -sd casket - -.BR +.br from your current document preparation/markup directory, you would construct a rune along the following lines: -.BR +.br find /home/ralph/sisu_www -type f | egrep '/home/ralph/sisu_www/([specify \ first \ directory \ for \ inclusion]|[specify \ second \ directory \ for \ inclusion]|[another \ directory \ for \ inclusion? \ \...])/.+?.html$' | egrep -v '(doc|concordance).html$' |estcmd gather -sd /home/ralph/sisu_www/casket - -.BR +.br (B) to set up the search form -.BR +.br (i) copy estseek.cgi to your cgi directory and set file permissions to 755: -.BR +.br sudo cp -vi /usr/lib/estraier/estseek.cgi /usr/lib/cgi-bin -.BR +.br sudo chmod -v 755 /usr/lib/cgi-bin/estseek.cgi -.BR +.br sudo cp -v /usr/share/hyperestraier/estseek.* /usr/lib/cgi-bin -.BR +.br [see \ estraier \ documentation \ for \ paths] -.BR +.br (ii) edit estseek.conf, with attention to the lines starting 'indexname:' and 'replace:': -.BR +.br indexname: /home/ralph/sisu_www/casket -.BR +.br replace: ^file:///home/ralph/sisu_www{{!}}http://localhost -.BR +.br replace: /index.html?${{!}}/ -.BR +.br (C) to test using webrick, start webrick: -.BR +.br sisu -W -.BR +.br and try open the url: <http://localhost:8081/cgi-bin/estseek.cgi> -.SH -26. SISU_WEBRICK -.BR +.SH 26. SISU_WEBRICK +.br -.SH -26.1 NAME +.SH 26.1 NAME -.BR +.br .B SiSU - Structured information, Serialized Units - a document publishing system -.SH -26.2 SYNOPSIS +.SH 26.2 SYNOPSIS -.BR +.br sisu_webrick [port] -.BR +.br or -.BR +.br sisu -W [port] -.SH -26.3 DESCRIPTION +.SH 26.3 DESCRIPTION -.BR +.br sisu_webrick is part of .B SiSU (man sisu) sisu_webrick starts @@ -3565,25 +3475,23 @@ output is written, providing a list of these directories (assuming .B SiSU is in use and they exist). -.BR +.br The default port for sisu_webrick is set to 8081, this may be modified in the yaml file: ~/.sisu/sisurc.yml a sample of which is provided as /etc/sisu/sisurc.yml (or in the equivalent directory on your system). -.SH -26.4 SUMMARY OF MAN PAGE +.SH 26.4 SUMMARY OF MAN PAGE -.BR +.br sisu_webrick, may be started on it's own with the command: sisu_webrick [port] or using the sisu command with the -W flag: sisu -W [port] -.BR +.br where no port is given and settings are unchanged the default port is 8081 -.SH -26.5 DOCUMENT PROCESSING COMMAND FLAGS +.SH 26.5 DOCUMENT PROCESSING COMMAND FLAGS -.BR +.br sisu -W [port] starts .B Ruby Webrick web-server, serving @@ -3591,40 +3499,33 @@ Webrick web-server, serving output directories, on the port provided, or if no port is provided and the defaults have not been changed in ~/.sisu/sisurc.yaml then on port 8081 -.SH -26.6 FURTHER INFORMATION +.SH 26.6 FURTHER INFORMATION -.BR +.br For more information on .B SiSU see: <http://www.sisudoc.org/> or <http://www.jus.uio.no/sisu> -.BR +.br or man sisu -.SH -26.7 AUTHOR +.SH 26.7 AUTHOR -.BR -Ralph Amissah ralph@amissah.com or ralph.amissah@gmail.com +.br +Ralph Amissah <ralph@amissah.com> or <ralph.amissah@gmail.com> -.SH -26.8 SEE ALSO +.SH 26.8 SEE ALSO -.BR +.br sisu(1) -.BR +.br sisu_vim(7) -.BR - sisu(8) - -.SH -27. REMOTE SOURCE DOCUMENTS -.BR +.SH 27. REMOTE SOURCE DOCUMENTS +.br -.BR +.br .B SiSU processing instructions can be run against remote source documents by providing the url of the documents against which the processing instructions @@ -3633,81 +3534,75 @@ are to be carried out. The remote documents can either be sisu marked up files in plaintext \.sst or \.ssm or; zipped sisu files, sisupod.zip or filename.ssp -.BR +.br .B \.sst / \.ssm - sisu text files -.BR +.br .B SiSU can be run against source text files on a remote machine, provide the processing instruction and the url. The source file and any associated parts (such as images) will be downloaded and generated locally. - .nf sisu -3 http://[provide \ url \ to \ valid \ \.sst \ or \ \.ssm \ file] .fi -.BR +.br Any of the source documents in the sisu examples page can be used in this way, see <http://www.jus.uio.no/sisu/SiSU/examples.html> and use the url to the \.sst for the desired document. -.BR +.br NOTE: to set up a remote machine to serve .B SiSU documents in this way, images should be in the directory relative to the document source \../_sisu/image -.BR +.br .B sisupod - zipped sisu files -.BR +.br A sisupod is the zipped content of a sisu marked up text or texts and any other associated parts to the document such as images. -.BR +.br .B SiSU can be run against a sisupod on a (local or) remote machine, provide the processing instruction and the url, the sisupod will be downloaded and the documents it contains generated locally. - .nf sisu -3 http://[provide \ url \ to \ valid \ sisupod.zip \ or \ \.ssp \ file] .fi -.BR +.br Any of the source documents in the sisu examples page can be used in this way, see <http://www.jus.uio.no/sisu/SiSU/examples.html> and use the url for the desired document. -.SH -REMOTE DOCUMENT OUTPUT -.BR +.SH REMOTE DOCUMENT OUTPUT +.br -.SH -28. REMOTE OUTPUT -.BR +.SH 28. REMOTE OUTPUT +.br -.BR +.br Once properly configured .B SiSU output can be automatically posted once generated to a designated remote machine using either rsync, or scp. -.BR +.br In order to do this some ssh authentication agent and keychain or similar tool will need to be configured. Once that is done the placement on a remote host can be done seamlessly with the -r (for scp) or -R (for rsync) flag, which may be used in conjunction with other processing flags, e.g. - .nf sisu -3R sisu_remote.sst .fi -.SH -28.1 COMMANDS +.SH 28.1 COMMANDS .TP .B -R [filename/wildcard] @@ -3724,17 +3619,15 @@ 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 your "keys" and ssh agent in place. Also see -R -.SH -28.2 CONFIGURATION +.SH 28.2 CONFIGURATION -.BR +.br [expand \ on \ the \ setting \ up \ of \ an \ ssh-agent \ / \ keychain] -.SH -29. REMOTE SERVERS -.BR +.SH 29. REMOTE SERVERS +.br -.BR +.br As .B SiSU is generally operated using the command line, and works within a Unix type @@ -3744,61 +3637,55 @@ the program and all documents can just as easily be on a remote server, to which you are logged on using a terminal, and commands and operations would be pretty much the same as they would be on your local machine. -.SH -30. QUICKSTART - GETTING STARTED HOWTO -.BR +.SH 30. QUICKSTART - GETTING STARTED HOWTO +.br -.SH -30.1 INSTALLATION +.SH 30.1 INSTALLATION -.BR +.br Installation is currently most straightforward and tested on the .B Debian platform, as there are packages for the installation of sisu and all requirements for what it does. -.SH -30.1.1 DEBIAN INSTALLATION +.SH 30.1.1 DEBIAN INSTALLATION -.BR +.br .B SiSU is available directly from the .B Debian Sid and testing archives (and possibly Ubuntu), assuming your /etc/apt/sources.list is set accordingly: - .nf aptitude update aptitude install sisu-complete .fi -.BR +.br The following /etc/apt/sources.list setting permits the download of additional markup samples: - .nf #/etc/apt/sources.list -.BR +.br deb http://ftp.fi.debian.org/debian/ unstable main non-free contrib -.BR +.br deb-src http://ftp.fi.debian.org/debian/ unstable main non-free contrib -.BR +.br .fi -.BR +.br The aptitude commands become: - .nf aptitude update -.BR +.br aptitude install sisu-complete sisu-markup-samples .fi -.BR +.br If there are newer versions of .B SiSU upstream of the @@ -3806,69 +3693,65 @@ upstream of the archives, they will be available by adding the following to your /etc/apt/sources.list - .nf #/etc/apt/sources.list deb http://www.jus.uio.no/sisu/archive unstable main non-free deb-src http://www.jus.uio.no/sisu/archive unstable main non-free .fi -.BR +.br repeat the aptitude commands - .nf aptitude update aptitude install sisu-complete sisu-markup-samples .fi -.BR +.br Note however that it is not necessary to install sisu-complete if not all components of sisu are to be used. Installing just the package sisu will provide basic functionality. -.SH -30.1.2 RPM INSTALLATION +.SH 30.1.2 RPM INSTALLATION -.BR +.br RPMs are provided though untested, they are prepared by running alien against the source package, and against the debs. -.BR +.br They may be downloaded from: -.BR +.br <http://www.jus.uio.no/sisu/SiSU/download.html#rpm> -.BR +.br as root type: -.BR +.br rpm -i [rpm \ package \ name] -.SH -30.1.3 INSTALLATION FROM SOURCE +.SH 30.1.3 INSTALLATION FROM SOURCE -.BR +.br To install .B SiSU from source check information at: -.BR +.br <http://www.jus.uio.no/sisu/SiSU/download.html#current> -.BR +.br * download the source package -.BR +.br * Unpack the source -.BR +.br 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: -.BR +.br For basic use .B SiSU is only dependent on the programming language in which it is written @@ -3881,16 +3764,15 @@ 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)[^24] or converting LaTeX to pdf. -.BR +.br .B setup.rb -.BR +.br This is a standard ruby installer, using setup.rb is a three step process. In the root directory of the unpacked .B SiSU as root type: - .nf ruby setup.rb config ruby setup.rb setup @@ -3898,415 +3780,404 @@ as root type: ruby setup.rb install .fi -.BR +.br further information on setup.rb is available from: -.BR +.br <http://i.loveruby.net/en/projects/setup/> -.BR +.br <http://i.loveruby.net/en/projects/setup/doc/usage.html> -.BR +.br .B "install" -.BR +.br The "install" file provided is an installer prepared using "rant". In the root directory of the unpacked .B SiSU as root type: -.BR +.br ruby install base -.BR +.br or for a more complete installation: -.BR +.br ruby install -.BR +.br or -.BR +.br ruby install base -.BR +.br This makes use of Rant (by Stefan Lang) and the provided Rantfile. It has been configured to do post installation setup setup configuration and generation of first test file. Note however, that additional external package dependencies, such as tetex-extra are not taken care of for you. -.BR +.br Further information on "rant" is available from: -.BR +.br <http://make.rubyforge.org/> -.BR +.br <http://rubyforge.org/frs/?group_id=615> -.BR +.br For a list of alternative actions you may type: -.BR +.br ruby install help -.BR +.br ruby install -T -.SH -30.2 TESTING SISU, GENERATING OUTPUT +.SH 30.2 TESTING SISU, GENERATING OUTPUT -.BR +.br To check which version of sisu is installed: -.BR +.br sisu -v -.BR +.br Depending on your mode of installation one or a number of markup sample files may be found either in the directory: -.BR +.br ... -.BR +.br or -.BR +.br ... -.BR +.br change directory to the appropriate one: -.BR -cd /usr/share/doc/sisu/sisu_markup_samples/dfsg +.br +cd /usr/share/doc/sisu/markup-samples/samples -.SH -30.2.1 BASIC TEXT, PLAINTEXT, HTML, XML, ODF, EPUB +.SH 30.2.1 BASIC TEXT, PLAINTEXT, HTML, XML, ODF, EPUB -.BR +.br Having moved to the directory that contains the markup samples (see instructions above if necessary), choose a file and run sisu against it -.BR +.br sisu -NhwoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst -.BR +.br this will generate html including a concordance file, opendocument text format, plaintext, XHTML and various forms of XML, and OpenDocument text -.SH -30.2.2 LATEX / PDF +.SH 30.2.2 LATEX / PDF -.BR +.br Assuming a LaTeX engine such as tetex or texlive is installed with the required modules (done automatically on selection of sisu-pdf in .B Debian ) -.BR +.br Having moved to the directory that contains the markup samples (see instructions above if necessary), choose a file and run sisu against it -.BR +.br sisu -pv free_as_in_freedom.rms_and_free_software.sam_williams.sst -.BR +.br sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst -.BR +.br should generate most available output formats: html including a concordance file, opendocument text format, plaintext, XHTML and various forms of XML, and OpenDocument text and pdf -.SH -30.2.3 RELATIONAL DATABASE - POSTGRESQL, SQLITE +.SH 30.2.3 RELATIONAL DATABASE - POSTGRESQL, SQLITE -.BR +.br Relational databases need some setting up - you must have permission to create the database and write to it when you run sisu. -.BR +.br Assuming you have the database installed and the requisite permissions -.BR +.br sisu --sqlite --recreate -.BR +.br sisu --sqlite -v --import free_as_in_freedom.rms_and_free_software.sam_williams.sst -.BR +.br sisu --pgsql --recreate -.BR +.br sisu --pgsql -v --import free_as_in_freedom.rms_and_free_software.sam_williams.sst -.SH -30.3 GETTING HELP +.SH 30.3 GETTING HELP -.SH -30.3.1 THE MAN PAGES +.SH 30.3.1 THE MAN PAGES -.BR +.br Type: -.BR +.br man sisu -.BR +.br The man pages are also available online, though not always kept as up to date as within the package itself: -.BR +.br * sisu.1 <http://www.jus.uio.no/sisu/man/sisu.1.html> [^25] -.BR +.br * sisu.8 <http://www.jus.uio.no/sisu/man/sisu.8.html> [^26] -.BR +.br * man directory <http://www.jus.uio.no/sisu/man> [^27] -.SH -30.3.2 BUILT IN HELP +.SH 30.3.2 BUILT IN HELP -.BR +.br sisu --help -.BR +.br sisu --help --env -.BR +.br sisu --help --commands -.BR +.br sisu --help --markup -.SH -30.3.3 THE HOME PAGE +.SH 30.3.3 THE HOME PAGE -.BR +.br <http://www.sisudoc.org/> -.BR +.br <http://www.jus.uio.no/sisu> -.BR +.br <http://www.jus.uio.no/sisu/SiSU> -.SH -30.4 MARKUP SAMPLES +.SH 30.4 MARKUP SAMPLES -.BR +.br A number of markup samples (along with output) are available off: -.BR +.br <http://www.jus.uio.no/sisu/SiSU/examples.html> -.BR +.br Additional markup samples are packaged separately in the file: -.BR -.B * +.br +*** -.BR +.br On .B Debian 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. -.SH -31. EDITOR FILES, SYNTAX HIGHLIGHTING -.BR +.SH 31. EDITOR FILES, SYNTAX HIGHLIGHTING +.br -.BR +.br The directory: -.BR +.br \./data/sisu/v2/conf/editor-syntax-etc/ -.BR +.br \./data/sisu/v3/conf/editor-syntax-etc/ -.BR +.br /usr/share/sisu/v2/conf/editor-syntax-etc -.BR +.br /usr/share/sisu/v3/conf/editor-syntax-etc -.BR +.br contains rudimentary sisu syntax highlighting files for: -.BR +.br * (g)vim <http://www.vim.org> -.BR +.br package: sisu-vim -.BR +.br status: largely done -.BR +.br there is a vim syntax highlighting and folds component -.BR +.br * gedit <http://www.gnome.org/projects/gedit> -.BR +.br * gobby <http://gobby.0x539.de/> -.BR +.br file: sisu.lang -.BR +.br place in: -.BR +.br /usr/share/gtksourceview-1.0/language-specs -.BR +.br or -.BR +.br ~/.gnome2/gtksourceview-1.0/language-specs -.BR +.br status: very basic syntax highlighting -.BR +.br comments: this editor features display line wrap and is used by Goby! -.BR +.br * nano <http://www.nano-editor.org> -.BR +.br file: nanorc -.BR +.br save as: -.BR +.br ~/.nanorc -.BR +.br status: basic syntax highlighting -.BR +.br comments: assumes dark background; no display line-wrap; does line breaks -.BR +.br * diakonos (an editor written in ruby) <http://purepistos.net/diakonos> -.BR +.br file: diakonos.conf -.BR +.br save as: -.BR +.br ~/.diakonos/diakonos.conf -.BR +.br includes: -.BR +.br status: basic syntax highlighting -.BR +.br comments: assumes dark background; no display line-wrap -.BR +.br * kate & kwrite <http://kate.kde.org> -.BR +.br file: sisu.xml -.BR +.br place in: -.BR +.br /usr/share/apps/katepart/syntax -.BR +.br or -.BR +.br ~/.kde/share/apps/katepart/syntax -.BR +.br [settings::configure \ kate::{highlighting,filetypes}] -.BR +.br [tools::highlighting::{markup,scripts}:: \ .B \ SiSU \ ] -.BR +.br * nedit <http://www.nedit.org> -.BR +.br file: sisu_nedit.pats -.BR +.br nedit -import sisu_nedit.pats -.BR +.br status: a very clumsy first attempt [not \ really \ done] -.BR +.br comments: this editor features display line wrap -.BR +.br * emacs <http://www.gnu.org/software/emacs/emacs.html> -.BR +.br files: sisu-mode.el -.BR +.br to file ~/.emacs add the following 2 lines: -.BR +.br (add-to-list 'load-path "/usr/share/sisu/v2/conf/editor-syntax-etc/emacs") -.BR +.br (require 'sisu-mode.el) -.BR +.br [not \ done \ / \ not \ yet \ included] -.BR +.br * vim & gvim <http://www.vim.org> -.BR +.br files: -.BR +.br package is the most comprehensive sisu syntax highlighting and editor environment provided to date (is for vim/ gvim, and is separate from the contents of this directory) -.BR +.br status: this includes: syntax highlighting; vim folds; some error checking -.BR +.br comments: this editor features display line wrap -.BR +.br NOTE: -.BR +.br [ \ .B \ SiSU \ parses \ files \ with \ long \ lines \ or \ line \ breaks, \ but, \ display \ linewrap \ (without \ line-breaks) \ is \ a \ convenient \ editor \ feature \ to \ have \ for \ sisu \ markup] -.SH -32. HOW DOES SISU WORK? -.BR +.SH 32. HOW DOES SISU WORK? +.br -.BR +.br .B SiSU markup is fairly minimalistic, it consists of: a (largely optional) document header, made up of information about the document (such as when it was @@ -4327,22 +4198,21 @@ document layout, publishing, content certification, concordance etc.), and makes it possible to take advantage of some of the strengths of established ways of representing documents, (or indeed to create new ones). -.SH -33. SUMMARY OF FEATURES -.BR +.SH 33. SUMMARY OF FEATURES +.br -.BR +.br * sparse/minimal markup (clean utf-8 source texts). Documents are prepared in a single UTF-8 file using a minimalistic mnemonic syntax. Typical literature, documents like "War and Peace" require almost no markup, and most of the headers are optional. -.BR +.br * 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]. -.BR +.br * 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 @@ -4356,39 +4226,39 @@ alternative practical standard ways of representing documents [be \ that \ browser \ viewing, \ paper \ publication, \ sql \ search \ etc.] (html, epub, xml, odf, latex, pdf, sql) -.BR +.br * 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: -.BR +.br * html - both as a single scrollable text and a segmented document -.BR +.br * xhtml -.BR +.br * epub -.BR +.br * XML - both in sax and dom style xml structures for further development as required -.BR +.br * ODF - open document format, the iso standard for document storage -.BR +.br * LaTeX - used to generate pdf -.BR +.br * pdf (via LaTeX) -.BR +.br * sql - population of an sql database, (at the same object level that is used to cite text within a document) -.BR +.br 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 @@ -4396,7 +4266,7 @@ 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)) -.BR +.br * 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 @@ -4408,7 +4278,7 @@ 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. -.BR +.br * 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 @@ -4417,7 +4287,7 @@ 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]. -.BR +.br * 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 @@ -4425,45 +4295,45 @@ considerable degree of future-proofing, output representations are (open document text) module in 2006, epub in 2009 and in future html5 output sometime in future, without modification of existing prepared texts -.BR +.br * SQL search aside, documents are generated as required and static once generated. -.BR +.br * 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) -.BR +.br * document source (plaintext utf-8) if shared on the net may be used as input and processed locally to produce the different document outputs -.BR +.br * 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 -.BR +.br * generated document outputs may automatically be posted to remote sites. -.BR +.br * for basic document generation, the only software dependency is .B 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. -.BR +.br * as a developers tool it is flexible and extensible -.BR +.br Syntax highlighting for .B SiSU markup is available for a number of text editors. -.BR +.br .B SiSU 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 @@ -4471,7 +4341,7 @@ 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 -.BR +.br 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 @@ -4479,7 +4349,7 @@ 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)... -.BR +.br 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 @@ -4488,109 +4358,68 @@ 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. -.SH -34. HELP SOURCES -.BR - -.BR -For a summary of alternative ways to get help on -.B SiSU -try one of the following: - -.BR -.B man page - -.BR - man sisu_help - -.BR -.B man2html - -.BR - <http://www.jus.uio.no/sisu/man/sisu_help.1.html> - -.BR -.B sisu generated output - links to html - -.BR - <http://sisudoc.org/sisu/sisu_help/index.html> - -.BR -.B help sources lists - -.BR -Alternative sources for this help sources page listed here: - -.BR - man sisu_help_sources - -.BR - <http://sisudoc.org/sisu/sisu_help_sources/index.html> - -.SH -34.1 MAN PAGES +.SH 34. HELP SOURCES +.br -.SH -34.1.1 MAN +.SH 34.1 MAN PAGES -.BR +.br man sisu -.BR +.br man sisu-concordance -.BR +.br man sisu-epub -.BR +.br man sisu-git -.BR +.br man sisu-harvest -.BR +.br man sisu-html -.BR +.br man sisu-odf -.BR +.br man sisu-pdf -.BR +.br man sisu-pg -.BR +.br man sisu-po -.BR +.br man sisu-sqlite -.BR +.br man sisu-txt -.BR +.br man 7 sisu_complete -.BR +.br man 7 sisu_pdf -.BR +.br man 7 sisu_postgresql -.BR +.br man 7 sisu_sqlite -.BR +.br man sisu_termsheet -.BR +.br man sisu_webrick -.SH -34.2 SISU GENERATED OUTPUT - LINKS TO HTML +.SH 34.2 SISU GENERATED OUTPUT - LINKS TO HTML -.BR +.br Note .B SiSU documentation is prepared in @@ -4598,210 +4427,196 @@ documentation is prepared in 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[^29] -.SH -34.2.1 WWW.SISUDOC.ORG +.SH 34.2.1 WWW.SISUDOC.ORG -.BR +.br <http://sisudoc.org/sisu/sisu_manual/index.html> -.BR +.br <http://sisudoc.org/sisu/sisu_manual/index.html> -.SH -34.3 MAN2HTML +.SH 34.3 MAN2HTML -.SH -34.3.1 LOCALLY INSTALLED +.SH 34.3.1 LOCALLY INSTALLED -.BR +.br file:///usr/share/doc/sisu/html/sisu.1.html -.BR +.br file:///usr/share/doc/sisu/html/sisu.1.html -.BR - file:///usr/share/doc/sisu/html/sisu_pdf.7.html +.br + /usr/share/doc/sisu/html/sisu_pdf.7.html -.BR - file:///usr/share/doc/sisu/html/sisu_postgresql.7.html +.br + /usr/share/doc/sisu/html/sisu_postgresql.7.html -.BR - file:///usr/share/doc/sisu/html/sisu_sqlite.7.html +.br + /usr/share/doc/sisu/html/sisu_sqlite.7.html -.BR - file:///usr/share/doc/sisu/html/sisu_webrick.1.html +.br + /usr/share/doc/sisu/html/sisu_webrick.1.html -.SH -34.3.2 WWW.JUS.UIO.NO/SISU +.SH 34.3.2 WWW.jus.uio.no/sisu -.BR +.br <http://www.jus.uio.no/sisu/man/sisu.1.html> -.BR +.br <http://www.jus.uio.no/sisu/man/sisu.1.html> -.BR +.br <http://www.jus.uio.no/sisu/man/sisu_complete.7.html> -.BR +.br <http://www.jus.uio.no/sisu/man/sisu_pdf.7.html> -.BR +.br <http://www.jus.uio.no/sisu/man/sisu_postgresql.7.html> -.BR +.br <http://www.jus.uio.no/sisu/man/sisu_sqlite.7.html> -.BR +.br <http://www.jus.uio.no/sisu/man/sisu_webrick.1.html> -.TP -.BI 1. -objects include: headings, paragraphs, verse, tables, images, but not +1. 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. -.TP -.BI 2. -i.e. the html, pdf, epub, odf outputs are each built individually and + +.br +2. 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. -.BR -.TP -.BI 3. -the different heading levels -.TP -.BI 4. -units of text, primarily paragraphs and headings, also any tables, poems, +.br +3. the different heading levels + +.br +4. units of text, primarily paragraphs and headings, also any tables, poems, code-blocks -.TP -.BI 5. -Specification submitted by Adobe to ISO to become a full open ISO + +.br +5. Specification submitted by Adobe to ISO to become a full open ISO specification <http://www.linux-watch.com/news/NS7542722606.html> -.TP -.BI 6. -ISO standard ISO/IEC 26300:2006 -.BR -.TP -.BI 7. -An open standard format for e-books +.br +6. ISO standard ISO/IEC 26300:2006 -.BR -.TP -.BI *1. -square brackets -.TP -.BI *2. -square brackets -.TP -.BI +1. -square brackets -.TP -.BI 8. -<http://www.jus.uio.no/sisu/man/> -.TP -.BI 9. -<http://www.jus.uio.no/sisu/man/sisu.1.html> -.TP -.BI 10. -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. -.TP -.BI 11. -files should be prepared using UTF-8 character encoding -.TP -.BI 12. -a footnote or endnote -.TP -.BI 13. -self contained endnote marker & endnote in one -.TP -.BI *. -unnumbered asterisk footnote/endnote, insert multiple asterisks if required -.TP -.BI **. -another unnumbered asterisk footnote/endnote -.TP -.BI *3. -editors notes, numbered asterisk footnote/endnote series -.TP -.BI +2. -editors notes, numbered asterisk footnote/endnote series -.TP -.BI 14. -<http://www.sisudoc.org/> +.br +7. An open standard format for e-books -.BR -.TP -.BI 15. -<http://www.ruby-lang.org/en/> -.TP -.BI 16. -Table from the Wealth of Networks by Yochai Benkler +.br +*1. square brackets + +.br +*2. square brackets + +.br ++1. square brackets + +.br +8. <http://www.jus.uio.no/sisu/man/> + +.br +9. <http://www.jus.uio.no/sisu/man/sisu.1.html> + +.br +10. 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. + +.br +11. files should be prepared using UTF-8 character encoding + +.br +12. a footnote or endnote + +.br +13. self contained endnote marker & endnote in one + +.br +* unnumbered asterisk footnote/endnote, insert multiple asterisks if +required + +.br +** another unnumbered asterisk footnote/endnote + +.br +*3. editors notes, numbered asterisk footnote/endnote series + +.br ++2. editors notes, numbered asterisk footnote/endnote series + +.br +14 <http://www.sisudoc.org/> + +.br +15. <http://www.ruby-lang.org/en/> + +.br +16. Table from the Wealth of Networks by Yochai Benkler <http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler> -.TP -.BI 17. -\.ssc (for composite) 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 "accidents", working on a \.ssc file that is overwritten by subsequent -processing. It may be however that when the resulting file is shared \.ssc is an -appropriate suffix to use. -.TP -.BI 19. -<http://www.postgresql.org/> + +.br +17. .ssc (for composite) 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 \"accidents\", working on a .ssc file that is overwritten by +subsequent processing. It may be however that when the resulting file is shared +.ssc is an appropriate suffix to use. + +.br +19. <http://www.postgresql.org/> +.br <http://advocacy.postgresql.org/> +.br <http://en.wikipedia.org/wiki/Postgresql> -.TP -.BI 20. -<http://www.hwaci.com/sw/sqlite/> +.br +20. <http://www.hwaci.com/sw/sqlite/> +.br <http://en.wikipedia.org/wiki/Sqlite> -.TP -.BI 21. -<http://search.sisudoc.org> -.TP -.BI 22. -(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. -.TP -.BI 23. -of this feature when demonstrated to an IBM software innovations evaluator +.br +21. <http://search.sisudoc.org> + +.br +22. (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. + +.br +23. 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. -.TP -.BI 24. -There is nothing to stop MySQL support being added in future. -.TP -.BI 25. -<http://www.jus.uio.no/sisu/man/sisu.1.html> -.BR -.TP -.BI 26. -<http://www.jus.uio.no/sisu/man/sisu.8.html> +.br +24. There is nothing to stop MySQL support being added in future. -.BR -.TP -.BI 27. -<http://www.jus.uio.no/sisu/man> -.TP -.BI 28. -the +.br +25. <http://www.jus.uio.no/sisu/man/sisu.1.html> + +.br +26. <http://www.jus.uio.no/sisu/man/sisu.8.html> + +.br +27. <http://www.jus.uio.no/sisu/man> + +.br +28. the .B Debian Free Software guidelines require that everything distributed within .B Debian can be changed - and the documents are authors' works that while freely distributable are not freely changeable. -.TP -.BI 29. -named index.html or more extensively through sisu_manifest.html + +.br +29. named index.html or more extensively through sisu_manifest.html +.br .SH SEE ALSO +.br \fIsisu\fR(1), .br \fIsisu-epub\fR(1), @@ -4823,6 +4638,7 @@ named index.html or more extensively through sisu_manifest.html \fIsisu_vim\fR(7) .SH HOMEPAGE +.br More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. .SH AUTHOR |