aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2014-07-22 21:56:23 -0400
committerRalph Amissah <ralph@amissah.com>2014-07-22 21:56:23 -0400
commit162c6f42bfbbdd4c8c4153bfe6781e83b768326f (patch)
tree5dbc8a659fba4b1e902501f7f26fcd6b69d6c2dd /data/doc
parentdebian/changelog (5.5.1-1) (diff)
parentdocumentation related (diff)
Merge tag 'sisu_5.5.2' into debian/sid
SiSU 5.5.2
Diffstat (limited to 'data/doc')
-rw-r--r--data/doc/sisu/CHANGELOG_v525
-rw-r--r--data/doc/sisu/CHANGELOG_v625
-rw-r--r--data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_fn.yml12
-rw-r--r--data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_fn_monolingual.yml12
-rw-r--r--data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_ft.yml12
-rw-r--r--data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_ft_monolingual.yml12
-rw-r--r--data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_lng.yml12
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_commands.sst33
8 files changed, 98 insertions, 45 deletions
diff --git a/data/doc/sisu/CHANGELOG_v5 b/data/doc/sisu/CHANGELOG_v5
index f6c18141..c9416620 100644
--- a/data/doc/sisu/CHANGELOG_v5
+++ b/data/doc/sisu/CHANGELOG_v5
@@ -31,6 +31,31 @@ v2 branch is removed; it is available in sisu =< 3.3.2
%% Reverse Chronological:
+%% 5.5.2.orig.tar.xz (2014-07-22:29/2)
+http://sources.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/sisu_5.5.2
+http://sources.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/debian/sisu_5.5.2-1
+http://www.jus.uio.no/sisu/pkg/src/sisu_5.5.2.orig.tar.xz
+ sisu_5.5.2.orig.tar.xz
+ sisu_5.5.2-1.dsc
+
+* bin/sisu, hub, hub close (ensure), remove /tmp/ processing dir
+
+* html_lite_shared, issue fix
+
+* options, sisupod parsing fix
+
+* db, reorganize action triggers
+
+* db pg import, fix
+ * remove dbi from rescue, no longer using ruby-dbi
+ * ruby-pg query SELECT MAX
+
+* sysenv,
+ * break up file, multiple se_* files
+ * revert to use of stub_pwd (instead of new base_markup_dir_stub introduced in
+ 5.5.1) to bring back correct hub (post) processing behavior
+ * processing shortcuts, options, adjust (refinement necessary)
+
%% 5.5.1.orig.tar.xz (2014-07-15:28/2)
http://sources.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/sisu_5.5.1
http://sources.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/debian/sisu_5.5.1-1
diff --git a/data/doc/sisu/CHANGELOG_v6 b/data/doc/sisu/CHANGELOG_v6
index ddf381fd..e41a12e0 100644
--- a/data/doc/sisu/CHANGELOG_v6
+++ b/data/doc/sisu/CHANGELOG_v6
@@ -21,6 +21,31 @@ v2 branch is removed; it is available in sisu =< 3.3.2
%% Reverse Chronological:
+%% 6.1.2.orig.tar.xz (2014-07-22:29/2)
+http://sources.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/sisu_6.1.2
+http://sources.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/debian/sisu_6.1.2-1
+http://www.jus.uio.no/sisu/pkg/src/sisu_6.1.2.orig.tar.xz
+ sisu_6.1.2.orig.tar.xz
+ sisu_6.1.2-1.dsc
+
+* bin/sisu, hub, hub close (ensure), remove /tmp/ processing dir
+
+* html_lite_shared, issue fix
+
+* options, sisupod parsing fix
+
+* db, reorganize action triggers
+
+* db pg import, fix
+ * remove dbi from rescue, no longer using ruby-dbi
+ * ruby-pg query SELECT MAX
+
+* sysenv,
+ * break up file, multiple se_* files
+ * revert to use of stub_pwd (instead of new base_markup_dir_stub introduced in
+ 6.1.1) to bring back correct hub (post) processing behavior
+ * processing shortcuts, options, adjust (refinement necessary)
+
%% 6.1.1.orig.tar.xz (2014-07-15:28/2)
http://sources.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/sisu_6.1.1
http://sources.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/debian/sisu_6.1.1-1
diff --git a/data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_fn.yml b/data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_fn.yml
index 7f78f367..1f0a7981 100644
--- a/data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_fn.yml
+++ b/data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_fn.yml
@@ -49,12 +49,12 @@ show_output_on: 'filesystem_url'
#% flag - set (non-default) processing flag shortcuts -1, -2 etc. (here adding colour and verbosity as default)
flag:
color: true # making colour default -c is toggle, and will now toggle colour off
-# default: '-NQdhewpotbxXyYv' # includes verbose; -m would in any event be run by default
-# i: '-NQdhewpoty' # -m run by default
-# ii: '-NQdhewpotbxXy' # -m run by default
-# iii: '-NQdhewpotbxXyY' # -m run by default
-# iv: '-NQhewpotbxXYDy --update' # -m run by default
-# v: '-NQhewpotbxXYDyv --update' # includes verbose; -m run by default
+# default: '--digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --sqlite --manifest --verbose'
+# i: '--digest --qrcode --text --html --epub --concordance --pdf --manifest'
+# ii: '--digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --manifest'
+# iii: '--digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --sqlite --manifest'
+# iv: '--digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --postresql --update --manifest'
+# v: '--digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --sqlite --source --sisupod --manifest'
#% papersize, (LaTeX/pdf) available values: A4, US_letter, book_b5, book_a5, US_legal
default:
diff --git a/data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_fn_monolingual.yml b/data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_fn_monolingual.yml
index b3c49ca1..432885f6 100644
--- a/data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_fn_monolingual.yml
+++ b/data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_fn_monolingual.yml
@@ -49,12 +49,12 @@ show_output_on: 'filesystem_url'
#% flag - set (non-default) processing flag shortcuts -1, -2 etc. (here adding colour and verbosity as default)
flag:
color: true # making colour default -c is toggle, and will now toggle colour off
-# default: '-NQdhewpotbxXyYv' # includes verbose; -m would in any event be run by default
-# i: '-NQdhewpoty' # -m run by default
-# ii: '-NQdhewpotbxXy' # -m run by default
-# iii: '-NQdhewpotbxXyY' # -m run by default
-# iv: '-NQhewpotbxXYDy --update' # -m run by default
-# v: '-NQhewpotbxXYDyv --update' # includes verbose; -m run by default
+# default: '--digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --sqlite --manifest --verbose'
+# i: '--digest --qrcode --text --html --epub --concordance --pdf --manifest'
+# ii: '--digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --manifest'
+# iii: '--digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --sqlite --manifest'
+# iv: '--digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --postresql --update --manifest'
+# v: '--digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --sqlite --source --sisupod --manifest'
#% papersize, (LaTeX/pdf) available values: A4, US_letter, book_b5, book_a5, US_legal
default:
diff --git a/data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_ft.yml b/data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_ft.yml
index 26fff9a0..8a9f13d8 100644
--- a/data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_ft.yml
+++ b/data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_ft.yml
@@ -49,12 +49,12 @@ show_output_on: 'filesystem_url'
#% flag - set (non-default) processing flag shortcuts -1, -2 etc. (here adding colour and verbosity as default)
flag:
color: true # making colour default -c is toggle, and will now toggle colour off
-# default: '-NQdhewpotbxXyYv' # includes verbose; -m would in any event be run by default
-# i: '-NQdhewpoty' # -m run by default
-# ii: '-NQdhewpotbxXy' # -m run by default
-# iii: '-NQdhewpotbxXyY' # -m run by default
-# iv: '-NQhewpotbxXYDy --update' # -m run by default
-# v: '-NQhewpotbxXYDyv --update' # includes verbose; -m run by default
+# default: '--digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --sqlite --manifest --verbose'
+# i: '--digest --qrcode --text --html --epub --concordance --pdf --manifest'
+# ii: '--digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --manifest'
+# iii: '--digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --sqlite --manifest'
+# iv: '--digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --postresql --update --manifest'
+# v: '--digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --sqlite --source --sisupod --manifest'
#% papersize, (LaTeX/pdf) available values: A4, US_letter, book_b5, book_a5, US_legal
default:
diff --git a/data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_ft_monolingual.yml b/data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_ft_monolingual.yml
index adf144d5..752dbd66 100644
--- a/data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_ft_monolingual.yml
+++ b/data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_ft_monolingual.yml
@@ -49,12 +49,12 @@ show_output_on: 'filesystem_url'
#% flag - set (non-default) processing flag shortcuts -1, -2 etc. (here adding colour and verbosity as default)
flag:
color: true # making colour default -c is toggle, and will now toggle colour off
-# default: '-NQdhewpotbxXyYv' # includes verbose; -m would in any event be run by default
-# i: '-NQdhewpoty' # -m run by default
-# ii: '-NQdhewpotbxXy' # -m run by default
-# iii: '-NQdhewpotbxXyY' # -m run by default
-# iv: '-NQhewpotbxXYDy --update' # -m run by default
-# v: '-NQhewpotbxXYDyv --update' # includes verbose; -m run by default
+# default: '--digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --sqlite --manifest --verbose'
+# i: '--digest --qrcode --text --html --epub --concordance --pdf --manifest'
+# ii: '--digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --manifest'
+# iii: '--digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --sqlite --manifest'
+# iv: '--digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --postresql --update --manifest'
+# v: '--digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --sqlite --source --sisupod --manifest'
#% papersize, (LaTeX/pdf) available values: A4, US_letter, book_b5, book_a5, US_legal
default:
diff --git a/data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_lng.yml b/data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_lng.yml
index 9b60f8c9..364532df 100644
--- a/data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_lng.yml
+++ b/data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_lng.yml
@@ -50,12 +50,12 @@ show_output_on: 'filesystem_url'
#% flag - set (non-default) processing flag shortcuts -1, -2 etc. (here adding colour and verbosity as default)
flag:
color: true # making colour default -c is toggle, and will now toggle colour off
-# default: '-NQdhewpotbxXyYv' # includes verbose; -m would in any event be run by default
-# i: '-NQdhewpoty' # -m run by default
-# ii: '-NQdhewpotbxXy' # -m run by default
-# iii: '-NQdhewpotbxXyY' # -m run by default
-# iv: '-NQhewpotbxXYDy --update' # -m run by default
-# v: '-NQhewpotbxXYDyv --update' # includes verbose; -m run by default
+# default: '--digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --sqlite --manifest --verbose'
+# i: '--digest --qrcode --text --html --epub --concordance --pdf --manifest'
+# ii: '--digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --manifest'
+# iii: '--digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --sqlite --manifest'
+# iv: '--digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --postresql --update --manifest'
+# v: '--digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --sqlite --source --sisupod --manifest'
#% papersize, (LaTeX/pdf) available values: A4, US_letter, book_b5, book_a5, US_legal
default:
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 16661dd6..7af33161 100644
--- a/data/doc/sisu/markup-samples/manual/en/sisu_commands.sst
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_commands.sst
@@ -79,11 +79,8 @@ configure/initialise shared output directory files initialize shared output dire
!_ --concordance [filename/wildcard] \\
produces concordance (wordmap) a rudimentary index of all the words in a document. (Concordance files are not generated for documents of over 260,000 words unless this limit is increased in the file sisurc.yml). Alias -w
-!_ -D [instruction] [filename] \\
-see --pg
-
-!_ -d [--db-[database type (sqlite|pg)]] --[instruction] [filename] \\
-see --sqlite
+!_ -d [filename/wildcard/url] \\
+see --docbook
!_ --dal [filename/wildcard/url] \\
(abstract objects, document abstraction renamed abstract objects in sisu5) see --ao
@@ -91,6 +88,9 @@ see --sqlite
!_ --delete [filename/wildcard] \\
see --zap
+!_ --digests [filename/wildcard/url] \\
+document digest or document content certificate ( DCC ) as sha digest tree of the document: the digest for the document, and digests for each object contained within the document (together with information on software versions that produced it) (digest.txt). --digests -V for verbose digest output to screen.
+
!_ --docbook [filename/wildcard/url] \\
docbook xml
@@ -203,12 +203,15 @@ 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 (not available)
+!_ --manifest [filename/wildcard] \\
+produces an html summary of output generated (hyperlinked to content) and document specific metadata (sisu_manifest.html). This step is assumed for most processing flags.
!_ --manpage [filename/wildcard] \\
produces man page of file, not suitable for all outputs. Alias -i
+!_ --markdown [filename/wildcard/url] \\
+markdown smart text (not available)
+
!_ --monolingual \\
see --i18n-*
@@ -216,7 +219,7 @@ see --i18n-*
see --i18n-*
!_ -N [filename/wildcard/url] \\
-document digest or document content certificate ( DCC ) as md5 digest tree of the document: the digest for the document, and digests for each object contained within the document (together with information on software versions that produced it) (digest.txt). -NV for verbose digest output to screen.
+see --digests
!_ -n [filename/wildcard/url] \\
skip the creation of intermediate processing files (document abstraction) if they already exist, this skips the equivalent of -m which is otherwise assumed by most processing flags.
@@ -273,8 +276,8 @@ See --pdf-portrait
!_ --pdf-portrait [filename/wildcard] \\
sets orientation, produces LaTeX pdf portrait.pdf.pdf. Default paper size is set in config file, or document header, or provided with additional command line parameter, e.g. --papersize-a4 preset sizes include: 'A4', U.S. 'letter' and 'legal' and book sizes 'A5' and 'B5' (system defaults to A4). Related options --pdf --pdf-landscape. See also --papersize-* or --papersize=[list]. Alias --pdf-p or in conjunction with --pdf --portrait
-!_ --pg [instruction] [filename] \\
-database PostgreSQL ( --pgsql may be used instead) possible instructions, include: --createdb; --create; --dropall; --import [filename]; --update [filename]; --remove [filename]; see database section below. Alias -D
+!_ --pg-[instruction] [filename] \\
+database PostgreSQL ( --pgsql may be used instead) possible instructions, include: --pg-createdb; --pg-create; --pg-dropall; --pg-import [filename]; --pg-update [filename]; --pg-remove [filename]; see database section below.
!_ --po [language_directory/filename language_directory] \\
see --po4a
@@ -330,8 +333,8 @@ set hash digest where used to sha256
!_ --sha512 \\
set hash digest where used to sha512
-!_ --sqlite --[instruction] [filename] \\
-database type set to SQLite, this produces one of two possible databases, without additional database related instructions it produces a discreet SQLite file for the document processed; with additional instructions it produces a common SQLite database of all processed documents that (come from the same document preparation directory and as a result) share the same output directory base path (possible instructions include: --createdb; --create; --dropall; --import [filename]; --update [filename]; --remove [filename]); see database section below. Alias -d
+!_ --sqlite-[instruction] [filename] \\
+database type set to SQLite, this produces one of two possible databases, without additional database related instructions it produces a discreet SQLite file for the document processed; with additional instructions it produces a common SQLite database of all processed documents that (come from the same document preparation directory and as a result) share the same output directory base path (possible instructions include: --sqlite-createdb; --sqlite-create; --sqlite-dropall; --sqlite-import [filename]; --sqlite-update [filename]; --sqlite-remove [filename]); see database section below.
!_ --sisupod \\
produces a sisupod a zipped sisu directory of markup files including sisu markup source files and the directories local configuration file, images and skins. Note: this only includes the configuration files or skins contained in ./_sisu not those in ~/.sisu -S [filename/wildcard] option. Note: (this option is tested only with zsh). Alias -S
@@ -433,7 +436,7 @@ see --xml-sax
produces a short sitemap entry for the document, based on html output and the sisu_manifest. --sitemaps generates/updates the sitemap index of existing sitemaps. (Experimental, [g,y,m announcement this week])
!_ -y [filename/wildcard] \\
-produces an html summary of output generated (hyperlinked to content) and document specific metadata (sisu_manifest.html). This step is assumed for most processing flags.
+see --manifest
!_ -Z [filename/wildcard] \\
see --zap
@@ -459,9 +462,9 @@ strips output text of editor endnotes~[+ square brackets ]~ denoted by dagger/pl
!_ dbi - database interface
-!_ -D or --pgsql
+!_ --pg or --pgsql
set for PostgreSQL
-!_ -d or --sqlite
+!_ --sqlite
default set for SQLite -d is modifiable with --db=[database type (PgSQL or SQLite)]
!_ --pg -v --createall \\