From f6f8918bfdf8d9bd550f473ecfb53744e17f5731 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Fri, 22 Feb 2013 21:40:54 -0500 Subject: v4: documentation, sisu markup (sisu_markup.sst, man page sisu.1, sisu.1.html) --- data/doc/sisu/CHANGELOG_v4 | 1 + data/doc/sisu/html/sisu.1.html | 18 +++++++++++------- .../sisu/markup-samples/v4/sisu_manual/sisu_markup.sst | 16 +++++++++++++++- man/man1/sisu.1 | 17 +++++++++++++++-- 4 files changed, 42 insertions(+), 10 deletions(-) diff --git a/data/doc/sisu/CHANGELOG_v4 b/data/doc/sisu/CHANGELOG_v4 index 203a0189..b8d88e1b 100644 --- a/data/doc/sisu/CHANGELOG_v4 +++ b/data/doc/sisu/CHANGELOG_v4 @@ -33,6 +33,7 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_4.0.9.orig.tar.xz * output formats modified to include, (pdf, odf, epub, html, plaintext) * vim syntax, sisu.vim * emacs, sisu-mode.el + * documentation, sisu_markup.sst, man page sisu.1, sisu.1.html %% 4.0.8.orig.tar.xz (2013-02-20:07/3) http://sources.sisudoc.org/gitweb/?p=code/sisu.git;a=shortlog;h=refs/tags/sisu_4.0.8 diff --git a/data/doc/sisu/html/sisu.1.html b/data/doc/sisu/html/sisu.1.html index 3d852a3e..56535d2e 100644 --- a/data/doc/sisu/html/sisu.1.html +++ b/data/doc/sisu/html/sisu.1.html @@ -372,8 +372,7 @@ invoked by --dump & redirect).
see --dal (document abstraction level/layer)
--machine [filename/wildcard/url]
-
see --dal (document abstraction -level/layer)
+
see --dal (document abstraction level/layer)
--maintenance [filename/wildcard/url]
maintenance mode, interim @@ -381,8 +380,7 @@ processing files are preserved and their locations indicated. (also see -V). Aliases -M and --keep-processing-files.
--manpage [filename/wildcard]
-
produces -man page of file, not suitable for all outputs. Alias -i
+
produces man page of file, not suitable for all outputs. Alias -i
-N [filename/wildcard/url]
document digest or document content certificate ( DCC ) as md5 digest tree @@ -1900,18 +1898,24 @@ or breaks the page, starts a new page.

page break -\- or breaks a column, starts a new column, if using columns, else breaks the page, starts a new page. -


+

page break line across page -..- draws a dividing line, dividing paragraphs + +

page break:

-\\-
 or
 <:pb>
 
-

or -


+

+

page (break) new:

=\\=
 or
 <:pn>
 

+

page (break) line across page (dividing paragraphs):
+

-..-
+
+

Book Index

To make an index append to paragraph the book index term relates diff --git a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_markup.sst b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_markup.sst index 98377850..92b7f430 100644 --- a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_markup.sst +++ b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_markup.sst @@ -1162,6 +1162,8 @@ may be used. 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). +To draw a dividing line dividing paragraphs, see the section on page breaks. + 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: @@ -1170,6 +1172,10 @@ page new =\\= or <:pn> breaks the page, starts a new page. page break -\\- or <:pb> breaks a column, starts a new column, if using columns, else breaks the page, starts a new page. +page break line across page -..- draws a dividing line, dividing paragraphs + +page break: + code{ -\\- @@ -1180,7 +1186,7 @@ or }code -or +page (break) new: code{ @@ -1192,6 +1198,14 @@ or }code +page (break) line across page (dividing paragraphs): + +code{ + +-..- + +}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. diff --git a/man/man1/sisu.1 b/man/man1/sisu.1 index f21808b1..9fcc524c 100644 --- a/man/man1/sisu.1 +++ b/man/man1/sisu.1 @@ -1,4 +1,4 @@ -.TH "sisu" "1" "2013-02-07" "4.0.6" "SiSU" +.TH "sisu" "1" "2013-02-22" "4.0.9" "SiSU" .br .SH NAME .br @@ -2272,6 +2272,12 @@ page new =\e= or breaks the page, starts a new page. .BR page break -\\- or breaks a column, starts a new column, if using columns, else breaks the page, starts a new page. + +.BR +page break line across page -..- draws a dividing line, dividing paragraphs + +.BR +page break: .nf -\e\e- @@ -2280,13 +2286,20 @@ or .fi .BR -or +page (break) new: .nf =\e\e= or <:pn> .fi + +.BR +page (break) line across page (dividing paragraphs): +.nf +-..- +.fi + .SH BOOK INDEX .BR -- cgit v1.2.3