aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2013-12-03 00:34:46 -0500
committerRalph Amissah <ralph@amissah.com>2013-12-03 00:34:46 -0500
commit88b3272a0f19387b3c5551c8e04b99e3535dd3a1 (patch)
treefb73b323e9d02f4f3c7c47e8e4a7563a58f7c403
parentv5: xml, fictionbook (diff)
v5: documentation related to commands for new outputs in developmentsisu_4.2.13
-rw-r--r--data/doc/sisu/CHANGELOG_v52
-rw-r--r--data/doc/sisu/markup-samples/sisu_manual/en/sisu_commands.sst32
-rw-r--r--data/doc/sisu/markup-samples/sisu_manual/en/sisu_markup.sst6
-rw-r--r--man/man1/sisu.187
4 files changed, 114 insertions, 13 deletions
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
diff --git a/man/man1/sisu.1 b/man/man1/sisu.1
index 71251228..a692a9f4 100644
--- a/man/man1/sisu.1
+++ b/man/man1/sisu.1
@@ -1,4 +1,4 @@
-.TH "sisu" "1" "2013-07-25" "4.1.8" "SiSU"
+.TH "sisu" "1" "2013-11-27" "5.1.0" "SiSU"
.br
.SH NAME
.br
@@ -266,6 +266,12 @@ 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)
.TP
+.B --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)
+.TP
.B -b [filename/wildcard]
see --xhtml
.TP
@@ -322,13 +328,16 @@ see --sqlite
.TP
.B --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
+(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
.TP
.B --delete [filename/wildcard]
see --zap
.TP
+.B --docbook [filename/wildcard/url]
+docbook smart text (sisu v5)
+.TP
.B --dump[=directory_path] [filename/wildcard]
places output in directory specified, if none is specified in the current
directory (pwd). Unlike using default settings
@@ -368,6 +377,9 @@ see --sample-search-form
.B -f [optional string part of filename]
see --find
.TP
+.B --fictionbook [filename/wildcard/url]
+fictionbook smart text (sisu v5)
+.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
@@ -457,6 +469,9 @@ 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.
.TP
+.B --markdown [filename/wildcard/url]
+markdown smart text (sisu v5)
+.TP
.B --manpage [filename/wildcard]
produces man page of file, not suitable for all outputs. Alias -i
.TP
@@ -597,6 +612,9 @@ subdirectory under the current directory (pwd). Unlike using default settings
.I HTML
files have embedded css. Compare --dump
.TP
+.B --rst [filename/wildcard/url]
+ReST (rST restructured text) smart text (sisu v5)
+.TP
.B --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
@@ -693,6 +711,9 @@ see --txt
.B --texinfo [filename/wildcard]
produces texinfo and info file, (view with pinfo). Alias -I
.TP
+.B --textile [filename/wildcard/url]
+textile smart text (sisu v5)
+.TP
.B --txt [filename/wildcard]
produces
.I plaintext
@@ -702,6 +723,18 @@ 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
+.TP
+.B --txt-markdown [filename/wildcard]
+see --markdown
+.TP
+.B --txt-rst [filename/wildcard]
+see --rst
+.TP
+.B --txt-textile [filename/wildcard]
+see --textile
+.TP
.B -U [filename/wildcard]
see --urls
.TP
@@ -1596,7 +1629,7 @@ normal text [^**] continues
.nf
normal text ~[* editors notes, numbered asterisk footnote/endnote series ]~ continues
-normal text ~[+ editors notes, numbered asterisk footnote/endnote series ]~ continues
+normal text ~[+ editors notes, numbered plus symbol footnote/endnote series ]~ continues
.fi
.BR
@@ -1855,7 +1888,7 @@ information in each column
.BR
.B markup example:
-[^17]
+[^18]
.nf
!_ Table 3.1: Contributors to Wikipedia, January 2001 - June 2005
@@ -2257,7 +2290,7 @@ its own:
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,
+page break -\e- or breaks a column, starts a new column, if using columns,
else breaks the page, starts a new page.
.BR
@@ -2335,7 +2368,10 @@ If multiple sub-terms appear under one paragraph, they are separated under the
main term heading from each other by a pipe symbol.
.nf
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
.fi
@@ -2347,6 +2383,7 @@ additional paragraph. The logical structure of the resulting index would be:
Main term, 1,
sub-term, 1-3,
second sub-term, 1,
+ Another term, 1
.fi
.SH COMPOSITE DOCUMENTS MARKUP
@@ -2384,7 +2421,36 @@ The form described above should be relied on. Within the
.I Vim
editor it results in the text thus linked becoming hyperlinked to the document
it is calling in which is convenient for editing.
+.SH SUBSTITUTIONS
+
+
+.BR
+
+.B markup example:
+.nf
+The current Debian is ${debian_stable} the next debian will be ${debian_testing}
+Configure substitution in _sisu/sisu_document_make
+
+@make:
+:substitute: /${debian_stable}/,'*{Wheezy}*' /${debian_testing}/,'*{Jessie}*'
+.fi
+
+
+.BR
+
+.B resulting output:
+
+.BR
+The current
+.B Debian
+is
+.B Wheezy
+the next debian will be
+.B Jessie
+
+.BR
+Configure substitution in _sisu/sisu_document_make
.SH SISU FILETYPES
.BR
@@ -2668,8 +2734,7 @@ supported by XeTeX polyglosia.
.SH GENERAL DIRECTORIES
.nf
- ./subject_name/
-
+\./subject_name/
% files stored at this level e.g. sisu_manual.sst or
% for sisu v3 may be under language sub-directories
% e.g.
@@ -3788,7 +3853,7 @@ editors notes, numbered asterisk footnote/endnote series
.BR
.TP
.BI +2.
-editors notes, numbered asterisk footnote/endnote series
+editors notes, numbered plus symbol footnote/endnote series
.BR
.TP