diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 116 |
1 files changed, 76 insertions, 40 deletions
@@ -81,9 +81,9 @@ specify sisu version for sisu installed via gem gem search sisu - sisu _5.6.0_ --version + sisu _5.6.2_ --version - sisu _6.2.1_ --version + sisu _6.2.3_ --version to uninstall sisu installed via gem @@ -249,8 +249,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 -*--asciitext [filename/wildcard]* -asciitext, smart text (not available) +*--asciidoc [filename/wildcard]* +asciidoc, smart text (not available) *-b [filename/wildcard]* see --xhtml @@ -331,6 +331,9 @@ see --epub *--epub [filename/wildcard]* produces an epub document, [sisu version >=2 ] (filename.epub). Alias -e +*--errors-as-warnings* +override stop processing on error. Alias --no-stop + *--exc-** exclude output feature, overrides configuration settings --exc-numbering, see --exc-ocn; --exc-ocn, (exclude "object citation numbering", (switches off @@ -360,12 +363,10 @@ see --find fictionbook xml (not available) *--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 *-G [optional string part of filename]* -see --find +see --glob *-g [filename/wildcard]* see --git @@ -375,7 +376,9 @@ produces or updates markup source file structure in a git repo (experimental and subject to change). Alias -g *--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 *-h [filename/wildcard]* see --html @@ -387,13 +390,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. -*--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. - *--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). @@ -479,6 +475,9 @@ by most processing flags. *--no-** see --exc-* +*--no-stop* +override stop processing on error. Alias --erros-as-warnings + *--numbering* turn on "object citation numbers". See --inc-ocn and --exc-ocn @@ -695,8 +694,8 @@ include: --endnotes for endnotes --footnotes for footnotes at the end of each paragraph --unix for unix linefeed (default) --msdos for msdos linefeed). Alias -t -*--txt-asciitext [filename/wildcard]* -see --asciitext +*--txt-asciidoc [filename/wildcard]* +see --asciidoc *--txt-markdown [filename/wildcard]* see --markdown @@ -748,6 +747,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 +*--very-verbose [filename/wildcard]* +provides more verbose output of what is being generated. See --verbose. Alias +-V + +*--version* +sisu version + *-W* see --webrick @@ -892,21 +898,6 @@ primary outline of the document structure. Markup of substantive text includes: * paragraph actions, such as indent, bulleted, numbered-lists, etc. -Some interactive help on markup is available, by typing sisu and selecting -markup or sisu --help markup - -To check the markup in a file: - - sisu --identify [filename].sst - -For brief descriptive summary of markup history - - sisu --query-history - -or if for a particular version: - - sisu --query-0.38 - MARKUP RULES, DOCUMENT STRUCTURE AND METADATA REQUIREMENTS .......................................................... @@ -1201,7 +1192,7 @@ FONT ATTRIBUTES *markup example:* -normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}", +normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}", ^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}-, #{monospace}# normal text @@ -1566,8 +1557,53 @@ TREE markup source text [link: <http://www.sisudoc.org/sisu/en/src/viral_spiral.david_bollier.sst>] markup source (zipped) pod [link: <http://www.sisudoc.org/sisu/en/src/viral_spiral.david_bollier.sst.zip>] -GROUPED TEXT -............ +GROUPED TEXT / BLOCKED TEXT +........................... + +There are two markup syntaxes for blocked text, using curly braces or using +tics + + +---------------------------------------- + +BLOCKED TEXT CURLY BRACE SYNTAX +............................... + +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. + +code{ +this is a code block + +}code + +poem{ + +this here is a poem + +}poem + + +---------------------------------------- + +BLOCKED TEXT TIC SYNTAX +....................... + +``` code +this is a code block + +``` + +``` poem + +this here is a poem + +``` + +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. ---------------------------------------- @@ -1995,8 +2031,8 @@ its own: page new =\= 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. +page break -\- 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 @@ -2075,8 +2111,8 @@ 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* +(insert/information) 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 |