v4: documentation, sisu.1 manpage & minor

3 files changed, 82 insertions, 93 deletions

diff --git a/data/doc/sisu/markup-samples/v4/sisu_manual/_sisu/sisu_document_make b/data/doc/sisu/markup-samples/v4/sisu_manual/_sisu/sisu_document_make
index 17c6bbf8..72706d10 100644
--- a/data/doc/sisu/markup-samples/v4/sisu_manual/_sisu/sisu_document_make
+++ b/data/doc/sisu/markup-samples/v4/sisu_manual/_sisu/sisu_document_make
@@ -2,7 +2,7 @@
  :num_top: 1
  :breaks: new=C; break=1
  :bold: /Debian|Ruby|SiSU/
- :italics: /Linux|GPL|GPLv3|LaTeX|PostgreSQL|SQLite|SQL|Vim|ascii|plaintext|UTF-?8|HTML|XHTML|XML|EPUB|OpenDocument|ODF|ODT|PDF|pgSQL|TeXinfo|YAML|YML|ocn|object citation system|object citation numbering|granular search|Dublin Core/
+ :italics: /Linux|GPL|GPLv3|LaTeX|PostgreSQL|SQLite|SQL|Vim|ascii|plaintext|UTF-?8|HTML|XHTML|XML|EPUB|OpenDocument|ODF|ODT|PDF|pgSQL|TeXinfo|YAML|YML|OCN|object citation system|object citation numbering|granular search|Dublin Core/
  :substitute: /${debian_stable}/,'*{Wheezy}*' /${debian_testing}/,'*{Jessie}*'
  :home_button_text: {SiSU}http://sisudoc.org; {git}http://git.sisudoc.org
  :footer: {SiSU}http://sisudoc.org; {git}http://git.sisudoc.org
