Merge tag 'sisu_5.5.0' into debian/sid

SiSU 5.5.0

6 files changed, 100 insertions, 13 deletions

diff --git a/data/doc/sisu/CHANGELOG_v5 b/data/doc/sisu/CHANGELOG_v5
index eba3b432..2cca5ac9 100644
--- a/data/doc/sisu/CHANGELOG_v5
+++ b/data/doc/sisu/CHANGELOG_v5
@@ -31,6 +31,49 @@ v2 branch is removed; it is available in sisu =< 3.3.2
 
 %% Reverse Chronological:
 
+%% 5.5.0.orig.tar.xz (2014-07-11:27/5)
+http://sources.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/sisu_5.5.0
+http://sources.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/debian/sisu_5.5.0-1
+http://www.jus.uio.no/sisu/pkg/src/sisu_5.5.0.orig.tar.xz
+  sisu_5.5.0.orig.tar.xz
+  sisu_5.5.0-1.dsc
+
+* ao_numbering,
+  * auto name segment, extract "number" from heading, fix
+  * check that all auto given number based seg names are unique
+
+* ao_composite, nested includes, .ssi (insert) can include .ssi & .sst
+~ .ssm can contain/include .sst or .ssi
+  .sst files can be processed independently, they do not contain other files
+  .ssi files have been only insertions of text & are not processed independently
+  but as part of an ssm
+  change proposed:
+  .ssm unchanged,
+  .sst unchanged,
+  .ssi as before, but can include .sst or .ssi, so:
+  files are only insertions & are not processed independently but as part of an
+  .ssm or another .ssi
+  i.e. as before with the addition that it like a .ssm can contain/include
+  .sst or .ssi
+~ requested feature, (Closes: #744408)
+  User beware. In previous versions there has been a deliberate attempt to keep
+  it easy to follow documents & not have to dig through different levels of
+  includes, as this is more likely to lead to errors in markup.
+  The idea of nested includes has not been attractive (messy for a document),
+  however, this is now made possible, use with care
+  ~ it is not as easy to see document structure at a glance, and structural
+    errors may be introduced and will need to be taken care of (requiring
+    document markup debugging)
+  ~ allowing .ssi to also include other .ssi or .sst could lead to infinite
+    recursion if an .ssi includes another which includes itself; stopping after
+    an additional level of includes seems arbitrary, and possibly prone to error
+    if you are dealing with many documents
+~ requires testing
+~ version bump, new behavior added to .ssi one of the 3 sisu filetypes
+
+* src, sisupod composite source, nested includes
+  follow rules for ao_composite (described above)
+
 %% 5.4.5.orig.tar.xz (2014-07-07:27/1)
 http://sources.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/sisu_5.4.5
 http://sources.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/debian/sisu_5.4.5-1
diff --git a/data/doc/sisu/CHANGELOG_v6 b/data/doc/sisu/CHANGELOG_v6
index eef28547..ae42efe7 100644
--- a/data/doc/sisu/CHANGELOG_v6
+++ b/data/doc/sisu/CHANGELOG_v6
@@ -21,6 +21,49 @@ v2 branch is removed; it is available in sisu =< 3.3.2
 
 %% Reverse Chronological:
 
+%% 6.1.0.orig.tar.xz (2014-07-11:27/5)
+http://sources.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/sisu_6.1.0
+http://sources.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/debian/sisu_6.1.0-1
+http://www.jus.uio.no/sisu/pkg/src/sisu_6.1.0.orig.tar.xz
+  sisu_6.1.0.orig.tar.xz
+  sisu_6.1.0-1.dsc
+
+* ao_numbering,
+  * auto name segment, extract "number" from heading, fix
+  * check that all auto given number based seg names are unique
+
+* ao_composite, nested includes, .ssi (insert) can include .ssi & .sst
+~ .ssm can contain/include .sst or .ssi
+  .sst files can be processed independently, they do not contain other files
+  .ssi files have been only insertions of text & are not processed independently
+  but as part of an ssm
+  change proposed:
+  .ssm unchanged,
+  .sst unchanged,
+  .ssi as before, but can include .sst or .ssi, so:
+  files are only insertions & are not processed independently but as part of an
+  .ssm or another .ssi
+  i.e. as before with the addition that it like a .ssm can contain/include
+  .sst or .ssi
+~ requested feature, (Closes: #744408)
+  User beware. In previous versions there has been a deliberate attempt to keep
+  it easy to follow documents & not have to dig through different levels of
+  includes, as this is more likely to lead to errors in markup.
+  The idea of nested includes has not been attractive (messy for a document),
+  however, this is now made possible, use with care
+  ~ it is not as easy to see document structure at a glance, and structural
+    errors may be introduced and will need to be taken care of (requiring
+    document markup debugging)
+  ~ allowing .ssi to also include other .ssi or .sst could lead to infinite
+    recursion if an .ssi includes another which includes itself; stopping after
+    an additional level of includes seems arbitrary, and possibly prone to error
+    if you are dealing with many documents
+~ requires testing
+~ version bump, new behavior added to .ssi one of the 3 sisu filetypes
+
+* src, sisupod composite source, nested includes
+  follow rules for ao_composite (described above)
+
 %% 6.0.11.orig.tar.xz (2014-07-07:27/1)
 http://sources.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/sisu_6.0.11
 http://sources.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/debian/sisu_6.0.11-1
diff --git a/data/doc/sisu/markup-samples/manual/en/sisu_filetypes.sst b/data/doc/sisu/markup-samples/manual/en/sisu_filetypes.sst
index d36acac0..4b5c31e7 100644
--- a/data/doc/sisu/markup-samples/manual/en/sisu_filetypes.sst
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_filetypes.sst
@@ -53,7 +53,7 @@ Note: a secondary file of the composite document is built prior to processing wi
 
 3~ sisu insert files (.ssi)
 
-Inserts are documents prepared solely for the purpose of being incorporated into one or more master documents. They resemble regular SiSU text files except they are ignored by the 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.
+Inserts are documents prepared solely for the purpose of being incorporated into one or more master documents. They resemble regular SiSU 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.
 
 2~ sisupod, zipped binary container (sisupod.zip, .ssp)
 
diff --git a/data/doc/sisu/markup-samples/manual/en/sisu_markup.sst b/data/doc/sisu/markup-samples/manual/en/sisu_markup.sst
index 08128821..7db8416e 100644
--- a/data/doc/sisu/markup-samples/manual/en/sisu_markup.sst
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_markup.sst
@@ -1344,7 +1344,7 @@ code{
 
 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}*
+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). 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
 
diff --git a/data/doc/sisu/markup-samples/manual/en/sisu_search_cgi.ssi b/data/doc/sisu/markup-samples/manual/en/sisu_search_cgi.ssi
index 4e833b9b..301cfa72 100644
--- a/data/doc/sisu/markup-samples/manual/en/sisu_search_cgi.ssi
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_search_cgi.ssi
@@ -59,6 +59,7 @@ To create a sample search form, from within the same directory run:
 ``` code
 sisu --sample-search-form --db-pg
 ```
+
 and copy the resulting cgi form to your cgi-bin directory
 
 A sample setup for nginx is provided that assumes data will be stored under /srv/www and cgi scripts under /srv/cgi
diff --git a/data/doc/sisu/sisu.org b/data/doc/sisu/sisu.org
index 265abda9..64246368 100644
--- a/data/doc/sisu/sisu.org
+++ b/data/doc/sisu/sisu.org
@@ -2247,22 +2247,22 @@ consider,
 I have to date deliberately tried to keep it easy to follow documents & not have too much depth ...
 The idea of recursive includes is un-attractive (messy for a document)
 
-.ssm currently can contain .sst or .ssi
+.ssm currently can contain/include .sst or .ssi
 .sst files can be processed independently,
-.ssi files are only insertions & cannot
+.ssi files are only insertions & are not processed independently but as part of an ssm
 
-allowing .ssi to also include other .ssi or .sst could lead to recursive .ssi
-allowing .ssm to also include other .ssm .ssi or .sst could lead to recursive .ssm
+change proposed
+.ssm unchanged
+.sst unchanged
+.ssi as before, but can include .sst or .ssi, so:
+  files are only insertions & are not processed independently but as part of an .ssm or another .ssi
+  i.e. as before with the addition that it like a .ssm can contain/include .sst or .ssi
 
-stopping after an additional level of includes seems arbitrary, and possibly prone to error if you are dealing with many documents
+this is pretty much as requested by wishlist 744408
 
-a possibility would be to have another file extension to flag the role of the file,
-.ssmi (not very attractive) might do it
-(providing visual cue signalling its role as both a master file and an insertion/included file that cannot be processed independently)
-a .ssmi file must be included in a .ssm file
-a .ssmi file (like .ssm) permits the inclusion only of .sst or .ssi files
+allowing .ssi to also include other .ssi or .sst could lead to recursive .ssi
 
-will work on eventually
+stopping after an additional level of includes seems arbitrary, and possibly prone to error if you are dealing with many documents
 
 **** TODO [#C] #744409 [w|u] sisu output: urls in code blocks are not linkified
       <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=744409>