aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/sisu/markup-samples
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2014-02-14 00:26:53 -0500
committerRalph Amissah <ralph@amissah.com>2014-02-14 00:26:55 -0500
commit06145fcda953ce6ea963b63a91e4ac8103c9cc58 (patch)
treee29a1853cdaa1f9ffca13e71cb96183c5b6b8a5b /data/doc/sisu/markup-samples
parentv5 v6: version & changelog (& rakefile) (diff)
v5 v6: ocn, object citation numbering, --no-numbering option & default tuningsisu_5.3.4
* add less cryptic --numbering --no-numbering command-line options (to --no-ocn) * plaintext & odt switch default to ocn==true for consistency with other output * [decide how fine-grained ocn/numbering switches could be: could be per output type by command-line instruction (see txt & odt); currently set per sisu instruction for all outputs]
Diffstat (limited to 'data/doc/sisu/markup-samples')
-rw-r--r--data/doc/sisu/markup-samples/manual/README6
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_commands.sst25
2 files changed, 17 insertions, 14 deletions
diff --git a/data/doc/sisu/markup-samples/manual/README b/data/doc/sisu/markup-samples/manual/README
index 76b55552..dab91438 100644
--- a/data/doc/sisu/markup-samples/manual/README
+++ b/data/doc/sisu/markup-samples/manual/README
@@ -1,5 +1,5 @@
-ruby ../../../../../bin/sisu6 --txt -v en/README.ssm
-ruby ../../../../../bin/sisu6 --txt -v --no-manifest --dump='../../../../../..' en/README.ssm
+ruby ../../../../../bin/sisu6 --txt --no-ocn -v en/README.ssm
+ruby ../../../../../bin/sisu6 --txt --no-ocn -v --no-manifest --dump='../../../../../..' en/README.ssm
-ruby ../../../../../bin/sisu6 --manpage -v en/README.ssm
+ruby ../../../../../bin/sisu6 --manpage -v en/sisu.ssm
ruby ../../../../../bin/sisu6 --manpage -v --no-manifest --dump='../../../../../../man/man1' en/sisu.ssm
diff --git a/data/doc/sisu/markup-samples/manual/en/sisu_commands.sst b/data/doc/sisu/markup-samples/manual/en/sisu_commands.sst
index be491bf8..c1a0788a 100644
--- a/data/doc/sisu/markup-samples/manual/en/sisu_commands.sst
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_commands.sst
@@ -41,7 +41,7 @@ SiSU is a document publishing system, that from a simple single marked-up docume
produces plaintext with Unix linefeeds and without markup, (object numbers are omitted), has footnotes at end of each paragraph that contains them [ -A for equivalent dos (linefeed) output file] [see -e for endnotes]. (Options include: --endnotes for endnotes --footnotes for footnotes at the end of each paragraph --unix for unix linefeed (default) --msdos for msdos linefeed)
!_ --ao [filename/wildcard/url] \\
-assumed for most other flags, creates new intermediate files for processing (abstract objects, document abstraction) that is used in all subsequent processing of other output. This step is assumed for most processing flags. To skip it see -n. Alias -m. (sisu v5)
+assumed for most other flags, creates new intermediate files for processing (abstract objects, document abstraction) that is used in all subsequent processing of other output. This step is assumed for most processing flags. To skip it see -n. Alias -m.
!_ -b [filename/wildcard] \\
see --xhtml
@@ -83,13 +83,13 @@ see --pg
see --sqlite
!_ --dal [filename/wildcard/url] \\
-assumed for most other flags, creates new intermediate files for processing (abstract objects, document abstraction) that is used in all subsequent processing of other output. This step is assumed for most processing flags. To skip it see -n. Renamed --ao (abstract objects) in sisu v5. Alias -m
+(abstract objects, document abstraction renamed abstract objects in sisu5) see --ao
!_ --delete [filename/wildcard] \\
see --zap
!_ --docbook [filename/wildcard/url] \\
-docbook smart text (sisu v5)
+docbook smart text (not available)
!_ --dump[=directory_path] [filename/wildcard] \\
places output in directory specified, if none is specified in the current directory (pwd). Unlike using default settings HTML files have embedded css. Compare --redirect
@@ -102,7 +102,8 @@ produces an epub document, [sisu version >=2 ] (filename.epub). Alias -e
!_ --exc-* \\
exclude output feature, overrides configuration settings
- --exc-ocn, (exclude object citation numbering, (switches off object citation numbering), affects html (seg, scroll), epub, xhtml, xml, pdf);
+ --exc-numbering, see --exc-ocn;
+ --exc-ocn, (exclude "object citation numbering", (switches off object citation numbers), affects html (seg, scroll), epub, xhtml, xml, pdf);
--exc-toc, (exclude table of contents, affects html (scroll), epub, pdf);
--exc-links-to-manifest, --exc-manifest-links, (exclude links to manifest, affects html (seg, scroll));
--exc-search-form, (exclude search form, affects html (seg, scroll), manifest);
@@ -124,7 +125,7 @@ see --sample-search-form
see --find
!_ --fictionbook [filename/wildcard/url] \\
-fictionbook smart text (sisu v5)
+fictionbook smart text (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
@@ -176,8 +177,7 @@ Where output is in one language only the language code may not be desired.
see also --output-by-*
!_ --inc-* \\
-include output feature, overrides configuration settings, (usually the default if none set), has precedence over --exc-* (exclude output feature). Some detail provided under --exc-*,
-see --exc-*
+include output feature, overrides configuration settings, (usually the default if none set), has precedence over --exc-* (exclude output feature). Some detail provided under --exc-*, see --exc-*
!_ -j [filename/wildcard] \\
copies images associated with a file for use by html, xhtml & xml outputs (automatically invoked by --dump & redirect).
@@ -201,7 +201,7 @@ see --dal (document abstraction level/layer)
maintenance mode, interim processing files are preserved and their locations indicated. (also see -V). Aliases -M and --keep-processing-files.
!_ --markdown [filename/wildcard/url] \\
-markdown smart text (sisu v5)
+markdown smart text (not available)
!_ --manpage [filename/wildcard] \\
produces man page of file, not suitable for all outputs. Alias -i
@@ -221,11 +221,14 @@ skip the creation of intermediate processing files (document abstraction) if the
!_ --no-* \\
see --exc-*
+!_ --numbering \\
+turn on "object citation numbers". See --inc-ocn and --exc-ocn
+
!_ -o [filename/wildcard/url] \\
see --odt
!_ --ocn \\
-see --inc-ocn and --exc-ocn
+"object citation numbers". See --inc-ocn and --exc-ocn
!_ --odf [filename/wildcard/url] \\
see --odt
@@ -298,7 +301,7 @@ see --scp
places output in subdirectory under specified directory, subdirectory uses the filename (without the suffix). If no output directory is specified places the subdirectory under the current directory (pwd). Unlike using default settings HTML files have embedded css. Compare --dump
!_ --rst [filename/wildcard/url] \\
-ReST (rST restructured text) smart text (sisu v5)
+ReST (rST restructured text) smart text (not available)
!_ --rsync [filename/wildcard] \\
copies sisu output files to remote host using rsync. 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. Note the behavior of rsync different if -R is used with other flags from if used alone. Alone the rsync --delete parameter is sent, useful for cleaning the remote directory (when -R is used together with other flags, it is not). Also see --scp. Alias -R
@@ -343,7 +346,7 @@ see --txt
produces texinfo and info file, (view with pinfo). Alias -I
!_ --textile [filename/wildcard/url] \\
-textile smart text (sisu v5)
+textile smart text (not available)
!_ --txt [filename/wildcard] \\
produces plaintext with Unix linefeeds and without markup, (object numbers are omitted), has footnotes at end of each paragraph that contains them [ -A for equivalent dos (linefeed) output file] [see -e for endnotes]. (Options include: --endnotes for endnotes --footnotes for footnotes at the end of each paragraph --unix for unix linefeed (default) --msdos for msdos linefeed). Alias -t