From 659b10c6bff6fdd7e643671ead17c43c3de4d52d Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Fri, 3 Oct 2014 19:10:54 -0400 Subject: v5 v6: version & changelog --- data/doc/sisu/CHANGELOG_v5 | 7 +++++++ data/doc/sisu/CHANGELOG_v6 | 7 +++++++ data/sisu/v5/v/version.yml | 6 +++--- data/sisu/v6/v/version.yml | 6 +++--- setup/sisu_version.rb | 4 ++-- 5 files changed, 22 insertions(+), 8 deletions(-) diff --git a/data/doc/sisu/CHANGELOG_v5 b/data/doc/sisu/CHANGELOG_v5 index eed72ecb..6f237b9f 100644 --- a/data/doc/sisu/CHANGELOG_v5 +++ b/data/doc/sisu/CHANGELOG_v5 @@ -31,6 +31,13 @@ v2 branch is removed; it is available in sisu =< 3.3.2 %% Reverse Chronological: +%% 5.6.9.orig.tar.xz (2014-10-03:39/5) +http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/sisu_5.6.9 +http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/debian/sisu_5.6.9-1 +http://www.jus.uio.no/sisu/pkg/src/sisu_5.6.9.orig.tar.xz + sisu_5.6.9.orig.tar.xz + sisu_5.6.9-1.dsc + %% 5.6.8.orig.tar.xz (2014-09-28:38/7) http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/sisu_5.6.8 http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/debian/sisu_5.6.8-1 diff --git a/data/doc/sisu/CHANGELOG_v6 b/data/doc/sisu/CHANGELOG_v6 index 7350e085..043d7726 100644 --- a/data/doc/sisu/CHANGELOG_v6 +++ b/data/doc/sisu/CHANGELOG_v6 @@ -21,6 +21,13 @@ v2 branch is removed; it is available in sisu =< 3.3.2 %% Reverse Chronological: +%% 6.2.10.orig.tar.xz (2014-10-03:39/5) +http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/sisu_6.2.10 +http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/debian/sisu_6.2.10-1 +http://www.jus.uio.no/sisu/pkg/src/sisu_6.2.10.orig.tar.xz + sisu_6.2.10.orig.tar.xz + sisu_6.2.10-1.dsc + %% 6.2.9.orig.tar.xz (2014-09-28:38/7) http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/sisu_6.2.9 http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/debian/sisu_6.2.9-1 diff --git a/data/sisu/v5/v/version.yml b/data/sisu/v5/v/version.yml index 9b5e1349..94574c44 100644 --- a/data/sisu/v5/v/version.yml +++ b/data/sisu/v5/v/version.yml @@ -1,5 +1,5 @@ --- :project: SiSU -:version: 5.6.8 -:date_stamp: 2014w38/7 -:date: "2014-09-28" +:version: 5.6.9 +:date_stamp: 2014w39/5 +:date: "2014-10-03" diff --git a/data/sisu/v6/v/version.yml b/data/sisu/v6/v/version.yml index 1b5eae1b..eed6e5cf 100644 --- a/data/sisu/v6/v/version.yml +++ b/data/sisu/v6/v/version.yml @@ -1,5 +1,5 @@ --- :project: SiSU -:version: 6.2.9 -:date_stamp: 2014w38/7 -:date: "2014-09-28" +:version: 6.2.10 +:date_stamp: 2014w39/5 +:date: "2014-10-03" diff --git a/setup/sisu_version.rb b/setup/sisu_version.rb index 40072dea..557233cb 100644 --- a/setup/sisu_version.rb +++ b/setup/sisu_version.rb @@ -1,7 +1,7 @@ #% constants module SiSUversion - SiSU_version_next_stable = '5.6.8' #% set version stable current - SiSU_version_next_unstable = '6.2.9' #% set version unstable dev + SiSU_version_next_stable = '5.6.9' #% set version stable current + SiSU_version_next_unstable = '6.2.10' #% set version unstable dev #% qi quick install file SiSU_version_generic_next_stable = '5.4.x' SiSU_version_generic_next_unstable = '6.0.x' -- cgit v1.2.3 From 3883915a5fddac4aa6114f80cb2ef6634a4bfe6b Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Fri, 3 Oct 2014 19:13:06 -0400 Subject: sisu.org move stuff done to sisu-done.org --- data/doc/sisu/sisu-done.org | 1987 +++++++++++++++++++++++++++++++++++++++++++ data/doc/sisu/sisu.org | 839 ------------------ 2 files changed, 1987 insertions(+), 839 deletions(-) create mode 100644 data/doc/sisu/sisu-done.org diff --git a/data/doc/sisu/sisu-done.org b/data/doc/sisu/sisu-done.org new file mode 100644 index 00000000..f39fcee1 --- /dev/null +++ b/data/doc/sisu/sisu-done.org @@ -0,0 +1,1987 @@ +#+PRIORITIES: A F E +(emacs:evil mode gifts a "vim" of "alternative" powers! ;) + +* General +** Finding +*** source + +http://git.sisudoc.org/gitweb/ + +sisu git repo: +http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=summary + +sisu-markup-samples git repo: +http://git.sisudoc.org/gitweb/?p=doc/sisu-markup-samples.git;a=summary + +*** mailing list +sisu at lists.sisudoc.org + +http://lists.sisudoc.org/listinfo/sisu + +** irc oftc sisu + +** home pages + * + * + * + +** Installing sisu + +*** where you take responsibility for having the correct dependencies + +Provided you have *Ruby*, *SiSU* can be run. + +SiSU should be run from the directory containing your sisu marked up document +set. + +This works fine so long as you already have sisu external dependencies in +place. For many operations such as html, epub, odt this is likely to be fine. +Note however, that additional external package dependencies, such as texlive +(for pdfs), sqlite3 or postgresql (for search) should you desire to use them +are not taken care of for you. + +**** run off the source tarball without installation + +RUN OFF SOURCE PACKAGE DIRECTORY TREE (WITHOUT INSTALLING) +.......................................................... + +***** 1. Obtain the latest sisu source + +using git: + +http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=summary +http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=log + + git clone git://git.sisudoc.org/git/code/sisu.git + +or, identify latest available source: + +https://packages.debian.org/sid/sisu +http://packages.qa.debian.org/s/sisu.html +http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org + +http://sisudoc.org/sisu/archive/pool/main/s/sisu/ + +and download the: + + sisu_5.4.5.orig.tar.xz + +using debian tool dget: + +The dget tool is included within the devscripts package +https://packages.debian.org/search?keywords=devscripts +to install dget install devscripts: + + apt-get install devscripts + +and then you can get it from Debian: + dget -xu http://ftp.fi.debian.org/debian/pool/main/s/sisu/sisu_5.4.5-1.dsc + +or off sisu repos + dget -x http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu_5.4.5-1.dsc +or + dget -x http://sisudoc.org/sisu/archive/pool/main/s/sisu/sisu_5.4.5-1.dsc + +***** 2. Unpack the source + +Provided you have *Ruby*, *SiSU* can be run without installation straight from +the source package directory tree. + +Run ruby against the full path to bin/sisu (in the unzipped source package +directory tree). SiSU should be run from the directory containing your sisu +marked up document set. + + ruby ~/sisu-5.4.5/bin/sisu --html -v document_name.sst + +This works fine so long as you already have sisu external dependencies in +place. For many operations such as html, epub, odt this is likely to be fine. +Note however, that additional external package dependencies, such as texlive +(for pdfs), sqlite3 or postgresql (for search) should you desire to use them +are not taken care of for you. + +**** gem install (with rake) + +(i) create the gemspec; (ii) build the gem (from the gemspec); (iii) install +the gem + +Provided you have ruby & rake, this can be done with the single command: + + rake gem_create_build_install + +to build and install sisu v5 & sisu v6, alias gemcbi + +separate gems are made/installed for sisu v5 & sisu v6 contained in source. + +to build and install sisu v5, alias gem5cbi: + + rake gem_create_build_install_stable + +to build and install sisu v6, alias gem6cbi: + + rake gem_create_build_install_unstable + +for individual steps (create, build, install) see rake options, rake -T to +specify sisu version for sisu installed via gem + + gem search sisu + + sisu _5.4.5_ --version + + sisu _6.0.11_ --version + +to uninstall sisu installed via gem + + sudo gem uninstall --verbose sisu + +For a list of alternative actions you may type: + + rake help + + rake -T + +Rake: + +**** installation with setup.rb + +this is a three step process, in the root directory of the unpacked *SiSU* as +root type: + +ruby setup.rb config +ruby setup.rb setup +#[as root:] +ruby setup.rb install + +further information: + + + + ruby setup.rb config && ruby setup.rb setup && sudo ruby setup.rb install + +*** Debian install + +*SiSU* is available off the *Debian* archives. It should necessary only to run +as root, Using apt-get: + + apt-get update + + apt get install sisu-complete + +(all sisu dependencies should be taken care of) + +If there are newer versions of *SiSU* upstream, they will be available by +adding the following to your sources list /etc/apt/sources.list + +#/etc/apt/sources.list + +deb http://www.jus.uio.no/sisu/archive unstable main non-free +deb-src http://www.jus.uio.no/sisu/archive unstable main non-free + +The non-free section is for sisu markup samples provided, which contain +authored works the substantive text of which cannot be changed, and which as a +result do not meet the debian free software guidelines. + +*SiSU* is developed on *Debian*, and packages are available for *Debian* that +take care of the dependencies encountered on installation. + +The package is divided into the following components: + + *sisu*, the base code, (the main package on which the others depend), without + any dependencies other than ruby (and for convenience the ruby webrick web + server), this generates a number of types of output on its own, other + packages provide additional functionality, and have their dependencies + + *sisu-complete*, a dummy package that installs the whole of greater sisu as + described below, apart from sisu -examples + + *sisu-pdf*, dependencies used by sisu to produce pdf from /LaTeX/ generated + + *sisu-postgresql*, dependencies used by sisu to populate postgresql database + (further configuration is necessary) + + *sisu-sqlite*, dependencies used by sisu to populate sqlite database + + *sisu-markup-samples*, sisu markup samples and other miscellany (under + *Debian* Free Software Guidelines non-free) + + *SiSU* is available off Debian Unstable and Testing [link: + ] + [^1] install it using apt-get, aptitude or alternative *Debian* install tools. + +* Markup :sisu:markup: + +** sisu + +#% structure - headings, levels + * headings (A-D, 1-3) + * inline + 'A~ ' NOTE title level + 'B~ ' NOTE optional + 'C~ ' NOTE optional + 'D~ ' NOTE optional + '1~ ' NOTE chapter level + '2~ ' NOTE optional + '3~ ' NOTE optional + '4~ ' NOTE optional :consider: + * node + * parent + * children + +#% font face NOTE open & close marks, inline within paragraph + * emphasize '*{ ... }*' NOTE configure whether bold italics or underscore, default bold + * bold '!{ ... }!' + * italics '/{ ... }/' + * underscore '_{ ... }_' + * superscript '^{ ... }^' + * subscript ',{ ... },' + * strike '-{ ... }-' + * add '+{ ... }+' + * monospace '#{ ... }#' +#% para NOTE paragraph controls are at the start of a paragraph + * a para is a block of text separated from others by an empty line + * indent + * default, all '_1 ' up to '_9 ' + * first line hang '_1_0 ' + * first line indent further '_0_1 ' + * bullet + [levels 1-6] + '_* ' + '_1* ' + '_2* ' + * numbered list + [levels 1-3] + '# ' + +#% blocks NOTE text blocks that are not to be treated in the way that ordinary paragraphs would be + * code + * [type of markup if any] + * poem + * group + * alt + * tables +#% boxes + NOTE grouped text with code block type color & possibly default image, warning, tip, red, blue etc. decide [NB N/A not implemented] + +#% notes NOTE inline within paragraph at the location where the note reference is to occur + * footnotes '~{ ... }~' + * [bibliography] [NB N/A not implemented] + +#% links, linking + * links - external, web, url + * links - internal + +#% images [multimedia?] + * images + * [base64 inline] [N/A not implemented] + +#% object numbers + * ocn (object numbers) + automatically attributed to substantive objects, paragraphs, tables, blocks, verse (unless exclude marker provided) + +#% contents + * toc (table of contents) + autogenerated from structure/headings information + * index (book index) + built from hints in newline text following a paragraph and starting with ={} has identifying rules for main and subsidiary text + +#% breaks + * line break ' \\ ' inline + * page break, column break ' -\\- ' start of line, breaks a column, starts a new column, if using columns, else breaks the page, starts a new page. + * page break, page new ' =\\= ' start of line, breaks the page, starts a new page. + * horizontal '-..-' start of line, rule page (break) line across page (dividing paragraphs) + +#% book type index + +#% comment + * comment + +#% misc + * term & definition + +** proposals/additions + +*** TODO [#B] markup syntax code block, indicate syntax of code :feature: + ``` code:ruby + +*** TODO [#C] colored boxes round text :feature:ponder: + ``` box:red (select color of box) + ``` box:warn ``` box:tip (some default boxes? decide) + ``` box:red:"Warn" (select color and lead text of box, else instead + select color box & use regular single line bold markup ^!_ Warn$) + +*** TODO [#D] blockquotes implement? :feature:ponder: + ``` quote + not sure how best to represent + +*** TODO [#D] bibliography :feature:ponder: + +*** TODO speaker, as e.g. play (irc?) :feature:ponder: + ``` Ophelia: + ::Ophelia + +*** TODO [#F] time stamp (e.g. for irc, video text?):feature:ponder: + ``` 04:03 + ``` 04:03 ... 07:12 + ``` 04:03 + 03:09 + ``` 12:04:03 + ``` 12:04:03 ... 12:07:12 + ``` 12:04:03 + 03:09 + probably not worth the effort, as time stamp is an alternative + identifying number (to ocn, and ∴ sisu objects not ideal) + +*** TODO book index, alternative based on search within text + +** syntax hilighting + +*** vim +data/sisu/conf/editor-syntax-etc/vim/ +data/sisu/conf/editor-syntax-etc/vim/syntax/sisu.vim + +*** emacs +data/sisu/conf/editor-syntax-etc/emacs/ +data/sisu/conf/editor-syntax-etc/emacs/sisu-mode.el + +* Document Abstraction :sisu:doc_abstr: + +** TODO [#D] XML middle layer? + +*** XMLda sisu + consder alternative sisu layer in XML + +*** TODO [#D] RelaxNG sisu + +* Output :sisu:output: +** New outputs to consider + +*** XML :xml: +%% xml, docbook.txt fictionbook.txt xldl.txt lml.txt tei.txt emacs.txt + + + + + + +xml editor vim emacs + +nXML plugin + + + + + +emacs.txt evil.txt + + + + +To validate a book.xml file using xmllint, run the following command: +$ xmllint --postvalid --xinclude --noout book.xml + +The default location where xmllint will look for the catalog file is +/etc/xml/catalog. Alternatively, you can set the environment variable +XML_CATALOG_FILES to define another default location for catalog +files. Once you’ve got the DTD and catalog set up locally, you can +validate as before: +$ xmllint --postvalid --xinclude --noout book.xml + +%% Docbook +docbook.txt + +%% Fictionbook +fictionbook.txt + +%% XLDL +xldl.txt + +%% Literature Markup Language +lml.txt + +%% Text Encoding Initiative +tei.txt + +**** TODO [#B] docbook :feature: + +***** urls +#% docbook book xml.txt + + + + + + + + + + + + + + + + + + + +***** rb file +lib/sisu/v6/xml_docbook5.rb + +***** transformations :transform:markup_docbook: +#% structure - headings, levels + [] sisu (A-C, 1-3) + [] collapsed (1-6) (decoration) + [] node (child, parent ...) + +#% font face + [] bold + [] italics + [] underscore + [] superscript + [] subscript + [] strike + [] add + +#% para + [] default + [] indent + [] default, all + [] first line hang or indent further + [] bullet + +#% blocks + + [] code + [] [type of markup if any] + [] poem + [] group + [] alt + [] tables + +#% notes + [] footnotes + [] [bibliography?] + +#% links, linking + [] links - external, web, url + [] links - internal + +#% images [multimedia?] + [] images + [] [base 64] + +#% object numbers + [] ocn (object numbers) + +#% contents + [] toc (table of contents) + + [] index (book index) + +#% misc + +**** TODO [#D] fictionbook :feature: + +***** urls +#% fictionbook xml.txt + + + + + + + + + + +***** rb file +lib/sisu/v6/xml_fictionbook2.rb + +***** transformations :transformations:markup_fictionbok: #% +#% structure - headings, levels + [] sisu (A-C, 1-3) + [] collapsed (1-6) (decoration) + [] node (child, parent ...) + +#% font face + [] bold + [] italics + [] underscore + [] superscript + [] subscript + [] strike + [] add + [] monospace + +#% para + [] default + [] indent + [] default, all + [] first line hang or indent further + [] bullet + +#% blocks + [] code + [] [type of markup if any] + [] poem + [] group + [] alt + [] tables + +#% notes + [] footnotes + [] [bibliography?] + +#% links, linking + [] links - external, web, url + [] links - internal + +#% images [multimedia?] + [] images + [] [base 64] + +#% object numbers + [] ocn (object numbers) + +#% contents + [] toc (table of contents) + [] index (book index) + +#% breaks + [] line break + [] horizontal rule + [] column break + [] page break + +#% comment + [] comment + +#% misc + + + + + + + + + + + + +**** TODO [#D] XLDL :feature: + +***** urls +%% xml.txt xldl - novels, stories, poems +Name: XLDL - an XML doctype for novels, stories, poems, playsName: XLDL - an XML doctype for novels, stories, poems, plays + + + + +**** TODO [#E] Literature Markup Language - :feature: + +***** urls +%% Literature Markup Language - + +"It is assumed, that there are three quite different techniques to provide text, +respectively three types of text, this is prose and poetry and code (for +example source code of computer programs or from markup languages)." +Suggestions and Ideas for Literature Markup Language - 1.1 + + +**** TODO [#E] TEI Lite (Text Encoding Initiative) :feature: + +***** urls +%% TEI Lite (Text Encoding Initiative) + + + +*** Text :txt: + +sisu_markup.txt asciidoc.txt markdown.txt textile.txt rst.txt + +**** TODO [#D] asciidoc :feature: + +***** urls +#% asciidoc + + + + + +cheatsheets + + + + + + + + + + +***** rb file +lib/sisu/v6/txt_asaciidoc.rb + +***** transformations :transformations:markup_asciidoc: #% +#% structure - headings, levels + [] sisu (A-C, 1-3) + [] collapsed (1-4) (decoration) + [] inline + '== ' + '=== ' + '==== ' + '===== ' + '' + '' + [] underscore + '-' + '~' + '^' + '+' + '' ['.' proposed] + '' ['.' proposed] + [] node (child, parent ...) + +#% font face + [open & close marks] + [] bold + '*' + [] italics + '_' + [] underscore + '' + [] superscript + '^' + [] subscript + '~' + [] strike + '-' + [] add + [] monospace + '+' + '`' pass markup through unchanged, monospace code + +#% para + [] default + [] indent + [] default, all + [] first line hang or indent further + [] bullet + [levels 1-6] + '*' + '**' + '***' + '****' + '*****' + '*******' + [] numbered list + [levels 1-3] + '. ' number + '.. ' lower alpha + '... ' lower roman + '.... ' upper alpha + '..... ' upper roman + +#% blocks + [] code + [source,perl] + ---- + code here + ---- + [] [type of markup if any] + [] poem + [] group + ---- + grouped text here, actually a listing block + ---- + [] alt + [] tables + +#% notes + [] footnotes + [] [bibliography?] + +#% links, linking + [] links - external, web, url + http://google.com[Google Search] + [] links - internal + +#% images [multimedia?] + [] images + [] [base 64] + +#% object numbers + [] ocn (object numbers) + +#% contents + [] toc (table of contents) + [] index (book index) + +#% breaks + [] line break + "+\n" + forced + + line break + [] horizontal rule + [] column break + [] page break + +#% comment + [] comment + // + +#% misc + + [] term & definition +Term 1:: Definition 1 +Term 2:: Definition 2 +[horizontal] + Term 2.1;; + Definition 2.1 + Term 2.2;; + Definition 2.2 + +**** TODO [#E] markdown :feature: + +***** urls +#% markdown + + + + + + + +Markdown supports two styles of headers, Setext and atx +Setext + + +atx + + + + + + + + + + + + + + +#% pandoc markdown + + + + + + + +#% multimarkdown + + +#% markdown pandoc v multimarkdown + + +#% rST v markdown + + +***** rb file +lib/sisu/v6/txt_markdown.rb + +***** transformations :transformations:markup_markdown: #% +#% structure - headings, levels + [] sisu (A-C, 1-3) + [] collapsed (1-6) (decoration) + [inline 1-5] + '#' + '##' + '###' + '####' + '#####' + '######' + [underscore 1-5] + '=' + '-' + #'~' + #'^' + #'+' + [] node (child, parent ...) + +#% font face + [open & close marks] + [] bold + '**' + [] italics + '*' + [] underscore + '' + [] superscript + '' + [] subscript + '' + [] strike + '' + [] add + [] monospace + '`' + +#% para + [] default + [] indent + [] default, all + [] first line hang or indent further + [] bullet + '*' + [] numbered list + '0.' + +#% blocks + [] code + ' ' #indent at least 4 spaces + [] [type of markup if any] + [] poem + [] group + [] alt + [] tables + +#% notes + [] footnotes + [] [bibliography?] + +#% links, linking + [] links - external, web, url + [] links - internal + +#% images [multimedia?] + [] images + [] [base 64] + +#% object numbers + [] ocn (object numbers) + +#% contents + [] toc (table of contents) + [] index (book index) + +#% breaks + [] line break + [] horizontal rule + (three or more asterisks hypens or underscores) + * * * + *** + ***** + - - - + ___ + [] column break + [] page break + +#% misc + +**** TODO [#F] rst :feature: + +***** urls +#% rST + + + + + + + + +#% rST v markdown + + +***** rb file +lib/sisu/v6/txt_rst.rb + +***** transformations :transformations:markup_rst: #% +#% structure - headings, levels + [] sisu (A-C, 1-3) + [] collapsed (1-6) (decoration) + [inline] + N/A + [underscore] + Titles are underlined (or over- and underlined) with a printing + nonalphanumeric 7-bit ASCII character. Recommended choices are + "= - ` : ' " ~ ^ _ * + # < >". The underline/overline must be at + least as long as the title text. + '=' + '-' + '`' + ':' + "'" + '"' + + [] node (child, parent ...) + +#% font face + [] bold + '**' + [] italics + '*' + [] underscore + '+' + [] superscript + '^' + [] subscript + [] strike + '-' + [] add + [] monospace + '``' + +#% para + [] default + [] indent + [] default, all + [] first line hang or indent further + [] bullet + "-", "*" or "+" + '-' + [] numbered list + '#.' + +#% blocks + [] code + [] [type of markup if any] + [] poem + [] group + [] alt + [] tables + +#% notes + [] footnotes + [binary] + Footnote references, like [5]_. + Note that footnotes may get + rearranged, e.g., to the bottom of + the "page". + .. [5] A numerical footnote. + -- + Autonumbered footnotes are + possible, like using [#]_ and [#]_. + .. [#] This is the first one. + .. [#] This is the second one. + + [] [bibliography?] + +#% links, linking + [] links - external, web, url + Typical result + External hyperlinks, like Python_. + .. _Python: + or + External hyperlinks, like `Python + `_. + [] links - internal + Internal crossreferences, like example_. + .. _example: + + This is an example crossreference target. + -- + Titles are targets, too + ======================= + Implict references, like `Titles are + targets, too`_. + +#% images [multimedia?] + [] images + [] [base 64] + +#% object numbers + [] ocn (object numbers) + +#% contents + [] toc (table of contents) + [] index (book index) + +#% breaks + [] line break + [] horizontal rule + [] column break + [] page break + +#% misc + +**** TODO [#F] textile :feature: + +***** urls +#% textile + +v2.4 + +v2 + + +***** rb file +lib/sisu/v6/txt_textile.rb + +***** transformations :transformations:markup_textile: #% +#% structure - headings, levels + [] sisu (A-C, 1-3) + [] collapsed (1-6) (decoration) + [inline] + h1(#id). An HTML first-level heading + h2. An HTML second-level heading + h3. An HTML third-level heading + h4. An HTML fourth-level heading + h5. An HTML fifth-level heading + h6. An HTML sixth-level heading + [underscore] + N/A + + [] node (child, parent ...) + +#% font face + [] bold + *bold text* + [] italics + _italic text_ + [] underscore + +underlined text+ + [] superscript + ^TM^ + [] subscript + ~subscript~ + [] strike + -strikethrough text- + [] add + +#% para + [] default + [] indent + [] default, all + [] first line hang or indent further + [] bullet + * bulleted list + ** 2-level + +#% blocks + [] code + [] [type of markup if any] + [] poem + [] group + [] alt + [] tables + |Table | with two columns | + |and two | rows | + +#% notes + [] footnotes + Text with a link to some reference[1] + fn1. Footnote explanation + [] [bibliography?] + +#% links, linking + [] links - external, web, url + "(classname)link text(title tooltip)":link_address + "Link to Wikipedia":http://www.wikipedia.org + [] links - internal + +#% images [multimedia?] + [] images + !http://commons.wikimedia.org/wiki/Special:Filepath/Wikipedia-logo-en.png! + !imageurl(alt text)! + [] [base 64] + +#% object numbers + [] ocn (object numbers) + +#% contents + [] toc (table of contents) + [] index (book index) + +#% breaks + [] line break + [] horizontal rule + [] column break + [] page break + +#% misc + [] *_bold italic text_* + [] *-bold strikethrough text-* + [] *_-bold italic strikethrough text-_* + [] *+bold underlined text+* + [] *_+italic underlined text+_ + [] *_+bold italic underlined text+_ + [] *_-+bold italic strikethrough underlined text+-_* + %{font-size:18pt}font size% + %{color:red}text in red% + # Chapter 1 + +#% notes +heading inline only +footnotes uses marker and endnote, check + +** Improvements + +*** HTML + +*** XML + +*** --strict mode (html w3c compliant ocn etc.) + +* Code (ruby) :sisu:code: + +** code enhancements :enhance: + +*** TODO [#D] directory & path, use ruby directory tools + +*** TODO [#D] document url shortcut, allow addition of alternative dir stub +(e.g. viral Spiral) + +** code refactoring :refactor: + +*** ruby 2.1 + +**** DONE make sure sisu works + +** bugs :bug: + +*** misc, unclassified + +**** DONE (6.0.5) [#B] sisu should give warning when part of minimal essential structure is missing :processing:fix: + +work through testing for as many of these as possible + +minimal content/structure requirement: +[metadata] + @title: + @creator: +[levels] + A~ (level A [title]) + 1~ (at least one level 1 [segment/(chapter)]) +test what happens in the absence of each + +structure rules (document heirarchy, heading levels): + + there are two sets of heading levels ABCD (title & parts if any) and 123 (segment & subsegments if any) + sisu has the fllowing levels: + + A~ [title] . required (== 1) followed by B~ or 1~ + B~ [part] * followed by C~ or 1~ + C~ [subpart] * followed by D~ or 1~ + D~ [subsubpart] * followed by 1~ + 1~ [segment (chapter)] + required (>= 1) followed by text or 2~ + text * followed by more text or 1~, 2~ or relevant part *(B~ if none other used; if C~ is last used: C~ or B~; if D~ is used: D~, C~ or B~) + 2~ [subsegment] * followed by text or 3~ + text * followed by more text or 1~, 2~ or 3~ or relevant part, see *() + 3~ [subsubsegment] * followed by text + text * followed by more text or 1~, 2~ or 3~ or relevant part, see *() + + * level A~ is the tile and is mandatory + * there can only be one level A~ + * heading levels BCD, are optional and there may be several of each + (where all three are used corresponding to e.g. Book Part Section) + * sublevels that are used must follow each other sequentially (alphabetically), + * heading levels A~ B~ C~ D~ are followed by other heading levels rather than substantive text + which may be the subsequent sequential (alphabetic) heading part level + or a heading (segment) level 1~ + * there must be at least one heading (segment) level 1~ + (the level on which the text is segmented, in a book would correspond to the Chapter level) + * additional heading levels 1~ 2~ 3~ are optional and there may be several of each + * heading levels 1~ 2~ 3~ are followed by text (which may be followed by the same heading level) + and/or the next lower numeric heading level (followed by text) + or indeed return to the relevant part level + (as a corollary to the rules above substantive text/ content + must be preceded by a level 1~ (2~ or 3~) heading) + +there must be a title, level A +creator field absent: crash, no warnings given +title missing: +level A missing: +no level 1: + +***** NOTES/COMMENTS + +revisit, + * check logic, add to if possible + * tidy, inelegant solution + +**** DONE (5.3.5::6.0.5) [#B] victory chals discussed parsing problem caused by use of open-close markers around url + + +*** DBT Outstanding bugs -- sisu caught by removal of ruby-dbi + +**** DONE (pending acceptance) [#B] sisu 5.3.4-1 marked for autoremoval from debian testing on 2014-06-10, for depending on ruby-dbi + +sisu 5.3.4-1 is marked for autoremoval from testing on 2014-06-10 +It (build-)depends on packages with these RC bugs: +746081: ruby-dbi: FTBFS: ERROR: Test "ruby2.1" failed: wrong number +of arguments (3 for 1..2) + +The current status of use of ruby-dbi in sisu. + +from: +http://lists.sisudoc.org/pipermail/sisu/2014-May/000818.html + +***** sisu + SiSU does not depend on an sql database to be useful and most users do + not use the database (population and resulting search) possibilities. + +***** DONE [#B] sisu-sqlite + 5.3.4 uses ruby-sqlite3 directly. There has been a + dependency within debian/control on ruby-dbi for sisu-sqlite, this can + safely be removed, without affecting its operation. + (it is used rather by the sample sqlite3 search form) + + >Solution Proposed: remove debian/control dependency on ruby-dbi + + Solution Implemented: + * sisu-sqlite uses 'sqlite3' ruby-sqlite3 (any superflous dbi loading dropped) + * code tests passed (create tables, populate db etc. work fine) + (closes) + +***** DONE [#B] sisu-postgresql + sisu-postgresql 5.3.4 uses ruby-pg through ruby-dbi. + + >Solution Proposed: + >* attempt now to fix by migrating to use ruby-pg directly + > * remove dependency on ruby-dbi in debian/control + > * rewrite code within sisu to work directly with ruby-pg + + Solution Implemented: + * sisu-postgresql uses 'pg' ruby-pg (ruby-dbi dropped) + * code tests passed (create tables, populate db etc. work fine) + (closes) + +***** DONE [#B] sample cgi search forms + there is a sample cgi search form facility within sisu that uses + ruby-dbi to query sqlite3 or pg databases. + + >Solution Proposed: + >* file a wishlist bug against sisu. No action needed immediately + > (other perhaps than to remove references to ruby-dbi). This offering + > in sisu would be classified as "wishlist" as these are samples only + > and need not be provided at all as populating the database (at an + > object level) in this case is the challenge (so you could say these + > documents meet your search criteria at these locations within them + > (relevant to almost all output formats html, epub, pdf etc.) (and + > may be looked up in these languages if they are available)) and is + > independent from search, once you have an sql database you can query + > it as you wish. (the cgi sample forms will be provided again + > eventually using ruby-sqlite3 and ruby-pg directly). + + Solution Implemented: + * sample cgi search froms (cgi database query forms) fixed :) + * pg sample uses 'pg' (dbi dropped) + generate sample form using: sisu --sample-search-form --db-pg + * sqlite sample uses 'sqlite3' (dbi dropped) + generate sample form using: sisu --sample-search-form --db-sqlite + (closes) + +***** NOTES/COMMENTS + +debian/control, remove dependency on ruby-dbi, contained in sisu-postgresql and sisu-sqlite + +Current status + * sisu-sqlite ok, uses 'sqlite3' (superflous dbi loading dropped) + * sisu-postgresql ok, uses 'pg' (dbi dropped) + * sample cgi search froms (cgi database query forms) ok :) + * pg sample uses 'pg' (dbi dropped) + * sqlite sample uses 'sqlite3' (dbi dropped) + +*** DBT Outstanding bugs -- Normal bugs; Unclassified (2 bugs) :debian:dbt:normal: + + +**** DONE (5.3.5::6.0.5) [#B] #744360 [n|u] sisu: includes do not work properly :processing:fix: + + +From: Daniel Baumann +To: Debian Bug Tracking System +Subject: includes do not work properly +Date: Sun, 13 Apr 2014 12:38:59 +0200 +Package: sisu +Version: 5.3.4-1 +Severity: wishlist + +using this in foo.ssm: + + :A~ foo + + :B~ bar + + << bar/baz.ssi + +and this in baz.ssi: + + 1~ foo bar baz + +then everything works. + +using the more natural foo.ssm: + + :A~ foo + + << bar/baz.ssi + +and baz.ssi: + + :B~ bar + + 1~ foo bar baz + +makes ':B~ bar' being ignored in the output (pdf) entirely. + +Regards, +Daniel + +***** NOTES/COMMENTS + +it appears both give faulty text, though in different ways + +fixed + +**** DONE (5.3.5::6.0.5) [#B] #744378 [n|u] sisu: --no-manifest not working anymore :check: + + +From: Daniel Baumann +To: Debian Bug Tracking System +Subject: --no-manifest not working anymore +Date: Sun, 13 Apr 2014 16:12:13 +0200 +Package: sisu +Version: 5.3.4-1 +Severity: wishlist + +when running sisu-pdf with --no-manifest, the output (pdf) still +contains the sisu manifest at the end of the document. + +Regards, +Daniel + +***** NOTES/COMMENTS + +fix, metadata page in pdf should not contain link to manifest where --no-manifest flag is used + + +**** DONE (5.3.5::6.0.5) [#D] #744353 [w|u] sisu output: please do not use typewriter for urls :output:consider: + + +From: Daniel Baumann +To: Debian Bug Tracking System +Subject: please do not use typewriter for urls +Date: Sun, 13 Apr 2014 12:28:27 +0200 +Package: sisu +Version: 5.3.4-1 +Severity: wishlist + +when using urls in sisu like this: + + http://example.org + +sisu then creates in the output (pdf) links like this: + + + +where as '' is written in typewriter font +(monospace). please don't do that automagically since it's desturbing +the visual flow when reading. If the users wants that, he should be able +to configure it. + +Regards, +Daniel + +***** NOTES/COMMENTS + +monospace for url outputs in pdf + +this is default behavior of the latex url package (it uses tt typewriter font) +it is possible to modify the font to sf class or tm/rm class, & I now default to sf +this means when the sisu default sf is used there will be no difference in typeface, +but when times roman or other is used, urls will be in sf instead of that font, +(instead of the latex default typewriter) + +it provides a visual cue even when output is monochrome, without color +(and is in some way related to #744391 sisu output: no color on a4 portrait) +however, it is worth noting here that urls are printed in a smaller font so as +to fit more on a line of text + +**** DONE (5.3.5::6.0.5) [#C] #744355 [w|u] vim syntaxhighlighting: includes and directories :syntaxhi:fix: + + +From: Daniel Baumann +To: Debian Bug Tracking System +Subject: vim syntaxhighlighting: includes and directories +Date: Sun, 13 Apr 2014 12:28:46 +0200 +Package: sisu +Version: 5.3.4-1 +Severity: wishlist + +When using includes like this: + + << foo.ssi + +then vim correctly displays the line in blue. + +However, when using includes in a subdirectory like this: + + << bar/foo.ssi + +then vim doesn't use any colors at all. + +Regards, +Daniel + +***** NOTES/COMMENTS + +done + +**** DONE PASS [#C] #744356 [w|u] vim syntaxhighlighting: urls and tags :discuss:close: + + +From: Daniel Baumann +To: Debian Bug Tracking System +Subject: vim syntaxhighlighting: urls and tags +Date: Sun, 13 Apr 2014 12:28:56 +0200 +Package: sisu +Version: 5.3.4-1 +Severity: wishlist + +When using an URL at the end of a sentence like this: + + Foo bar baz http://example.org. + +then vim properly highlights the url in blue. + +this also works properly when a second sentence after it, like: + + Foo bar baz http://example.org. Foo bar baz http://example.org. + +it works with html tag as well, like this: + + Foo bar baz http://example.org.
Foo bar baz http://example.org. + +but it doesn't work if there's no space: + + Foo bar baz http://example.org.
Foo bar baz http://example.org. + +then, the string 'http://www.gnu.org/licenses/.<' is shown red. + +Regards, +Daniel + +***** NOTES/COMMENTS + +this is meant to be flagged as an error, +(red indicates error, and is an error will not parse correctly) +even if the sisu parser works in the flagged case there is no promise that it will in future + +use of angle bracket markers (html markers) in sisu markup is depreciated. +for line-break use \\ instead, +for which there should be surrounding spaces or a preceding space and end of line; +if
is still used there should be a space after the url - which sisu should remove in output. + +would like to close without further action +re-open if necessary + +**** DONE (6.0.5) [#C] #744357 [w|u] sisu output: please create mailto links automatically + + +From: Daniel Baumann +To: Debian Bug Tracking System +Subject: please create mailto links automatically +Date: Sun, 13 Apr 2014 12:29:12 +0200 +Package: sisu +Version: 5.3.4-1 +Severity: wishlist + +When using urls like: + + http://example.org + +in sisu, the output (pdf) contains a hyperlink to http://example.org +automatically, which is nice. + +please also create mailto links when using email adresses like: + + john.doe@example.org + +Regards, +Daniel + +***** NOTES/COMMENTS + +for pdf fix/implement mailto links +done but requires further testing & possibly refinement + +**** DONE (5.3.5::6.0.5) [#C] #744358 [w|u] sisu output: please do not add ';' after \:copyright: :output:fix: + + +From: Daniel Baumann +To: Debian Bug Tracking System +Subject: please do not add ';' after :copyright: +Date: Sun, 13 Apr 2014 12:29:20 +0200 +Package: sisu +Version: 5.3.4-1 +Severity: wishlist + +When using: + + :copyright: foo bar baz. + +sisu generates the following in the output format (pdf): + + foo bar baz.; + +Please do not automagically add a semicolon (;). If the user wants a +semicolon, he would add one. + +Regards, +Daniel + +***** NOTES/COMMENTS + +fix copyright, remove trailing semi-colon + +**** DONE (5.3.5::6.0.5) [#B] #744379 [w|u] sisu: missing includes doesn't give an error :processing:fix: + + +From: Daniel Baumann +To: Debian Bug Tracking System +Subject: missing includes doesn't give an error +Date: Sun, 13 Apr 2014 16:14:46 +0200 +Package: sisu +Version: 5.3.4-1 +Severity: wishlist + +When using includes (*.ssi) in a sisu master document (*.ssm) like: + + << foo.ssi + +and that to be included file foo.ssi (for whatever reason) doesn't +exist, sisu doesn't error out but include '<< foo.ssi' literally as a +string in the output (pdf). + +Regards, +Daniel + +***** NOTES/COMMENTS + +5.3.4-1 writes the following to the screen: +"ERROR test.ssm.sst requires invalid or non-existent file: foo.ssi" + +and unsatisfactorily within the text output it writes no error message but the include instruction: + +"<< foo.ssi" + +5.3.5, the current "fix"/ solution, is to add an error message within the text rather than to stop processing with an error. +In addition to (i) slightly modified (you could say corrected) to the following: + +"ERROR test.ssm requires an invalid or non-existent file: foo.ssi" + +the following is written within the text output: + +"<< foo.ssi [ERROR test.ssm requires an invalid or non-existent file: foo.ssi]" + +**** DONE (5.3.5::6.0.5) [#D] #744381 [w|u] sisu syntax: inconsistency \:copyright: and \:license: :metadata: + + +From: Daniel Baumann +To: Debian Bug Tracking System +Subject: inconsistency between :copyright: and :license: +Date: Sun, 13 Apr 2014 16:26:55 +0200 +Package: sisu +Version: 5.3.4-1 +Severity: wishlist + +when using ':copyright: foo', then the output contains 'foo'. + +when using ':license: foo', then the output contains 'License: foo'. + +this is inconsistent. either both should have a 'prefix' in the output, +or neither should have one (i'd prefere the latter). + +Regards, +Daniel + +***** NOTES/COMMENTS + +Under rights there are a series of sub-categories starting with copyright, that +need to be distinguished. Until now started distinguishing after after +Copyright. For consistency have add the prefix 'Copyright' to the output. +Preference to omit noted, but this solution is consistent with options +provided. Bug closed, re-open if necessary. + +**** DONE (6.0.5) [#B] #744383 [w|u] sisu syntax: :B and :C result in the same formatting :output:fix: (partial solution) + + +From: Daniel Baumann +To: Debian Bug Tracking System +Subject: sisu syntax: :B and :C result in the same formatting +Date: Sun, 13 Apr 2014 16:32:07 +0200 +Package: sisu +Version: 5.3.4-1 +Severity: wishlist + +when using :A, :B, and :C in sisu, in the output (pdf) both :B and :C +are formatted identically. + +imho :C should be 'smaller' than :B. + +or, as an analogy with html: i would expect that :A equals

, :B +equals

, and :C equals

. currently, (in that analogy), :B and :C +both equal

. + +Regards, +Daniel + +***** NOTES/COMMENTS + +this is in part an artifact of LaTeX not having as many document heading levels +and trying to take advantage of the behavior of existing levels rather than +customizing further + +look for a solution, possibly overriding the default font sizes for each + +The current settings were chosen because, there are not enough levels and I +find too many different font sizes disconcerting, especially running sisu over +a wide variety of document types + +the following levels are available in LaTeX + +\part +\chapter +\section +\subsection +\subsubsection + +the levels in sisu are + +A [title] +B [part] +C [subpart] +D [subsubpart] +1 [segment (chapter)] +2 [subsegment] +3 [subsubsegment] + +sisu current mapping: + +level A [title] +level B C D \part (it is up to the user to make part levels visually distinguishable e.g. Book Part Section) +[skipped \chapter] +[skipped \section] +level 1 \subsection +level 2 \subsubsection +level 3 \subsubsection + +the reason for skipping section was the default configuration and resulting +fact that it made for a table of contents that takes more space + +sisu new mapping: + +level A [title] +level B C D \part (it is up to the user to make part levels visually distinguishable e.g. Book Part Section) +[skipped \chapter] +level 1 \section +level 2 \subsection +level 3 \subsubsection + +levels B C & D are the same size, + it is up to the user to make part levels visually distinguishable + e.g. Book Part Section +levels 1 2 & 3 are now distinguished + +(Closes #744386) sisu syntax: 1~ and 2~ result in the same formatting +(under consideration & yet to be done #744383) sisu syntax: :B and :C result in the same formatting +(touches ) +override part font size settings for different levels (B C D) + +**** DONE CLOSED [#C] #744384 [w|u] sisu syntax: relies on empty lines + + +From: Daniel Baumann +To: Debian Bug Tracking System +Subject: sisu syntax: relies on empty lines +Date: Sun, 13 Apr 2014 16:34:46 +0200 +Package: sisu +Version: 5.3.4-1 +Severity: wishlist + +the following snipped: + + :C~ foo bar + << foo-bar.ssi + +means that the include is ignored entirely. apparently sisu relies on +having an empty line in between like this: + + :C~ foo bar + + << foo-bar.ssi + +Regards, +Daniel + +***** NOTES/COMMENTS + +consider, + +(i) as a general observation, sisu relies on emptly lines to identify separate objects + such as headings, paragraphs (and indeed insertions) + +(ii) a heading need not be on a single line (so << would be part of that heading) +this means sisu should be able to work identifying headings in wrapped texts +(e.g. where the text is wrapped at 80 and the heading is longer than that) + +there has been no rule to the contrary (i.e. that headings should be on a single text line) + +consider, should there be such a rule? + +**** DONE (5.3.5::6.0.5) [#B] #744386 [w|u] sisu syntax: 1~ and 2~ result in the same formatting :output:pdf:fix: (see #744383) + + +From: Daniel Baumann +To: Debian Bug Tracking System +Subject: sisu syntax: 1~ and 2~ result in the same formatting +Date: Sun, 13 Apr 2014 16:43:51 +0200 +Package: sisu +Version: 5.3.4-1 +Severity: wishlist + +similar as with #744383, the same also applies for 1~ and 2~ - they +should be different in the output format (pdf here). + +Regards, +Daniel + +***** NOTES/COMMENTS + +1~ 2~ 3~ are now differentiated + +deal with under #744383 + +**** DONE (5.3.5::6.0.5) [#C] #744391 [w|u] sisu output: no color on a4 portrait :output:pdf:contemplate: + + +From: Daniel Baumann +To: Debian Bug Tracking System +Subject: sisu output: please use (blue) color for links +Date: Sun, 13 Apr 2014 17:23:37 +0200 +Package: sisu +Version: 5.3.4-1 +Severity: wishlist +Tags: upstream + +it would be nice if links (urls and emails) would be colored blue to +mark them visually as links. this behaviour is somewhat the lowest +common denominator in browsers (if you use html without any css that is). + +Regards, +Daniel + +From: Daniel Baumann +To: 744391@bugs.debian.org +Subject: Re: sisu output: please use (blue) color for links +Date: Sun, 13 Apr 2014 17:35:33 +0200 +retitle 744391 sisu output: no color on a4 portrait +thanks + +now this is strange.. turns out that (yes, i have colors enabled in +sisurc) the portrait a4 pdf has no colors at all, while the landscape a4 +pdf does indeed have colors (red for toc, blue for links). + +Regards, +Daniel + +***** NOTES/COMMENTS + +background: +portrait was provided for print/paper copy and is great for that in monochrome +(without grays for colored links), +landscape better matching a screen for visual presentations, color affecting the landscape only + +solution: +make configurable by cli & rc file +make both (portrait & landscape colors) configurable +either as hyperlinks monochrome or colored +overriding existing default which remains as described + +document +cli: +--pdf-hyperlinks-no-color or --pdf-hyperlinks-mono +--pdf-hyperlinks-color + +rc: + +default: + pdf_hyperlinks: *[possible values] + pdf_hyperlinks_portrait: *[possible values] + pdf_hyperlinks_landscape: *[possible values] + + * 'color' or ('mono' or 'no-color' or 'color-off') + + +**** DONE (5.3.5::6.0.5) [#B] #744399 [w|u] sisu syntax: :A smaller formatted than :B :output:fix: (see #744383) (partial solution) + + +From: Daniel Baumann +To: Debian Bug Tracking System +Subject: sisu syntax: :A smaller formatted than :B +Date: Sun, 13 Apr 2014 17:49:26 +0200 +Package: sisu +Version: 5.3.4-1 +Severity: wishlist +Tags: upstream + +in a document like this: + +:A~ foo + +:B~ bar + +the :A~ 'title' is formated 'smaller' (not bold, smaller font size) than +the :B~ 'title' on the first page of the actual document (means, first +page after TOC). + +Regards, +Daniel + +***** NOTES/COMMENTS + +for pdf + +now is same size see #744383 + +\part (level A B C D) +\chapter (skipped) +\section (level 1) +\subsection (level 2) +\subsubsection (level 3) + +**** DONE (5.3.5::6.0.5) [#C] #744402 [w|u] sisu: support sha512 :implement: + + +From: Daniel Baumann +To: Debian Bug Tracking System +Subject: sisu: support sha512 +Date: Sun, 13 Apr 2014 18:06:56 +0200 +Package: sisu +Version: 5.3.4-1 +Severity: wishlist +Tags: upstream + +sisu uses sha256 when using sha as digest, please support sha512. + +it would be even nicer if you could specify the actual digest like +'sha512', 'sha256', etc. rather than just 'sha'. + +Regards, +Daniel + +***** NOTES/COMMENTS + +implemented +document command line option --sha512 + +**** DONE (5.3.5::6.0.5) [#C] #744405 [w|u] sisu: set default font size :configuration:pdf:implement: + + +From: Daniel Baumann +To: Debian Bug Tracking System +Subject: sisu: set default font size +Date: Sun, 13 Apr 2014 18:29:46 +0200 +Package: sisu +Version: 5.3.4-1 +Severity: wishlist +Tags: upstream + +in sisurc, one can set the default fonts. it would be nice to be also +able to set the default font size. + +Regards, +Daniel + +***** NOTES/COMMENTS + +for pdf make configurable + +yaml.rc + +default: + texpdf_fontsize: 12 + +command-line + +--pdf-fontsize-12 +--pdf-fontsize-8 +etc. + + +**** DONE (5.5.0::6.1.0) [#C] #744408 [w|u] sisu: support more than one level of includes/nested includes + + +From: Daniel Baumann +To: Debian Bug Tracking System +Subject: sisu: support more than one level of includes/nested includes +Date: Sun, 13 Apr 2014 18:39:23 +0200 +Package: sisu +Version: 5.3.4-1 +Severity: wishlist +Tags: upstream + +currently, it's possible to use only one ssm file which itself includes +one or more ssi files. + +it would be nice if the ssm could include an 'intermediate' ssi, which +then includes further ssi files. this is very handy for larger documents. + +Regards, +Daniel + +***** NOTES/COMMENTS + +consider, +I have to date deliberately tried to keep it easy to follow documents & not have too much depth ... +The idea of recursive includes is un-attractive (messy for a document) + +.ssm currently can contain/include .sst or .ssi +.sst files can be processed independently, +.ssi files are only insertions & are not processed independently but as part of an ssm + +change proposed +.ssm unchanged +.sst unchanged +.ssi as before, but can include .sst or .ssi, so: + files are only insertions & are not processed independently but as part of an .ssm or another .ssi + i.e. as before with the addition that it like a .ssm can contain/include .sst or .ssi + +this is pretty much as requested by wishlist 744408 + +allowing .ssi to also include other .ssi or .sst could lead to recursive .ssi + +stopping after an additional level of includes seems arbitrary, and possibly prone to error if you are dealing with many documents + +**** DONE (6.0.5) [#C] #744541 [w|u] sisu: urls in @creator broken + + +From: Daniel Baumann +To: Debian Bug Tracking System +Subject: sisu: urls in @creator broken +Date: Sun, 13 Apr 2014 18:45:35 +0200 +Package: sisu +Version: 5.3.4-1 +Severity: wishlist +Tags: upstream + +first, if you have an url within @creator, like: + + @creator: foo bar http://example.org + +the generation fails (pdf output). + +as a workaround, i put the url into parenthesis, like: + + @creator: foo bar (http://example.org) + +but then, it would be nice if that url would be automatically +transformed into a link in the output format (pdf). + +Regards, +Daniel + +***** NOTES/COMMENTS + +pdf, fix diff --git a/data/doc/sisu/sisu.org b/data/doc/sisu/sisu.org index d5e0ec52..a5f8dbdc 100644 --- a/data/doc/sisu/sisu.org +++ b/data/doc/sisu/sisu.org @@ -1137,74 +1137,12 @@ footnotes uses marker and endnote, check *** ruby 2.1 -**** DONE make sure sisu works - *** TODO [#C] refactor ruby :ongoing: ** bugs :bug: *** misc, unclassified -**** DONE (6.0.5) [#B] sisu should give warning when part of minimal essential structure is missing :processing:fix: - -work through testing for as many of these as possible - -minimal content/structure requirement: -[metadata] - @title: - @creator: -[levels] - A~ (level A [title]) - 1~ (at least one level 1 [segment/(chapter)]) -test what happens in the absence of each - -structure rules (document heirarchy, heading levels): - - there are two sets of heading levels ABCD (title & parts if any) and 123 (segment & subsegments if any) - sisu has the fllowing levels: - - A~ [title] . required (== 1) followed by B~ or 1~ - B~ [part] * followed by C~ or 1~ - C~ [subpart] * followed by D~ or 1~ - D~ [subsubpart] * followed by 1~ - 1~ [segment (chapter)] + required (>= 1) followed by text or 2~ - text * followed by more text or 1~, 2~ or relevant part *(B~ if none other used; if C~ is last used: C~ or B~; if D~ is used: D~, C~ or B~) - 2~ [subsegment] * followed by text or 3~ - text * followed by more text or 1~, 2~ or 3~ or relevant part, see *() - 3~ [subsubsegment] * followed by text - text * followed by more text or 1~, 2~ or 3~ or relevant part, see *() - - * level A~ is the tile and is mandatory - * there can only be one level A~ - * heading levels BCD, are optional and there may be several of each - (where all three are used corresponding to e.g. Book Part Section) - * sublevels that are used must follow each other sequentially (alphabetically), - * heading levels A~ B~ C~ D~ are followed by other heading levels rather than substantive text - which may be the subsequent sequential (alphabetic) heading part level - or a heading (segment) level 1~ - * there must be at least one heading (segment) level 1~ - (the level on which the text is segmented, in a book would correspond to the Chapter level) - * additional heading levels 1~ 2~ 3~ are optional and there may be several of each - * heading levels 1~ 2~ 3~ are followed by text (which may be followed by the same heading level) - and/or the next lower numeric heading level (followed by text) - or indeed return to the relevant part level - (as a corollary to the rules above substantive text/ content - must be preceded by a level 1~ (2~ or 3~) heading) - -there must be a title, level A -creator field absent: crash, no warnings given -title missing: -level A missing: -no level 1: - -***** NOTES/COMMENTS - -revisit, - * check logic, add to if possible - * tidy, inelegant solution - -**** DONE (5.3.5::6.0.5) [#B] victory chals discussed parsing problem caused by use of open-close markers around url - **** TODO UNDERWAY (6.0.5) [#B] exclude heading where possible marker '-#' not distinguished from unnumbered heading '~#' * ~# is general & means no ocn (for any object to which it is applied) @@ -1220,156 +1158,6 @@ revisit, *** DBT Outstanding bugs -- sisu caught by removal of ruby-dbi -**** DONE (pending acceptance) [#B] sisu 5.3.4-1 marked for autoremoval from debian testing on 2014-06-10, for depending on ruby-dbi - -sisu 5.3.4-1 is marked for autoremoval from testing on 2014-06-10 -It (build-)depends on packages with these RC bugs: -746081: ruby-dbi: FTBFS: ERROR: Test "ruby2.1" failed: wrong number -of arguments (3 for 1..2) - -The current status of use of ruby-dbi in sisu. - -from: -http://lists.sisudoc.org/pipermail/sisu/2014-May/000818.html - -***** sisu - SiSU does not depend on an sql database to be useful and most users do - not use the database (population and resulting search) possibilities. - -***** DONE [#B] sisu-sqlite - 5.3.4 uses ruby-sqlite3 directly. There has been a - dependency within debian/control on ruby-dbi for sisu-sqlite, this can - safely be removed, without affecting its operation. - (it is used rather by the sample sqlite3 search form) - - >Solution Proposed: remove debian/control dependency on ruby-dbi - - Solution Implemented: - * sisu-sqlite uses 'sqlite3' ruby-sqlite3 (any superflous dbi loading dropped) - * code tests passed (create tables, populate db etc. work fine) - (closes) - -***** DONE [#B] sisu-postgresql - sisu-postgresql 5.3.4 uses ruby-pg through ruby-dbi. - - >Solution Proposed: - >* attempt now to fix by migrating to use ruby-pg directly - > * remove dependency on ruby-dbi in debian/control - > * rewrite code within sisu to work directly with ruby-pg - - Solution Implemented: - * sisu-postgresql uses 'pg' ruby-pg (ruby-dbi dropped) - * code tests passed (create tables, populate db etc. work fine) - (closes) - -***** DONE [#B] sample cgi search forms - there is a sample cgi search form facility within sisu that uses - ruby-dbi to query sqlite3 or pg databases. - - >Solution Proposed: - >* file a wishlist bug against sisu. No action needed immediately - > (other perhaps than to remove references to ruby-dbi). This offering - > in sisu would be classified as "wishlist" as these are samples only - > and need not be provided at all as populating the database (at an - > object level) in this case is the challenge (so you could say these - > documents meet your search criteria at these locations within them - > (relevant to almost all output formats html, epub, pdf etc.) (and - > may be looked up in these languages if they are available)) and is - > independent from search, once you have an sql database you can query - > it as you wish. (the cgi sample forms will be provided again - > eventually using ruby-sqlite3 and ruby-pg directly). - - Solution Implemented: - * sample cgi search froms (cgi database query forms) fixed :) - * pg sample uses 'pg' (dbi dropped) - generate sample form using: sisu --sample-search-form --db-pg - * sqlite sample uses 'sqlite3' (dbi dropped) - generate sample form using: sisu --sample-search-form --db-sqlite - (closes) - -***** NOTES/COMMENTS - -debian/control, remove dependency on ruby-dbi, contained in sisu-postgresql and sisu-sqlite - -Current status - * sisu-sqlite ok, uses 'sqlite3' (superflous dbi loading dropped) - * sisu-postgresql ok, uses 'pg' (dbi dropped) - * sample cgi search froms (cgi database query forms) ok :) - * pg sample uses 'pg' (dbi dropped) - * sqlite sample uses 'sqlite3' (dbi dropped) - -*** DBT Outstanding bugs -- Normal bugs; Unclassified (2 bugs) :debian:dbt:normal: - - -**** DONE (5.3.5::6.0.5) [#B] #744360 [n|u] sisu: includes do not work properly :processing:fix: - - -From: Daniel Baumann -To: Debian Bug Tracking System -Subject: includes do not work properly -Date: Sun, 13 Apr 2014 12:38:59 +0200 -Package: sisu -Version: 5.3.4-1 -Severity: wishlist - -using this in foo.ssm: - - :A~ foo - - :B~ bar - - << bar/baz.ssi - -and this in baz.ssi: - - 1~ foo bar baz - -then everything works. - -using the more natural foo.ssm: - - :A~ foo - - << bar/baz.ssi - -and baz.ssi: - - :B~ bar - - 1~ foo bar baz - -makes ':B~ bar' being ignored in the output (pdf) entirely. - -Regards, -Daniel - -***** NOTES/COMMENTS - -it appears both give faulty text, though in different ways - -fixed - -**** DONE (5.3.5::6.0.5) [#B] #744378 [n|u] sisu: --no-manifest not working anymore :check: - - -From: Daniel Baumann -To: Debian Bug Tracking System -Subject: --no-manifest not working anymore -Date: Sun, 13 Apr 2014 16:12:13 +0200 -Package: sisu -Version: 5.3.4-1 -Severity: wishlist - -when running sisu-pdf with --no-manifest, the output (pdf) still -contains the sisu manifest at the end of the document. - -Regards, -Daniel - -***** NOTES/COMMENTS - -fix, metadata page in pdf should not contain link to manifest where --no-manifest flag is used - **** TODO ONGOING #746740 [n|u] manpages incomplete Date: Sat, 03 May 2014 08:45:49 +0200 @@ -1496,48 +1284,6 @@ That said re pdf, LaTeX XeTeX are flexible, it may be possible to drop the ocn at the start of a code block lower on its line so that it is closer to the code that follows -**** DONE (5.3.5::6.0.5) [#D] #744353 [w|u] sisu output: please do not use typewriter for urls :output:consider: - - -From: Daniel Baumann -To: Debian Bug Tracking System -Subject: please do not use typewriter for urls -Date: Sun, 13 Apr 2014 12:28:27 +0200 -Package: sisu -Version: 5.3.4-1 -Severity: wishlist - -when using urls in sisu like this: - - http://example.org - -sisu then creates in the output (pdf) links like this: - - - -where as '' is written in typewriter font -(monospace). please don't do that automagically since it's desturbing -the visual flow when reading. If the users wants that, he should be able -to configure it. - -Regards, -Daniel - -***** NOTES/COMMENTS - -monospace for url outputs in pdf - -this is default behavior of the latex url package (it uses tt typewriter font) -it is possible to modify the font to sf class or tm/rm class, & I now default to sf -this means when the sisu default sf is used there will be no difference in typeface, -but when times roman or other is used, urls will be in sf instead of that font, -(instead of the latex default typewriter) - -it provides a visual cue even when output is monochrome, without color -(and is in some way related to #744391 sisu output: no color on a4 portrait) -however, it is worth noting here that urls are printed in a smaller font so as -to fit more on a line of text - **** TODO [#C] #744354 [w|u] sisu output: please do not add '<' and '>' around urls From: Daniel Baumann @@ -1569,360 +1315,6 @@ would need to make configurable url_visual_delimiters: '<>' look into later -**** DONE (5.3.5::6.0.5) [#C] #744355 [w|u] vim syntaxhighlighting: includes and directories :syntaxhi:fix: - - -From: Daniel Baumann -To: Debian Bug Tracking System -Subject: vim syntaxhighlighting: includes and directories -Date: Sun, 13 Apr 2014 12:28:46 +0200 -Package: sisu -Version: 5.3.4-1 -Severity: wishlist - -When using includes like this: - - << foo.ssi - -then vim correctly displays the line in blue. - -However, when using includes in a subdirectory like this: - - << bar/foo.ssi - -then vim doesn't use any colors at all. - -Regards, -Daniel - -***** NOTES/COMMENTS - -done - -**** DONE PASS [#C] #744356 [w|u] vim syntaxhighlighting: urls and tags :discuss:close: - - -From: Daniel Baumann -To: Debian Bug Tracking System -Subject: vim syntaxhighlighting: urls and tags -Date: Sun, 13 Apr 2014 12:28:56 +0200 -Package: sisu -Version: 5.3.4-1 -Severity: wishlist - -When using an URL at the end of a sentence like this: - - Foo bar baz http://example.org. - -then vim properly highlights the url in blue. - -this also works properly when a second sentence after it, like: - - Foo bar baz http://example.org. Foo bar baz http://example.org. - -it works with html tag as well, like this: - - Foo bar baz http://example.org.
Foo bar baz http://example.org. - -but it doesn't work if there's no space: - - Foo bar baz http://example.org.
Foo bar baz http://example.org. - -then, the string 'http://www.gnu.org/licenses/.<' is shown red. - -Regards, -Daniel - -***** NOTES/COMMENTS - -this is meant to be flagged as an error, -(red indicates error, and is an error will not parse correctly) -even if the sisu parser works in the flagged case there is no promise that it will in future - -use of angle bracket markers (html markers) in sisu markup is depreciated. -for line-break use \\ instead, -for which there should be surrounding spaces or a preceding space and end of line; -if
is still used there should be a space after the url - which sisu should remove in output. - -would like to close without further action -re-open if necessary - -**** DONE (6.0.5) [#C] #744357 [w|u] sisu output: please create mailto links automatically - - -From: Daniel Baumann -To: Debian Bug Tracking System -Subject: please create mailto links automatically -Date: Sun, 13 Apr 2014 12:29:12 +0200 -Package: sisu -Version: 5.3.4-1 -Severity: wishlist - -When using urls like: - - http://example.org - -in sisu, the output (pdf) contains a hyperlink to http://example.org -automatically, which is nice. - -please also create mailto links when using email adresses like: - - john.doe@example.org - -Regards, -Daniel - -***** NOTES/COMMENTS - -for pdf fix/implement mailto links -done but requires further testing & possibly refinement - -**** DONE (5.3.5::6.0.5) [#C] #744358 [w|u] sisu output: please do not add ';' after \:copyright: :output:fix: - - -From: Daniel Baumann -To: Debian Bug Tracking System -Subject: please do not add ';' after :copyright: -Date: Sun, 13 Apr 2014 12:29:20 +0200 -Package: sisu -Version: 5.3.4-1 -Severity: wishlist - -When using: - - :copyright: foo bar baz. - -sisu generates the following in the output format (pdf): - - foo bar baz.; - -Please do not automagically add a semicolon (;). If the user wants a -semicolon, he would add one. - -Regards, -Daniel - -***** NOTES/COMMENTS - -fix copyright, remove trailing semi-colon - -**** DONE (5.3.5::6.0.5) [#B] #744379 [w|u] sisu: missing includes doesn't give an error :processing:fix: - - -From: Daniel Baumann -To: Debian Bug Tracking System -Subject: missing includes doesn't give an error -Date: Sun, 13 Apr 2014 16:14:46 +0200 -Package: sisu -Version: 5.3.4-1 -Severity: wishlist - -When using includes (*.ssi) in a sisu master document (*.ssm) like: - - << foo.ssi - -and that to be included file foo.ssi (for whatever reason) doesn't -exist, sisu doesn't error out but include '<< foo.ssi' literally as a -string in the output (pdf). - -Regards, -Daniel - -***** NOTES/COMMENTS - -5.3.4-1 writes the following to the screen: -"ERROR test.ssm.sst requires invalid or non-existent file: foo.ssi" - -and unsatisfactorily within the text output it writes no error message but the include instruction: - -"<< foo.ssi" - -5.3.5, the current "fix"/ solution, is to add an error message within the text rather than to stop processing with an error. -In addition to (i) slightly modified (you could say corrected) to the following: - -"ERROR test.ssm requires an invalid or non-existent file: foo.ssi" - -the following is written within the text output: - -"<< foo.ssi [ERROR test.ssm requires an invalid or non-existent file: foo.ssi]" - -**** DONE (5.3.5::6.0.5) [#D] #744381 [w|u] sisu syntax: inconsistency \:copyright: and \:license: :metadata: - - -From: Daniel Baumann -To: Debian Bug Tracking System -Subject: inconsistency between :copyright: and :license: -Date: Sun, 13 Apr 2014 16:26:55 +0200 -Package: sisu -Version: 5.3.4-1 -Severity: wishlist - -when using ':copyright: foo', then the output contains 'foo'. - -when using ':license: foo', then the output contains 'License: foo'. - -this is inconsistent. either both should have a 'prefix' in the output, -or neither should have one (i'd prefere the latter). - -Regards, -Daniel - -***** NOTES/COMMENTS - -Under rights there are a series of sub-categories starting with copyright, that -need to be distinguished. Until now started distinguishing after after -Copyright. For consistency have add the prefix 'Copyright' to the output. -Preference to omit noted, but this solution is consistent with options -provided. Bug closed, re-open if necessary. - -**** DONE (6.0.5) [#B] #744383 [w|u] sisu syntax: :B and :C result in the same formatting :output:fix: (partial solution) - - -From: Daniel Baumann -To: Debian Bug Tracking System -Subject: sisu syntax: :B and :C result in the same formatting -Date: Sun, 13 Apr 2014 16:32:07 +0200 -Package: sisu -Version: 5.3.4-1 -Severity: wishlist - -when using :A, :B, and :C in sisu, in the output (pdf) both :B and :C -are formatted identically. - -imho :C should be 'smaller' than :B. - -or, as an analogy with html: i would expect that :A equals

, :B -equals

, and :C equals

. currently, (in that analogy), :B and :C -both equal

. - -Regards, -Daniel - -***** NOTES/COMMENTS - -this is in part an artifact of LaTeX not having as many document heading levels -and trying to take advantage of the behavior of existing levels rather than -customizing further - -look for a solution, possibly overriding the default font sizes for each - -The current settings were chosen because, there are not enough levels and I -find too many different font sizes disconcerting, especially running sisu over -a wide variety of document types - -the following levels are available in LaTeX - -\part -\chapter -\section -\subsection -\subsubsection - -the levels in sisu are - -A [title] -B [part] -C [subpart] -D [subsubpart] -1 [segment (chapter)] -2 [subsegment] -3 [subsubsegment] - -sisu current mapping: - -level A [title] -level B C D \part (it is up to the user to make part levels visually distinguishable e.g. Book Part Section) -[skipped \chapter] -[skipped \section] -level 1 \subsection -level 2 \subsubsection -level 3 \subsubsection - -the reason for skipping section was the default configuration and resulting -fact that it made for a table of contents that takes more space - -sisu new mapping: - -level A [title] -level B C D \part (it is up to the user to make part levels visually distinguishable e.g. Book Part Section) -[skipped \chapter] -level 1 \section -level 2 \subsection -level 3 \subsubsection - -levels B C & D are the same size, - it is up to the user to make part levels visually distinguishable - e.g. Book Part Section -levels 1 2 & 3 are now distinguished - -(Closes #744386) sisu syntax: 1~ and 2~ result in the same formatting -(under consideration & yet to be done #744383) sisu syntax: :B and :C result in the same formatting -(touches ) -override part font size settings for different levels (B C D) - -**** DONE CLOSED [#C] #744384 [w|u] sisu syntax: relies on empty lines - - -From: Daniel Baumann -To: Debian Bug Tracking System -Subject: sisu syntax: relies on empty lines -Date: Sun, 13 Apr 2014 16:34:46 +0200 -Package: sisu -Version: 5.3.4-1 -Severity: wishlist - -the following snipped: - - :C~ foo bar - << foo-bar.ssi - -means that the include is ignored entirely. apparently sisu relies on -having an empty line in between like this: - - :C~ foo bar - - << foo-bar.ssi - -Regards, -Daniel - -***** NOTES/COMMENTS - -consider, - -(i) as a general observation, sisu relies on emptly lines to identify separate objects - such as headings, paragraphs (and indeed insertions) - -(ii) a heading need not be on a single line (so << would be part of that heading) -this means sisu should be able to work identifying headings in wrapped texts -(e.g. where the text is wrapped at 80 and the heading is longer than that) - -there has been no rule to the contrary (i.e. that headings should be on a single text line) - -consider, should there be such a rule? - -**** DONE (5.3.5::6.0.5) [#B] #744386 [w|u] sisu syntax: 1~ and 2~ result in the same formatting :output:pdf:fix: (see #744383) - - -From: Daniel Baumann -To: Debian Bug Tracking System -Subject: sisu syntax: 1~ and 2~ result in the same formatting -Date: Sun, 13 Apr 2014 16:43:51 +0200 -Package: sisu -Version: 5.3.4-1 -Severity: wishlist - -similar as with #744383, the same also applies for 1~ and 2~ - they -should be different in the output format (pdf here). - -Regards, -Daniel - -***** NOTES/COMMENTS - -1~ 2~ 3~ are now differentiated - -deal with under #744383 **** TODO [#B] #744390 [w|u] sisu: empty sections are ignored @@ -1968,66 +1360,6 @@ seemed to work (checked pdf & html (scroll & seg)) was not able to reproduce will look again -**** DONE (5.3.5::6.0.5) [#C] #744391 [w|u] sisu output: no color on a4 portrait :output:pdf:contemplate: - - -From: Daniel Baumann -To: Debian Bug Tracking System -Subject: sisu output: please use (blue) color for links -Date: Sun, 13 Apr 2014 17:23:37 +0200 -Package: sisu -Version: 5.3.4-1 -Severity: wishlist -Tags: upstream - -it would be nice if links (urls and emails) would be colored blue to -mark them visually as links. this behaviour is somewhat the lowest -common denominator in browsers (if you use html without any css that is). - -Regards, -Daniel - -From: Daniel Baumann -To: 744391@bugs.debian.org -Subject: Re: sisu output: please use (blue) color for links -Date: Sun, 13 Apr 2014 17:35:33 +0200 -retitle 744391 sisu output: no color on a4 portrait -thanks - -now this is strange.. turns out that (yes, i have colors enabled in -sisurc) the portrait a4 pdf has no colors at all, while the landscape a4 -pdf does indeed have colors (red for toc, blue for links). - -Regards, -Daniel - -***** NOTES/COMMENTS - -background: -portrait was provided for print/paper copy and is great for that in monochrome -(without grays for colored links), -landscape better matching a screen for visual presentations, color affecting the landscape only - -solution: -make configurable by cli & rc file -make both (portrait & landscape colors) configurable -either as hyperlinks monochrome or colored -overriding existing default which remains as described - -document -cli: ---pdf-hyperlinks-no-color or --pdf-hyperlinks-mono ---pdf-hyperlinks-color - -rc: - -default: - pdf_hyperlinks: *[possible values] - pdf_hyperlinks_portrait: *[possible values] - pdf_hyperlinks_landscape: *[possible values] - - * 'color' or ('mono' or 'no-color' or 'color-off') - **** TODO [#D] #744395 [w|u] sisu output: half-page title page in landscape output @@ -2099,101 +1431,6 @@ Daniel will look at: should be possible; requires a configuration option -**** DONE (5.3.5::6.0.5) [#B] #744399 [w|u] sisu syntax: :A smaller formatted than :B :output:fix: (see #744383) (partial solution) - - -From: Daniel Baumann -To: Debian Bug Tracking System -Subject: sisu syntax: :A smaller formatted than :B -Date: Sun, 13 Apr 2014 17:49:26 +0200 -Package: sisu -Version: 5.3.4-1 -Severity: wishlist -Tags: upstream - -in a document like this: - -:A~ foo - -:B~ bar - -the :A~ 'title' is formated 'smaller' (not bold, smaller font size) than -the :B~ 'title' on the first page of the actual document (means, first -page after TOC). - -Regards, -Daniel - -***** NOTES/COMMENTS - -for pdf - -now is same size see #744383 - -\part (level A B C D) -\chapter (skipped) -\section (level 1) -\subsection (level 2) -\subsubsection (level 3) - -**** DONE (5.3.5::6.0.5) [#C] #744402 [w|u] sisu: support sha512 :implement: - - -From: Daniel Baumann -To: Debian Bug Tracking System -Subject: sisu: support sha512 -Date: Sun, 13 Apr 2014 18:06:56 +0200 -Package: sisu -Version: 5.3.4-1 -Severity: wishlist -Tags: upstream - -sisu uses sha256 when using sha as digest, please support sha512. - -it would be even nicer if you could specify the actual digest like -'sha512', 'sha256', etc. rather than just 'sha'. - -Regards, -Daniel - -***** NOTES/COMMENTS - -implemented -document command line option --sha512 - -**** DONE (5.3.5::6.0.5) [#C] #744405 [w|u] sisu: set default font size :configuration:pdf:implement: - - -From: Daniel Baumann -To: Debian Bug Tracking System -Subject: sisu: set default font size -Date: Sun, 13 Apr 2014 18:29:46 +0200 -Package: sisu -Version: 5.3.4-1 -Severity: wishlist -Tags: upstream - -in sisurc, one can set the default fonts. it would be nice to be also -able to set the default font size. - -Regards, -Daniel - -***** NOTES/COMMENTS - -for pdf make configurable - -yaml.rc - -default: - texpdf_fontsize: 12 - -command-line - ---pdf-fontsize-12 ---pdf-fontsize-8 -etc. - **** TODO [#C] #744407 [w|u] sisu: possibility to influence content/formating of the title page @@ -2220,50 +1457,6 @@ Daniel consider, work on possibly, later -**** DONE (5.5.0::6.1.0) [#C] #744408 [w|u] sisu: support more than one level of includes/nested includes - - -From: Daniel Baumann -To: Debian Bug Tracking System -Subject: sisu: support more than one level of includes/nested includes -Date: Sun, 13 Apr 2014 18:39:23 +0200 -Package: sisu -Version: 5.3.4-1 -Severity: wishlist -Tags: upstream - -currently, it's possible to use only one ssm file which itself includes -one or more ssi files. - -it would be nice if the ssm could include an 'intermediate' ssi, which -then includes further ssi files. this is very handy for larger documents. - -Regards, -Daniel - -***** NOTES/COMMENTS - -consider, -I have to date deliberately tried to keep it easy to follow documents & not have too much depth ... -The idea of recursive includes is un-attractive (messy for a document) - -.ssm currently can contain/include .sst or .ssi -.sst files can be processed independently, -.ssi files are only insertions & are not processed independently but as part of an ssm - -change proposed -.ssm unchanged -.sst unchanged -.ssi as before, but can include .sst or .ssi, so: - files are only insertions & are not processed independently but as part of an .ssm or another .ssi - i.e. as before with the addition that it like a .ssm can contain/include .sst or .ssi - -this is pretty much as requested by wishlist 744408 - -allowing .ssi to also include other .ssi or .sst could lead to recursive .ssi - -stopping after an additional level of includes seems arbitrary, and possibly prone to error if you are dealing with many documents - **** TODO [#C] #744409 [w|u] sisu output: urls in code blocks are not linkified @@ -2287,38 +1480,6 @@ Daniel consider, so far code blocks are pretty much untouched ... not tampered with, this could be done though -**** DONE (6.0.5) [#C] #744541 [w|u] sisu: urls in @creator broken - - -From: Daniel Baumann -To: Debian Bug Tracking System -Subject: sisu: urls in @creator broken -Date: Sun, 13 Apr 2014 18:45:35 +0200 -Package: sisu -Version: 5.3.4-1 -Severity: wishlist -Tags: upstream - -first, if you have an url within @creator, like: - - @creator: foo bar http://example.org - -the generation fails (pdf output). - -as a workaround, i put the url into parenthesis, like: - - @creator: foo bar (http://example.org) - -but then, it would be nice if that url would be automatically -transformed into a link in the output format (pdf). - -Regards, -Daniel - -***** NOTES/COMMENTS - -pdf, fix - **** TODO [#C] #744685 [w|u] sisu output: copy&past-able wrapped code blocks -- cgit v1.2.3 From 0bd17c97aa19fb4a03c27e07d9e0a631b560b9f6 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Fri, 3 Oct 2014 19:15:10 -0400 Subject: v5 v6: cleaning, minor --- lib/sisu/v5/hub_options.rb | 51 ---------------------------------------------- lib/sisu/v6/hub_options.rb | 51 ---------------------------------------------- 2 files changed, 102 deletions(-) diff --git a/lib/sisu/v5/hub_options.rb b/lib/sisu/v5/hub_options.rb index ceeebe78..0854b9c6 100644 --- a/lib/sisu/v5/hub_options.rb +++ b/lib/sisu/v5/hub_options.rb @@ -505,57 +505,6 @@ module SiSU_Commandline end s.strip! end - def expand_numeric_shortcuts_(a) - shortcut=SiSU_Env::InfoProcessingFlag.new - s='' - a.each do |x| - y=case x - when /0/ - (x=~/^-0\S+/) \ - ? x.gsub(/^-0(\S+)/,shortcut.act_0.str + ' -\1') - : x.gsub(/^-0/,shortcut.act_0.str + ' ') - when /1/ - (x=~/^-1\S+/) \ - ? x.gsub(/^-1(\S+)/,shortcut.act_1.str + ' -\1') - : x.gsub(/^-1/,shortcut.act_1.str + ' ') - when /2/ - (x=~/^-2\S+/) \ - ? x.gsub(/^-2(\S+)/,shortcut.act_2.str + ' -\1') - : x.gsub(/^-2/,shortcut.act_2.str + ' ') - when /3/ - (x=~/^-3\S+/) \ - ? x.gsub(/^-3(\S+)/,shortcut.act_3.str + ' -\1') - : x.gsub(/^-3/,shortcut.act_3.str + ' ') - when /4/ - (x=~/^-4\S+/) \ - ? x.gsub(/^-4(\S+)/,shortcut.act_4.str + ' -\1') - : x.gsub(/^-4/,shortcut.act_4.str + ' ') - when /5/ - (x=~/^-5\S+/) \ - ? x.gsub(/^-5(\S+)/,shortcut.act_5.str + ' -\1') - : x.gsub(/^-5/,shortcut.act_5.str + ' ') - when /6/ - (x=~/^-6\S+/) \ - ? x.gsub(/^-6(\S+)/,shortcut.act_6.str + ' -\1') - : x.gsub(/^-6/,shortcut.act_6.str + ' ') - when /7/ - (x=~/^-7\S+/) \ - ? x.gsub(/^-7(\S+)/,shortcut.act_7.str + ' -\1') - : x.gsub(/^-7/,shortcut.act_7.str + ' ') - when /8/ - (x=~/^-8\S+/) \ - ? x.gsub(/^-8(\S+)/,shortcut.act_8.str + ' -\1') - : x.gsub(/^-8/,shortcut.act_8.str + ' ') - when /9/ - (x=~/^-9\S+/) \ - ? x.gsub(/^-9(\S+)/,shortcut.act_9.str + ' -\1') - : x.gsub(/^-9/,shortcut.act_9.str + ' ') - else x - end - s << " #{y}" unless y.empty? - end - s.strip! - end def opt_cmd_and_mod_adjust(ch,select_arr,files) select_arr=select_arr.flatten sel_init=select_arr.flatten diff --git a/lib/sisu/v6/hub_options.rb b/lib/sisu/v6/hub_options.rb index 0cb0d336..7ed7645f 100644 --- a/lib/sisu/v6/hub_options.rb +++ b/lib/sisu/v6/hub_options.rb @@ -505,57 +505,6 @@ module SiSU_Commandline end s.strip! end - def expand_numeric_shortcuts_(a) - shortcut=SiSU_Env::InfoProcessingFlag.new - s='' - a.each do |x| - y=case x - when /0/ - (x=~/^-0\S+/) \ - ? x.gsub(/^-0(\S+)/,shortcut.act_0.str + ' -\1') - : x.gsub(/^-0/,shortcut.act_0.str + ' ') - when /1/ - (x=~/^-1\S+/) \ - ? x.gsub(/^-1(\S+)/,shortcut.act_1.str + ' -\1') - : x.gsub(/^-1/,shortcut.act_1.str + ' ') - when /2/ - (x=~/^-2\S+/) \ - ? x.gsub(/^-2(\S+)/,shortcut.act_2.str + ' -\1') - : x.gsub(/^-2/,shortcut.act_2.str + ' ') - when /3/ - (x=~/^-3\S+/) \ - ? x.gsub(/^-3(\S+)/,shortcut.act_3.str + ' -\1') - : x.gsub(/^-3/,shortcut.act_3.str + ' ') - when /4/ - (x=~/^-4\S+/) \ - ? x.gsub(/^-4(\S+)/,shortcut.act_4.str + ' -\1') - : x.gsub(/^-4/,shortcut.act_4.str + ' ') - when /5/ - (x=~/^-5\S+/) \ - ? x.gsub(/^-5(\S+)/,shortcut.act_5.str + ' -\1') - : x.gsub(/^-5/,shortcut.act_5.str + ' ') - when /6/ - (x=~/^-6\S+/) \ - ? x.gsub(/^-6(\S+)/,shortcut.act_6.str + ' -\1') - : x.gsub(/^-6/,shortcut.act_6.str + ' ') - when /7/ - (x=~/^-7\S+/) \ - ? x.gsub(/^-7(\S+)/,shortcut.act_7.str + ' -\1') - : x.gsub(/^-7/,shortcut.act_7.str + ' ') - when /8/ - (x=~/^-8\S+/) \ - ? x.gsub(/^-8(\S+)/,shortcut.act_8.str + ' -\1') - : x.gsub(/^-8/,shortcut.act_8.str + ' ') - when /9/ - (x=~/^-9\S+/) \ - ? x.gsub(/^-9(\S+)/,shortcut.act_9.str + ' -\1') - : x.gsub(/^-9/,shortcut.act_9.str + ' ') - else x - end - s << " #{y}" unless y.empty? - end - s.strip! - end def opt_cmd_and_mod_adjust(ch,select_arr,files) select_arr=select_arr.flatten sel_init=select_arr.flatten -- cgit v1.2.3 From 97864e99d0819efdd3916f11f16cca058438ffc4 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Fri, 3 Oct 2014 19:20:08 -0400 Subject: v5 v6: --act provides info on current --act0 to --act9 settings * makes it easier to make use of acts 0 to 9 --- data/doc/sisu/CHANGELOG_v5 | 3 ++ data/doc/sisu/CHANGELOG_v6 | 3 ++ lib/sisu/v5/hub_options.rb | 8 +++++- lib/sisu/v5/se_processing.rb | 68 +++++++++++++++++++++++++++++++------------- lib/sisu/v6/hub_options.rb | 8 +++++- lib/sisu/v6/se_processing.rb | 68 +++++++++++++++++++++++++++++++------------- 6 files changed, 116 insertions(+), 42 deletions(-) diff --git a/data/doc/sisu/CHANGELOG_v5 b/data/doc/sisu/CHANGELOG_v5 index 6f237b9f..cd26fe03 100644 --- a/data/doc/sisu/CHANGELOG_v5 +++ b/data/doc/sisu/CHANGELOG_v5 @@ -38,6 +38,9 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_5.6.9.orig.tar.xz sisu_5.6.9.orig.tar.xz sisu_5.6.9-1.dsc +* --act provides info on current --act0 to --act9 settings (makes it easier to + make use of acts 0 to 9) + %% 5.6.8.orig.tar.xz (2014-09-28:38/7) http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/sisu_5.6.8 http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/debian/sisu_5.6.8-1 diff --git a/data/doc/sisu/CHANGELOG_v6 b/data/doc/sisu/CHANGELOG_v6 index 043d7726..04c1f218 100644 --- a/data/doc/sisu/CHANGELOG_v6 +++ b/data/doc/sisu/CHANGELOG_v6 @@ -28,6 +28,9 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_6.2.10.orig.tar.xz sisu_6.2.10.orig.tar.xz sisu_6.2.10-1.dsc +* --act provides info on current --act0 to --act9 settings (makes it easier to + make use of acts 0 to 9) + %% 6.2.9.orig.tar.xz (2014-09-28:38/7) http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/sisu_6.2.9 http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/debian/sisu_6.2.9-1 diff --git a/lib/sisu/v5/hub_options.rb b/lib/sisu/v5/hub_options.rb index 0854b9c6..9e35cc36 100644 --- a/lib/sisu/v5/hub_options.rb +++ b/lib/sisu/v5/hub_options.rb @@ -511,7 +511,7 @@ module SiSU_Commandline shortcut=SiSU_Env::InfoProcessingFlag.new if files ==:true if not sel_init.empty? \ - and sel_init.inspect =~/"--act[0-9]/ + and sel_init.inspect =~/"--act[s0-9]?/ sel_init.each do |s| select_arr <<=case s when /--act0/ then shortcut.act_0.arr @@ -524,6 +524,7 @@ module SiSU_Commandline when /--act7/ then shortcut.act_7.arr when /--act8/ then shortcut.act_8.arr when /--act9/ then shortcut.act_9.arr + when /--act/ then shortcut.act_info end end end @@ -688,6 +689,11 @@ module SiSU_Commandline end end else + if not sel_init.empty? \ + and sel_init.inspect =~/"--acts?/ + shortcut.act_info + exit + end if ch =~/c/ then select_arr << '--color-toggle' ch=ch.gsub(/[c]/,'') end diff --git a/lib/sisu/v5/se_processing.rb b/lib/sisu/v5/se_processing.rb index 88b0b7df..8646b5e0 100644 --- a/lib/sisu/v5/se_processing.rb +++ b/lib/sisu/v5/se_processing.rb @@ -472,6 +472,9 @@ module SiSU_Info_Processing_Flag : false end def act_0 #configurable processing flag shortcuts + def default + '--manifest --digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --sqlite --verbose' + end def str if defined? @rc['flag']['act0'] \ and @rc['flag']['act0'].is_a?(String) @@ -479,8 +482,7 @@ module SiSU_Info_Processing_Flag elsif defined? @rc['flag']['default'] \ and @rc['flag']['default'].is_a?(String) @rc['flag']['default'] - else - '--manifest --digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --sqlite --verbose' + else default end end def arr @@ -489,6 +491,9 @@ module SiSU_Info_Processing_Flag self end def act_1 #configurable processing flag shortcuts + def default + '--manifest --text --html' + end def str if defined? @rc['flag']['act1'] \ and @rc['flag']['act1'].is_a?(String) @@ -496,8 +501,7 @@ module SiSU_Info_Processing_Flag elsif defined? @rc['flag']['i'] \ and @rc['flag']['i'].is_a?(String) @rc['flag']['i'] - else - '--manifest --text --html' + else default end end def arr @@ -506,6 +510,9 @@ module SiSU_Info_Processing_Flag self end def act_2 #configurable processing flag shortcuts + def default + '--manifest --text --html --epub --pdf' + end def str if defined? @rc['flag']['act2'] \ and @rc['flag']['act2'].is_a?(String) @@ -513,8 +520,7 @@ module SiSU_Info_Processing_Flag elsif defined? @rc['flag']['ii'] \ and @rc['flag']['ii'].is_a?(String) @rc['flag']['ii'] - else - '--manifest --text --html --epub --pdf' + else default end end def arr @@ -523,6 +529,9 @@ module SiSU_Info_Processing_Flag self end def act_3 #configurable processing flag shortcuts + def default + '--manifest --text --html --epub --pdf --concordance --qrcode' + end def str if defined? @rc['flag']['act3'] \ and @rc['flag']['act3'].is_a?(String) @@ -530,8 +539,7 @@ module SiSU_Info_Processing_Flag elsif defined? @rc['flag']['iii'] \ and @rc['flag']['iii'].is_a?(String) @rc['flag']['iii'] - else - '--manifest --text --html --epub --pdf --concordance --qrcode' + else default end end def arr @@ -540,6 +548,9 @@ module SiSU_Info_Processing_Flag self end def act_4 #configurable processing flag shortcuts + def default + '--manifest --text --html --epub --pdf --concordance --qrcode --digest --odf --docbook' + end def str if defined? @rc['flag']['act4'] \ and @rc['flag']['act4'].is_a?(String) @@ -547,8 +558,7 @@ module SiSU_Info_Processing_Flag elsif defined? @rc['flag']['iv'] \ and @rc['flag']['iv'].is_a?(String) @rc['flag']['iv'] - else - '--manifest --text --html --epub --pdf --concordance --qrcode --digest --odf --docbook' + else default end end def arr @@ -557,6 +567,9 @@ module SiSU_Info_Processing_Flag self end def act_5 #configurable processing flag shortcuts + def default + '--manifest --text --html --epub --pdf --concordance --qrcode --digest --odf --docbook --sqlite' + end def str if defined? @rc['flag']['act5'] \ and @rc['flag']['act5'].is_a?(String) @@ -564,8 +577,7 @@ module SiSU_Info_Processing_Flag elsif defined? @rc['flag']['v'] \ and @rc['flag']['v'].is_a?(String) @rc['flag']['v'] - else - '--manifest --text --html --epub --pdf --concordance --qrcode --digest --odf --docbook --sqlite' + else default end end def arr @@ -574,12 +586,14 @@ module SiSU_Info_Processing_Flag self end def act_6 #configurable processing flag shortcuts + def default + '--manifest --text --html --epub --pdf --concordance --qrcode --digest --odf --docbook --sqlite --xhtml --xml-sax --xml-dom' + end def str if defined? @rc['flag']['act6'] \ and @rc['flag']['act6'].is_a?(String) @rc['flag']['act6'] - else - '--manifest --text --html --epub --pdf --concordance --qrcode --digest --odf --docbook --sqlite --xhtml --xml-sax --xml-dom' + else default end end def arr @@ -588,12 +602,14 @@ module SiSU_Info_Processing_Flag self end def act_7 #configurable processing flag shortcuts + def default + '--manifest --text --html --epub --pdf --concordance --qrcode --digest --odf --docbook --sqlite --xhtml --xml-sax --xml-dom --source --sisupod' + end def str if defined? @rc['flag']['act7'] \ and @rc['flag']['act7'].is_a?(String) @rc['flag']['act7'] - else - '--manifest --text --html --epub --pdf --concordance --qrcode --digest --odf --docbook --sqlite --xhtml --xml-sax --xml-dom --source --sisupod' + else default end end def arr @@ -602,12 +618,14 @@ module SiSU_Info_Processing_Flag self end def act_8 #configurable processing flag shortcuts + def default + '--manifest --text --html --epub --pdf --concordance --qrcode --digest --odf --docbook --xhtml --xml-sax --xml-dom --pg --update' + end def str if defined? @rc['flag']['act8'] \ and @rc['flag']['act8'].is_a?(String) @rc['flag']['act8'] - else - '--manifest --text --html --epub --pdf --concordance --qrcode --digest --odf --docbook --xhtml --xml-sax --xml-dom --pg --update' + else default end end def arr @@ -616,12 +634,14 @@ module SiSU_Info_Processing_Flag self end def act_9 #configurable processing flag shortcuts + def default + '--manifest --text --html --epub --pdf --concordance --qrcode --digest --odf --docbook --xhtml --xml-sax --xml-dom --pg --update --source --sisupod' + end def str if defined? @rc['flag']['act9'] \ and @rc['flag']['act9'].is_a?(String) @rc['flag']['act9'] - else - '--manifest --text --html --epub --pdf --concordance --qrcode --digest --odf --docbook --xhtml --xml-sax --xml-dom --pg --update --source --sisupod' + else default end end def arr @@ -629,6 +649,14 @@ module SiSU_Info_Processing_Flag end self end + def act_info + puts 'current "act" settings:' + acts=%w[ act_0 act_1 act_2 act_3 act_4 act_5 act_6 act_7 act_8 act_9 ] + acts.each_with_index do |m,i| + puts '--act-' + i.to_s + ' == ' \ + + send(m).str + end + end end end __END__ diff --git a/lib/sisu/v6/hub_options.rb b/lib/sisu/v6/hub_options.rb index 7ed7645f..f8085c6c 100644 --- a/lib/sisu/v6/hub_options.rb +++ b/lib/sisu/v6/hub_options.rb @@ -511,7 +511,7 @@ module SiSU_Commandline shortcut=SiSU_Env::InfoProcessingFlag.new if files ==:true if not sel_init.empty? \ - and sel_init.inspect =~/"--act[0-9]/ + and sel_init.inspect =~/"--act[s0-9]?/ sel_init.each do |s| select_arr <<=case s when /--act0/ then shortcut.act_0.arr @@ -524,6 +524,7 @@ module SiSU_Commandline when /--act7/ then shortcut.act_7.arr when /--act8/ then shortcut.act_8.arr when /--act9/ then shortcut.act_9.arr + when /--act/ then shortcut.act_info end end end @@ -688,6 +689,11 @@ module SiSU_Commandline end end else + if not sel_init.empty? \ + and sel_init.inspect =~/"--acts?/ + shortcut.act_info + exit + end if ch =~/c/ then select_arr << '--color-toggle' ch=ch.gsub(/[c]/,'') end diff --git a/lib/sisu/v6/se_processing.rb b/lib/sisu/v6/se_processing.rb index e437bd0f..2f41bb17 100644 --- a/lib/sisu/v6/se_processing.rb +++ b/lib/sisu/v6/se_processing.rb @@ -472,6 +472,9 @@ module SiSU_Info_Processing_Flag : false end def act_0 #configurable processing flag shortcuts + def default + '--manifest --digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --sqlite --verbose' + end def str if defined? @rc['flag']['act0'] \ and @rc['flag']['act0'].is_a?(String) @@ -479,8 +482,7 @@ module SiSU_Info_Processing_Flag elsif defined? @rc['flag']['default'] \ and @rc['flag']['default'].is_a?(String) @rc['flag']['default'] - else - '--manifest --digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --sqlite --verbose' + else default end end def arr @@ -489,6 +491,9 @@ module SiSU_Info_Processing_Flag self end def act_1 #configurable processing flag shortcuts + def default + '--manifest --text --html' + end def str if defined? @rc['flag']['act1'] \ and @rc['flag']['act1'].is_a?(String) @@ -496,8 +501,7 @@ module SiSU_Info_Processing_Flag elsif defined? @rc['flag']['i'] \ and @rc['flag']['i'].is_a?(String) @rc['flag']['i'] - else - '--manifest --text --html' + else default end end def arr @@ -506,6 +510,9 @@ module SiSU_Info_Processing_Flag self end def act_2 #configurable processing flag shortcuts + def default + '--manifest --text --html --epub --pdf' + end def str if defined? @rc['flag']['act2'] \ and @rc['flag']['act2'].is_a?(String) @@ -513,8 +520,7 @@ module SiSU_Info_Processing_Flag elsif defined? @rc['flag']['ii'] \ and @rc['flag']['ii'].is_a?(String) @rc['flag']['ii'] - else - '--manifest --text --html --epub --pdf' + else default end end def arr @@ -523,6 +529,9 @@ module SiSU_Info_Processing_Flag self end def act_3 #configurable processing flag shortcuts + def default + '--manifest --text --html --epub --pdf --concordance --qrcode' + end def str if defined? @rc['flag']['act3'] \ and @rc['flag']['act3'].is_a?(String) @@ -530,8 +539,7 @@ module SiSU_Info_Processing_Flag elsif defined? @rc['flag']['iii'] \ and @rc['flag']['iii'].is_a?(String) @rc['flag']['iii'] - else - '--manifest --text --html --epub --pdf --concordance --qrcode' + else default end end def arr @@ -540,6 +548,9 @@ module SiSU_Info_Processing_Flag self end def act_4 #configurable processing flag shortcuts + def default + '--manifest --text --html --epub --pdf --concordance --qrcode --digest --odf --docbook' + end def str if defined? @rc['flag']['act4'] \ and @rc['flag']['act4'].is_a?(String) @@ -547,8 +558,7 @@ module SiSU_Info_Processing_Flag elsif defined? @rc['flag']['iv'] \ and @rc['flag']['iv'].is_a?(String) @rc['flag']['iv'] - else - '--manifest --text --html --epub --pdf --concordance --qrcode --digest --odf --docbook' + else default end end def arr @@ -557,6 +567,9 @@ module SiSU_Info_Processing_Flag self end def act_5 #configurable processing flag shortcuts + def default + '--manifest --text --html --epub --pdf --concordance --qrcode --digest --odf --docbook --sqlite' + end def str if defined? @rc['flag']['act5'] \ and @rc['flag']['act5'].is_a?(String) @@ -564,8 +577,7 @@ module SiSU_Info_Processing_Flag elsif defined? @rc['flag']['v'] \ and @rc['flag']['v'].is_a?(String) @rc['flag']['v'] - else - '--manifest --text --html --epub --pdf --concordance --qrcode --digest --odf --docbook --sqlite' + else default end end def arr @@ -574,12 +586,14 @@ module SiSU_Info_Processing_Flag self end def act_6 #configurable processing flag shortcuts + def default + '--manifest --text --html --epub --pdf --concordance --qrcode --digest --odf --docbook --sqlite --xhtml --xml-sax --xml-dom' + end def str if defined? @rc['flag']['act6'] \ and @rc['flag']['act6'].is_a?(String) @rc['flag']['act6'] - else - '--manifest --text --html --epub --pdf --concordance --qrcode --digest --odf --docbook --sqlite --xhtml --xml-sax --xml-dom' + else default end end def arr @@ -588,12 +602,14 @@ module SiSU_Info_Processing_Flag self end def act_7 #configurable processing flag shortcuts + def default + '--manifest --text --html --epub --pdf --concordance --qrcode --digest --odf --docbook --sqlite --xhtml --xml-sax --xml-dom --source --sisupod' + end def str if defined? @rc['flag']['act7'] \ and @rc['flag']['act7'].is_a?(String) @rc['flag']['act7'] - else - '--manifest --text --html --epub --pdf --concordance --qrcode --digest --odf --docbook --sqlite --xhtml --xml-sax --xml-dom --source --sisupod' + else default end end def arr @@ -602,12 +618,14 @@ module SiSU_Info_Processing_Flag self end def act_8 #configurable processing flag shortcuts + def default + '--manifest --text --html --epub --pdf --concordance --qrcode --digest --odf --docbook --xhtml --xml-sax --xml-dom --pg --update' + end def str if defined? @rc['flag']['act8'] \ and @rc['flag']['act8'].is_a?(String) @rc['flag']['act8'] - else - '--manifest --text --html --epub --pdf --concordance --qrcode --digest --odf --docbook --xhtml --xml-sax --xml-dom --pg --update' + else default end end def arr @@ -616,12 +634,14 @@ module SiSU_Info_Processing_Flag self end def act_9 #configurable processing flag shortcuts + def default + '--manifest --text --html --epub --pdf --concordance --qrcode --digest --odf --docbook --xhtml --xml-sax --xml-dom --pg --update --source --sisupod' + end def str if defined? @rc['flag']['act9'] \ and @rc['flag']['act9'].is_a?(String) @rc['flag']['act9'] - else - '--manifest --text --html --epub --pdf --concordance --qrcode --digest --odf --docbook --xhtml --xml-sax --xml-dom --pg --update --source --sisupod' + else default end end def arr @@ -629,6 +649,14 @@ module SiSU_Info_Processing_Flag end self end + def act_info + puts 'current "act" settings:' + acts=%w[ act_0 act_1 act_2 act_3 act_4 act_5 act_6 act_7 act_8 act_9 ] + acts.each_with_index do |m,i| + puts '--act-' + i.to_s + ' == ' \ + + send(m).str + end + end end end __END__ -- cgit v1.2.3 From 14b5f96494f79b75e3e77844561678c793d0caa6 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Fri, 3 Oct 2014 19:28:27 -0400 Subject: v5 v6: html, tiny first nudge toward html5 (v5 v6 differ) * document headers, other minor --- data/doc/sisu/CHANGELOG_v5 | 2 ++ data/doc/sisu/CHANGELOG_v6 | 2 ++ lib/sisu/v5/cgi_sql_common.rb | 21 ++++++------- lib/sisu/v5/harvest_authors.rb | 10 +++--- lib/sisu/v5/harvest_topics.rb | 10 +++--- lib/sisu/v5/html_concordance.rb | 3 +- lib/sisu/v5/html_format.rb | 29 ++++------------- lib/sisu/v5/html_manifest.rb | 8 ++--- lib/sisu/v5/html_segments.rb | 2 +- lib/sisu/v5/se_css.rb | 6 ++-- lib/sisu/v5/shared_metadata.rb | 14 +++++++++ lib/sisu/v6/cgi_sql_common.rb | 29 +++++++++-------- lib/sisu/v6/defaults.rb | 34 ++++++++++---------- lib/sisu/v6/harvest_authors.rb | 10 +++--- lib/sisu/v6/harvest_topics.rb | 10 +++--- lib/sisu/v6/html.rb | 14 ++++----- lib/sisu/v6/html_concordance.rb | 9 +++--- lib/sisu/v6/html_format.rb | 69 ++++++++++++----------------------------- lib/sisu/v6/html_lite_shared.rb | 4 +-- lib/sisu/v6/html_manifest.rb | 26 ++++++++-------- lib/sisu/v6/html_promo.rb | 16 +++++----- lib/sisu/v6/html_scroll.rb | 2 +- lib/sisu/v6/html_segments.rb | 6 ++-- lib/sisu/v6/html_tune.rb | 8 ++--- lib/sisu/v6/se_css.rb | 6 ++-- lib/sisu/v6/shared_metadata.rb | 14 +++++++++ lib/sisu/v6/xhtml_epub2.rb | 2 +- 27 files changed, 176 insertions(+), 190 deletions(-) diff --git a/data/doc/sisu/CHANGELOG_v5 b/data/doc/sisu/CHANGELOG_v5 index cd26fe03..e3d65afb 100644 --- a/data/doc/sisu/CHANGELOG_v5 +++ b/data/doc/sisu/CHANGELOG_v5 @@ -41,6 +41,8 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_5.6.9.orig.tar.xz * --act provides info on current --act0 to --act9 settings (makes it easier to make use of acts 0 to 9) +* html, tiny first nudge toward html5 (document headers and minor) + %% 5.6.8.orig.tar.xz (2014-09-28:38/7) http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/sisu_5.6.8 http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/debian/sisu_5.6.8-1 diff --git a/data/doc/sisu/CHANGELOG_v6 b/data/doc/sisu/CHANGELOG_v6 index 04c1f218..89e20477 100644 --- a/data/doc/sisu/CHANGELOG_v6 +++ b/data/doc/sisu/CHANGELOG_v6 @@ -31,6 +31,8 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_6.2.10.orig.tar.xz * --act provides info on current --act0 to --act9 settings (makes it easier to make use of acts 0 to 9) +* html, tiny first nudge toward html5 (document headers and minor) + %% 6.2.9.orig.tar.xz (2014-09-28:38/7) http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/sisu_6.2.9 http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/debian/sisu_6.2.9-1 diff --git a/lib/sisu/v5/cgi_sql_common.rb b/lib/sisu/v5/cgi_sql_common.rb index 187859ec..a16ca0db 100644 --- a/lib/sisu/v5/cgi_sql_common.rb +++ b/lib/sisu/v5/cgi_sql_common.rb @@ -144,18 +144,17 @@ module SiSU_CGI_SQL end def header_desc <<-WOK_SQL - - + + - - SiSU search form (sample): SiSU information Structuring Universe - - - - - - + + <meta charset="utf-8"> + <meta name="sourcefile" content="SiSU._sst" /> + SiSU search form (sample): SiSU information Structuring Universe + + + + diff --git a/lib/sisu/v5/harvest_authors.rb b/lib/sisu/v5/harvest_authors.rb index 1ea2167a..8db14eee 100644 --- a/lib/sisu/v5/harvest_authors.rb +++ b/lib/sisu/v5/harvest_authors.rb @@ -318,20 +318,20 @@ module SiSU_HarvestAuthors output_structure_by='(output organised by ?)' end < - + + + SiSU Metadata Harvest - Authors - + - + diff --git a/lib/sisu/v5/harvest_topics.rb b/lib/sisu/v5/harvest_topics.rb index bb0bbe22..b2e83683 100644 --- a/lib/sisu/v5/harvest_topics.rb +++ b/lib/sisu/v5/harvest_topics.rb @@ -688,20 +688,20 @@ module SiSU_HarvestTopics output_structure_by='(output organised by ?)' end < - + + + SiSU Metadata Harvest - Topics - + - + diff --git a/lib/sisu/v5/html_concordance.rb b/lib/sisu/v5/html_concordance.rb index 44a6cd69..51acabef 100644 --- a/lib/sisu/v5/html_concordance.rb +++ b/lib/sisu/v5/html_concordance.rb @@ -156,9 +156,10 @@ WOK else '' end < + + SiSU created WordIndex for: #{@md.title.full} diff --git a/lib/sisu/v5/html_format.rb b/lib/sisu/v5/html_format.rb index b8db9445..c34759cf 100644 --- a/lib/sisu/v5/html_format.rb +++ b/lib/sisu/v5/html_format.rb @@ -89,7 +89,7 @@ module SiSU_HTML_Format end end def id #w3c? "tidy" complains about numbers as identifiers ! annoying - (@ocn==nil || @ocn.empty?) ? '' : %{id="o#{@ocn}"} + (@ocn==nil || @ocn.empty?) ? '' : %{id="#{Mx[:ocn_id_char]}#{@ocn}"} end def goto (@ocn==nil || @ocn.empty?) ? '' : %{} @@ -173,9 +173,8 @@ module SiSU_HTML_Format SiSU_XML_Tags::RDF.new(md) end def doc_type - %{ -\n} + %{ +\n} end def table_close %{ @@ -414,6 +413,7 @@ WOK rdf=SiSU_XML_Tags::RDF.new(@md) %{#{doc_type} + #{@md.html_title} @@ -597,11 +597,7 @@ WOK #{@vz.credits_splash} #{@vz.credits_sisu} - - - - @@ -615,11 +611,7 @@ WOK #{@vz.credits_splash} #{@vz.credits_sisu} - - - - } end @@ -630,11 +622,7 @@ WOK #{@vz.credits_splash} #{@vz.credits_sisu} - - - - @@ -775,11 +763,7 @@ WOK #{@vz.credits_splash} #{@vz.credits_sisu} - - - - } end @@ -832,6 +816,7 @@ WOK rdf=SiSU_XML_Tags::RDF.new(@md) %{#{doc_type} + #{@seg_name_html[@seg_name_html_tracker]} - #{@md.html_title} @@ -841,9 +826,7 @@ WOK #{@stylesheet.css_head_seg} </head> #{@vz.color_body} -<a name="top" id="top"></a> -<a name="up" id="up"></a> -<a name="start" id="start"></a>} +<a name="top" id="top"></a>} end def title_banner(title,subtitle,creator) %{ diff --git a/lib/sisu/v5/html_manifest.rb b/lib/sisu/v5/html_manifest.rb index a31420ac..45ee2aae 100644 --- a/lib/sisu/v5/html_manifest.rb +++ b/lib/sisu/v5/html_manifest.rb @@ -888,10 +888,10 @@ WOK vz=SiSU_Viz::Defaults.new format_head_toc=SiSU_HTML_Format::HeadToc.new(@md) @manifest[:html] <<<<WOK -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> -<html xmlns="http://www.w3.org/1999/xhtml"> +<!DOCTYPE html> +<html> <head> +<meta charset="utf-8"> <title> SiSU manifest: #{@md.title.full} @@ -901,7 +901,7 @@ SiSU manifest: #{@md.title.full} #{@stylesheet.css_head} - + #{format_head_toc.seg_head_navigation_band(:manifest)} WOK if make.build.manifest_minitoc? diff --git a/lib/sisu/v5/html_segments.rb b/lib/sisu/v5/html_segments.rb index 0467a128..555b75bb 100644 --- a/lib/sisu/v5/html_segments.rb +++ b/lib/sisu/v5/html_segments.rb @@ -120,7 +120,7 @@ module SiSU_HTML_Seg << @seg[:idx] \ << '' # << '' elsif @type=='metadata' - metadata=SiSU_Metadata::Summary.new(@md).xhtml_display.metadata + metadata=SiSU_Metadata::Summary.new(@md).html_display.metadata @seg[:headings]=[] format_head_seg=SiSU_HTML_Format::HeadSeg.new(@md) if @title_banner_ diff --git a/lib/sisu/v5/se_css.rb b/lib/sisu/v5/se_css.rb index 378fece8..4d4713e1 100644 --- a/lib/sisu/v5/se_css.rb +++ b/lib/sisu/v5/se_css.rb @@ -169,21 +169,21 @@ module SiSU_CSS @file.path_rel_links.html_scroll_css \ + @env.path.style + '/' \ + @css.html - %{ } + %{ } end def html_seg stylesheet= @file.path_rel_links.html_seg_css \ + @env.path.style + '/' \ + @css.html - %{ } + %{ } end def html_tables stylesheet= @file.path_rel_links.html_seg_css \ + @env.path.style + '/' \ + @css.html - %{ } + %{ } end def xhtml_epub %{ } diff --git a/lib/sisu/v5/shared_metadata.rb b/lib/sisu/v5/shared_metadata.rb index 3a83d674..9f4f4362 100644 --- a/lib/sisu/v5/shared_metadata.rb +++ b/lib/sisu/v5/shared_metadata.rb @@ -829,6 +829,20 @@ WOK end self end + def html_display + def meta_para + inf_xml=char_enc(@inf).amp + inf_xml=char_enc(inf_xml).utf8 + inf_xml=char_enc(inf_xml).br + %{

+ #{@tag}: #{inf_xml} +

} + end + def metadata + SiSU_Metadata::Summary.new(@md,true).metadata_base + end + self + end def xml_sax def meta_para inf_xml=char_enc(@inf).utf8 diff --git a/lib/sisu/v6/cgi_sql_common.rb b/lib/sisu/v6/cgi_sql_common.rb index c6758685..a05f8f53 100644 --- a/lib/sisu/v6/cgi_sql_common.rb +++ b/lib/sisu/v6/cgi_sql_common.rb @@ -144,24 +144,23 @@ module SiSU_CGI_SQL end def header_desc <<-WOK_SQL - - + + - - SiSU search form (sample): SiSU information Structuring Universe - - - - - - + + <meta charset="utf-8"> + <meta name="sourcefile" content="SiSU._sst" /> + SiSU search form (sample): SiSU information Structuring Universe + + + + - +
-
+

SiSU @@ -544,11 +543,11 @@ module SiSU_CGI_SQL def tail <<-'WOK'

- +
-
+

SiSU diff --git a/lib/sisu/v6/defaults.rb b/lib/sisu/v6/defaults.rb index fb56a6d4..185e28e7 100644 --- a/lib/sisu/v6/defaults.rb +++ b/lib/sisu/v6/defaults.rb @@ -268,7 +268,7 @@ module SiSU_Viz end #% path def path_stylesheet_home - %{ } + %{ } end #% text #changed from txt to avoid naming conflicts #FOLLOW def txt_generator @@ -372,7 +372,7 @@ module SiSU_Viz end #% color def color_body - %{} + %{} end def color_white '"#ffffff"' @@ -450,7 +450,7 @@ module SiSU_Viz %{"#{color_white}"} end def color_body - %{} + %{} end def color_font_face #was font WATCH "#{color_black}" @@ -663,38 +663,38 @@ module SiSU_Viz 		' end def margin_txt_w1 - %{ + %{
  } end def margin_txt_w2 - %{ + %{
  } end def margin_txt_0 - %{ + %{
} end def margin_txt_1 - %{ + %{
} end def margin_txt_2 - %{ + %{
} end def margin_txt_3 - %{ + %{
} end def margin_css - ' + '
' end #% png @@ -790,8 +790,8 @@ module SiSU_Viz } end def banner_band #yellow_dark now white - %{ -
+ %{ +
#{png_home} @@ -800,11 +800,11 @@ module SiSU_Viz #{table_close}} end def banner_instrument_cover_band_scr - ' + '
' end def banner_instrument_cover_band_seg - ' + '
' end #% widget @@ -813,7 +813,7 @@ module SiSU_Viz end def widgets_open < + WOK end def widget_sisu_text @@ -941,7 +941,7 @@ WOK end def credits_sisu %{
-
+
#{widget_sisu}
} @@ -993,7 +993,7 @@ WOK - + diff --git a/lib/sisu/v6/harvest_authors.rb b/lib/sisu/v6/harvest_authors.rb index 0f375c00..e48c4f78 100644 --- a/lib/sisu/v6/harvest_authors.rb +++ b/lib/sisu/v6/harvest_authors.rb @@ -318,20 +318,20 @@ module SiSU_HarvestAuthors output_structure_by='(output organised by ?)' end < - + + + SiSU Metadata Harvest - Authors - + - + diff --git a/lib/sisu/v6/harvest_topics.rb b/lib/sisu/v6/harvest_topics.rb index aafc3755..2b80565e 100644 --- a/lib/sisu/v6/harvest_topics.rb +++ b/lib/sisu/v6/harvest_topics.rb @@ -688,20 +688,20 @@ module SiSU_HarvestTopics output_structure_by='(output organised by ?)' end < - + + + SiSU Metadata Harvest - Topics - + - + diff --git a/lib/sisu/v6/html.rb b/lib/sisu/v6/html.rb index 199770e7..014a81c5 100644 --- a/lib/sisu/v6/html.rb +++ b/lib/sisu/v6/html.rb @@ -335,10 +335,10 @@ module SiSU_HTML

-(relatively static) RSS feeds for DOCUMENTS:
-RSS feed http://www.jus.uio.no/lm/rssfeed/documents.xml
-RSS feed http://www.jus.uio.no/lm/rssfeed/tradelaw.xml
-RSS feed http://www.jus.uio.no/lm/rssfeed/environmental.xml
+(relatively static) RSS feeds for DOCUMENTS:
+RSS feed http://www.jus.uio.no/lm/rssfeed/documents.xml
+RSS feed http://www.jus.uio.no/lm/rssfeed/tradelaw.xml
+RSS feed http://www.jus.uio.no/lm/rssfeed/environmental.xml

info@address.com

@@ -383,7 +383,7 @@ WOK toc[:seg_mini]=format_toc.mini_lev0 title=if dob.ocn ==0 then linkname else - @@toc[:scr] << '
' + @@toc[:scr] << '
' %{#{linkname}} end txt_obj={ txt: title } @@ -425,7 +425,7 @@ WOK else linkname end else - @@toc[:scr] << '
' + @@toc[:scr] << '
' %{#{linkname}} end txt_obj={ txt: title } @@ -666,7 +666,7 @@ WOK @segtoc << "#{@vz.table_close*1}\n" tmp_head=nil if @md.prefix_a - tmp_head ||= %{

#{@md.prefix_a}\n} + tmp_head ||= %{

#{@md.prefix_a}\n} toc_shared << tmp_head.dup @segtoc << tmp_head.dup end diff --git a/lib/sisu/v6/html_concordance.rb b/lib/sisu/v6/html_concordance.rb index ce284e3f..54560aa2 100644 --- a/lib/sisu/v6/html_concordance.rb +++ b/lib/sisu/v6/html_concordance.rb @@ -136,7 +136,7 @@ module SiSU_Concordance @fnb=@md.fnb @lex_button=%{SiSU home -->} @doc_details =<

 

#{@md.title.full}

#{@md.author}

+
 

#{@md.title.full}

#{@md.author}

WOK @make=SiSU_Env::ProcessingSettings.new(@md) end @@ -156,9 +156,10 @@ WOK else '' end < + + SiSU created WordIndex for: #{@md.title.full} @@ -175,10 +176,10 @@ WOK #{toc}
#{@doc_details} -

Word index links are to html versions of the text the segmented version followed by the scroll (single document) version.
[For segmented text references [T1], [T2] or [T3] appearing without a link, indicates that the word appears in a title (or subtitle) of the text (that is identifiable by the appended object citation number).]

+

Word index links are to html versions of the text the segmented version followed by the scroll (single document) version.
[For segmented text references [T1], [T2] or [T3] appearing without a link, indicates that the word appears in a title (or subtitle) of the text (that is identifiable by the appended object citation number).]

(The word listing/index is Case sensitive: Capitalized words appear before lower case)

- word (number of occurences)
linked references to word within document
+ word (number of occurences)
linked references to word within document
[if number of occurences exceed number of references - word occurs more than once in at least one reference. Footnote/endnotes are either assigned to the paragraph from which they are referenced or ignored, so it is relevant to check the footnotes referenced from within a paragraph as well.]

diff --git a/lib/sisu/v6/html_format.rb b/lib/sisu/v6/html_format.rb index eb0745da..abefdf2f 100644 --- a/lib/sisu/v6/html_format.rb +++ b/lib/sisu/v6/html_format.rb @@ -74,7 +74,7 @@ module SiSU_HTML_Format else name=(@make.build.html_strict?) ? '' : %{ name="#{@ocn}"} @ocn.gsub(/^(\d+|)$/, - %{}) + %{}) end else '' @@ -89,7 +89,7 @@ module SiSU_HTML_Format end end def id #w3c? "tidy" complains about numbers as identifiers ! annoying - (@ocn==nil || @ocn.empty?) ? '' : %{id="o#{@ocn}"} + (@ocn==nil || @ocn.empty?) ? '' : %{id="#{Mx[:ocn_id_char]}#{@ocn}"} end def goto (@ocn==nil || @ocn.empty?) ? '' : %{} @@ -173,9 +173,8 @@ module SiSU_HTML_Format SiSU_XML_Tags::RDF.new(md) end def doc_type - %{ -\n} + %{ +\n} end def table_close %{ @@ -302,7 +301,7 @@ WOK

  #{@vz.table_close} -

} +

} else '' end end @@ -325,7 +324,7 @@ WOK #{doc_types} #{up_button} #{@vz.table_close} -

} +

} else '' end end @@ -355,7 +354,7 @@ WOK

 #{firstseg}  #{@vz.table_close} -

} +

} else '' end end @@ -411,20 +410,17 @@ WOK

} end def head - rdf=SiSU_XML_Tags::RDF.new(@md) %{#{doc_type} + #{@md.html_title} -#{rdf.metatag_html} #{@stylesheet.css_head} #{@vz.color_body} - - -} +} end def concordance if @md.concord_make @@ -513,7 +509,7 @@ WOK rights=SiSU_HTML_Tune::CleanHTML.new(@md.rights.all).clean_for_html rights=rights.gsub(/^\s*Copyright\s+\(C\)/,'Copyright © ') %{

Rights: #{rights}

-

} +

} end self end @@ -597,11 +593,7 @@ WOK #{@vz.credits_splash} #{@vz.credits_sisu} - - - - @@ -615,11 +607,7 @@ WOK #{@vz.credits_splash} #{@vz.credits_sisu} - - - - } end @@ -630,11 +618,7 @@ WOK #{@vz.credits_splash} #{@vz.credits_sisu} - - - - @@ -775,11 +759,7 @@ WOK #{@vz.credits_splash} #{@vz.credits_sisu} - - - - } end @@ -829,21 +809,18 @@ WOK } #revisit end def head_seg - rdf=SiSU_XML_Tags::RDF.new(@md) %{#{doc_type} + #{@seg_name_html[@seg_name_html_tracker]} - #{@md.html_title} - -#{rdf.metatag_html} + #{@stylesheet.css_head_seg} #{@vz.color_body} - - -} +} end def title_banner(title,subtitle,creator) %{ @@ -937,15 +914,9 @@ WOK and dob.tags.length > 0 # insert tags "hypertargets" dob.tags.each do |t| t=t.gsub(/[^a-z0-9._-]/,'') #use for all html tags? consider limiting to strict? or implementing earlier - if @make.build.html_strict? - tags=(t =~/^[#{Mx[:ocn_id_char]}]?[0-9.]+$/) \ - ? tags #check what can be sorted in ao - : (tags << %{}) - else - tags=(t =~/^[#{Mx[:ocn_id_char]}][0-9.]+$/) \ - ? tags #check what can be sorted in ao - : (tags << %{}) - end + tags=(t =~/^[0-9.]+$/) \ + ? tags #check what can be sorted in ao + : (tags << %{}) end end tags @@ -1038,7 +1009,7 @@ WOK end def heading_normal(tag,attrib) section_break=(tag=~/h[1-5]/) \ - ? '


