diff options
Diffstat (limited to 'man')
| -rw-r--r-- | man/man1/sisu-concordance.1 | 37 | ||||
| -rw-r--r-- | man/man1/sisu-epub.1 | 37 | ||||
| -rw-r--r-- | man/man1/sisu-harvest.1 | 37 | ||||
| -rw-r--r-- | man/man1/sisu-html-scroll.1 | 39 | ||||
| -rw-r--r-- | man/man1/sisu-html-seg.1 | 39 | ||||
| -rw-r--r-- | man/man1/sisu-html.1 | 37 | ||||
| -rw-r--r-- | man/man1/sisu-odf.1 | 37 | ||||
| -rw-r--r-- | man/man1/sisu-pdf-landscape.1 | 39 | ||||
| -rw-r--r-- | man/man1/sisu-pdf-portrait.1 | 39 | ||||
| -rw-r--r-- | man/man1/sisu-pdf.1 | 37 | ||||
| -rw-r--r-- | man/man1/sisu-pg.1 | 37 | ||||
| -rw-r--r-- | man/man1/sisu-sqlite.1 | 37 | ||||
| -rw-r--r-- | man/man1/sisu-txt.1 | 37 | ||||
| -rw-r--r-- | man/man1/sisu-webrick.1 | 117 | ||||
| -rw-r--r-- | man/man1/sisu.1 | 6165 | ||||
| -rw-r--r-- | man/man1/sisu_termsheet.1 | 60 | ||||
| -rw-r--r-- | man/man1/sisu_webrick.1 | 219 | ||||
| -rw-r--r-- | man/man7/sisu_vim.7 | 131 | ||||
| -rw-r--r-- | man/man8/sisu.8 | 333 |
19 files changed, 3326 insertions, 4188 deletions
diff --git a/man/man1/sisu-concordance.1 b/man/man1/sisu-concordance.1 new file mode 100644 index 00000000..f1eb4705 --- /dev/null +++ b/man/man1/sisu-concordance.1 @@ -0,0 +1,37 @@ +.TH SISU-CONCORDANCE 1 "2011-03-05" "2.8.1" "SiSU" + +.SH NAME +\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system + +.SH SYNOPSIS +\fBsisu\-concordance\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR + +.SH DESCRIPTION +\fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. +.PP +The \fBsisu\-concordance\fR command is an alias for \fBsisu \-\-concordance\fR (or \fBsisu \-w\fR) which produces an HTML concordance file (wordlist) of a SiSU markup file. + +.SH SEE ALSO +\fIsisu\fR(1), +.br +\fIsisu\-epub\fR(1), +.br +\fIsisu\-harvest\fR(1), +.br +\fIsisu\-html\fR(1), +.br +\fIsisu\-pdf\fR(1), +.br +\fIsisu\-odf\fR(1), +.br +\fIsisu\-pg\fR(1), +.br +\fIsisu\-sqlite\fR(1), +.br +\fIsisu\-txt\fR(1). + +.SH HOMEPAGE +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. + +.SH AUTHOR +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu-epub.1 b/man/man1/sisu-epub.1 new file mode 100644 index 00000000..bf4c2755 --- /dev/null +++ b/man/man1/sisu-epub.1 @@ -0,0 +1,37 @@ +.TH SISU-EPUB 1 "2011-03-05" "2.8.1" "SiSU" + +.SH NAME +\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system + +.SH SYNOPSIS +\fBsisu\-epub\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR + +.SH DESCRIPTION +\fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. +.PP +The \fBsisu\-epub\fR command is an alias for \fBsisu \-\-epub\fR (or \fBsisu \-e\fR) which produces EPUB output of a SiSU markup file. + +.SH SEE ALSO +\fIsisu\fR(1), +.br +\fIsisu\-concordance\fR(1), +.br +\fIsisu\-harvest\fR(1), +.br +\fIsisu\-html\fR(1), +.br +\fIsisu\-pdf\fR(1), +.br +\fIsisu\-odf\fR(1), +.br +\fIsisu\-pg\fR(1), +.br +\fIsisu\-sqlite\fR(1), +.br +\fIsisu\-txt\fR(1). + +.SH HOMEPAGE +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. + +.SH AUTHOR +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu-harvest.1 b/man/man1/sisu-harvest.1 new file mode 100644 index 00000000..35b7b9c9 --- /dev/null +++ b/man/man1/sisu-harvest.1 @@ -0,0 +1,37 @@ +.TH SISU-HARVEST 1 "2011-03-05" "2.8.1" "SiSU" + +.SH NAME +\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system + +.SH SYNOPSIS +\fBsisu\-harvest\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR + +.SH DESCRIPTION +\fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. +.PP +The \fBsisu\-harvest\fR command is an alias for \fBsisu \-\-harvest\fR which based on the @classify: :topic_register: headers in each SiSU markup file, produces HTML output in the form of an index of authors and their texts and an index of topics and related texts. + +.SH SEE ALSO +\fIsisu\fR(1), +.br +\fIsisu\-concordance\fR(1), +.br +\fIsisu\-epub\fR(1), +.br +\fIsisu\-html\fR(1), +.br +\fIsisu\-pdf\fR(1), +.br +\fIsisu\-odf\fR(1), +.br +\fIsisu\-pg\fR(1), +.br +\fIsisu\-sqlite\fR(1), +.br +\fIsisu\-txt\fR(1). + +.SH HOMEPAGE +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. + +.SH AUTHOR +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu-html-scroll.1 b/man/man1/sisu-html-scroll.1 new file mode 100644 index 00000000..a39fa7bf --- /dev/null +++ b/man/man1/sisu-html-scroll.1 @@ -0,0 +1,39 @@ +.TH SISU-HTML 1 "2013-11-08" "4.2.12" "SiSU" + +.SH NAME +\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system + +.SH SYNOPSIS +\fBsisu\-html\-scroll\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR + +.SH DESCRIPTION +\fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. +.PP +The \fBsisu\-html\-scroll\fR command is an alias for \fBsisu \-\-html\-scroll\fR which produces HTML single document (scroll) output of a SiSU markup file. + +.SH SEE ALSO +\fIsisu\fR(1), +.br +\fIsisu\-concordance\fR(1), +.br +\fIsisu\-epub\fR(1), +.br +\fIsisu\-harvest\fR(1), +.br +\fIsisu\-html\fR(1), +.br +\fIsisu\-pdf\fR(1), +.br +\fIsisu\-odf\fR(1), +.br +\fIsisu\-pg\fR(1), +.br +\fIsisu\-sqlite\fR(1), +.br +\fIsisu\-txt\fR(1). + +.SH HOMEPAGE +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. + +.SH AUTHOR +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu-html-seg.1 b/man/man1/sisu-html-seg.1 new file mode 100644 index 00000000..858bfb9a --- /dev/null +++ b/man/man1/sisu-html-seg.1 @@ -0,0 +1,39 @@ +.TH SISU-HTML 1 "2013-11-08" "4.2.12" "SiSU" + +.SH NAME +\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system + +.SH SYNOPSIS +\fBsisu\-html\-seg\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR + +.SH DESCRIPTION +\fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. +.PP +The \fBsisu\-html\-seg\fR command is an alias for \fBsisu \-\-html\-seg\fR (or \fBsisu \-h\fR) which produces HTML segmented output of a SiSU markup file. + +.SH SEE ALSO +\fIsisu\fR(1), +.br +\fIsisu\-concordance\fR(1), +.br +\fIsisu\-epub\fR(1), +.br +\fIsisu\-harvest\fR(1), +.br +\fIsisu\-html\fR(1), +.br +\fIsisu\-pdf\fR(1), +.br +\fIsisu\-odf\fR(1), +.br +\fIsisu\-pg\fR(1), +.br +\fIsisu\-sqlite\fR(1), +.br +\fIsisu\-txt\fR(1). + +.SH HOMEPAGE +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. + +.SH AUTHOR +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu-html.1 b/man/man1/sisu-html.1 new file mode 100644 index 00000000..205cb8d9 --- /dev/null +++ b/man/man1/sisu-html.1 @@ -0,0 +1,37 @@ +.TH SISU-HTML 1 "2011-03-05" "2.8.1" "SiSU" + +.SH NAME +\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system + +.SH SYNOPSIS +\fBsisu\-html\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR + +.SH DESCRIPTION +\fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. +.PP +The \fBsisu\-html\fR command is an alias for \fBsisu \-\-html\fR (or \fBsisu \-h\fR) which produces HTML output of a SiSU markup file. + +.SH SEE ALSO +\fIsisu\fR(1), +.br +\fIsisu\-concordance\fR(1), +.br +\fIsisu\-epub\fR(1), +.br +\fIsisu\-harvest\fR(1), +.br +\fIsisu\-pdf\fR(1), +.br +\fIsisu\-odf\fR(1), +.br +\fIsisu\-pg\fR(1), +.br +\fIsisu\-sqlite\fR(1), +.br +\fIsisu\-txt\fR(1). + +.SH HOMEPAGE +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. + +.SH AUTHOR +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu-odf.1 b/man/man1/sisu-odf.1 new file mode 100644 index 00000000..18df172f --- /dev/null +++ b/man/man1/sisu-odf.1 @@ -0,0 +1,37 @@ +.TH SISU-ODF 1 "2011-03-05" "2.8.1" "SiSU" + +.SH NAME +\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system + +.SH SYNOPSIS +\fBsisu\-odf\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR + +.SH DESCRIPTION +\fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. +.PP +The \fBsisu\-odf\fR command is an alias for \fBsisu \-\-odt\fR (or \fBsisu \-o\fR) which produces OpenDocument output of a SiSU markup file. + +.SH SEE ALSO +\fIsisu\fR(1), +.br +\fIsisu\-concordance\fR(1), +.br +\fIsisu\-epub\fR(1), +.br +\fIsisu\-harvest\fR(1), +.br +\fIsisu\-html\fR(1), +.br +\fIsisu\-pdf\fR(1), +.br +\fIsisu\-pg\fR(1), +.br +\fIsisu\-sqlite\fR(1), +.br +\fIsisu\-txt\fR(1). + +.SH HOMEPAGE +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. + +.SH AUTHOR +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu-pdf-landscape.1 b/man/man1/sisu-pdf-landscape.1 new file mode 100644 index 00000000..080c8bfc --- /dev/null +++ b/man/man1/sisu-pdf-landscape.1 @@ -0,0 +1,39 @@ +.TH SISU-PDF 1 "2011-03-05" "2.8.1" "SiSU" + +.SH NAME +\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system + +.SH SYNOPSIS +\fBsisu\-pdf\-landscape\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR + +.SH DESCRIPTION +\fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. +.PP +The \fBsisu\-pdf\-landscape\fR command is an alias for \fBsisu \-\-pdf\-landscape\fR which produces PDF landscape output of a SiSU markup file. + +.SH SEE ALSO +\fIsisu\fR(1), +.br +\fIsisu\-concordance\fR(1), +.br +\fIsisu\-epub\fR(1), +.br +\fIsisu\-harvest\fR(1), +.br +\fIsisu\-html\fR(1), +.br +\fIsisu\-pdf\fR(1), +.br +\fIsisu\-odf\fR(1), +.br +\fIsisu\-pg\fR(1), +.br +\fIsisu\-sqlite\fR(1), +.br +\fIsisu\-txt\fR(1). + +.SH HOMEPAGE +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. + +.SH AUTHOR +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu-pdf-portrait.1 b/man/man1/sisu-pdf-portrait.1 new file mode 100644 index 00000000..e0e734fb --- /dev/null +++ b/man/man1/sisu-pdf-portrait.1 @@ -0,0 +1,39 @@ +.TH SISU-PDF 1 "2011-03-05" "2.8.1" "SiSU" + +.SH NAME +\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system + +.SH SYNOPSIS +\fBsisu\-pdf\-portrait\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR + +.SH DESCRIPTION +\fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. +.PP +The \fBsisu\-pdf\-portrait\fR command is an alias for \fBsisu \-\-pdf\-portrait\fR which produces PDF portrait output of a SiSU markup file. + +.SH SEE ALSO +\fIsisu\fR(1), +.br +\fIsisu\-concordance\fR(1), +.br +\fIsisu\-epub\fR(1), +.br +\fIsisu\-harvest\fR(1), +.br +\fIsisu\-html\fR(1), +.br +\fIsisu\-pdf\fR(1), +.br +\fIsisu\-odf\fR(1), +.br +\fIsisu\-pg\fR(1), +.br +\fIsisu\-sqlite\fR(1), +.br +\fIsisu\-txt\fR(1). + +.SH HOMEPAGE +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. + +.SH AUTHOR +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu-pdf.1 b/man/man1/sisu-pdf.1 new file mode 100644 index 00000000..07cd526d --- /dev/null +++ b/man/man1/sisu-pdf.1 @@ -0,0 +1,37 @@ +.TH SISU-PDF 1 "2011-03-05" "2.8.1" "SiSU" + +.SH NAME +\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system + +.SH SYNOPSIS +\fBsisu\-pdf\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR + +.SH DESCRIPTION +\fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. +.PP +The \fBsisu\-pdf\fR command is an alias for \fBsisu \-\-pdf\fR (or \fBsisu \-p\fR) which produces PDF output of a SiSU markup file. + +.SH SEE ALSO +\fIsisu\fR(1), +.br +\fIsisu\-concordance\fR(1), +.br +\fIsisu\-epub\fR(1), +.br +\fIsisu\-harvest\fR(1), +.br +\fIsisu\-html\fR(1), +.br +\fIsisu\-odf\fR(1), +.br +\fIsisu\-pg\fR(1), +.br +\fIsisu\-sqlite\fR(1), +.br +\fIsisu\-txt\fR(1). + +.SH HOMEPAGE +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. + +.SH AUTHOR +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu-pg.1 b/man/man1/sisu-pg.1 new file mode 100644 index 00000000..094b84d5 --- /dev/null +++ b/man/man1/sisu-pg.1 @@ -0,0 +1,37 @@ +.TH SISU-PG 1 "2011-03-05" "2.8.1" "SiSU" + +.SH NAME +\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system + +.SH SYNOPSIS +\fBsisu\-pq\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR + +.SH DESCRIPTION +\fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. +.PP +The \fBsisu\-pq\fR command is an alias for \fBsisu \-\-pg\fR (or \fBsisu \-D\fR) which populates a PostgreSQL database with SiSU content (for search) from a SiSU markup file. + +.SH SEE ALSO +\fIsisu\fR(1), +.br +\fIsisu\-concordance\fR(1), +.br +\fIsisu\-epub\fR(1), +.br +\fIsisu\-harvest\fR(1), +.br +\fIsisu\-html\fR(1), +.br +\fIsisu\-pdf\fR(1), +.br +\fIsisu\-odf\fR(1), +.br +\fIsisu\-sqlite\fR(1), +.br +\fIsisu\-txt\fR(1). + +.SH HOMEPAGE +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. + +.SH AUTHOR +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu-sqlite.1 b/man/man1/sisu-sqlite.1 new file mode 100644 index 00000000..96e091be --- /dev/null +++ b/man/man1/sisu-sqlite.1 @@ -0,0 +1,37 @@ +.TH SISU-SQLITE 1 "2011-03-05" "2.8.1" "SiSU" + +.SH NAME +\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system + +.SH SYNOPSIS +\fBsisu\-sqlite\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR + +.SH DESCRIPTION +\fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. +.PP +The \fBsisu\-sqlite\fR command is an alias for \fBsisu \-\-sqlite\fR (or \fBsisu \-d\fR) which populates a SQLite database with SiSU content (for search) from a SiSU markup file. + +.SH SEE ALSO +\fIsisu\fR(1), +.br +\fIsisu\-concordance\fR(1), +.br +\fIsisu\-epub\fR(1), +.br +\fIsisu\-harvest\fR(1), +.br +\fIsisu\-html\fR(1), +.br +\fIsisu\-pdf\fR(1), +.br +\fIsisu\-odf\fR(1), +.br +\fIsisu\-pg\fR(1), +.br +\fIsisu\-txt\fR(1). + +.SH HOMEPAGE +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. + +.SH AUTHOR +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu-txt.1 b/man/man1/sisu-txt.1 new file mode 100644 index 00000000..87fa6625 --- /dev/null +++ b/man/man1/sisu-txt.1 @@ -0,0 +1,37 @@ +.TH SISU-TXT 1 "2011-03-05" "2.8.1" "SiSU" + +.SH NAME +\fBSiSU\fR \- Structured information, Serialized Units \- a document publishing system + +.SH SYNOPSIS +\fBsisu\-txt\fR \fIsisu_document.sst\fR | \fIsisu_document.ssm\fR + +.SH DESCRIPTION +\fBSiSU\fR is a lightweight markup based document structuring, publishing and search framework for document collections. +.PP +The \fBsisu\-txt\fR command is an alias for \fBsisu \-\-txt\fR (or \fBsisu \-t\fR) which produces plain text output of a SiSU markup file. + +.SH SEE ALSO +\fIsisu\fR(1), +.br +\fIsisu\-concordance\fR(1), +.br +\fIsisu\-epub\fR(1), +.br +\fIsisu\-harvest\fR(1), +.br +\fIsisu\-html\fR(1), +.br +\fIsisu\-pdf\fR(1), +.br +\fIsisu\-odf\fR(1), +.br +\fIsisu\-pg\fR(1), +.br +\fIsisu\-sqlite\fR(1). + +.SH HOMEPAGE +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. + +.SH AUTHOR +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu-webrick.1 b/man/man1/sisu-webrick.1 new file mode 100644 index 00000000..2cfe9455 --- /dev/null +++ b/man/man1/sisu-webrick.1 @@ -0,0 +1,117 @@ +.TH "sisu_webrick" "1" "2007-09-16" "0.59.1" "SiSU" +.SH NAME +sisu \- documents: structuring, publishing in multiple formats, and search +.SH SYNOPSIS +sisu \-W +.SH +SISU \- SISU_WEBRICK, +RALPH AMISSAH +.BR + +.SH +SISU WEBRICK +.BR + +.SH +1. SISU_WEBRICK +.BR + +.SH +1.1 NAME + +.BR +.B SiSU +\- Structured information, Serialized Units - a document publishing system + +.SH +1.2 SYNOPSIS + +.BR +sisu_webrick \ [port] + +.BR +or + +.BR +sisu --Webrick \ [port] + +.BR +or + +.BR +sisu -W \ [port] + +.SH +1.3 DESCRIPTION + +.BR +sisu_webrick is part of +.B SiSU +(man sisu) sisu_webrick starts +.B Ruby +\'s Webrick web-server and points it to the directories to which +.B SiSU +output is written, providing a list of these directories (assuming +.B SiSU +is in use and they exist). + +.BR +The default port for sisu_webrick is set to 8081, this may be modified in the +yaml file: ~/.sisu/sisurc.yml a sample of which is provided as +/etc/sisu/sisurc.yml (or in the equivalent directory on your system). + +.SH +1.4 SUMMARY OF MAN PAGE + +.BR +sisu_webrick, may be started on it\'s own with the command: sisu_webrick \ +[port] or using the sisu command with the -W flag: sisu -W \ [port] + +.BR +where no port is given and settings are unchanged the default port is 8081 + +.SH +1.5 DOCUMENT PROCESSING COMMAND FLAGS + +.BR +sisu -W \ [port] starts +.B Ruby +Webrick web-server, serving +.B SiSU +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 +1.6 FURTHER INFORMATION + +.BR +For more information on +.B SiSU +see: <http://www.jus.uio.no/sisu> + +.BR +or man sisu + +.SH +1.7 AUTHOR + +.BR +Ralph Amissah ralph@amissah.com or ralph.amissah@gmail.com + +.SH +1.8 SEE ALSO + +.BR + sisu(1) + +.BR + sisu_vim(7) + +.BR + sisu(8) + +.SH HOMEPAGE +More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. + +.SH AUTHOR +\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. diff --git a/man/man1/sisu.1 b/man/man1/sisu.1 index fc8f3a77..8f1b1d91 100644 --- a/man/man1/sisu.1 +++ b/man/man1/sisu.1 @@ -1,611 +1,824 @@ -.TH "sisu" "1" "2008-12-14" "0.70.1" "SiSU" +.TH "sisu" "1" "2014-02-05" "7.1.5" "SiSU" +.br .SH NAME +.br sisu \- documents: markup, structuring, publishing in multiple standard formats, and search +.br .SH SYNOPSIS -sisu [\-abcDdFHhIiMmNnopqRrSsTtUuVvwXxYyZz0\-9] [filename/wildcard ] -.BR -sisu [\-Ddcv] [instruction] -.BR +.br +sisu [\-short\-options|\-\-long\-options] [filename/wildcard] + +.br +sisu [\-abCcDdeFGghIikLMmNnoPpQqRrSsTtUuVvWwXxYyZ_0\-9] [filename/wildcard] + +.br +sisu \-\-txt \-\-html \-\-epub \-\-odt \-\-pdf \-\-wordmap \-\-sqlite \-\-manpage \-\-texinfo \-\-sisupod \-\-source \-\-qrcode [filename/wildcard] + +.br +sisu [\-Ddcv] [instruction] [filename/wildcard] + +.br +sisu \-\-pg (\-\-createdb|update [filename/wildcard]|\-\-dropall) + +.br +sisu [operations] + +.br sisu [\-CcFLSVvW] -.SH -SISU \- MANUAL, + +.br +sisu (\-\-configure|\-\-webrick|\-\-sample\-search\-form) +.SH SISU - MANUAL, RALPH AMISSAH -.BR -.SH -WHAT IS SISU? -.BR +.SH WHAT IS SISU? -.SH -1. INTRODUCTION \- WHAT IS SISU? -.BR +.SH INTRODUCTION - WHAT IS SISU? -.BR -.B SiSU -is a framework for document structuring, publishing (in multiple open -standard formats) and search, comprising of: (a) a lightweight document -structure and presentation markup syntax; and (b) an accompanying engine for -generating standard document format outputs from documents prepared in sisu -markup syntax, which is able to produce multiple standard outputs (including -the population of sql databases) that (can) share a common numbering system for -the citation of text within a document. .BR -.B SiSU -is developed under an open source, software libre license (GPL3). Its use -case for development is to cope with medium to large document sets with -evolving markup related technologies, which should be prepared once, and for -which you want multiple output formats that can be updated and a common -mechanism for cross\-output\-format citation, and search. -.BR .B SiSU -both defines a markup syntax and provides an engine that produces open -standards format outputs from documents prepared with +is a lightweight markup based document creation and publishing framework that +is controlled from the command line. Prepare documents for .B SiSU -markup. From a single lightly prepared document sisu custom builds several -standard output formats which share a common (text object) numbering system for -citation of content within a document (that also has implications for search). -The sisu engine works with an abstraction of the document\'s structure and -content from which it is possible to generate different forms of representation -of the document. Significantly +using your text editor of choice, then use .B SiSU -markup is more sparse than html and outputs which include html, LaTeX, -landscape and portrait pdfs, Open Document Format (ODF), all of which can be -added to and updated. -.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. +to generate various output document formats. .BR -Source document preparation and output generation is a two step process: (i) -document source is prepared, that is, marked up in sisu markup syntax and (ii) -the desired output subsequently generated by running the sisu engine against -document source. Output representations if updated (in the sisu engine) can be -generated by re\-running the engine against the prepared source. Using -.B SiSU -markup applied to a document, +From a single lightly prepared document (plain-text +.I UTF-8 +) sisu custom builds several standard output formats which share a common (text +object) numbering system for citation of content within a document (that also +has implications for search). The sisu engine works with an abstraction of the +document's structure and content from which it is possible to generate +different forms of representation of the document. .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, 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. - -.BR -In preparing a -.B SiSU -document you optionally provide semantic information related to the document -in a document header, and in marking up the substantive text provide -information on the structure of the document, primarily indicating heading -levels and footnotes. You also provide information on basic text attributes -where used. The rest is automatic, sisu from this information custom builds[^2] -the different forms of output requested. - -.BR -.B SiSU -works with an abstraction of the document based on its structure which is -comprised of its structure (or frame)[^3] and the objects[^4] it contains, -which enables -.B SiSU -to represent the document in many different ways, and to take advantage of -the strengths of different ways of presenting documents. The objects are -numbered, and these numbers can be used to provide a common base for citing -material within a document across the different output format types. This is -significant as page numbers are not well suited to the digital age, in web -publishing, changing a browser\'s default font or using a different browser -means that text appears on different pages; and in publishing in different -formats, html, landscape and portrait pdf etc. again page numbers are of no use -to cite text in a manner that is relevant against the different output types. -Dealing with documents at an object level together with object numbering also -has implications for search. - -.BR -One of the challenges of maintaining documents is to keep them in a format that -would allow users to use them without depending on a proprietary software -popular at the time. Consider the ease of dealing with legacy proprietary -formats today and what guarantee you have that old proprietary formats will -remain (or can be read without proprietary software/equipment) in 15 years -time, or the way the way in which html has evolved over its relatively short -span of existence. -.B SiSU -provides the flexibility of outputing documents in multiple non\-proprietary -open formats including html, pdf[^5] and the ISO standard ODF.[^6] Whilst -.B SiSU -relies on software, the markup is uncomplicated and minimalistic which -guarantees that future engines can be written to run against it. It is also -easily converted to other formats, which means documents prepared in -.B SiSU -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. -.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), and existing output to be -updated (html has evolved and the related module has been updated repeatedly -over the years, presumably when the World Wide Web Consortium (w3c) finalises -html 5 which is currently under development, the html module will again be -updated allowing all existing documents to be regenerated as html 5). +produces: plain-text, +.I HTML, +.I XHTML, +.I XML, +.I EPUB, +.I ODF: +.I ODT +(Opendocument), +.I LaTeX, +.I PDF, +and populates an +.I SQL +database ( +.I PostgreSQL +or +.I SQLite +) with text objects, roughly, paragraph sized chunks so that document searches +are done at this level of granularity. .BR -The document formats are written to the file\-system and available for indexing -by independent indexing tools, whether off the web like Google and Yahoo or on -the site like Lucene and Hyperestraier. +Outputs share a common citation numbering system, associated with text objects +and any semantic meta-data provided about the document. .BR -.B SiSU -also provides other features such as concordance files and document content -certificates, and the working against an abstraction of document structure has -further possibilities for the research and development of other document -representations, the availability of objects is useful for example for topic -maps and the commercial law thesaurus by Vikki Rogers and Al Krtizer, together -with the flexibility of -.B SiSU -offers great possibilities. -.BR -.B SiSU -is primarily for published works, which can take advantage of the citation -system to reliably reference its documents. .B SiSU -works well in a complementary manner with such collaborative technologies as -Wikis, which can take advantage of and be used to discuss the substance of -content prepared in -.B SiSU -. +also provides concordance files, document content certificates and manifests of +generated output. Book indexes may be made. .BR -<http://www.jus.uio.no/sisu> +Some document markup samples are provided in the package sisu -markup-samples. +Homepages: -.SH -2. COMMANDS SUMMARY -.BR +* <http://www.sisudoc.org/> -.SH -2.1 SYNOPSIS +* <http://www.jus.uio.no/sisu> -.BR -.B SiSU -\- Structured information, Serialized Units \- a document publishing system -.BR -sisu [ \ \-abcDdFHhIiMmNnopqRrSsTtUuVvwXxYyZz0\-9 \ ] [ \ filename/ \ wildcard -\ ] +.SH COMMANDS SUMMARY -.BR -sisu [ \ \-Ddcv \ ] [ \ instruction \ ] +.SH DESCRIPTION -.BR -sisu [ \ \-CcFLSVvW \ ] .BR -Note: commands should be issued from within the directory that contains the -marked up files, cd to markup directory. - -.SH -2.2 DESCRIPTION -.BR -.B SiSU .B SiSU -is a document publishing system, that from a simple single marked\-up -document, produces multiple of output formats including: plaintext, html, -LaTeX, pdf, xhtml, XML, info, and SQL (PostgreSQL and SQLite), which share -numbered text objects (\"object citation numbering\") and the same document -structure information. For more see: <http://www.jus.uio.no/sisu> - -.SH -2.3 DOCUMENT PROCESSING COMMAND FLAGS +is a document publishing system, that from a simple single marked-up document, +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 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) - +.B -[0-9] [filename/wildcard] +see --act .TP -.B \-b [filename/wildcard] -produces xhtml/XML output for browser viewing (sax parsing). - +.B --ao [filename/wildcard/url] +assumed for most other flags, creates new intermediate files for processing +(abstract objects, document abstraction) that is used in all subsequent +processing of other output. This step is assumed for most processing flags. To +skip it see -n. Alias -m. +.TP +.B --act[s0-9] [filename/wildcard] +--act0 to --act9 configurable shortcuts for multiple flags, -0 to -9 synonyms, +configure in sisurc.yml; sisu default action on a specified file where no flag +is provided is --act0; --act or --acts for information on current actions +ascribed to --act0 to --act9 +.TP +.B --asciidoc [filename/wildcard] +asciidoc, smart text (not available) +.TP +.B -b [filename/wildcard] +see --xhtml +.TP +.B --by-* +see --output-by-* .TP -.B \-C [\-\-init\-site] +.B -C configure/initialise shared output directory files initialize shared output directory (config files such as css and dtd files are not updated if they -already exist unless modifier is used). \-C \-\-init\-site configure/initialise -site more extensive than \-C on its own, shared output directory files/force +already exist unless modifier is used). -C --init-site configure/initialise +site more extensive than -C on its own, shared output directory files/force update, existing shared output config files such as css and dtd files are updated if this modifier is used. - .TP -.B \-CC +.B -c [filename/wildcard] +see --color-toggle +.TP +.B --color +see --color-on +.TP +.B --color-off +turn off color in output to terminal +.TP +.B --color-on +turn on color in output to terminal +.TP +.B --color-toggle [filename/wildcard] +screen toggle ansi screen colour on or off depending on default set (unless -c +flag is used: if sisurc colour default is set to 'true', output to screen will +be with colour, if sisurc colour default is set to 'false' or is undefined +screen output will be without colour). Alias -c +.TP +.B --configure configure/initialise shared output directory files initialize shared output directory (config files such as css and dtd files are not updated if they -already exist unless modifier is used). The equivalent of: \-C \-\-init\-site -configure/initialise site, more extensive than \-C on its own, shared output +already exist unless modifier is used). The equivalent of: -C --init-site +configure/initialise site, more extensive than -C on its own, shared output directory files/force update, existing shared output config files such as css -and dtd files are updated if \-CC is used. - +and dtd files are updated if -CC is used. .TP -.B \-c [filename/wildcard] -screen toggle ansi screen colour on or off depending on default set (unless -\-c flag is used: if sisurc colour default is set to \'true\', output to screen -will be with colour, if sisurc colour default is set to \'false\' or is -undefined screen output will be without colour). - +.B --concordance [filename/wildcard] +produces concordance (wordmap) a rudimentary index of all the words in a +document. (Concordance files are not generated for documents of over 260,000 +words unless this limit is increased in the file sisurc.yml). Alias -w .TP -.B \-D [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. - +.B -d [filename/wildcard/url] +see --docbook .TP -.B \-d [\-\-db\-[database \ type \ (sqlite|pg)]] \-\-[instruction] [filename] -database type default set to sqlite, (for which \-\-sqlite may be used -instead) or to specify another database \-\-db\-[pgsql, \ sqlite] (however see -\-D) possible instructions include: \-\-createdb; \-\-create; \-\-dropall; -\-\-import [filename]; \-\-update [filename]; \-\-remove [filename]; see -database section below. - +.B --dal [filename/wildcard/url] +(abstract objects, document abstraction renamed abstract objects in sisu5) see +--ao .TP -.B \-F [\-\-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 -\-\-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 -present work directory which must be writable, (with screen instructions given -that they be copied to the cgi\-bin directory). \-Fv (in addition to the above) -provides some information on setting up hyperestraier for sisu - +.B --delete [filename/wildcard] +see --zap .TP -.B \-H [filename/wildcard] -produces html without link suffixes (.html \.pdf etc.) (\"Hide\"). Requires -an appropriately configured web server. [behaviour \ switched \ after \ 0.35 \ -see \ \-h]. - +.B --digests [filename/wildcard/url] +document digest or document content certificate ( DCC ) as sha digest tree of +the document: the digest for the document, and digests for each object +contained within the document (together with information on software versions +that produced it) (digest.txt). --digests -V for verbose digest output to +screen. .TP -.B \-h [filename/wildcard] -produces html (with hardlinks i.e. with name suffixes in links/local urls). -html, with internal document links that include the document suffix, i.e. -whether it is \.html or \.pdf (required for browsing directly off a file -system, and works with most web servers). [behaviour \ switched \ after \ 0.35 -\ see \ \-H]. - +.B --docbook [filename/wildcard/url] +docbook xml .TP -.B \-I [filename/wildcard] -produces texinfo and info file, (view with pinfo). - +.B --dom [filename/wildcard/url] +see --xml-dom .TP -.B \-i [filename/wildcard] -produces man page of file, not suitable for all outputs. - +.B --dump[=directory_path] [filename/wildcard] +places output in directory specified, if none is specified in the current +directory (pwd). Unlike using default settings +.I HTML +files have embedded css. Compare --redirect .TP -.B \-L -prints license information. - +.B -e [filename/wildcard] +see --epub .TP -.B \-M [filename/wildcard/url] -maintenance mode files created for processing preserved and their locations -indicated. (also see \-V) - +.B --epub [filename/wildcard] +produces an epub document, [sisu version >=2 ] (filename.epub). Alias -e .TP -.B \-m [filename/wildcard/url] -assumed for most other flags, creates new meta\-markup file, (the metaverse ) -that is used in all subsequent processing of other output. This step is assumed -for most processing flags. To skip it see \-n - +.B --errors-as-warnings +override stop processing on error. Alias --no-stop .TP -.B \-N [filename/wildcard/url] -document digest or document content certificate ( DCC ) as md5 digest tree of -the document: the digest for the document, and digests for each object -contained within the document (together with information on software versions -that produced it) (digest.txt). \-NV for verbose digest output to screen. - +.B --exc-* +exclude output feature, overrides configuration settings --exc-numbering, see +--exc-ocn; --exc-ocn, (exclude "object citation numbering", (switches off +object citation numbers), 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 \-n [filename/wildcard/url] -skip meta\-markup (building of \"metaverse\"), this skips the equivalent of -\-m which is otherwise assumed by most processing flags. - +.B -F [--webserv=webrick] +see --sample-search-form .TP -.B \-o [filename/wildcard/url] -output basic document in opendocument file format (opendocument.odt). - +.B -f [optional string part of filename] +see --find +.TP +.B --fictionbook [filename/wildcard/url] +fictionbook xml (not available) +.TP +.B --find [optional string part of filename] +see --glob +.TP +.B -G [optional string part of filename] +see --glob +.TP +.B -g [filename/wildcard] +see --git +.TP +.B --git [filename/wildcard] +produces or updates markup source file structure in a git repo (experimental +and subject to change). Alias -g +.TP +.B --glob [optional string part of filename] +without match string, glob all .sst .ssm files in directory (including language +subdirectories). With match string, find files that match given string in +directory (including language subdirectories). Alias -G, -f, --find +.TP +.B -h [filename/wildcard] +see --html +.TP +.B --harvest *.ss[tm] +makes two lists of sisu output based on the sisu markup documents in a +directory: list of author and authors works (year and titles), and; list by +topic with titles and author. Makes use of header metadata fields (author, +title, date, topic_register). Can be used with maintenance (-M) and remote +placement (-R) flags. .TP -.B \-p [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). +.B --html [filename/wildcard] +produces html output, in two forms (i) segmented text with table of contents +(toc.html and index.html) and (ii) the document in a single file (scroll.html). +Alias -h +.TP +.B --html-scroll [filename/wildcard] +produces html output, the document in a single file (scroll.html) only. Compare +--html-seg and --html +.TP +.B --html-seg [filename/wildcard] +produces html output, segmented text with table of contents (toc.html and +index.html). Compare --html-scroll and --html +.TP +.B --html-strict [filename/wildcard] +produces html with --strict option. see --strict +.TP +.B -I [filename/wildcard] +see --texinfo +.TP +.B -i [filename/wildcard] +see --manpage +.TP +.B --i18n-* +these flags affect output by filetype and filename): --i18n-mono +(--monolingual) output filenames without language code for default language +('en' or as set); --i18n-multi (--multilingual) language code provided as part +of the output filename, this is the default. Where output is in one language +only the language code may not be desired. see also --output-by-* +.TP +.B --inc-* +include output feature, overrides configuration settings, (usually the default +if none set), has precedence over --exc-* (exclude output feature). Some detail +provided under --exc-*, see --exc-* +.TP +.B -j [filename/wildcard] +copies images associated with a file for use by html, xhtml & xml outputs +(automatically invoked by --dump & redirect). +.TP +.B -k +see --color-off +.TP +.B --keep-processing-files [filename/wildcard/url] +see --maintenance +.TP +.B -M [filename/wildcard/url] +see --maintenance +.TP +.B -m [filename/wildcard/url] +see --dal (document abstraction level/layer) +.TP +.B --machine [filename/wildcard/url] +see --dal (document abstraction level/layer) +.TP +.B --maintenance [filename/wildcard/url] +maintenance mode, interim processing files are preserved and their locations +indicated. (also see -V). Aliases -M and --keep-processing-files. +.TP +.B --manifest [filename/wildcard] +produces an html summary of output generated (hyperlinked to content) and +document specific metadata (sisu_manifest.html). This step is assumed for most +processing flags. +.TP +.B --manpage [filename/wildcard] +produces man page of file, not suitable for all outputs. Alias -i +.TP +.B --markdown [filename/wildcard/url] +markdown smart text (not available) +.TP +.B --monolingual +see --i18n-* +.TP +.B --multilingual +see --i18n-* +.TP +.B -N [filename/wildcard/url] +see --digests +.TP +.B -n [filename/wildcard/url] +skip the creation of intermediate processing files (document abstraction) if +they already exist, this skips the equivalent of -m which is otherwise assumed +by most processing flags. +.TP +.B --no-* +see --exc-* +.TP +.B --no-stop +override stop processing on error. Alias --erros-as-warnings +.TP +.B --numbering +turn on "object citation numbers". See --inc-ocn and --exc-ocn +.TP +.B -o [filename/wildcard/url] +see --odt +.TP +.B --ocn +"object citation numbers". See --inc-ocn and --exc-ocn +.TP +.B --odf [filename/wildcard/url] +see --odt +.TP +.B --odt [filename/wildcard/url] +output basic document in opendocument file format (opendocument.odt). Alias -o +.TP +.B --output-by-* +select output directory structure from 3 alternatives: --output-by-language, +(language directory (based on language code) with filetype (html, epub, pdf +etc.) subdirectories); --output-by-filetype, (filetype directories with +language code as part of filename); --output-by-filename, (filename directories +with language code as part of filename). This is configurable. Alias --by-* +.TP +.B -P [language_directory/filename language_directory] +see --po4a +.TP +.B -p [filename/wildcard] +see --pdf +.TP +.B --papersize-(a4|a5|b5|letter|legal) +in conjunction with --pdf set pdf papersize, overriding any configuration +settings, to set more than one papersize repeat the option --pdf --papersize-a4 +--papersize-letter. See also --papersize=* + +.BR +.B --papersize=a4,a5,b5,letter,legal +in conjunction with --pdf set pdf papersize, overriding any configuration +settings, to set more than one papersize list after the equal sign with a comma +separator --papersize=a4,letter. See also --papersize-* +.TP +.B --pdf [filename/wildcard] +produces +.I LaTeX +pdf (portrait.pdf & landscape.pdf). Orientation and papersize may be set on the +command-line. 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), and; --landscape or --portrait, so: e.g. "sisu +--pdf-a4 --pdf-letter --landscape --verbose [filename/wildcard]" or "sisu --pdf +--landscape --a4 --letter --verbose [filename/wildcard]". --pdf defaults to +both landscape & portrait output, and a4 if no other papersizes are configured. +Related options --pdf-landscape --pdf-portrait --pdf-papersize-* +--pdf-papersize=[list]. Alias -p +.TP +.B --pdf-l [filename/wildcard] +See --pdf-landscape +.TP +.B --pdf-landscape [filename/wildcard] +sets orientation, produces +.I LaTeX +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). Related options --pdf --pdf-portrait. See also +--papersize-* or --papersize=[list]. Alias --pdf-l or in conjunction with --pdf +--landscape +.TP +.B --pdf-p [filename/wildcard] +See --pdf-portrait +.TP +.B --pdf-portrait [filename/wildcard] +sets orientation, produces +.I LaTeX +pdf portrait.pdf.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). Related options --pdf --pdf-landscape. See also +--papersize-* or --papersize=[list]. Alias --pdf-p or in conjunction with --pdf +--portrait +.TP +.B --pg-[instruction] [filename] +database +.I PostgreSQL +( --pgsql may be used instead) possible instructions, include: --pg-createdb; +--pg-create; --pg-dropall; --pg-import [filename]; --pg-update [filename]; +--pg-remove [filename]; see database section below. .TP -.B \-q [filename/wildcard] +.B --po [language_directory/filename language_directory] +see --po4a +.TP +.B --po4a [language_directory/filename language_directory] +produces .pot and po files for the file in the languages specified by the +language directory. +.B SiSU +markup is placed in subdirectories named with the language code, e.g. en/ fr/ +es/. The sisu config file must set the output directory structure to +multilingual. v3, experimental +.TP +.B -Q [filename/wildcard] +see --qrcode +.TP +.B -q [filename/wildcard] +see --quiet +.TP +.B --qrcode [filename/wildcard] +generate QR code image of metadata (used in manifest). +.TP +.B --quiet [filename/wildcard] quiet less output to screen. - .TP -.B \-R [filename/wildcard] +.B -R [filename/wildcard] +see --rsync +.TP +.B -r [filename/wildcard] +see --scp +.TP +.B --redirect[=directory_path] [filename/wildcard] +places output in subdirectory under specified directory, subdirectory uses the +filename (without the suffix). If no output directory is specified places the +subdirectory under the current directory (pwd). Unlike using default settings +.I HTML +files have embedded css. Compare --dump +.TP +.B --rst [filename/wildcard/url] +ReST (rST restructured text) smart text (not available) +.TP +.B --rsync [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 - +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 --scp. Alias -R +.TP +.B -S +see --sisupod +.TP +.B -S [filename/wildcard] +see --sisupod +.TP +.B -s [filename/wildcard] +see --source +.TP +.B --sample-search-form [--db-(pg|sqlite)] +generate examples of (naive) cgi search form for +.I SQLite +or PgSQL depends on your already having used sisu to populate an +.I SQLite +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 +--sqlite & --pg and the database section below. Optional additional parameters: +--db-user='www-data'. The samples are dumped in the present work directory +which must be writable, (with screen instructions given that they be copied to +the cgi-bin directory). Alias -F +.TP +.B --sax [filename/wildcard/url] +see --xml-sax .TP -.B \-r [filename/wildcard] +.B --scp [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 - +that you have your "keys" and ssh agent in place. Also see --rsync. Alias -r +.TP +.B --sha256 +set hash digest where used to sha256 +.TP +.B --sha512 +set hash digest where used to sha512 .TP -.B \-S +.B --sqlite-[instruction] [filename] +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 +.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: --sqlite-createdb; --sqlite-create; +--sqlite-dropall; --sqlite-import [filename]; --sqlite-update [filename]; +--sqlite-remove [filename]); see database section below. +.TP +.B --sisupod produces a sisupod a zipped sisu directory of markup files including sisu markup source files and the directories local configuration file, images and skins. Note: this only includes the configuration files or skins contained in - \./_sisu not those in ~/.sisu \-S [filename/wildcard] option. Note: (this -option is tested only with zsh). - -.TP -.B \-S [filename/wildcard] -produces a zipped file of the prepared document specified along with -associated images, by default named sisupod.zip they may alternatively be named -with the filename extension \.ssp This provides a quick way of gathering the -relevant parts of a sisu document which can then for example be emailed. A -sisupod includes sisu markup source file, (along with associated documents if a -master file, or available in multilingual versions), together with related -images and skin. +./_sisu not those in ~/.sisu -S [filename/wildcard] option. Note: (this option +is tested only with zsh). Alias -S +.TP +.B --sisupod [filename/wildcard] +produces a zipped file of the prepared document specified along with associated +images, by default named sisupod.zip they may alternatively be named with the +filename extension .ssp This provides a quick way of gathering the relevant +parts of a sisu document which can then for example be emailed. A sisupod +includes sisu markup source file, (along with associated documents if a master +file, or available in multilingual versions), together with related images and +skin. .B SiSU -commands can be run directly against a sisupod contained in a local -directory, or provided as a url on a remote site. As there is a security issue -with skins provided by other users, they are not applied unless the flag -\-\-trust or \-\-trusted is added to the command instruction, it is recommended -that file that are not your own are treated as untrusted. The directory -structure of the unzipped file is understood by sisu, and sisu commands can be -run within it. Note: if you wish to send multiple files, it quickly becomes -more space efficient to zip the sisu markup directory, rather than the -individual files for sending). See the \-S option without [filename/wildcard]. - +commands can be run directly against a sisupod contained in a local directory, +or provided as a url on a remote site. As there is a security issue with skins +provided by other users, they are not applied unless the flag --trust or +--trusted is added to the command instruction, it is recommended that file that +are not your own are treated as untrusted. The directory structure of the +unzipped file is understood by sisu, and sisu commands can be run within it. +Note: if you wish to send multiple files, it quickly becomes more space +efficient to zip the sisu markup directory, rather than the individual files +for sending). See the -S option without [filename/wildcard]. Alias -S .TP -.B \-s [filename/wildcard] -copies sisu markup file to output directory. - +.B --source [filename/wildcard] +copies sisu markup file to output directory. Alias -s .TP -.B \-t [filename/wildcard \ (*.termsheet.rb)] +.B --strict +together with --html, produces more w3c compliant html, for example not having +purely numeric identifiers for text, the location object url#33 becomes url#o33 +.TP +.B -T [filename/wildcard (*.termsheet.rb)] standard form document builder, preprocessing feature - .TP -.B \-U [filename/wildcard] +.B -t [filename/wildcard] +see --txt +.TP +.B --texinfo [filename/wildcard] +produces texinfo and info file, (view with pinfo). Alias -I +.TP +.B --textile [filename/wildcard/url] +textile smart text (not available) +.TP +.B --txt [filename/wildcard] +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 --txt-asciidoc [filename/wildcard] +see --asciidoc +.TP +.B --txt-markdown [filename/wildcard] +see --markdown +.TP +.B --txt-rst [filename/wildcard] +see --rst +.TP +.B --txt-textile [filename/wildcard] +see --textile +.TP +.B -U [filename/wildcard] +see --urls +.TP +.B -u [filename/wildcard] +provides url mapping of output files for the flags requested for processing, +also see -U +.TP +.B --urls [filename/wildcard] prints url output list/map for the available processing flags options and resulting files that could be requested, (can be used to get a list of processing options in relation to a file, together with information on the -output that would be produced), \-u provides url output mapping for those flags +output that would be produced), -u provides url output mapping for those flags requested for processing. The default assumes sisu_webrick is running and provides webrick url mappings where appropriate, but these can be switched to -file system paths in sisurc.yml - -.TP -.B \-u [filename/wildcard] -provides url mapping of output files for the flags requested for processing, -also see \-U - +file system paths in sisurc.yml. Alias -U .TP -.B \-V +.B -V on its own, provides .B SiSU -version and environment information (sisu \-\-help env) - +version and environment information (sisu --help env) .TP -.B \-V [filename/wildcard] -even more verbose than the \-v flag. (also see \-M) - +.B -V [filename/wildcard] +even more verbose than the -v flag. .TP -.B \-v +.B -v on its own, provides .B SiSU version information - .TP -.B \-v [filename/wildcard] -provides verbose output of what is being built, where it is being built (and -error messages if any), as with \-u flag provides a url mapping of files -created for each of the processing flag requests. See also \-V - +.B -v [filename/wildcard] +see --verbose .TP -.B \-W -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 \ -\-H; \ also, \ note \ \-F \ webrick \ ]. - +.B --verbose [filename/wildcard] +provides verbose output of what is being generated, where output is placed (and +error messages if any), as with -u flag provides a url mapping of files created +for each of the processing flag requests. Alias -v .TP -.B \-w [filename/wildcard] -produces concordance (wordmap) a rudimentary index of all the words in a -document. (Concordance files are not generated for documents of over 260,000 -words unless this limit is increased in the file sisurc.yml) - +.B --very-verbose [filename/wildcard] +provides more verbose output of what is being generated. See --verbose. Alias +-V .TP -.B \-X [filename/wildcard] -produces XML output with deep document structure, in the nature of dom. - +.B --version +sisu version .TP -.B \-x [filename/wildcard] -produces XML output shallow structure (sax parsing). - +.B -W +see --webrick +.TP +.B -w [filename/wildcard] +see --concordance .TP -.B \-Y [filename/wildcard] +.B --webrick +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 -H ; also, note -F webrick ]. Alias -W +.TP +.B --wordmap [filename/wildcard] +see --concordance +.TP +.B --xhtml [filename/wildcard] +produces xhtml/ +.I XML +output for browser viewing (sax parsing). Alias -b +.TP +.B --xml-dom [filename/wildcard] +produces +.I XML +output with deep document structure, in the nature of dom. Alias -X +.TP +.B --xml-sax [filename/wildcard] +produces +.I XML +output shallow structure (sax parsing). Alias -x +.TP +.B -X [filename/wildcard] +see --xml-dom +.TP +.B -x [filename/wildcard] +see --xml-sax +.TP +.B -Y [filename/wildcard] produces a short sitemap entry for the document, based on html output and the -sisu_manifest. \-\-sitemaps generates/updates the sitemap index of existing -sitemaps. (Experimental, [g,y,m \ announcement \ this \ week]) - +sisu_manifest. --sitemaps generates/updates the sitemap index of existing +sitemaps. (Experimental, [g,y,m announcement this week]) .TP -.B \-y [filename/wildcard] -produces an html summary of output generated (hyperlinked to content) and -document specific metadata (sisu_manifest.html). This step is assumed for most -processing flags. - +.B -y [filename/wildcard] +see --manifest .TP -.B \-Z [filename/wildcard] -Zap, if used with other processing flags deletes output files of the type -about 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. - +.B -Z [filename/wildcard] +see --zap .TP -.B \-z [filename/wildcard] -produces php (zend) [this \ feature \ is \ disabled \ for \ the \ time \ -being] - -.SH -3. COMMAND LINE MODIFIERS -.BR +.B --zap [filename/wildcard] +Zap, if used with other processing flags deletes output files of the type about +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 COMMAND LINE MODIFIERS .TP -.B \-\-no\-ocn -[with \ \-h \ \-H \ or \ \-p] switches off object citation numbering. Produce -output without identifying numbers in margins of html or LaTeX/pdf output. - +.B --no-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 +.B --no-annotate strips output text of editor endnotes[^*1] denoted by asterisk or dagger/plus sign - .TP -.B \-\-no\-asterisk +.B --no-asterisk strips output text of editor endnotes[^*2] denoted by asterisk sign - .TP -.B \-\-no\-dagger +.B --no-dagger strips output text of editor endnotes[^+1] denoted by dagger/plus sign +.SH DATABASE COMMANDS -.SH -4. DATABASE COMMANDS -.BR - -.BR -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)] - -.TP -.B \-Dv \-\-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. - -.TP -.B \-Dv \-\-import -[filename/wildcard] imports data specified to postgresql db (rb.dbi) [ \ \-dv -\ \-\-import \ sqlite \ equivalent] -.TP -.B \-Dv \-\-update -[filename/wildcard] updates/imports specified data to postgresql db (rb.dbi) -[ \ \-dv \ \-\-update \ sqlite \ equivalent] +.B dbi - database interface -.TP -.B \-D \-\-remove -[filename/wildcard] removes specified data to postgresql db (rb.dbi) [ \ \-d -\ \-\-remove \ sqlite \ equivalent] - -.TP -.B \-D \-\-dropall -kills data\" and drops (postgresql or sqlite) db, tables & indexes [ \ \-d \ -\-\-dropall \ sqlite \ equivalent] - -.BR -The v in e.g. \-Dv is for verbose output. - -.SH -5. SHORTCUTS, SHORTHAND FOR MULTIPLE FLAGS .BR +.B --pg or --pgsql +set for +.I PostgreSQL +.B --sqlite +default set for +.I SQLite +-d is modifiable with --db=[database type (PgSQL or +.I SQLite +) ] .TP -.B \-\-update [filename/wildcard] -Checks existing file output and runs the flags required to update this -output. This means that if only html and pdf output was requested on previous -runs, only the \-hp files will be applied, and only these will be generated -this time, together with the summary. This can be very convenient, if you offer -different outputs of different files, and just want to do the same again. - -.TP -.B \-0 to \-5 [filename \ or \ wildcard] -Default shorthand mappings (note that the defaults can be changed/configured -in the sisurc.yml file): - +.B --pg -v --createall +initial step, creates required relations (tables, indexes) in existing +.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 \-0 -\-mNhwpAobxXyYv [this \ is \ the \ default \ action \ run \ when \ no \ -options \ are \ give, \ i.e. \ on \ \'sisu \ [filename]\'] - +.B --pg -v --import +[filename/wildcard] imports data specified to +.I PostgreSQL +db (rb.dbi) [ -dv --import +.I SQLite +equivalent] .TP -.B \-1 -\-mNHwpy - +.B --pg -v --update +[filename/wildcard] updates/imports specified data to +.I PostgreSQL +db (rb.dbi) [ -dv --update +.I SQLite +equivalent] .TP -.B \-2 -\-mNHwpaoy - -.TP -.B \-3 -\-mNhwpAobxXyY - +.B --pg --remove +[filename/wildcard] removes specified data to +.I PostgreSQL +db (rb.dbi) [ -d --remove +.I SQLite +equivalent] .TP -.B \-4 -\-mNhwpAobxXDyY \-\-import - -.TP -.B \-5 -\-mNhwpAobxXDyY \-\-update - -.BR -add \-v for verbose mode and \-c for color, e.g. sisu \-2vc [filename \ or \ -wildcard] +.B --pg --dropall +kills data" and drops ( +.I PostgreSQL +or +.I SQLite +) db, tables & indexes [ -d --dropall +.I SQLite +equivalent] .BR -consider \-u for appended url info or \-v for verbose output +The -v is for verbose output. +.SH COMMAND LINE WITH FLAGS - BATCH PROCESSING -.SH -5.1 COMMAND LINE WITH FLAGS \- BATCH PROCESSING .BR -In the data directory run sisu \-mh filename or wildcard eg. \"sisu \-h -cisg.sst\" or \"sisu \-h *.{sst,ssm}\" to produce html version of all -documents. +In the data directory run sisu -mh filename or wildcard eg. "sisu -h cisg.sst" +or "sisu -h *.{sst,ssm}" to produce html version of all documents. .BR 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 HELP -.SH -6. HELP -.BR +.SH SISU MANUAL -.SH -6.1 SISU MANUAL .BR The most up to date information on sisu should be contained in the sisu_manual, @@ -620,19 +833,18 @@ The manual can be generated from source, found respectively, either within the tarball or installed locally at: .BR - ./data/doc/sisu/sisu_markup_samples/sisu_manual/ + ./data/doc/sisu/markup-samples/sisu_manual .BR - /usr/share/doc/sisu/sisu_markup_samples/sisu_manual/ + /usr/share/doc/sisu/markup-samples/sisu_manual .BR move to the respective directory and type e.g.: .BR sisu sisu_manual.ssm +.SH SISU MAN PAGES -.SH -6.2 SISU MAN PAGES .BR If @@ -643,12 +855,6 @@ is installed on your system usual man commands should be available, try: man sisu .BR - man sisu_markup - -.BR - man sisu_commands - -.BR Most .B SiSU man pages are generated directly from sisu documents that are used to prepare @@ -657,13 +863,13 @@ the sisu manual, the sources files for which are located within the tarball at: .BR - ./data/doc/sisu/sisu_manual/ + ./data/doc/sisu/markup-samples/sisu_manual .BR Once installed, directory equivalent to: .BR - /usr/share/doc/sisu/sisu_manual/ + /usr/share/doc/sisu/markup-samples/sisu_manual .BR Available man pages are converted back to html using man2html: @@ -672,94 +878,34 @@ Available man pages are converted back to html using man2html: /usr/share/doc/sisu/html/ .BR - ./data/doc/sisu/html/ + ./data/doc/sisu/html .BR An online version of the sisu man page is available here: .BR -* various sisu man pages <http://www.jus.uio.no/sisu/man/> [^7] - -.BR -* sisu.1 <http://www.jus.uio.no/sisu/man/sisu.1.html> [^8] - -.SH -6.3 SISU BUILT\-IN INTERACTIVE HELP +* various sisu man pages <http://www.jus.uio.no/sisu/man/> [^1] .BR -This is particularly useful for getting the current sisu setup/environment -information: +* sisu.1 <http://www.jus.uio.no/sisu/man/sisu.1.html> [^2] +.SH SISU BUILT-IN INTERACTIVE HELP, [DISCONTINUED] -.BR - sisu \-\-help .BR - sisu \-\-help [subject] +This fell out of date and has been discontinued. +.SH INTRODUCTION TO SISU MARKUP[^3] -.BR - sisu \-\-help commands +.SH SUMMARY -.BR - sisu \-\-help markup .BR - sisu \-\-help env [for \ feedback \ on \ the \ way \ your \ system \ is \ - setup \ with \ regard \ to \ sisu] -.BR - sisu \-V [environment \ information, \ same \ as \ above \ command] - -.BR - sisu (on its own provides version and some help information) - -.BR -Apart from real\-time information on your current configuration the -.B SiSU -manual and man pages are likely to contain more up\-to\-date information than -the sisu interactive help (for example on commands and markup). - -.BR -NOTE: Running the command sisu (alone without any flags, filenames or -wildcards) brings up the interactive help, as does any sisu command that is not -recognised. Enter to escape. - -.SH -6.4 HELP SOURCES - -.BR -For lists of alternative help sources, see: - -.BR -.B man page - -.BR - man sisu_help_sources - -.BR -.B man2html - -.BR - /usr/share/doc/sisu/sisu_manual/sisu_help_sources/index.html - -.BR -.B sisu generated html - -.BR - /usr/share/doc/sisu/html/sisu_help_sources/index.html - -.BR - <http://sisudoc.org/sisu/sisu_help_sources/index.html> - -.SH -7. INTRODUCTION TO SISU MARKUP[^9] -.BR - -.SH -7.1 SUMMARY - -.BR .B SiSU -source documents are plaintext (UTF\-8)[^10] files +source documents are +.I plaintext +( +.I UTF-8 +)[^4] files .BR All paragraphs are separated by an empty line. @@ -768,7 +914,7 @@ All paragraphs are separated by an empty line. Markup is comprised of: .BR -* at the top of a document, the document header made up of semantic meta\-data +* at the top of a document, the document header made up of semantic meta-data about the document and if desired additional processing instructions (such an instruction to automatically number headings from a particular level down) @@ -794,35 +940,88 @@ primary outline of the document structure. Markup of substantive text includes: * linked text and images .BR - * paragraph actions, such as indent, bulleted, numbered\-lists, etc. + * paragraph actions, such as indent, bulleted, numbered-lists, etc. +.SH MARKUP RULES, DOCUMENT STRUCTURE AND METADATA REQUIREMENTS -.BR -Some interactive help on markup is available, by typing sisu and selecting -markup or sisu \-\-help markup .BR -To check the markup in a file: +minimal content/structure requirement: .BR - sisu \-\-identify [filename].sst +[metadata] +.nf +A~ (level A [title]) + +1~ (at least one level 1 [segment/(chapter)]) +.fi -.BR -For brief descriptive summary of markup history .BR - sisu \-\-query\-history +structure rules (document heirarchy, heading levels): .BR -or if for a particular version: +there are two sets of heading levels ABCD (title & parts if any) and 123 +(segment & subsegments if any) .BR - sisu \-\-query\-0.38 +sisu has the fllowing levels: +.nf +A~ [title] . + required (== 1) followed by B~ or 1~ +B~ [part] * + followed by C~ or 1~ +C~ [subpart] * + followed by D~ or 1~ +D~ [subsubpart] * + followed by 1~ +1~ [segment (chapter)] + + required (>= 1) followed by text or 2~ +text * + followed by more text or 1~, 2~ + or relevant part *() +2~ [subsegment] * + followed by text or 3~ +text * + followed by more text or 1~, 2~ or 3~ + or relevant part, see *() +3~ [subsubsegment] * + followed by text +text * + followed by more text or 1~, 2~ or 3~ or relevant part, see *() + +*(B~ if none other used; + if C~ is last used: C~ or B~; + if D~ is used: D~, C~ or B~) +.fi + +.nf +* level A~ is the tile and is mandatory +* there can only be one level A~ +* heading levels BCD, are optional and there may be several of each + (where all three are used corresponding to e.g. Book Part Section) + * sublevels that are used must follow each other sequentially + (alphabetically), +* heading levels A~ B~ C~ D~ are followed by other heading levels rather + than substantive text + which may be the subsequent sequential (alphabetic) heading part level + or a heading (segment) level 1~ +* there must be at least one heading (segment) level 1~ + (the level on which the text is segmented, in a book would correspond + to the Chapter level) +* additional heading levels 1~ 2~ 3~ are optional and there may be several + of each +* heading levels 1~ 2~ 3~ are followed by text (which may be followed by + the same heading level) + and/or the next lower numeric heading level (followed by text) + or indeed return to the relevant part level + (as a corollary to the rules above substantive text/ content + must be preceded by a level 1~ (2~ or 3~) heading) +.fi -.SH -7.2 MARKUP EXAMPLES +.SH MARKUP EXAMPLES + +.SH ONLINE -.SH -7.2.1 ONLINE .BR Online markup examples are available together with the respective outputs @@ -835,30 +1034,22 @@ markup and the respective output produced: <http://www.jus.uio.no/sisu/sisu_markup/> .BR -Some example marked up files are available as html with syntax highlighting for -viewing: <http://www.jus.uio.no/sisu/sample/syntax> - -.BR an alternative presentation of markup syntax: -<http://www.jus.uio.no/sisu/sample/on_markup.txt> +/usr/share/doc/sisu/on_markup.txt.gz +.SH INSTALLED -.SH -7.2.2 INSTALLED .BR With .B SiSU -installed sample skins may be found in: -/usr/share/doc/sisu/sisu_markup_samples/dfsg (or equivalent directory) and if -sisu\-markup\-samples is installed also under: -/usr/share/doc/sisu/sisu_markup_samples/non\-free +installed sample skins may be found in: /usr/share/doc/sisu/markup-samples (or +equivalent directory) and if sisu -markup-samples is installed also under: +/usr/share/doc/sisu/markup-samples-non-free +.SH MARKUP OF HEADERS -.SH -8. MARKUP OF HEADERS -.BR .BR -Headers contain either: semantic meta\-data about a document, which can be used +Headers contain either: semantic meta-data about a document, which can be used by any output module of the program, or; processing instructions. .BR @@ -866,97 +1057,89 @@ Note: the first line of a document may include information on the markup version used in the form of a comment. Comments are a percentage mark at the start of a paragraph (and as the first character in a line of text) followed by a space and the comment: - - .nf - % this would be a comment +% this would be a comment .fi -.SH -8.1 SAMPLE HEADER +.SH SAMPLE HEADER -.BR -This current document has a header similar to this one (without the comments): - -.nf - % SiSU 0.57 -.BR - @title: SiSU -.BR - @subtitle: Markup -.BR - @creator: Amissah, Ralph -.BR - % note formatting rules on author / creator field, \"Surname, Other names\", if more than one author separate by semi\-colon (if name is of an institution just write name or the name contains a comma enclose in quotation marks) -.BR - @rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 -.BR - @type: information -.BR - @subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search -.BR - @topic_register: text markup language; application:text processing;output:html|xml|latex|pdf|sql -.BR - % note formatting for topic_register topic levels are separated by a colon, a semi\-colon separates main topics -.BR - @date: 2007\-09\-16 -.BR - % original publication date unless the substantive text is updated/modified, then date of update -.BR - @date.created: 2002\-08\-28 -.BR - @date.issued: 2002\-08\-28 -.BR - @date.available: 2002\-08\-28 -.BR - @date.modified: 2007\-09\-16 -.BR - @level: new=C; break=1; num_top=1 -.BR - % comment: in this @level header num_top=1 starts automatic heading numbering at heading level 1 (numbering continues 3 levels down); the new and break instructions are used by the LaTeX/pdf and odf output to determine where to put page breaks (that are not used by html output or say sql database population). -.BR - @skin: skin_sisu_manual -.BR - % skins modify the appearance of a document and are placed in a sub\-directory under \./_sisu/skin ~/.sisu/skin or /etc/sisu/skin. A skin may affect single documents that request them, all documents in a directory, or be site\-wide. (A document is affected by a single skin) -.BR - @bold: /Gnu|Debian|Ruby|SiSU/ -.BR - @links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ -.BR - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html -.BR - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU -.BR - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ -.BR - { SiSU @ Ruby Application Archive }http://raa.ruby\-lang.org/project/sisu/ -.BR - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html .BR +This current document is loaded by a master document that has a header similar +to this one: +.nf +% SiSU master 4.0 + +@title: SiSU + :subtitle: Manual + +@creator: + :author: Amissah, Ralph + +@publisher: [publisher name] + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@classify: + :topic_register: SiSU:manual;electronic documents:SiSU:manual + :subject: ebook, epublishing, electronic book, electronic publishing, + electronic document, electronic citation, data structure, + citation systems, search + +% used_by: manual + +@date: + :published: 2008-05-22 + :created: 2002-08-28 + :issued: 2002-08-28 + :available: 2002-08-28 + :modified: 2010-03-03 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :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] + +@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 -.BR { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html -.BR -.BR + { SiSU Git repo }http://git.sisudoc.org/gitweb/?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 either the -form @headername: or 0~headername. 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: + +.B @identifier: information or instructions .BR -where the \"identifier\" is a tag recognised by the program, and the -\"information\" or \"instructions\" belong to the tag/indentifier specified +where the "identifier" is a tag recognised by the program, and the +"information" or "instructions" belong to the tag/identifier specified .BR Note: a header where used should only be used once; all headers apart from @@ -965,477 +1148,413 @@ structure, and can be useful to know. .BR This is a sample header +.nf +% SiSU 2.0 [declared file-type identifier with markup version] +.fi -.BR -.B % SiSU 0.38 -[declared \ file\-type \ identifier \ with \ markup \ version] +.nf +@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] +.fi -.BR -.B @title: - \ [title \ text] This is the title of the document and used as such, this header is the only one that is -.I mandatory +.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] +.fi -.BR -.B @subtitle: -The Subtitle if any +.nf +@rights: + :copyright: Copyright (C) [Year and Holder] + :license: [Use License granted] + :text: [Year and Holder] + :translation: [Name, Year] + :illustrations: [Name, Year] +.fi -.BR -.B @creator: -[or \ @author:] Name of Author +.nf +@classify: + :topic_register: SiSU:markup sample:book;book:novel:fantasy + :type: + :subject: + :description: + :keywords: + :abstract: + :loc: [Library of Congress classification] + :dewey: [Dewey classification +.fi -.BR -.B @subject: -(whatever your subject) +.nf +@identify: + :isbn: [ISBN] + :oclc: +.fi -.BR -.B @description: +.nf +@links: { SiSU }http://www.sisudoc.org + { FSF }http://www.fsf.org +.fi -.BR -.B @publisher: +.nf +@make: + :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 -.BR -.B @contributor: +.nf +@original: + :language: [language] +.fi -.BR -.B @translator: -\ [or \ @translated_by:] +.nf +@notes: + :comment: + :prefix: [prefix is placed just after table of contents] +.fi + +.SH MARKUP OF SUBSTANTIVE TEXT + +.SH HEADING LEVELS -.BR -.B @illustrator: -\ [or \ @illustrated_by:] .BR -.B @prepared_by: -\ [or \ @digitized_by:] +Heading levels are :A~ ,:B~ ,:C~ ,1~ ,2~ ,3~ ... :A - :C being part / section +headings, followed by other heading levels, and 1 -6 being headings followed by +substantive text or sub-headings. :A~ usually the title :A~? conditional level +1 heading (used where a stand-alone document may be imported into another) .BR -.B @date: 2000\-08\-27 -[ \ also \ @date.created: \ @date.issued: \ @date.available: \ @date.valid: \ -@date.modified: \ ] +.B :A~ [heading text] +Top level heading [this usually has similar content to the title @title: ] +NOTE: the heading levels described here are in 0.38 notation, see heading .BR -.B @type: article -.BR -.B @format: +.B :B~ [heading text] +Second level heading [this is a heading level divider] .BR -.B @identifier: -.BR -.B @source: +.B :C~ [heading text] +Third level heading [this is a heading level divider] .BR -.B @language: -[or \ @language.document:] [country \ code \ for \ language \ if \ available, -\ or \ language, \ English, \ en \ is \ the \ default \ setting] (en \- -English, fr \- French, de \- German, it \- Italian, es \- Spanish, pt \- -Portuguese, sv \- Swedish, da \- Danish, fi \- Finnish, no \- Norwegian, is \- -Icelandic, nl \- Dutch, et \- Estonian, hu \- Hungarian, pl \- Polish, ro \- -Romanian, ru \- Russian, el \- Greek, uk \- Ukranian, tr \- Turkish, sk \- -Slovak, sl \- Slovenian, hr \- Croatian, cs \- Czech, bg \- Bul garian ) -[however, \ encodings \ are \ not \ available \ for \ all \ of \ the \ -languages \ listed.] -.BR -[@language.original: \ original \ language \ in \ which \ the \ work \ was \ -published] +.B 1~ [heading text] +Top level heading preceding substantive text of document or sub-heading 2, the +heading level that would normally be marked 1. or 2. or 3. etc. in a document, +and the level on which sisu by default would break html output into named +segments, names are provided automatically if none are given (a number), +otherwise takes the form 1~my_filename_for_this_segment .BR -.B @papersize: -(A4|US_letter|book_B5|book_A5|US_legal) -.BR -.B @relation: +.B 2~ [heading text] +Second level heading preceding substantive text of document or sub-heading 3 , +the heading level that would normally be marked 1.1 or 1.2 or 1.3 or 2.1 etc. +in a document. .BR -.B @coverage: -.BR -.B @rights: -Copyright (c) Name of Right Holder, all rights reserved, or as granted: -public domain, copyleft, creative commons variant, etc. +.B 3~ [heading text] +Third level heading preceding substantive text of document, that would normally +be marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a document +.nf +1~filename level 1 heading, -.BR -.B @owner: +% 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 -.BR -.B @keywords: -text document generation processing management latex pdf structured xml -citation [your \ keywords \ here, \ used \ for \ example \ by \ rss \ feeds, \ -and \ in \ sql \ searches] +.SH FONT ATTRIBUTES -.BR -.B @abstract: -[paper \ abstract, \ placed \ after \ table \ of \ contents] .BR -.B @comment: -[...] -.BR -.B @catalogue: -loc=[Library \ of \ Congress \ classification]; dewey=[Dewey \ -classification]; isbn=[ISBN]; pg=[Project \ Gutenberg \ text \ number] +.B markup example: +.nf +normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}", +^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}-, #{monospace}# -.BR -.B @classify_loc: -[Library \ of \ Congress \ classification] +normal text -.BR -.B @classify_dewey: -[Dewey \ classification] +*{emphasis}* [note: can be configured to be represented by bold, italics or underscore] -.BR -.B @classify_isbn: -[ISBN] +!{bold text}! -.BR -.B @classify_pg: -[Project \ Gutenberg \ text \ number] +/{italics}/ -.BR -.B @prefix: -[prefix \ is \ placed \ just \ after \ table \ of \ contents] +_{underscore}_ -.BR -.B @prefix_a: -[prefix \ is \ placed \ just \ before \ table \ of \ contents \ \- \ not \ -implemented] +"{citation}" -.BR -.B @prefix_b: +^{superscript}^ -.BR -.B @rcs: -$Id: sisu_markup.sst,v 1.2 2007/09/08 17:12:47 ralph Exp $ [used \ by \ rcs \ -or \ cvs \ to \ embed \ version \ (revision \ control) \ information \ into \ -document, \ rcs \ or \ cvs \ can \ usefully \ provide \ a \ history \ of \ -updates \ to \ a \ document \ ] +,{subscript}, -.BR -.B @structure: -PART; CHAPTER; SECTION; ARTICLE; none; none; -optional, document structure can be defined by words to match or regular -expression (the regular expression is assumed to start at the beginning of a -line of text i.e. ^) default markers :A~ to :C~ and 1~ to 6~ can be used within -text instead, without this header tag, and may be used to supplement the -instructions provided in this header tag if provided (@structure: is a synonym -for @toc:) ++{inserted text}+ -.BR -.B @level: -newpage=3; breakpage=4 -[paragraph \ level, \ used \ by \ latex \ to \ breakpages, \ the \ page \ is -\ optional \ eg. \ in \ newpage] +-{strikethrough}- + +#{monospace}# +.fi -.BR -.B @markup: -information on the markup used, e.g. new=1,2,3; break=4; num_top=4 [or \ -newpage=1,2,3; \ breakpage=4; \ num_top=4] newpage and breakpage, heading -level, used by LaTeX to breakpages. breakpage: starts on a new page in single -column text and on a new column in double column text; newpage: starts on a new -page for both single and double column texts. -num_top=4 [auto\-number \ document, \ starting \ at \ level \ 4. \ the \ -default \ is \ to \ provide \ 3 \ levels, \ as \ in \ 1 \ level \ 4, \ 1.1 \ -level \ 5, \ 1.1.1 \ level \ 6, \ markup \ to \ be \ merged \ within \ level] -num_extract [take \ numbering \ of \ headings \ provided \ (manually \ in \ -marked \ up \ source \ document), \ and \ use \ for \ numbering \ of \ -segments. \ Available \ where \ a \ clear \ numbering \ structure \ is \ -provided \ within \ document, \ without \ the \ repetition \ of \ a \ number \ -in \ a \ header.] [In \ 0.38 \ notation, \ you \ would \ map \ to \ the \ -equivalent \ levels, \ the \ examples \ provided \ would \ map \ to \ the \ -following \ new=A,B,C; \ break=1; \ num_top=1 \ [or \ newpage=A,B,C; \ -breakpage=1; \ num_top=1] see headings] .BR -.B @bold: -[regular \ expression \ of \ words/phrases \ to \ be \ made \ bold] + +.B resulting output: .BR -.B @italics: -[regular \ expression \ of \ words/phrases \ to \ italicise] +normal text, +.B emphasis, +.B bold text +, +.I italics, +.I underscore, +"citation", ^superscript^, [subscript], ++inserted text++, --strikethrough--, +monospace .BR -.B @vocabulary: -name of taxonomy/vocabulary/wordlist to use against document +normal text .BR -.B @skin: -skin_doc_[name_of_desired_document_skin] -skins change default settings related to the appearance of documents -generated, such as the urls of the home site, and the icon/logo for the -document or site. -.TP -.B @man: 8; -name=sisu \- documents: markup, structuring, publishing in multiple standard -formats, and search; -synopsis=sisu [\-abcDdFHhIiMmNnopqRrSsTtUuVvwXxYyZz0\-9] [filename/wildcard \ -] -sisu [\-Ddcv] [instruction] -sisu [\-CcFLSVvW] -the man page category number (default 1) and special tags used in preparing -man page headings +.B emphasis +[note: can be configured to be represented by bold, italics or underscore] .BR -.B @links: -{ -.B SiSU -}http://www.jus.uio.no/sisu/; -{ FSF }http://www.fsf.org -.BR -.B @promo: -sisu, ruby, search_libre_docs, open_society -[places \ content \ in \ right \ pane \ in \ html, \ makes \ use \ of \ -list.yml \ and \ promo.yml, \ commented \ out \ sample \ in \ document \ -sample: \ -free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst] +.B bold text -.SH -9. MARKUP OF SUBSTANTIVE TEXT .BR -.SH -9.1 HEADING LEVELS +.I italics .BR -Heading levels are :A~ ,:B~ ,:C~ ,1~ ,2~ ,3~ \... :A \- :C being part / section -headings, followed by other heading levels, and 1 \-6 being headings followed -by substantive text or sub\-headings. :A~ usually the title :A~? conditional -level 1 heading (used where a stand\-alone document may be imported into -another) +.I underscore .BR -.B :A~ [heading \ text] -Top level heading [this \ usually \ has \ similar \ content \ to \ the \ -title \ @title: \ ] NOTE: the heading levels described here are in 0.38 -notation, see heading +"citation" .BR -.B :B~ [heading \ text] -Second level heading [this \ is \ a \ heading \ level \ divider] +^superscript^ .BR -.B :C~ [heading \ text] -Third level heading [this \ is \ a \ heading \ level \ divider] +[subscript] .BR -.B 1~ [heading \ text] -Top level heading preceding substantive text of document or sub\-heading 2, -the heading level that would normally be marked 1. or 2. or 3. etc. in a -document, and the level on which sisu by default would break html output into -named segments, names are provided automatically if none are given (a number), -otherwise takes the form 1~my_filename_for_this_segment +++inserted text++ .BR -.B 2~ [heading \ text] -Second level heading preceding substantive text of document or sub\-heading -3, the heading level that would normally be marked 1.1 or 1.2 or 1.3 or 2.1 -etc. in a document. +--strikethrough-- .BR -.B 3~ [heading \ text] -Third level heading preceding substantive text of document, that would -normally be marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a document +monospace +.SH INDENTATION AND BULLETS -.nf - 1~filename level 1 heading, .BR - % 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 - -.BR .B markup example: - - .nf - normal text !{emphasis}! *{bold text}* _{underscore}_ /{italics}/ \"{citation}\" ^{superscript}^ ,{subscript}, +{inserted text}+ -.BR - normal text -.BR - !{emphasis}! -.BR - *{bold text}* -.BR - _{underscore}_ -.BR - /{italics}/ -.BR - \"{citation}\" -.BR - ^{superscript}^ -.BR - ,{subscript}, -.BR - +{inserted text}+ -.BR - \-{strikethrough}\- -.fi +ordinary paragraph -.BR -.B resulting output: +_1 indent paragraph one step -.BR -normal text -.B emphasis -.B bold text -.I underscore -.I italics -<cite>citation</cite> ^superscript^ \ [subscript] <ins>inserted text</ins> -<del>strikethrough</del> +_2 indent paragraph two steps -.BR -normal text +_9 indent paragraph nine steps +.fi .BR -.B bold text - -.BR -.I underscore -.BR -.I italics +.B resulting output: .BR -<cite>citation</cite> +ordinary paragraph .BR -^superscript^ + indent paragraph one step .BR -[subscript] + indent paragraph two steps .BR -<ins>inserted text</ins> + indent paragraph nine steps .BR -<del>strikethrough</del> - -.SH -9.3 INDENTATION AND BULLETS -.BR .B markup example: +.nf +_* bullet text +_1* bullet text, first indent -.nf - ordinary paragraph -.BR - _1 indent paragraph one step -.BR - _2 indent paragraph two steps -.BR - _9 indent paragraph nine steps +_2* bullet text, two step indent .fi +.BR + .B resulting output: .BR -ordinary paragraph +* bullet text .BR - indent paragraph one step + * bullet text, first indent .BR - indent paragraph two steps + * bullet text, two step indent .BR - indent paragraph nine steps +Numbered List (not to be confused with headings/titles, (document structure)) .BR + .B markup example: +.nf +# numbered list numbered list 1., 2., 3, etc. + +_# numbered list numbered list indented a., b., c., d., etc. +.fi + +.SH HANGING INDENTS -.nf - _* bullet text -.BR - _1* bullet text, first indent .BR - _2* bullet text, two step indent + +.B markup example: +.nf +_0_1 first line no indent, +rest of paragraph indented one step + +_1_0 first line indented, +rest of paragraph no indent + +in each case level may be 0-9 .fi + .BR + .B resulting output: .BR -* bullet text +first line no indent, rest of paragraph indented one step; first line no + indent, rest of paragraph indented one step; first line no indent, rest of + paragraph indented one step; first line no indent, rest of paragraph indented + one step; first line no indent, rest of paragraph indented one step; first + line no indent, rest of paragraph indented one step; first line no indent, + rest of paragraph indented one step; first line no indent, rest of paragraph + indented one step; first line no indent, rest of paragraph indented one step; .BR - * bullet text, first indent +A regular paragraph. .BR - * bullet text, two step indent +first line indented, rest of paragraph no indent first line indented, rest of +paragraph no indent first line indented, rest of paragraph no indent first line +indented, rest of paragraph no indent first line indented, rest of paragraph no +indent first line indented, rest of paragraph no indent first line indented, +rest of paragraph no indent first line indented, rest of paragraph no indent +first line indented, rest of paragraph no indent first line indented, rest of +paragraph no indent first line indented, rest of paragraph no indent .BR -Numbered List (not to be confused with headings/titles, (document structure)) +in each case level may be 0-9 .BR -.B markup example: +.B live-build + A collection of scripts used to build customized +.B Debian + Livesystems. + .I live-build + was formerly known as live-helper, and even earlier known as live-package. -.nf - # numbered list numbered list 1., 2., 3, etc. .BR - _# numbered list numbered list indented a., b., c., d., etc. -.fi -.SH -9.4 FOOTNOTES / ENDNOTES +.B live-build + + A collection of scripts used to build customized +.B Debian + Livesystems. +.I live-build + was formerly known as live-helper, and even earlier known as live-package. +.SH FOOTNOTES / ENDNOTES -.BR -Footnotes and endnotes not distinguished in markup. They are automatically -numbered. Depending on the output file format (html, odf, pdf etc.), the -document output selected will have either footnotes or endnotes. .BR -.B markup example: +Footnotes and endnotes are marked up at the location where they would be +indicated within a text. They are automatically numbered. The output type +determines whether footnotes or endnotes will be produced +.BR +.B markup example: .nf - ~{ a footnote or endnote }~ +~{ a footnote or endnote }~ .fi + .BR + .B resulting output: .BR -[^11] +[^5] .BR -.B markup example: - +.B markup example: .nf - normal text~{ self contained endnote marker & endnote in one }~ continues +normal text~{ self contained endnote marker & endnote in one }~ continues .fi + .BR + .B resulting output: .BR -normal text[^12] continues +normal text[^6] continues .BR -.B markup example: - +.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 +normal text ~{* unnumbered asterisk footnote/endnote, insert multiple asterisks if required }~ continues + +normal text ~{** another unnumbered asterisk footnote/endnote }~ continues .fi + .BR + .B resulting output: .BR @@ -1444,18 +1563,18 @@ normal text [^*] continues .BR normal text [^**] continues - .BR -.B markup example: - +.B markup example: .nf - normal text ~[* \ editors \ notes, \ numbered \ asterisk \ footnote/endnote \ series \ ]~ continues -.BR - normal text ~[+ \ editors \ notes, \ numbered \ asterisk \ footnote/endnote \ series \ ]~ continues +normal text ~[* editors notes, numbered asterisk footnote/endnote series ]~ continues + +normal text ~[+ editors notes, numbered plus symbol footnote/endnote series ]~ continues .fi + .BR + .B resulting output: .BR @@ -1464,1188 +1583,1157 @@ normal text [^*3] continues .BR normal text [^+2] continues - .BR + .B Alternative endnote pair notation for footnotes/endnotes: +.nf +% note the endnote marker "~^" +normal text~^ continues -.nf - % note the endnote marker \"~^\" -.BR - normal text~^ continues -.BR - ^~ endnote text following the paragraph in which the marker occurs +^~ endnote text following the paragraph in which the marker occurs .fi + .BR the standard and pair notation cannot be mixed in the same document +.SH LINKS -.SH -9.5 LINKS +.SH NAKED URLS WITHIN TEXT, DEALING WITH URLS -.SH -9.5.1 NAKED URLS WITHIN TEXT, DEALING WITH URLS .BR -urls are found within text and marked up automatically. A url within text is +urls found within text are marked up automatically. A url within text is automatically hyperlinked to itself and by default decorated with angled braces, unless they are contained within a code block (in which case they are passed as normal text), or escaped by a preceding underscore (in which case the decoration is omitted). .BR -.B markup example: - +.B markup example: .nf - normal text http://www.jus.uio.no/sisu continues +normal text http://www.sisudoc.org/ continues .fi + .BR + .B resulting output: .BR -normal text <http://www.jus.uio.no/sisu> continues +normal text <http://www.sisudoc.org/> continues .BR An escaped url without decoration .BR -.B markup example: - +.B markup example: .nf - normal text http://www.jus.uio.no/sisu continues -.BR - deb http://www.jus.uio.no/sisu/archive unstable main non\-free +normal text _http://www.sisudoc.org/ continues + +deb _http://www.jus.uio.no/sisu/archive unstable main non-free .fi + .BR + .B resulting output: .BR -normal text http://www.jus.uio.no/sisu continues +normal text <_http://www.sisudoc.org/> continues .BR -deb http://www.jus.uio.no/sisu/archive unstable main non\-free +deb <_http://www.jus.uio.no/sisu/archive> unstable main non-free .BR where a code block is used there is neither decoration nor hyperlinking, code blocks are discussed later in this document .BR -.B resulting output: - +.B resulting output: .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 +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 +.SH LINKING TEXT + + .BR To link text or an image to a url the markup is as follows .BR -.B markup example: - +.B markup example: .nf - about { SiSU }http://url.org markup +about { SiSU }http://url.org markup .fi -.SH -9.5.2 LINKING TEXT .BR + .B resulting output: .BR -about SiSU <http://www.jus.uio.no/sisu/> markup +aboutSiSU <http://www.sisudoc.org/> markup .BR A shortcut notation is available so the url link may also be provided automatically as a footnote .BR -.B markup example: - +.B markup example: .nf - about {~^ SiSU }http://url.org markup +about {~^ SiSU }http://url.org markup .fi + .BR + .B resulting output: .BR -about SiSU <http://www.jus.uio.no/sisu/> [^13] markup +aboutSiSU <http://www.sisudoc.org/> [^7] markup -.SH -9.5.3 LINKING IMAGES +.BR +Internal document links to a tagged location, including an ocn .BR + .B markup example: +.nf +about { text links }#link_text +.fi -.nf - { tux.png 64x80 }image .BR - % various url linked images -.BR - {tux.png 64x80 \"a better way\" }http://www.jus.uio.no/sisu/ + +.B resulting output: + .BR +about ⌠text links⌡⌈link_text⌋ + .BR - {GnuDebianLinuxRubyBetterWay.png 100x101 \"Way Better \- with Gnu/Linux, Debian and Ruby\" }http://www.jus.uio.no/sisu/ +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: +.nf +{ tux.png 64x80 }image + +% various url linked images + +{tux.png 64x80 "a better way" }http://www.sisudoc.org/ + +{GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian and Ruby" }http://www.sisudoc.org/ + +{~^ ruby_logo.png "Ruby" }http://www.ruby-lang.org/en/ .fi + .BR + .B resulting output: .BR [ tux.png ] .BR -tux.png 64x80 \"Gnu/Linux \- a better way\" <http://www.jus.uio.no/sisu/> +tux.png 64x80 "Gnu/Linux - a better way" <http://www.sisudoc.org/> .BR -[ \ ruby_logo \ (png \ missing) \ ] [^14] +GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian +and Ruby" <http://www.sisudoc.org/> .BR -GnuDebianLinuxRubyBetterWay.png 100x101 \"Way Better \- with Gnu/Linux, Debian -and Ruby\" <http://www.jus.uio.no/sisu/> +ruby_logo.png 70x90 "Ruby" <http://www.ruby-lang.org/en/> [^8] .BR + .B linked url footnote shortcut +.nf +{~^ [text to link] }http://url.org +% maps to: { [text to link] }http://url.org ~{ http://url.org }~ -.nf - {~^ \ [text \ to \ link] }http://url.org -.BR -.BR - % maps to: { \ [text \ to \ link] }http://url.org ~{ http://url.org }~ -.BR - % which produces hyper\-linked text within a document/paragraph, with an endnote providing the url for the text location used in the hyperlink +% which produces hyper-linked text within a document/paragraph, with an endnote providing the url for the text location used in the hyperlink .fi - .nf - text marker *~name +text marker *~name .fi + .BR 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. +auto-heading numbering, without further intervention. +.SH LINK SHORTCUT FOR MULTIPLE VERSIONS OF A SISU DOCUMENT IN THE SAME DIRECTORY +TREE -.SH -9.6 GROUPED TEXT - -.SH -9.6.1 TABLES .BR -Tables may be prepared in two either of two forms -.BR .B markup example: +.nf +!_ /{"Viral Spiral"}/, David Bollier + +{ "Viral Spiral", David Bollier [3sS]}viral_spiral.david_bollier.sst +.fi -.nf - table{ c3; 40; 30; 30; -.BR - This is a table .BR - this would become column two of row one + +.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 / BLOCKED TEXT + + .BR - column three of row one is here +There are two markup syntaxes for blocked text, using curly braces or using +tics +.SH BLOCKED TEXT CURLY BRACE SYNTAX + + .BR - And here begins another row +at the start of a line on its own use name of block type with an opening curly +brace, follow with the content of the block, and close with a closing curly +brace and the name of the block type, e.g. +.nf +code{ + +this is a code block + +}code +.fi + +.nf + +poem{ + +this here is a poem + +}poem +.fi + +.SH BLOCKED TEXT TIC SYNTAX + +.nf +``` code +this is a code block + +``` + +``` poem +this here is a poem + +``` +.fi + + .BR - column two of row two +start a line with three backtics, a space followed by the name of the name of +block type, follow with the content of the block, and close with three back +ticks on a line of their own, e.g. +.SH TABLES + + .BR - column three of row two, and so on +Tables may be prepared in two either of two forms + .BR - }table + +.B markup example: +.nf +table{ c3; 40; 30; 30; + +This is a table +this would become column two of row one +column three of row one is here + +And here begins another row +column two of row two +column three of row two, and so on + +}table .fi + .BR + .B resulting output: +This is a table|this would become column two of row one|column three of row one is here』And here begins another row|column two of row two|column three of row two, and so on』 - \ [table \ omitted, \ see \ other \ document \ formats] .BR a second form may be easier to work with in cases where there is not much information in each column .BR + .B markup example: -[^15] +[^9] +.nf +!_ Table 3.1: Contributors to Wikipedia, January 2001 - June 2005 +{table~h 24; 12; 12; 12; 12; 12; 12;} + |Jan. 2001|Jan. 2002|Jan. 2003|Jan. 2004|July 2004|June 2006 +Contributors* | 10| 472| 2,188| 9,653| 25,011| 48,721 +Active contributors** | 9| 212| 846| 3,228| 8,442| 16,945 +Very active contributors*** | 0| 31| 190| 692| 1,639| 3,016 +No. of English language articles| 25| 16,000| 101,000| 190,000| 320,000| 630,000 +No. of articles, all languages | 25| 19,000| 138,000| 490,000| 862,000|1,600,000 -.nf - !_ Table 3.1: Contributors to Wikipedia, January 2001 \- June 2005 -.BR - {table~h 24; 12; 12; 12; 12; 12; 12;} -.BR - |Jan. 2001|Jan. 2002|Jan. 2003|Jan. 2004|July 2004|June 2006 -.BR - Contributors* | 10| 472| 2,188| 9,653| 25,011| 48,721 -.BR - Active contributors** | 9| 212| 846| 3,228| 8,442| 16,945 -.BR - Very active contributors*** | 0| 31| 190| 692| 1,639| 3,016 -.BR - No. of English language articles| 25| 16,000| 101,000| 190,000| 320,000| 630,000 -.BR - 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. +* Contributed at least ten times; ** at least 5 times in last month; *** more than 100 times in last month. .fi + .BR + .B resulting output: .BR -.B Table 3.1: Contributors to Wikipedia, January 2001 \- June 2005 - \ [table \ omitted, \ see \ other \ document \ formats] +.B Table 3.1: Contributors to Wikipedia, January 2001 - June 2005 +|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 POEM -.SH -9.6.2 POEM .BR + .B basic markup: +.nf +poem{ + Your poem here -.nf - poem{ -.BR - Your poem here -.BR - }poem -.BR - Each verse in a poem is given a separate object number. +}poem + +Each verse in a poem is given an object number. .fi + .BR + .B markup example: +.nf +poem{ + `Fury said to a + mouse, That he + met in the + house, + "Let us + both go to + law: I will + prosecute + YOU. --Come, + I'll take no + denial; We + must have a + trial: For + really this + morning I've + nothing + to do." + Said the + mouse to the + cur, "Such + a trial, + dear Sir, + With + no jury + or judge, + would be + wasting + our + breath." + "I'll be + judge, I'll + be jury," + Said + cunning + old Fury: + "I'll + try the + whole + cause, + and + condemn + you + to + death."' -.nf - poem{ -.BR - \'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 - }poem +}poem .fi -.BR -.B resulting output: - - \'Fury said to a .BR + +.B resulting output: + `Fury said to a mouse, That he -.BR met in the -.BR house, -.BR - \"Let us -.BR + "Let us both go to -.BR law: I will -.BR prosecute -.BR - YOU. \-\-Come, -.BR - I\'ll take no -.BR + YOU. --Come, + I'll take no denial; We -.BR must have a -.BR trial: For -.BR really this -.BR - morning I\'ve -.BR + morning I've nothing -.BR - to do.\" -.BR + to do." Said the -.BR mouse to the -.BR - cur, \"Such -.BR + cur, "Such 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 + breath." + "I'll be + judge, I'll + be jury," Said -.BR cunning -.BR old Fury: -.BR - \"I\'ll -.BR + "I'll try the -.BR whole -.BR cause, -.BR and -.BR condemn -.BR you -.BR to -.BR - death.\"\' -.BR + death."' + + +.SH GROUP -.SH -9.6.3 GROUP .BR + .B basic markup: +.nf +group{ + Your grouped text here -.nf - group{ -.BR - Your grouped text here -.BR - }group -.BR - A group is treated as an object and given a single object number. +}group + +A group is treated as an object and given a single object number. .fi + .BR + .B markup example: +.nf +group{ + `Fury said to a + mouse, That he + met in the + house, + "Let us + both go to + law: I will + prosecute + YOU. --Come, + I'll take no + denial; We + must have a + trial: For + really this + morning I've + nothing + to do." + Said the + mouse to the + cur, "Such + a trial, + dear Sir, + With + no jury + or judge, + would be + wasting + our + breath." + "I'll be + judge, I'll + be jury," + Said + cunning + old Fury: + "I'll + try the + whole + cause, + and + condemn + you + to + death."' -.nf - group{ -.BR - \'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 - }group +}group .fi -.BR -.B resulting output: - - \'Fury said to a .BR + +.B resulting output: + `Fury said to a mouse, That he -.BR met in the -.BR house, -.BR - \"Let us -.BR + "Let us both go to -.BR law: I will -.BR prosecute -.BR - YOU. \-\-Come, -.BR - I\'ll take no -.BR + YOU. --Come, + I'll take no denial; We -.BR must have a -.BR trial: For -.BR really this -.BR - morning I\'ve -.BR + morning I've nothing -.BR - to do.\" -.BR + to do." Said the -.BR mouse to the -.BR - cur, \"Such -.BR + cur, "Such 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 + breath." + "I'll be + judge, I'll + be jury," Said -.BR cunning -.BR old Fury: -.BR - \"I\'ll -.BR + "I'll try the -.BR whole -.BR cause, -.BR and -.BR condemn -.BR you -.BR to -.BR - death.\"\' -.BR + death."' + + +.SH CODE -.SH -9.6.4 CODE .BR -Code tags are used to escape regular sisu markup, and have been used -extensively within this document to provide examples of +Code tags code{ ... }code (used as with other group tags described above) are +used to escape regular sisu markup, and have been used extensively within this +document to provide examples of .B SiSU -markup. You cannot however use code tags to escape code tags. They are -however used in the same way as group or poem tags. +markup. You cannot however use code tags to escape code tags. They are however +used in the same way as group or poem tags. .BR -A code\-block is treated as an object and given a single object number. [an \ -option \ to \ number \ each \ line \ of \ code \ may \ be \ considered \ at \ -some \ later \ time] +A code-block is treated as an object and given a single object number. [an +option to number each line of code may be considered at some later time] .BR -.B use of code tags instead of poem compared, resulting output: - +.B use of code tags instead of poem compared, resulting output: .nf - \'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.\"\' + `Fury said to a + mouse, That he + met in the + house, + "Let us + both go to + law: I will + prosecute + YOU. --Come, + I'll take no + denial; We + must have a + trial: For + really this + morning I've + nothing + to do." + Said the + mouse to the + cur, "Such + a trial, + dear Sir, + With + no jury + or judge, + would be + wasting + our + breath." + "I'll be + judge, I'll + be jury," + Said + cunning + old Fury: + "I'll + try the + whole + cause, + and + condemn + you + to + death."' .fi -.SH -9.7 BOOK INDEX - -.BR -To make an index append to paragraph the book index term relates to it, using -an equal sign and curly braces. .BR -Currently two levels are provided, a main term and if needed a sub\-term. -Sub\-terms are separated from the main term by a colon. - - +From +.B SiSU +2.7.7 on you can number codeblocks by placing a hash after the opening code tag +code{# as demonstrated here: .nf - Paragraph containing main term and sub\-term. -.BR - ={Main term:sub\-term} +1 | `Fury said to a +2 | mouse, That he +3 | met in the +4 | house, +5 | "Let us +6 | both go to +7 | law: I will +8 | prosecute +9 | YOU. --Come, +10 | I'll take no +11 | denial; We +12 | must have a +13 | trial: For +14 | really this +15 | morning I've +16 | nothing +17 | to do." +18 | Said the +19 | mouse to the +20 | cur, "Such +21 | a trial, +22 | dear Sir, +23 | With +24 | no jury +25 | or judge, +26 | would be +27 | wasting +28 | our +29 | breath." +30 | "I'll be +31 | judge, I'll +32 | be jury," +33 | Said +34 | cunning +35 | old Fury: +36 | "I'll +37 | try the +38 | whole +39 | cause, +40 | and +41 | condemn +42 | you +43 | to +44 | death."' .fi -.BR -The index syntax starts on a new line, but there should not be an empty line -between paragraph and index markup. +.SH ADDITIONAL BREAKS - LINEBREAKS WITHIN OBJECTS, COLUMN AND PAGE-BREAKS -.BR -The structure of the resulting index would be: +.SH LINE-BREAKS -.nf - Main term, 1 .BR - sub\-term, 1 +To break a line within a "paragraph object", two backslashes \e\e +with a space before and a space or newline after them +may be used. +.nf +To break a line within a "paragraph object", +two backslashes \e\e with a space before +and a space or newline after them \e\e +may be used. .fi -.BR -Several terms may relate to a paragraph, they are separated by a semicolon. If -the term refers to more than one paragraph, indicate the number of paragraphs. - -.nf - Paragraph containing main term, second term and sub\-term. .BR - ={first term; second term: sub\-term} -.fi +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). .BR -The structure of the resulting index would be: +To draw a dividing line dividing paragraphs, see the section on page breaks. +.SH PAGE BREAKS -.nf - First term, 1, .BR - Second term, 1, -.BR - sub\-term, 1 -.fi +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 -If multiple sub\-terms appear under one paragraph, they are separated under the -main term heading from each other by a pipe symbol. +page new =\e= breaks the page, starts a new page. +.BR +page break -\- breaks a column, starts a new column, if using columns, else +breaks the page, starts a new page. -.nf - Paragraph containing main term, second term and sub\-term. .BR - ={Main term:sub\-term+1|second sub\-term +page break line across page -..- draws a dividing line, dividing paragraphs + .BR - A paragraph that continues discussion of the first sub\-term +page break: +.nf +-\e\e- .fi + .BR -The plus one in the example provided indicates the first sub\-term spans one -additional paragraph. The logical structure of the resulting index would be: +page (break) new: +.nf +=\e\e= +.fi -.nf - Main term, 1, -.BR - sub\-term, 1\-3, .BR - second sub\-term, 1, +page (break) line across page (dividing paragraphs): +.nf +-..- .fi -.SH -10. COMPOSITE DOCUMENTS MARKUP -.BR +.SH BIBLIOGRAPHY / REFERENCES -.BR -It is possible to build a document by creating a master document that requires -other documents. The documents required may be complete documents that could be -generated independently, or they could be markup snippets, prepared so as to be -easily available to be placed within another text. If the calling document is a -master document (built from other documents), it should be named with the -suffix -.B \.ssm -Within this document you would provide information on the other documents -that should be included within the text. These may be other documents that -would be processed in a regular way, or markup bits prepared only for inclusion -within a master document -.B \.sst -regular markup file, or -.B \.ssi -(insert/information) A secondary file of the composite document is built -prior to processing with the same prefix and the suffix -.B \._sst .BR -basic markup for importing a document into a master document +There are three ways to prepare a bibliography using sisu (which are mutually +exclusive): (i) manually preparing and marking up as regular text in sisu a +list of references, this is treated as a regular document segment (and placed +before endnotes if any); (ii) preparing a bibliography, marking a heading level +1~!biblio (note the exclamation mark) and preparing a bibliography using +various metadata tags including for author: title: year: a list of which is +provided below, or; (iii) as an assistance in preparing a bibliography, marking +a heading level 1~!biblio and tagging citations within footnotes for inclusion, +identifying citations and having a parser attempt to extract them and build a +bibliography of the citations provided. - -.nf - << filename1.sst .BR - << filename2.ssi +For the heading/section sequence: endnotes, bibliography then book index to +occur, the name biblio or bibliography must be given to the bibliography +section, like so: +.nf +1~!biblio~ [Note: heading marker::required title missing] .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. +.SH A MARKUP TAGGED METADATA BIBLIOGRAPHY SECTION -.nf - << filename.ssi .BR - <<{filename.ssi} -.BR - % using textlink alternatives +Here instead of writing your full citations directly in footnotes, each time +you have new material to cite, you add it to your bibliography section (if it +has not been added yet) providing the information you need against an available +list of tags (provided below). + .BR - << |filename.ssi|@|^| +The required tags are au: ti: and year: [^10] an short quick example might be +as follows: +.nf +1~!biblio~ [Note: heading marker::required title missing] + +au: von Hippel, E. +ti: Perspective: User Toolkits for Innovation +lng: (language) +jo: Journal of Product Innovation Management +vo: 18 +ed: (editor) +yr: 2001 +note: +sn: Hippel, /{User Toolkits}/ (2001) +id: vHippel_2001 +% form: + +au: Benkler, Yochai +ti: The Wealth of Networks +st: How Social Production Transforms Markets and Freedom +lng: (language) +pb: Harvard University Press +edn: (edition) +yr: 2006 +pl: U.S. +url: http://cyber.law.harvard.edu/wealth_of_networks/Main_Page +note: +sn: Benkler, /{Wealth of Networks}/ (2006) +id: Benkler2006 + +au: Quixote, Don; Panza, Sancho +ti: Taming Windmills, Keeping True +jo: Imaginary Journal +yr: 1605 +url: https://en.wikipedia.org/wiki/Don_Quixote +note: made up to provide an example of author markup for an article with two authors +sn: Quixote & Panza, /{Taming Windmills}/ (1605) +id: quixote1605 .fi -.SH -MARKUP SYNTAX HISTORY -.BR -.SH -11. NOTES RELATED TO FILES\-TYPES AND MARKUP SYNTAX .BR +Note that the section name !biblio (or !bibliography) is required for the +bibliography to be treated specially as such, and placed after the +auto-generated endnote section. .BR -0.38 is substantially current, depreciated 0.16 supported, though file names -were changed at 0.37 +Using this method, work goes into preparing the bibliography, the tags author +or editor, year and title are required and will be used to sort the +bibliography that is placed under the Bibliography section .BR -* sisu \-\-query=[sisu \ version \ [0.38] or \'history] +The metadata tags may include shortname (sn:) and id, if provided, which are +used for substitution within text. Every time the given id is found within the +text it will be replaced by the given short title of the work (it is for this +reason the short title has sisu markup to italicize the title), it should work +with any page numbers to be added, the short title should be one that can +easily be used to look up the full description in the bibliography. +.nf +The following footnote~{ quixote1605, pp 1000 - 1001, also Benkler2006 p 1. }~ +.fi -.BR -provides a short history of changes to -.B SiSU -markup .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:] - +would be presented as: +.BR +Quixote and Panza, +.I Taming Windmills +(1605), pp 1000 - 1001 also, Benkler, +.I Wealth of Networks, +(2006) p 1 or rather[^11] .nf - :A~ @title by @author +au: author Surname, FirstNames (if multiple semi-colon separator) + (required unless editor to be used instead) +ti: title (required) +st: subtitle +jo: journal +vo: volume +ed: editor (required if author not provided) +tr: translator +src: source (generic field where others are not appropriate) +in: in (like src) +pl: place/location (state, country) +pb: publisher +edn: edition +yr: year (yyyy or yyyy-mm or yyyy-mm-dd) (required) +pg: pages +url: http://url +note: note +id: create_short_identifier e.g. authorSurnameYear + (used in substitutions: when found within text will be + replaced by the short name provided) +sn: short name e.g. Author, /{short title}/, Year + (used in substitutions: when an id is found within text + the short name will be used to replace it) .fi -.BR -.B 0.52 -(2007w14/6) declared document type identifier at start of text/document: +.SH TAGGING CITATIONS FOR INCLUSION IN THE BIBLIOGRAPHY -.BR - .B SiSU -0.52 .BR -or, backward compatible using the comment marker: +Here whenever you make a citation that you wish be included in the +bibliography, you tag the citation as such using special delimiters (which are +subsequently removed from the final text produced by sisu) .BR - % -.B SiSU -0.38 +Here you would write something like the following, either in regular text or a +footnote +.nf +See .: Quixote, Don; Panza, Sancho /{Taming Windmills, Keeping True}/ (1605) :. +.fi -.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 +.B SiSU +will parse for a number of patterns within the delimiters to try make out the +authors, title, date etc. and from that create a Bibliography. This is more +limited than the previously described method of preparing a tagged +bibliography, and using an id within text to identify the work, which also +lends itself to greater consistency. +.SH GLOSSARY + .BR -.B SiSU -0.42 is the same as 0.38 with the introduction of some additional endnote -types, +Using the section name 1~!glossary results in the Glossary being treated +specially as such, and placed after the auto-generated endnote section (before +the bibliography/list of references if there is one). .BR -Introduces some variations on endnotes, in particular the use of the asterisk +The Glossary is ordinary text marked up in a manner deemed suitable for that +purpose. e.g. with the term in bold, possibly with a hanging indent. +.nf +1~!glossary~ [Note: heading marker::required title missing] +_0_1 *{GPL}* An abbreviation that stands for "General Purpose License." ... -.nf - ~{* for example for describing an author }~ and ~{** for describing a second author }~ +_0_1 [provide your list of terms and definitions] .fi -.BR -* for example for describing an author .BR -** for describing a second author +In the given example the first line is not indented subsequent lines are by one +level, and the term to be defined is in bold text. +.SH BOOK INDEX -.BR -and +.BR +To make an index append to paragraph the book index term relates to it, using +an equal sign and curly braces. +.BR +Currently two levels are provided, a main term and if needed a sub-term. +Sub-terms are separated from the main term by a colon. .nf - ~[* \ my \ note \ ]~ or ~[+ \ another \ note \ ]~ + Paragraph containing main term and sub-term. + ={Main term:sub-term} .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) +The index syntax starts on a new line, but there should not be an empty line +between paragraph and index markup. .BR -.B SiSU -0.38 introduced alternative experimental header and heading/structure -markers, - - +The structure of the resulting index would be: .nf - @headername: and headers :A~ :B~ :C~ 1~ 2~ 3~ + Main term, 1 + sub-term, 1 .fi + .BR -as the equivalent of: +Several terms may relate to a paragraph, they are separated by a semicolon. If +the term refers to more than one paragraph, indicate the number of paragraphs. +.nf + Paragraph containing main term, second term and sub-term. + ={first term; second term: sub-term} +.fi +.BR +The structure of the resulting index would be: .nf - 0~headername and headers 1~ 2~ 3~ 4~ 5~ 6~ + First term, 1, + Second term, 1, + sub-term, 1 .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 +If multiple sub-terms appear under one paragraph, they are separated under the +main term heading from each other by a pipe symbol. +.nf + Paragraph containing main term, second term and sub-term. + ={Main term: + sub-term+2|second sub-term; + Another term + } -.BR -.B 0.37 -(2006w09/7) introduced new file naming convention, \.sst (text), \.ssm -(master), \.ssi (insert), markup syntax unchanged + A paragraph that continues discussion of the first sub-term +.fi -.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: +The plus one in the example provided indicates the first sub-term spans one +additional paragraph. The logical structure of the resulting index would be: +.nf + Main term, 1, + sub-term, 1-3, + second sub-term, 1, + Another term, 1 +.fi + +.SH COMPOSITE DOCUMENTS MARKUP -.nf - rename \'s/\.s[123]$/\.sst/\' *.s{1,2,3} .BR - rename \'s/\.r[123]$/\.ssm/\' *.r{1,2,3} +It is possible to build a document by creating a master document that requires +other documents. The documents required may be complete documents that could be +generated independently, or they could be markup snippets, prepared so as to be +easily available to be placed within another text. If the calling document is a +master document (built from other documents), it should be named with the +suffix +.B .ssm +Within this document you would provide information on the other documents that +should be included within the text. These may be other documents that would be +processed in a regular way, or markup bits prepared only for inclusion within a +master document +.B .sst +regular markup file, or +.B .ssi +(insert/information) A secondary file of the composite document is built prior +to processing with the same prefix and the suffix +.B ._sst + .BR - rename \'s/\.si$/\.ssi/\' *.si +basic markup for importing a document into a master document +.nf +<< filename1.sst + +<< filename2.ssi .fi -.BR -The internal document markup remains unchanged, from -.B SiSU -0.16 .BR -.B 0.35 -(2005w52/3) sisupod, zipped content file introduced +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 SUBSTITUTIONS -.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 +.B markup example: +.nf +The current Debian is ${debian_stable} the next debian will be ${debian_testing} -.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 +Configure substitution in _sisu/sisu_document_make -.BR -.B SiSU -0.16 (0.15 development branch) introduced the use of +@make: +:substitute: /${debian_stable}/,'*{Wheezy}*' /${debian_testing}/,'*{Jessie}*' +.fi -.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{ +.B resulting output: -.SH -12. SISU FILETYPES .BR +The current +.B Debian +is +.B Jessie +the next debian will be +.B Stretch .BR -.B SiSU -has plaintext and binary filetypes, and can process either type of document. +Configure substitution in _sisu/sisu_document_make +.SH SISU FILETYPES -.SH -12.1 \.SST \.SSM \.SSI MARKED UP PLAIN TEXT .BR + .B SiSU -documents are prepared as plain\-text (utf\-8) files with +has +.I plaintext +and binary filetypes, and can process either type of document. +.SH .SST .SSM .SSI MARKED UP PLAIN TEXT + +.TP .B SiSU -markup. They may make reference to and contain images (for example), which -are stored in the directory beneath them _sisu/image. +documents are prepared as plain-text (utf-8) files with .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 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. +markup. They may make reference to and contain images (for example), which are +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. .BR + .B SiSU -processing can be done directly against a sisu documents; which may be -located locally or on a remote server for which a url is provided. +processing can be done directly against a sisu documents; which may be located +locally or on a remote server for which a url is provided. .BR + .B SiSU source markup can be shared with the command: .BR - sisu \-s [filename] + sisu -s [filename] +.SH SISU TEXT - REGULAR FILES (.SST) -.SH -12.1.1 SISU TEXT \- REGULAR FILES (.SST) .BR The most common form of document in -.B SiSU -, see the section on +.B SiSU, +see the section on .B SiSU markup. +.SH SISU MASTER FILES (.SSM) -.BR -<http://www.jus.uio.no/sisu/sisu_markup> - -.BR -<http://www.jus.uio.no/sisu/sisu_manual> - -.SH -12.1.2 SISU MASTER FILES (.SSM) .BR Composite documents which incorporate other .B SiSU documents which may be either regular .B SiSU -text \.sst which may be generated independently, or inserts prepared solely -for the purpose of being incorporated into one or more master documents. +text .sst which may be generated independently, or inserts prepared solely for +the purpose of being incorporated into one or more master documents. .BR The mechanism by which master files incorporate other documents is described as @@ -2657,34 +2745,28 @@ manual. .BR Note: Master documents may be prepared in a similar way to regular documents, -and processing will occur normally if a \.sst file is renamed \.ssm without -requiring any other documents; the \.ssm marker flags that the document may +and processing will occur normally if a .sst file is renamed .ssm without +requiring any other documents; the .ssm marker flags that the document may contain other documents. .BR Note: a secondary file of the composite document is built prior to processing -with the same prefix and the suffix \._sst [^16] +with the same prefix and the suffix ._sst [^12] +.SH SISU INSERT FILES (.SSI) -.BR -<http://www.jus.uio.no/sisu/sisu_markup> - -.BR -<http://www.jus.uio.no/sisu/sisu_manual> - -.SH -12.1.3 SISU INSERT FILES (.SSI) .BR Inserts are documents prepared solely for the purpose of being incorporated into one or more master documents. They resemble regular .B SiSU -text files except they are ignored by the -.B SiSU -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. +text files (.sst). Since sisu -5.5.0 (6.1.0) .ssi files can like .ssm files +include other .sst or .ssm files. .ssi files cannot be called by the sisu +processor directly and can only be incorporated in other documents. Making a +file a .ssi file is a quick and convenient way of breaking up a document that +is to be included in a master document, and flagging that the file to be +incorporated .ssi is not intended that the file should be processed on its own. +.SH SISUPOD, ZIPPED BINARY CONTAINER (SISUPOD.ZIP, .SSP) -.SH -12.2 SISUPOD, ZIPPED BINARY CONTAINER (SISUPOD.ZIP, \.SSP) .BR A sisupod is a zipped @@ -2692,17 +2774,16 @@ A sisupod is a zipped text file or set of .B SiSU text files and any associated images that they contain (this will be extended -to include sound and multimedia\-files) - -.BR +to include sound and multimedia-files) +.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 @@ -2716,155 +2797,34 @@ documents. The command to create a sisupod is: .BR - sisu \-S [filename] + sisu -S [filename] .BR Alternatively, make a pod of the contents of a whole directory: .BR - sisu \-S + sisu -S .BR -.B SiSU -processing can be done directly against a sisupod; which may be located -locally or on a remote server for which a url is provided. - -.BR -<http://www.jus.uio.no/sisu/sisu_commands> - -.BR -<http://www.jus.uio.no/sisu/sisu_manual> -.SH -13. EXPERIMENTAL ALTERNATIVE INPUT REPRESENTATIONS -.BR - -.SH -13.1 ALTERNATIVE XML - -.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. +processing can be done directly against a sisupod; which may be located locally +or on a remote server for which a url is provided. .BR -.B convert from sst to simple xml representations (sax, dom and node): +<http://www.sisudoc.org/sisu/sisu_commands> .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] +<http://www.sisudoc.org/sisu/sisu_manual> +.SH CONFIGURATION +.SH CONFIGURATION FILES -.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]] +.SH CONFIG.YML -.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 -14.2 CONFIGURATION FILES (CONFIG.YML) - -.BR .B SiSU configration parameters are adjusted in the configuration file, which can be used to override the defaults set. This includes such things as which directory @@ -2877,17 +2837,27 @@ The configuration file is a yaml file, which means indentation is significant. .BR + .B SiSU -resource configuration is determined by looking at the following files if -they exist: +resource configuration is determined by looking at the following files if they +exist: + +.BR + ./_sisu/v7/sisurc.yml .BR ./_sisu/sisurc.yml .BR + ~/.sisu/v7/sisurc.yml + +.BR ~/.sisu/sisurc.yml .BR + /etc/sisu/v7/sisurc.yml + +.BR /etc/sisu/sisurc.yml .BR @@ -2905,144 +2875,129 @@ access details. If .B SiSU is installed a sample sisurc.yml may be found in /etc/sisu/sisurc.yml +.SH SISU_DOCUMENT_MAKE -.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 +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 - ~/.sisu/skin +The search order is as for resource configuration: .BR - /etc/sisu/skin + ./_sisu/v7/sisu_document_make .BR -.B Within the skin directory -are the following the default sub\-directories for document skins: + ./_sisu/sisu_document_make .BR - ./skin/doc + ~/.sisu/v7/sisu_document_make .BR - ./skin/dir + ~/.sisu/sisu_document_make .BR - ./skin/site + /etc/sisu/v7/sisu_document_make .BR -A skin is placed in the appropriate directory and the file named skin_[name].rb + /etc/sisu/sisu_document_make .BR -The skin itself is a ruby file which modifies the default appearances set in -the program. +A sample sisu_document_make can be found in the _sisu/ directory under along +with the provided sisu markup samples. +.SH CSS - CASCADING STYLE SHEETS (FOR HTML, XHTML AND XML) -.SH -15.1 DOCUMENT SKIN .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 +CSS files to modify the appearance of +.B SiSU +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 -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). +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 -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 +.I HTML: +html. css .BR -A site skin, modifies the program default skin. -.SH -15.4 SAMPLE SKINS +.I XML +DOM: dom.css .BR -With -.B SiSU -installed sample skins may be found in: -.BR - /etc/sisu/skin/doc and - /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc +.I XML +SAX: sax.css .BR -(or equivalent directory) and if sisu\-markup\-samples is installed also under: -.BR - /usr/share/doc/sisu/sisu_markup_samples/non\-free/_sisu/skin/doc +.I XHTML: +xhtml. css .BR -Samples of list.yml and promo.yml (which are used to create the right column -list) may be found in: +The default homepage may use homepage.css or html. css .BR - /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml (or equivalent - directory) +Under consideration is to permit the placement of a CSS file with a different +name in directory _sisu/css directory or equivalent.[^13] +.SH ORGANISING CONTENT - DIRECTORY STRUCTURE AND MAPPING -.SH -16. 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. +v3 has new options for the source directory tree, and output directory +structures of which there are 3 alternatives. +.SH DOCUMENT SOURCE DIRECTORY -.BR -The basic CSS file for html output is html.css, placing a file of that name in -directory _sisu/css or equivalent will result in the default file of that name -being overwritten. .BR -HTML: html.css +The document source directory is the directory in which sisu processing +commands are given. It contains the sisu source files (.sst .ssm .ssi), or (for +sisu v3 may contain) subdirectories with language codes which contain the sisu +source files, so all English files would go in subdirectory en/, French in fr/, +Spanish in es/ and so on. ISO 639-1 codes are used (as varied by po4a). A list +of available languages (and possible sub-directory names) can be obtained with +the command "sisu --help lang" The list of languages is limited to langagues +supported by XeTeX polyglosia. +.SH GENERAL DIRECTORIES -.BR -XML DOM: dom.css +.nf + ./subject_name/ -.BR -XML SAX: sax.css +% files stored at this level e.g. sisu_manual.sst or +% for sisu v3 may be under language sub-directories +% e.g. -.BR -XHTML: xhtml.css + ./subject_name/en -.BR -The default homepage may use homepage.css or html.css + ./subject_name/fr -.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.[^17] + ./subject_name/es -.SH -17. ORGANISING CONTENT -.BR + ./subject_name/_sisu + + ./subject_name/_sisu/css + + ./subject_name/_sisu/image +.fi + +.SH DOCUMENT OUTPUT DIRECTORY STRUCTURES + +.SH OUTPUT DIRECTORY ROOT -.SH -17.1 DIRECTORY STRUCTURE AND MAPPING .BR The output directory root can be set in the sisurc.yml file. Under the root, @@ -3052,10 +3007,10 @@ under the output directory root and the output for all documents contained in the directory of a particular name will be generated to subdirectories beneath that directory (poem or conventions). A document will be placed in a subdirectory of the same name as the document with the filetype identifier -stripped (.sst \.ssm) +stripped (.sst .ssm) .BR -The last part of a directory path, representing the sub\-directory in which a +The last part of a directory path, representing the sub-directory in which a document set resides, is the directory name that will be used for the output directory. This has implications for the organisation of document collections as it could make sense to place documents of a particular subject, or type @@ -3069,1423 +3024,985 @@ directory named after each institution, and these would be output to the same output directory. Skins could be associated with each institution on a directory basis and resulting documents will take on the appropriate different appearance. +.SH ALTERNATIVE OUTPUT STRUCTURES -.SH -17.2 ORGANISING CONTENT - -.SH -18. HOMEPAGES -.BR .BR -.B SiSU -is about the ability to auto\-generate documents. Home pages are regarded as -custom built items, and are not created by -.B SiSU -. More accurately, -.B SiSU -has a default home page, which will not be appropriate for use with other -sites, and the means to provide your own home page instead in one of two ways -as part of a site\'s configuration, these being: - -.BR -1. through placing your home page and other custom built documents in the -subdirectory _sisu/home/ (this probably being the easier and more convenient -option) - -.BR -2. through providing what you want as the home page in a skin, +There are 3 possibile output structures described as being, by language, by +filetype or by filename, the selection is made in sisurc.yml +.nf +#% output_dir_structure_by: language; filetype; or filename +output_dir_structure_by: language #(language & filetype, preferred?) +#output_dir_structure_by: filetype +#output_dir_structure_by: filename #(default, closest to original v1 & v2) +.fi -.BR -Document sets are contained in directories, usually organised by site or -subject. Each directory can/should have its own homepage. See the section on -directory structure and organisation of content. +.SH BY LANGUAGE -.SH -18.1 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 -configuration directory _sisu/home/ in any of the locations that is searched -for the configuration directory, namely \./_sisu; ~/_sisu; /etc/sisu From there -they are copied to the root of the output directory with the command: +The by language directory structure places output files .BR - sisu \-CC - -.SH -18.2 HOME PAGE WITHIN A SKIN +The by language directory structure separates output files by language code +(all files of a given language), and within the language directory by filetype. .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. +Its selection is configured in sisurc.yml .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 - - +output_dir_structure_by: language .nf - class Home -.BR - def homepage -.BR - # place the html content of your homepage here, this will become index.html -.BR - <<HOME <html> -.BR - <head></head> -.BR - <doc> -.BR - <p>this is my new homepage.</p> -.BR - </doc> -.BR - </html> -.BR - HOME -.BR - end -.BR - end + |-- en + |-- epub + |-- hashes + |-- html + | |-- viral_spiral.david_bollier + | |-- manifest + | |-- qrcode + | |-- odt + | |-- pdf + | |-- sitemaps + | |-- txt + | |-- xhtml + | `-- xml + |-- po4a + | `-- live-manual + | |-- po + | |-- fr + | `-- pot + `-- _sisu + |-- css + |-- image + |-- image_sys -> ../../_sisu/image_sys + `-- xml + |-- rnc + |-- rng + `-- xsd .fi -.SH -19. MARKUP AND OUTPUT EXAMPLES -.BR - -.SH -19.1 MARKUP EXAMPLES .BR -Current markup examples and document output samples are provided at -<http://www.jus.uio.no/sisu/SiSU/examples.html> +#by: language subject_dir/en/manifest/filename.html +.SH BY FILETYPE -.BR -Some markup with syntax highlighting may be found under -<http://www.jus.uio.no/sisu/sample/syntax> but is not as up to date. .BR -For some documents hardly any markup at all is required at all, other than a -header, and an indication that the levels to be taken into account by the -program in generating its output are. - -.SH -20. SISU SEARCH \- INTRODUCTION -.BR +The by filetype directory structure separates output files by filetype, all +html files in one directory pdfs in another and so on. Filenames are given a +language extension. .BR -.B SiSU -output can easily and conveniently be indexed by a number of standalone -indexing tools, such as Lucene, Hyperestraier. +Its selection is configured in sisurc.yml .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. +output_dir_structure_by: filetype +.nf + |-- epub + |-- hashes + |-- html + |-- viral_spiral.david_bollier + |-- manifest + |-- qrcode + |-- odt + |-- pdf + |-- po4a + |-- live-manual + | |-- po + | |-- fr + | `-- pot + |-- _sisu + | |-- css + | |-- image + | |-- image_sys -> ../../_sisu/image_sys + | `-- xml + | |-- rnc + | |-- rng + | `-- xsd + |-- sitemaps + |-- txt + |-- xhtml + `-- xml +.fi -.BR -In addition to this -.B SiSU -has the ability to populate a relational sql type database with documents at -an object level, with objects numbers that are shared across different output -types, which make them searchable with that degree of granularity. Basically, -your match criteria is met by these documents and at these locations within -each document, which can be viewed within the database directly or in various -output formats. -.SH -21. SQL .BR +#by: filetype subject_dir/html/filename/manifest.en.html +.SH BY FILENAME -.SH -21.1 POPULATING SQL TYPE DATABASES .BR -.B SiSU -feeds sisu markupd documents into sql type databases PostgreSQL[^18] and/or -SQLite[^19] database together with information related to document structure. +The by filename directory structure places most output of a particular file +(the different filetypes) in a common directory. .BR -This is one of the more interesting output forms, as all the structural data of -the documents are retained (though can be ignored by the user of the database -should they so choose). All site texts/documents are (currently) streamed to -four tables: - -.BR - * one containing semantic (and other) headers, including, title, author, - subject, (the Dublin Core...); - -.BR - * another the substantive texts by individual \"paragraph\" (or object) \- - along with structural information, each paragraph being identifiable by its - paragraph number (if it has one which almost all of them do), and the - substantive text of each paragraph quite naturally being searchable (both in - formatted and clean text versions for searching); and +Its selection is configured in sisurc.yml .BR - * a third containing endnotes cross\-referenced back to the paragraph from - which they are referenced (both in formatted and clean text versions for - searching). +output_dir_structure_by: filename +.nf + |-- epub + |-- po4a + |-- live-manual + | |-- po + | |-- fr + | `-- pot + |-- _sisu + | |-- css + | |-- image + | |-- image_sys -> ../../_sisu/image_sys + | `-- xml + | |-- rnc + | |-- rng + | `-- xsd + |-- sitemaps + |-- src + |-- pod + `-- viral_spiral.david_bollier +.fi -.BR - * a fourth table with a one to one relation with the headers table contains - full text versions of output, eg. pdf, html, xml, and ascii. .BR -There is of course the possibility to add further structures. +#by: filename subject_dir/filename/manifest.en.html +.SH REMOTE DIRECTORIES -.BR -At this level -.B SiSU -loads a relational database with documents chunked into objects, their -smallest logical structurally constituent parts, as text objects, with their -object citation number and all other structural information needed to construct -the document. Text is stored (at this text object level) with and without -elementary markup tagging, the stripped version being so as to facilitate ease -of searching. +.nf + ./subject_name/ -.BR -Being able to search a relational database at an object level with the -.B SiSU -citation system is an effective way of locating content generated by -.B SiSU -. As individual text objects of a document stored (and indexed) together with -object numbers, and all versions of the document have the same numbering, -complex searches can be tailored to return just the locations of the search -results relevant for all available output formats, with live links to the -precise locations in the database or in html/xml documents; or, the structural -information provided makes it possible to search the full contents of the -database and have headings in which search content appears, or to search only -headings etc. (as the Dublin Core is incorporated it is easy to make use of -that as well). +% containing sub_directories named after the generated files from which they are made -.SH -22. POSTGRESQL -.BR + ./subject_name/src -.SH -22.1 NAME +% contains shared source files text and binary e.g. sisu_manual.sst and sisu_manual.sst.zip -.BR -.B SiSU -\- Structured information, Serialized Units \- a document publishing system, -postgresql dependency package + ./subject_name/_sisu -.SH -22.2 DESCRIPTION +% configuration file e.g. sisurc.yml -.BR -Information related to using postgresql with sisu (and related to the -sisu_postgresql dependency package, which is a dummy package to install -dependencies needed for -.B SiSU -to populate a postgresql database, this being part of -.B SiSU -\- man sisu). + ./subject_name/_sisu/skin -.SH -22.3 SYNOPSIS +% skins in various skin directories doc, dir, site, yml -.BR - sisu \-D [instruction] [filename/wildcard \ if \ required] + ./subject_name/_sisu/css -.BR - sisu \-D \-\-pg \-\-[instruction] [filename/wildcard \ if \ required] + ./subject_name/_sisu/image -.SH -22.4 COMMANDS +% images for documents contained in this directory -.BR -Mappings to two databases are provided by default, postgresql and sqlite, the -same commands are used within sisu to construct and populate databases however -\-d (lowercase) denotes sqlite and \-D (uppercase) denotes postgresql, -alternatively \-\-sqlite or \-\-pgsql may be used + ./subject_name/_sisu/mm +.fi -.BR -.B \-D or \-\-pgsql -may be used interchangeably. +.SH SISUPOD -.SH -22.4.1 CREATE AND DESTROY DATABASE +.nf + ./sisupod/ -.TP -.B \-\-pgsql \-\-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) +% files stored at this level e.g. sisu_manual.sst -.TP -.B sisu \-D \-\-createdb -creates database where no database existed before + ./sisupod/_sisu -.TP -.B sisu \-D \-\-create -creates database tables where no database tables existed before +% configuration file e.g. sisurc.yml -.TP -.B sisu \-D \-\-Dropall -destroys database (including all its content)! kills data and drops tables, -indexes and database associated with a given directory (and directories of the -same name). + ./sisupod/_sisu/skin -.TP -.B sisu \-D \-\-recreate -destroys existing database and builds a new empty database structure +% skins in various skin directories doc, dir, site, yml -.SH -22.4.2 IMPORT AND REMOVE DOCUMENTS + ./sisupod/_sisu/css -.TP -.B sisu \-D \-\-import \-v [filename/wildcard] -populates database with the contents of the file. Imports documents(s) -specified to a postgresql database (at an object level). + ./sisupod/_sisu/image -.TP -.B sisu \-D \-\-update \-v [filename/wildcard] -updates file contents in database +% images for documents contained in this directory -.TP -.B sisu \-D \-\-remove \-v [filename/wildcard] -removes specified document from postgresql database. + ./sisupod/_sisu/mm +.fi -.SH -23. SQLITE -.BR +.SH HOMEPAGES -.SH -23.1 NAME .BR -.B SiSU -\- Structured information, Serialized Units \- a document publishing system. - -.SH -23.2 DESCRIPTION -.BR -Information related to using sqlite with sisu (and related to the sisu_sqlite -dependency package, which is a dummy package to install dependencies needed for .B SiSU -to populate an sqlite database, this being part of +is about the ability to auto-generate documents. Home pages are regarded as +custom built items, and are not created by +.B SiSU. +More accurately, .B SiSU -\- man sisu). - -.SH -23.3 SYNOPSIS - -.BR - sisu \-d [instruction] [filename/wildcard \ if \ required] - -.BR - sisu \-d \-\-(sqlite|pg) \-\-[instruction] [filename/wildcard \ if \ - required] - -.SH -23.4 COMMANDS +has a default home page, which will not be appropriate for use with other +sites, and the means to provide your own home page instead in one of two ways +as part of a site's configuration, these being: .BR -Mappings to two databases are provided by default, postgresql and sqlite, the -same commands are used within sisu to construct and populate databases however -\-d (lowercase) denotes sqlite and \-D (uppercase) denotes postgresql, -alternatively \-\-sqlite or \-\-pgsql may be used +1. through placing your home page and other custom built documents in the +subdirectory _sisu/home/ (this probably being the easier and more convenient +option) .BR -.B \-d or \-\-sqlite -may be used interchangeably. - -.SH -23.4.1 CREATE AND DESTROY DATABASE - -.TP -.B \-\-sqlite \-\-createall -initial step, creates required relations (tables, indexes) in existing -(sqlite) database (a database should be created manually and given the same -name as working directory, as requested) (rb.dbi) - -.TP -.B sisu \-d \-\-createdb -creates database where no database existed before - -.TP -.B sisu \-d \-\-create -creates database tables where no database tables existed before - -.TP -.B sisu \-d \-\-dropall -destroys database (including all its content)! kills data and drops tables, -indexes and database associated with a given directory (and directories of the -same name). - -.TP -.B sisu \-d \-\-recreate -destroys existing database and builds a new empty database structure - -.SH -23.4.2 IMPORT AND REMOVE DOCUMENTS - -.TP -.B sisu \-d \-\-import \-v [filename/wildcard] -populates database with the contents of the file. Imports documents(s) -specified to an sqlite database (at an object level). - -.TP -.B sisu \-d \-\-update \-v [filename/wildcard] -updates file contents in database - -.TP -.B sisu \-d \-\-remove \-v [filename/wildcard] -removes specified document from sqlite database. +2. through providing what you want as the home page in a skin, -.SH -24. INTRODUCTION .BR +Document sets are contained in directories, usually organised by site or +subject. Each directory can/should have its own homepage. See the section on +directory structure and organisation of content. +.SH HOME PAGE AND OTHER CUSTOM BUILT PAGES IN A SUB-DIRECTORY -.SH -24.1 SEARCH \- DATABASE FRONTEND SAMPLE, UTILISING DATABASE AND SISU FEATURES, -INCLUDING OBJECT CITATION NUMBERING (BACKEND CURRENTLY POSTGRESQL) .BR -Sample search frontend <http://search.sisudoc.org> [^20] A small database and -sample query front\-end (search from) that makes use of the citation system, -.I object citation numbering -to demonstrates functionality.[^21] +Custom built pages, including the home page index.html may be placed within the +configuration directory _sisu/home/ in any of the locations that is searched +for the configuration directory, namely ./_sisu ; ~/_sisu ; /etc/sisu From +there they are copied to the root of the output directory with the command: .BR -.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, LaTeX, -PDF and indeed the SQL database. You can then refer to one of the other outputs -or in the SQL database expand the text within the matched objects (paragraphs) -in the documents matched. + sisu -CC +.SH MARKUP AND OUTPUT EXAMPLES -.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.[^22] +.SH MARKUP EXAMPLES -.TP -.B sisu \-F \-\-webserv\-webrick -builds a cgi web search frontend for the database created .BR -The following is feedback on the setup on a machine provided by the help -command: +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://git.sisudoc.org> .BR - sisu \-\-help sql +For some documents hardly any markup at all is required at all, other than a +header, and an indication that the levels to be taken into account by the +program in generating its output are. +.SH SISU MARKUP SAMPLES -.nf - Postgresql -.BR - user: ralph -.BR - current db set: SiSU_sisu -.BR - port: 5432 .BR - dbi connect: DBI:Pg:database=SiSU_sisu;port=5432 -.BR - sqlite -.BR - current db set: /home/ralph/sisu_www/sisu/sisu_sqlite.db -.BR - dbi connect DBI:SQLite:/home/ralph/sisu_www/sisu/sisu_sqlite.db -.fi - -.BR -Note on databases built +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. .BR -By default, [unless \ otherwise \ specified] databases are built on a directory -basis, from collections of documents within that directory. The name of the -directory you choose to work from is used as the database name, i.e. if you are -working in a directory called /home/ralph/ebook the database SiSU_ebook is -used. [otherwise \ a \ manual \ mapping \ for \ the \ collection \ is \ -necessary] - -.SH -24.2 SEARCH FORM - -.TP -.B sisu \-F -generates a sample search form, which must be copied to the web\-server cgi -directory - -.TP -.B sisu \-F \-\-webserv\-webrick -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 +.I Accelerando, +Charles Stross (2005) +accelerando.charles_stross.sst .BR -The generated search form must be copied manually to the webserver directory as -instructed -.SH -25. HYPERESTRAIER -.BR +.I Alice's Adventures in Wonderland, +Lewis Carroll (1865) +alices_adventures_in_wonderland.lewis_carroll.sst .BR -See the documentation for hyperestraier: -.BR - <http://hyperestraier.sourceforge.net/> +.I CONTENT, +Cory Doctorow (2008) +content.cory_doctorow.sst .BR - /usr/share/doc/hyperestraier/index.html -.BR - man estcmd +.I Democratizing Innovation, +Eric von Hippel (2005) +democratizing_innovation.eric_von_hippel.sst .BR -on sisu_hyperestraier: -.BR - man sisu_hyperestraier +.I Down and Out in the Magic Kingdom, +Cory Doctorow (2003) +down_and_out_in_the_magic_kingdom.cory_doctorow.sst .BR - /usr/share/doc/sisu/sisu_markup/sisu_hyperestraier/index.html -.BR -NOTE: the examples that follow assume that sisu output is placed in the -directory /home/ralph/sisu_www +.I For the Win, +Cory Doctorow (2010) +for_the_win.cory_doctorow.sst .BR -(A) to generate the index within the webserver directory to be indexed: -.BR - estcmd gather \-sd [index \ name] [directory \ path \ to \ index] +.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 -the following are examples that will need to be tailored according to your -needs: -.BR - cd /home/ralph/sisu_www +.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 - estcmd gather \-sd casket /home/ralph/sisu_www -.BR -you may use the \'find\' command together with \'egrep\' to limit indexing to -particular document collection directories within the web server directory: +.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 - find /home/ralph/sisu_www \-type f | egrep - \'/home/ralph/sisu_www/sisu/.+?.html$\' |estcmd gather \-sd casket \- -.BR -Check which directories in the webserver/output directory (~/sisu_www or -elsewhere depending on configuration) you wish to include in the search index. +.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 -As sisu duplicates output in multiple file formats, it it is probably -preferable to limit the estraier index to html output, and as it may also be -desirable to exclude files \'plain.txt\', \'toc.html\' and -\'concordance.html\', as these duplicate information held in other html output -e.g. -.BR - find /home/ralph/sisu_www \-type f | egrep - \'/sisu_www/(sisu|bookmarks)/.+?.html$\' | egrep \-v - \'(doc|concordance).html$\' |estcmd gather \-sd casket \- +.I GNU GENERAL PUBLIC LICENSE v2, +Free Software Foundation (1991) +gpl2.fsf.sst .BR -from your current document preparation/markup directory, you would construct a -rune along the following lines: -.BR - find /home/ralph/sisu_www \-type f | egrep \'/home/ralph/sisu_www/([specify \ - first \ directory \ for \ inclusion]|[specify \ second \ directory \ for \ - inclusion]|[another \ directory \ for \ inclusion? \ \...])/.+?.html$\' | - egrep \-v \'(doc|concordance).html$\' |estcmd gather \-sd - /home/ralph/sisu_www/casket \- +.I GNU GENERAL PUBLIC LICENSE v3, +Free Software Foundation (2007) +gpl3.fsf.sst .BR -(B) to set up the search form -.BR -(i) copy estseek.cgi to your cgi directory and set file permissions to 755: +.I Gulliver's Travels, +Jonathan Swift (1726 / 1735) +gullivers_travels.jonathan_swift.sst .BR - sudo cp \-vi /usr/lib/estraier/estseek.cgi /usr/lib/cgi\-bin -.BR - sudo chmod \-v 755 /usr/lib/cgi\-bin/estseek.cgi +.I Little Brother, +Cory Doctorow (2008) +little_brother.cory_doctorow.sst .BR - sudo cp \-v /usr/share/hyperestraier/estseek.* /usr/lib/cgi\-bin -.BR - [see \ estraier \ documentation \ for \ paths] +.I The Cathederal and the Bazaar, +Eric Raymond (2000) +the_cathedral_and_the_bazaar.eric_s_raymond.sst .BR -(ii) edit estseek.conf, with attention to the lines starting \'indexname:\' and -\'replace:\': -.BR - indexname: /home/ralph/sisu_www/casket +.I The Public Domain - Enclosing the Commons of the Mind, +James Boyle (2008) +the_public_domain.james_boyle.sst .BR - replace: ^file:///home/ralph/sisu_www{{!}}http://localhost -.BR - replace: /index.html?${{!}}/ +.I The Wealth of Networks - How Social Production Transforms Markets and +Freedom, +Yochai Benkler (2006) +the_wealth_of_networks.yochai_benkler.sst .BR -(C) to test using webrick, start webrick: -.BR - sisu \-W - -.BR -and try open the url: <http://localhost:8081/cgi\-bin/estseek.cgi> +.I Through the Looking Glass, +Lewis Carroll (1871) +through_the_looking_glass.lewis_carroll.sst -.SH -26. SISU_WEBRICK .BR -.SH -26.1 NAME +.I Two Bits - The Cultural Significance of Free Software, +Christopher Kelty (2008) +two_bits.christopher_kelty.sst .BR -.B SiSU -\- Structured information, Serialized Units \- a document publishing system -.SH -26.2 SYNOPSIS +.I UN Contracts for International Sale of Goods, +UN (1980) +un_contracts_international_sale_of_goods_convention_1980.sst .BR -sisu_webrick [port] -.BR -or - -.BR -sisu \-W [port] +.I Viral Spiral, +David Bollier (2008) +viral_spiral.david_bollier.sst +.SH SISU SEARCH - INTRODUCTION -.SH -26.3 DESCRIPTION .BR -sisu_webrick is part of -.B SiSU -(man sisu) sisu_webrick starts -.B Ruby -\'s Webrick web\-server and points it to the directories to which -.B SiSU -output is written, providing a list of these directories (assuming -.B SiSU -is in use and they exist). +Because the document structure of sites created is clearly defined, and the +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 map +the results to the html or other output, which has richer text markup. .BR -The default port for sisu_webrick is set to 8081, this may be modified in the -yaml file: ~/.sisu/sisurc.yml a sample of which is provided as -/etc/sisu/sisurc.yml (or in the equivalent directory on your system). - -.SH -26.4 SUMMARY OF MAN PAGE -.BR -sisu_webrick, may be started on it\'s own with the command: sisu_webrick [port] -or using the sisu command with the \-W flag: sisu \-W [port] +.B SiSU +can populate a relational sql type database with documents at an object level, +including objects numbers that are shared across different output types. Making +a document corpus searchable with that degree of granularity. Basically, your +match criteria is met by these documents and at these locations within each +document, which can be viewed within the database directly or in various output +formats. .BR -where no port is given and settings are unchanged the default port is 8081 - -.SH -26.5 DOCUMENT PROCESSING COMMAND FLAGS -.BR -sisu \-W [port] starts -.B Ruby -Webrick web\-server, serving .B SiSU -output directories, on the port provided, or if no port is provided and the -defaults have not been changed in ~/.sisu/sisurc.yaml then on port 8081 - -.SH -26.6 FURTHER INFORMATION +can populate an sql database (sqlite3 or postgresql) with documents made up of +their objects. It also can generate a cgi search form that can be used to query +the database. .BR -For more information on -.B SiSU -see: <http://www.jus.uio.no/sisu> +In order to use the built in search functionality you would take the following +steps. .BR -or man sisu - -.SH -26.7 AUTHOR +* use sisu to populate an sql database with with a sisu markup content .BR -Ralph Amissah ralph@amissah.com or ralph.amissah@gmail.com - -.SH -26.8 SEE ALSO + * sqlite3 should work out of the box .BR - sisu(1) + * postgresql may require some initial database configuration .BR - sisu_vim(7) +* provide a way to query the database, which sisu can assist with by .BR - sisu(8) + * generating a sample ruby cgi search form, required (sisu configuration + recommended) -.SH -27. REMOTE SOURCE DOCUMENTS .BR + * adding a query field for this search form to be added to all html files + (sisu configuration required) +.SH SQL -.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 +.SH POPULATE THE DATABASE -.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. - - +TO populate the sql database, run sisu against a sisu markup file with one of +the following sets of flags .nf - sisu \-3 http://[provide \ url \ to \ valid \ \.sst \ or \ \.ssm \ file] +sisu --sqlite filename.sst .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. - -.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. - - +creates an sqlite3 database containing searchable content of just the sisu +markup document selected .nf - sisu \-3 http://[provide \ url \ to \ valid \ sisupod.zip \ or \ \.ssp \ file] +sisu --sqlite --update filename.sst .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 -28. 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. - - +creates an sqlite3 database containing searchable content of marked up +document(s) selected by the user from a common directory .nf - sisu \-3R sisu_remote.sst +sisu --pg --update filename.sst .fi -.SH -28.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 -28.2 CONFIGURATION - -.BR -[expand \ on \ the \ setting \ up \ of \ an \ ssh\-agent \ / \ keychain] - -.SH -29. 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. +fills a postgresql database with searchable content of marked up document(s) +selected by the user from a common directory -.SH -30. QUICKSTART \- GETTING STARTED HOWTO .BR - -.SH -30.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 -30.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: - - +For postgresql the first time the command is run in a given directory the user +will be prompted to create the requisite database, at the time of writing the +prompt sisu provides is as follows: .nf - aptitude update -.BR - aptitude install sisu\-complete +no connection with pg database established, you may need to run: + createdb "SiSU.7a.current" + after that don't forget to run: + sisu --pg --createall + before attempting to populate the database .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 - d -.fi +The named database that sisu expects to find must exist and if necessary be +created using postgresql tools. If the database exist but the database tables +do not, sisu will attempt to create the tables it needs, the equivalent of the +requested sisu --pg --createall command. .BR -The aptitude commands become: +Once this is done, the sql database is populated and ready to be queried. +.SH SQL TYPE DATABASES -.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 +feeds sisu markup documents into sql type databases +.I PostgreSQL +[^14] and/or +.I SQLite +[^15] database together with information related to document structure. - -.nf - #/etc/apt/sources.list -.BR - 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 - -.BR -repeat the aptitude commands - - -.nf - aptitude update -.BR - 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 -30.1.2 RPM INSTALLATION +This is one of the more interesting output forms, as all the structural data of +the documents are retained (though can be ignored by the user of the database +should they so choose). All site texts/documents are (currently) streamed to +four tables: .BR -RPMs are provided though untested, they are prepared by running alien against -the source package, and against the debs. + * one containing semantic (and other) headers, including, title, author, + subject, (the + .I Dublin Core. + ..); .BR -They may be downloaded from: + * another the substantive texts by individual "paragraph" (or object) - along + with structural information, each paragraph being identifiable by its + paragraph number (if it has one which almost all of them do), and the + substantive text of each paragraph quite naturally being searchable (both in + formatted and clean text versions for searching); and .BR - <http://www.jus.uio.no/sisu/SiSU/download.html#rpm> + * a third containing endnotes cross-referenced back to the paragraph from + which they are referenced (both in formatted and clean text versions for + searching). .BR -as root type: + * a fourth table with a one to one relation with the headers table contains + full text versions of output, eg. pdf, html, xml, and + .I ascii. .BR - rpm \-i [rpm \ package \ name] - -.SH -30.1.3 INSTALLATION FROM SOURCE +There is of course the possibility to add further structures. .BR -To install +At this level .B SiSU -from source check information at: +loads a relational database with documents chunked into objects, their smallest +logical structurally constituent parts, as text objects, with their object +citation number and all other structural information needed to construct the +document. Text is stored (at this text object level) with and without +elementary markup tagging, the stripped version being so as to facilitate ease +of searching. .BR - <http://www.jus.uio.no/sisu/SiSU/download.html#current> +Being able to search a relational database at an object level with the +.B SiSU +citation system is an effective way of locating content generated by +.B SiSU. +As individual text objects of a document stored (and indexed) together with +object numbers, and all versions of the document have the same numbering, +complex searches can be tailored to return just the locations of the search +results relevant for all available output formats, with live links to the +precise locations in the database or in html/xml documents; or, the structural +information provided makes it possible to search the full contents of the +database and have headings in which search content appears, or to search only +headings etc. (as the +.I Dublin Core +is incorporated it is easy to make use of that as well). +.SH POSTGRESQL -.BR -* download the source package +.SH NAME -.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, various XMLs, including ODF (and will also -produce LaTeX). Dependencies required for further actions, though it relies on -the installation of additional dependencies which the source tarball does not -take care of, for things like using a database (postgresql or sqlite)[^23] or -converting LaTeX to pdf. +- Structured information, Serialized Units - a document publishing system, +postgresql dependency package +.SH DESCRIPTION -.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 +Information related to using postgresql with sisu (and related to the +sisu_postgresql dependency package, which is a dummy package to install +dependencies needed for .B SiSU -as root type: - - -.nf - ruby setup.rb config -.BR - ruby setup.rb setup -.BR - #[and \ as \ root:] -.BR - 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 +to populate a postgresql database, this being part of .B SiSU -as root type: +- man sisu) . +.SH SYNOPSIS -.BR - ruby install base .BR -or for a more complete installation: + sisu -D [instruction] [filename/wildcard if required] .BR - ruby install + sisu -D --pg --[instruction] [filename/wildcard if required] +.SH COMMANDS -.BR -or .BR - ruby install base +Mappings to two databases are provided by default, postgresql and sqlite, the +same commands are used within sisu to construct and populate databases however +-d (lowercase) denotes sqlite and -D (uppercase) denotes postgresql, +alternatively --sqlite or --pgsql may be used .BR -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: +.B -D or --pgsql +may be used interchangeably. +.SH CREATE AND DESTROY DATABASE -.BR - <http://make.rubyforge.org/> +.TP +.B --pgsql --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) +.TP +.B sisu -D --createdb +creates database where no database existed before +.TP +.B sisu -D --create +creates database tables where no database tables existed before +.TP +.B sisu -D --Dropall +destroys database (including all its content)! kills data and drops tables, +indexes and database associated with a given directory (and directories of the +same name). +.TP +.B sisu -D --recreate +destroys existing database and builds a new empty database structure +.SH IMPORT AND REMOVE DOCUMENTS -.BR - <http://rubyforge.org/frs/?group_id=615> +.TP +.B sisu -D --import -v [filename/wildcard] +populates database with the contents of the file. Imports documents(s) +specified to a postgresql database (at an object level). +.TP +.B sisu -D --update -v [filename/wildcard] +updates file contents in database +.TP +.B sisu -D --remove -v [filename/wildcard] +removes specified document from postgresql database. +.SH SQLITE -.BR -For a list of alternative actions you may type: +.SH NAME -.BR - ruby install help .BR - ruby install \-T -.SH -30.2 TESTING SISU, GENERATING OUTPUT +.B SiSU +- Structured information, Serialized Units - a document publishing system. +.SH DESCRIPTION -.BR -To check which version of sisu is installed: .BR -sisu \-v +Information related to using sqlite with sisu (and related to the sisu_sqlite +dependency package, which is a dummy package to install dependencies needed for +.B SiSU +to populate an sqlite database, this being part of +.B SiSU +- man sisu) . +.SH SYNOPSIS -.BR -Depending on your mode of installation one or a number of markup sample files -may be found either in the directory: .BR -... + sisu -d [instruction] [filename/wildcard if required] .BR -or + sisu -d --(sqlite|pg) --[instruction] [filename/wildcard if required] +.SH COMMANDS -.BR -... .BR -change directory to the appropriate one: +Mappings to two databases are provided by default, postgresql and sqlite, the +same commands are used within sisu to construct and populate databases however +-d (lowercase) denotes sqlite and -D (uppercase) denotes postgresql, +alternatively --sqlite or --pgsql may be used .BR -cd /usr/share/doc/sisu/sisu_markup_samples/dfsg - -.SH -30.2.1 BASIC TEXT, PLAINTEXT, HTML, XML, ODF -.BR -Having moved to the directory that contains the markup samples (see -instructions above if necessary), choose a file and run sisu against it +.B -d or --sqlite +may be used interchangeably. +.SH CREATE AND DESTROY DATABASE -.BR -sisu \-NhwoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst +.TP +.B --sqlite --createall +initial step, creates required relations (tables, indexes) in existing (sqlite) +database (a database should be created manually and given the same name as +working directory, as requested) (rb.dbi) +.TP +.B sisu -d --createdb +creates database where no database existed before +.TP +.B sisu -d --create +creates database tables where no database tables existed before +.TP +.B sisu -d --dropall +destroys database (including all its content)! kills data and drops tables, +indexes and database associated with a given directory (and directories of the +same name). +.TP +.B sisu -d --recreate +destroys existing database and builds a new empty database structure +.SH IMPORT AND REMOVE DOCUMENTS -.BR -this will generate html including a concordance file, opendocument text format, -plaintext, XHTML and various forms of XML, and OpenDocument text +.TP +.B sisu -d --import -v [filename/wildcard] +populates database with the contents of the file. Imports documents(s) +specified to an sqlite database (at an object level). +.TP +.B sisu -d --update -v [filename/wildcard] +updates file contents in database +.TP +.B sisu -d --remove -v [filename/wildcard] +removes specified document from sqlite database. +.SH CGI SEARCH FORM -.SH -30.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 -) +For the search form, which is a single search page .BR -Having moved to the directory that contains the markup samples (see -instructions above if necessary), choose a file and run sisu against it +* configure the search form .BR -sisu \-pv free_as_in_freedom.rms_and_free_software.sam_williams.sst +* generate the sample search form with the sisu command, (this will be based on +the configuration settings and existing found sisu databases) .BR -sisu \-3 free_as_in_freedom.rms_and_free_software.sam_williams.sst +For postgresql web content you may need to edit the search cgi script. Two +things to look out for are that the user is set as needed, and that the any +different databases that you wish to be able to query are listed. .BR -should generate most available output formats: html including a concordance -file, opendocument text format, plaintext, XHTML and various forms of XML, and -OpenDocument text and pdf - -.SH -30.2.3 RELATIONAL DATABASE \- POSTGRESQL, SQLITE +correctly, you may want www-data rather than your username. +.nf +@user='www-data' +.fi -.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 +* check the search form, copy it to the appropriate cgi directory and set the +correct permissions .BR -sisu \-\-sqlite \-\-recreate +For a search form to appear on each html page, you need to: .BR -sisu \-\-sqlite \-v \-\-import -free_as_in_freedom.rms_and_free_software.sam_williams.sst +* rely on the above mentioned configuration of the search form .BR -sisu \-\-pgsql \-\-recreate +* configure the html search form to be on .BR -sisu \-\-pgsql \-v \-\-import -free_as_in_freedom.rms_and_free_software.sam_williams.sst +* run the html command +.SH SETUP SEARCH FORM -.SH -30.3 GETTING HELP - -.SH -30.3.1 THE MAN PAGES .BR -Type: +You will need a web server, httpd with cgi enabled, and a postgresql database +to which you are able to create databases. .BR - man sisu +Setup postgresql, make sure you are able to create and write to the database, +e.g.: +.nf +sudo su postgres + createuser -d -a ralph +.fi -.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> [^24] +You then need to create the database that sisu will use, for sisu manual in the +directory manual/en for example, (when you try to populate a database that does +not exist sisu prompts as to whether it exists): +.nf +createdb SiSU.7a.manual +.fi -.BR -* sisu.8 <http://www.jus.uio.no/sisu/man/sisu.8> [^25] .BR -* man directory <http://www.jus.uio.no/sisu/man> [^26] -.SH -30.3.2 BUILT IN HELP +.B SiSU +is then able to create the required tables that allow you to populate the +database with documents in the directory for which it has been created: +.nf +sisu --pg --createall -v +.fi -.BR -sisu \-\-help .BR -sisu \-\-help \-\-env +You can then start to populate the database, in this example with a single +document: +.nf +sisu --pg --update -v en/sisu_manual.ssm +.fi -.BR -sisu \-\-help \-\-commands .BR -sisu \-\-help \-\-markup - -.SH -30.3.3 THE HOME PAGE +To create a sample search form, from within the same directory run: +.nf +sisu --sample-search-form --db-pg +.fi -.BR -<http://www.jus.uio.no/sisu> .BR -<http://www.jus.uio.no/sisu/SiSU> - -.SH -30.4 MARKUP SAMPLES +and copy the resulting cgi form to your cgi-bin directory .BR -A number of markup samples (along with output) are available off: +A sample setup for nginx is provided that assumes data will be stored under +/srv/www and cgi scripts under /srv/cgi +.SH SEARCH - DATABASE FRONTEND SAMPLE, UTILISING DATABASE AND SISU FEATURES, +INCLUDING OBJECT CITATION NUMBERING (BACKEND CURRENTLY POSTGRESQL) -.BR -<http://www.jus.uio.no/sisu/SiSU/examples.html> .BR -Additional markup samples are packaged separately in the file: +Sample search frontend <http://search.sisudoc.org> [^16] A small database and +sample query front-end (search from) that makes use of the citation system, .I +object citation numbering +to demonstrates functionality.[^17] .BR -.B * -.BR -On -.B Debian -they are available in non\-free[^27] to include them it is necessary to -include non\-free in your /etc/apt/source.list or obtain them from the sisu -home site. +.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 +.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. -.SH -31. EDITOR FILES, SYNTAX HIGHLIGHTING .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.[^18] +.TP +.B sisu -F --webserv-webrick +builds a cgi web search frontend for the database created .BR -The directory: +The following is feedback on the setup on a machine provided by the help +command: .BR - \./data/sisu/conf/editor\-syntax\-etc/ + sisu --help sql +.nf +Postgresql + user: ralph + current db set: SiSU_sisu + port: 5432 + dbi connect: DBI:Pg:database=SiSU_sisu;port=5432 + +sqlite + current db set: /home/ralph/sisu_www/sisu/sisu_sqlite.db + dbi connect DBI:SQLite:/home/ralph/sisu_www/sisu/sisu_sqlite.db +.fi -.BR - /usr/share/sisu/conf/editor\-syntax\-etc .BR -contains rudimentary sisu syntax highlighting files for: +Note on databases built .BR -* (g)vim <http://www.vim.org> +By default, [unless otherwise specified] databases are built on a directory +basis, from collections of documents within that directory. The name of the +directory you choose to work from is used as the database name, i.e. if you are +working in a directory called /home/ralph/ebook the database SiSU_ebook is +used. [otherwise a manual mapping for the collection is necessary] +.SH SEARCH FORM -.BR - package: sisu\-vim +.TP +.B sisu -F +generates a sample search form, which must be copied to the web-server cgi +directory +.TP +.B sisu -F --webserv-webrick +generates a sample search form for use with the webrick server, which must be +copied to the web-server cgi directory +.TP +.B sisu -W +starts the webrick server which should be available wherever sisu is properly +installed .BR -status: largely done +The generated search form must be copied manually to the webserver directory as +instructed +.SH SISU_WEBRICK -.BR - there is a vim syntax highlighting and folds component +.SH NAME -.BR -* gedit <http://www.gnome.org/projects/gedit> .BR -* gobby <http://gobby.0x539.de/> -.BR - file: sisu.lang +.B SiSU +- Structured information, Serialized Units - a document publishing system +.SH SYNOPSIS -.BR -place in: .BR - /usr/share/gtksourceview\-1.0/language\-specs +sisu_webrick [port] .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 +sisu -W [port] +.SH DESCRIPTION -.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\-examples/config/syntax_hi\") - -.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) +sisu_webrick is part of +.B SiSU +(man sisu) sisu_webrick starts +.B Ruby +' s Webrick web-server and points it to the directories to which +.B SiSU +output is written, providing a list of these directories (assuming +.B SiSU +is in use and they exist). .BR - status: this includes: syntax highlighting; vim folds; some error checking +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 SUMMARY OF MAN PAGE -.BR - comments: this editor features display line wrap .BR -NOTE: +sisu_webrick, may be started on it's own with the command: sisu_webrick [port] +or using the sisu command with the -W flag: sisu -W [port] .BR -[ \ .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] +where no port is given and settings are unchanged the default port is 8081 +.SH DOCUMENT PROCESSING COMMAND FLAGS -.SH -32. HOW DOES SISU WORK? -.BR .BR +sisu -W [port] starts +.B Ruby +Webrick web-server, serving .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). +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 SUMMARY OF FEATURES -.SH -33. 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. +* sparse/minimal markup (clean utf-8 source texts). Documents are prepared in 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 -pattern\-match description, or for heading levels individually); basic text -attributes (bold, italics, underscore, strike\-through etc.) as required; and +pattern-match description, or for heading levels individually); basic text +attributes (bold, italics, underscore, strike-through etc.) as required; and semantic information related to the document (header information, extended beyond the Dublin core and easily further extended as required); the headers may also contain processing instructions. .B SiSU -markup is primarily an abstraction of document structure and document -metadata to permit taking advantage of the basic strengths of existing -alternative practical standard ways of representing documents [be \ that \ -browser \ viewing, \ paper \ publication, \ sql \ search \ etc.] (html, xml, -odf, latex, pdf, sql) +markup is primarily an abstraction of document structure and document metadata +to permit taking advantage of the basic strengths of existing alternative +practical standard ways of representing documents [be that browser viewing, +paper publication, sql search etc.] (html, epub, xml, odf, latex, pdf, sql) .BR * for output produces reasonably elegant output of established industry and @@ -4494,35 +4011,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 - * XML \- both in sax and dom style xml structures for further development as - required +* +.I EPUB .BR - * ODF \- open document format, the iso standard for document storage +* +.I XML +- both in sax and dom style xml structures for further development as required .BR - * LaTeX \- used to generate pdf +* +.I ODT +- Open Document Format text, the iso standard for document storage .BR - * pdf (via LaTeX) +* +.I LaTeX +- used to generate pdf .BR - * sql \- population of an sql database, (at the same object level that is - used to cite text within a document) +* +.I PDF +(via +.I LaTeX +) + +.BR +* +.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 @@ -4533,29 +4074,34 @@ browsers and formats. sisu seeks to provide a common way of pinpoint the text within a document, (which can be utilized for citation and by search engines). The outputs share a common numbering system that is meaningful (to man and machine) across all digital outputs whether paper, screen, or database -oriented, (pdf, HTML, xml, sqlite, postgresql), this numbering system can be -used to reference content. +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 -formats, having a very sparsely marked\-up source document base. there is a -considerable degree of future\-proofing, output representations are -\"upgradeable\", and new document formats may be added. e.g. addition of odf -(open document text) module in 2006 and in future html5 output sometime in -future, without modification of existing prepared texts +formats, having a very sparsely marked-up source document base. there is a +considerable degree of future-proofing, output representations are +"upgradeable", and new document formats may be added. e.g. addition of odf +(open document text) module in 2006, epub in 2009 and in future html5 output +sometime in future, without modification of existing prepared texts .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 @@ -4564,8 +4110,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 @@ -4578,9 +4126,16 @@ 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, XML, ODF, -LaTeX). To use a database you of course need that, and to convert the LaTeX +.B Ruby, +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 @@ -4592,9 +4147,10 @@ Syntax highlighting for markup is available for a number of text editors. .BR + .B SiSU -is less about document layout than about finding a way with little markup to -be able to construct an abstract representation of a document that makes it +is less about document layout than about finding a way with little markup to be +able to construct an abstract representation of a document that makes it possible to produce multiple representations of it which may be rather different from each other and used for different purposes, whether layout and publishing, or search of content @@ -4604,8 +4160,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 @@ -4615,461 +4171,166 @@ possible representations that are quite different from those offered at present. For example objects could be saved individually and identified by their hashes, with an index of how the objects relate to each other to form a document. - -.SH -34. HELP SOURCES -.BR - -.BR -For a summary of alternative ways to get help on -.B SiSU -try one of the following: - -.BR -.B man page - -.BR - man sisu_help - -.BR -.B man2html - -.BR - <http://www.jus.uio.no/sisu/man/sisu_help.1.html> - -.BR -.B sisu generated output \- links to html - -.BR - <http://sisudoc.org/sisu/sisu_help/index.html> - -.BR -.B help sources lists - -.BR -Alternative sources for this help sources page listed here: - -.BR - man sisu_help_sources - -.BR - <http://sisudoc.org/sisu/sisu_help_sources/index.html> - -.SH -34.1 MAN PAGES - -.SH -34.1.1 MAN - -.BR - man sisu - -.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 -34.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, and odf which may be also be accessed via the html pages[^28] - -.SH -34.2.1 WWW.SISUDOC.ORG - -.BR -<http://sisudoc.org/sisu/sisu_manual/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_manual/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_commands/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_complete/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_configuration/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_description/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_examples/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_faq/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_filetypes/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_help/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_help_sources/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_howto/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_introduction/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_manual/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_markup/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_output_overview/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_pdf/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_postgresql/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_quickstart/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_remote/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_search/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_skin/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_sqlite/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_syntax_highlighting/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_vim/index.html> - -.BR - <http://sisudoc.org/sisu/sisu_webrick/index.html> - -.SH -34.3 MAN2HTML - -.SH -34.3.1 LOCALLY INSTALLED - -.BR -<file:///usr/share/doc/sisu/html/sisu.1.html> - -.BR -<file:///usr/share/doc/sisu/html/sisu_help.1.html> - -.BR -<file:///usr/share/doc/sisu/html/sisu_help_sources.1.html> - -.BR - /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 - -.BR - /usr/share/doc/sisu/html/sisu_sqlite.7.html - -.BR - /usr/share/doc/sisu/html/sisu_webrick.1.html - -.SH -34.3.2 WWW.JUS.UIO.NO/SISU - -.BR -<http://www.jus.uio.no/sisu/man/sisu.1.html> - -.BR - <http://www.jus.uio.no/sisu/man/sisu.1.html> - -.BR - <http://www.jus.uio.no/sisu/man/sisu_complete.7.html> - -.BR - <http://www.jus.uio.no/sisu/man/sisu_pdf.7.html> - -.BR - <http://www.jus.uio.no/sisu/man/sisu_postgresql.7.html> - -.BR - <http://www.jus.uio.no/sisu/man/sisu_sqlite.7.html> - -.BR - <http://www.jus.uio.no/sisu/man/sisu_webrick.1.html> - -.SH -DOCUMENT INFORMATION (METADATA) -.BR - -.SH -METADATA -.BR - -.BR -Document Manifest @ <http://sisudoc.org/sisu_manual/sisu/sisu_manifest.html> - -.BR -.B Dublin Core -(DC) - -.BR -.I DC tags included with this document are provided here. - -DC Title: -.I SiSU \- Manual - -DC Creator: -.I Ralph Amissah - -DC Rights: -3 - -.BR -DC Type: -.I information - -.BR -DC Date created: -.I 2002\-08\-28 - -.BR -DC Date issued: -.I 2002\-08\-28 - -.BR -DC Date available: -.I 2002\-08\-28 - -.BR -DC Date modified: -.I 2008\-05\-22 - -.BR -DC Date: -.I 2008\-05\-22 - -.BR -.B Version Information - -.BR -Sourcefile: -.I sisu.ssm.sst - -.BR -Filetype: -.I SiSU text insert 0.67 - -.BR -Sourcefile Digest, MD5(sisu.ssm.sst)= -.I 7fbab3b7c0fd0ed2e128585c2982c5c8 - -.BR -Skin_Digest: MD5(skin_sisu_manual.rb)= -.I 072b2584bedea82ea8a416587b9fa244 - -.BR -.B Generated - -.BR -Document (metaverse) last generated: -.I Mon Jul 21 02:54:34 \-0400 2008 - -.BR -Generated by: -.I SiSU -.I 0.68.0 -of 2008w29/1 (2008\-07\-21) - -.BR -Ruby version: -.I ruby 1.8.7 (2008\-06\-20 patchlevel 22) \ [i486\-linux] - -.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. -.TP -.BI 2. -i.e. the html, pdf, odf outputs are each built individually and optimised for -that form of presentation, rather than for example the html being a saved -version of the odf, or the pdf being a saved version of the html. -.TP -.BI 3. -the different heading levels -.TP -.BI 4. -units of text, primarily paragraphs and headings, also any tables, poems, -code-blocks -.TP -.BI 5. -Specification submitted by Adobe to ISO to become a full open ISO -specification -<http://www.linux-watch.com/news/NS7542722606.html> -.TP -.BI 6. -ISO/IEC 26300:2006 .TP .BI *1. square brackets + +.BR .TP .BI *2. square brackets + +.BR .TP .BI +1. square brackets + +.BR .TP -.BI 7. +.BI 1. <http://www.jus.uio.no/sisu/man/> + +.BR .TP -.BI 8. +.BI 2. <http://www.jus.uio.no/sisu/man/sisu.1.html> + +.BR .TP -.BI 9. +.BI 3. 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 10. +.BI 4. files should be prepared using UTF-8 character encoding + +.BR .TP -.BI 11. +.BI 5. a footnote or endnote + +.BR .TP -.BI 12. +.BI 6. self contained endnote marker & endnote in one + +.BR .TP .BI *. unnumbered asterisk footnote/endnote, insert multiple asterisks if required + +.BR .TP .BI **. another unnumbered asterisk footnote/endnote + +.BR .TP .BI *3. editors notes, numbered asterisk footnote/endnote series + +.BR .TP .BI +2. -editors notes, numbered asterisk footnote/endnote series +editors notes, numbered plus symbol footnote/endnote series + +.BR .TP -.BI 13. -<http://www.jus.uio.no/sisu/> +.BI 7. +<http://www.sisudoc.org/> + +.BR .TP -.BI 14. +.BI 8. <http://www.ruby-lang.org/en/> + +.BR .TP -.BI 15. +.BI 9. Table from the Wealth of Networks by Yochai Benkler <http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler> + +.BR .TP -.BI 16. +.BI 10. +for which you may alternatively use the full form author: title: and year: + +.BR +.TP +.BI 11. +Quixote and Panza, Taming Windmills (1605), pp 1000 - 1001 also, Benkler, Wealth of Networks (2006), p 1 + +.BR +.TP +.BI 12. \.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 +have "accidents", working on a \.ssc file that is overwritten by subsequent processing. It may be however that when the resulting file is shared \.ssc is an appropriate suffix to use. + +.BR .TP -.BI 17. -\.B SiSU -has worked this way in the past, though this was dropped as it was thought -the complexity outweighed the flexibility, however, the balance was rather fine -and this behaviour could be reinstated. +.BI 13. +SiSU has worked this way in the past, though this was dropped as it was +thought the complexity outweighed the flexibility, however, the balance was +rather fine and this behaviour could be reinstated. + +.BR .TP -.BI 18. -<http://www.postgresql.org/> -<http://advocacy.postgresql.org/> +.BI 14. +<http://www.postgresql.org/> <http://advocacy.postgresql.org/> <http://en.wikipedia.org/wiki/Postgresql> + +.BR .TP -.BI 19. -<http://www.hwaci.com/sw/sqlite/> -<http://en.wikipedia.org/wiki/Sqlite> +.BI 15. +<http://www.hwaci.com/sw/sqlite/> <http://en.wikipedia.org/wiki/Sqlite> + +.BR .TP -.BI 20. +.BI 16. <http://search.sisudoc.org> + +.BR .TP -.BI 21. +.BI 17. (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 22. +.BI 18. of this feature when demonstrated to an IBM software innovations evaluator in 2004 he said to paraphrase: this could be of interest to us. We have large document management systems, you can search hundreds of thousands of documents and we can tell you which documents meet your search criteria, but there is no way we can tell you without opening each document where within each your matches are found. -.TP -.BI 23. -There is nothing to stop MySQL support being added in future. -.TP -.BI 24. -<http://www.jus.uio.no/sisu/man/sisu.1> -.TP -.BI 25. -<http://www.jus.uio.no/sisu/man/sisu.8> -.TP -.BI 26. -<http://www.jus.uio.no/sisu/man> -.TP -.BI 27. -the -.B Debian -Free Software guidelines require that everything distributed within -.B Debian -can be changed - and the documents are authors' works that while freely -distributable are not freely changeable. -.TP -.BI 28. -named index.html or more extensively through sisu_manifest.html + +.BR .TP -Other versions of this document: -.TP -manifest: <http://www.jus.uio.no/sisu/sisu/sisu_manifest.html> -.TP -html: <http://www.jus.uio.no/sisu/sisu/toc.html> -.TP -pdf: <http://www.jus.uio.no/sisu/sisu/portrait.pdf> -.TP -pdf: <http://www.jus.uio.no/sisu/sisu/landscape.pdf> -.TP -at: <http://www.jus.uio.no/sisu> -.TP -.TP -* Generated by: SiSU 0.70.0 of 2008w48/3 (2008-12-03) +.SH SEE ALSO + 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 -* Ruby version: ruby 1.8.7 (2008-08-11 patchlevel 72) [i486-linux] +.SH HOMEPAGE + More information about SiSU can be found at <http://www.sisudoc.org/> or <http://www.jus.uio.no/sisu/> .TP -* Last Generated on: Tue Dec 09 12:24:07 -0500 2008 +.SH SOURCE + <http://git.sisudoc.org/> .TP -* SiSU http://www.jus.uio.no/sisu +.SH AUTHOR + SiSU is written by Ralph Amissah <ralph@amissah.com> diff --git a/man/man1/sisu_termsheet.1 b/man/man1/sisu_termsheet.1 deleted file mode 100644 index feb663f8..00000000 --- a/man/man1/sisu_termsheet.1 +++ /dev/null @@ -1,60 +0,0 @@ -.\" Name: SiSU information Structuring Universe -.\" Author: Ralph Amissah -.\" Description: sisu termsheet (preprocessing) manpage -.\" arch-tag: sisu manpage -.\" License: GPL 3 or later -.\" Notes: Process this file with -.\" groff -man -Tascii sisu.1 -.\" nroff -man sisu.1 | most -.\" |sisu.1|@|^|<url:sisu.1> -.TH sisu_termsheet 1 "December 17, 2005" "version 0.34" "SiSU termsheet merge (sisu \-t [termsheet\-name])" -.SH NAME -.B SiSU -\- Structured information, Serialized Units \- a document publishing system -.SH SYNOPSIS -.PP -.B sisu -.B \-t -.I [termsheet\-name(s)] -.\"%% Description -.SH DESCRIPTION -.B sisu_termsheet -.I is part of SiSU is -.B invoked -.I through the sisu command (man sisu) -.PP -.\"%% Summary -.SH Summary of man page -.PP -sisu_termsheet, is started with the command: -.B sisu \-t -.I [termsheet\-name(s)] -.\"%% Flags -.SH DOCUMENT PROCESSING COMMAND FLAGS -.PP -.BI sisu \ \-t \ [termsheet\-name(s)] -(runs sisu_termsheet) merges the termsheet(s) specified on the commandline with the documents it is instructed to merge in the termsheet(s), and produces regular -.I SiSU -output documents from the merged results. -.PP -[further documentation on termsheets required] -.\"%% Further Information -.SH FURTHER INFORMATION -.PP -For more information on -.I SiSU -see: -.I <http://www.jus.uio.no/sisu> -.PP -or -.I man sisu -.SH AUTHOR -Ralph Amissah -.I <ralph@amissah.com> -or -.I <ralph.amissah@gmail.com> -.SH SEE ALSO -.BR sisu(1), -.BR sisu(8), -.BR sisu_webrick(1), -.BR sisu_vim(7) diff --git a/man/man1/sisu_webrick.1 b/man/man1/sisu_webrick.1 deleted file mode 100644 index ff8fdc59..00000000 --- a/man/man1/sisu_webrick.1 +++ /dev/null @@ -1,219 +0,0 @@ -.TH "sisu_webrick" "1" "2007-09-16" "0.59.1" "SiSU" -.SH NAME -sisu \- documents: structuring, publishing in multiple formats, and search -.SH SYNOPSIS -sisu \-W -.SH -SISU \- SISU_WEBRICK, -RALPH AMISSAH -.BR - -.SH -SISU WEBRICK -.BR - -.SH -1. SISU_WEBRICK -.BR - -.SH -1.1 NAME - -.BR -.B SiSU -\- Structured information, Serialized Units \- a document publishing system - -.SH -1.2 SYNOPSIS - -.BR -sisu_webrick \ [port] - -.BR -or - -.BR -sisu \-W \ [port] - -.SH -1.3 DESCRIPTION - -.BR -sisu_webrick is part of -.B SiSU -(man sisu) sisu_webrick starts -.B Ruby -\'s Webrick web\-server and points it to the directories to which -.B SiSU -output is written, providing a list of these directories (assuming -.B SiSU -is in use and they exist). - -.BR -The default port for sisu_webrick is set to 8081, this may be modified in the -yaml file: ~/.sisu/sisurc.yml a sample of which is provided as -/etc/sisu/sisurc.yml (or in the equivalent directory on your system). - -.SH -1.4 SUMMARY OF MAN PAGE - -.BR -sisu_webrick, may be started on it\'s own with the command: sisu_webrick \ -[port] or using the sisu command with the \-W flag: sisu \-W \ [port] - -.BR -where no port is given and settings are unchanged the default port is 8081 - -.SH -1.5 DOCUMENT PROCESSING COMMAND FLAGS - -.BR -sisu \-W \ [port] starts -.B Ruby -Webrick web\-server, serving -.B SiSU -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 -1.6 FURTHER INFORMATION - -.BR -For more information on -.B SiSU -see: <http://www.jus.uio.no/sisu> - -.BR -or man sisu - -.SH -1.7 AUTHOR - -.BR -Ralph Amissah ralph@amissah.com or ralph.amissah@gmail.com - -.SH -1.8 SEE ALSO - -.BR - sisu(1) - -.BR - sisu_vim(7) - -.BR - sisu(8) - -.SH -DOCUMENT INFORMATION (METADATA) -.BR - -.SH -METADATA -.BR - -.BR -Document Manifest @ -<http://sisudoc.org/sisu_manual/sisu_webrick/sisu_manifest.html> - -.BR -.B Dublin Core -(DC) - -.BR -.I DC tags included with this document are provided here. - -.BR -DC Title: -.I SiSU \- sisu_webrick - -.BR -DC Creator: -.I Ralph Amissah - -.BR -DC Rights: -.I Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL -3 - -.BR -DC Type: -.I information - -.BR -DC Date created: -.I 2002\-08\-28 - -.BR -DC Date issued: -.I 2002\-08\-28 - -.BR -DC Date available: -.I 2007\-08\-28 - -.BR -DC Date modified: -.I 2007\-09\-16 - -.BR -DC Date: -.I 2007\-09\-16 - -.BR -.B Version Information - -.BR -Sourcefile: -.I sisu_webrick.sst - -.BR -Filetype: -.I SiSU text 0.58 - -.BR -Sourcefile Digest, MD5(sisu_webrick.sst)= -.I 11fb0494766a9b6d3ce091bf41241973 - -.BR -Skin_Digest: MD5(/etc/sisu/skin/doc/skin_sisu.rb)= -.I c4b3c21ba1ed0d491bfe14cd0fcd075e - -.BR -.B Generated - -.BR -Document (metaverse) last generated: -.I Sat Sep 29 15:49:36 +0100 2007 - -.BR -Generated by: -.I SiSU -.I 0.59.1 -of 2007w39/2 (2007\-09\-25) - -.BR -Ruby version: -.I ruby 1.8.6 (2007\-06\-07 patchlevel 36) \ [i486\-linux] - - -.TP -Other versions of this document: -.TP -manifest: <http://www.jus.uio.no/sisu/sisu_webrick/sisu_manifest.html> -.TP -html: <http://www.jus.uio.no/sisu/sisu_webrick/toc.html> -.TP -pdf: <http://www.jus.uio.no/sisu/sisu_webrick/portrait.pdf> -.TP -pdf: <http://www.jus.uio.no/sisu/sisu_webrick/landscape.pdf> -.TP -at: <http://www.jus.uio.no/sisu> -.TP -* Generated by: SiSU 0.59.1 of 2007w39/2 (2007-09-25) -.TP -* Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux] -.TP -* Last Generated on: Sat Sep 29 15:49:36 +0100 2007 -.TP -* SiSU http://www.jus.uio.no/sisu diff --git a/man/man7/sisu_vim.7 b/man/man7/sisu_vim.7 index 6b6ccd15..7678f370 100644 --- a/man/man7/sisu_vim.7 +++ b/man/man7/sisu_vim.7 @@ -1,4 +1,4 @@ -.TH "sisu_vim" "1" "2008-02-12" "0.64.4" "SiSU" +.TH "sisu_vim" "1" "2008\-02\-12" "0.64.4" "SiSU" .SH NAME sisu_vim \- vim syntax and folds file for sisu: markup, structuring, publishing in multiple standard formats, and search .SH @@ -23,16 +23,10 @@ has syntax highlighting for a number of editors including vim which are documented under: .BR - man sisu_syntax_highlighting + /usr/share/doc/sisu/markup\-samples/sisu_manual/sisu_syntax_highlighting.sst .BR - /usr/share/doc/sisu/sisu_manual/sisu_syntax_highlighting/index.html - -.BR - <http://sisudoc.org/sisu_manual/sisu_syntax_highlighting/index.html> - -.BR - <http://www.jus.uio.no/sisu/sisu_manual/sisu_syntax_highlighting/index.html> + <http://www.sisudoc.org/sisu/sisu_manual/sisu_syntax_highlighting/index.html> .BR .B SiSU @@ -69,126 +63,15 @@ sisu\-vim actions are activated on files with the suffix \.sst \.ssm \.ssi FURTHER INFORMATION .BR -For more information on +For more information .B SiSU see: .BR -<http://www.jus.uio.no/sisu> - -.BR -or man sisu - -.SH -DOCUMENT INFORMATION (METADATA) -.BR - -.SH -METADATA -.BR - -.BR -Document Manifest @ -<http://sisudoc.org/sisu_manual/sisu_vim/sisu_manifest.html> - -.BR -.B Dublin Core -(DC) - -.BR -.I DC tags included with this document are provided here. - -.BR -DC Title: -.I SiSU \- Vim - -.BR -DC Creator: -.I Ralph Amissah - -.BR -DC Rights: -.I Copyright (C) Ralph Amissah 2008, part of SiSU documentation, License GPL -3 - -.BR -DC Type: -.I information +<http://sisudoc.org/> .BR -DC Date created: -.I 2002\-11\-12 - -.BR -DC Date issued: -.I 2002\-11\-12 - -.BR -DC Date available: -.I 2002\-11\-12 - -.BR -DC Date modified: -.I 2008\-02\-12 - -.BR -DC Date: -.I 2008\-02\-12 - -.BR -.B Version Information - -.BR -Sourcefile: -.I sisu_vim.sst - -.BR -Filetype: -.I SiSU text insert 0.58 - -.BR -Sourcefile Digest, MD5(sisu_vim.sst)= -.I b5028f957b128162f7653bbd940042ca - -.BR -Skin_Digest: MD5(skin_sisu_manual.rb)= -.I 072b2584bedea82ea8a416587b9fa244 - -.BR -.B Generated - -.BR -Document (metaverse) last generated: -.I Thu Feb 14 02:44:14 +0000 2008 - -.BR -Generated by: -.I SiSU -.I 0.64.4 -of 2008w06/4 (2008\-02\-14) +<http://www.jus.uio.no/sisu> .BR -Ruby version: -.I ruby 1.8.6 (2007\-09\-24 patchlevel 111) \ [i486\-linux] - - -.TP -Other versions of this document: -.TP -manifest: <http://www.jus.uio.no/sisu/sisu_vim/sisu_manifest.html> -.TP -html: <http://www.jus.uio.no/sisu/sisu_vim/toc.html> -.TP -pdf: <http://www.jus.uio.no/sisu/sisu_vim/portrait.pdf> -.TP -pdf: <http://www.jus.uio.no/sisu/sisu_vim/landscape.pdf> -.TP -at: <http://www.jus.uio.no/sisu> -.TP -* Generated by: SiSU 0.64.4 of 2008w06/4 (2008-02-14) -.TP -* Ruby version: ruby 1.8.6 (2007-09-24 patchlevel 111) [i486-linux] -.TP -* Last Generated on: Thu Feb 14 02:44:14 +0000 2008 -.TP -* SiSU http://www.jus.uio.no/sisu +or man sisu diff --git a/man/man8/sisu.8 b/man/man8/sisu.8 deleted file mode 100644 index e3e676ae..00000000 --- a/man/man8/sisu.8 +++ /dev/null @@ -1,333 +0,0 @@ -.\" Name: SiSU information Structuring Universe -.\" Author: Ralph Amissah -.\" Description: sisu manpage -.\" License: GPL 3 or later -.\" Notes: Process this file with -.\" groff -man -Tascii sisu.1 -.\" nroff -man sisu.1 | most -.\" /[^\\][-'] -.\" :%s/\([^\\]\)\([-']\)/\1\\\2/c -.TH sisu 8 "October 26, 2006" "version 0.48" "CONFIGURATION and SETUP" -.SH NAME -.B SiSU -\- Structured information, Serialized Units \- a document publishing system -.SH SYNOPSIS -.B sisu -.B [\-mhwpxXv...] [ -.I filename/wildcard -.B ] -.\"%% Description -.SH DESCRIPTION -A document publishing system, that from a simple single marked\-up document, -produces a multitude of output formats including: html, latex, pdf, info, and -sql output, which can be cross referenced as having the same document structure -and text object numbering, "object citation numbering". Features include its\' -simple syntax; the semantic tagging of documents; document management; built to -be associated with a revision control system; text object numbering for the -identification of a texts location in any of the output formats, easy skinning -on a site wide, or per document basis; granular search; a degree of future -proofing ... for more see -.I man 1 sisu -or -.I <http://www.jus.uio.no/sisu> -.PP -.B SiSU is a way of preparing, publishing, managing and searching documents. -.\"%% Installation -.SH INSTALLATION -.PP -Up to date information on SiSU downloads, and their installation should be -available from: -.I <http://www.jus.uio.no/sisu/SiSU/download.html> -or at: -.I <http://www.jus.uio.no/sisu/sisu_download/download.html> -.PP -There you should find links to the latest source tarball, and instructions on -how to install SiSU. -.PP -Sample marked up documents are are available at -.I /usr/share/doc/sisu/sisu_markup_samples/dfsg -or equivalent directory, or online, see -.I <http://www.jus.uio.no/sisu/SiSU/2.html> -.PP -.I man 1 sisu -has a syntax table along with processing commands. -.PP -SiSU also provides some help via the command: -.I sisu \-\-help -and selecting an appropriate subject, e.g. -.PP -.I sisu \-\-help commands -.PP -.I sisu \-\-help markup -.PP -.I sisu \-\-help headers -.PP -.I sisu \-\-help env -.PP -The rest of this note is on post installation setup -.\"%% Post Installation Setup -.SH Post Installation Setup \- Quick start -.PP - -After installation of sisu\-complete, move to the document samples directory, -.PP - cd /usr/share/doc/sisu/sisu_markup_samples/dfsg -.PP -[this is not where you would normally work but provides sample documents for -testing, you may prefer instead to copy the contents of that directory to a local -directory before proceeding] -.PP -and in that directory, initialise the output directory with the command -.PP -.I sisu \-CC -.PP -then run: -.PP -.I sisu \-1 free_as_in_freedom.rms_and_free_software.sam_williams.sst -.PP -or the same: -.PP -.I sisu \-NhwpoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst -.PP -look at output results, see the "sisu_manifest" page created for the document -.PP -for an overview of your current sisu setup, type: -.PP -.I sisu \-\-help env -.PP -or -.PP -.I sisu \-V -.PP -To generate a document from a remote url accessible location move to a -writable directory, (create a work directory and cd into it) as the file will -be downloaded there and e.g. -.PP -.I sisu \-1 http://www.jus.uio.no/sisu/gpl3.fsf/gpl3.fsf.sst -.PP -.I sisu \-3 http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst -.PP -examine source document, vim has syntax highlighting support -.PP -gvim free_as_in_freedom.rms_and_free_software.sam_williams.sst -.PP -additional markup samples in -.I <http://www.jus.uio.no/sisu/SiSU/2.html> -.PP -it should also be possible to run sisu against sisupods (prepared zip files, -created by running the command sisu \-S [filename]), whether stored locally or -remotely. -.PP -.I sisu \-3 http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip -.PP -there is a security issue associated with the running of document skins that -are not your own, so these are turned of by default, and the use of the -following command, which switches on the associated skin is not recommended: -.PP -.I sisu \-3 \-\-trust http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip -.PP -For help -.I man sisu -.PP -.I sisu \-\-help -.PP -.I sisu \-\-help env -for the way sisu "sees/maps" your system -.PP -.I sisu \-\-help commands -for list of commands and so on -.PP -.\"%% B. Generate a (local) document from a markup/work directory. -.B Document markup directory -.PP -Perhaps the easiest way to begin is to create a directory for sisu marked up -documents within your home directory, and copy the file structure (and document -samples) provided in the document sample directory: -.I mkdir ~/sisu_test -.PP -.I cd ~/sisu_test -.PP -.I cp \-a /usr/share/doc/sisu/sisu_markup_samples/dfsg/* ~/sisu_test/. -.PP -.B \-\-\-\-\-\-\-\-\-\- -.PP -.B Tip: -the markup syntax examples may be of interest -.I <http://www.jus.uio.no/sisu/sample/> -.PP -.B Tip: -.I sisu \-U [sisu markup filename] -should printout the different possible outputs and where sisu would place them. -.PP -.B Tip: -if you want to toggle ansi color add -.I c -to your flags. -.PP -.B \-\-\-\-\-\-\-\-\-\- -.PP -.\"%% configuration files -.B SiSU configuration file search path is: -.PP -.I ./_sisu/sisurc.yaml -.PP -.I ~/.sisu/sisurc.yaml -.PP -.I /etc/sisu/sisurc.yaml -.PP -.\"%% Debian Installation Note -.SH Debian INSTALLATION Note -.PP -It is best you see -.I <http://www.jus.uio.no/sisu/SiSU/download.html#debian> -for up the most up to date information. -.PP -notes taken from the Debian control file (end edited), gives an idea of -additional packages that SiSU can make use of if available, (the -use/requirement of some of which are interdependent for specific actions by -SiSU): -.PP -Package: sisu -.PP -Depends: ruby (>= 1.8.2), libwebrick\-ruby, unzip, zip -.PP -Conflicts: vim\-sisu, sisu\-vim, sisu\-remote -.PP -Replaces: vim\-sisu, sisu\-vim -.PP -Recommends: sisu\-pdf, sisu\-sqlite, sisu\-postgresql, librmagick\-ruby, trang, -tidy, librexml\-ruby, openssl, rsync, openssh\-client \| lsh\-client, keychain, -hyperestraier, kdissert Suggests: rcs \| cvs, lv, texinfo, pinfo -.PP -Package: sisu\-complete -.PP -Depends: ruby (>= 1.8.2), sisu, sisu\-pdf, sisu\-postgresql, sisu\-sqlite -.PP -Recommends: hyperestraier -.PP -Package: sisu\-pdf -.PP -Depends: sisu, texlive\-latex\-base, texlive\-fonts\-recommended, -texlive\-latex\-recommended, texlive\-latex\-extra -.PP -Suggests: evince, xpdf -.PP -Package: sisu\-postgresql -.PP -Depends: sisu, libdbd\-pg\-ruby, libdbi\-ruby, libdbm\-ruby, postgresql -.PP -Recommends: libfcgi\-ruby -.PP -Package: sisu\-sqlite -.PP -Depends: sisu, sqlite, libdbd\-sqlite\-ruby, libdbi\-ruby, libdbm\-ruby -.PP -Recommends: libfcgi\-ruby -.PP -Package: sisu\-markup\-samples -.PP -Depends: sisu -.PP -.SH Package Description -.B sisu -.PP -Description: documents \- structuring, publishing in multiple formats and search -.PP -SiSU is a lightweight markup based, command line oriented, document -structuring, publishing and search framework for document collections. -.PP -With minimal preparation of a plain\-text, (UTF\-8) file, using its native markup -syntax in your text editor of choice, SiSU can generate various document -formats (most of which share a common object numbering system for locating -content), including plain text, HTML, XHTML, XML, OpenDocument text (ODF:ODT), -LaTeX, PDF files, and populate an SQL database with objects (roughly -paragraph\-sized chunks) so searches may be performed and matches returned with -that degree of granularity: your search criteria is met by these documents and -at these locations within each document. Object numbering is particularly -suitable for "published" works (finalized texts as opposed to works that are -frequently changed or updated) for which it provides a fixed means of reference -of content. Document outputs also share semantic meta\-data provided. -.PP -SiSU also provides concordance files, document content certificates and -manifests of generated output. -.PP -A vim syntax highlighting file and an ftplugin with folds for sisu markup is -provided, as are syntax highlighting files for kate, kwrite, gedit and -diakonos. Vim 7 includes syntax highlighting for SiSU. -.PP -man pages, and interactive help are provided. -.PP -Dependencies for various features are taken care of in sisu related packages. -The package sisu\-complete installs the whole of SiSU. -.PP -Additional document markup samples are provided in the package -sisu\-markup\-samples which is found in the non\-free archive the licenses for -the substantive content of the marked up documents provided is that provided -by the author or original publisher. -.PP -Homepage: <http://www.jus.uio.no/sisu> -.fi -.\"%% Configuration Files -.SH DOCUMENT RESOURCE CONFIGURATION -.B sisu -resource configuration information is obtained from sources (where they exist): -.\" preformatted text follows -.nf -.I ~/.sisu/sisurc.yaml -.I /etc/sisu/[sisu version]/sisurc.yaml -.I sisu program defaults -.fi -.PP -.\"%% Skins -.B Skins -.PP -default document appearance may be modified using skins contained in -sub\-directories located at the following paths: -.\" preformatted text follows -.nf -.I ./_sisu/skin -.I ~/.sisu/skin -.I /etc/sisu/skin -.fi -.PP -more specifically, the following locations (or their /etc/sisu equivalent) -should be used: -.PP -.I ~/.sisu/skin/doc -skins for individual documents; -.PP -.I ~/.sisu/skin/dir -skins for directories of matching names; -.PP -.I ~/.sisu/skin/site -site\-wide skin -modifying the site\-wide appearance of documents. -.PP -Usually all skin files are placed in the document skin directory: -.I ~/.sisu/skin/doc -with softlinks being made to the skins contained there from other skin -directories as required. -.\"%% Further Information -.SH FURTHER INFORMATION -.PP -For more information on -.I SiSU -see: -.I <http://www.jus.uio.no/sisu> -.PP -or -.I man sisu -.\"%% Author -.SH AUTHOR -Ralph Amissah -.I <ralph@amissah.com> -or -.I <ralph.amissah@gmail.com> -.SH SEE ALSO -.BR sisu(1), -.BR sisu_examples(1), -.BR sisu_webrick(1), -.BR sisu_pdf(1) -.BR sisu_sqlite(1) -.BR sisu_postgresql(1) -.BR sisu_termsheet(1), |