From 582f1bbd8b8a52b6198f6404cefb2763d5e5d3da Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Wed, 21 Mar 2012 19:57:53 -0400 Subject: v3: documentation sisu_commands, manpage, html (man2html) --- man/man1/sisu.1 | 1319 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 685 insertions(+), 634 deletions(-) (limited to 'man') diff --git a/man/man1/sisu.1 b/man/man1/sisu.1 index 1d4d280b..ceef64ca 100644 --- a/man/man1/sisu.1 +++ b/man/man1/sisu.1 @@ -1,4 +1,4 @@ -.TH "sisu" "1" "2011-12-08" "3.1.7" "SiSU" +.TH "sisu" "1" "2012-03-19" "3.2.0" "SiSU" .br .SH NAME .br @@ -213,6 +213,23 @@ footnotes at the end of each paragraph \-\-unix for unix linefeed (default) .B \-b [filename/wildcard] see \-\-xhtml +.TP +.B \-C +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. + +.TP +.B \-CC +see \-\-configure + +.TP +.B \-c [filename/wildcard] +see \-\-color\-toggle + .TP .B \-\-color\-toggle [filename/wildcard] screen toggle ansi screen colour on or off depending on default set (unless \-c @@ -236,21 +253,12 @@ 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 .TP -.B \-C -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. - -.TP -.B \-CC -see \-\-configure +.B \-D [instruction] [filename] +see \-\-pg .TP -.B \-c [filename/wildcard] -see \-\-color\-toggle +.B \-d [\-\-db\-[database \ type \ (sqlite|pg)]] \-\-[instruction] [filename] +see \-\-sqlite .TP .B \-\-dal [filename/wildcard/url] @@ -264,20 +272,45 @@ Alias \-m see \-\-zap .TP -.B \-D [instruction] [filename] -see \-\-pg +.B \-\-dump[=directory_path] [filename/wildcard] +places output in directory specified, if none is specified in the current +directory (pwd). Compare \-\-redirect .TP -.B \-d [\-\-db\-[database \ type \ (sqlite|pg)]] \-\-[instruction] [filename] -see \-\-sqlite +.B \-e [filename/wildcard] +see \-\-epub .TP .B \-\-epub [filename/wildcard] produces an epub document, [sisu \ version \ >=2 \ ] (filename.epub). Alias \-e .TP -.B \-e [filename/wildcard] -see \-\-epub +.B \-\-exc\-* +exclude output feature, overrides configuration settings \-\-exc\-ocn, (exclude +object citation numbering, affects html (seg, scroll), epub, xhtml, xml); +\-\-exc\-toc, (exclude table of contents, affects html (scroll), epub, pdf); +\-\-exc\-links\-to\-manifest, \-\-exc\-manifest\-links, (exclude links to +manifest, affects html (seg, scroll)); \-\-exc\-search\-form, (exclude search +form, affects html (seg, scroll), manifest); \-\-exc\-minitoc, (exclude mini +table of contents, affects html (seg), concordance, manifest); +\-\-exc\-manifest\-minitoc, (exclude mini table of contents, affects manifest); +\-\-exc\-html\-minitoc, (exclude mini table of contents, affects html (seg), +concordance); \-\-exc\-html\-navigation, (exclude navigation, affects html +(seg)); \-\-exc\-html\-navigation\-bar, (exclude navigation bar, affects html +(seg)); \-\-exc\-html\-search\-form, (exclude search form, affects html (seg, +scroll)); \-\-exc\-html\-right\-pane, (exclude right pane/column, affects html +(seg, scroll)); \-\-exc\-html\-top\-band, (exclude top band, affects html (seg, +scroll), concordance (minitoc forced on to provide seg navigation)); +\-\-exc\-segsubtoc (exclude sub table of contents, affects html (seg), epub); +see also \-\-inc\-* + +.TP +.B \-F [\-\-webserv=webrick] +see \-\-sample\-search\-form + +.TP +.B \-f [optional \ string \ part \ of \ filename] +see \-\-find .TP .B \-\-find [optional \ string \ part \ of \ filename] @@ -286,12 +319,12 @@ language subdirectories). With match string, find files that match given string in directory (including language subdirectories). Alias \-f, \-\-glob, \-G .TP -.B \-F [\-\-webserv=webrick] -see \-\-sample\-search\-form +.B \-G [optional \ string \ part \ of \ filename] +see \-\-find .TP -.B \-f [optional \ string \ part \ of \ filename] -see \-\-find +.B \-g [filename/wildcard] +see \-\-git .TP .B \-\-git [filename/wildcard] @@ -303,12 +336,8 @@ and subject to change). Alias \-g see \-\-find .TP -.B \-G [optional \ string \ part \ of \ filename] -see \-\-find - -.TP -.B \-g [filename/wildcard] -see \-\-git +.B \-h [filename/wildcard] +see \-\-html .TP .B \-\-harvest *.ss[tm] @@ -324,17 +353,13 @@ 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 +features, license. .TP .B \-\-html [filename/wildcard] 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 -.TP -.B \-h [filename/wildcard] -see \-\-html - .TP .B \-I [filename/wildcard] see \-\-texinfo @@ -343,6 +368,17 @@ see \-\-texinfo .B \-i [filename/wildcard] see \-\-manpage +.TP +.B \-\-inc\-* +include output feature, overrides configuration settings, (usually the default +if none set), has precedence over \-\-exc\-* (exclude output feature). Some +detail provided under \-\-exc\-*, see \-\-exc\-* + +.TP +.B \-j [filename/wildcard] +copies images associated with a file for use by html, xhtml & xml outputs +(automatically invoked by \-\-dump & redirect). + .TP .B \-\-keep\-processing\-files [filename/wildcard/url] see \-\-maintenance @@ -351,6 +387,14 @@ see \-\-maintenance .B \-L prints license information. +.TP +.B \-M [filename/wildcard/url] +see \-\-maintenance + +.TP +.B \-m [filename/wildcard/url] +see \-\-dal (document abstraction level/layer) + .TP .B \-\-machine [filename/wildcard/url] see \-\-dal (document abstraction level/layer) @@ -358,26 +402,12 @@ see \-\-dal (document abstraction level/layer) .TP .B \-\-maintenance [filename/wildcard/url] maintenance mode, interim processing files are preserved and their locations -indicated. (also see \-V). Aliases \-M and \-\-keep\-processing\-files +indicated. (also see \-V). Aliases \-M and \-\-keep\-processing\-files. .TP .B \-\-manpage [filename/wildcard] produces man page of file, not suitable for all outputs. Alias \-i -.TP -.B \-M [filename/wildcard/url] -see \-\-maintenance - -.TP -.B \-m [filename/wildcard/url] -see \-\-dal (document abstraction level/layer) - -.TP -.B \-\-no\-ocn -[with \ \-\-html \ \-\-pdf \ or \ \-\-epub] switches off object citation -numbering. Produce output without identifying numbers in margins of html or -LaTeX/pdf output. - .TP .B \-N [filename/wildcard/url] document digest or document content certificate ( DCC ) as md5 digest tree of @@ -391,6 +421,20 @@ 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. +.TP +.B \-\-no\-* +see \-\-exc\-* + +.TP +.B \-\-no\-ocn +[with \ \-\-html \ \-\-pdf \ or \ \-\-epub] switches off object citation +numbering. Produce output without identifying numbers in margins of html or +LaTeX/pdf output. + +.TP +.B \-o [filename/wildcard/url] +see \-\-odt + .TP .B \-\-odf [filename/wildcard/url] see \-\-odt @@ -400,8 +444,12 @@ see \-\-odt output basic document in opendocument file format (opendocument.odt). Alias \-o .TP -.B \-o [filename/wildcard/url] -see \-\-odt +.B \-P [language_directory/filename \ language_directory] +see \-\-po4a + +.TP +.B \-p [filename/wildcard] +see \-\-pdf .TP .B \-\-pdf [filename/wildcard] @@ -431,12 +479,12 @@ es/. The sisu config file must set the output directory structure to multilingual. v3, experimental .TP -.B \-P [language_directory/filename \ language_directory] -see \-\-po4a +.B \-Q [filename/wildcard] +see \-\-qrcode .TP -.B \-p [filename/wildcard] -see \-\-pdf +.B \-q [filename/wildcard] +see \-\-quiet .TP .B \-\-qrcode [filename/wildcard] @@ -447,12 +495,18 @@ generate QR code image of metadata (used in manifest). v3 only. quiet less output to screen. .TP -.B \-Q [filename/wildcard] -see \-\-qrcode +.B \-R [filename/wildcard] +see \-\-rsync .TP -.B \-q [filename/wildcard] -see \-\-quiet +.B \-r [filename/wildcard] +see \-\-scp + +.TP +.B \-\-redirect[=directory_path] [filename/wildcard] +places output in subdirectory under specified directory, subdirectory uses the +filename (without the suffix). If no output directory is specified places the +subdirectory under the current directory (pwd). Compare \-\-dump .TP .B \-\-rsync [filename/wildcard] @@ -464,12 +518,16 @@ different if \-R is used with other flags from if used alone. Alone the rsync \-R is used together with other flags, it is not). Also see \-\-scp. Alias \-R .TP -.B \-R [filename/wildcard] -see \-\-rsync +.B \-S +see \-\-sisupod .TP -.B \-r [filename/wildcard] -see \-\-scp +.B \-S [filename/wildcard] +see \-\-sisupod + +.TP +.B \-s [filename/wildcard] +see \-\-source .TP .B \-\-sample\-search\-form [\-\-webserv=webrick] @@ -492,11 +550,14 @@ that you have your "keys" and ssh agent in place. Also see \-\-rsync. Alias \-r .TP .B \-\-sqlite \-\-[instruction] [filename] -database type default set to sqlite, (for which \-\-sqlite may be used instead) -or to specify another database \-\-db\-[pgsql, \ sqlite] (however see \-D) -possible instructions include: \-\-createdb; \-\-create; \-\-dropall; -\-\-import [filename]; \-\-update [filename]; \-\-remove [filename]; see -database section below. Alias \-d +database type set to sqlite, this produces one of two possible databases, +without additional database related instructions it produces a discreet sqlite +file for the document processed; with additional instructions it produces a +common sqlite database of all processed documents that (come from the same +document preparation directory and as a result) share the same output directory +base path (possible instructions include: \-\-createdb; \-\-create; +\-\-dropall; \-\-import [filename]; \-\-update [filename]; \-\-remove +[filename]); see database section below. Alias \-d .TP .B \-\-sisupod @@ -531,16 +592,12 @@ for sending). See the \-S option without [filename/wildcard]. Alias \-S copies sisu markup file to output directory. Alias \-s .TP -.B \-S -see \-\-sisupod - -.TP -.B \-S [filename/wildcard] -see \-\-sisupod +.B \-T [filename/wildcard \ (*.termsheet.rb)] +standard form document builder, preprocessing feature .TP -.B \-s [filename/wildcard] -see \-\-source +.B \-t [filename/wildcard] +see \-\-txt .TP .B \-\-texinfo [filename/wildcard] @@ -556,12 +613,13 @@ footnotes at the end of each paragraph \-\-unix for unix linefeed (default) \-\-msdos for msdos linefeed). Alias \-t .TP -.B \-T [filename/wildcard \ (*.termsheet.rb)] -standard form document builder, preprocessing feature +.B \-U [filename/wildcard] +see \-\-urls .TP -.B \-t [filename/wildcard] -see \-\-txt +.B \-u [filename/wildcard] +provides url mapping of output files for the flags requested for processing, +also see \-U .TP .B \-\-urls [filename/wildcard] @@ -574,13 +632,24 @@ provides webrick url mappings where appropriate, but these can be switched to file system paths in sisurc.yml. Alias \-U .TP -.B \-U [filename/wildcard] -see \-\-urls +.B \-V +on its own, provides +.B SiSU +version and environment information (sisu \-\-help env) .TP -.B \-u [filename/wildcard] -provides url mapping of output files for the flags requested for processing, -also see \-U +.B \-V [filename/wildcard] +even more verbose than the \-v flag. + +.TP +.B \-v +on its own, provides +.B SiSU +version information + +.TP +.B \-v [filename/wildcard] +see \-\-verbose .TP .B \-\-v2 [filename/wildcard] @@ -599,24 +668,12 @@ error messages if any), as with \-u flag provides a url mapping of files created for each of the processing flag requests. Alias \-v .TP -.B \-V -on its own, provides -.B SiSU -version and environment information (sisu \-\-help env) - -.TP -.B \-V [filename/wildcard] -even more verbose than the \-v flag. - -.TP -.B \-v -on its own, provides -.B SiSU -version information +.B \-W +see \-\-webrick .TP -.B \-v [filename/wildcard] -see \-\-verbose +.B \-w [filename/wildcard] +see \-\-concordance .TP .B \-\-webrick @@ -626,18 +683,10 @@ port is set to 8081 and can be changed in the resource configuration files. output \ should \ be \ created \ using \ the \ \-h \ option \ rather \ than \ \-H \ ; \ also, \ note \ \-F \ webrick \ ]. Alias \-W -.TP -.B \-W -see \-\-webrick - .TP .B \-\-wordmap [filename/wildcard] see \-\-concordance -.TP -.B \-w [filename/wildcard] -see \-\-concordance - .TP .B \-\-xhtml [filename/wildcard] produces xhtml/XML output for browser viewing (sax parsing). Alias \-b @@ -671,6 +720,10 @@ produces an html summary of output generated (hyperlinked to content) and document specific metadata (sisu_manifest.html). This step is assumed for most processing flags. +.TP +.B \-Z [filename/wildcard] +see \-\-zap + .TP .B \-\-zap [filename/wildcard] Zap, if used with other processing flags deletes output files of the type about @@ -678,10 +731,6 @@ to be processed, prior to processing. If \-Z is used as the lone processing related flag (or in conjunction with a combination of \-[mMvVq]), will remove the related document output directory. Alias \-Z -.TP -.B \-Z [filename/wildcard] -see \-\-zap - .SH 3. COMMAND LINE MODIFIERS .br @@ -1027,7 +1076,7 @@ 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 +% this would be a comment .fi .SH 8.1 SAMPLE HEADER @@ -1037,49 +1086,49 @@ This current document is loaded by a master document that has a header similar to this one: .nf - % SiSU master 2.0 - @title: SiSU - :subtitle: Manual - @creator: - :author: Amissah, Ralph - @publisher: \ [publisher \ name] - @rights: Copyright (C) Ralph Amissah 2007, License GPL 3 - @classify: - :type: information - :topic_register: SiSU:manual;electronic documents:SiSU:manual - :subject: ebook, epublishing, electronic book, electronic publishing, - electronic document, electronic citation, data structure, - citation systems, search - % used_by: manual - @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 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - :manpage: name=sisu \- documents: markup, structuring, publishing - in multiple standard formats, and search; - synopsis=sisu \ [\-abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0\-9] \ [filename/wildcard \ ] - . sisu \ [\-Ddcv] \ [instruction] - . sisu \ [\-CcFLSVvW] - . sisu \-\-v2 \ [operations] - . 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 +% SiSU master 2.0 +@title: SiSU + :subtitle: Manual +@creator: + :author: Amissah, Ralph +@publisher: \ [publisher \ name] +@rights: Copyright (C) Ralph Amissah 2007, License GPL 3 +@classify: + :type: information + :topic_register: SiSU:manual;electronic documents:SiSU:manual + :subject: ebook, epublishing, electronic book, electronic publishing, + electronic document, electronic citation, data structure, + citation systems, search +% used_by: manual +@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 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + :manpage: name=sisu \- documents: markup, structuring, publishing + in multiple standard formats, and search; + synopsis=sisu \ [\-abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0\-9] \ [filename/wildcard \ ] + . sisu \ [\-Ddcv] \ [instruction] + . sisu \ [\-CcFLSVvW] + . sisu \-\-v2 \ [operations] + . 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 @@ -1108,86 +1157,86 @@ structure, and can be useful to know. This is a sample header .nf - % SiSU 2.0 \ [declared \ file\-type \ identifier \ with \ markup \ version] +% SiSU 2.0 \ [declared \ file\-type \ identifier \ with \ markup \ version] .fi .nf - @title: \ [title \ text] \ [this \ header \ is \ the \ only \ one \ that \ is \ mandatory] - :subtitle: \ [subtitle \ if \ any] - :language: English +@title: \ [title \ text] \ [this \ header \ is \ the \ only \ one \ that \ is \ mandatory] + :subtitle: \ [subtitle \ if \ any] + :language: English .fi .nf - @creator: - :author: \ [Lastname, \ First \ names] - :illustrator: \ [Lastname, \ First \ names] - :translator: \ [Lastname, \ First \ names] - :prepared_by: \ [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] - :created: \ [year \ or \ yyyy\-mm\-dd] - :issued: \ [year \ or \ yyyy\-mm\-dd] - :available: \ [year \ or \ yyyy\-mm\-dd] - :modified: \ [year \ or \ yyyy\-mm\-dd] - :valid: \ [year \ or \ yyyy\-mm\-dd] - :added_to_site: \ [year \ or \ yyyy\-mm\-dd] - :translated: \ [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] + :modified: \ [year \ or \ yyyy\-mm\-dd] + :valid: \ [year \ or \ yyyy\-mm\-dd] + :added_to_site: \ [year \ or \ yyyy\-mm\-dd] + :translated: \ [year \ or \ yyyy\-mm\-dd] .fi .nf - @rights: - :copyright: Copyright (C) \ [Year \ and \ Holder] - :license: \ [Use \ License \ granted] - :text: \ [Year \ and \ Holder] - :translation: \ [Name, \ Year] - :illustrations: \ [Name, \ Year] +@rights: + :copyright: Copyright (C) \ [Year \ and \ Holder] + :license: \ [Use \ License \ granted] + :text: \ [Year \ and \ Holder] + :translation: \ [Name, \ Year] + :illustrations: \ [Name, \ Year] .fi .nf - @classify: - :topic_register: SiSU:markup sample:book;book:novel:fantasy - :type: - :subject: - :description: - :keywords: - :abstract: - :isbn: \ [ISBN] - :loc: \ [Library \ of \ Congress \ classification] - :dewey: \ [Dewey \ classification] - :pg: \ [Project \ Gutenberg \ text \ number] +@classify: + :topic_register: SiSU:markup sample:book;book:novel:fantasy + :type: + :subject: + :description: + :keywords: + :abstract: + :isbn: \ [ISBN] + :loc: \ [Library \ of \ Congress \ classification] + :dewey: \ [Dewey \ classification] + :pg: \ [Project \ Gutenberg \ text \ number] .fi .nf - @links: { SiSU }http://www.sisudoc.org - { FSF }http://www.fsf.org +@links: { SiSU }http://www.sisudoc.org + { FSF }http://www.fsf.org .fi .nf - @make: - :skin: skin_name - [skins change default settings related to the appearance of documents generated] - :num_top: 1 - :headings: \ [text \ to \ match \ for \ each \ level - (e.g. PART; Chapter; Section; Article; - or another: none; BOOK|FIRST|SECOND; none; CHAPTER;) - :breaks: new=:C; break=1 - :promo: sisu, ruby, sisu_search_libre, open_society - :bold: [regular expression of words/phrases to be made bold] - :italics: \ [regular \ expression \ of \ words/phrases \ to \ italicise] +@make: + :skin: skin_name + [skins change default settings related to the appearance of documents generated] + :num_top: 1 + :headings: \ [text \ to \ match \ for \ each \ level + (e.g. PART; Chapter; Section; Article; + or another: none; BOOK|FIRST|SECOND; none; CHAPTER;) + :breaks: new=:C; break=1 + :promo: sisu, ruby, sisu_search_libre, open_society + :bold: [regular expression of words/phrases to be made bold] + :italics: \ [regular \ expression \ of \ words/phrases \ to \ italicise] .fi .nf - @original: - :language: \ [language] +@original: + :language: \ [language] .fi .nf - @notes: - :comment: - :prefix: \ [prefix \ is \ placed \ just \ after \ table \ of \ contents] +@notes: + :comment: + :prefix: \ [prefix \ is \ placed \ just \ after \ table \ of \ contents] .fi .SH 9. MARKUP OF SUBSTANTIVE TEXT @@ -1236,10 +1285,10 @@ 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, - % and may be further subdivided (this is the level on which by default html - % segments are made) +1~filename level 1 heading, +% the primary division such as Chapter that is followed by substantive text, +% and may be further subdivided (this is the level on which by default html +% segments are made) .fi .SH 9.2 FONT ATTRIBUTES @@ -1248,29 +1297,29 @@ be marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a document .B markup example: .nf - normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}", - ^{superscript}^, ,{subscript},, +{inserted text}+, \-{strikethrough}\-, #{monospace}# - normal text +normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}", +^{superscript}^, ,{subscript},, +{inserted text}+, \-{strikethrough}\-, #{monospace}# +normal text .br - *{emphasis}* \ [note: \ can \ be \ configured \ to \ be \ represented \ by \ bold, \ italics \ or \ underscore] +*{emphasis}* \ [note: \ can \ be \ configured \ to \ be \ represented \ by \ bold, \ italics \ or \ underscore] .br - !{bold text}! +!{bold text}! .br - _{underscore}_ +_{underscore}_ .br - /{italics}/ +/{italics}/ .br - "{citation}" +"{citation}" .br - ^{superscript}^ +^{superscript}^ .br - ,{subscript}, +,{subscript}, .br - +{inserted text}+ ++{inserted text}+ .br - \-{strikethrough}\- +\-{strikethrough}\- .br - #{monospace}# +#{monospace}# .fi .br @@ -1326,13 +1375,13 @@ monospace .B markup example: .nf - ordinary paragraph +ordinary paragraph .br - _1 indent paragraph one step +_1 indent paragraph one step .br - _2 indent paragraph two steps +_2 indent paragraph two steps .br - _9 indent paragraph nine steps +_9 indent paragraph nine steps .fi .br @@ -1354,11 +1403,11 @@ ordinary paragraph .B markup example: .nf - _* bullet text +_* bullet text .br - _1* bullet text, first indent +_1* bullet text, first indent .br - _2* bullet text, two step indent +_2* bullet text, two step indent .fi .br @@ -1380,9 +1429,9 @@ Numbered List (not to be confused with headings/titles, (document structure)) .B markup example: .nf - # numbered list numbered list 1., 2., 3, etc. +# numbered list numbered list 1., 2., 3, etc. .br - _# numbered list numbered list indented a., b., c., d., etc. +_# numbered list numbered list indented a., b., c., d., etc. .fi .SH 9.4 HANGING INDENTS @@ -1391,11 +1440,11 @@ Numbered List (not to be confused with headings/titles, (document structure)) .B markup example: .nf - _0_1 first line no indent, - rest of paragraph indented one step - _1_0 first line indented, - rest of paragraph no indent - in each case level may be 0\-9 +_0_1 first line no indent, +rest of paragraph indented one step +_1_0 first line indented, +rest of paragraph no indent +in each case level may be 0\-9 .fi .br @@ -1421,7 +1470,7 @@ determines whether footnotes or endnotes will be produced .B markup example: .nf - ~{ a footnote or endnote }~ +~{ a footnote or endnote }~ .fi .br @@ -1434,7 +1483,7 @@ determines whether footnotes or endnotes will be produced .B markup example: .nf - normal text~{ self contained endnote marker & endnote in one }~ continues +normal text~{ self contained endnote marker & endnote in one }~ continues .fi .br @@ -1447,9 +1496,9 @@ normal text[^13] continues .B markup example: .nf - normal text ~{* unnumbered asterisk footnote/endnote, insert multiple asterisks if required }~ continues +normal text ~{* unnumbered asterisk footnote/endnote, insert multiple asterisks if required }~ continues .br - normal text ~{** another unnumbered asterisk footnote/endnote }~ continues +normal text ~{** another unnumbered asterisk footnote/endnote }~ continues .fi .br @@ -1465,9 +1514,9 @@ normal text [^**] continues .B markup example: .nf - normal text ~[* \ editors \ notes, \ numbered \ asterisk \ footnote/endnote \ series \ ]~ continues +normal text ~[* \ editors \ notes, \ numbered \ asterisk \ footnote/endnote \ series \ ]~ continues .br - normal text ~[+ \ editors \ notes, \ numbered \ asterisk \ footnote/endnote \ series \ ]~ continues +normal text ~[+ \ editors \ notes, \ numbered \ asterisk \ footnote/endnote \ series \ ]~ continues .fi .br @@ -1483,10 +1532,10 @@ normal text [^+2] continues .B Alternative endnote pair notation for footnotes/endnotes: .nf - % note the endnote marker "~^" - normal text~^ continues +% note the endnote marker "~^" +normal text~^ continues .br - ^~ endnote text following the paragraph in which the marker occurs +^~ endnote text following the paragraph in which the marker occurs .fi .br @@ -1507,7 +1556,7 @@ decoration is omitted). .B markup example: .nf - normal text http://www.sisudoc.org/ continues +normal text http://www.sisudoc.org/ continues .fi .br @@ -1523,8 +1572,8 @@ An escaped url without decoration .B markup example: .nf - normal text _http://www.sisudoc.org/ continues - deb _http://www.jus.uio.no/sisu/archive unstable main non\-free +normal text _http://www.sisudoc.org/ continues +deb _http://www.jus.uio.no/sisu/archive unstable main non\-free .fi .br @@ -1544,9 +1593,9 @@ blocks are discussed later in this document .B resulting output: .nf - deb http://www.jus.uio.no/sisu/archive unstable main non\-free +deb http://www.jus.uio.no/sisu/archive unstable main non\-free .br - deb\-src 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 .SH 9.6.2 LINKING TEXT @@ -1558,7 +1607,7 @@ To link text or an image to a url the markup is as follows .B markup example: .nf - about { SiSU }http://url.org markup +about { SiSU }http://url.org markup .fi .br @@ -1575,7 +1624,7 @@ automatically as a footnote .B markup example: .nf - about {~^ SiSU }http://url.org markup +about {~^ SiSU }http://url.org markup .fi .br @@ -1584,6 +1633,9 @@ automatically as a footnote .br about SiSU [^14] markup +.br +Internal document links to a tagged location, including an ocn + .br .B markup example: @@ -1604,11 +1656,11 @@ about SiSU [^14] markup .B markup example: .nf - { 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/ +{ 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/ .fi .br @@ -1621,24 +1673,24 @@ about SiSU [^14] markup tux.png 64x80 "Gnu/Linux \- a better way" .br -[ \ ruby_logo \ (png \ missing) \ ] [^15] +GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better \- with Gnu/Linux, Debian +and Ruby" .br -GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better \- with Gnu/Linux, Debian -and Ruby" +[ \ ruby_logo \ (png \ missing) \ ] [^15] .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 +{~^ \ [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 .fi .nf - text marker *~name +text marker *~name .fi .br @@ -1657,14 +1709,14 @@ Tables may be prepared in two either of two forms .B markup example: .nf - table{ c3; 40; 30; 30; - This is a table - this would become column two of row one - column three of row one is here - And here begins another row - column two of row two - column three of row two, and so on - }table +table{ c3; 40; 30; 30; +This is a table +this would become column two of row one +column three of row one is here +And here begins another row +column two of row two +column three of row two, and so on +}table .fi .br @@ -1678,18 +1730,18 @@ information in each column .br .B markup example: -[^16] +[^17] .nf - !_ Table 3.1: Contributors to Wikipedia, January 2001 \- June 2005 - {table~h 24; 12; 12; 12; 12; 12; 12;} - |Jan. 2001|Jan. 2002|Jan. 2003|Jan. 2004|July 2004|June 2006 - Contributors* | 10| 472| 2,188| 9,653| 25,011| 48,721 - Active contributors** | 9| 212| 846| 3,228| 8,442| 16,945 - Very active contributors*** | 0| 31| 190| 692| 1,639| 3,016 - No. of English language articles| 25| 16,000| 101,000| 190,000| 320,000| 630,000 - No. of articles, all languages | 25| 19,000| 138,000| 490,000| 862,000|1,600,000 - * Contributed at least ten times; ** at least 5 times in last month; *** more than 100 times in last month. +!_ Table 3.1: Contributors to Wikipedia, January 2001 \- June 2005 +{table~h 24; 12; 12; 12; 12; 12; 12;} + |Jan. 2001|Jan. 2002|Jan. 2003|Jan. 2004|July 2004|June 2006 +Contributors* | 10| 472| 2,188| 9,653| 25,011| 48,721 +Active contributors** | 9| 212| 846| 3,228| 8,442| 16,945 +Very active contributors*** | 0| 31| 190| 692| 1,639| 3,016 +No. of English language articles| 25| 16,000| 101,000| 190,000| 320,000| 630,000 +No. of articles, all languages | 25| 19,000| 138,000| 490,000| 862,000|1,600,000 +* Contributed at least ten times; ** at least 5 times in last month; *** more than 100 times in last month. .fi .br @@ -1710,62 +1762,62 @@ than 100 times in last month. .B basic markup: .nf - poem{ - Your poem here - }poem - Each verse in a poem is given an object number. +poem{ + Your poem here +}poem +Each verse in a poem is given an object number. .fi .br .B markup example: .nf - poem{ - `Fury said to a - mouse, That he - met in the - house, - "Let us - both go to - law: I will - prosecute - YOU. \-\-Come, - I'll take no - denial; We - must have a - trial: For - really this - morning I've - nothing - to do." - Said the - mouse to the - cur, "Such - a trial, - dear Sir, - With - no jury - or judge, - would be - wasting - our - breath." - "I'll be - judge, I'll - be jury," - Said - cunning - old Fury: - "I'll - try the - whole - cause, - and - condemn - you - to - death."' - }poem +poem{ + `Fury said to a + mouse, That he + met in the + house, + "Let us + both go to + law: I will + prosecute + YOU. \-\-Come, + I'll take no + denial; We + must have a + trial: For + really this + morning I've + nothing + to do." + Said the + mouse to the + cur, "Such + a trial, + dear Sir, + With + no jury + or judge, + would be + wasting + our + breath." + "I'll be + judge, I'll + be jury," + Said + cunning + old Fury: + "I'll + try the + whole + cause, + and + condemn + you + to + death."' +}poem .fi .br @@ -1866,66 +1918,65 @@ than 100 times in last month. .B basic markup: .nf - group{ +group{ .br - Your grouped text here + Your grouped text here .br - }group +}group .br - A group is treated as an object and given a single object number. +A group is treated as an object and given a single object number. .fi .br .B markup example: .nf - group{ -.br - 'Fury said to a - mouse, That he - met in the - house, - "Let us - both go to - law: I will - prosecute - YOU. \-\-Come, - I'll take no - denial; We - must have a - trial: For - really this - morning I've - nothing - to do." - Said the - mouse to the - cur, "Such - a trial, - dear Sir, - With - no jury - or judge, - would be - wasting - our - breath." - "I'll be - judge, I'll - be jury," - Said - cunning - old Fury: - "I'll - try the - whole - cause, - and - condemn - you - to - death."' - }group +group{ + 'Fury said to a + mouse, That he + met in the + house, + "Let us + both go to + law: I will + prosecute + YOU. \-\-Come, + I'll take no + denial; We + must have a + trial: For + really this + morning I've + nothing + to do." + Said the + mouse to the + cur, "Such + a trial, + dear Sir, + With + no jury + or judge, + would be + wasting + our + breath." + "I'll be + judge, I'll + be jury," + Said + cunning + old Fury: + "I'll + try the + whole + cause, + and + condemn + you + to + death."' +}group .fi .br @@ -2039,50 +2090,50 @@ some \ later \ time] .B use of code tags instead of poem compared, resulting output: .nf - `Fury said to a - mouse, That he - met in the - house, - "Let us - both go to - law: I will - prosecute - YOU. \-\-Come, - I'll take no - denial; We - must have a - trial: For - really this - morning I've - nothing - to do." - Said the - mouse to the - cur, "Such - a trial, - dear Sir, - With - no jury - or judge, - would be - wasting - our - breath." - "I'll be - judge, I'll - be jury," - Said - cunning - old Fury: - "I'll - try the - whole - cause, - and - condemn - you - to - death."' + `Fury said to a + mouse, That he + met in the + house, + "Let us + both go to + law: I will + prosecute + YOU. \-\-Come, + I'll take no + denial; We + must have a + trial: For + really this + morning I've + nothing + to do." + Said the + mouse to the + cur, "Such + a trial, + dear Sir, + With + no jury + or judge, + would be + wasting + our + breath." + "I'll be + judge, I'll + be jury," + Said + cunning + old Fury: + "I'll + try the + whole + cause, + and + condemn + you + to + death."' .fi .br @@ -2092,50 +2143,50 @@ From code{# as demonstrated here: .nf -1 | `Fury said to a -2 | mouse, That he -3 | met in the -4 | house, -5 | "Let us -6 | both go to -7 | law: I will -8 | prosecute -9 | YOU. \-\-Come, -10 | I'll take no -11 | denial; We -12 | must have a -13 | trial: For -14 | really this -15 | morning I've -16 | nothing -17 | to do." -18 | Said the -19 | mouse to the -20 | cur, "Such -21 | a trial, -22 | dear Sir, -23 | With -24 | no jury -25 | or judge, -26 | would be -27 | wasting -28 | our -29 | breath." -30 | "I'll be -31 | judge, I'll -32 | be jury," -33 | Said -34 | cunning -35 | old Fury: -36 | "I'll -37 | try the -38 | whole -39 | cause, -40 | and -41 | condemn -42 | you -43 | to -44 | death."' +1 | `Fury said to a +2 | mouse, That he +3 | met in the +4 | house, +5 | "Let us +6 | both go to +7 | law: I will +8 | prosecute +9 | YOU. \-\-Come, +10 | I'll take no +11 | denial; We +12 | must have a +13 | trial: For +14 | really this +15 | morning I've +16 | nothing +17 | to do." +18 | Said the +19 | mouse to the +20 | cur, "Such +21 | a trial, +22 | dear Sir, +23 | With +24 | no jury +25 | or judge, +26 | would be +27 | wasting +28 | our +29 | breath." +30 | "I'll be +31 | judge, I'll +32 | be jury," +33 | Said +34 | cunning +35 | old Fury: +36 | "I'll +37 | try the +38 | whole +39 | cause, +40 | and +41 | condemn +42 | you +43 | to +44 | death."' .fi .SH 9.8 ADDITIONAL BREAKS \- LINEBREAKS WITHIN OBJECTS, COLUMN AND PAGE\-BREAKS @@ -2148,10 +2199,10 @@ with a space before and a space or newline after them may be used. .nf - To break a line within a "paragraph object", - two backslashes \e\e with a space before - and a space or newline after them \e\e - may be used. +To break a line within a "paragraph object", +two backslashes \e\e with a space before +and a space or newline after them \e\e +may be used. .fi .br @@ -2167,14 +2218,14 @@ or a new page may be inserted manually using the following markup on a line on its own: .nf - <:pb> +<:pb> .fi .br or .nf - <:pn> +<:pn> .fi .br @@ -2195,8 +2246,8 @@ 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} + Paragraph containing main term and sub\-term. + ={Main term:sub\-term} .fi .br @@ -2207,8 +2258,8 @@ between paragraph and index markup. The structure of the resulting index would be: .nf - Main term, 1 - sub\-term, 1 + Main term, 1 + sub\-term, 1 .fi .br @@ -2216,17 +2267,17 @@ 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} + Paragraph containing main term, second term and sub\-term. + ={first term; second term: sub\-term} .fi .br The structure of the resulting index would be: .nf - First term, 1, - Second term, 1, - sub\-term, 1 + First term, 1, + Second term, 1, + sub\-term, 1 .fi .br @@ -2234,9 +2285,9 @@ 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 + 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 @@ -2244,9 +2295,9 @@ 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, + Main term, 1, + sub\-term, 1\-3, + second sub\-term, 1, .fi .SH 10. COMPOSITE DOCUMENTS MARKUP @@ -2275,8 +2326,8 @@ to processing with the same prefix and the suffix basic markup for importing a document into a master document .nf - << filename1.sst - << filename2.ssi +<< filename1.sst +<< filename2.ssi .fi .br @@ -2286,10 +2337,10 @@ which is convenient for editing. Alternative markup for importation of documents under consideration, and occasionally supported have been. .nf - << filename.ssi - <<{filename.ssi} - % using textlink alternatives - << |filename.ssi|@|^| +<< filename.ssi +<<{filename.ssi} +% using textlink alternatives +<< |filename.ssi|@|^| .fi .SH 11. MARKUP SYNTAX HISTORY @@ -2321,17 +2372,17 @@ markup addition of a monospace tag related headers now grouped, e.g. .nf - @title: - :subtitle: +@title: + :subtitle: - @creator: - :author: - :translator: - :illustrator: +@creator: + :author: + :translator: + :illustrator: - @rights: - :text: - :illustrations: +@rights: + :text: + :illustrations: .fi .br @@ -2341,7 +2392,7 @@ see document markup samples, and sisu \-\-help headers the monospace tag takes the form of a hash '#' .nf - #{ this enclosed text would be monospaced }# +#{ this enclosed text would be monospaced }# .fi .br @@ -2354,7 +2405,7 @@ the monospace tag takes the form of a hash '#' book index tags .nf - /^={.+?}$/ +/^={.+?}$/ .fi .br @@ -2362,15 +2413,15 @@ 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} +={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, +Free Software Foundation, 1\-6 +GNU/Linux community distribution, 1 + Debian, 1\-3 + Fedora, 1 + Gentoo, .fi .br @@ -2379,7 +2430,7 @@ logical structure produced assuming this is the first text "object" not\-used] .nf - /[:;]{.+?}[:;][a\-z+]/ +/[:;]{.+?}[:;][a\-z+]/ .fi .br @@ -2391,7 +2442,7 @@ headers @title and @creator in the first heading [expanded \ using \ the \ contents \ of \ the \ headers \ @title: \ and \ @author:] .nf - :A~ @title by @author +:A~ @title by @author .fi .br @@ -2432,7 +2483,7 @@ types, 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 }~ +~{* for example for describing an author }~ and ~{** for describing a second author }~ .fi .br @@ -2445,7 +2496,7 @@ Introduces some variations on endnotes, in particular the use of the asterisk and .nf - ~[* \ my \ note \ ]~ or ~[+ \ another \ note \ ]~ +~[* \ my \ note \ ]~ or ~[+ \ another \ note \ ]~ .fi .br @@ -2465,14 +2516,14 @@ which numerically increments an asterisk and plus respectively 0.38 introduced alternative experimental header and heading/structure markers, .nf - @headername: and headers :A~ :B~ :C~ 1~ 2~ 3~ +@headername: and headers :A~ :B~ :C~ 1~ 2~ 3~ .fi .br as the equivalent of: .nf - 0~headername and headers 1~ 2~ 3~ 4~ 5~ 6~ +0~headername and headers 1~ 2~ 3~ 4~ 5~ 6~ .fi .br @@ -2513,9 +2564,9 @@ those levels this is captured by the following file 'rename' instruction: .nf - rename 's/\e.s[123]$/\e.sst/' *.s{1,2,3} - rename 's/\e.r[123]$/\e.ssm/' *.r{1,2,3} - rename 's/\e.si$/\e.ssi/' *.si +rename 's/\e.s[123]$/\e.sst/' *.s{1,2,3} +rename 's/\e.r[123]$/\e.ssm/' *.r{1,2,3} +rename 's/\e.si$/\e.ssi/' *.si .fi .br @@ -2636,7 +2687,7 @@ contain other documents. .br Note: a secondary file of the composite document is built prior to processing -with the same prefix and the suffix \._sst [^17] +with the same prefix and the suffix \._sst [^18] .br @@ -2911,7 +2962,7 @@ Documents take on a document skin, if the header of the document specifies a skin to be used. .nf - @skin: skin_united_nations +@skin: skin_united_nations .fi .SH 15.2 DIRECTORY SKIN @@ -2990,7 +3041,7 @@ The default homepage may use homepage.css or html.css .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] +file that is looked for in a skin.[^19] .SH 17. ORGANISING CONTENT \- DIRECTORY STRUCTURE AND MAPPING .br @@ -3007,27 +3058,27 @@ The document source directory is the directory in which sisu processing commands are given. It contains the sisu source files (.sst \.ssm \.ssi), or (for sisu v3 may contain) subdirectories with language codes which contain the sisu source files, so all English files would go in subdirectory en/, French in -fr/, Spanish in es/ and so on. ISO \... codes are usedr. A list of available -languages (and possible sub\-directory names) can be obtained with the command -"sisu \-\-help lang" The list of languages is limited to langagues supported by -XeTeX polyglosia. +fr/, Spanish in es/ and so on. ISO 639\-1 codes are used (as varied by po4a). A +list of available languages (and possible sub\-directory names) can be obtained +with the command "sisu \-\-help lang" The list of languages is limited to +langagues supported by XeTeX polyglosia. .SH 17.1.1 GENERAL DIRECTORIES .nf - ./subject_name/ - % files stored at this level e.g. sisu_manual.sst or - % for sisu v3 may be under language sub\-directories - % e.g. - ./subject_name/en - ./subject_name/fr - ./subject_name/es - ./subject_name/_sisu - % configuration file e.g. sisurc.yml - ./subject_name/_sisu/skin - % skins in various skin directories doc, dir, site, yml - ./subject_name/_sisu/css - ./subject_name/_sisu/image +./subject_name/ +% files stored at this level e.g. sisu_manual.sst or +% for sisu v3 may be under language sub\-directories +% e.g. +./subject_name/en +./subject_name/fr +./subject_name/es +./subject_name/_sisu +% configuration file e.g. sisurc.yml +./subject_name/_sisu/skin +% skins in various skin directories doc, dir, site, yml +./subject_name/_sisu/css +./subject_name/_sisu/image .fi .SH 17.2 DOCUMENT OUTPUT DIRECTORY STRUCTURES @@ -3067,10 +3118,10 @@ There are 3 possibile output structures described as being, by language, by filetype or by filename, the selection is made in sisurc.yml .nf - #% output_dir_structure_by: language; filetype; or filename - output_dir_structure_by: language #(language & filetype, preferred?) - #output_dir_structure_by: filetype - #output_dir_structure_by: filename #(default, closest to original v1 & v2) +#% output_dir_structure_by: language; filetype; or filename +output_dir_structure_by: language #(language & filetype, preferred?) +#output_dir_structure_by: filetype +#output_dir_structure_by: filename #(default, closest to original v1 & v2) .fi .SH 17.2.3 BY LANGUAGE @@ -3203,33 +3254,33 @@ output_dir_structure_by: filename .SH 17.2.6 REMOTE DIRECTORIES .nf - ./subject_name/ - % containing sub_directories named after the generated files from which they are made - ./subject_name/src - % contains shared source files text and binary e.g. sisu_manual.sst and sisu_manual.sst.zip - ./subject_name/_sisu - % configuration file e.g. sisurc.yml - ./subject_name/_sisu/skin - % skins in various skin directories doc, dir, site, yml - ./subject_name/_sisu/css - ./subject_name/_sisu/image - % images for documents contained in this directory - ./subject_name/_sisu/mm +\./subject_name/ +% containing sub_directories named after the generated files from which they are made + \./subject_name/src +% contains shared source files text and binary e.g. sisu_manual.sst and sisu_manual.sst.zip + \./subject_name/_sisu +% configuration file e.g. sisurc.yml + \./subject_name/_sisu/skin +% skins in various skin directories doc, dir, site, yml + \./subject_name/_sisu/css + \./subject_name/_sisu/image +% images for documents contained in this directory + \./subject_name/_sisu/mm .fi .SH 17.2.7 SISUPOD .nf - ./sisupod/ - % files stored at this level e.g. sisu_manual.sst - ./sisupod/_sisu - % configuration file e.g. sisurc.yml - ./sisupod/_sisu/skin - % skins in various skin directories doc, dir, site, yml - ./sisupod/_sisu/css - ./sisupod/_sisu/image - % images for documents contained in this directory - ./sisupod/_sisu/mm +\./sisupod/ +% files stored at this level e.g. sisu_manual.sst + \./sisupod/_sisu +% configuration file e.g. sisurc.yml + \./sisupod/_sisu/skin +% skins in various skin directories doc, dir, site, yml + \./sisupod/_sisu/css + \./sisupod/_sisu/image +% images for documents contained in this directory + \./sisupod/_sisu/mm .fi .SH 17.3 ORGANISING CONTENT @@ -3289,18 +3340,18 @@ homepage modified in skin_commercial law.rb; or the directory poems in skin_poems.rb .nf - class Home - def homepage - # place the html content of your homepage here, this will become index.html - < - - -

