From 57ad1a1e1e5c31669eedd8c319f9ba5feb1aab6f Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Thu, 10 Mar 2011 09:07:26 -0500 Subject: manpage: sisu.1 and html regenerated --- man/man1/sisu.1 | 2452 +++++++++++++++++++++++++------------------------------ 1 file changed, 1134 insertions(+), 1318 deletions(-) (limited to 'man/man1') 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 -.BR +.br -.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: -.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 -.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 [^8] -.BR +.br * sisu.1 [^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 - - -.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 or from -.BR +.br There is of course this document, which provides a cursory overview of sisu markup and the respective output produced: -.BR -Some example marked up files are available as html with syntax highlighting for -viewing: - -.BR +.br an alternative presentation of markup syntax: - +/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 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 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 [^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" -.BR +.br [ \ ruby_logo \ (png \ missing) \ ] [^15] -.BR +.br GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian and Ruby" -.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 -.BR +.br -.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 -.BR +.br -.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 -.BR +.br -.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 -.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 [^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 -.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: -.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: or -.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 or -.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 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 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 -.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 -.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 -.BR +.br -.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 -.BR +.br -.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 [^25] -.BR +.br * sisu.8 [^26] -.BR +.br * man directory [^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 -.BR +.br -.BR +.br -.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 -.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 -.BR +.br package: sisu-vim -.BR +.br status: largely done -.BR +.br there is a vim syntax highlighting and folds component -.BR +.br * gedit -.BR +.br * gobby -.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 -.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) -.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 -.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 -.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 -.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 -.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 - - -.BR -.B sisu generated output - links to html - -.BR - - -.BR -.B help sources lists - -.BR -Alternative sources for this help sources page listed here: - -.BR - man sisu_help_sources - -.BR - - -.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 -.BR +.br -.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 -.BR +.br -.BR +.br -.BR +.br -.BR +.br -.BR +.br -.BR +.br -.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 -.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. - -.TP -.BI 9. - -.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. - +.br +7. An open standard format for e-books -.BR -.TP -.BI 15. - -.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. + +.br +9. + +.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 + +.br +15. + +.br +16. Table from the Wealth of Networks by 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. - + +.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. +.br +.br -.TP -.BI 20. - +.br +20. +.br -.TP -.BI 21. - -.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. + +.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. - -.BR -.TP -.BI 26. - +.br +24. There is nothing to stop MySQL support being added in future. -.BR -.TP -.BI 27. - -.TP -.BI 28. -the +.br +25. + +.br +26. + +.br +27. + +.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 -- cgit v1.2.3