aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/sisu/markup-samples
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2011-06-26 21:26:07 -0400
committerRalph Amissah <ralph@amissah.com>2011-06-26 22:40:25 -0400
commit1d239f2504dffc05c39efd38a10a27dba9e9c85e (patch)
tree485daaef736390ac2ed61a1a07d3b8507fee00b7 /data/doc/sisu/markup-samples
parentv2 v3: sisurc.yml, config settings (diff)
v3: documentation, on additional breaks in document, (remove some old info)sisu_3.0.13
* linebreak \\ (previously undocumented <br> kept but depreciated) [it is intended that this should close #617298 (post mail)] * page break (breaks column if column, else breaks page) * page new (new page, breaks page) * sisurc.yml set output directory structure by language * removed section on hyperestraier, too specialised for general manpage (also section not checked recently)
Diffstat (limited to 'data/doc/sisu/markup-samples')
-rw-r--r--data/doc/sisu/markup-samples/sisu_manual/sisu.ssm2
-rw-r--r--data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst2
-rw-r--r--data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst39
3 files changed, 40 insertions, 3 deletions
diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu.ssm b/data/doc/sisu/markup-samples/sisu_manual/sisu.ssm
index c26aeabd..89d8556a 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/sisu.ssm
+++ b/data/doc/sisu/markup-samples/sisu_manual/sisu.ssm
@@ -86,8 +86,6 @@
<< sisu_search_cgi.ssi
-<< sisu_hyperestraier.ssi
-
<< sisu_webrick.sst
<< sisu_remote.sst
diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst
index 36e1bb9c..a5f380a9 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst
+++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst
@@ -208,7 +208,7 @@ see --rsync
see --scp
!_ --sample-search-form [--webserv=webrick] <br>
-generate examples of (naive) cgi search form for sqlite and pgsql depends on your already having used sisu to populate an sqlite and/or pgsql database, (the sqlite version scans the output directories for existing sisu_sqlite databases, so it is first necessary to create them, before generating the search form) see -d -D and the database section below. If the optional parameter --webserv=webrick is passed, the cgi examples created will be set up to use the default port set for use by the webrick server, (otherwise the port is left blank and the system setting used, usually 80). The samples are dumped in the present work directory which must be writable, (with screen instructions given that they be copied to the cgi-bin directory). -Fv (in addition to the above) provides some information on setting up hyperestraier for sisu. Alias -F
+generate examples of (naive) cgi search form for sqlite and pgsql depends on your already having used sisu to populate an sqlite and/or pgsql database, (the sqlite version scans the output directories for existing sisu_sqlite databases, so it is first necessary to create them, before generating the search form) see -d -D and the database section below. If the optional parameter --webserv=webrick is passed, the cgi examples created will be set up to use the default port set for use by the webrick server, (otherwise the port is left blank and the system setting used, usually 80). The samples are dumped in the present work directory which must be writable, (with screen instructions given that they be copied to the cgi-bin directory). Alias -F
!_ --scp [filename/wildcard] <br>
copies sisu output files to remote host using scp. This requires that sisurc.yml has been provided with information on hostname and username, and that you have your "keys" and ssh agent in place. Also see --rsync. Alias -r
diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst
index 65dc4e91..a246d160 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst
+++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst
@@ -1108,6 +1108,45 @@ code{#
}code
+2~ Additional breaks - linebreaks within objects, column and page-breaks
+
+3~ line-breaks
+
+To break a line within a "paragraph object", two backslashes \\\\ \\ with a space before and a space or newline after them \\ may be used.
+
+code{
+
+To break a line within a "paragraph object",
+two backslashes \\ with a space before
+and a space or newline after them \\
+may be used.
+
+}code
+
+The html break br enclosed in angle brackets (though undocumented) is available in versions prior to 3.0.13 and 2.9.7 (it remains available for the time being, but is depreciated).
+
+3~ page breaks
+
+Page breaks are only relevant and honored in some output formats. A page break or a new page may be inserted manually using the following markup on a line on its own:
+
+code{
+
+<:pb>
+
+}code
+
+or
+
+code{
+
+<:pn>
+
+}code
+
+page new <:pn> breaks the page, starts a new page.
+
+page break <:pb> breaks a column, starts a new column, if using columns, else breaks the page, starts a new page.
+
2~ Book index
To make an index append to paragraph the book index term relates to it, using an equal sign and curly braces.