this is my new homepage.

- - - HOME - end + class Home + def homepage + # place the html content of your homepage here, this will become index.html + < + + +

this is my new homepage.

+ + +HOME end + end .fi .SH 19. MARKUP AND OUTPUT EXAMPLES @@ -3349,8 +3400,8 @@ output formats. .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. +feeds sisu markupd documents into sql type databases PostgreSQL[^20] and/or +SQLite[^21] database together with information related to document structure. .br This is one of the more interesting output forms, as all the structural data of @@ -3576,10 +3627,10 @@ removes specified document from sqlite database. INCLUDING OBJECT CITATION NUMBERING (BACKEND CURRENTLY POSTGRESQL) .br -Sample search frontend [^21] A small database and +Sample search frontend [^22] 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] +to demonstrates functionality.[^23] .br .B SiSU @@ -3594,7 +3645,7 @@ outputs or in the SQL database expand the text within the matched objects 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] +meet the search criteria.[^24] .TP .B sisu \-F \-\-webserv\-webrick @@ -3608,14 +3659,14 @@ command: sisu \-\-help sql .nf - Postgresql - user: ralph - current db set: SiSU_sisu - port: 5432 - dbi connect: DBI:Pg:database=SiSU_sisu;port=5432 - sqlite - current db set: /home/ralph/sisu_www/sisu/sisu_sqlite.db - dbi connect DBI:SQLite:/home/ralph/sisu_www/sisu/sisu_sqlite.db +Postgresql + user: ralph + current db set: SiSU_sisu + port: 5432 + dbi connect: DBI:Pg:database=SiSU_sisu;port=5432 +sqlite + current db set: /home/ralph/sisu_www/sisu/sisu_sqlite.db + dbi connect DBI:SQLite:/home/ralph/sisu_www/sisu/sisu_sqlite.db .fi .br @@ -3756,7 +3807,7 @@ 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] +sisu \-3 http://[provide \ url \ to \ valid \ \.sst \ or \ \.ssm \ file] .fi .br @@ -3784,7 +3835,7 @@ 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] +sisu \-3 http://[provide \ url \ to \ valid \ sisupod.zip \ or \ \.ssp \ file] .fi .br @@ -3811,7 +3862,7 @@ 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 +sisu \-3R sisu_remote.sst .fi .SH 27.1 COMMANDS @@ -3870,8 +3921,8 @@ Sid and testing archives (and possibly Ubuntu), assuming your /etc/apt/sources.list is set accordingly: .nf - aptitude update - aptitude install sisu\-complete + aptitude update + aptitude install sisu\-complete .fi .br @@ -3906,17 +3957,17 @@ 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 +#/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 repeat the aptitude commands .nf - aptitude update - aptitude install sisu\-complete sisu\-markup\-samples + aptitude update + aptitude install sisu\-complete sisu\-markup\-samples .fi .br @@ -3973,7 +4024,7 @@ and 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 +take care of, for things like using a database (postgresql or sqlite)[^25] or converting LaTeX to pdf. .br @@ -3986,10 +4037,10 @@ the root directory of the unpacked as root type: .nf - ruby setup.rb config - ruby setup.rb setup - #[and \ as \ root:] - ruby setup.rb install + ruby setup.rb config + ruby setup.rb setup + #[and \ as \ root:] + ruby setup.rb install .fi .br @@ -4150,13 +4201,13 @@ The man pages are also available online, though not always kept as up to date as within the package itself: .br -* sisu.1 [^25] +* sisu.1 [^26] .br -* sisu.8 [^26] +* sisu.8 [^27] .br -* man directory [^27] +* man directory [^28] .SH 29.3.2 BUILT IN HELP @@ -4200,7 +4251,7 @@ Additional markup samples are packaged separately in the file: .br On .B Debian -they are available in non\-free[^28] to include them it is necessary to include +they are available in non\-free[^29] 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 30. EDITOR FILES, SYNTAX HIGHLIGHTING @@ -4636,7 +4687,7 @@ Note documentation is prepared in .B SiSU and output is available in multiple formats including amongst others html, pdf, -odf and epub, which may be also be accessed via the html pages[^29] +odf and epub, which may be also be accessed via the html pages[^30] .SH 33.2.1 WWW.SISUDOC.ORG @@ -4812,7 +4863,7 @@ editors notes, numbered asterisk footnote/endnote series .br .TP -.BI 16. +.BI 17. Table from the Wealth of Networks by Yochai Benkler .br @@ -4820,7 +4871,7 @@ Table from the Wealth of Networks by Yochai Benkler .br .TP -.BI 17. +.BI 18. \.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 @@ -4829,7 +4880,7 @@ appropriate suffix to use. .br .TP -.BI 19. +.BI 20. .br @@ -4838,26 +4889,26 @@ appropriate suffix to use. .br .TP -.BI 20. +.BI 21. .br .br .TP -.BI 21. +.BI 22. .br .TP -.BI 22. +.BI 23. (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 .TP -.BI 23. +.BI 24. 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 @@ -4867,26 +4918,26 @@ matches are found. .br .TP -.BI 24. +.BI 25. There is nothing to stop MySQL support being added in future. .br .TP -.BI 25. +.BI 26. .br .TP -.BI 26. +.BI 27. .br .TP -.BI 27. +.BI 28. .br -28. the +29. the .B Debian Free Software guidelines require that everything distributed within .B Debian @@ -4894,7 +4945,7 @@ can be changed \- and the documents are authors' works that while freely distributable are not freely changeable. .br -29. named index.html or more extensively through sisu_manifest.html +30. named index.html or more extensively through sisu_manifest.html .br .SH SEE ALSO -- cgit v1.2.3