From 45a05d0cbf65cd368ff463e02dac76796d210ee4 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Sun, 26 Jun 2011 22:55:48 -0400 Subject: sha256 (3.0.13) --- data/doc/sisu/CHANGELOG_v3 | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'data/doc') diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index 7f2093b0..2945f34e 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -16,9 +16,9 @@ v3 branch once stable will supersede & replace current stable v2 branch %% 3.0.13.orig.tar.gz (2011-06-26:25/7) http://git.sisudoc.org/?p=code/sisu.git;a=log;h=refs/tags/debian/3.0.13-1 http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.13.orig.tar.gz - sisu_3.0.13.orig.tar.gz - sisu_3.0.13-1.dsc - sisu_3.0.13-1.debian.tar.gz + 33d2358a39a69c1be4403b06b52eaeca604e851ee4e32c6f1625399944362fea 1943441 sisu_3.0.13.orig.tar.gz + c741399aa3da6189854f7a532eae6db27370646a2b86b7427bf330401369bc13 1223 sisu_3.0.13-1.dsc + 0fe5173e4973a4af7fba79dcf5ae3c702f34b5ac89e02f4be9e014641e7514d0 289790 sisu_3.0.13-1.debian.tar.gz * dal_syntax, linebreak within regular objects is \\ (
depreciated) [test, affects downstream outputs, there is the potential for breakage] -- cgit v1.2.3 From 9056c5a30941680d7e6704f1e0380f28159ddbdd Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 26 Jul 2011 20:03:08 -0400 Subject: v3: 3.0.14 version & changelog "opened" --- data/doc/sisu/CHANGELOG_v3 | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'data/doc') diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index 2945f34e..c69e53e8 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -13,6 +13,13 @@ Reverse Chronological: %% Development branch UNSTABLE v3 branch once stable will supersede & replace current stable v2 branch +%% 3.0.14.orig.tar.gz (2011-07-26:30/2) +http://git.sisudoc.org/?p=code/sisu.git;a=log;h=refs/tags/debian/3.0.14-1 +http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.14.orig.tar.gz + sisu_3.0.14.orig.tar.gz + sisu_3.0.14-1.dsc + sisu_3.0.14-1.debian.tar.gz + %% 3.0.13.orig.tar.gz (2011-06-26:25/7) http://git.sisudoc.org/?p=code/sisu.git;a=log;h=refs/tags/debian/3.0.13-1 http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.13.orig.tar.gz -- cgit v1.2.3 From 200843919b9d7e41012af32e876c43d3fb44a852 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 26 Jul 2011 20:04:52 -0400 Subject: v3: urls, --concordance (hyphen added, descriptive) --- data/doc/sisu/CHANGELOG_v3 | 2 ++ 1 file changed, 2 insertions(+) (limited to 'data/doc') diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index c69e53e8..6769a187 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -20,6 +20,8 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.14.orig.tar.gz sisu_3.0.14-1.dsc sisu_3.0.14-1.debian.tar.gz + * urls, --concordance + %% 3.0.13.orig.tar.gz (2011-06-26:25/7) http://git.sisudoc.org/?p=code/sisu.git;a=log;h=refs/tags/debian/3.0.13-1 http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.13.orig.tar.gz -- cgit v1.2.3 From b739f3f1afeeb7798a906f06d030392d2d3e33e2 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 26 Jul 2011 20:05:50 -0400 Subject: v3: sysenv, avoid creation of spurious directories in output tree * an image copy section removed (re-implement correctly later) --- data/doc/sisu/CHANGELOG_v3 | 3 +++ 1 file changed, 3 insertions(+) (limited to 'data/doc') diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index 6769a187..7bcc728f 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -20,6 +20,9 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.14.orig.tar.gz sisu_3.0.14-1.dsc sisu_3.0.14-1.debian.tar.gz + * sysenv, avoid creation of spurious directories in output tree + (an image copy section removed, re-implement correctly later) + * urls, --concordance %% 3.0.13.orig.tar.gz (2011-06-26:25/7) -- cgit v1.2.3 From 5eb77a9b2e3558ef1d7393b60d3acd2b8d97912b Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 26 Jul 2011 20:08:59 -0400 Subject: v3: param, cleanup setting of auto endotes --- data/doc/sisu/CHANGELOG_v3 | 2 ++ 1 file changed, 2 insertions(+) (limited to 'data/doc') diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index 7bcc728f..ff837c06 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -23,6 +23,8 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.14.orig.tar.gz * sysenv, avoid creation of spurious directories in output tree (an image copy section removed, re-implement correctly later) + * param, cleanup setting of auto endnotes + * urls, --concordance %% 3.0.13.orig.tar.gz (2011-06-26:25/7) -- cgit v1.2.3 From bdc8fb1810ad1295ebedca29926bc58481e1dd24 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 26 Jul 2011 20:10:12 -0400 Subject: v3: xmls (sax, dom, xhtml) use of tidy, correct output location --- data/doc/sisu/CHANGELOG_v3 | 2 ++ 1 file changed, 2 insertions(+) (limited to 'data/doc') diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index ff837c06..db069a13 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -25,6 +25,8 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.14.orig.tar.gz * param, cleanup setting of auto endnotes + * xmls (sax, dom, xhtml) use of xml tidy, correct output file location + * urls, --concordance %% 3.0.13.orig.tar.gz (2011-06-26:25/7) -- cgit v1.2.3 From 427c8b2969fef30a403a55adfc32b449d78d7fe9 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 26 Jul 2011 20:11:52 -0400 Subject: v3: texpdf, XeTeX language settings (setmainlanguage setotherlanguage) * get from directory or filename if header @make: :language: not set --- data/doc/sisu/CHANGELOG_v3 | 3 +++ 1 file changed, 3 insertions(+) (limited to 'data/doc') diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index db069a13..e873047e 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -25,6 +25,9 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.14.orig.tar.gz * param, cleanup setting of auto endnotes + * texpdf, XeTeX language settings ((setmainlanguage setotherlanguage) from + directory or filename) if @make: :language: header not set + * xmls (sax, dom, xhtml) use of xml tidy, correct output file location * urls, --concordance -- cgit v1.2.3 From a44bbf20b1f06c938ae0579a7771005995273c0c Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 26 Jul 2011 20:12:52 -0400 Subject: v3: epub, opf fixes --- data/doc/sisu/CHANGELOG_v3 | 2 ++ 1 file changed, 2 insertions(+) (limited to 'data/doc') diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index e873047e..00f62e6a 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -20,6 +20,8 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.14.orig.tar.gz sisu_3.0.14-1.dsc sisu_3.0.14-1.debian.tar.gz + * epub, opf fixes + * sysenv, avoid creation of spurious directories in output tree (an image copy section removed, re-implement correctly later) -- cgit v1.2.3 From f965e5904777542136ff525685193be307bbcfe8 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 26 Jul 2011 20:14:34 -0400 Subject: v3: qrcode, manifest, (++), QR code (metadata) images for manifest * generate images using qrencode --- data/doc/sisu/CHANGELOG_v3 | 3 +++ 1 file changed, 3 insertions(+) (limited to 'data/doc') diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index 00f62e6a..89c0bf6b 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -20,6 +20,9 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.14.orig.tar.gz sisu_3.0.14-1.dsc sisu_3.0.14-1.debian.tar.gz + * qrcode, sysenv, manifest, generate & add QR code images of metadata to + manifest (using qrencode) (consider where and how else to use images) + * epub, opf fixes * sysenv, avoid creation of spurious directories in output tree -- cgit v1.2.3 From 2e6af20c3742adb42c756568fda2c05f7abd6d03 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 26 Jul 2011 20:16:49 -0400 Subject: v3: param, manifest, qrcode, epub, added creator.editor field --- data/doc/sisu/CHANGELOG_v3 | 2 ++ 1 file changed, 2 insertions(+) (limited to 'data/doc') diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index 89c0bf6b..47270aaa 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -20,6 +20,8 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.14.orig.tar.gz sisu_3.0.14-1.dsc sisu_3.0.14-1.debian.tar.gz + * param, manifest, qrcode, epub, added creator.editor field + * qrcode, sysenv, manifest, generate & add QR code images of metadata to manifest (using qrencode) (consider where and how else to use images) -- cgit v1.2.3 From 399e6eaa0597b59b20135da362da894e09630e8b Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 26 Jul 2011 20:17:56 -0400 Subject: v3: sql db, constants, cgi-sql, structure changed, creator.editor field added --- data/doc/sisu/CHANGELOG_v3 | 2 ++ 1 file changed, 2 insertions(+) (limited to 'data/doc') diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index 47270aaa..a8a43efd 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -22,6 +22,8 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.14.orig.tar.gz * param, manifest, qrcode, epub, added creator.editor field + * sql db, constants, cgi-sql, structure changed, creator editor field added + * qrcode, sysenv, manifest, generate & add QR code images of metadata to manifest (using qrencode) (consider where and how else to use images) -- cgit v1.2.3 From c77953fb0518bf296bc88208c5cec9fabff3bb89 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 26 Jul 2011 20:20:22 -0400 Subject: v3: vim sisu syntax highlighting * markers for hanging indent added * added header for @creator: :editor: * minor comments added * deletion of an unused tag --- data/doc/sisu/CHANGELOG_v3 | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'data/doc') diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index a8a43efd..396be68f 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -24,6 +24,12 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.14.orig.tar.gz * sql db, constants, cgi-sql, structure changed, creator editor field added + * vim sisu syntax highlighting + * markers for hanging indent added + * added header for @creator: :editor: + * minor comments added + * deletion of an unused tag + * qrcode, sysenv, manifest, generate & add QR code images of metadata to manifest (using qrencode) (consider where and how else to use images) -- cgit v1.2.3 From afa76471f128da7a04a89b5ee4b88b846de74c47 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 26 Jul 2011 20:21:32 -0400 Subject: v3: emacs syntax highlighting sisu-mode.el * markers for hanging indent added * line-break --- data/doc/sisu/CHANGELOG_v3 | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'data/doc') diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index 396be68f..740611a8 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -30,6 +30,10 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.14.orig.tar.gz * minor comments added * deletion of an unused tag + * emacs sisu-mode.el + * markers for hanging indent added + * line-break + * qrcode, sysenv, manifest, generate & add QR code images of metadata to manifest (using qrencode) (consider where and how else to use images) -- cgit v1.2.3 From 5e292103d5da448844c7c5bc38b920874d895107 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 26 Jul 2011 20:22:49 -0400 Subject: v3: dal, indent, control of first line of indent & rest of paragraph * implements hanging indent, and possibility to set first line step indent * __[1-9] hanging indent (initial indent 0); paragraph text indent [1-9] * _[0-9]?_[1-9] initial indent; paragraph text indent * __[1-9]! bold words \\ part of hanging indent paragraph text --- data/doc/sisu/CHANGELOG_v3 | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) (limited to 'data/doc') diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index 740611a8..56e737bc 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -20,6 +20,26 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.14.orig.tar.gz sisu_3.0.14-1.dsc sisu_3.0.14-1.debian.tar.gz + * hanging indent partially implemented, added markup possibilities + + __[1-9] hanging indent (initial indent 0); paragraph text indent [1-9] + + _[0-9]?_[1-9] initial indent; paragraph text indent + + * done: dal; + not done: , plaintext, html, xhtml, xml sax, xml dom, epub, pdf, odf, + man, info + check: po4a, html_lite (used in sql search results) + * syntax highlighting done: vim (sisu.vim), emacs (sisu-mode.el) + + * indent added bold words markup syntax (_[1-9]!) (_[0-9]?_[1-9]!) + for indents + + __[1-9]! bold words + part of hanging indent paragraph text + + __[1-9]! bold words \\ part of hanging indent paragraph text + * param, manifest, qrcode, epub, added creator.editor field * sql db, constants, cgi-sql, structure changed, creator editor field added -- cgit v1.2.3 From 051b32167ddbff4193e7d52d8be434ef3f70470d Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 26 Jul 2011 20:24:41 -0400 Subject: v3: plaintext, indent ... --- data/doc/sisu/CHANGELOG_v3 | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) (limited to 'data/doc') diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index 56e737bc..7db34c34 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -26,9 +26,8 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.14.orig.tar.gz _[0-9]?_[1-9] initial indent; paragraph text indent - * done: dal; - not done: , plaintext, html, xhtml, xml sax, xml dom, epub, pdf, odf, - man, info + * done: dal, plaintext; + not done: html, xhtml, xml sax, xml dom, epub, pdf, odf, man, info check: po4a, html_lite (used in sql search results) * syntax highlighting done: vim (sisu.vim), emacs (sisu-mode.el) -- cgit v1.2.3 From 476ee850a8f11f49578281137620189304223de0 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 26 Jul 2011 20:25:25 -0400 Subject: v3: css, indent ... --- data/doc/sisu/CHANGELOG_v3 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'data/doc') diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index 7db34c34..3caf06c8 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -26,7 +26,7 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.14.orig.tar.gz _[0-9]?_[1-9] initial indent; paragraph text indent - * done: dal, plaintext; + * done: dal, plaintext, css; not done: html, xhtml, xml sax, xml dom, epub, pdf, odf, man, info check: po4a, html_lite (used in sql search results) * syntax highlighting done: vim (sisu.vim), emacs (sisu-mode.el) -- cgit v1.2.3 From 1abd2f99b807f9f33d1bd39c0a692e1455bf44f1 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 26 Jul 2011 20:26:52 -0400 Subject: v3: xhtml, xml sax & dom, indent (partially implemented) ... --- data/doc/sisu/CHANGELOG_v3 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'data/doc') diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index 3caf06c8..8d50ee88 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -26,8 +26,8 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.14.orig.tar.gz _[0-9]?_[1-9] initial indent; paragraph text indent - * done: dal, plaintext, css; - not done: html, xhtml, xml sax, xml dom, epub, pdf, odf, man, info + * done: dal, plaintext, css, xhtml, xml sax, xml dom; + not done: html, epub, pdf, odf, man, info check: po4a, html_lite (used in sql search results) * syntax highlighting done: vim (sisu.vim), emacs (sisu-mode.el) -- cgit v1.2.3 From 392f8d5cc7b48dfe27eb1c1034b04e899a54f7bf Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 26 Jul 2011 20:27:58 -0400 Subject: v3: html, indent ... --- data/doc/sisu/CHANGELOG_v3 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'data/doc') diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index 8d50ee88..29f166dd 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -26,8 +26,8 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.14.orig.tar.gz _[0-9]?_[1-9] initial indent; paragraph text indent - * done: dal, plaintext, css, xhtml, xml sax, xml dom; - not done: html, epub, pdf, odf, man, info + * done: dal, plaintext, css, html, xhtml, xml sax, xml dom; + not done: epub, pdf, odf, man, info check: po4a, html_lite (used in sql search results) * syntax highlighting done: vim (sisu.vim), emacs (sisu-mode.el) -- cgit v1.2.3 From 727db14c20acedb648b127976e6e0ed104d8515a Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 26 Jul 2011 20:28:55 -0400 Subject: v3: epub, indent ... --- data/doc/sisu/CHANGELOG_v3 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'data/doc') diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index 29f166dd..98a6380d 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -26,8 +26,8 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.14.orig.tar.gz _[0-9]?_[1-9] initial indent; paragraph text indent - * done: dal, plaintext, css, html, xhtml, xml sax, xml dom; - not done: epub, pdf, odf, man, info + * done: dal, plaintext, css, html, epub, xhtml, xml sax, xml dom; + not done: pdf, odf, man, info check: po4a, html_lite (used in sql search results) * syntax highlighting done: vim (sisu.vim), emacs (sisu-mode.el) -- cgit v1.2.3 From dba6d8b359e626a30d613685b0a686c29df4e98b Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 26 Jul 2011 20:30:47 -0400 Subject: v3: texpdf, indent ... --- data/doc/sisu/CHANGELOG_v3 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'data/doc') diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index 98a6380d..73d1062d 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -26,8 +26,8 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.14.orig.tar.gz _[0-9]?_[1-9] initial indent; paragraph text indent - * done: dal, plaintext, css, html, epub, xhtml, xml sax, xml dom; - not done: pdf, odf, man, info + * done: dal, plaintext, css, html, epub, xhtml, xml sax, xml dom, pdf; + not done: odf, man, info check: po4a, html_lite (used in sql search results) * syntax highlighting done: vim (sisu.vim), emacs (sisu-mode.el) -- cgit v1.2.3 From e3330f16f31ccc9cd62d5d1f15e76cec4e45485d Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 26 Jul 2011 20:32:10 -0400 Subject: v3: sql (pg, sqlite), indent ... --- data/doc/sisu/CHANGELOG_v3 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'data/doc') diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index 73d1062d..b10bf30d 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -26,7 +26,7 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.14.orig.tar.gz _[0-9]?_[1-9] initial indent; paragraph text indent - * done: dal, plaintext, css, html, epub, xhtml, xml sax, xml dom, pdf; + * done: dal, plaintext, css, html, epub, xhtml, xml sax, xml dom, pdf, sql; not done: odf, man, info check: po4a, html_lite (used in sql search results) * syntax highlighting done: vim (sisu.vim), emacs (sisu-mode.el) -- cgit v1.2.3 From bd65e8adf156439b93c01a89b2e6269817c883fb Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 26 Jul 2011 20:35:12 -0400 Subject: v2 v3: sisu_manual * sisu_commands: --qrcode -Q; update shortcut options; line-breaks use \\ * sisu_markup.sst: indent update; publisher --- data/doc/sisu/CHANGELOG_v3 | 4 + .../markup-samples/sisu_manual/sisu_commands.sst | 230 +++++++++++---------- .../markup-samples/sisu_manual/sisu_markup.sst | 29 ++- 3 files changed, 150 insertions(+), 113 deletions(-) (limited to 'data/doc') diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index b10bf30d..7234637e 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -43,6 +43,10 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.14.orig.tar.gz * sql db, constants, cgi-sql, structure changed, creator editor field added + * sisu_manual + * sisu_commands: --qrcode -Q; update shortcut options; line-breaks use \\ + * sisu_markup.sst: indent update; publisher + * vim sisu syntax highlighting * markers for hanging indent added * added header for @creator: :editor: diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst index a5f380a9..86ac41cf 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst @@ -1,4 +1,4 @@ -% SiSU 2.0 +% SiSU 3.0 @title: SiSU :subtitle: Commands @@ -57,276 +57,282 @@ SiSU is a document publishing system, that from a simple single marked-up docume 2~ Document Processing Command Flags -!_ -a [filename/wildcard]
+!_ -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) -!_ -b [filename/wildcard]
+!_ -b [filename/wildcard] \\ see --xhtml -!_ --color-toggle [filename/wildcard]
+!_ --color-toggle [filename/wildcard] \\ screen toggle ansi screen colour on or off depending on default set (unless -c flag is used: if sisurc colour default is set to 'true', output to screen will be with colour, if sisurc colour default is set to 'false' or is undefined screen output will be without colour). Alias -c -!_ --concordance [filename/wildcard]
+!_ --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 -!_ -C [--init-site]
+!_ -C [--init-site] \\ configure/initialise shared output directory files initialize shared output directory (config files such as css and dtd files are not updated if they already exist unless modifier is used). -C --init-site configure/initialise site more extensive than -C on its own, shared output directory files/force update, existing shared output config files such as css and dtd files are updated if this modifier is used. -!_ -CC
+!_ -CC \\ configure/initialise shared output directory files initialize shared output directory (config files such as css and dtd files are not updated if they already exist unless modifier is used). The equivalent of: -C --init-site configure/initialise site, more extensive than -C on its own, shared output directory files/force update, existing shared output config files such as css and dtd files are updated if -CC is used. -!_ -c [filename/wildcard]
+!_ -c [filename/wildcard] \\ see --color-toggle -!_ --dal [filename/wildcard/url]
+!_ --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 -!_ --delete [filename/wildcard]
+!_ --delete [filename/wildcard] \\ see --zap -!_ -D [instruction] [filename]
+!_ -D [instruction] [filename] \\ see --pg -!_ -d [--db-[database type (sqlite|pg)]] --[instruction] [filename]
+!_ -d [--db-[database type (sqlite|pg)]] --[instruction] [filename] \\ see --sqlite -!_ --epub [filename/wildcard]
+!_ --epub [filename/wildcard] \\ produces an epub document, [sisu version >=2 ] (filename.epub). Alias -e -!_ -e [filename/wildcard]
+!_ -e [filename/wildcard] \\ see --epub -!_ --find [optional string part of filename]
+!_ --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 -!_ -F [--webserv=webrick]
+!_ -F [--webserv=webrick] \\ see --sample-search-form -!_ -f [optional string part of filename]
+!_ -f [optional string part of filename] \\ see --find -!_ --git [filename/wildcard]
+!_ --git [filename/wildcard] \\ produces or updates markup source file structure in a git repo (experimental and subject to change). Alias -g -!_ --glob [optional string part of filename]
+!_ --glob [optional string part of filename] \\ see --find -!_ -G [optional string part of filename]
+!_ -G [optional string part of filename] \\ see --find -!_ -g [filename/wildcard]
+!_ -g [filename/wildcard] \\ see --git -!_ --harvest *.ss[tm]
+!_ --harvest *.ss[tm] \\ makes two lists of sisu output based on the sisu markup documents in a directory: list of author and authors works (year and titles), and; list by 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]
+!_ --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]
+!_ --html [filename/wildcard] \\ produces html output, segmented text with table of contents (toc.html and index.html) and the document in a single file (scroll.html). Alias -h -!_ -h [filename/wildcard]
+!_ -h [filename/wildcard] \\ see --html -!_ -I [filename/wildcard]
+!_ -I [filename/wildcard] \\ see --texinfo -!_ -i [filename/wildcard]
+!_ -i [filename/wildcard] \\ see --manpage -!_ --keep-processing-files [filename/wildcard/url]
+!_ --keep-processing-files [filename/wildcard/url] \\ see --maintenance -!_ -L
+!_ -L \\ prints license information. -!_ --machine [filename/wildcard/url]
+!_ --machine [filename/wildcard/url] \\ see --dal (document abstraction level/layer) -!_ --maintenance [filename/wildcard/url]
+!_ --maintenance [filename/wildcard/url] \\ maintenance mode, interim processing files are preserved and their locations indicated. (also see -V). Aliases -M and --keep-processing-files -!_ --manpage [filename/wildcard]
+!_ --manpage [filename/wildcard] \\ produces man page of file, not suitable for all outputs. Alias -i -!_ -M [filename/wildcard/url]
+!_ -M [filename/wildcard/url] \\ see --maintenance -!_ -m [filename/wildcard/url]
+!_ -m [filename/wildcard/url] \\ see --dal (document abstraction level/layer) -!_ --no-ocn
+!_ --no-ocn \\ [with --html --pdf or --epub] switches off object citation numbering. Produce output without identifying numbers in margins of html or LaTeX/pdf output. -!_ -N [filename/wildcard/url]
+!_ -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. -!_ -n [filename/wildcard/url]
+!_ -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. -!_ --odf [filename/wildcard/url]
+!_ --odf [filename/wildcard/url] \\ see --odt -!_ --odt [filename/wildcard/url]
+!_ --odt [filename/wildcard/url] \\ output basic document in opendocument file format (opendocument.odt). Alias -o -!_ -o [filename/wildcard/url]
+!_ -o [filename/wildcard/url] \\ see --odt -!_ --pdf [filename/wildcard]
+!_ --pdf [filename/wildcard] \\ produces LaTeX pdf (portrait.pdf & landscape.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). Alias -p -!_ --pg [instruction] [filename]
+!_ --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 -!_ --po [language_directory/filename language_directory]
+!_ --po [language_directory/filename language_directory] \\ see --po4a -!_ --po4a [language_directory/filename language_directory]
+!_ --po4a [language_directory/filename language_directory] \\ produces .pot and po files for the file in the languages specified by the language directory. SiSU markup is placed in subdirectories named with the language code, e.g. en/ fr/ es/. The sisu config file must set the output directory structure to multilingual. v3, experimental -!_ -P [language_directory/filename language_directory]
+!_ -P [language_directory/filename language_directory] \\ see --po4a -!_ -p [filename/wildcard]
+!_ -p [filename/wildcard] \\ see --pdf -!_ --quiet [filename/wildcard]
+!_ --qrcode [filename/wildcard] \\ +generate QR code image of metadata (used in manifest). v3 only. + +!_ --quiet [filename/wildcard] \\ quiet less output to screen. -!_ -q [filename/wildcard]
+!_ -Q [filename/wildcard] \\ +see --qrcode + +!_ -q [filename/wildcard] \\ see --quiet -!_ --rsync [filename/wildcard]
+!_ --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 -!_ -R [filename/wildcard]
+!_ -R [filename/wildcard] \\ see --rsync -!_ -r [filename/wildcard]
+!_ -r [filename/wildcard] \\ see --scp -!_ --sample-search-form [--webserv=webrick]
+!_ --sample-search-form [--webserv=webrick] \\ generate examples of (naive) cgi search form for sqlite and pgsql depends on your already having used sisu to populate an sqlite and/or pgsql database, (the sqlite version scans the output directories for existing sisu_sqlite databases, so it is first necessary to create them, before generating the search form) see -d -D and the database section below. If the optional parameter --webserv=webrick is passed, the cgi examples created will be set up to use the default port set for use by the webrick server, (otherwise the port is left blank and the system setting used, usually 80). The samples are dumped in the present work directory which must be writable, (with screen instructions given that they be copied to the cgi-bin directory). Alias -F -!_ --scp [filename/wildcard]
+!_ --scp [filename/wildcard] \\ copies sisu output files to remote host using scp. 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. Also see --rsync. Alias -r -!_ --sqlite --[instruction] [filename]
+!_ --sqlite --[instruction] [filename] \\ database type default set to sqlite, (for which --sqlite may be used instead) or to specify another database --db-[pgsql, sqlite] (however see -D) possible instructions include: --createdb; --create; --dropall; --import [filename]; --update [filename]; --remove [filename]; see database section below. Alias -d -!_ --sisupod
+!_ --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 -!_ --sisupod [filename/wildcard]
+!_ --sisupod [filename/wildcard] \\ produces a zipped file of the prepared document specified along with associated images, by default named sisupod.zip they may alternatively be named with the filename extension .ssp This provides a quick way of gathering the relevant parts of a sisu document which can then for example be emailed. A sisupod includes sisu markup source file, (along with associated documents if a master file, or available in multilingual versions), together with related images and skin. SiSU commands can be run directly against a sisupod contained in a local directory, or provided as a url on a remote site. As there is a security issue with skins provided by other users, they are not applied unless the flag --trust or --trusted is added to the command instruction, it is recommended that file that are not your own are treated as untrusted. The directory structure of the unzipped file is understood by sisu, and sisu commands can be run within it. Note: if you wish to send multiple files, it quickly becomes more space efficient to zip the sisu markup directory, rather than the individual files for sending). See the -S option without [filename/wildcard]. Alias -S -!_ --source [filename/wildcard]
+!_ --source [filename/wildcard] \\ copies sisu markup file to output directory. Alias -s -!_ -S
+!_ -S \\ see --sisupod -!_ -S [filename/wildcard]
+!_ -S [filename/wildcard] \\ see --sisupod -!_ -s [filename/wildcard]
+!_ -s [filename/wildcard] \\ see --source -!_ --texinfo [filename/wildcard]
+!_ --texinfo [filename/wildcard] \\ produces texinfo and info file, (view with pinfo). Alias -I -!_ --txt [filename/wildcard]
+!_ --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 -!_ -T [filename/wildcard (*.termsheet.rb)]
+!_ -T [filename/wildcard (*.termsheet.rb)] \\ standard form document builder, preprocessing feature -!_ -t [filename/wildcard]
+!_ -t [filename/wildcard] \\ see --txt -!_ --urls [filename/wildcard]
+!_ --urls [filename/wildcard] \\ prints url output list/map for the available processing flags options and resulting files that could be requested, (can be used to get a list of processing options in relation to a file, together with information on the output that would be produced), -u provides url output mapping for those flags requested for processing. The default assumes sisu_webrick is running and provides webrick url mappings where appropriate, but these can be switched to file system paths in sisurc.yml. Alias -U -!_ -U [filename/wildcard]
+!_ -U [filename/wildcard] \\ see --urls -!_ -u [filename/wildcard]
+!_ -u [filename/wildcard] \\ provides url mapping of output files for the flags requested for processing, also see -U -!_ --v2 [filename/wildcard]
+!_ --v2 [filename/wildcard] \\ invokes the sisu v2 document parser/generator. This is the default and is normally omitted. -!_ --v3 [filename/wildcard]
+!_ --v3 [filename/wildcard] \\ invokes the sisu v3 document parser/generator. Currently under development and incomplete, v3 requires >= ruby1.9.2p180. You may run sisu3 instead. -!_ --verbose [filename/wildcard]
+!_ --verbose [filename/wildcard] \\ 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 -!_ -V
+!_ -V \\ on its own, provides SiSU version and environment information (sisu --help env) -!_ -V [filename/wildcard]
+!_ -V [filename/wildcard] \\ even more verbose than the -v flag. -!_ -v
+!_ -v \\ on its own, provides SiSU version information -!_ -v [filename/wildcard]
+!_ -v [filename/wildcard] \\ see --verbose -!_ --webrick
+!_ --webrick \\ starts ruby's webrick webserver points at sisu output directories, the default port is set to 8081 and can be changed in the resource configuration files. [tip: the webrick server requires link suffixes, so html output should be created using the -h option rather than -H ; also, note -F webrick ]. Alias -W -!_ -W
+!_ -W \\ see --webrick -!_ --wordmap [filename/wildcard]
+!_ --wordmap [filename/wildcard] \\ see --concordance -!_ -w [filename/wildcard]
+!_ -w [filename/wildcard] \\ see --concordance -!_ --xhtml [filename/wildcard]
+!_ --xhtml [filename/wildcard] \\ produces xhtml/XML output for browser viewing (sax parsing). Alias -b -!_ --xml-dom [filename/wildcard]
+!_ --xml-dom [filename/wildcard] \\ produces XML output with deep document structure, in the nature of dom. Alias -X -!_ --xml-sax [filename/wildcard]
+!_ --xml-sax [filename/wildcard] \\ produces XML output shallow structure (sax parsing). Alias -x -!_ -X [filename/wildcard]
+!_ -X [filename/wildcard] \\ see --xml-dom -!_ -x [filename/wildcard]
+!_ -x [filename/wildcard] \\ see --xml-sax -!_ -Y [filename/wildcard]
+!_ -Y [filename/wildcard] \\ 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]
+!_ -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. -!_ --zap [filename/wildcard]
+!_ --zap [filename/wildcard] \\ Zap, if used with other processing flags deletes output files of the type about to be processed, prior to processing. If -Z is used as the lone processing related flag (or in conjunction with a combination of -[mMvVq]), will remove the related document output directory. Alias -Z -!_ -Z [filename/wildcard]
+!_ -Z [filename/wildcard] \\ see --zap 1~command_modifiers command line modifiers -!_ --no-ocn
+!_ --no-ocn \\ [with --html --pdf or --epub] switches off object citation numbering. Produce output without identifying numbers in margins of html or LaTeX/pdf output. -!_ --no-annotate
+!_ --no-annotate \\ strips output text of editor endnotes~[* square brackets ]~ denoted by asterisk or dagger/plus sign -!_ --no-asterisk
+!_ --no-asterisk \\ strips output text of editor endnotes~[* square brackets ]~ denoted by asterisk sign -!_ --no-dagger
+!_ --no-dagger \\ strips output text of editor endnotes~[+ square brackets ]~ denoted by dagger/plus sign 1~commands_database database commands @@ -335,50 +341,50 @@ dbi - database interface -D or --pgsql set for postgresql -d or --sqlite default set for sqlite -d is modifiable with --db=[database type (pgsql or sqlite)] -!_ --pg -v --createall
+!_ --pg -v --createall \\ initial step, creates required relations (tables, indexes) in existing postgresql database (a database should be created manually and given the same name as working directory, as requested) (rb.dbi) [ -dv --createall sqlite equivalent] it may be necessary to run sisu -Dv --createdb initially NOTE: at the present time for postgresql it may be necessary to manually create the database. The command would be 'createdb [database name]' where database name would be SiSU_[present working directory name (without path)]. Please use only alphanumerics and underscores. -!_ --pg -v --import
+!_ --pg -v --import \\ [filename/wildcard] imports data specified to postgresql db (rb.dbi) [ -dv --import sqlite equivalent] -!_ --pg -v --update
+!_ --pg -v --update \\ [filename/wildcard] updates/imports specified data to postgresql db (rb.dbi) [ -dv --update sqlite equivalent] -!_ --pg --remove
+!_ --pg --remove \\ [filename/wildcard] removes specified data to postgresql db (rb.dbi) [ -d --remove sqlite equivalent] -!_ --pg --dropall
+!_ --pg --dropall \\ kills data" and drops (postgresql or sqlite) db, tables & indexes [ -d --dropall sqlite equivalent] The -v is for verbose output. 1~command_shorcuts Shortcuts, Shorthand for multiple flags -!_ --update [filename/wildcard]
+!_ --update [filename/wildcard] \\ Checks existing file output and runs the flags required to update this output. This means that if only html and pdf output was requested on previous runs, only the -hp files will be applied, and only these will be generated this time, together with the summary. This can be very convenient, if you offer different outputs of different files, and just want to do the same again. -!_ -0 to -5 [filename or wildcard]
-Default shorthand mappings (note that the defaults can be changed/configured in the sisurc.yml file): +!_ -0 to -5 [filename or wildcard] \\ +Default shorthand mappings (for v3, note that the defaults can be changed/configured in the sisurc.yml file): -!_ -0
--mNhwpAobxXyYv [this is the default action run when no options are give, i.e. on 'sisu [filename]'] +!_ -0 \\ +-NQhewpotbxXyYv [this is the default action run when no options are give, i.e. on 'sisu [filename]'] -!_ -1
--mhewpy +!_ -1 \\ +-Qhewpoty -!_ -2
--mhewpaoy +!_ -2 \\ +-NQhewpotbxXy -!_ -3
--mhewpAobxXyY +!_ -3 \\ +-NQhewpotbxXyY -!_ -4
--mhewpAobxXDyY --import +!_ -4 \\ +-NQhewpotbxXDyY --update -!_ -5
--mhewpAobxXDyY --update +!_ -5 \\ +-NQhewpotbxXDyYv --update -add -v for verbose mode and -c for color, e.g. sisu -2vc [filename or wildcard] +add -v for verbose mode and -c to toggle color state, e.g. sisu -2vc [filename or wildcard] consider -u for appended url info or -v for verbose output diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst index a246d160..735f00ea 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst @@ -123,7 +123,10 @@ code{ @title: SiSU :subtitle: Manual -@creator: :author: Amissah, Ralph +@creator: + :author: Amissah, Ralph + +@publisher: [publisher name] @rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 @@ -440,6 +443,30 @@ _# numbered list numbered list indented a., b., c., d., etc. }code +2~ Hanging Indents + +!_ markup example: + +code{ + +_0_1 first line no indent, +rest of paragraph indented one step + +_1_0 first line indented, +rest of paragraph no indent + +in each case level may be 0-9 + +}code + +!_ resulting output: + +_0_1 first line no indent, rest of paragraph indented one step + +_1_0 first line indented, rest of paragraph no indent + +in each case level may be 0-9 + 2~ Footnotes / Endnotes Footnotes and endnotes are marked up at the location where they would be indicated within a text. They are automatically numbered. The output type determines whether footnotes or endnotes will be produced -- cgit v1.2.3 From 520128d4486320eca4efbc6cefb208004d2ec4f0 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 26 Jul 2011 20:36:23 -0400 Subject: v2 v3: manpage * commands: --qrcode -Q; update shortcut options * markup.sst: indent update; publisher --- data/doc/sisu/CHANGELOG_v3 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'data/doc') diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index 7234637e..a27a7070 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -43,7 +43,7 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.14.orig.tar.gz * sql db, constants, cgi-sql, structure changed, creator editor field added - * sisu_manual + * sisu_manual, manpage * sisu_commands: --qrcode -Q; update shortcut options; line-breaks use \\ * sisu_markup.sst: indent update; publisher -- cgit v1.2.3 From 3c0b56d9b72b3fbc1a482b1da1dcca23b5676a24 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 26 Jul 2011 20:37:49 -0400 Subject: v2 v3: manpage html (man2html) * commands: --qrcode -Q; update shortcut options * markup.sst: indent update; publisher --- data/doc/sisu/CHANGELOG_v3 | 2 +- data/doc/sisu/html/sisu.1.html | 515 +++++++++++++++++++++++------------------ 2 files changed, 290 insertions(+), 227 deletions(-) (limited to 'data/doc') diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index a27a7070..7978dc09 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -43,7 +43,7 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.14.orig.tar.gz * sql db, constants, cgi-sql, structure changed, creator editor field added - * sisu_manual, manpage + * sisu_manual, manpage, manpage html (man2html) * sisu_commands: --qrcode -Q; update shortcut options; line-breaks use \\ * sisu_markup.sst: indent update; publisher diff --git a/data/doc/sisu/html/sisu.1.html b/data/doc/sisu/html/sisu.1.html index fb74b10d..33529bfc 100644 --- a/data/doc/sisu/html/sisu.1.html +++ b/data/doc/sisu/html/sisu.1.html @@ -179,39 +179,39 @@ and the same document structure information. For more see: <9.4 Footnotes / Endnotes +

9.4 Hanging Indents

+ +


+markup example: +


+

  _0_1 first line no indent,
+  rest of paragraph indented one step
+  _1_0 first line indented,
+  rest of paragraph no indent
+  in each case level may be 0-9
+
+


+resulting output: +


+ first line no indent, rest of paragraph indented one step
+ +


+first line indented, rest of paragraph no indent +


+ +

in each case level may be 0-9 +

+

9.5 Footnotes / Endnotes


Footnotes and endnotes are marked up at the location where they would be @@ -1428,11 +1454,11 @@ normal text [^+2] continues

the standard and pair notation cannot be mixed in the same document

-

9.5 +

9.6 Links

-

9.5.1 Naked Urls Within Text, Dealing with Urls

+

9.6.1 Naked Urls Within Text, Dealing with Urls


urls found within text are marked up automatically. A url within text is @@ -1479,7 +1505,7 @@ where a code block is used there is neither decoration nor hyperlinking, deb-src http://www.jus.uio.no/sisu/archive unstable main non-free

-

9.5.2 Linking Text

+

9.6.2 Linking Text


@@ -1509,9 +1535,6 @@ aboutSiSU <http://www.sisudoc.org/


about SiSU <http://www.sisudoc.org/ > [^14] markup -

-

9.5.3 Linking Images

-


markup example:


@@ -1561,10 +1584,10 @@ note at a heading level the same is automatically achieved by providing names to headings 1, 2 and 3 i.e. 2~[name] and 3~[name] or in the case of auto-heading numbering, without further intervention.

-

9.6 Grouped Text

+

9.7 Grouped Text

-

9.6.1 +

9.7.1 Tables


@@ -1609,7 +1632,7 @@ Tables

No. of articles, all languages | 25| 19,000| 138,000| 490,000| 862,000|1,600,000 \* Contributed at least ten times; \** at least 5 times in last month; -\* more than 100 times in last month. +\*\** more than 100 times in last month.


resulting output: @@ -1622,7 +1645,7 @@ Tables * Contributed at least ten times; ** at least 5 times in last month; *** more than 100 times in last month.

-

9.6.2 Poem

+

9.7.2 Poem


basic markup: @@ -1774,7 +1797,7 @@ more than 100 times in last month.

-

9.6.3 Group

+

9.7.3 Group


basic markup: @@ -1930,7 +1953,7 @@ more than 100 times in last month.

-

9.6.4 Code

+

9.7.4 Code


Code tags code{ ... }code (used as with other group tags described above) @@ -2040,11 +2063,11 @@ opening code tag code{# as demonstrated here: 44 | death."’

-

9.7 Additional Breaks - Linebreaks Within Objects, Column and Page-breaks

+

9.8 Additional Breaks - Linebreaks Within Objects, Column and Page-breaks

-

9.7.1 Line-breaks

+

9.8.1 Line-breaks


To break a line within a "paragraph object", two backslashes \\ with a space @@ -2060,7 +2083,7 @@ The html break br enclosed in angle brackets (though undocumented) is available in versions prior to 3.0.13 and 2.9.7 (it remains available for the time being, but is depreciated).

-

9.7.2 Page Breaks

+

9.8.2 Page Breaks


Page breaks are only relevant and honored in some output formats. A page @@ -2081,7 +2104,7 @@ page new <:pn> breaks the page, starts a new page. page break <:pb> breaks a column, starts a new column, if using columns, else breaks the page, starts a new page.

-

9.8 Book Index

+

9.9 Book Index


To make an index append to paragraph the book index term relates to it, @@ -2337,9 +2360,9 @@ text follows levels 1,2,3 and it is ’nice’ to do most work in those


this is captured by the following file ’rename’ instruction:


-

  rename ’s/.s[123]$/.sst/’ *.s{1,2,3}
-  rename ’s/.r[123]$/.ssm/’ *.r{1,2,3}
-  rename ’s/.si$/.ssi/’ *.si
+
  rename ’s/\.s[123]$/\.sst/’ *.s{1,2,3}
+  rename ’s/\.r[123]$/\.ssm/’ *.r{1,2,3}
+  rename ’s/\.si$/\.ssi/’ *.si
 


The internal document markup remains unchanged, from SiSU 0.16 @@ -2398,7 +2421,7 @@ be located locally or on a remote server for which a url is provided.

12.1.1 Sisu Text - Regular Files (.sst)


-The most common form of document in SiSU , see the section on SiSU markup. +The most common form of document in SiSU, see the section on SiSU markup.


<http://www.sisudoc.org/sisu/sisu_markup @@ -2716,7 +2739,7 @@ list) may be found in:


CSS files to modify the appearance of SiSU html, XHTML or XML may be placed -in the configuration directory: ./_sisu/css ; ~/.sisu/css or; /etc/sisu/css +in the configuration directory: ./_sisu/css; ~/.sisu/css or; /etc/sisu/css and these will be copied to the output directories with the command sisu -CC.


@@ -2889,8 +2912,9 @@ streamed to four tables:


* another the substantive texts by individual "paragraph" (or object) -- along
- with structural information, each paragraph being identifiable by its
+-
+ along with structural information, each paragraph being identifiable +by its
paragraph number (if it has one which almost all of them do), and the
substantive text of each paragraph quite naturally being searchable (both in
@@ -2918,14 +2942,15 @@ so as to facilitate ease of searching.


Being able to search a relational database at an object level with the SiSU citation system is an effective way of locating content generated -by SiSU object numbers, and all versions of the document have the same -numbering, complex searches can be tailored to return just the locations -of the search results relevant for all available output formats, with live -links to the precise locations in the database or in html/xml documents; -or, the structural information provided makes it possible to search the -full contents of the database and have headings in which search content -appears, or to search only headings etc. (as the Dublin Core is incorporated -it is easy to make use of that as well). +by SiSU. As individual text objects of a document stored (and indexed) together +with object numbers, and all versions of the document have the same numbering, +complex searches can be tailored to return just the locations of the search +results relevant for all available output formats, with live links to the +precise locations in the database or in html/xml documents; or, the structural +information provided makes it possible to search the full contents of the +database and have headings in which search content appears, or to search +only headings etc. (as the Dublin Core is incorporated it is easy to make +use of that as well).

22. Postgresql


@@ -3050,7 +3075,8 @@ for SiSU to populate an sqlite database, this being part of SiSU - sisu -d [instruction] [filename/wildcard  if  required]


- sisu -d --(sqlite|pg) --[instruction] [filename/wildcard  if  required]
+ sisu -d --(sqlite|pg) --[instruction] [filename/wildcard  if
+ required]

23.4 Commands

@@ -3890,8 +3916,9 @@ the


NOTE:


-[  .B  SiSU  parses  files  with  long  lines  or  line  breaks,  display  linewrap - (without  line-breaks)  is  a  convenient +[  .B  SiSU  parses  files  with  long  lines  or  line  breaks, but,  display  linewrap + (without  line-breaks)  is  a  convenient editor  feature  to  have  for  sisu  markup] +

31. How Does Sisu Work?


@@ -3937,8 +3964,8 @@ beyond the Dublin core and easily further extended as required); the headers may also contain processing instructions. SiSU markup is primarily an abstraction of document structure and document metadata to permit taking advantage of the basic strengths of existing alternative practical standard ways -of representing documents [be  that  paper  publication,  sql  search  etc.] (html, -epub, xml, odf, latex, pdf, sql) +of representing documents [be  that  browser viewing,  paper  publication, + sql  search  etc.] (html, epub, xml, odf, latex, pdf, sql)


* for output produces reasonably elegant output of established industry and institutionally accepted open standard formats.[3] takes advantage of @@ -3969,8 +3996,7 @@ as


* sql - population of an sql database, (at the same object level that -is used
- to cite text within a document)
+is used to cite text within a document)


Also produces: concordance files; document content certificates (md5 or @@ -4029,7 +4055,7 @@ and images and sent as a zip file called a sisupod, if shared on the net * generated document outputs may automatically be posted to remote sites.


-* for basic document generation, the only software dependency is Ruby , +* for basic document generation, the only software dependency is Ruby, and a few standard Unix tools (this covers plaintext, HTML, EPUB, XML, ODF, LaTeX). To use a database you of course need that, and to convert the LaTeX generated to pdf, a latex processor like tetex or texlive. @@ -4191,108 +4217,143 @@ may be also be accessed via the html pages[^29] <http://www.jus.uio.no/sisu/man/sisu_webrick.1.html >
-

1. objects include: headings, paragraphs, verse, tables, images, but not +

+

    +.
  1. objects include: headings, paragraphs, verse, tables, images, but not footnotes/endnotes which are numbered separately and tied to the object from which they are referenced.


    -2. i.e. the html, pdf, epub, odf outputs are each built individually and optimised +

  2. .
  3. i.e. the html, pdf, epub, odf outputs are each built individually and optimised for that form of presentation, rather than for example the html being a saved version of the odf, or the pdf being a saved version of the html.


    -3. the different heading levels +

  4. .
  5. +

    the different heading levels


    -4. units of text, primarily paragraphs and headings, also any tables, poems, +

  6. .
  7. units of text, primarily paragraphs and headings, also any tables, poems,

    code-blocks


    -5. Specification submitted by Adobe to ISO to become a full open ISO specification +

  8. .
  9. +

    Specification submitted by Adobe to ISO to become a full open ISO specification + +


    <http://www.linux-watch.com/news/NS7542722606.html >


    -6. ISO standard ISO/IEC 26300:2006 +

  10. .
  11. +

    ISO standard ISO/IEC 26300:2006


    -7. An open standard format for e-books +

  12. .
  13. +

    An open standard format for e-books


    -*1. square brackets + + +

    *1.
    +
    square brackets


    -*2. square brackets +

    + +
    *2.
    +
    square brackets


    -+1. square brackets +

    + +
    +1.
    +
    square brackets


    -8. <http://www.jus.uio.no/sisu/man/ +

  14. .
  15. <http://www.jus.uio.no/sisu/man/ >


    -9. <http://www.jus.uio.no/sisu/man/sisu.1.html +

  16. .
  17. <http://www.jus.uio.no/sisu/man/sisu.1.html >


    -10. From sometime after SiSU 0.58 it should be possible to describe SiSU -markup using SiSU, which though not an original design goal is useful. -

    -
    -11. files should be prepared using UTF-8 character encoding +

  18. .
  19. From sometime after SiSU 0.58 it should be possible to describe SiSU markup +using SiSU, which though not an original design goal is useful.


    -12. a footnote or endnote +

  20. .
  21. +

    files should be prepared using UTF-8 character encoding


    -13. self contained endnote marker & endnote in one +

  22. .
  23. +

    a footnote or endnote


    -* unnumbered asterisk footnote/endnote, insert multiple asterisks if required +

  24. .
  25. self contained endnote marker & endnote in one +


    + + +

    *.
    +
    unnumbered asterisk footnote/endnote, insert multiple asterisks if required


    -** another unnumbered asterisk footnote/endnote +

    + +
    **.
    +
    another unnumbered asterisk footnote/endnote


    -*3. editors notes, numbered asterisk footnote/endnote series +

    + +
    *3.
    +
    editors notes, numbered asterisk footnote/endnote series


    -+2. editors notes, numbered asterisk footnote/endnote series +

    + +
    +2.
    +
    editors notes, numbered asterisk footnote/endnote series


    -14 <http://www.sisudoc.org/ +

  26. .
  27. <http://www.sisudoc.org/ >


    -15. <http://www.ruby-lang.org/en/ +

  28. .
  29. <http://www.ruby-lang.org/en/ >


    -16. Table from the Wealth of Networks by Yochai Benkler <http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler +

  30. .
  31. +

    Table from the Wealth of Networks by Yochai Benkler +


    +<http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler > -


    -17. .ssc (for composite) is under consideration but ._sst makes clear that -this is not a regular file to be worked on, and thus less likely that people -will have subsequent processing. It may be however that when the resulting -file is shared +

  32. .
  33. .ssc (for composite) is under consideration but ._sst makes clear that this +is not a regular file to be worked on, and thus less likely that people +will have "accidents", working on a .ssc file that is overwritten by subsequent +processing. It may be however that when the resulting file is shared .ssc +is an appropriate suffix to use. +


    +

  34. .
  35. <http://www.postgresql.org/ +>


    -19. <http://www.postgresql.org/ ->
    <http://advocacy.postgresql.org/ >
    <http://en.wikipedia.org/wiki/Postgresql >
    -20. <http://www.hwaci.com/sw/sqlite/ ->
    +

  36. .
  37. <http://www.hwaci.com/sw/sqlite/ +> +


    <http://en.wikipedia.org/wiki/Sqlite >
    -21. <http://search.sisudoc.org +

  38. .
  39. <http://search.sisudoc.org >


    -22. (which could be extended further with current back-end). As regards scaling +

  40. .
  41. (which could be extended further with current back-end). As regards scaling of the database, it is as scalable as the database (here Postgresql) and hardware allow.


    -23. of this feature when demonstrated to an IBM software innovations evaluator +

  42. .
  43. of this feature when demonstrated to an IBM software innovations evaluator in 2004 he said to paraphrase: this could be of interest to us. We have large document management systems, you can search hundreds of thousands of documents and we can tell you which documents meet your search criteria, but there is no way we can tell you without opening each document where within each your matches are found.


    -24. There is nothing to stop MySQL support being added in future. +

  44. .
  45. There is nothing to stop MySQL support being added in future.


    -25. <http://www.jus.uio.no/sisu/man/sisu.1.html +

  46. .
  47. <http://www.jus.uio.no/sisu/man/sisu.1.html >


    -26. <http://www.jus.uio.no/sisu/man/sisu.8.html +

  48. .
  49. <http://www.jus.uio.no/sisu/man/sisu.8.html >


    -27. <http://www.jus.uio.no/sisu/man +

  50. .
  51. <http://www.jus.uio.no/sisu/man >


    28. the Debian Free Software guidelines require that everything distributed @@ -4301,7 +4362,9 @@ while freely distributable are not freely changeable.


    29. named index.html or more extensively through sisu_manifest.html
    -

    +

  52. +
+

See Also


sisu(1) @@ -4366,20 +4429,20 @@ More information about SiSU can be found at <9.1 Heading Levels
  • 9.2 Font Attributes
  • 9.3 Indentation and Bullets
  • -
  • 9.4 Footnotes / Endnotes
  • -
  • 9.5 Links
  • -
  • 9.5.1 Naked Urls Within Text, Dealing with Urls
  • -
  • 9.5.2 Linking Text
  • -
  • 9.5.3 Linking Images
  • -
  • 9.6 Grouped Text
  • -
  • 9.6.1 Tables
  • -
  • 9.6.2 Poem
  • -
  • 9.6.3 Group
  • -
  • 9.6.4 Code
  • -
  • 9.7 Additional Breaks - Linebreaks Within Objects, Column and Page-breaks
  • -
  • 9.7.1 Line-breaks
  • -
  • 9.7.2 Page Breaks
  • -
  • 9.8 Book Index
  • +
  • 9.4 Hanging Indents
  • +
  • 9.5 Footnotes / Endnotes
  • +
  • 9.6 Links
  • +
  • 9.6.1 Naked Urls Within Text, Dealing with Urls
  • +
  • 9.6.2 Linking Text
  • +
  • 9.7 Grouped Text
  • +
  • 9.7.1 Tables
  • +
  • 9.7.2 Poem
  • +
  • 9.7.3 Group
  • +
  • 9.7.4 Code
  • +
  • 9.8 Additional Breaks - Linebreaks Within Objects, Column and Page-breaks
  • +
  • 9.8.1 Line-breaks
  • +
  • 9.8.2 Page Breaks
  • +
  • 9.9 Book Index
  • 10. Composite Documents Markup
  • Markup Syntax History
  • 11. Notes Related to Files-types and Markup Syntax
  • -- cgit v1.2.3