From 88b3272a0f19387b3c5551c8e04b99e3535dd3a1 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 3 Dec 2013 00:34:46 -0500 Subject: v5: documentation related to commands for new outputs in development --- data/doc/sisu/CHANGELOG_v5 | 2 ++ .../sisu_manual/en/sisu_commands.sst | 32 +++++++++++++++++++++- .../markup-samples/sisu_manual/en/sisu_markup.sst | 6 +++- 3 files changed, 38 insertions(+), 2 deletions(-) (limited to 'data') diff --git a/data/doc/sisu/CHANGELOG_v5 b/data/doc/sisu/CHANGELOG_v5 index 7a09c091..1403cb6f 100644 --- a/data/doc/sisu/CHANGELOG_v5 +++ b/data/doc/sisu/CHANGELOG_v5 @@ -88,6 +88,8 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_5.1.0.orig.tar.xz * hub, sisu5 -M (maintenance mode) provide info as to path to hub.rb (i.e. where library is being drawn) +* documentation related to commands for new outputs in development + %% 5.0.25.orig.tar.xz (2013-11-08:44/5) http://sources.sisudoc.org/gitweb/?p=code/sisu.git;a=shortlog;h=refs/tags/sisu_5.0.25 http://sources.sisudoc.org/gitweb/?p=code/sisu.git;a=shortlog;h=refs/tags/debian/sisu_5.0.25-1 diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_commands.sst b/data/doc/sisu/markup-samples/sisu_manual/en/sisu_commands.sst index 8e8926ad..2ca43a43 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_commands.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/en/sisu_commands.sst @@ -40,6 +40,9 @@ SiSU is a document publishing system, that from a simple single marked-up docume !_ -a [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) +!_ --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) + !_ -b [filename/wildcard] \\ see --xhtml @@ -80,11 +83,14 @@ see --pg see --sqlite !_ --dal [filename/wildcard/url] \\ -assumed for most other flags, creates new intermediate files for processing (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 +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 !_ --delete [filename/wildcard] \\ see --zap +!_ --docbook [filename/wildcard/url] \\ +docbook smart text (sisu v5) + !_ --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 @@ -117,6 +123,9 @@ see --sample-search-form !_ -f [optional string part of filename] \\ see --find +!_ --fictionbook [filename/wildcard/url] \\ +fictionbook smart text (sisu v5) + !_ --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 @@ -188,6 +197,9 @@ see --dal (document abstraction level/layer) !_ --maintenance [filename/wildcard/url] \\ 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) + !_ --manpage [filename/wildcard] \\ produces man page of file, not suitable for all outputs. Alias -i @@ -279,6 +291,9 @@ see --scp !_ --redirect[=directory_path] [filename/wildcard] \\ 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) + !_ --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 @@ -318,9 +333,24 @@ see --txt !_ --texinfo [filename/wildcard] \\ produces texinfo and info file, (view with pinfo). Alias -I +!_ --textile [filename/wildcard/url] \\ +textile smart text (sisu v5) + !_ --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 +!_ --txt-asciitext [filename/wildcard] \\ +see --asciitext + +!_ --txt-markdown [filename/wildcard] \\ +see --markdown + +!_ --txt-rst [filename/wildcard] \\ +see --rst + +!_ --txt-textile [filename/wildcard] \\ +see --textile + !_ -U [filename/wildcard] \\ see --urls diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_markup.sst b/data/doc/sisu/markup-samples/sisu_manual/en/sisu_markup.sst index ddf6e570..69293637 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_markup.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/en/sisu_markup.sst @@ -1254,7 +1254,10 @@ If multiple sub-terms appear under one paragraph, they are separated under the m code{ Paragraph containing main term, second term and sub-term. - ={Main term:sub-term+1|second sub-term} + ={Main term: + sub-term+2|second sub-term; + Another term + } A paragraph that continues discussion of the first sub-term @@ -1267,6 +1270,7 @@ code{ Main term, 1, sub-term, 1-3, second sub-term, 1, + Another term, 1 }code -- cgit v1.2.3