documentation related minor updates and fixes
authorRalph Amissah <ralph@amissah.com>
Thu, 14 Oct 2010 18:48:26 +0000 (14:48 -0400)
committerRalph Amissah <ralph@amissah.com>
Thu, 14 Oct 2010 18:48:26 +0000 (14:48 -0400)
CHANGELOG_v2
data/doc/sisu/v2/CHANGELOG
data/doc/sisu/v2/markup-samples/sisu_manual/sisu_manual.ssm
data/doc/sisu/v2/markup-samples/sisu_manual/sisu_markup.sst
lib/sisu/v2/cgi_sql_common.rb
lib/sisu/v2/defaults.rb
man/man1/sisu.1

index f65044dce8fd3814b9832c35ed3e752590cd3b20..86cbf103a11d78202d854cff1c673e72ac8bd37d 100644 (file)
@@ -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
index 05c6b2d594da601e9ef0af869e24afcffc8d2c4d..84e519cfc3ec07a58b05f76a337db561019d680c 100644 (file)
@@ -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
index 48c6d6811d9fd9cc770acce8fdaf0cf3a220ec6f..878dc5cb80402e478f3ebdd970ccf1a9256908c9 100644 (file)
@@ -43,7 +43,7 @@
 
 :B~ What is SiSU?
 
-<< sisu_introduction.ssi
+<< sisu_introduction.sst
 
 << sisu_how.ssi
 
index b718e997a1264a3edd03c6ff82d727ee3f0a1fa3..bff00b018ce259bbd00d11fcec74cf8ce6432de1 100644 (file)
@@ -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:]
index 56f6cb373dbe3cc2d7e2ff2338ce627d135405ab..1b043f00a84594503305fda6f66fa734c2eb4c15 100644 (file)
@@ -569,9 +569,18 @@ module SiSU_CGI_sql
     </a>
   <br />
     <i>w3 since October 3 1993</i>
-    <a href="mailto://ralph@amissah.com" >
+    <a href="mailto:ralph@amissah.com" >
       ralph@amissah.com
     </a>
+  <br />
+    mailing list subscription
+    <a href="http://lists.sisudoc.org/listinfo/sisu" >
+      http://lists.sisudoc.org/listinfo/sisu
+    </a>
+  <br />
+    <a href="mailto:sisu@lists.sisudoc.org" >
+      sisu@lists.sisudoc.org
+    </a>
   </font></p>
 </td><td valign="top" width="45%">
   <p class="tiny_left"><font color="#666666" size="2">
index 188b1869bd9cce2636f2f77b8efb85c444a43c6a..362b67e5fef8dd33a8567f6c188251b7dc4dbfe1 100644 (file)
@@ -1595,7 +1595,7 @@ WOK
     </a>
   <br />
     <i>w3 since October 3 1993</i>
-    <a href="mailto://ralph@amissah.com" #{js_mail}>
+    <a href="mailto:ralph@amissah.com" #{js_mail}>
       ralph@amissah.com
     </a>
   </font></p>
@@ -1989,7 +1989,7 @@ SiSU is a comprehensive future-proofing electronic document management system.
 Potential users of SiSU include individual authors who want to publish their books or articles electronically to reach a broad audience, web publishers who want to provide multiple channels of access to their electronic documents, or any organizations which centrally manage a medium or large set of electronic documents, especially governmental organizations which may prefer to keep their documents in easily accessible yet non-proprietary formats.
 </p>
 <p>
-SiSU is an Open Source project initiated and led by Ralph Amissah  (<a href="mailto://ralph.amissah@gmail.com">ralph.amissah@gmail.com</a>) and can be contacted at <a href="mailto://sisu@lists.sisudoc.org">sisu@lists.sisudoc.org</a>. SiSU is licensed under the GNU General Public License.
+SiSU is an Open Source project initiated and led by Ralph Amissah  (<a href="mailto:ralph.amissah@gmail.com">ralph.amissah@gmail.com</a>) and can be contacted via mailing list <a href="http://lists.sisudoc.org/listinfo/sisu">http://lists.sisudoc.org/listinfo/sisu</a> at <a href="mailto:sisu@lists.sisudoc.org">sisu@lists.sisudoc.org</a>. SiSU is licensed under the GNU General Public License.
 </p>
 <p class="bold">
   For less markup than the most elementary HTML you can have more.
@@ -2151,21 +2151,26 @@ SiSU was developed in relation to legal documents, and is strong across a wide v
 <p class="tiny">
 SiSU has been developed and has been in use for several years. Requirements to cover a wide range of documents within its use domain have been explored.</p>
 <p class="small">
-<a href="mailto://ralph@amissah.com">
+<a href="mailto:ralph@amissah.com">
 ralph@amissah.com
 </a>
 </p>
 <p class="small">
-<a href="mailto://ralph.amissah@gmail.com">
+<a href="mailto:ralph.amissah@gmail.com">
 ralph.amissah@gmail.com
 </a>
 </p>
 <p class="small">
-<a href="mailto://sisu@lists.sisudoc.org">
+<a href="mailto:sisu@lists.sisudoc.org">
 sisu@lists.sisudoc.org.
 </a>
 </p>
 <p class="small">
+<a href="http://lists.sisudoc.org/listinfo/sisu">
+http://lists.sisudoc.org/listinfo/sisu
+</a>
+</p>
+<p class="small">
 #{@date.year_static}
 </p>
 <p class="tiny">
index 7a9d96599efddb99d6c54981bc76d81c5edef1fe..3dd8f71af1b8eb63910f758f6fa5e9b3574d1265 100644 (file)
@@ -1256,7 +1256,7 @@ normally be marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a document
 .BR
   /{italics}/
 .BR
-  \"{citation}\"
+  "{citation}"
 .BR
   ^{superscript}^
 .BR