' + ? '

' : '' %{#{section_break}
@@ -1196,13 +1167,13 @@ WOK
#{@txt} #{@two} -

} +

} end def navigation_toc_lev1 %{#{@banner.nav_toc}} end def navigation_toc_lev2 #change bold use css - %{

+ %{

@@ -1214,7 +1185,7 @@ WOK #{@vz.table_close}} end def navigation_toc_lev3 #change bold use css - %{

+ %{

diff --git a/lib/sisu/v6/html_lite_shared.rb b/lib/sisu/v6/html_lite_shared.rb index 7249ba31..dc54fdb9 100644 --- a/lib/sisu/v6/html_lite_shared.rb +++ b/lib/sisu/v6/html_lite_shared.rb @@ -104,7 +104,7 @@ module SiSU_FormatShared w=%{width="#{w}"} if w h=%{height="#{h}"} if h c=m[/"(.+?)"/m,1] - caption=%{

#{c}

} if c + caption=%{

#{c}

} if c png=m.scan(/\S+/)[0] ins=if u \ and u.strip !~/^image$/ @@ -265,7 +265,7 @@ GSUB parablock=parablock.gsub(//,'') @@tablehead=1 if parablock =~/#{Mx[:gr_o]}Th#{Mx[:tc_p]}/u parablock=parablock.gsub(/#{Mx[:gr_o]}Th?#{Mx[:tc_p]}.+?#{Mx[:tc_p]}~(\d+)#{Mx[:gr_c]}/, - %{
}) + %{
}) if parablock =~/#{Mx[:gr_o]}TZ#{Mx[:gr_c]}/ tablefoot=[] @@tablefoot.each {|x| tablefoot << %{

#{x}

\n}} diff --git a/lib/sisu/v6/html_manifest.rb b/lib/sisu/v6/html_manifest.rb index 036713e9..1ac7f4d4 100644 --- a/lib/sisu/v6/html_manifest.rb +++ b/lib/sisu/v6/html_manifest.rb @@ -158,7 +158,7 @@ module SiSU_Manifest if @o_str.dump_or_redirect? '' elsif src==:src #check - %{
#{@brace_url.xml_open}#{url}/#{file}#{@brace_url.xml_close}} + %{
#{@brace_url.xml_open}#{url}/#{file}#{@brace_url.xml_close}} else %{

