summaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2012-11-19 02:50:04 +0000
committerRalph Amissah <ralph@amissah.com>2012-12-12 14:44:37 +0000
commiteae9bb93fdd2e677c8882bcc96d42b804ac2bafe (patch)
tree5b5b33598ba30847c07888f6eb8cc644a8133876 /man
parentv4: vim syntax, sisu.vim, make, new headers (diff)
downloadsisu-eae9bb93fdd2e677c8882bcc96d42b804ac2bafe.zip
sisu-eae9bb93fdd2e677c8882bcc96d42b804ac2bafe.tar.xz
v4: documentation; markup samples & help
Diffstat (limited to 'man')
-rw-r--r--man/man1/sisu.12807
1 files changed, 868 insertions, 1939 deletions
diff --git a/man/man1/sisu.1 b/man/man1/sisu.1
index 4f82611..ccf359c 100644
--- a/man/man1/sisu.1
+++ b/man/man1/sisu.1
@@ -1,4 +1,4 @@
-.TH "sisu" "1" "2012-11-05" "4.0.0" "SiSU"
+.TH "sisu" "1" "2012-10-03" "4.0.0" "SiSU"
.br
.SH NAME
.br
@@ -6,25 +6,28 @@ sisu \- documents: markup, structuring, publishing in multiple standard formats,
.br
.SH SYNOPSIS
.br
+sisu [\-short\-options|\-\-long\-options] [filename/wildcard]
+
+.br
sisu [\-abCcDdeFGghIikLMmNnoPpQqRrSsTtUuVvWwXxYyZ_0\-9] [filename/wildcard]
.br
-sisu [\-Ddcv] [instruction] [filename/wildcard]
+sisu \-\-txt \-\-html \-\-epub \-\-odt \-\-pdf \-\-wordmap \-\-sqlite \-\-manpage \-\-texinfo \-\-sisupod \-\-source \-\-qrcode [filename/wildcard]
.br
-sisu [\-CcFLSVvW]
+sisu [\-Ddcv] [instruction] [filename/wildcard]
.br
-sisu [operations]
+sisu \-\-pg (\-\-createdb|update [filename/wildcard]|\-\-dropall)
.br
-sisu \-\-v3 [operations]
+sisu [operations]
.br
-sisu \-\-v2 [operations]
+sisu [\-CcFLSVvW]
.br
-sisu2 [operations]
+sisu (\-\-configure|\-\-webrick|\-\-sample\-search\-form)
.SH SISU \- MANUAL,
RALPH AMISSAH
.br
@@ -32,7 +35,7 @@ RALPH AMISSAH
.SH WHAT IS SISU?
.br
-.SH 1. INTRODUCTION \- WHAT IS SISU?
+.SH INTRODUCTION \- WHAT IS SISU?
.br
.br
@@ -47,11 +50,12 @@ text within a document.
.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
-evolving document formats/ representation technologies. Documents are prepared
-once, and generated as need be to update the technical presentation or add
-additional output formats. Various output formats (including search related
+is developed under an open source, software libre license (
+.I GPLv3
+). Its use case for development is work with medium to large document sets and
+cope with evolving document formats/ representation technologies. Documents are
+prepared once, and generated as need be to update the technical presentation or
+add additional output formats. Various output formats (including search related
output) share a common mechanism for cross\-output\-format citation.
.br
@@ -66,12 +70,20 @@ The sisu engine works with an abstraction of the document's structure and
content from which it is possible to generate different forms of representation
of the document. Significantly
.B SiSU
-markup is more sparse than html and outputs which include html, EPUB, LaTeX,
-landscape and portrait pdfs, Open Document Format (ODF), all of which can be
-added to and updated.
+markup is more sparse than html and outputs which include
+.I HTML,
+.I EPUB,
+.I ODT
+(Open Document Format text),
+.I LaTeX,
+landscape and portrait
+.I PDF,
+all of which can be added to and updated.
.B SiSU
-is also able to populate SQL type databases at an object level, which means
-that searches can be made with that degree of granularity.
+is also able to populate
+.I SQL
+type databases at an object level, which means that searches can be made with
+that degree of granularity.
.br
Source document preparation and output generation is a two step process: (i)
@@ -84,15 +96,24 @@ markup applied to a document,
.B SiSU
custom builds (to take advantage of the strengths of different ways of
representing documents) various standard open output formats including plain
-text, HTML, XHTML, XML, EPUB, OpenDocument, LaTeX or PDF files, and populate an
-SQL database with objects[^1] (equating generally to paragraph\-sized chunks)
-so searches may be performed and matches returned with that degree of
-granularity ( e.g. your search criteria is met by these documents and at these
-locations within each document). Document output formats share a common object
-numbering system for locating content. This is particularly suitable for
-"published" works (finalized texts as opposed to works that are frequently
-changed or updated) for which it provides a fixed means of reference of
-content.
+text,
+.I HTML,
+.I XHTML,
+.I XML,
+.I EPUB,
+.I ODT,
+.I LaTeX
+or
+.I PDF
+files, and populate an
+.I SQL
+database with objects[^1] (equating generally to paragraph\-sized chunks) so
+searches may be performed and matches returned with that degree of granularity
+( e.g. your search criteria is met by these documents and at these locations
+within each document). Document output formats share a common object numbering
+system for locating content. This is particularly suitable for "published"
+works (finalized texts as opposed to works that are frequently changed or
+updated) for which it provides a fixed means of reference of content.
.br
In preparing a
@@ -131,7 +152,16 @@ proprietary software/equipment) in 15 years time, or the way the way in which
html has evolved over its relatively short span of existence.
.B SiSU
provides the flexibility of producing documents in multiple non\-proprietary
-open formats including html, pdf[^5] ODF,[^6] and EPUB.[^7] Whilst
+open formats including
+.I HTML,
+.I EPUB,
+[^5]
+.I ODT,
+[^6]
+.I PDF
+[^7]
+.I ODF,
+[^8]. Whilst
.B SiSU
relies on software, the markup is uncomplicated and minimalistic which
guarantees that future engines can be written to run against it. It is also
@@ -140,19 +170,29 @@ easily converted to other formats, which means documents prepared in
can be migrated to other document formats. Further security is provided by the
fact that the software itself,
.B SiSU
-is available under GPL3 a licence that guarantees that the source code will
-always be open, and free as in libre, which means that that code base can be
-used, updated and further developed as required under the terms of its license.
-Another challenge is to keep up with a moving target.
+is available under
+.I GPLv3
+a licence that guarantees that the source code will always be open, and free as
+in libre, which means that that code base can be used, updated and further
+developed as required under the terms of its license. Another challenge is to
+keep up with a moving target.
.B SiSU
permits new forms of output to be added as they become important, (Open
Document Format text was added in 2006 when it became an ISO standard for
-office applications and the archival of documents), EPUB was introduced in
-2009; and allows the technical representations existing output to be updated
-(html has evolved and the related module has been updated repeatedly over the
-years, presumably when the World Wide Web Consortium (w3c) finalises html 5
-which is currently under development, the html module will again be updated
-allowing all existing documents to be regenerated as html 5).
+office applications and the archival of documents),
+.I EPUB
+was introduced in 2009; and allows the technical representations existing
+output to be updated (
+.I HTML
+has evolved and the related module has been updated repeatedly over the years,
+presumably when the World Wide Web Consortium (w3c) finalises
+.I HTML
+5 which is currently under development, the
+.I HTML
+module will again be updated allowing all existing documents to be regenerated
+as
+.I HTML
+5).
.br
The document formats are written to the file\-system and available for indexing
@@ -185,29 +225,50 @@ content prepared in
.br
<http://www.jus.uio.no/sisu>
-.SH 2. COMMANDS SUMMARY
+.SH COMMANDS SUMMARY
.br
-.SH 2.1 DESCRIPTION
+.SH DESCRIPTION
.br
.B SiSU
is a document publishing system, that from a simple single marked\-up document,
-produces multiple output formats including: plaintext, html, xhtml, XML, epub,
-odt (odf text), LaTeX, pdf, info, and SQL (PostgreSQL and SQLite), which share
-text object numbers ("object citation numbering") and the same document
-structure information. For more see: <http://www.jus.uio.no/sisu>
+produces multiple output formats including:
+.I plaintext,
+.I HTML,
+.I XHTML,
+.I XML,
+.I EPUB,
+.I ODT
+(
+.I OpenDocument
+(
+.I ODF
+) text),
+.I LaTeX,
+.I PDF,
+info, and
+.I SQL
+(
+.I PostgreSQL
+and
+.I SQLite
+) , which share text object numbers ("object citation numbering") and the same
+document structure information. For more see: <http://sisudoc.org> or
+<http://www.jus.uio.no/sisu>
-.SH 2.2 DOCUMENT PROCESSING COMMAND FLAGS
+.SH DOCUMENT PROCESSING COMMAND FLAGS
.TP
.B \-a [filename/wildcard]
-produces plaintext with Unix linefeeds and without markup, (object numbers are
-omitted), has footnotes at end of each paragraph that contains them [ \ \-A \
-for \ equivalent \ dos \ (linefeed) \ output \ file] [see \ \-e \ for \
-endnotes]. (Options include: \-\-endnotes for endnotes \-\-footnotes for
-footnotes at the end of each paragraph \-\-unix for unix linefeed (default)
-\-\-msdos for msdos linefeed)
+produces
+.I plaintext
+with Unix linefeeds and without markup, (object numbers are omitted), has
+footnotes at end of each paragraph that contains them [ \ \-A \ for \
+equivalent \ dos \ (linefeed) \ output \ file] [see \ \-e \ for \ endnotes].
+(Options include: \-\-endnotes for endnotes \-\-footnotes for footnotes at the
+end of each paragraph \-\-unix for unix linefeed (default) \-\-msdos for msdos
+linefeed)
.TP
.B \-b [filename/wildcard]
@@ -290,23 +351,28 @@ produces an epub document, [sisu \ version \ >=2 \ ] (filename.epub). Alias \-e
.TP
.B \-\-exc\-*
-exclude output feature, overrides configuration settings \-\-exc\-ocn, (exclude
-object citation numbering, (switches off object citation numbering), affects
-html (seg, scroll), epub, xhtml, xml, pdf); \-\-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\-*
+exclude output feature, overrides configuration settings \-\-exc\-
+.I ocn,
+(exclude
+.I object citation numbering,
+(switches off
+.I object citation numbering
+) , affects html (seg, scroll), epub, xhtml, xml, pdf) ; \-\-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]
@@ -460,17 +526,20 @@ see \-\-pdf
.TP
.B \-\-pdf [filename/wildcard]
-produces LaTeX pdf (portrait.pdf & landscape.pdf). Default paper size is set in
-config file, or document header, or provided with additional command line
-parameter, e.g. \-\-papersize\-a4 preset sizes include: 'A4', U.S. 'letter' and
-'legal' and book sizes 'A5' and 'B5' (system defaults to A4). Alias \-p
+produces
+.I LaTeX
+pdf (portrait.pdf & landscape.pdf). Default paper size is set in config file,
+or document header, or provided with additional command line parameter, e.g.
+\-\-papersize\-a4 preset sizes include: 'A4', U.S. 'letter' and 'legal' and
+book sizes 'A5' and 'B5' (system defaults to A4). Alias \-p
.TP
.B \-\-pg [instruction] [filename]
-database postgresql ( \-\-pgsql may be used instead) possible instructions,
-include: \-\-createdb; \-\-create; \-\-dropall; \-\-import [filename];
-\-\-update [filename]; \-\-remove [filename]; see database section below. Alias
-\-D
+database
+.I PostgreSQL
+( \-\-pgsql may be used instead) possible instructions, include: \-\-createdb;
+\-\-create; \-\-dropall; \-\-import [filename]; \-\-update [filename];
+\-\-remove [filename]; see database section below. Alias \-D
.TP
.B \-\-po [language_directory/filename \ language_directory]
@@ -538,11 +607,15 @@ see \-\-source
.TP
.B \-\-sample\-search\-form [\-\-webserv=webrick]
-generate examples of (naive) cgi search form for sqlite and pgsql depends on
-your already having used sisu to populate an sqlite and/or pgsql database, (the
-sqlite version scans the output directories for existing sisu_sqlite databases,
-so it is first necessary to create them, before generating the search form) see
-\-d \-D and the database section below. If the optional parameter
+generate examples of (naive) cgi search form for
+.I SQLite
+and PgSQL depends on your already having used sisu to populate an
+.I SQLite
+and/or PgSQL database, (the
+.I SQLite
+version scans the output directories for existing sisu_sqlite databases, so it
+is first necessary to create them, before generating the search form) see \-d
+\-D and the database section below. If the optional parameter
\-\-webserv=webrick is passed, the cgi examples created will be set up to use
the default port set for use by the webrick server, (otherwise the port is left
blank and the system setting used, usually 80). The samples are dumped in the
@@ -557,14 +630,19 @@ that you have your "keys" and ssh agent in place. Also see \-\-rsync. Alias \-r
.TP
.B \-\-sqlite \-\-[instruction] [filename]
-database type set to sqlite, this produces one of two possible databases,
-without additional database related instructions it produces a discreet sqlite
+database type set to
+.I SQLite,
+this produces one of two possible databases, without additional database
+related instructions it produces a discreet
+.I 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
+common
+.I 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
@@ -612,12 +690,14 @@ produces texinfo and info file, (view with pinfo). Alias \-I
.TP
.B \-\-txt [filename/wildcard]
-produces plaintext with Unix linefeeds and without markup, (object numbers are
-omitted), has footnotes at end of each paragraph that contains them [ \ \-A \
-for \ equivalent \ dos \ (linefeed) \ output \ file] [see \ \-e \ for \
-endnotes]. (Options include: \-\-endnotes for endnotes \-\-footnotes for
-footnotes at the end of each paragraph \-\-unix for unix linefeed (default)
-\-\-msdos for msdos linefeed). Alias \-t
+produces
+.I plaintext
+with Unix linefeeds and without markup, (object numbers are omitted), has
+footnotes at end of each paragraph that contains them [ \ \-A \ for \
+equivalent \ dos \ (linefeed) \ output \ file] [see \ \-e \ for \ endnotes].
+(Options include: \-\-endnotes for endnotes \-\-footnotes for footnotes at the
+end of each paragraph \-\-unix for unix linefeed (default) \-\-msdos for msdos
+linefeed). Alias \-t
.TP
.B \-U [filename/wildcard]
@@ -659,14 +739,13 @@ version information
see \-\-verbose
.TP
-.B \-\-v2 [filename/wildcard]
-invokes the sisu v2 document parser/generator. This is the default and is
-normally omitted.
+.B \-\-v3 [filename/wildcard]
+invokes the sisu v3 document parser/generator. You may run sisu3 instead.
.TP
-.B \-\-v3 [filename/wildcard]
-invokes the sisu v3 document parser/generator. Currently under development and
-incomplete, v3 requires >= ruby1.9.2p180. You may run sisu3 instead.
+.B \-\-v4 [filename/wildcard]
+invokes the sisu v4 document parser/generator. This is the default and is
+normally omitted.
.TP
.B \-\-verbose [filename/wildcard]
@@ -684,7 +763,7 @@ see \-\-concordance
.TP
.B \-\-webrick
-starts ruby's webrick webserver points at sisu output directories, the default
+starts ruby' s webrick webserver points at sisu output directories, the default
port is set to 8081 and can be changed in the resource configuration files.
[tip: \ the \ webrick \ server \ requires \ link \ suffixes, \ so \ html \
output \ should \ be \ created \ using \ the \ \-h \ option \ rather \ than \
@@ -696,16 +775,21 @@ see \-\-concordance
.TP
.B \-\-xhtml [filename/wildcard]
-produces xhtml/XML output for browser viewing (sax parsing). Alias \-b
+produces xhtml/
+.I XML
+output for browser viewing (sax parsing). Alias \-b
.TP
.B \-\-xml\-dom [filename/wildcard]
-produces XML output with deep document structure, in the nature of dom. Alias
-\-X
+produces
+.I XML
+output with deep document structure, in the nature of dom. Alias \-X
.TP
.B \-\-xml\-sax [filename/wildcard]
-produces XML output shallow structure (sax parsing). Alias \-x
+produces
+.I XML
+output shallow structure (sax parsing). Alias \-x
.TP
.B \-X [filename/wildcard]
@@ -738,14 +822,17 @@ 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
-.SH 3. COMMAND LINE MODIFIERS
+.SH COMMAND LINE MODIFIERS
.br
.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.
+.B \-\-no\-
+.I ocn
+[with \ \-\-html \ \-\-pdf \ or \ \-\-epub] switches off
+.I object citation numbering.
+Produce output without identifying numbers in margins of html or
+.I LaTeX
+/pdf output.
.TP
.B \-\-no\-annotate
@@ -760,51 +847,66 @@ 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
+.SH DATABASE COMMANDS
.br
.br
-dbi \- database interface
+.B dbi \- database interface
.br
-\-D or \-\-pgsql set for postgresql \-d or \-\-sqlite default set for sqlite
-\-d is modifiable with \-\-db=[database \ type \ (pgsql \ or \ sqlite)]
+.B \-D or \-\-pgsql
+set for
+.I PostgreSQL
+.B \-d or \-\-sqlite
+default set for
+.I SQLite
+\-d is modifiable with \-\-db=[database \ type \ (PgSQL \ or \ .I \ SQLite \ )
+\ ]
.TP
.B \-\-pg \-v \-\-createall
initial step, creates required relations (tables, indexes) in existing
-postgresql database (a database should be created manually and given the same
-name as working directory, as requested) (rb.dbi) [ \ \-dv \ \-\-createall \
-sqlite \ equivalent] it may be necessary to run sisu \-Dv \-\-createdb
-initially NOTE: at the present time for postgresql it may be necessary to
-manually create the database. The command would be 'createdb [database \ name]'
-where database name would be SiSU_[present \ working \ directory \ name \
-(without \ path)]. Please use only alphanumerics and underscores.
+.I PostgreSQL
+database (a database should be created manually and given the same name as
+working directory, as requested) (rb.dbi) [ \ \-dv \ \-\-createall \ .I \
+SQLite \ equivalent] it may be necessary to run sisu \-Dv \-\-createdb
+initially NOTE: at the present time for
+.I PostgreSQL
+it may be necessary to manually create the database. The command would be
+'createdb [database \ name]' where database name would be SiSU_[present \
+working \ directory \ name \ (without \ path)]. Please use only alphanumerics
+and underscores.
.TP
.B \-\-pg \-v \-\-import
-[filename/wildcard] imports data specified to postgresql db (rb.dbi) [ \ \-dv \
-\-\-import \ sqlite \ equivalent]
+[filename/wildcard] imports data specified to
+.I PostgreSQL
+db (rb.dbi) [ \ \-dv \ \-\-import \ .I \ SQLite \ equivalent]
.TP
.B \-\-pg \-v \-\-update
-[filename/wildcard] updates/imports specified data to postgresql db (rb.dbi) [
-\ \-dv \ \-\-update \ sqlite \ equivalent]
+[filename/wildcard] updates/imports specified data to
+.I PostgreSQL
+db (rb.dbi) [ \ \-dv \ \-\-update \ .I \ SQLite \ equivalent]
.TP
.B \-\-pg \-\-remove
-[filename/wildcard] removes specified data to postgresql db (rb.dbi) [ \ \-d \
-\-\-remove \ sqlite \ equivalent]
+[filename/wildcard] removes specified data to
+.I PostgreSQL
+db (rb.dbi) [ \ \-d \ \-\-remove \ .I \ SQLite \ equivalent]
.TP
.B \-\-pg \-\-dropall
-kills data" and drops (postgresql or sqlite) db, tables & indexes [ \ \-d \
-\-\-dropall \ sqlite \ equivalent]
+kills data" and drops (
+.I PostgreSQL
+or
+.I SQLite
+) db, tables & indexes [ \ \-d \ \-\-dropall \ .I \ SQLite \ equivalent]
.br
The \-v is for verbose output.
-.SH 5. SHORTCUTS, SHORTHAND FOR MULTIPLE FLAGS
+.SH SHORTCUTS, SHORTHAND FOR MULTIPLE FLAGS
.br
.TP
@@ -852,7 +954,7 @@ add \-v for verbose mode and \-c to toggle color state, e.g. sisu \-2vc
.br
consider \-u for appended url info or \-v for verbose output
-.SH 5.1 COMMAND LINE WITH FLAGS \- BATCH PROCESSING
+.SH COMMAND LINE WITH FLAGS \- BATCH PROCESSING
.br
In the data directory run sisu \-mh filename or wildcard eg. "sisu \-h
@@ -863,10 +965,10 @@ 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
+.SH HELP
.br
-.SH 6.1 SISU MANUAL
+.SH SISU MANUAL
.br
The most up to date information on sisu should be contained in the sisu_manual,
@@ -892,7 +994,7 @@ move to the respective directory and type e.g.:
.br
sisu sisu_manual.ssm
-.SH 6.2 SISU MAN PAGES
+.SH SISU MAN PAGES
.br
If
@@ -932,12 +1034,12 @@ Available man pages are converted back to html using man2html:
An online version of the sisu man page is available here:
.br
-* various sisu man pages <http://www.jus.uio.no/sisu/man/> [^8]
+* various sisu man pages <http://www.jus.uio.no/sisu/man/> [^9]
.br
-* sisu.1 <http://www.jus.uio.no/sisu/man/sisu.1.html> [^9]
+* sisu.1 <http://www.jus.uio.no/sisu/man/sisu.1.html> [^10]
-.SH 6.3 SISU BUILT\-IN INTERACTIVE HELP
+.SH SISU BUILT\-IN INTERACTIVE HELP
.br
This is particularly useful for getting the current sisu setup/environment
@@ -957,7 +1059,7 @@ information:
.br
sisu \-\-help env [for \ feedback \ on \ the \ way \ your \ system \ is \
- setup \ with \ regard \ to \ sisu]
+ setup \ with \ regard \ to \ sisu \ ]
.br
sisu \-V [environment \ information, \ same \ as \ above \ command]
@@ -976,14 +1078,18 @@ 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 7. INTRODUCTION TO SISU MARKUP[^10]
+.SH INTRODUCTION TO SISU MARKUP[^11]
.br
-.SH 7.1 SUMMARY
+.SH SUMMARY
.br
.B SiSU
-source documents are plaintext (UTF\-8)[^11] files
+source documents are
+.I plaintext
+(
+.I UTF\-8
+)[^12] files
.br
All paragraphs are separated by an empty line.
@@ -1042,9 +1148,9 @@ or if for a particular version:
.br
sisu \-\-query\-0.38
-.SH 7.2 MARKUP EXAMPLES
+.SH MARKUP EXAMPLES
-.SH 7.2.1 ONLINE
+.SH ONLINE
.br
Online markup examples are available together with the respective outputs
@@ -1060,16 +1166,16 @@ markup and the respective output produced:
an alternative presentation of markup syntax:
/usr/share/doc/sisu/on_markup.txt.gz
-.SH 7.2.2 INSTALLED
+.SH INSTALLED
.br
With
.B SiSU
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:
+equivalent directory) and if sisu \-markup\-samples is installed also under:
/usr/share/doc/sisu/markup\-samples\-non\-free
-.SH 8. MARKUP OF HEADERS
+.SH MARKUP OF HEADERS
.br
.br
@@ -1086,7 +1192,7 @@ a space and the comment:
% this would be a comment
.fi
-.SH 8.1 SAMPLE HEADER
+.SH SAMPLE HEADER
.br
This current document is loaded by a master document that has a header similar
@@ -1095,57 +1201,60 @@ to this one:
.nf
% SiSU master 2.0
@title: SiSU
- :subtitle: Manual
+:subtitle: Manual
@creator:
- :author: Amissah, Ralph
-@publisher: \ [publisher \ name]
-@rights: Copyright (C) Ralph Amissah 2007, License GPL 3
+:author: Amissah, Ralph
+@publisher: [publisher \ name]
+@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
@classify:
- :type: information
- :topic_register: SiSU:manual;electronic documents:SiSU:manual
- :subject: ebook, epublishing, electronic book, electronic publishing,
+: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
+: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]
+:num_top: 1
+:breaks: new=C; break=1
+:bold: /Gnu|Debian|Ruby|SiSU/
+:home_button_text: {SiSU}http://sisudoc.org; {git}http://git.sisudoc.org
+:footer: {SiSU}http://sisudoc.org; {git}http://git.sisudoc.org
+: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 \-\-v4 [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 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 AVAILABLE HEADERS
.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
+on the document (such as the
+.I 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
+.I Dublin Core
+meta tags are available
.br
.B @indentifier:
@@ -1164,56 +1273,60 @@ 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]
+@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]
+: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]
+: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]
+: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]
+:topic_register: SiSU:markup sample:book;book:novel:fantasy
+:type:
+:subject:
+:description:
+:keywords:
+:abstract:
+:loc: [Library \ of \ Congress \ classification]
+:dewey: Dewey classification
+.fi
+
+.nf
+@identify:
+:isbn: [ISBN]
+:oclc:
.fi
.nf
@@ -1223,33 +1336,28 @@ This is a sample header
.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]
+: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]
+:home_button_text: {SiSU}http://sisudoc.org; {git}http://git.sisudoc.org
+:footer: {SiSU}http://sisudoc.org; {git}http://git.sisudoc.org
.fi
.nf
@original:
- :language: \ [language]
+:language: [language]
.fi
.nf
@notes:
- :comment:
- :prefix: \ [prefix \ is \ placed \ just \ after \ table \ of \ contents]
+:comment:
+:prefix: [prefix \ is \ placed \ just \ after \ table \ of \ contents]
.fi
-.SH 9. MARKUP OF SUBSTANTIVE TEXT
+.SH MARKUP OF SUBSTANTIVE TEXT
.br
-.SH 9.1 HEADING LEVELS
+.SH HEADING LEVELS
.br
Heading levels are :A~ ,:B~ ,:C~ ,1~ ,2~ ,3~ \... :A \- :C being part / section
@@ -1282,7 +1390,7 @@ otherwise takes the form 1~my_filename_for_this_segment
.br
.B 2~ [heading \ text]
-Second level heading preceding substantive text of document or sub\-heading 3,
+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.
@@ -1293,12 +1401,10 @@ 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)
+% 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
+.SH FONT ATTRIBUTES
.br
.B markup example:
@@ -1307,25 +1413,15 @@ be marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a document
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]
-.br
+*{emphasis}* [note: \ can \ be \ configured \ to \ be \ represented \ by \ bold, \ italics \ or \ underscore]
!{bold text}!
-.br
-_{underscore}_
-.br
/{italics}/
-.br
+_{underscore}_
"{citation}"
-.br
^{superscript}^
-.br
,{subscript},
-.br
+{inserted text}+
-.br
\-{strikethrough}\-
-.br
#{monospace}#
.fi
@@ -1335,7 +1431,8 @@ _{underscore}_
.br
normal text,
.B emphasis,
-.B bold text,
+.B bold text
+,
.I italics,
.I underscore,
"citation", ^superscript^, [subscript], ++inserted text++,
@@ -1376,18 +1473,15 @@ or \ underscore]
.br
monospace
-.SH 9.3 INDENTATION AND BULLETS
+.SH INDENTATION AND BULLETS
.br
.B markup example:
.nf
ordinary paragraph
-.br
_1 indent paragraph one step
-.br
_2 indent paragraph two steps
-.br
_9 indent paragraph nine steps
.fi
@@ -1411,9 +1505,7 @@ ordinary paragraph
.nf
_* bullet text
-.br
_1* bullet text, first indent
-.br
_2* bullet text, two step indent
.fi
@@ -1437,11 +1529,10 @@ Numbered List (not to be confused with headings/titles, (document structure))
.nf
# numbered list numbered list 1., 2., 3, etc.
-.br
_# numbered list numbered list indented a., b., c., d., etc.
.fi
-.SH 9.4 HANGING INDENTS
+.SH HANGING INDENTS
.br
.B markup example:
@@ -1466,7 +1557,7 @@ first line indented, rest of paragraph no indent
.br
in each case level may be 0\-9
-.SH 9.5 FOOTNOTES / ENDNOTES
+.SH FOOTNOTES / ENDNOTES
.br
Footnotes and endnotes are marked up at the location where they would be
@@ -1484,7 +1575,7 @@ determines whether footnotes or endnotes will be produced
.B resulting output:
.br
-[^12]
+[^13]
.br
.B markup example:
@@ -1497,14 +1588,13 @@ normal text~{ self contained endnote marker & endnote in one }~ continues
.B resulting output:
.br
-normal text[^13] continues
+normal text[^14] continues
.br
.B markup example:
.nf
normal text ~{* unnumbered asterisk footnote/endnote, insert multiple asterisks if required }~ continues
-.br
normal text ~{** another unnumbered asterisk footnote/endnote }~ continues
.fi
@@ -1522,7 +1612,6 @@ normal text [^**] continues
.nf
normal text ~[* \ editors \ notes, \ numbered \ asterisk \ footnote/endnote \ series \ ]~ continues
-.br
normal text ~[+ \ editors \ notes, \ numbered \ asterisk \ footnote/endnote \ series \ ]~ continues
.fi
@@ -1541,16 +1630,15 @@ normal text [^+2] continues
.nf
% note the endnote marker "~^"
normal text~^ continues
-.br
^~ endnote text following the paragraph in which the marker occurs
.fi
.br
the standard and pair notation cannot be mixed in the same document
-.SH 9.6 LINKS
+.SH LINKS
-.SH 9.6.1 NAKED URLS WITHIN TEXT, DEALING WITH URLS
+.SH NAKED URLS WITHIN TEXT, DEALING WITH URLS
.br
urls found within text are marked up automatically. A url within text is
@@ -1601,11 +1689,10 @@ blocks are discussed later in this document
.nf
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
.fi
-.SH 9.6.2 LINKING TEXT
+.SH LINKING TEXT
.br
To link text or an image to a url the markup is as follows
@@ -1638,27 +1725,45 @@ about {~^ SiSU }http://url.org markup
.B resulting output:
.br
-about SiSU <http://www.sisudoc.org/> [^14] markup
+aboutSiSU <http://www.sisudoc.org/> [^15] markup
.br
-Internal document links to a tagged location, including an ocn
+Internal document links to a tagged location, including an
+.I ocn
.br
.B markup example:
.nf
- { tux.png 64x80 }image
-.br
- % various url linked images
+about { text links }#link_text
+.fi
+
.br
- {tux.png 64x80 "a better way" }http://www.sisudoc.org/
+.B resulting output:
+
.br
+about ⌠text links⌡⌈link_text⌋
+
.br
- {GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better \- with Gnu/Linux, Debian and Ruby" }http://www.sisudoc.org/
+Shared document collection link
+
.br
+.B markup example:
+
+.nf
+about { SiSU book markup examples }:SiSU/examples.html
+.fi
+
.br
- {~^ ruby_logo.png "Ruby" }http://www.ruby\-lang.org/en/
+.B resulting output:
+
.br
+about ⌠
+.B SiSU
+book markup examples⌡⌈:SiSU/examples.html⌋
+
+.SH LINKING IMAGES
+
.br
.B markup example:
@@ -1684,16 +1789,15 @@ GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better \- with Gnu/Linux, Debian
and Ruby" <http://www.sisudoc.org/>
.br
-[ \ ruby_logo \ (png \ missing) \ ] [^15]
+ruby_logo.png 70x90 "Ruby" <http://www.ruby\-lang.org/en/> [^16]
.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
@@ -1705,9 +1809,41 @@ 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.7 GROUPED TEXT
+.SH LINK SHORTCUT FOR MULTIPLE VERSIONS OF A SISU DOCUMENT IN THE SAME DIRECTORY
+TREE
+
+.br
+.B markup example:
-.SH 9.7.1 TABLES
+.nf
+!_ /{"Viral Spiral"}/, David Bollier
+{ "Viral Spiral", David Bollier [3sS]}viral_spiral.david_bollier.sst
+.fi
+
+.br
+.B
+.I "Viral Spiral",
+David Bollier
+
+"Viral Spiral", David Bollier <http://corundum/sisu_manual/en/manifest/viral_spiral.david_bollier.html>
+ document manifest <http://corundum/sisu_manual/en/manifest/viral_spiral.david_bollier.html>
+ ⌠html, segmented text⌡「http://corundum/sisu_manual/en/html/viral_spiral.david_bollier.html」
+ ⌠html, scroll, document in one⌡「http://corundum/sisu_manual/en/html/viral_spiral.david_bollier.html」
+ ⌠epub⌡「http://corundum/sisu_manual/en/epub/viral_spiral.david_bollier.epub」
+ ⌠pdf, landscape⌡「http://corundum/sisu_manual/en/pdf/viral_spiral.david_bollier.pdf」
+ ⌠pdf, portrait⌡「http://corundum/sisu_manual/en/pdf/viral_spiral.david_bollier.pdf」
+ ⌠odf: odt, open document text⌡「http://corundum/sisu_manual/en/odt/viral_spiral.david_bollier.odt」
+ ⌠xhtml scroll⌡「http://corundum/sisu_manual/en/xhtml/viral_spiral.david_bollier.xhtml」
+ ⌠xml, sax⌡「http://corundum/sisu_manual/en/xml/viral_spiral.david_bollier.xml」
+ ⌠xml, dom⌡「http://corundum/sisu_manual/en/xml/viral_spiral.david_bollier.xml」
+ ⌠concordance⌡「http://corundum/sisu_manual/en/html/viral_spiral.david_bollier.html」
+ ⌠dcc, document content certificate (digests)⌡「http://corundum/sisu_manual/en/digest/viral_spiral.david_bollier.txt」
+ ⌠markup source text⌡「http://corundum/sisu_manual/en/src/viral_spiral.david_bollier.sst」
+ ⌠markup source (zipped) pod⌡「http://corundum/sisu_manual/en/pod/viral_spiral.david_bollier.sst.zip」
+
+.SH GROUPED TEXT
+
+.SH TABLES
.br
Tables may be prepared in two either of two forms
@@ -1729,7 +1865,7 @@ column three of row two, and so on
.br
.B resulting output:
- [table omitted, see other document formats]
+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』
.br
a second form may be easier to work with in cases where there is not much
@@ -1737,7 +1873,7 @@ information in each column
.br
.B markup example:
-[^17]
+[^18]
.nf
!_ Table 3.1: Contributors to Wikipedia, January 2001 \- June 2005
@@ -1757,13 +1893,13 @@ No. of articles, all languages | 25| 19,000| 138,000| 490,000| 862,0
.br
.B Table 3.1: Contributors to Wikipedia, January 2001 \- June 2005
- [table omitted, see other document formats]
+|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』
.br
* Contributed at least ten times; ** at least 5 times in last month; *** more
than 100 times in last month.
-.SH 9.7.2 POEM
+.SH POEM
.br
.B basic markup:
@@ -1831,106 +1967,59 @@ poem{
.B resulting output:
`Fury said to a
-.br
mouse, That he
-.br
met in the
-.br
house,
-.br
"Let us
-.br
both go to
-.br
law: I will
-.br
prosecute
-.br
YOU. \-\-Come,
-.br
I'll take no
-.br
denial; We
-.br
must have a
-.br
trial: For
-.br
really this
-.br
morning I've
-.br
nothing
-.br
to do."
-.br
Said the
-.br
mouse to the
-.br
cur, "Such
-.br
a trial,
-.br
dear Sir,
-.br
With
-.br
no jury
-.br
or judge,
-.br
would be
-.br
wasting
-.br
our
-.br
breath."
-.br
"I'll be
-.br
judge, I'll
-.br
be jury,"
-.br
Said
-.br
cunning
-.br
old Fury:
-.br
"I'll
-.br
try the
-.br
whole
-.br
cause,
-.br
and
-.br
condemn
-.br
you
-.br
to
-.br
death."'
-.br
-.SH 9.7.3 GROUP
+.SH GROUP
.br
.B basic markup:
.nf
group{
-.br
Your grouped text here
-.br
}group
-.br
A group is treated as an object and given a single object number.
.fi
@@ -1939,7 +2028,7 @@ A group is treated as an object and given a single object number.
.nf
group{
- 'Fury said to a
+ `Fury said to a
mouse, That he
met in the
house,
@@ -1990,95 +2079,51 @@ group{
.B resulting output:
`Fury said to a
-.br
mouse, That he
-.br
met in the
-.br
house,
-.br
"Let us
-.br
both go to
-.br
law: I will
-.br
prosecute
-.br
YOU. \-\-Come,
-.br
I'll take no
-.br
denial; We
-.br
must have a
-.br
trial: For
-.br
really this
-.br
morning I've
-.br
nothing
-.br
to do."
-.br
Said the
-.br
mouse to the
-.br
cur, "Such
-.br
a trial,
-.br
dear Sir,
-.br
With
-.br
no jury
-.br
or judge,
-.br
would be
-.br
wasting
-.br
our
-.br
breath."
-.br
"I'll be
-.br
judge, I'll
-.br
be jury,"
-.br
Said
-.br
cunning
-.br
old Fury:
-.br
"I'll
-.br
try the
-.br
whole
-.br
cause,
-.br
and
-.br
condemn
-.br
you
-.br
to
-.br
death."'
-.br
-.SH 9.7.4 CODE
+.SH CODE
.br
Code tags code{ \... }code (used as with other group tags described above) are
@@ -2196,9 +2241,9 @@ code{# as demonstrated here:
44 | death."'
.fi
-.SH 9.8 ADDITIONAL BREAKS \- LINEBREAKS WITHIN OBJECTS, COLUMN AND PAGE\-BREAKS
+.SH ADDITIONAL BREAKS \- LINEBREAKS WITHIN OBJECTS, COLUMN AND PAGE\-BREAKS
-.SH 9.8.1 LINE\-BREAKS
+.SH LINE\-BREAKS
.br
To break a line within a "paragraph object", two backslashes \e\e
@@ -2217,14 +2262,23 @@ The html break br enclosed in angle brackets (though undocumented) is available
in versions prior to 3.0.13 and 2.9.7 (it remains available for the time being,
but is depreciated).
-.SH 9.8.2 PAGE BREAKS
+.SH PAGE BREAKS
.br
Page breaks are only relevant and honored in some output formats. A page break
or a new page may be inserted manually using the following markup on a line on
its own:
+.br
+page new =\e= or breaks the page, starts a new page.
+
+.br
+page break \-\\- or breaks a column, starts a new column, if using columns,
+else breaks the page, starts a new page.
+
.nf
+\-\e\e\-
+or
<:pb>
.fi
@@ -2232,17 +2286,12 @@ its own:
or
.nf
+=\e\e=
+or
<:pn>
.fi
-.br
-page new <:pn> breaks the page, starts a new page.
-
-.br
-page break <:pb> breaks a column, starts a new column, if using columns, else
-breaks the page, starts a new page.
-
-.SH 9.9 BOOK INDEX
+.SH BOOK INDEX
.br
To make an index append to paragraph the book index term relates to it, using
@@ -2307,7 +2356,7 @@ additional paragraph. The logical structure of the resulting index would be:
second sub\-term, 1,
.fi
-.SH 10. COMPOSITE DOCUMENTS MARKUP
+.SH COMPOSITE DOCUMENTS MARKUP
.br
.br
@@ -2338,305 +2387,30 @@ basic markup for importing a document into a master document
.fi
.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}
-% using textlink alternatives
-<< |filename.ssi|@|^|
-.fi
-
-.SH 11. MARKUP SYNTAX HISTORY
-.br
-
-.SH 11.1 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
-0.38 is substantially current for version 1.0
-
-.br
-depreciated 0.16 supported, though file names were changed at 0.37
-
-.br
-* sisu \-\-query=[sisu \ version \ [0.38] or 'history]
-
-.br
-provides a short history of changes to
-.B SiSU
-markup
-
-.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
+The form described above should be relied on. Within the
+.I Vim
+editor it results in the text thus linked becoming hyperlinked to the document
+it is calling in which is convenient for editing.
+.SH SISU FILETYPES
.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
-0.57 is the same as 0.42 with the introduction of some a shortcut to use the
-headers @title and @creator in the first heading [expanded \ using \ the \
-contents \ of \ the \ headers \ @title: \ and \ @author:]
+has
+.I plaintext
+and binary filetypes, and can process either type of document.
-.nf
-:A~ @title by @author
-.fi
-
-.br
-.B 0.52
-(2007w14/6) declared document type identifier at start of text/document:
-
-.br
- .B SiSU
-0.52
-
-.br
-or, backward compatible using the comment marker:
-
-.br
- %
-.B SiSU
-0.38
-
-.br
-variations include '
-.B SiSU
-(text|master|insert) [version]' and 'sisu\-[version]'
-
-.br
-.B 0.51
-(2007w13/6) skins changed (simplified), markup unchanged
-
-.br
-.B 0.42
-(2006w27/4) * (asterisk) type endnotes, used e.g. in relation to author
-
-.br
-.B SiSU
-0.42 is the same as 0.38 with the introduction of some additional endnote
-types,
-
-.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
-* for example for describing an author
-
-.br
-** for describing a second author
-
-.br
-and
-
-.nf
-~[* \ my \ note \ ]~ or ~[+ \ another \ note \ ]~
-.fi
-
-.br
-which numerically increments an asterisk and plus respectively
-
-.br
-*1 my note +1 another note
-
-.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
-.B SiSU
-0.38 introduced alternative experimental header and heading/structure markers,
-
-.nf
-@headername: and headers :A~ :B~ :C~ 1~ 2~ 3~
-.fi
-
-.br
-as the equivalent of:
+.SH .SST \.SSM \.SSI MARKED UP PLAIN TEXT
-.nf
-0~headername and headers 1~ 2~ 3~ 4~ 5~ 6~
-.fi
-
-.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
-.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
-headings/levels, levels which are followed by ordinary text. This may be
-conceptualised as levels A,B,C, 1,2,3, and using such letter number notation,
-in effect: A must exist, optional B and C may follow in sequence (not strict) 1
-must exist, optional 2 and 3 may follow in sequence i.e. there are two
-independent heading level sequences A,B,C and 1,2,3 (using the 0.16 standard
-notation 1,2,3 and 4,5,6) on the positive side: the 0.38 A,B,C,1,2,3
-alternative makes explicit an aspect of structuring documents in
-.B SiSU
-that is not otherwise obvious to the newcomer (though it appears more
-complicated, is more in your face and likely to be understood fairly quickly);
-the substantive text follows levels 1,2,3 and it is 'nice' to do most work in
-those levels
-
-.br
-.B 0.37
-(2006w09/7) introduced new file naming convention, \.sst (text), \.ssm
-(master), \.ssi (insert), markup syntax unchanged
-
-.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
-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
-.fi
-
-.br
-The internal document markup remains unchanged, from
-.B SiSU
-0.16
-
-.br
-.B 0.35
-(2005w52/3) sisupod, zipped content file introduced
-
-.br
-.B 0.23
-(2005w36/2) utf\-8 for markup file
-
-.br
-.B 0.22
-(2005w35/3) image dimensions may be omitted if rmagick is available to be
-relied upon
-
-.br
-.B 0.20.4
-(2005w33/4) header 0~links
-
-.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
-.B SiSU
-0.16 (0.15 development branch) introduced the use of
-
-.br
-the header 0~ and headings/structure 1~ 2~ 3~ 4~ 5~ 6~
-
-.br
-in place of the 0.1 header, heading/structure notation
-
-.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
-
-.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
-
-.br
-.B SiSU
-documents are prepared as plain\-text (utf\-8) files with
+.TP
+.B SiSU¤b〕 documents are prepared as plain\-text (utf\-8) files with
.B SiSU
markup. They may make reference to and contain images (for example), which are
-stored in the directory beneath them _sisu/image.
-.B SiSU
-plaintext markup files are of three types that may be distinguished by the file
-extension used: regular text \.sst; master documents, composite documents that
+stored in the directory beneath them _sisu/image. 〔b¤SiSU
+.I plaintext
+markup files are of three types that may be distinguished by the file extension
+used: regular text \.sst; master documents, composite documents that
incorporate other text, which can be any regular text or text insert; and
inserts the contents of which are like regular text except these are marked
\.ssi and are not processed.
@@ -2653,7 +2427,7 @@ source markup can be shared with the command:
.br
sisu \-s [filename]
-.SH 12.1.1 SISU TEXT \- REGULAR FILES (.SST)
+.SH SISU TEXT \- REGULAR FILES (.SST)
.br
The most common form of document in
@@ -2662,13 +2436,7 @@ see the section on
.B SiSU
markup.
-.br
-<http://www.sisudoc.org/sisu/sisu_markup>
-
-.br
-<http://www.sisudoc.org/sisu/sisu_manual>
-
-.SH 12.1.2 SISU MASTER FILES (.SSM)
+.SH SISU MASTER FILES (.SSM)
.br
Composite documents which incorporate other
@@ -2694,15 +2462,9 @@ 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 [^18]
+with the same prefix and the suffix \._sst [^19]
-.br
-<http://www.sisudoc.org/sisu/sisu_markup>
-
-.br
-<http://www.sisudoc.org/sisu/sisu_manual>
-
-.SH 12.1.3 SISU INSERT FILES (.SSI)
+.SH SISU INSERT FILES (.SSI)
.br
Inserts are documents prepared solely for the purpose of being incorporated
@@ -2713,7 +2475,7 @@ 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 SISUPOD, ZIPPED BINARY CONTAINER (SISUPOD.ZIP, \.SSP)
.br
A sisupod is a zipped
@@ -2723,15 +2485,15 @@ 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
+.TP
.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
-documents contained in a directory are located in the sub\-directory
-_sisu/image. Without the ability to create a sisupod it can be inconvenient to
-manually identify all other files associated with a document. A sisupod
-automatically bundles all associated files with the document that is turned
-into a pod.
+.I plaintext
+files rely on a recognised directory structure to find contents such as images
+associated with documents, but all images for example for all documents
+contained in a directory are located in the sub\-directory _sisu/image. Without
+the ability to create a sisupod it can be inconvenient to manually identify all
+other files associated with a document. A sisupod automatically bundles all
+associated files with the document that is turned into a pod.
.br
The structure of the sisupod is such that it may for example contain a single
@@ -2764,125 +2526,12 @@ or on a remote server for which a url is provided.
.br
<http://www.sisudoc.org/sisu/sisu_manual>
-.SH 13. EXPERIMENTAL ALTERNATIVE INPUT REPRESENTATIONS
-.br
-
-.SH 13.1 ALTERNATIVE XML
-
+.SH CONFIGURATION
.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
-.B convert from sst to simple xml representations (sax, dom and node):
-
-.br
- sisu \-\-to\-sax [filename/wildcard] or sisu \-\-to\-sxs [filename/wildcard]
-
-.br
- sisu \-\-to\-dom [filename/wildcard] or sisu \-\-to\-sxd [filename/wildcard]
-
-.br
- sisu \-\-to\-node [filename/wildcard] or sisu \-\-to\-sxn [filename/wildcard]
-
-.br
-.B convert to sst from any sisu xml representation (sax, dom and node):
-
-.br
- sisu \-\-from\-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]]
-
-.br
-or the same:
-
-.br
- sisu \-\-from\-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]]
-
-.SH 13.1.1 XML SAX REPRESENTATION
-
-.br
-To convert from sst to simple xml (sax) representation:
-
-.br
- sisu \-\-to\-sax [filename/wildcard] or sisu \-\-to\-sxs [filename/wildcard]
-
-.br
-To convert from any sisu xml representation back to sst
-
-.br
- sisu \-\-from\-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]]
-
-.br
-or the same:
-
-.br
- sisu \-\-from\-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]]
-
-.SH 13.1.2 XML DOM REPRESENTATION
-
-.br
-To convert from sst to simple xml (dom) representation:
-
-.br
- sisu \-\-to\-dom [filename/wildcard] or sisu \-\-to\-sxd [filename/wildcard]
-.br
-To convert from any sisu xml representation back to sst
-
-.br
- sisu \-\-from\-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]]
-
-.br
-or the same:
-
-.br
- sisu \-\-from\-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]]
-
-.SH 13.1.3 XML NODE REPRESENTATION
-
-.br
-To convert from sst to simple xml (node) representation:
-
-.br
- sisu \-\-to\-node [filename/wildcard] or sisu \-\-to\-sxn [filename/wildcard]
-
-.br
-To convert from any sisu xml representation back to sst
-
-.br
- sisu \-\-from\-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]]
-
-.br
-or the same:
-
-.br
- sisu \-\-from\-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]]
-
-.SH 14. CONFIGURATION
-.br
-
-.SH 14.1 DETERMINING THE CURRENT CONFIGURATION
-
-.br
-Information on the current configuration of
-.B SiSU
-should be available with the help command:
-
-.br
- sisu \-v
-
-.br
-which is an alias for:
-
-.br
- sisu \-\-help env
-
-.br
-Either of these should be executed from within a directory that contains sisu
-markup source documents.
+.SH CONFIGURATION FILES
-.SH 14.2 CONFIGURATION FILES (CONFIG.YML)
+.SH CONFIG.YML
.br
.B SiSU
@@ -2902,12 +2551,21 @@ resource configuration is determined by looking at the following files if they
exist:
.br
+ ./_sisu/v4/sisurc.yml
+
+.br
./_sisu/sisurc.yml
.br
+ ~/.sisu/v4/sisurc.yml
+
+.br
~/.sisu/sisurc.yml
.br
+ /etc/sisu/v4/sisurc.yml
+
+.br
/etc/sisu/sisurc.yml
.br
@@ -2926,131 +2584,81 @@ If
.B SiSU
is installed a sample sisurc.yml may be found in /etc/sisu/sisurc.yml
-.SH 15. SKINS
-.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
- ./_sisu/skin
+.SH SISU_DOCUMENT_MAKE
.br
- ~/.sisu/skin
+Most sisu document headers relate to metadata, the exception is the @make:
+header which provides processing related information. The default contents of
+the @make header may be set by placing them in a file sisu_document_make.
.br
- /etc/sisu/skin
+The search order is as for resource configuration:
.br
-.B Within the skin directory
-are the following the default sub\-directories for document skins:
+ ./_sisu/v4/sisu_document_make
.br
- ./skin/doc
+ ./_sisu/sisu_document_make
.br
- ./skin/dir
+ ~/.sisu/v4/sisu_document_make
.br
- ./skin/site
+ ~/.sisu/sisu_document_make
.br
-A skin is placed in the appropriate directory and the file named skin_[name].rb
+ /etc/sisu/v4/sisu_document_make
.br
-The skin itself is a ruby file which modifies the default appearances set in
-the program.
-
-.SH 15.1 DOCUMENT SKIN
+ /etc/sisu/sisu_document_make
.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
+A sample sisu_document_make can be found in the _sisu/ directory under along
+with the provided sisu markup samples.
-.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
-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
-
-.br
-A site skin, modifies the program default skin.
-
-.SH 15.4 SAMPLE SKINS
-
-.br
-With
-.B SiSU
-installed sample skins may be found in:
-
-.br
- /etc/sisu/skin/doc and
- /usr/share/doc/sisu/markup\-samples/samples/_sisu/skin/doc
-
-.br
-(or equivalent directory) and if sisu\-markup\-samples is installed also under:
-
-.br
- /usr/share/doc/sisu/markup\-samples\-non\-free/samples/_sisu/skin/doc
-
-.br
-Samples of list.yml and promo.yml (which are used to create the right column
-list) may be found in:
-
-.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)
+.SH CSS \- CASCADING STYLE SHEETS (FOR HTML, XHTML AND XML)
.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.
+html,
+.I XHTML
+or
+.I 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
-The basic CSS file for html output is html.css, placing a file of that name in
+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
-HTML: html.css
+.I HTML:
+html. css
.br
-XML DOM: dom.css
+.I XML
+DOM: dom.css
.br
-XML SAX: sax.css
+.I XML
+SAX: sax.css
.br
-XHTML: xhtml.css
+.I XHTML:
+xhtml. css
.br
-The default homepage may use homepage.css or html.css
+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.[^19]
+name in directory _sisu/css directory or equivalent.[^20]
-.SH 17. ORGANISING CONTENT \- DIRECTORY STRUCTURE AND MAPPING
+.SH ORGANISING CONTENT \- DIRECTORY STRUCTURE AND MAPPING
.br
.br
@@ -3058,7 +2666,7 @@ file that is looked for in a skin.[^19]
v3 has new options for the source directory tree, and output directory
structures of which there are 3 alternatives.
-.SH 17.1 DOCUMENT SOURCE DIRECTORY
+.SH DOCUMENT SOURCE DIRECTORY
.br
The document source directory is the directory in which sisu processing
@@ -3070,27 +2678,24 @@ 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
+.SH 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/en
+ \./subject_name/fr
+ \./subject_name/es
+ \./subject_name/_sisu
+ \./subject_name/_sisu/css
+ \./subject_name/_sisu/image
.fi
-.SH 17.2 DOCUMENT OUTPUT DIRECTORY STRUCTURES
+.SH DOCUMENT OUTPUT DIRECTORY STRUCTURES
-.SH 17.2.1 OUTPUT DIRECTORY ROOT
+.SH OUTPUT DIRECTORY ROOT
.br
The output directory root can be set in the sisurc.yml file. Under the root,
@@ -3118,7 +2723,7 @@ output directory. Skins could be associated with each institution on a
directory basis and resulting documents will take on the appropriate different
appearance.
-.SH 17.2.2 ALTERNATIVE OUTPUT STRUCTURES
+.SH ALTERNATIVE OUTPUT STRUCTURES
.br
There are 3 possibile output structures described as being, by language, by
@@ -3131,7 +2736,7 @@ output_dir_structure_by: language #(language & filetype, preferred?)
#output_dir_structure_by: filename #(default, closest to original v1 & v2)
.fi
-.SH 17.2.3 BY LANGUAGE
+.SH BY LANGUAGE
.br
The by language directory structure places output files
@@ -3178,7 +2783,7 @@ output_dir_structure_by: language
.br
#by: language subject_dir/en/manifest/filename.html
-.SH 17.2.4 BY FILETYPE
+.SH BY FILETYPE
.br
The by filetype directory structure separates output files by filetype, all
@@ -3222,7 +2827,7 @@ output_dir_structure_by: filetype
.br
#by: filetype subject_dir/html/filename/manifest.en.html
-.SH 17.2.5 BY FILENAME
+.SH BY FILENAME
.br
The by filename directory structure places most output of a particular file
@@ -3258,10 +2863,10 @@ output_dir_structure_by: filename
.br
#by: filename subject_dir/filename/manifest.en.html
-.SH 17.2.6 REMOTE DIRECTORIES
+.SH REMOTE DIRECTORIES
.nf
-\./subject_name/
+./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
@@ -3275,10 +2880,10 @@ output_dir_structure_by: filename
\./subject_name/_sisu/mm
.fi
-.SH 17.2.7 SISUPOD
+.SH SISUPOD
.nf
-\./sisupod/
+./sisupod/
% files stored at this level e.g. sisu_manual.sst
\./sisupod/_sisu
% configuration file e.g. sisurc.yml
@@ -3290,9 +2895,9 @@ output_dir_structure_by: filename
\./sisupod/_sisu/mm
.fi
-.SH 17.3 ORGANISING CONTENT
+.SH ORGANISING CONTENT
-.SH 18. HOMEPAGES
+.SH HOMEPAGES
.br
.br
@@ -3319,7 +2924,7 @@ 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 HOME PAGE AND OTHER CUSTOM BUILT PAGES IN A SUB\-DIRECTORY
.br
Custom built pages, including the home page index.html may be placed within the
@@ -3330,52 +2935,147 @@ there they are copied to the root of the output directory with the command:
.br
sisu \-CC
-.SH 18.2 HOME PAGE WITHIN A SKIN
+.SH MARKUP AND OUTPUT EXAMPLES
+.br
+
+.SH MARKUP EXAMPLES
.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.
+Current markup examples and document output samples are provided off
+<http://sisudoc.org> or <http://www.jus.uio.no/sisu> and in the sisu
+\-markup\-sample package available off <http://sources.sisudoc.org>
.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
+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.
-.nf
- class Home
- def homepage
- # place the html content of your homepage here, this will become index.html
- <<HOME <html>
-<head></head>
-<doc>
-<p>this is my new homepage.</p>
-</doc>
-</html>
-HOME
- end
- end
-.fi
+.SH SISU MARKUP SAMPLES
-.SH 19. MARKUP AND OUTPUT EXAMPLES
.br
+A few additional sample books prepared as sisu markup samples, output formats
+to be generated using
+.B SiSU
+are contained in a separate package sisu \-markup\-samples. sisu
+\-markup\-samples contains books (prepared using sisu markup), that were
+released by their authors various licenses mostly different Creative Commons
+licences that do not permit inclusion in the
+.B Debian
+Project as they have requirements that do not meet the
+.B Debian
+Free Software Guidelines for various reasons, most commonly that they require
+that the original substantive text remain unchanged, and sometimes that the
+works be used only non\-commercially.
-.SH 19.1 MARKUP EXAMPLES
+.br
+.I Accelerando,
+Charles Stross (2005)
+accelerando.charles_stross.sst
.br
-Current markup examples and document output samples are provided at
-<http://www.jus.uio.no/sisu/SiSU/examples.html>
+.I Alice's Adventures in Wonderland,
+Lewis Carroll (1865)
+alices_adventures_in_wonderland.lewis_carroll.sst
.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.
+.I CONTENT,
+Cory Doctorow (2008)
+content.cory_doctorow.sst
+
+.br
+.I Democratizing Innovation,
+Eric von Hippel (2005)
+democratizing_innovation.eric_von_hippel.sst
+
+.br
+.I Down and Out in the Magic Kingdom,
+Cory Doctorow (2003)
+down_and_out_in_the_magic_kingdom.cory_doctorow.sst
+
+.br
+.I For the Win,
+Cory Doctorow (2010)
+for_the_win.cory_doctorow.sst
+
+.br
+.I Free as in Freedom \- Richard Stallman's Crusade for Free Software,
+Sam Williams (2002)
+free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst
+
+.br
+.I Free as in Freedom 2.0 \- Richard Stallman and the Free Software Revolution,
+Sam Williams (2002), Richard M. Stallman (2010)
+free_as_in_freedom_2.richard_stallman_and_the_free_software_revolution.sam_williams.richard_stallman.sst
+
+.br
+.I Free Culture \- How Big Media Uses Technology and the Law to Lock Down
+Culture and Control Creativity,
+Lawrence Lessig (2004)
+free_culture.lawrence_lessig.sst
+
+.br
+.I Free For All \- How Linux and the Free Software Movement Undercut the High
+Tech Titans,
+Peter Wayner (2002)
+free_for_all.peter_wayner.sst
+
+.br
+.I GNU GENERAL PUBLIC LICENSE v2,
+Free Software Foundation (1991)
+gpl2.fsf.sst
+
+.br
+.I GNU GENERAL PUBLIC LICENSE v3,
+Free Software Foundation (2007)
+gpl3.fsf.sst
-.SH 20. SISU SEARCH \- INTRODUCTION
+.br
+.I Gulliver's Travels,
+Jonathan Swift (1726 / 1735)
+gullivers_travels.jonathan_swift.sst
+
+.br
+.I Little Brother,
+Cory Doctorow (2008)
+little_brother.cory_doctorow.sst
+
+.br
+.I The Cathederal and the Bazaar,
+Eric Raymond (2000)
+the_cathedral_and_the_bazaar.eric_s_raymond.sst
+
+.br
+.I The Public Domain \- Enclosing the Commons of the Mind,
+James Boyle (2008)
+the_public_domain.james_boyle.sst
+
+.br
+.I The Wealth of Networks \- How Social Production Transforms Markets and
+Freedom,
+Yochai Benkler (2006)
+the_wealth_of_networks.yochai_benkler.sst
+
+.br
+.I Through the Looking Glass,
+Lewis Carroll (1871)
+through_the_looking_glass.lewis_carroll.sst
+
+.br
+.I Two Bits \- The Cultural Significance of Free Software,
+Christopher Kelty (2008)
+two_bits.christopher_kelty.sst
+
+.br
+.I UN Contracts for International Sale of Goods,
+UN (1980)
+un_contracts_international_sale_of_goods_convention_1980.sst
+
+.br
+.I Viral Spiral,
+David Bollier (2008)
+viral_spiral.david_bollier.sst
+
+.SH SISU SEARCH \- INTRODUCTION
.br
.br
@@ -3385,10 +3085,11 @@ indexing tools, such as Lucene, Hyperestraier.
.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.
+text
+.I 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
In addition to this
@@ -3400,15 +3101,18 @@ 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
+.SH SQL
.br
-.SH 21.1 POPULATING SQL TYPE DATABASES
+.SH POPULATING SQL TYPE DATABASES
.br
.B SiSU
-feeds sisu markupd documents into sql type databases PostgreSQL[^20] and/or
-SQLite[^21] database together with information related to document structure.
+feeds sisu markupd documents into sql type databases
+.I PostgreSQL
+[^21] and/or
+.I SQLite
+[^22] database together with information related to document structure.
.br
This is one of the more interesting output forms, as all the structural data of
@@ -3418,7 +3122,9 @@ four tables:
.br
* one containing semantic (and other) headers, including, title, author,
- subject, (the Dublin Core...);
+ subject, (the
+ .I Dublin Core.
+ ..);
.br
* another the substantive texts by individual "paragraph" (or object) \-
@@ -3434,7 +3140,8 @@ four tables:
.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.
+ full text versions of output, eg. pdf, html, xml, and
+ .I ascii.
.br
There is of course the possibility to add further structures.
@@ -3461,20 +3168,21 @@ results relevant for all available output formats, with live links to the
precise locations in the database or in html/xml documents; or, the structural
information provided makes it possible to search the full contents of the
database and have headings in which search content appears, or to search only
-headings etc. (as the Dublin Core is incorporated it is easy to make use of
-that as well).
+headings etc. (as the
+.I Dublin Core
+is incorporated it is easy to make use of that as well).
-.SH 22. POSTGRESQL
+.SH POSTGRESQL
.br
-.SH 22.1 NAME
+.SH NAME
.br
.B SiSU
\- Structured information, Serialized Units \- a document publishing system,
postgresql dependency package
-.SH 22.2 DESCRIPTION
+.SH DESCRIPTION
.br
Information related to using postgresql with sisu (and related to the
@@ -3483,9 +3191,9 @@ dependencies needed for
.B SiSU
to populate a postgresql database, this being part of
.B SiSU
-\- man sisu).
+\- man sisu) .
-.SH 22.3 SYNOPSIS
+.SH SYNOPSIS
.br
sisu \-D [instruction] [filename/wildcard \ if \ required]
@@ -3493,7 +3201,7 @@ to populate a postgresql database, this being part of
.br
sisu \-D \-\-pg \-\-[instruction] [filename/wildcard \ if \ required]
-.SH 22.4 COMMANDS
+.SH COMMANDS
.br
Mappings to two databases are provided by default, postgresql and sqlite, the
@@ -3505,7 +3213,7 @@ alternatively \-\-sqlite or \-\-pgsql may be used
.B \-D or \-\-pgsql
may be used interchangeably.
-.SH 22.4.1 CREATE AND DESTROY DATABASE
+.SH CREATE AND DESTROY DATABASE
.TP
.B \-\-pgsql \-\-createall
@@ -3531,7 +3239,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 IMPORT AND REMOVE DOCUMENTS
.TP
.B sisu \-D \-\-import \-v [filename/wildcard]
@@ -3546,16 +3254,16 @@ updates file contents in database
.B sisu \-D \-\-remove \-v [filename/wildcard]
removes specified document from postgresql database.
-.SH 23. SQLITE
+.SH SQLITE
.br
-.SH 23.1 NAME
+.SH NAME
.br
.B SiSU
\- Structured information, Serialized Units \- a document publishing system.
-.SH 23.2 DESCRIPTION
+.SH DESCRIPTION
.br
Information related to using sqlite with sisu (and related to the sisu_sqlite
@@ -3563,9 +3271,9 @@ dependency package, which is a dummy package to install dependencies needed for
.B SiSU
to populate an sqlite database, this being part of
.B SiSU
-\- man sisu).
+\- man sisu) .
-.SH 23.3 SYNOPSIS
+.SH SYNOPSIS
.br
sisu \-d [instruction] [filename/wildcard \ if \ required]
@@ -3574,7 +3282,7 @@ to populate an sqlite database, this being part of
sisu \-d \-\-(sqlite|pg) \-\-[instruction] [filename/wildcard \ if \
required]
-.SH 23.4 COMMANDS
+.SH COMMANDS
.br
Mappings to two databases are provided by default, postgresql and sqlite, the
@@ -3586,7 +3294,7 @@ alternatively \-\-sqlite or \-\-pgsql may be used
.B \-d or \-\-sqlite
may be used interchangeably.
-.SH 23.4.1 CREATE AND DESTROY DATABASE
+.SH CREATE AND DESTROY DATABASE
.TP
.B \-\-sqlite \-\-createall
@@ -3612,7 +3320,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 IMPORT AND REMOVE DOCUMENTS
.TP
.B sisu \-d \-\-import \-v [filename/wildcard]
@@ -3627,32 +3335,41 @@ updates file contents in database
.B sisu \-d \-\-remove \-v [filename/wildcard]
removes specified document from sqlite database.
-.SH 24. INTRODUCTION
+.SH INTRODUCTION
.br
-.SH 24.1 SEARCH \- DATABASE FRONTEND SAMPLE, UTILISING DATABASE AND SISU FEATURES,
+.SH SEARCH \- DATABASE FRONTEND SAMPLE, UTILISING DATABASE AND SISU FEATURES,
INCLUDING OBJECT CITATION NUMBERING (BACKEND CURRENTLY POSTGRESQL)
.br
-Sample search frontend <http://search.sisudoc.org> [^22] A small database and
+Sample search frontend <http://search.sisudoc.org> [^23] A small database and
sample query front\-end (search from) that makes use of the citation system,
.I object citation numbering
-to demonstrates functionality.[^23]
+to demonstrates functionality.[^24]
.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
-all outputs using object citation numbering, which includes html, XML, EPUB,
-LaTeX, PDF and indeed the SQL database. You can then refer to one of the other
-outputs or in the SQL database expand the text within the matched objects
-(paragraphs) in the documents matched.
+all outputs using
+.I object citation numbering,
+which includes html,
+.I XML,
+.I EPUB,
+.I LaTeX,
+.I PDF
+and indeed the
+.I SQL
+database. You can then refer to one of the other outputs or in the
+.I SQL
+database expand the text within the matched objects (paragraphs) in the
+documents matched.
.br
Note you may set results either for documents matched and object number
locations within each matched document meeting the search criteria; or display
the names of the documents matched along with the objects (paragraphs) that
-meet the search criteria.[^24]
+meet the search criteria.[^25]
.TP
.B sisu \-F \-\-webserv\-webrick
@@ -3687,7 +3404,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 SEARCH FORM
.TP
.B sisu \-F
@@ -3700,10 +3417,6 @@ generates a sample search form for use with the webrick server, which must be
copied to the web\-server cgi directory
.TP
-.B sisu \-Fv
-as above, and provides some information on setting up hyperestraier
-
-.TP
.B sisu \-W
starts the webrick server which should be available wherever sisu is properly
installed
@@ -3712,16 +3425,16 @@ installed
The generated search form must be copied manually to the webserver directory as
instructed
-.SH 25. SISU_WEBRICK
+.SH SISU_WEBRICK
.br
-.SH 25.1 NAME
+.SH NAME
.br
.B SiSU
\- Structured information, Serialized Units \- a document publishing system
-.SH 25.2 SYNOPSIS
+.SH SYNOPSIS
.br
sisu_webrick [port]
@@ -3732,7 +3445,7 @@ or
.br
sisu \-W [port]
-.SH 25.3 DESCRIPTION
+.SH DESCRIPTION
.br
sisu_webrick is part of
@@ -3750,7 +3463,7 @@ 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 25.4 SUMMARY OF MAN PAGE
+.SH SUMMARY OF MAN PAGE
.br
sisu_webrick, may be started on it's own with the command: sisu_webrick [port]
@@ -3759,7 +3472,7 @@ or using the sisu command with the \-W flag: sisu \-W [port]
.br
where no port is given and settings are unchanged the default port is 8081
-.SH 25.5 DOCUMENT PROCESSING COMMAND FLAGS
+.SH DOCUMENT PROCESSING COMMAND FLAGS
.br
sisu \-W [port] starts
@@ -3769,717 +3482,22 @@ 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 25.6 FURTHER INFORMATION
-
-.br
-For more information on
-.B SiSU
-see: <http://www.sisudoc.org/> or <http://www.jus.uio.no/sisu>
-
-.br
-or man sisu
-
-.SH 25.7 AUTHOR
-
-.br
-Ralph Amissah <ralph@amissah.com> or <ralph.amissah@gmail.com>
-
-.SH 25.8 SEE ALSO
-
-.br
- sisu(1)
-
-.br
- sisu_vim(7)
-
-.SH 26. REMOTE SOURCE DOCUMENTS
-.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 are to be
-carried out. The remote
-.B SiSU
-documents can either be sisu marked up files in plaintext \.sst or \.ssm or;
-zipped sisu files, sisupod.zip or filename.ssp
-
-.br
-.B \.sst / \.ssm \- sisu text files
-
-.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
-Any of the source documents in the sisu examples page can be used in this way,
-see <http://www.jus.uio.no/sisu/SiSU/examples.html> and use the url to the
- \.sst for the desired document.
-
-.br
-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
-.B sisupod \- zipped sisu files
-
-.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
-.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
-Any of the source documents in the sisu examples page can be used in this way,
-see <http://www.jus.uio.no/sisu/SiSU/examples.html> and use the url for the
-desired document.
-
-.SH REMOTE DOCUMENT OUTPUT
-.br
-
-.SH 27. REMOTE OUTPUT
-.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
-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 27.1 COMMANDS
-
-.TP
-.B \-R [filename/wildcard]
-copies sisu output files to remote host using rsync. This requires that
-sisurc.yml has been provided with information on hostname and username, and
-that you have your "keys" and ssh agent in place. Note the behavior of rsync
-different if \-R is used with other flags from if used alone. Alone the rsync
-\-\-delete parameter is sent, useful for cleaning the remote directory (when
-\-R is used together with other flags, it is not). Also see \-r
-
-.TP
-.B \-r [filename/wildcard]
-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 27.2 CONFIGURATION
-
-.br
-[expand \ on \ the \ setting \ up \ of \ an \ ssh\-agent \ / \ keychain]
-
-.SH 28. REMOTE SERVERS
-.br
-
-.br
-As
-.B SiSU
-is generally operated using the command line, and works within a Unix type
-environment,
-.B SiSU
-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 29. QUICKSTART \- GETTING STARTED HOWTO
-.br
-
-.SH 29.1 INSTALLATION
-
-.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 29.1.1 DEBIAN INSTALLATION
-
-.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
-The following /etc/apt/sources.list setting permits the download of additional
-markup samples:
-
-.nf
- #/etc/apt/sources.list
-.br
- deb http://ftp.fi.debian.org/debian/ unstable main non\-free contrib
-.br
- deb\-src http://ftp.fi.debian.org/debian/ unstable main non\-free contrib
-.br
-
-.fi
-
-.br
-The aptitude commands become:
-
-.nf
- aptitude update
-.br
- aptitude install sisu\-complete sisu\-markup\-samples
-.fi
-
-.br
-If there are newer versions of
-.B SiSU
-upstream of the
-.B Debian
-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
-repeat the aptitude commands
-
-.nf
- aptitude update
- aptitude install sisu\-complete sisu\-markup\-samples
-.fi
-
-.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 29.1.2 RPM INSTALLATION
-
-.br
-RPMs are provided though untested, they are prepared by running alien against
-the source package, and against the debs.
-
-.br
-They may be downloaded from:
-
-.br
- <http://www.jus.uio.no/sisu/SiSU/download.html#rpm>
-
-.br
-as root type:
-
-.br
- rpm \-i [rpm \ package \ name]
-
-.SH 29.1.3 INSTALLATION FROM SOURCE
-
-.br
-To install
-.B SiSU
-from source check information at:
-
-.br
- <http://www.jus.uio.no/sisu/SiSU/download.html#current>
-
-.br
-* download the source package
-
-.br
-* Unpack the source
-
-.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
-For basic use
-.B SiSU
-is only dependent on the programming language in which it is written
-.B Ruby,
-and
-.B SiSU
-will be able to generate html, EPUB, various XMLs, including ODF (and will also
-produce LaTeX). Dependencies required for further actions, though it relies on
-the installation of additional dependencies which the source tarball does not
-take care of, for things like using a database (postgresql or sqlite)[^25] or
-converting LaTeX to pdf.
-
-.br
-.B setup.rb
-
-.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
- #[and \ as \ root:]
- ruby setup.rb install
-.fi
-
-.br
-further information on setup.rb is available from:
-
-.br
- <http://i.loveruby.net/en/projects/setup/>
-
-.br
- <http://i.loveruby.net/en/projects/setup/doc/usage.html>
-
-.br
-.B "install"
-
-.br
-The "install" file provided is an installer prepared using "rant". In the root
-directory of the unpacked
-.B SiSU
-as root type:
-
-.br
- ruby install base
-
-.br
-or for a more complete installation:
-
-.br
- ruby install
-
-.br
-or
-
-.br
- ruby install base
-
-.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
-Further information on "rant" is available from:
-
-.br
- <http://make.rubyforge.org/>
-
-.br
- <http://rubyforge.org/frs/?group_id=615>
-
-.br
-For a list of alternative actions you may type:
-
-.br
- ruby install help
-
-.br
- ruby install \-T
-
-.SH 29.2 TESTING SISU, GENERATING OUTPUT
-
-.br
-To check which version of sisu is installed:
-
-.br
-sisu \-v
-
-.br
-Depending on your mode of installation one or a number of markup sample files
-may be found either in the directory:
-
-.br
-...
-
-.br
-or
-
-.br
-...
-
-.br
-change directory to the appropriate one:
-
-.br
-cd /usr/share/doc/sisu/markup\-samples/samples
-
-.SH 29.2.1 BASIC TEXT, PLAINTEXT, HTML, XML, ODF, EPUB
-
-.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
-sisu \-NhwoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst
-
-.br
-this will generate html including a concordance file, opendocument text format,
-plaintext, XHTML and various forms of XML, and OpenDocument text
-
-.SH 29.2.2 LATEX / PDF
-
-.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
-Having moved to the directory that contains the markup samples (see
-instructions above if necessary), choose a file and run sisu against it
-
-.br
-sisu \-pv free_as_in_freedom.rms_and_free_software.sam_williams.sst
-
-.br
-sisu \-3 free_as_in_freedom.rms_and_free_software.sam_williams.sst
-
-.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 29.2.3 RELATIONAL DATABASE \- POSTGRESQL, SQLITE
-
-.br
-Relational databases need some setting up \- you must have permission to create
-the database and write to it when you run sisu.
-
-.br
-Assuming you have the database installed and the requisite permissions
-
-.br
-sisu \-\-sqlite \-\-recreate
-
-.br
-sisu \-\-sqlite \-v \-\-import
-free_as_in_freedom.rms_and_free_software.sam_williams.sst
-
-.br
-sisu \-\-pgsql \-\-recreate
-
-.br
-sisu \-\-pgsql \-v \-\-import
-free_as_in_freedom.rms_and_free_software.sam_williams.sst
-
-.SH 29.3 GETTING HELP
-
-.SH 29.3.1 THE MAN PAGES
-
-.br
-Type:
-
-.br
- man sisu
-
-.br
-The man pages are also available online, though not always kept as up to date
-as within the package itself:
-
-.br
-* sisu.1 <http://www.jus.uio.no/sisu/man/sisu.1.html> [^26]
-
-.br
-* sisu.8 <http://www.jus.uio.no/sisu/man/sisu.8.html> [^27]
-
-.br
-* man directory <http://www.jus.uio.no/sisu/man> [^28]
-
-.SH 29.3.2 BUILT IN HELP
-
-.br
-sisu \-\-help
-
-.br
-sisu \-\-help \-\-env
-
-.br
-sisu \-\-help \-\-commands
-
-.br
-sisu \-\-help \-\-markup
-
-.SH 29.3.3 THE HOME PAGE
-
-.br
-<http://www.sisudoc.org/>
-
-.br
-<http://www.jus.uio.no/sisu>
-
-.br
-<http://www.jus.uio.no/sisu/SiSU>
-
-.SH 29.4 MARKUP SAMPLES
-
-.br
-A number of markup samples (along with output) are available off:
-
-.br
-<http://www.jus.uio.no/sisu/SiSU/examples.html>
-
-.br
-Additional markup samples are packaged separately in the file:
-
-.br
-***
-
-.br
-On
-.B Debian
-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
-.br
-
-.br
-The directory:
-
-.br
- ./data/sisu/v2/conf/editor\-syntax\-etc/
-
-.br
- ./data/sisu/v3/conf/editor\-syntax\-etc/
-
-.br
- /usr/share/sisu/v2/conf/editor\-syntax\-etc
-
-.br
- /usr/share/sisu/v3/conf/editor\-syntax\-etc
-
-.br
-contains rudimentary sisu syntax highlighting files for:
-
-.br
-* (g)vim <http://www.vim.org>
-
-.br
- package: sisu\-vim
-
-.br
-status: largely done
-
-.br
- there is a vim syntax highlighting and folds component
-
-.br
-* gedit <http://www.gnome.org/projects/gedit>
-
-.br
-* gobby <http://gobby.0x539.de/>
-
-.br
- file: sisu.lang
-
-.br
-place in:
-
-.br
- /usr/share/gtksourceview\-1.0/language\-specs
-
-.br
-or
-
-.br
- ~/.gnome2/gtksourceview\-1.0/language\-specs
-
-.br
- status: very basic syntax highlighting
-
-.br
- comments: this editor features display line wrap and is used by Goby!
-
-.br
-* nano <http://www.nano\-editor.org>
-
-.br
- file: nanorc
-
-.br
-save as:
-
-.br
- ~/.nanorc
-
-.br
- status: basic syntax highlighting
-
-.br
- comments: assumes dark background; no display line\-wrap; does line breaks
-
-.br
-* diakonos (an editor written in ruby) <http://purepistos.net/diakonos>
-
-.br
-file: diakonos.conf
-
-.br
-save as:
-
-.br
- ~/.diakonos/diakonos.conf
-
-.br
-includes:
-
-.br
- status: basic syntax highlighting
-
-.br
-comments: assumes dark background; no display line\-wrap
-
-.br
-* kate & kwrite <http://kate.kde.org>
-
-.br
- file: sisu.xml
-
-.br
- place in:
-
-.br
- /usr/share/apps/katepart/syntax
-
-.br
- or
-
-.br
- ~/.kde/share/apps/katepart/syntax
-
-.br
- [settings::configure \ kate::{highlighting,filetypes}]
-
-.br
- [tools::highlighting::{markup,scripts}:: \ .B \ SiSU \ ]
-
-.br
-* nedit <http://www.nedit.org>
-
-.br
- file: sisu_nedit.pats
-
-.br
- nedit \-import sisu_nedit.pats
-
-.br
- status: a very clumsy first attempt [not \ really \ done]
-
-.br
- comments: this editor features display line wrap
-
-.br
-* emacs <http://www.gnu.org/software/emacs/emacs.html>
-
-.br
- files: sisu\-mode.el
-
-.br
- to file ~/.emacs add the following 2 lines:
-
-.br
- (add\-to\-list 'load\-path
- "/usr/share/sisu/v2/conf/editor\-syntax\-etc/emacs")
-
-.br
- (require 'sisu\-mode.el)
-
-.br
- [not \ done \ / \ not \ yet \ included]
-
-.br
-* vim & gvim <http://www.vim.org>
-
-.br
- files:
-
-.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
- status: this includes: syntax highlighting; vim folds; some error checking
-
-.br
- comments: this editor features display line wrap
-
-.br
-NOTE:
-
-.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 31. HOW DOES SISU WORK?
-.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
-published, who authored it, and granting what rights) and any processing
-instructions; and markup within the substantive text of the document, which is
-related to document structure and typeface.
-.B SiSU
-must be able to discern the structure of a document, (text headings and their
-levels in relation to each other), either from information provided in the
-document header or from markup within the text (or from a combination of both).
-Processing is done against an abstraction of the document comprising of
-information on the document's structure and its objects,[2] which the program
-serializes (providing the object numbers) and which are assigned hash sum
-values based on their content. This abstraction of information about document
-structure, objects, (and hash sums), provides considerable flexibility in
-representing documents different ways and for different purposes (e.g. search,
-document layout, publishing, content certification, concordance etc.), and
-makes it possible to take advantage of some of the strengths of established
-ways of representing documents, (or indeed to create new ones).
-
-.SH 32. SUMMARY OF FEATURES
+.SH SUMMARY OF FEATURES
.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.
+a single
+.I 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
* 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].
+and more sparse than the most basic
+.I HTML
+) , [this \ may \ also \ be \ converted \ to \ .I \ XML \ representations \ of
+\ the \ same \ input/source \ document].
.br
* markup defines document structure (this may be done once in a header
@@ -4502,38 +3520,59 @@ different strengths of various standard formats for representing documents,
amongst the output formats currently supported are:
.br
- * html \- both as a single scrollable text and a segmented document
+*
+.I HTML
+\- both as a single scrollable text and a segmented document
.br
- * xhtml
+*
+.I XHTML
.br
- * epub
+*
+.I EPUB
.br
- * XML \- both in sax and dom style xml structures for further development as
- required
+*
+.I XML
+\- both in sax and dom style xml structures for further development as required
.br
- * ODF \- open document format, the iso standard for document storage
+*
+.I ODT
+\- Open Document Format text, the iso standard for document storage
.br
- * LaTeX \- used to generate pdf
+*
+.I LaTeX
+\- used to generate pdf
.br
- * pdf (via LaTeX)
+*
+.I PDF
+(via
+.I LaTeX
+)
.br
- * sql \- population of an sql database, (at the same object level that is
- used to cite text within a document)
+*
+.I SQL
+\- population of an sql database (
+.I PostgreSQL
+or
+.I SQLite
+) , (at the same object level that is used to cite text within a document)
.br
Also produces: concordance files; document content certificates (md5 or sha256
digests of headings, paragraphs, images etc.) and html manifests (and sitemaps
of content). (b) takes advantage of the strengths implicit in these very
-different output types, (e.g. PDFs produced using typesetting of LaTeX,
+different output types, (e.g. PDFs produced using typesetting of
+.I LaTeX,
databases populated with documents at an individual object/paragraph level,
-making possible granular search (and related possibilities))
+making possible
+.I granular search
+(and related possibilities))
.br
* ensuring content can be cited in a meaningful way regardless of selected
@@ -4544,17 +3583,21 @@ browsers and formats. sisu seeks to provide a common way of pinpoint the text
within a document, (which can be utilized for citation and by search engines).
The outputs share a common numbering system that is meaningful (to man and
machine) across all digital outputs whether paper, screen, or database
-oriented, (pdf, HTML, EPUB, xml, sqlite, postgresql), this numbering system can
-be used to reference content.
+oriented, (pdf,
+.I HTML,
+.I EPUB,
+xml, sqlite, postgresql) , this numbering system can be used to reference
+content.
.br
-* Granular search within documents. SQL databases are populated at an object
-level (roughly headings, paragraphs, verse, tables) and become searchable with
-that degree of granularity, the output information provides the
-object/paragraph numbers which are relevant across all generated outputs; it is
-also possible to look at just the matching paragraphs of the documents in the
-database; [output \ indexing \ also \ work \ well \ with \ search \ indexing \
-tools \ like \ hyperestraier].
+* Granular search within documents.
+.I SQL
+databases are populated at an object level (roughly headings, paragraphs,
+verse, tables) and become searchable with that degree of granularity, the
+output information provides the object/paragraph numbers which are relevant
+across all generated outputs; it is also possible to look at just the matching
+paragraphs of the documents in the database; [output \ indexing \ also \ work \
+well \ with \ search \ indexing \ tools \ like \ hyperestraier].
.br
* long term maintainability of document collections in a world of changing
@@ -4565,8 +3608,9 @@ considerable degree of future\-proofing, output representations are
sometime in future, without modification of existing prepared texts
.br
-* SQL search aside, documents are generated as required and static once
-generated.
+*
+.I SQL
+search aside, documents are generated as required and static once generated.
.br
* documents produced are static files, and may be batch processed, this needs
@@ -4575,8 +3619,10 @@ to be done only once but may be repeated for various reasons as desired
presentations/representations)
.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
+* document source (
+.I plaintext
+utf\-8) if shared on the net may be used as input and processed locally to
+produce the different document outputs
.br
* document source may be bundled together (automatically) with associated
@@ -4590,8 +3636,15 @@ may be processed locally to produce the desired document outputs
.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
+and a few standard Unix tools (this covers
+.I plaintext,
+.I HTML,
+.I EPUB,
+.I XML,
+.I ODF,
+.I LaTeX
+) . To use a database you of course need that, and to convert the
+.I LaTeX
generated to pdf, a latex processor like tetex or texlive.
.br
@@ -4615,8 +3668,8 @@ i.e. to be able to take advantage from this minimal preparation starting point
of some of the strengths of rather different established ways of representing
documents for different purposes, whether for search (relational database, or
indexed flat files generated for that purpose whether of complete documents, or
-say of files made up of objects), online viewing (e.g. html, xml, pdf), or
-paper publication (e.g. pdf)...
+say of files made up of objects), online viewing (e.g. html, xml, pdf) , or
+paper publication (e.g. pdf) \...
.br
the solution arrived at is by extracting structural information about the
@@ -4627,155 +3680,64 @@ 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 33. HELP SOURCES
-.br
-
-.SH 33.1 MAN PAGES
-
-.br
- man sisu
-
-.br
- man sisu\-concordance
-
-.br
- man sisu\-epub
-
-.br
- man sisu\-git
-
-.br
- man sisu\-harvest
-
-.br
- man sisu\-html
-
-.br
- man sisu\-odf
-
-.br
- man sisu\-pdf
-
-.br
- man sisu\-pg
-
-.br
- man sisu\-po
-
-.br
- man sisu\-sqlite
-
-.br
- man sisu\-txt
-
-.br
- man 7 sisu_complete
-
-.br
- man 7 sisu_pdf
-
-.br
- man 7 sisu_postgresql
-
-.br
- man 7 sisu_sqlite
-
-.br
- man sisu_termsheet
-
-.br
- man sisu_webrick
-
-.SH 33.2 SISU GENERATED OUTPUT \- LINKS TO HTML
-
-.br
-Note
-.B SiSU
-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[^30]
-
-.SH 33.2.1 WWW.SISUDOC.ORG
-
-.br
-<http://sisudoc.org/sisu/sisu_manual/index.html>
-
-.br
- <http://sisudoc.org/sisu/sisu_manual/index.html>
-
-.SH 33.3 MAN2HTML
-
-.SH 33.3.1 LOCALLY INSTALLED
-
-.br
-file:///usr/share/doc/sisu/html/sisu.1.html
-
-.br
- file:///usr/share/doc/sisu/html/sisu.1.html
-
-.br
- /usr/share/doc/sisu/html/sisu_pdf.7.html
-
-.br
- /usr/share/doc/sisu/html/sisu_postgresql.7.html
+.TP
+.BI 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.
.br
- /usr/share/doc/sisu/html/sisu_sqlite.7.html
+.TP
+.BI 2.
+i.e. the
.br
- /usr/share/doc/sisu/html/sisu_webrick.1.html
-
-.SH 33.3.2 WWW.JUS.UIO.NO/SISU
+.I HTML,
.br
-<http://www.jus.uio.no/sisu/man/sisu.1.html>
+.I PDF,
.br
- <http://www.jus.uio.no/sisu/man/sisu.1.html>
+.I EPUB,
.br
- <http://www.jus.uio.no/sisu/man/sisu_complete.7.html>
+.I ODT
.br
- <http://www.jus.uio.no/sisu/man/sisu_pdf.7.html>
+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
- <http://www.jus.uio.no/sisu/man/sisu_postgresql.7.html>
+.TP
+.BI 3.
+the different heading levels
.br
- <http://www.jus.uio.no/sisu/man/sisu_sqlite.7.html>
+.TP
+.BI 4.
+units of text, primarily paragraphs and headings, also any tables, poems,
+code-blocks
.br
- <http://www.jus.uio.no/sisu/man/sisu_webrick.1.html>
-
.TP
-.BI 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.
+.BI 5.
+An open standard format for e-books
.br
.TP
-.BI 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.
+.BI 6.
+Open Document Format (
.br
-.TP
-.BI 3.
-the different heading levels
+.I ODF
.br
-.TP
-.BI 4.
-units of text, primarily paragraphs and headings, also any tables, poems,
-code-blocks
+) text
.br
.TP
-.BI 5.
+.BI 7.
Specification submitted by Adobe to ISO to become a full open ISO
specification
@@ -4784,16 +3746,11 @@ specification
.br
.TP
-.BI 6.
+.BI 8.
ISO standard ISO/IEC 26300:2006
.br
.TP
-.BI 7.
-An open standard format for e-books
-
-.br
-.TP
.BI *1.
square brackets
@@ -4809,33 +3766,39 @@ square brackets
.br
.TP
-.BI 8.
+.BI 9.
<http://www.jus.uio.no/sisu/man/>
.br
.TP
-.BI 9.
+.BI 10.
<http://www.jus.uio.no/sisu/man/sisu.1.html>
.br
.TP
-.BI 10.
+.BI 11.
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
.TP
-.BI 11.
-files should be prepared using UTF-8 character encoding
+.BI 12.
+files should be prepared using
+
+.br
+.I UTF-8
+
+.br
+character encoding
.br
.TP
-.BI 12.
+.BI 13.
a footnote or endnote
.br
.TP
-.BI 13.
+.BI 14.
self contained endnote marker & endnote in one
.br
@@ -4860,17 +3823,17 @@ editors notes, numbered asterisk footnote/endnote series
.br
.TP
-.BI 14.
+.BI 15.
<http://www.sisudoc.org/>
.br
.TP
-.BI 15.
+.BI 16.
<http://www.ruby-lang.org/en/>
.br
.TP
-.BI 17.
+.BI 18.
Table from the Wealth of Networks by Yochai Benkler
.br
@@ -4878,7 +3841,7 @@ Table from the Wealth of Networks by Yochai Benkler
.br
.TP
-.BI 18.
+.BI 19.
\.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
@@ -4887,35 +3850,38 @@ appropriate suffix to use.
.br
.TP
-.BI 20.
+.BI 21.
<http://www.postgresql.org/>
.br
<http://advocacy.postgresql.org/>
+
.br
<http://en.wikipedia.org/wiki/Postgresql>
+
.br
.TP
-.BI 21.
+.BI 22.
<http://www.hwaci.com/sw/sqlite/>
.br
<http://en.wikipedia.org/wiki/Sqlite>
+
.br
.TP
-.BI 22.
+.BI 23.
<http://search.sisudoc.org>
.br
.TP
-.BI 23.
+.BI 24.
(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 24.
+.BI 25.
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
@@ -4924,62 +3890,25 @@ way we can tell you without opening each document where within each your
matches are found.
.br
-.TP
-.BI 25.
-There is nothing to stop MySQL support being added in future.
-.br
.TP
-.BI 26.
-<http://www.jus.uio.no/sisu/man/sisu.1.html>
-
-.br
-.TP
-.BI 27.
-<http://www.jus.uio.no/sisu/man/sisu.8.html>
-
-.br
-.TP
-.BI 28.
-<http://www.jus.uio.no/sisu/man>
-
-.br
-29. 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.
-
-.br
-30. named index.html or more extensively through sisu_manifest.html
-.br
-
.SH SEE ALSO
-.br
-\fIsisu\fR(1),
-.br
-\fIsisu\-epub\fR(1),
-.br
-\fIsisu\-harvest\fR(1),
-.br
-\fIsisu\-html\fR(1),
-.br
-\fIsisu\-odf\fR(1),
-.br
-\fIsisu\-pdf\fR(1),
-.br
-\fIsisu\-pg\fR(1),
-.br
-\fIsisu\-sqlite\fR(1),
-.br
-\fIsisu\-txt\fR(1).
-.br
-\fIsisu_vim\fR(7)
-
+ sisu(1),
+ sisu-epub(1),
+ sisu-harvest(1),
+ sisu-html(1),
+ sisu-odf(1),
+ sisu-pdf(1),
+ sisu-pg(1),
+ sisu-sqlite(1),
+ sisu-txt(1).
+ sisu_vim(7)
+.TP
.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>.
-
+ More information about SiSU can be found at <http://www.sisudoc.org/> or <http://www.jus.uio.no/sisu/>
+.TP
+.SH SOURCE
+ <http://sources.sisudoc.org/>
+.TP
.SH AUTHOR
-\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>.
+ SiSU is written by Ralph Amissah <ralph@amissah.com>