From bf076ed40633fa31cc33e225c00e2dcb1f526ce8 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Fri, 11 Jul 2014 00:17:43 -0400 Subject: documention related --- data/doc/sisu/markup-samples/manual/en/sisu_filetypes.sst | 2 +- data/doc/sisu/markup-samples/manual/en/sisu_markup.sst | 2 +- data/doc/sisu/markup-samples/manual/en/sisu_search_cgi.ssi | 1 + data/doc/sisu/sisu.org | 9 --------- 4 files changed, 3 insertions(+), 11 deletions(-) (limited to 'data/doc') 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 8800572d..64246368 100644 --- a/data/doc/sisu/sisu.org +++ b/data/doc/sisu/sisu.org @@ -2264,15 +2264,6 @@ allowing .ssi to also include other .ssi or .sst could lead to recursive .ssi stopping after an additional level of includes seems arbitrary, and possibly prone to error if you are dealing with many documents -***** Discard -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 - -will work on eventually - **** TODO [#C] #744409 [w|u] sisu output: urls in code blocks are not linkified -- cgit v1.2.3