From 1508dff14d18ed77bcab2b7b1a04a02ec0693e44 Mon Sep 17 00:00:00 2001
From: Ralph Amissah <ralph@amissah.com>
Date: Wed, 20 Aug 2014 19:13:14 -0400
Subject: documentation related, sisu manual book index, and --no-stop command
---
man/man1/sisu.1 | 126 ++++++++++++++++++++++++++++++++++----------------------
1 file changed, 77 insertions(+), 49 deletions(-)
(limited to 'man/man1')
diff --git a/man/man1/sisu.1 b/man/man1/sisu.1
index 608f69a2..12a89950 100644
--- a/man/man1/sisu.1
+++ b/man/man1/sisu.1
@@ -1,4 +1,4 @@
-.TH "sisu" "1" "2014-02-05" "6.2.1" "SiSU"
+.TH "sisu" "1" "2014-02-05" "6.2.3" "SiSU"
.br
.SH NAME
.br
@@ -144,8 +144,8 @@ is provided is --act0, current default setting for --act0 is --digest --qrcode
--text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax
--xml-dom --sqlite --manifest --verbose
.TP
-.B --asciitext [filename/wildcard]
-asciitext, smart text (not available)
+.B --asciidoc [filename/wildcard]
+asciidoc, smart text (not available)
.TP
.B -b [filename/wildcard]
see --xhtml
@@ -227,6 +227,9 @@ see --epub
.B --epub [filename/wildcard]
produces an epub document, [sisu version >=2 ] (filename.epub). Alias -e
.TP
+.B --errors-as-warnings
+override stop processing on error. Alias --no-stop
+.TP
.B --exc-*
exclude output feature, overrides configuration settings --exc-numbering, see
--exc-ocn; --exc-ocn, (exclude "object citation numbering", (switches off
@@ -256,12 +259,10 @@ see --find
fictionbook xml (not available)
.TP
.B --find [optional string part of filename]
-without match string, glob all .sst .ssm files in directory (including language
-subdirectories). With match string, find files that match given string in
-directory (including language subdirectories). Alias -f, --glob, -G
+see --glob
.TP
.B -G [optional string part of filename]
-see --find
+see --glob
.TP
.B -g [filename/wildcard]
see --git
@@ -271,7 +272,9 @@ produces or updates markup source file structure in a git repo (experimental
and subject to change). Alias -g
.TP
.B --glob [optional string part of filename]
-see --find
+without match string, glob all .sst .ssm files in directory (including language
+subdirectories). With match string, find files that match given string in
+directory (including language subdirectories). Alias -G, -f, --find
.TP
.B -h [filename/wildcard]
see --html
@@ -283,13 +286,6 @@ topic with titles and author. Makes use of header metadata fields (author,
title, date, topic_register). Can be used with maintenance (-M) and remote
placement (-R) flags.
.TP
-.B --help [topic]
-provides help on the selected topic, where topics (keywords) include: list,
-(com)mands, short(cuts), (mod)ifiers, (env)ironment, markup, syntax, headers,
-headings, endnotes, tables, example, customise, skin, (dir)ectories, path,
-(lang)uage, db, install, setup, (conf)igure, convert, termsheet, search, sql,
-features, license.
-.TP
.B --html [filename/wildcard]
produces html output, in two forms (i) segmented text with table of contents
(toc.html and index.html) and (ii) the document in a single file (scroll.html).
@@ -375,6 +371,9 @@ by most processing flags.
.B --no-*
see --exc-*
.TP
+.B --no-stop
+override stop processing on error. Alias --erros-as-warnings
+.TP
.B --numbering
turn on "object citation numbers". See --inc-ocn and --exc-ocn
.TP
@@ -615,8 +614,8 @@ footnotes at end of each paragraph that contains them [ -A for equivalent dos
endnotes --footnotes for footnotes at the end of each paragraph --unix for unix
linefeed (default) --msdos for msdos linefeed). Alias -t
.TP
-.B --txt-asciitext [filename/wildcard]
-see --asciitext
+.B --txt-asciidoc [filename/wildcard]
+see --asciidoc
.TP
.B --txt-markdown [filename/wildcard]
see --markdown
@@ -671,6 +670,13 @@ provides verbose output of what is being generated, where output is placed (and
error messages if any), as with -u flag provides a url mapping of files created
for each of the processing flag requests. Alias -v
.TP
+.B --very-verbose [filename/wildcard]
+provides more verbose output of what is being generated. See --verbose. Alias
+-V
+.TP
+.B --version
+sisu version
+.TP
.B -W
see --webrick
.TP
@@ -943,28 +949,6 @@ primary outline of the document structure. Markup of substantive text includes:
.BR
* paragraph actions, such as indent, bulleted, numbered-lists, etc.
-
-.BR
-Some interactive help on markup is available, by typing sisu and selecting
-markup or sisu --help markup
-
-.BR
-To check the markup in a file:
-
-.BR
- sisu --identify [filename].sst
-
-.BR
-For brief descriptive summary of markup history
-
-.BR
- sisu --query-history
-
-.BR
-or if for a particular version:
-
-.BR
- sisu --query-0.38
.SH MARKUP RULES, DOCUMENT STRUCTURE AND METADATA REQUIREMENTS
@@ -975,7 +959,6 @@ minimal content/structure requirement:
[metadata]
.nf
A~ (level A [title])
-1~ (at least one level 1 [segment/(chapter)])
.fi
@@ -1320,7 +1303,7 @@ be marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a document
.B markup example:
.nf
-normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}",
+normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}",
^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}-, #{monospace}#
normal text
@@ -1852,8 +1835,55 @@ David Bollier
⌠markup source text⌡「http://corundum/sisu_manual/en/src/viral_spiral.david_bollier.sst」
⌠markup source (zipped) pod⌡「http://corundum/sisu_manual/en/pod/viral_spiral.david_bollier.sst.zip」
-.SH GROUPED TEXT
+.SH GROUPED TEXT / BLOCKED TEXT
+
+.BR
+There are two markup syntaxes for blocked text, using curly braces or using
+tics
+.SH BLOCKED TEXT CURLY BRACE SYNTAX
+
+
+.BR
+at the start of a line on its own use name of block type with an opening curly
+brace, follow with the content of the block, and close with a closing curly
+brace and the name of the block type, e.g.
+.nf
+code{
+
+this is a code block
+
+}code
+.fi
+
+.nf
+
+poem{
+
+this here is a poem
+
+}poem
+.fi
+
+.SH BLOCKED TEXT TIC SYNTAX
+
+.nf
+``` code
+this is a code block
+
+```
+
+``` poem
+this here is a poem
+
+```
+.fi
+
+
+.BR
+start a line with three backtics, a space followed by the name of the name of
+block type, follow with the content of the block, and close with three back
+ticks on a line of their own, e.g.
.SH TABLES
@@ -2316,8 +2346,8 @@ its own:
page new =\e= breaks the page, starts a new page.
.BR
-page break -\- breaks a column, starts a new column, if using columns,
-else breaks the page, starts a new page.
+page break -\- 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
@@ -2430,8 +2460,8 @@ master document
.B .sst
regular markup file, or
.B .ssi
-(insert). A secondary file of the composite document is built prior to
-processing with the same prefix and the suffix
+(insert/information) A secondary file of the composite document is built prior
+to processing with the same prefix and the suffix
.B ._sst
.BR
@@ -3016,8 +3046,6 @@ output_dir_structure_by: filename
./sisupod/_sisu/mm
.fi
-.SH ORGANISING CONTENT
-
.SH HOMEPAGES
@@ -3461,7 +3489,7 @@ updates file contents in database
.TP
.B sisu -d --remove -v [filename/wildcard]
removes specified document from sqlite database.
-.SH INTRODUCTION
+.SH CGI SEARCH FORM
.SH SETUP SEARCH FORM
--
cgit v1.2.3