#{@brace_url.xml_open}#{url}/#{file}#{@brace_url.xml_close}

} end @@ -265,7 +265,7 @@ module SiSU_Manifest end end def metadata(id,info) - info=info.to_s.gsub(/(?:#{Mx[:br_line]}|\\)+/,'
') + info=info.to_s.gsub(/(?:#{Mx[:br_line]}|\\)+/,'
') @manifest[:html] << %{\n} end def links(url,lnk,target) @@ -888,10 +888,10 @@ WOK vz=SiSU_Viz::Defaults.new format_head_toc=SiSU_HTML_Format::HeadToc.new(@md) @manifest[:html] <<< - + + + SiSU manifest: #{@md.title.full} @@ -901,7 +901,7 @@ SiSU manifest: #{@md.title.full} #{@stylesheet.css_head} - + #{format_head_toc.seg_head_navigation_band(:manifest)} WOK if make.build.manifest_minitoc? @@ -963,26 +963,26 @@ WOK       metadata suggested links (if any)

-

#{id}:

#{info}

+
WOK published_versions @manifest[:html] << '
' @manifest[:html] <<<#{@translate.manifest_description_output} - +
WOK output_tests @manifest[:html] << '

#{@translate.filetype_description}

#{@translate.filename}

#{@translate.file_size}

(kB)

' @manifest[:html] <<< + WOK source_tests @manifest[:html] << '
' @manifest[:html] <<<#{@translate.manifest_description_metadata} - +
WOK metadata_tests @@ -991,7 +991,7 @@ WOK WOK @manifest[:html] <<<#{@translate.suggested_links}:

-

#{@translate.metadata}

#{@translate.description}

+
WOK links_tests @manifest[:html] <<<#{@translate.language_version_list} -
+
WOK @@ -1009,7 +1009,7 @@ WOK

#{@translate.filename}

#{@translate.description}

 

-
+
#{vz.credits_sisu_manifest}
diff --git a/lib/sisu/v6/html_promo.rb b/lib/sisu/v6/html_promo.rb index a6f456ae..750add5c 100644 --- a/lib/sisu/v6/html_promo.rb +++ b/lib/sisu/v6/html_promo.rb @@ -145,7 +145,7 @@ module SiSU_HTML_Promo @prod['form'] ? %{

#{@prod['form']}

} : '' end def nick - @prod['nick'] ? %{(#{@prod['nick']})
} : '' + @prod['nick'] ? %{(#{@prod['nick']})
} : '' end def update @prod['update'] ? %{

Updated: #{@prod['update']}

} : '' @@ -186,7 +186,7 @@ module SiSU_HTML_Promo else nil end form=if action - '
' + @env.widget.search_form('hyperestraier',action,'',table) + '
' + @env.widget.search_form('hyperestraier',action,'',table) else '' end form @@ -208,7 +208,7 @@ module SiSU_HTML_Promo end end def image - @prod['image'] ? %{
} : '' + @prod['image'] ? %{
} : '' end def url_link @url_=if @prod['url'] =~/https?:/ @@ -296,7 +296,7 @@ module SiSU_HTML_Promo def output_form_sponsor(type,id) cell=cell(@ad[:promo][type][id],prod_id) <<-WOK -
+
#{cell.site_link} #{cell.blurb} #{cell.links} @@ -306,7 +306,7 @@ module SiSU_HTML_Promo prod_id=id.gsub(/id_/,'') cell=cell(@ad[:promo][type][id],prod_id) < +
#{cell.site_link} #{cell.author} #{cell.year} @@ -330,7 +330,7 @@ WOK prod_type=((id=~/id_(?:[0-9x]){10,13}/i) ? 'isbn' : 'id') id_detail=%{

#{prod_type}: #{prod_id}

} < +
#{cell.site_link} #{cell.author} #{cell.year} @@ -346,7 +346,7 @@ WOK prod_id=id.gsub(/id_/,'') cell=cell(@ad[:promo][type][id],prod_id) < +
#{cell.site_link} #{cell.editor} #{cell.issn} @@ -363,7 +363,7 @@ WOK cell=cell(@ad[:promo][type][id],prod_id) #translate date (dd month yyyy) from 2007-03-04 and ruby conversion < +
#{cell.site_link} #{cell.date} #{cell.location} diff --git a/lib/sisu/v6/html_scroll.rb b/lib/sisu/v6/html_scroll.rb index 1415c585..f6a1115c 100644 --- a/lib/sisu/v6/html_scroll.rb +++ b/lib/sisu/v6/html_scroll.rb @@ -134,7 +134,7 @@ module SiSU_HTML_Scroll end elsif dob.is==:break \ and dob.from==:markup - '

' + '

' elsif dob.is==:heading_insert x=if dob.ln==0 unless dob.obj.empty? diff --git a/lib/sisu/v6/html_segments.rb b/lib/sisu/v6/html_segments.rb index 47fe9d14..54b0b124 100644 --- a/lib/sisu/v6/html_segments.rb +++ b/lib/sisu/v6/html_segments.rb @@ -120,7 +120,7 @@ module SiSU_HTML_Seg << @seg[:idx] \ << '' # << '' elsif @type=='metadata' - metadata=SiSU_Metadata::Summary.new(@md).xhtml_display.metadata + metadata=SiSU_Metadata::Summary.new(@md).html_display.metadata @seg[:headings]=[] format_head_seg=SiSU_HTML_Format::HeadSeg.new(@md) if @title_banner_ @@ -443,7 +443,7 @@ module SiSU_HTML_Seg @@seg[:tocband_banner] \ << format_head_seg.navigation_band(@@segtocband,@@seg[:dot_nav]) @@seg[:tocband_bannerless] \ - << '
' \ + << '
' \ << format_head_seg.navigation_band_bottom(@@segtocband,@@seg[:dot_nav]) if @title_banner_ @@seg[:headings] \ @@ -570,7 +570,7 @@ module SiSU_HTML_Seg sto.table elsif dob.is==:break \ and dob.from==:markup - '

' + '

' end if @md.flag_separate_endnotes dob.obj=dob.obj.gsub(/"\s+href="#(#{Mx[:note]}\d+)">/,%{" href=\"endnotes#{Sfx[:html]}#\\1">}) #endnote- twice #removed file type diff --git a/lib/sisu/v6/html_tune.rb b/lib/sisu/v6/html_tune.rb index 7ce62bfc..b655b7d1 100644 --- a/lib/sisu/v6/html_tune.rb +++ b/lib/sisu/v6/html_tune.rb @@ -65,7 +65,7 @@ module SiSU_HTML_Tune @@line_mode='' @@endnote_array=[] @@endnote_call_counter=1 - @@table_align=' + @@table_align='
 \; ' @@ -119,7 +119,7 @@ module SiSU_HTML_Tune end str=str.gsub(/#{Mx[:gl_o]}(#[0-9]{3})#{Mx[:gl_c]}/u,'&\1;'). gsub(/#{Mx[:gl_o]}#([a-z]{2,4})#{Mx[:gl_c]}/u,'&\1;'). - gsub(/[\\]{2}/m,'
') + gsub(/[\\]{2}/m,'
') end end class Tune @@ -187,7 +187,7 @@ module SiSU_HTML_Tune w=%{width="#{w}"} if w h=%{height="#{h}"} if h c=m[/"(.+?)"/m,1] - caption=%{

#{c}

} if c + caption=%{

#{c}

} if c png=m.scan(/\S+/)[0] image_path=@md.file.output_path.html_seg.rel_image #image_path=(@md.fns =~/\.-ss[tm]$/) \ @@ -277,7 +277,7 @@ module SiSU_HTML_Tune def markup(dob) dob.obj=dob.obj.gsub(/#{Mx[:mk_o]}#([a-zA-Z]+)#{Mx[:mk_c]}/,'&\1;'). gsub(/#{Mx[:mk_o]}(#[0-9]+)#{Mx[:mk_c]}/,'&\1;') - dob.obj=dob.obj.gsub(/#{Mx[:br_line]}|#{Mx[:br_nl]}/,'
') unless dob.is==:table + dob.obj=dob.obj.gsub(/#{Mx[:br_line]}|#{Mx[:br_nl]}/,'
') unless dob.is==:table dob.obj=dob.obj.gsub(/#{Mx[:fa_bold_o]}(.+?)#{Mx[:fa_bold_c]}/,'\1'). gsub(/#{Mx[:fa_italics_o]}(.+?)#{Mx[:fa_italics_c]}/,'\1'). gsub(/#{Mx[:fa_underscore_o]}(.+?)#{Mx[:fa_underscore_c]}/,'\1'). diff --git a/lib/sisu/v6/se_css.rb b/lib/sisu/v6/se_css.rb index fed9c571..a83d13ca 100644 --- a/lib/sisu/v6/se_css.rb +++ b/lib/sisu/v6/se_css.rb @@ -169,21 +169,21 @@ module SiSU_CSS @file.path_rel_links.html_scroll_css \ + @env.path.style + '/' \ + @css.html - %{ } + %{ } end def html_seg stylesheet= @file.path_rel_links.html_seg_css \ + @env.path.style + '/' \ + @css.html - %{ } + %{ } end def html_tables stylesheet= @file.path_rel_links.html_seg_css \ + @env.path.style + '/' \ + @css.html - %{ } + %{ } end def xhtml_epub %{ } diff --git a/lib/sisu/v6/shared_metadata.rb b/lib/sisu/v6/shared_metadata.rb index 182acde1..998c48df 100644 --- a/lib/sisu/v6/shared_metadata.rb +++ b/lib/sisu/v6/shared_metadata.rb @@ -829,6 +829,20 @@ WOK end self end + def html_display + def meta_para + inf_xml=char_enc(@inf).amp + inf_xml=char_enc(inf_xml).utf8 + inf_xml=char_enc(inf_xml).br + %{

+ #{@tag}: #{inf_xml} +

} + end + def metadata + SiSU_Metadata::Summary.new(@md,true).metadata_base + end + self + end def xml_sax def meta_para inf_xml=char_enc(@inf).utf8 diff --git a/lib/sisu/v6/xhtml_epub2.rb b/lib/sisu/v6/xhtml_epub2.rb index 245050a1..af796cbe 100644 --- a/lib/sisu/v6/xhtml_epub2.rb +++ b/lib/sisu/v6/xhtml_epub2.rb @@ -850,7 +850,7 @@ module SiSU_XHTML_EPUB2 - +
-- cgit v1.2.3 From aa2ad4de2a9d9234f626a05b4b0fc42d9539d8c2 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Fri, 3 Oct 2014 19:33:25 -0400 Subject: documentation, minor (on --act) --- README | 10 +++++----- data/doc/sisu/markup-samples/manual/en/sisu_commands.sst | 4 ++-- man/man1/sisu.1 | 11 ++++++----- 3 files changed, 13 insertions(+), 12 deletions(-) diff --git a/README b/README index e2a83b96..51d49f7d 100644 --- a/README +++ b/README @@ -242,12 +242,11 @@ assumed for most other flags, creates new intermediate files for processing processing of other output. This step is assumed for most processing flags. To skip it see -n. Alias -m. -*--act[0-9] [filename/wildcard]* +*--act[s0-9] [filename/wildcard]* --act0 to --act9 configurable shortcuts for multiple flags, -0 to -9 synonyms, -configure in sisurc.yml, sisu default action on a specified file where no flag -is provided is --act0, current default setting for --act0 is --digest --qrcode ---text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax ---xml-dom --sqlite --manifest --verbose +configure in sisurc.yml; sisu default action on a specified file where no flag +is provided is --act0; --act or --acts for information on current actions +ascribed to --act0 to --act9 *--asciidoc [filename/wildcard]* asciidoc, smart text (not available) @@ -906,6 +905,7 @@ minimal content/structure requirement: [metadata] A~ (level A [title]) + 1~ (at least one level 1 [segment/(chapter)]) structure rules (document heirarchy, heading levels): 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 31f1d7a0..3bf24cad 100644 --- a/data/doc/sisu/markup-samples/manual/en/sisu_commands.sst +++ b/data/doc/sisu/markup-samples/manual/en/sisu_commands.sst @@ -44,8 +44,8 @@ see --act 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 command:abstract objects|document abstraction|--ao|--dal|-m (document abstraction) } -!_ --act[0-9] [filename/wildcard] \\ ---act0 to --act9 configurable shortcuts for multiple flags, -0 to -9 synonyms, configure in sisurc.yml, sisu default action on a specified file where no flag is provided is --act0, current default setting for --act0 is --digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --sqlite --manifest --verbose +!_ --act[s0-9] [filename/wildcard] \\ +--act0 to --act9 configurable shortcuts for multiple flags, -0 to -9 synonyms, configure in sisurc.yml; sisu default action on a specified file where no flag is provided is --act0; --act or --acts for information on current actions ascribed to --act0 to --act9 ={ SiSU command:multiple instruction shortcut|--act } !_ --asciidoc [filename/wildcard] \\ diff --git a/man/man1/sisu.1 b/man/man1/sisu.1 index 001b723b..e0f63624 100644 --- a/man/man1/sisu.1 +++ b/man/man1/sisu.1 @@ -137,12 +137,11 @@ assumed for most other flags, creates new intermediate files for processing processing of other output. This step is assumed for most processing flags. To skip it see -n. Alias -m. .TP -.B --act[0-9] [filename/wildcard] +.B --act[s0-9] [filename/wildcard] --act0 to --act9 configurable shortcuts for multiple flags, -0 to -9 synonyms, -configure in sisurc.yml, sisu default action on a specified file where no flag -is provided is --act0, current default setting for --act0 is --digest --qrcode ---text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax ---xml-dom --sqlite --manifest --verbose +configure in sisurc.yml; sisu default action on a specified file where no flag +is provided is --act0; --act or --acts for information on current actions +ascribed to --act0 to --act9 .TP .B --asciidoc [filename/wildcard] asciidoc, smart text (not available) @@ -959,6 +958,8 @@ minimal content/structure requirement: [metadata] .nf A~ (level A [title]) + +1~ (at least one level 1 [segment/(chapter)]) .fi -- cgit v1.2.3