documentation related minor updates and fixes

3 files changed, 136 insertions, 7 deletions

diff --git a/data/doc/sisu/v2/CHANGELOG b/data/doc/sisu/v2/CHANGELOG
index 05c6b2d5..84e519cf 100644
--- a/data/doc/sisu/v2/CHANGELOG
+++ b/data/doc/sisu/v2/CHANGELOG
@@ -12,7 +12,7 @@ Reverse Chronological:
 
 %% Development branch UNSTABLE
 
-%% 2.7.7.orig.tar.gz (2010-10-13:41/3)
+%% 2.7.7.orig.tar.gz (2010-10-14:41/4)
 http://www.jus.uio.no/sisu/pkg/src/sisu_2.7.7.orig.tar.gz
   sisu_2.7.7.orig.tar.gz
   sisu_2.7.7-1.dsc
@@ -22,7 +22,9 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_2.7.7.orig.tar.gz
 
   * texpdf, first space following a bullet should be fixed width, fix
     (used \enspace (0.5em))
-    (requested fix and suggested solution, Ben Armstrong)
+    (requested fix and suggested latex solution, Ben Armstrong)
+
+  * documentation related minor updates and fixes
 
 %% 2.7.6.orig.tar.gz (2010-10-11:41/1)
 http://www.jus.uio.no/sisu/pkg/src/sisu_2.7.6.orig.tar.gz
diff --git a/data/doc/sisu/v2/markup-samples/sisu_manual/sisu_manual.ssm b/data/doc/sisu/v2/markup-samples/sisu_manual/sisu_manual.ssm
index 48c6d681..878dc5cb 100644
--- a/data/doc/sisu/v2/markup-samples/sisu_manual/sisu_manual.ssm
+++ b/data/doc/sisu/v2/markup-samples/sisu_manual/sisu_manual.ssm
@@ -43,7 +43,7 @@
 
 :B~ What is SiSU?
 
-<< sisu_introduction.ssi
+<< sisu_introduction.sst
 
 << sisu_how.ssi
 
diff --git a/data/doc/sisu/v2/markup-samples/sisu_manual/sisu_markup.sst b/data/doc/sisu/v2/markup-samples/sisu_manual/sisu_markup.sst
index b718e997..bff00b01 100644
--- a/data/doc/sisu/v2/markup-samples/sisu_manual/sisu_markup.sst
+++ b/data/doc/sisu/v2/markup-samples/sisu_manual/sisu_markup.sst
@@ -22,7 +22,7 @@
  :issued: 2002-08-28
  :available: 2002-08-28
  :published: 2008-05-22
- :modified: 2010-07-07
+ :modified: 2010-17-14
 
 @make:
  :num_top: 1
@@ -173,7 +173,7 @@ code{
 
 2~ Available Headers
 
-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
+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:
 information or instructions
@@ -1004,7 +1004,7 @@ group{
 
 3~ Code
 
-Code tags are used to escape regular sisu markup, and have been used extensively within this document to provide examples of 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.
+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 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.
 
 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]
 
@@ -1059,6 +1059,57 @@ code{
 
 }code
 
+From SiSU 2.7.7 on you can number codeblocks by placing a hash after the opening code tag #{ code{# }# as demonstrated here:
+
+code{#
+
+                    `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."'
+
+}code
+
 2~ Book index
 
 To make an index append to paragraph the book index term relates to it, using an equal sign and curly braces.
@@ -1155,12 +1206,88 @@ code{
 
 1~ Notes related to Files-types and Markup Syntax
 
-0.38 is substantially current, depreciated 0.16 supported, though file names were changed at 0.37
+2.0 introduced new headers and is therefore incompatible with 1.0 though otherwise the same with the addition of a couple of tags (i.e. a superset)
+
+0.38 is substantially current for version 1.0
+
+depreciated 0.16 supported, though file names were changed at 0.37
 
 _* sisu --query=[sisu version [0.38] or 'history]
 
 provides a short history of changes to SiSU markup
 
+!_ SiSU 2.0
+(2010-03-06:09/6)
+same as 1.0, apart from the changing of headers and the addition of a monospace tag related headers now grouped, e.g.
+
+code{
+
+@title:
+ :subtitle:
+
+@creator:
+ :author:
+ :translator:
+ :illustrator:
+
+@rights:
+ :text:
+ :illustrations:
+
+}code
+
+see document markup samples, and sisu --help headers
+
+the monospace tag takes the form of a hash '#'
+
+code{
+
+#{ this enclosed text would be monospaced }#
+
+}code
+
+!_  1.0
+(2009-12-19:50/6)
+same as 0.69
+
+!_ 0.69
+(2008-09-16:37/2)
+(same as 1.0) and as previous (0.57) with the addition of book index tags
+
+code{
+
+/^={.+?}$/
+
+}code
+
+e.g. appended to a paragraph, on a new-line (without a blank line in between) logical structure produced assuming this is the first text "object"
+
+code{
+
+ ={GNU/Linux community distribution:Debian+2|Fedora|Gentoo;Free Software Foundation+5}
+
+}code
+
+code{
+
+Free Software Foundation, 1-6
+GNU/Linux community distribution, 1
+    Debian, 1-3
+    Fedora, 1
+    Gentoo,
+
+}code
+
+!_ 0.66
+(2008-02-24:07/7)
+same as previous, adds semantic tags, [experimental and not-used]
+
+code{
+
+/[:;]{.+?}[:;][a-z+]/
+
+}code
+
 !_ 0.57
 (2007w34/4)
 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:]