diff --git a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_markup.sst b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_markup.sst
index 9027817a..98377850 100644
--- a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_markup.sst
+++ b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_markup.sst
@@ -97,41 +97,40 @@ This current document is loaded by a master document that has a header similar t
 
 code{
 
-% SiSU master 2.0
+% SiSU master 4.0
 
 @title: SiSU
- :subtitle: Manual
+  :subtitle: Manual
 
 @creator:
- :author: Amissah, Ralph
+  :author: Amissah, Ralph
 
 @publisher: [publisher name]
 
 @rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
 
 @classify:
- :type: information
- :topic_register: SiSU:manual;electronic documents:SiSU:manual
- :subject: ebook, epublishing, electronic book, electronic publishing,
+  :topic_register: SiSU:manual;electronic documents:SiSU:manual
+  :subject: ebook, epublishing, electronic book, electronic publishing,
     electronic document, electronic citation, data structure,
      citation systems, search
 
 % used_by: manual
 
 @date:
- :published: 2008-05-22
- :created: 2002-08-28
- :issued: 2002-08-28
- :available: 2002-08-28
- :modified: 2010-03-03
+  :published: 2008-05-22
+  :created: 2002-08-28
+  :issued: 2002-08-28
+  :available: 2002-08-28
+  :modified: 2010-03-03
 
 @make:
- :num_top: 1
- :breaks: new=C; break=1
- :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;
+  :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]
@@ -139,16 +138,16 @@ code{
      . sisu --v3 [operations]
 
 @links:
- { SiSU Homepage }http://www.sisudoc.org/
- { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/
- { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html
- { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html
- { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html
- { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary
- { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/
- { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html
- { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org
- { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU
+  { SiSU Homepage }http://www.sisudoc.org/
+  { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/
+  { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html
+  { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html
+  { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html
+  { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary
+  { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/
+  { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html
+  { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org
+  { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU
 
 }code
 
@@ -156,10 +155,10 @@ code{
 
 Header tags appear at the beginning of a document and provide meta information on the document (such as the Dublin Core), or information as to how the document as a whole is to be processed. All header instructions take the form @headername: or on the next line and indented by once space :subheadername: All Dublin Core meta tags are available
 
-!_ @indentifier:
+!_ @identifier:
 information or instructions
 
-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
 
 Note: a header where used should only be used once; all headers apart from @title: are optional; the @structure: header is used to describe document structure, and can be useful to know.
 
@@ -173,7 +172,6 @@ code{
 
 }code
 
-
 code{
 
 @title: [title text] [this header is the only one that is mandatory]
@@ -185,57 +183,57 @@ code{
 code{
 
 @creator:
- :author: [Lastname, First names]
- :illustrator: [Lastname, First names]
- :translator: [Lastname, First names]
- :prepared_by: [Lastname, First names]
+  :author: [Lastname, First names]
+  :illustrator: [Lastname, First names]
+  :translator: [Lastname, First names]
+  :prepared_by: [Lastname, First names]
 
 }code
 
 code{
 
 @date:
- :published: [year or yyyy-mm-dd]
- :created: [year or yyyy-mm-dd]
- :issued: [year or yyyy-mm-dd]
- :available: [year or yyyy-mm-dd]
- :modified: [year or yyyy-mm-dd]
- :valid: [year or yyyy-mm-dd]
- :added_to_site: [year or yyyy-mm-dd]
- :translated: [year or yyyy-mm-dd]
+  :published: [year or yyyy-mm-dd]
+  :created: [year or yyyy-mm-dd]
+  :issued: [year or yyyy-mm-dd]
+  :available: [year or yyyy-mm-dd]
+  :modified: [year or yyyy-mm-dd]
+  :valid: [year or yyyy-mm-dd]
+  :added_to_site: [year or yyyy-mm-dd]
+  :translated: [year or yyyy-mm-dd]
 
 }code
 
 code{
 
 @rights:
- :copyright: Copyright (C) [Year and Holder]
- :license: [Use License granted]
- :text: [Year and Holder]
- :translation: [Name, Year]
- :illustrations: [Name, Year]
+  :copyright: Copyright (C) [Year and Holder]
+  :license: [Use License granted]
+  :text: [Year and Holder]
+  :translation: [Name, Year]
+  :illustrations: [Name, Year]
 
 }code
 
 code{
 
 @classify:
- :topic_register: SiSU:markup sample:book;book:novel:fantasy
- :type:
- :subject:
- :description:
- :keywords:
- :abstract:
- :loc: [Library of Congress classification]
- :dewey: [Dewey classification
+  :topic_register: SiSU:markup sample:book;book:novel:fantasy
+  :type:
+  :subject:
+  :description:
+  :keywords:
+  :abstract:
+  :loc: [Library of Congress classification]
+  :dewey: [Dewey classification
 
 }code
 
 code{
 
 @identify:
- :isbn: [ISBN]
- :oclc:
+  :isbn: [ISBN]
+  :oclc:
 
 }code
 
@@ -250,30 +248,30 @@ code{
 code{
 
 @make:
- :num_top: 1
- :headings: [text to match for each level
+  :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
+  :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
 
 }code
 
 code{
 
 @original:
- :language: [language]
+  :language: [language]
 
 }code
 
 code{
 
 @notes:
- :comment:
- :prefix: [prefix is placed just after table of contents]
+  :comment:
+  :prefix: [prefix is placed just after table of contents]
 
 }code
 
@@ -449,12 +447,19 @@ in each case level may be 0-9
 
 !_ resulting output:
 
-_0_1 first line no indent, rest of paragraph indented one step
+_0_1 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;
+
+A regular paragraph.
 
-_1_0 first line indented, rest of paragraph no indent
+_1_0 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
 
 in each case level may be 0-9
 
+_0_1 *{live-build}* A collection of scripts used to build customized Debian Livesystems. /{live-build}/ was formerly known as live-helper, and even earlier known as live-package.
+
+_0_1 *{live-build}* \\
+A collection of scripts used to build customized Debian Livesystems. /{live-build}/ was formerly known as live-helper, and even earlier known as live-package.
+
 2~ Footnotes / Endnotes
 
 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
diff --git a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_markup_syntax_history.sst b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_markup_syntax_history.sst
index a5b56f1f..c6da0a14 100644
--- a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_markup_syntax_history.sst
+++ b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_markup_syntax_history.sst
@@ -25,22 +25,6 @@
 
 :B~? SiSU Markup Syntax History
 
-1~ Composite documents markup
-
-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 *{.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 *{.sst}* regular markup file, or *{.ssi}* (insert/information) A secondary file of the composite document is built prior to processing with the same prefix and the suffix *{._sst}*
-
-basic markup for importing a document into a master document
-
-code{
-
-<< filename1.sst
-
-<< filename2.ssi
-
-}code
-
-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.
-
 1~syntax_history Markup Syntax History
 
 2~ Notes related to Files-types and Markup Syntax
@@ -66,16 +50,16 @@ same as 1.0, apart from the changing of headers and the addition of a monospace
 code{
 
 @title:
- :subtitle:
+  :subtitle:
 
 @creator:
- :author:
- :translator:
- :illustrator:
+  :author:
+  :translator:
+  :illustrator:
 
 @rights:
- :text:
- :illustrations:
+  :text:
+  :illustrations:
 
 }code