From 58c37322bd487ed28c4604340f82b1e7769e8666 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Mon, 9 Nov 2020 18:42:38 -0500 Subject: nixify (start to nixify) --- .envrc | 13 + .gitignore | 1 + CHANGELOG | 17 +- CHANGELOGS/CHANGELOG | 1 + README | 27 +- data/doc/sisu/CHANGELOG | 9547 +++++++++++++++++++++++++++++++++++++ lib/sisu/sisu_thor_lib.rb | 52 + nix/pkglst/packages.nix | 13 + nix/pkglst/packages_rauby_2_6.nix | 13 + nix/pkglst/packages_rauby_2_7.nix | 13 + org/sisu_build.org | 6000 +++++++++++++++++++++++ qi | 13 +- setup/qi_libs.rb | 8 +- setup/rbuild | 14 +- setup/rbuild_help.rb | 1 - setup/rbuild_libs.rb | 4 +- shell.nix | 6 + 17 files changed, 15691 insertions(+), 52 deletions(-) create mode 100644 .envrc mode change 100644 => 120000 CHANGELOG create mode 120000 CHANGELOGS/CHANGELOG create mode 100644 data/doc/sisu/CHANGELOG create mode 100644 nix/pkglst/packages.nix create mode 100644 nix/pkglst/packages_rauby_2_6.nix create mode 100644 nix/pkglst/packages_rauby_2_7.nix create mode 100644 org/sisu_build.org mode change 100644 => 100755 setup/rbuild create mode 100644 shell.nix diff --git a/.envrc b/.envrc new file mode 100644 index 00000000..dd2752c9 --- /dev/null +++ b/.envrc @@ -0,0 +1,13 @@ +if type lorri &>/dev/null; then + echo "direnv: using lorri from PATH ($(type -p lorri))" + eval "$(lorri direnv)" +else + # fall back to using direnv's builtin nix support + # to prevent bootstrapping problems. + use nix + NIX_ENFORCE_PURITY=0 +fi +# source an additional user-specific .envrc in ./.envrc-local +if [ -e .envrc-local ]; then + source .envrc-local +fi diff --git a/.gitignore b/.gitignore index 7ec72f9a..321ba4a7 100644 --- a/.gitignore +++ b/.gitignore @@ -9,6 +9,7 @@ *.gem *.gemspec !.gitignore +!.envrc *_.rb *.rb_ .pc diff --git a/CHANGELOG b/CHANGELOG deleted file mode 100644 index 87616dc5..00000000 --- a/CHANGELOG +++ /dev/null @@ -1,16 +0,0 @@ -* for CHANGELOGS - * in program directory tree see ./CHANGELOGS/* (softlinks to:) - files in ./data/doc/sisu/ - ./data/doc/sisu/CHANGELOG_v* - * installed to /usr/share/doc/sisu/* - -* sisu source: - - -* ./debian/changelog (in debian/sid branch) - -* README -* ./data/doc/sisu/org/sisu.org - -* sisu-markup-samples source: - diff --git a/CHANGELOG b/CHANGELOG new file mode 120000 index 00000000..f360c4bb --- /dev/null +++ b/CHANGELOG @@ -0,0 +1 @@ +./data/doc/sisu/CHANGELOG \ No newline at end of file diff --git a/CHANGELOGS/CHANGELOG b/CHANGELOGS/CHANGELOG new file mode 120000 index 00000000..46d7caf6 --- /dev/null +++ b/CHANGELOGS/CHANGELOG @@ -0,0 +1 @@ +../data/doc/sisu/CHANGELOG \ No newline at end of file diff --git a/README b/README index 8997b7fc..2d1e9825 100644 --- a/README +++ b/README @@ -31,8 +31,7 @@ manifests of generated output. Book indexes may be made. Some document markup samples are provided in the package sisu -markup-samples. Homepages: -* -* +- INSTALL OR RUN WITHOUT INSTALLATION *********************************** @@ -907,11 +906,11 @@ All paragraphs are separated by an empty line. Markup is comprised of: -* at the top of a document, the document header made up of semantic meta-data +- at the top of a document, the document header made up of semantic meta-data about the document and if desired additional processing instructions (such an instruction to automatically number headings from a particular level down) -* followed by the prepared substantive text of which the most important single +- followed by the prepared substantive text of which the most important single characteristic is the markup of different heading levels, which define the primary outline of the document structure. Markup of substantive text includes: @@ -973,22 +972,22 @@ text * if C~ is last used: C~ or B~; if D~ is used: D~, C~ or B~) -* 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 +- 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 +- 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~ +- 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 +- 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 +- 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 @@ -1307,7 +1306,7 @@ _2* bullet text, two step indent *resulting output:* -* bullet text +- bullet text * bullet text, first indent @@ -1675,7 +1674,7 @@ Very active contributors*** | 0| 31| 190| 692| 1,6 No. of English language articles| 25| 16,000| 101,000| 190,000| 320,000| 630,000 No. of articles, all languages | 25| 19,000| 138,000| 490,000| 862,000|1,600,000 -* Contributed at least ten times; ** at least 5 times in last month; *** more than 100 times in last month. +- Contributed at least ten times; ** at least 5 times in last month; *** more than 100 times in last month. *resulting output:* @@ -1683,7 +1682,7 @@ No. of articles, all languages | 25| 19,000| 138,000| 490,000| 862,0 ┆Jan. 2001┆Jan. 2002┆Jan. 2003┆Jan. 2004┆July 2004┆June 2006』Contributors*┆10┆472┆2,188┆9,653┆25,011┆48,721』Active contributors**┆9┆212┆846┆3,228┆8,442┆16,945』Very active contributors***┆0┆31┆190┆692┆1,639┆3,016』No. of English language articles┆25┆16,000┆101,000┆190,000┆320,000┆630,000』No. of articles, all languages┆25┆19,000┆138,000┆490,000┆862,000┆1,600,000』 -* Contributed at least ten times; ** at least 5 times in last month; *** more +- Contributed at least ten times; ** at least 5 times in last month; *** more than 100 times in last month. diff --git a/data/doc/sisu/CHANGELOG b/data/doc/sisu/CHANGELOG new file mode 100644 index 00000000..c78eb12e --- /dev/null +++ b/data/doc/sisu/CHANGELOG @@ -0,0 +1,9547 @@ +version & changelog, tag for release +2019-09-03 ralph@amissah.com +fc418a65 (tag: sisu_7.2.0) + +qi_libs.rb helper, force git version tag when tag requested +2019-09-03 ralph@amissah.com +e98d9586 + +re-introduce depreciated markup for numbering codeblocks +2019-09-02 ralph@amissah.com +682f7207 + +markup modification: code blocks attributes, numberlines +2019-09-02 ralph@amissah.com +7ad03241 + +re-introduce depreciated table markup for table attributes +2019-08-28 ralph@amissah.com +e4af625f + +markup modification: table attributes +2019-08-28 ralph@amissah.com +172c0417 + +markup modification: distinguish blocks and groups +2019-08-28 ralph@amissah.com +480ff5a4 +- use where appropriate instead of poem + +version & changelog, open commit window +2019-08-28 ralph@amissah.com +cb1f7d55 + +version & changelog, tag for release +2019-07-16 ralph@amissah.com +444465c1 (tag: sisu_7.1.12, origin/upstream) + +texpdf, indent values, use formula (to replace table) +2019-07-16 ralph@amissah.com +38f77adf +- values changed to work better with portrait a4 & letter + +changelogs cosmetic substitution (org-mode) +2019-07-16 ralph@amissah.com +df3dbe03 + +version & changelog, open commit window +2019-07-16 ralph@amissah.com +888aace2 + +version & changelog, tag for release +2017-07-14 ralph@amissah.com +daba1068 (tag: sisu_7.1.11) + +--no-metadata turns off appending metadata to doc +2017-07-14 ralph@amissah.com +486a84f9 +- (Closes: #746742) + "please implement --no-metadata similar to --no-manifest" + +html, minitoc, default off +2017-07-14 ralph@amissah.com +90e27c85 +- default where no instruction given changed to false + (requested, as minitoc is sub-optimal for viewing with + smaller devices (when present minitoc is placed on left + part of screen together with content to its right)) + +version & changelog, open commit window +2017-07-14 ralph@amissah.com +ff31523b + +version & changelog, tag for release +2017-07-02 ralph@amissah.com +71d9615c (tag: sisu_7.1.10) + +texpf_format (debian texlive packages for usepackage .sty) +2017-07-02 ralph@amissah.com +55df651b +- update notes + +sisu.vim (syntax highlighting) back reference related fix +2017-07-02 ralph@amissah.com +63825bdc +- provided by Bram Moolenaar + +version & changelog, open commit window +2017-07-02 ralph@amissah.com +e4d9cabb + +version & changelog, tag for release +2016-07-31 ralph@amissah.com +ab9d0a0a (tag: sisu_7.1.9) + +html css, (root) heading size +2016-07-31 ralph@amissah.com +c3c2422a + +version & changelog, open commit window +2016-07-31 ralph@amissah.com +5b9b6b73 + +version & changelog, tag for release +2016-02-26 ralph@amissah.com +eea0f68f (tag: sisu_7.1.8) + +json, an output representation, first pass +2016-02-24 ralph@amissah.com +ee91e628 + +txt_orgmode, update (dp add email header field) +2016-02-21 ralph@amissah.com +3c8723a4 + +sisu.org add to header and minor update +2016-02-21 ralph@amissah.com +c558a2b2 + +sisu-mode.el 7.1.8 as committed to Gnu elpa +2016-02-20 ralph@amissah.com +aed0c99e +- submissions with much feedback from Stefan Monnier +- 2016-02-22 + +header hyperlink delimiters, now square brackets +2016-02-12 ralph@amissah.com +feffc6a1 + +headers, year set 2016 +2016-02-09 ralph@amissah.com +6532732d + +version & changelog, open commit window +2016-02-09 ralph@amissah.com +05757bab + +version & changelog, tag for release +2016-01-05 ralph@amissah.com +c716980a (tag: sisu_7.1.7) + +sisu-mode.el, tic block markup, and minor arrangement +2015-12-29 ralph@amissah.com +804502e6 +- moves outline-regexp +- adjustment to autoload list + +sisu-mode.el apply patch from Kevin Ryde of 2015-12-18 +2015-12-29 ralph@amissah.com +a6a3601e + +version & changelog, open commit window +2015-12-29 ralph@amissah.com +f4963b4c + +version & changelog, tag for release +2015-12-15 ralph@amissah.com +96ace838 (tag: sisu_7.1.6) + +ao_images, require 'rmagick' (instead of 'RMagick' depreciated) +2015-12-14 ralph@amissah.com +07970cd9 + +filename reference version update sisu_7a_sqlite.cgi +2015-12-14 ralph@amissah.com +86cf7cf3 + +documentation related to search, needs further review +2015-12-14 ralph@amissah.com +bc2b328e + +emacs sisu-mode.el match tic style markup blocks ``` (revisit required) +2015-12-14 ralph@amissah.com +9664f4d7 + +emacs sisu-mode.el & sisu-mode-autoloads.el +2015-12-14 ralph@amissah.com +923d361c +- sisu-mode.el, minor update and modify format to reduce diff with FSF + version +- sisu-mode-autoloads.el, added (see elpa 3.0.3 & Kevin Ryde recent post) + +version & changelog, open commit window +2015-12-14 ralph@amissah.com +3c0ac733 + +version & changelog, tag for release +2015-06-02 ralph@amissah.com +f3a5e917 (tag: sisu_7.1.5) + +minor clean, a file removed +2015-06-02 ralph@amissah.com +c0b6f1bc + +version & changelog, open commit window +2015-06-02 ralph@amissah.com +5640ed78 + +version & changelog, tag for release +2015-05-21 ralph@amissah.com +a79af026 (tag: sisu_7.1.4) + +constants, search, db name, period before and after db version +2015-05-20 ralph@amissah.com +0a971e44 (tag: sisu_7.1.3) +- aesthetic change, the current db name base becomes SiSU.7a. +- existing databases must be reinitialized +- (database structure is unchanged) + +date, some remaining year updates 2015 +2015-05-21 ralph@amissah.com +53e47913 + +version & changelog, open commit window +2015-05-20 ralph@amissah.com +a271416b + +version & changelog, tag for release +2015-05-18 ralph@amissah.com +17f9306b (tag: sisu_7.1.2) + +bin/sisu juggle multiple install & run options, resolve issue +2015-05-18 ralph@amissah.com +8b1af126 + +version & changelog, open commit window +2015-05-18 ralph@amissah.com +4b49cafb + +version & changelog, tag for release +2015-05-17 ralph@amissah.com +4748a2ee (tag: sisu_7.1.1) + +qi pkg manage changelog +2015-05-17 ralph@amissah.com +5ccf1584 + +bin/sisu juggle multiple install & run options +2015-05-17 ralph@amissah.com +d020a0bd + +qi (quick install) gem install version +2015-05-17 ralph@amissah.com +9979682d + +qi (quick install) gem install git version option +2015-05-17 ralph@amissah.com +164ba294 + +bin/sisu , install name check (stable & git versions) +2015-05-17 ralph@amissah.com +6217cf0e + +version & changelog, open commit window +2015-05-17 ralph@amissah.com +e58fbdc6 + +version & changelog, tag for release +2015-05-12 ralph@amissah.com +02d744a3 (tag: sisu_7.1.0) + +documentation update !bibliography & !glossary +2015-05-12 ralph@amissah.com +ab31d70b + +appendices: bibliography & glossary, worked on +2015-05-11 ralph@amissah.com +40b83047 +- bibliography & glossary make activated by markup headers + 1~!biblio & 1~!glossary +- bibliography tags altered + (introduced in 5.8.0 v6 project dir branch) +- version bump for change in behavior + +ao_references, fix +2015-05-11 ralph@amissah.com +c606ff1a + +qi (quick install) cleaning +2015-05-06 ralph@amissah.com +ee8b3b22 + +changelogs, clean up some cruft +2015-05-13 ralph@amissah.com +98461acf + +version & changelog +2015-05-05 ralph@amissah.com +fba0e3e4 + +version & changelog, tag for release +2015-05-01 ralph@amissah.com +c0f6a9e6 (tag: sisu_7.0.0) + +documentation, reflect absence of version directory branches +2015-05-01 ralph@amissah.com +6ca9586a + +lib/sisu/*, single libs directory (c&d gone) (7) +2015-04-21 ralph@amissah.com +960c3088 +- removed lib/sisu/{current,develop} dir branches + v7 (v5 & v6 retired) +- simplify dir structure, offer single version per snapshot +- have enjoyed carrying stable and development versions v5 & v6 + in a single tarball, may return to this structure + +version & changelog v7 +2015-04-20 ralph@amissah.com +4e86b5cc +- version info changes cause break, fixed in next commit + +version & changelog, tag for release +2015-04-21 ralph@amissah.com +1b360ea3 (tag: sisu_6.5.0) + +d: v6 made default branch (prior to v7 dir restructuring) +2015-04-21 ralph@amissah.com +2ade55a3 +- v5 invocation available as legacy, but is the same as v6 +- qi_libs, gem metadata, minor +- sisu_packaging.org: ruby require list; update sisu description +- bin/ chmod 755 + +c<-d: sync, roll develop into current dir branch (5==6) +2015-04-19 ralph@amissah.com +1323f18a +- two dir branches, same library contents + (v5 synced & updated with v6) + +setup.rb s/Config/RbConfig/ +2015-04-29 ralph@amissah.com +0de7dc34 + +gitignore adjustments +2015-04-30 ralph@amissah.com +caa1ddce + +c&d: version & changelog +2015-04-20 ralph@amissah.com +4706c1ff + +version & changelog, tag for release +2015-04-21 ralph@amissah.com +e0edf0e7 (tag: sisu_5.8.0) + +c&d: se_info_env, program images path +2015-04-21 ralph@amissah.com +6b914403 + +c: hub options, fix +2015-04-21 ralph@amissah.com +b2ff4e77 + +qi libs, minor, remove debian specific url +2015-04-21 ralph@amissah.com +2f5043b9 + +sisu.org git download info +2015-04-21 ralph@amissah.com +55cfe3bb + +gitignore adjustments +2015-04-21 ralph@amissah.com +ae273564 + +d: hub, if run from dir tree check git describe version info +2015-04-12 ralph@amissah.com +0ec4b394 + +bin/sisu when run from dir tree, check git describe version info +2015-04-12 ralph@amissah.com +d0ad76e3 + +documentation, acquiring source & installation, minor +2015-04-10 ralph@amissah.com +09497963 + +install related, qi (quick install) & rake +2015-04-10 ralph@amissah.com +490b3717 + +qi (quick install) fix +2015-04-08 ralph@amissah.com +72fbfab2 + +sisu packaging notes +2015-04-06 ralph@amissah.com +096c8888 + +sisu.org, prevent subscripting (by underscore) mangles file paths +2015-04-06 ralph@amissah.com +28c21059 + +c&d: sort image path when run from project dir (not installed) +2015-04-06 ralph@amissah.com +7ae4b455 + +c&d: pass info needed make run better without install +2015-04-06 ralph@amissah.com +906634e9 + +c&d: se_programs for "which" i/o redirection of error message +2015-04-06 ralph@amissah.com +8f28f4c4 + +d: ao_doc_objects fix for ao_doc_str +2015-04-07 ralph@amissah.com +aa72429a + +c&d: cleaning +2015-04-06 ralph@amissah.com +16615136 + +gitignore, minor adjustment +2015-04-06 ralph@amissah.com +8a8d7146 + +documentation update to mention bibliography +2015-03-22 ralph@amissah.com +28203ded + +d: bibliography marked up section of citations & metadata +2015-03-19 ralph@amissah.com +e7ce21ab +- if any order is as follows: endnotes; bibliography; index +- to trigger, identify the bibliography section using heading + 1~biblio +- and either: + - provide tagged bibliography at end of document, along with + an id for use in footnotes & the short title that should + be used to substitute the id + or: + - tag citations in footnotes that should appear in + bibliography +- bibliography currently sorted on last name year and title +- first pass (see documentation to be provided) + +d: ao & elsewhere, use of map & select +2015-03-19 ralph@amissah.com +64dfdccb + +d: manifest add html ids to label/identify content +2015-03-22 ralph@amissah.com +aae3c4c1 + +d: manpage fix +2015-03-22 ralph@amissah.com +70cf530d + +c&d: ao regex matches, auto match possessives ending in 's +2015-03-19 ralph@amissah.com +24624902 +- header regex matches for bold & italics, auto match possessives + ending in 's + +c&d: misc, largely but not entirely cosmetic +2015-03-19 ralph@amissah.com +9a05bd6d + +gitignore, minor +2015-03-19 ralph@amissah.com +19d976c3 + +d: po4a, initialize either directly with sst or passed through ao +2015-01-15 ralph@amissah.com +45d6d69d +- creates source language directory with source markup files + (.sst .ssm .ssi) & the po4a.cfg configuration file, then runs + po4a to place the markup source under po4a translation + management +- --po4a-sst uses original sisu markup source as described above +- --po4a-ao passes sisu source markup through document abstraction + before converting back to a sisu markup source markup equivalent + of the original document, it does this in an attempt to get more + uniform output, and put footnotes for example if any in a form + that is easier to translate + --po4a-ao -v --trans-en:fr,es en/live-manual.ssm + --po4a-ao -v --trans-en:fr,es en/live-manual.ssm \ + es/live-manual.ssm + in the latter example also runs sisu marked up "es" document + through document abstraction and returns a sisu markup source + version of the document, and against this gettext is (or can be + run) to (attempt to) have the source and target languages + together in the po/es file +- all quite rough, will need to be revisited, +- these for now replace the renamed --po4a-shelf (formerly --po4a) + +d: po4a_shelf, shelf current po4a, change tack +2015-01-15 ralph@amissah.com +adf811ce + +d: po4a, provide po4a.cfg file +2015-01-13 ralph@amissah.com +6ae23165 + +bin/sisu-misc-utils + c&d: lib sisu_thor_lib currently only po4a +2015-01-12 ralph@amissah.com +b36588c9 +- uses po4a to create po files with empty translation strings +- in appropriately configured directory e.g. + "data/doc/sisu/markup-samples/manual" have file named: + "languages_source_and_targets" containing e.g.: + source: en + targets: de fr es ja ru zh + command examples: + ruby ~snx/bin/sisu-misc-utils po4a --next --clean + ruby ~snx/bin/sisu-misc-utils po4a --next --distclean + ruby ~snx/bin/sisu-misc-utils po4a --next --make + +sisu po4a ruby thor Rakefile equivalent (& cosmetic edit to qi) +2015-01-09 ralph@amissah.com +28097d45 + +d: utils_response, rely on module (remove class) extend module +2015-01-11 ralph@amissah.com +23a3bb79 +- update a couple of affected files + +d: utils_response, ease selection options +2015-01-11 ralph@amissah.com +127db380 + +bin/sisu + c&d: SiSU_is now methods (instead of hash) +2015-01-11 ralph@amissah.com +802bf61f + +bin + c&d: RbConfig (instead of Config, switch) +2015-01-12 ralph@amissah.com +b2ccc637 + +c&d: some cruft +2015-01-11 ralph@amissah.com +01ce3c47 + +d: composite documents (.ssm), extract insert files list +2015-01-11 ralph@amissah.com +16681920 + +d: po4a, continue reorganization (translation request dev stopped) +2014-12-31 ralph@amissah.com +a25c6408 +- --po4a run against different language versions of sisu markup + files (representing the same document in different languages) + initializes po4a structure to place those documents under future + po4a management +- includes command line translation request + (use command line program 'trans' to pass request to + translation.google.com, stopped for now) + NOTE in case future development is restarted: to test, remove + code line 'auto_translate?(:skip)' that follows + 'def auto_translation(src_txt,markup=:src)'; place identical + english sisu markup files in en/test.sst fr/test.sst (or under + the language code to be tested) and run against en/test.sst + fr/test.sst e.g. '--po4a --trans --glob test.sst' + this send identical text objects to translate.google using + 'trans' and populate po file with results for placing future + translation under po4a management, however in initial tests + insufficient cleanly translated paragraphs were returned, + so stopped development for now. (no attempt at initialization + of new non-existent files using --trans-en:es,fr,de format) +- [hub_options, if development of trans is pursued later consider + the possibility of modifying the --trans string options to add + an optional timeout value, &; possibly modifying po4a code so + timeout may occur a fixed number of times before skipping + translation request attempts for the remainder]. + +d: po4a, reorganize a bit +2014-12-30 ralph@amissah.com +dd224ef3 + +d: po4a, stub for auto-translate +2014-12-26 ralph@amissah.com +311c40ac +- intention (stub only, not implemented) + - '--po4a --trans --glob test.sst' run against + en/test.sst fr/test.sst + - '--po4a --trans-en:fr en/test.sst' + to send identical text objects to translate.google using 'trans' + and populate po file with results for placing future translation + under po4a management + +d: po4a, init, if lang src == translation, empty translation field +2014-12-26 ralph@amissah.com +f23af592 + +c&d: po4a, book index, reinstate +2014-12-26 ralph@amissah.com +7f0d5e93 + +c&d: po4a (& git) revisited, revisit +2014-12-25 ralph@amissah.com +059e3121 + +c&d: html, ocn link back to self reinstated +2015-01-07 ralph@amissah.com +881e80cc +- requested, used as quick means to get object url reference link +- d: removed ocn_html_identifier variable, unnecessary in html5 + (requirement previously forced by html4) + +c&d: small fixes +2014-12-24 ralph@amissah.com +8afb40ca + +sisu.org consider +2014-12-24 ralph@amissah.com +81c9e526 + +gitignore, ignore +2014-12-24 ralph@amissah.com +4b2eb9f8 +- another emacs tmp file pattern +- rb dev tmp backup files, should they ever exist ignore + +d: persist, address garbage collection issue, bug, fix +2014-12-11 ralph@amissah.com +7d8015c0 +- related to code related changes (re: "persistence") in + recent reorganization of txt, html, epub, xmls etc. + +c&d: html, output by filename, filenames, fix +2014-12-09 ralph@amissah.com +7d9281ca + +c&d, cgi, search form, html ref, remove leading o ocn, bugfix +2014-12-08 ralph@amissah.com +6bb4c19f +- in html (on use of html5), removed leading 'o' before ocn, not + reflected in generated cgi, sample search form, so, does not + jump to the (otherwise correctly) identified location + +d: xmls, reorganize, introduce new file +2014-11-23 ralph@amissah.com +58034303 + +d: epub, reorganize, introduce new file +2014-11-20 ralph@amissah.com +563195c1 + +d: html, segments, reorganize, introduce new file +2014-11-20 ralph@amissah.com +1625f316 + +d: orgmode, add orgmode structure output to txts +2014-11-20 ralph@amissah.com +a37a13fb + +d: txt outputs, reorganize, introduce new files +2014-11-20 ralph@amissah.com +e0fcd082 + +d: ao, rearrange, introduce new file +2014-11-21 ralph@amissah.com +da4985ca + +d: misc mostly minor +2014-11-20 ralph@amissah.com +802c3625 +- html endnote segment, heading endnote, link back to html scroll +- epub endnote segment fails, issue with match, fix +- dp, remark if no existing option selected + +d: in dp (param) project_details used instead of sisu_version +2014-12-06 ralph@amissah.com +64729704 + +d: track changes to sisu_version info +2014-12-06 ralph@amissah.com +1b77c140 + +c&d: version & branch info, changes related to move of lib dirs +2014-12-05 ralph@amissah.com +71badaf7 + +c&d: project dir structure, libs moved under new branch names +2014-11-26 ralph@amissah.com +4db4dcc8 +- libs & version files under new branch names: current & develop +- previously under branch version numbers (v5|v6) +- version .yml files moved +- associated adjustments made as required, notably to: + bin/sisu se* qi* (file headers); breakage potential, testing + required +- [on dir names, want release to (alphabetically) precede + next/development, considered (cur|dev) + (current|(dev|development|progress|next)) (stable|unstable), + alpha sorting fail (release|(next|develop))] + +v5 v6: code headers reformatted for viewing as org-mode files +2014-11-12 ralph@amissah.com +98c8c90b + +org files, minor editing +2014-12-04 ralph@amissah.com +17c8e964 + +org files related to sisu, break up and place in own subdir +2014-11-13 ralph@amissah.com +a0242f55 + +CHANGELOGS formatted for viewing as emacs org-mode files +2014-11-12 ralph@amissah.com +ce99ce59 +- indentation, line-breaking, and formatting characters only changes made + +sisu-mode.el emacs, outline mode "folding" for sisu +2014-11-20 ralph@amissah.com +2f2a1157 + +qi, (quick install) header update (also rbuild) +2014-11-13 ralph@amissah.com +1db1a6e8 + +year set 2015 (prepare for the new year) +2014-11-12 ralph@amissah.com +9c443e48 + +v5 v6: version & changelog (upstream "UnFrozen" early) +2014-11-12 ralph@amissah.com +fa762951 +- "UnFrozen" prior to original time intended (end of Debian Freeze + for Jessie), reason: the upstream bugfix 5.7.2 intended for + Jessie (packaged for Debian as 5.7.1-2) was not accepted; this + means even if another patch does get sent for Jessie, it will + not be from upstream branch) +- post Debian:Jessie development commits + +v5 v6: ao, composite documents, on --verbose report loading of .sst files, fix +2014-11-02 ralph@amissah.com +e206fef8 (tag: sisu_5.7.2) +- without fix sisu reports loading of .ssm & .ssi files but not .sst + (sub-documents are imported correctly and resulting document outputs are + correct and unaffected, but unless aware of this bug it would seem otherwise + until the correct operation of sisu was manually verified e.g. by examining + documents produced); (issue somewhat mitigated by not being the most common + sisu operation) +- sisu is in development freeze, this fix is provided for Debian Jessie + (Closes: #767761) + +v5 v6: version & changelog (Frozen: bugfix & documentation changes only) +2014-11-02 ralph@amissah.com +b6e6eb5c +- NOTE: sisu is in development freeze mirroring the Debian release cycle; + bugfix & documentation update only, pending the release of Debian Jessie +- (as sisu upstream) the cleanest git workflow solution to the Debian freeze + appears to be to follow the Debian freeze with respect to upstream alterations + of sisu (bugfix & documentation only), incrementing upstream version number + as usual, whilst building package as required for Debian freeze version of + sisu 5.7.1-* + +v5 v6: cgi, sample search form, find & display endnotes from parent text object +2014-10-19 ralph@amissah.com +18ee3095 (tag: sisu_5.7.1) +- remove dedicated endnote search section (as endnotes found & listed from + reference text field) +- cleaner search results + +v5 v6: db, text search & display field, footnotes moved to end of text object +2014-10-19 ralph@amissah.com +2c73f306 +- cleaner, more useful search results +- cleaner text search field +- separate footnote fields redundant for search purposes + +v5 v6: html_format, "id"s for objects & footnotes +2014-10-19 ralph@amissah.com +41ad83d4 + +v5 v6: html, remove trailing backslash for empty linebreak & paragraph,

+2014-10-19 ralph@amissah.com +84957a42 + +v5 v6: version & changelog (tidy & simplify, output related) +2014-10-19 ralph@amissah.com +0dd55e12 + +v5: merge v6: remove defaults.rb & some relics related to sisu skins +2014-10-12 ralph@amissah.com +32fd8f39 (tag: sisu_5.7.0) + +v6: '*_parts', remove defaults.rb & some relics related to sisu skins, long gone +2014-10-12 ralph@amissah.com +53b74bac +- old code removed & substituted as required by *_parts +- attending code changes, fairly wide ranging, test + +v5 v6: html, epub, set document body language +2014-10-12 ralph@amissah.com +71037059 + +v5 v6: html_format, label, re: object number object names +2014-10-12 ralph@amissah.com +b99857de + +v5 v6: constants, remove ocn html leader +2014-10-12 ralph@amissah.com +e2836810 +- resulting hashtag #1 instead of #o1 + +v5: html, reduce difference with v6 (mostly removal of bgcolor) +2014-10-12 ralph@amissah.com +46485232 +- note: html_format.rb has differences, else same + +v5: html, reduce difference with v6 (removal of some trailing slashes


) +2014-10-12 ralph@amissah.com +92b4747c + +v5 v6: moved files: harvest* to html_harvest* +2014-10-12 ralph@amissah.com +61b9cb50 + +v5 v6: bin/sisu, hub, urls --maintenance, fix +2014-10-12 ralph@amissah.com +1f0232a2 + +v5 v6: db, --maintenance sql, separated out postgresql & sqlite +2014-10-12 ralph@amissah.com +69d47638 +- could share "maintenance" db import sql file (as done previously), consider + +v5 v6: epub tune, --maintenance, fix +2014-10-12 ralph@amissah.com +ff3eb782 + +v5 v6: qrcode, sha call, fix +2014-10-12 ralph@amissah.com +2f0c9ef1 + +v5 v6: version & changelog +2014-10-12 ralph@amissah.com +758d2cbd + +documentation, minor (on --act) +2014-10-03 ralph@amissah.com +aa2ad4de (tag: sisu_5.6.9) + +v5 v6: html, tiny first nudge toward html5 (v5 v6 differ) +2014-10-03 ralph@amissah.com +14b5f964 +- document headers, other minor + +v5 v6: --act provides info on current --act0 to --act9 settings +2014-10-03 ralph@amissah.com +97864e99 +- makes it easier to make use of acts 0 to 9 + +v5 v6: cleaning, minor +2014-10-03 ralph@amissah.com +0bd17c97 + +sisu.org move stuff done to sisu-done.org +2014-10-03 ralph@amissah.com +3883915a + +v5 v6: version & changelog +2014-10-03 ralph@amissah.com +659b10c6 + +v5 v6: header comment reduction, minor +2014-09-28 ralph@amissah.com +ca70dde5 (tag: sisu_5.6.8) + +v5 v6: sql, clean searchable text +2014-09-28 ralph@amissah.com +33b94cc1 +- update for (ao/dal) text representation, fix legacy action + +v5 v6: manifest, renamed html_manifest +2014-09-28 ralph@amissah.com +558fe23f + +v5 v6: xml cosmetic code, minor +2014-09-28 ralph@amissah.com +4a794af5 + +qi (quick installer) minor +2014-09-28 ralph@amissah.com +a0736573 + +v5 v6: version & changelog +2014-09-28 ralph@amissah.com +7ee89296 + +touch dates +2014-09-19 ralph@amissah.com +cd3bd14c (tag: sisu_5.6.7) + +update urls to git repo +2014-09-19 ralph@amissah.com +bd5a9529 + +vim syntax, sisu.vim, update git url and email address +2014-09-14 ralph@amissah.com +61c58cee + +v5 v6: version & changelog +2014-09-14 ralph@amissah.com +52ad2abe + +v5 v6: ao, auto naming (segment & tag), exceptions, avoidance of name collisions +2014-09-12 ralph@amissah.com +165276e6 (tag: sisu_5.6.6) +- (i) auto naming attempts to extract a suitable numeric name from document + headings if available, at times one appears to be available but is re-used + elsewhere in the document, (as where the document has Parts or Sections and + naming starts again within these sections from 1); (ii) this is treated as an + exception and an alternative sequential naming scheme is triggered; (iii) if a + document heading does not provide a suitable numeric name, another sequential + scheme is used + +v5 v6: ao, feedback on markup document structure (heading level) errors +2014-09-12 ralph@amissah.com +47afa95b +- adjustment to (existing) provided feedback, based on: + - level A~ title, required; + - levels B~ C~ D~ optional sequential document divider headings + (Part, Section etc. equivalent); + - level 1~ required, heading level preceding substantive text; followed by + - levels 2~ 3~ 4~ optional, sequential headings + (1.1, 1.1.1, 1.1.1.1 equivalents) + +v5 v6: ao, expansion of links to internal filepaths (re: syntax based shortcut) +2014-09-12 ralph@amissah.com +5dce93cc +- expansion of sisu output filepaths (sync with use of --act0 to --act9) + +sisurc, update samples +2014-09-12 ralph@amissah.com +6e1e2b4d +- adjustments to default settings for --act0 to --act9 (to match current "se") +- removed sisurc examples to organize output by filetype, filename, monolingual, + as one word diff + output_dir_structure_by: language + # (language|filetype|(filetype_mono|monolingual)|filename|filename_mono) + # language + # (language and filetype directories); + # filetype + # (filetype directories, filename includes language code); + # filetype_mono (or monolingual) + # (filetype drectories, no language codes in filenames) + # filename + # (directory output similar to v1 v2, filename includes language code); + # filename_mono + # (directory output similar to v1 v2, filename without language code) + +v5 v6: se, processing, adjustments to default settings for --act0 to --act9 +2014-09-12 ralph@amissah.com +48e7c350 + +v5 v6: se, env, lingual: mono / multi, rc settings +2014-09-12 ralph@amissah.com +b1e7b97d + +v5 v6: hub, /tmp processing directory checks +2014-09-12 ralph@amissah.com +57f76ceb + +v5 v6: version & changelog +2014-09-12 ralph@amissah.com +64968ca1 + +v5 v6: ao_doc_str, if faulty document structure, stop; if --no-stop option, skip +2014-09-05 ralph@amissah.com +98066f7d (tag: sisu_5.6.5) + +v5 v6: ao_numbering, provide more information on duplicate numbering before stop +2014-09-05 ralph@amissah.com +cf1ec234 + +v5 v6: html navigation, enable turn off (nav buttons on remaining html segments) +2014-09-05 ralph@amissah.com +984b76e0 + +v5 v6: (for html) set default to navigation bar off +2014-09-05 ralph@amissah.com +57c8b068 + +v5 v6: xml xhtml outputs, & issues +2014-09-05 ralph@amissah.com +6a13e63f + +v5 v6: shared_metadata, requires xml_shared +2014-09-05 ralph@amissah.com +8422ce1d + +v5 v6: link/path fixes +2014-09-05 ralph@amissah.com +94cf89b0 +- manifest, link where no "document harvest" +- html, home button links url (remove slash) +- harvest_authors, by_filetype, manifest path + +v5 v6: version & changelog +2014-09-05 ralph@amissah.com +ec29e713 + +v5 v6: version, touch date +2014-09-01 ralph@amissah.com +c7da8f76 (tag: sisu_5.6.4) + +v5 v6: misc, for when external dependencies unmet +2014-09-01 ralph@amissah.com +48ed4030 + +v5 v6: cgi_sqlite, expansion of variable (default db name), double quotes, fix +2014-09-01 ralph@amissah.com +81c7c3ff + +v5 v6: version & changelog (& rakefile) +2014-08-30 ralph@amissah.com +062ca593 + +v5 v6: dp, texpdf, copyright_and_license, minor fix, used by texpdf +2014-08-29 ralph@amissah.com +90f6210f (tag: sisu_5.6.3) + +v5 v6: hub, sisu version info, when & what to report +2014-08-29 ralph@amissah.com +32d773a2 + +v5 v6: cosmetic code +2014-08-29 ralph@amissah.com +967a86f0 + +sisurc, minor +2014-08-29 ralph@amissah.com +91ac7214 + +qi, start using ruby-thor (for rake like tasks) +2014-08-29 ralph@amissah.com +7248e7c4 + +setup/ (start using) Rakefile Rantfile link to setup/rbuild +2014-08-29 ralph@amissah.com +1fe52e4d + +v5 v6: version & changelog (& rakefile) +2014-08-29 ralph@amissah.com +3e26d06f + +documentation related, sisu manual book index, and --no-stop command +2014-08-20 ralph@amissah.com +1508dff1 (tag: sisu_5.6.2) + +v5 v6: start making use of --no-stop command +2014-08-20 ralph@amissah.com +29fc7f3c + +v5 v6: hub options, introduce "error override" --no-stop or --errors-as-warnings +2014-08-20 ralph@amissah.com +0f1666f8 + +v5 v6: ao, book index related +2014-08-20 ralph@amissah.com +e1b6e755 + +v5 v6: ao_expand_insertions, blocked text match, adjust +2014-08-20 ralph@amissah.com +0fda4e96 + +v5 v6: texpdf, output, copyright & license +2014-08-20 ralph@amissah.com +766b4b6a + +vim, emacs, syntax hilighting, restrict heading matches, minor +2014-08-20 ralph@amissah.com +aa2a6060 + +v5 v6: cosmetic code +2014-08-20 ralph@amissah.com +6c757d01 + +rbuild, gem build a selected tagged sisu version +2014-08-20 ralph@amissah.com +38caf649 + +v5 v6: version & changelog (& rakefile) +2014-08-20 ralph@amissah.com +b62b612e + +v5 v6: hub, organisation & loose ends +2014-08-12 ralph@amissah.com +9680068e (tag: sisu_5.6.1) +- tweak triggers +- split file further +- remove mod + +v5 v6: webrick, wb.cgi fixed & omitted/(use discarded) +2014-08-12 ralph@amissah.com +f6ad6569 + +v5 v6: version & changelog (& rakefile) +2014-08-12 ralph@amissah.com +a57d1562 + +documentation related +2014-08-08 ralph@amissah.com +23b07d95 (tag: sisu_5.6.0) + +v5 v6: extend document structure, headings A - D, 1 - 4 +2014-08-08 ralph@amissah.com +6bc3b814 +- sql db table structure changed (needs to be rebuilt) + +v5: merged v6 libraries +2014-08-08 ralph@amissah.com +80903424 +- commandline, --act0 to --act9, rc-config with flag:act[0-9] + - configurable command line options increased to 0 - 9 (instead of 0 - 5) + - use --act0 to --act9 (previous flags -1 to -5; -0 to -9 now available) + - default --act0 + - rc config with flag:act0 to flag:act9 (previously roman numerals) + - legacy roman numeral configuration works (for now) +- use opt.act, code internals (simplify, cleaner; remove opt.cmd + & opt.mod) +- hub, further changes related to use of opt.act; hub file split + +v5 v6: version & changelog (& rakefile) +2014-08-08 ralph@amissah.com +d7f17dc4 + +v6: hub, further changes related to use of opt.act; hub file split +2014-08-08 ralph@amissah.com +3a7ba139 (tag: sisu_5.5.6) + +v6: use opt.act, code internals (simplify, cleaner; remove opt.cmd & opt.mod) +2014-08-08 ralph@amissah.com +64e5c912 +- v5 dp, indentation changed to retain easy comparison with v6 + +v6: commandline, --act0 to --act9, rc-config with flag:act[0-9] +2014-08-08 ralph@amissah.com +c10a6dcb +- configurable command line options increased to 0 - 9 (instead of 0 - 5) +- use --act0 to --act9 (previous flags -1 to -5; -0 to -9 now available) +- default --act0 +- rc config with flag:act0 to flag:act9 (previously roman numerals) +- legacy roman numeral configuration works (for now) + +v5 v6: code file renames, fairly extensive +2014-08-08 ralph@amissah.com +39e11a44 +- v5 file renames sync with v6 for easier comparison +- v5 here (5.5.6) remains as in previous version (5.5.5) + +v5 v6: version & changelog (& rakefile) +2014-08-08 ralph@amissah.com +94106f16 + +v5 v6: ensure reset of parsed document directory path +2014-07-29 ralph@amissah.com +a79f9862 (tag: sisu_5.5.5) +- needed in the case of html for some subsequent processing + +v5 v6: options, minor fixes +2014-07-29 ralph@amissah.com +1fa2ba3f + +v5 v6: version & changelog (& rakefile) +2014-07-29 ralph@amissah.com +cf8ecbb7 + +v5 v6: ao_numbering, auto name segment, tweak to make behave as intended +2014-07-24 ralph@amissah.com +2907137b (tag: sisu_5.5.4) +- further testing required + +v5 v6: version & changelog (& rakefile) +2014-07-24 ralph@amissah.com +4cde4b1e + +v5 v6: db, reorganize previous commit +2014-07-23 ralph@amissah.com +c59e0eed (tag: sisu_5.5.3) + +v5 v6: db, rescue where no tables, attempt to initialize db and retry +2014-07-23 ralph@amissah.com +3b753e3d +- internally run the equivalent of --createall +- (if successful) permitting completion of --import or --update command +- make use of action triggers + +v5 v6: version & changelog (& rakefile) +2014-07-23 ralph@amissah.com +09223f6a + +documentation related +2014-07-22 ralph@amissah.com +743e0407 (tag: sisu_5.5.2) + +v5 v6: sysenv, processing shortcuts, options, adjust +2014-07-22 ralph@amissah.com +0ec06db2 +- (further refinement necessary) + +v5 v6: sysenv, revert to use of stub_pwd to correct hub post processing behavior +2014-07-22 ralph@amissah.com +67533e4e +- revert to use of stub_pwd (instead of preferred base_markup_dir_stub + introduced in 5.5.1) to bring back correct hub (post) processing behavior + +v5 v6: sysenv, reorganise, break up file, multiple se_* files +2014-07-22 ralph@amissah.com +ab10de39 + +v5 v6: db, pqsl, sqlite, reorganise triggers +2014-07-22 ralph@amissah.com +f36e8bf7 + +v5 v6: db, pg import, fix +2014-07-22 ralph@amissah.com +94aa1549 +- remove dbi from rescue, no longer using ruby-dbi +- ruby-pg query SELECT MAX + +v5 v6: db, minor +2014-07-22 ralph@amissah.com +e3121a48 + +v5 v6: options, sisupod parsing, fix +2014-07-22 ralph@amissah.com +dc516087 + +v5 v6: html_lite_shared, issue, fix +2014-07-22 ralph@amissah.com +b9b01e57 + +v5 v6: bin/sisu, hub, hub close (ensure), remove /tmp/ processing dir +2014-07-22 ralph@amissah.com +e1af490a + +v5 v6: cosmetic code +2014-07-22 ralph@amissah.com +41796e30 + +v5 v6: version & changelog (& rakefile) +2014-07-22 ralph@amissah.com +a9f81c23 + +v5 v6: document images (more to clean up) +2014-07-15 ralph@amissah.com +4ef1c309 (tag: sisu_5.5.1) + +v5 v6: base images & css, continue +2014-07-15 ralph@amissah.com +3628703f + +v5 v6: base images & css +2014-07-15 ralph@amissah.com +3a3037c4 + +v5 v6: docbook, status, under construction notice removed (still much to do) +2014-07-15 ralph@amissah.com +99f57f7e + +v5 v6: docbook, css (needs work), also doc header, sisu processing info +2014-07-15 ralph@amissah.com +d8917347 + +v5 v6: docbook, images, and adjustment +2014-07-15 ralph@amissah.com +796915d8 + +v5 v6: docbook, url links, urls +2014-07-15 ralph@amissah.com +8a09a5fc + +v5 v6: docbook, code & other blocks markup +2014-07-15 ralph@amissah.com +84fcc4fb + +v5 v6: src, sisupod, bring back in line +2014-07-15 ralph@amissah.com +7222b360 + +v5 v6: src_share, cosmetic code +2014-07-15 ralph@amissah.com +9100b4d6 + +v5 v6: ao_numbering, auto name segment, extract "number" from heading, refine +2014-07-15 ralph@amissah.com +03c28469 + +v5 v6: sysenv, general, base_markup_dir_stub (replace pwd_stub) +2014-07-15 ralph@amissah.com +639c57eb + +v5 v6: bin/sisu, hub, options, pass message: sisu_called_from_directory +2014-07-15 ralph@amissah.com +ebc9b30c + +documents / documentation related +2014-07-15 ralph@amissah.com +f89b2e6c +- COPYRIGHT, date +- sisu.org, minor +- README +- manpage + +v5 v6: version & changelog (& rakefile) +2014-07-15 ralph@amissah.com +db6adeb7 + +documention related +2014-07-11 ralph@amissah.com +bf076ed4 (tag: sisu_5.5.0) + +v5 v6: src, sisupod composite source, nested includes +2014-07-11 ralph@amissah.com +a93f8d5d + +v5 v6: src sisupod, cosmetic code arrangement +2014-07-11 ralph@amissah.com +3daec543 + +v5 v6: ao_composite, nested includes, .ssi (insert) can now include .ssi & .sst +2014-07-11 ralph@amissah.com +86ce2181 +- .ssm can contain/include .sst or .ssi + .sst files can be processed independently, they do not contain other files + .ssi files have been only insertions of text & 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 +- requested feature, (Closes: #744408) + User beware. In previous versions there has been a deliberate attempt to keep + it easy to follow documents & not have to dig through different levels of + includes, as this is more likely to lead to errors in markup. + The idea of nested includes has not been attractive (messy for a document), + however, this is now made possible, use with care + - it is not as easy to see document structure at a glance, and structural + errors may be introduced and will need to be taken care of (requiring + document markup debugging) + - allowing .ssi to also include other .ssi or .sst could lead to infinite + recursion if an .ssi includes another which includes itself; stopping after + an additional level of includes seems arbitrary, and possibly prone to error + if you are dealing with many documents +- requires testing +- version bump, new behavior added to .ssi one of the 3 sisu filetypes + +v5 v6: ao_composite, variable name +2014-07-11 ralph@amissah.com +cc3380a5 + +v5 v6: ao_numbering, check that all auto given number based seg names are unique +2014-07-11 ralph@amissah.com +561b6627 + +v5 v6: ao_numbering, auto name segment, extract "number" from heading, fix +2014-07-11 ralph@amissah.com +d1c4bb34 + +v5 v6: version & changelog (& rakefile) +2014-07-11 ralph@amissah.com +26ec305b + +sisu.org, README minor +2014-07-07 ralph@amissah.com +51ac9999 (tag: sisu_5.4.5) + +v5 v6: ao, auto seg naming, adjustments +2014-07-07 ralph@amissah.com +0c805339 +- re: seg numbering, fixed width, leading zeros (introduced: 5.4.3 / 6.0.9) + +bin/sisu, processing dir related +2014-07-07 ralph@amissah.com +58c41f68 +- e.g. using live-manual/manual as sample, the following should work as expected + available: ca de en es fr it ja pl pt_BR ro; select: en & ja: + sisu --html -v en/live-manual.ssm ja/live-manual.ssm + or for all available translations: + sisu --html -v **/live-manual.ssm + (these previously would have broken after processing the first directory) + sisu command equivalent for all available translations being (unaffected): + sisu --html -v --glob live-manual + +bin/sisu, some cosmetic long line breaking +2014-07-07 ralph@amissah.com +4080aa45 + +v5 v6: version & changelog (& rakefile) (git, ref log instead of shortlog) +2014-07-07 ralph@amissah.com +86ca0ae6 + +v5 v6: ao, fix, re: seg numbering, fixed width, leading zeros (new in 5.4.3) +2014-07-04 ralph@amissah.com +618c5f11 (tag: sisu_5.4.4) +- provisional fix (check related issues against 5.4.2) + +v5 v6: version & changelog (& rakefile) +2014-07-04 ralph@amissah.com +d7255c64 + +v5 v6: sysenv, developer _CONSTRUCTION_ZONE warning setup modified +2014-07-01 ralph@amissah.com +d850e670 (tag: sisu_5.4.3) + +v5 v6: epub, a fix, double check +2014-07-01 ralph@amissah.com +1b3d9ac3 + +v5 v6: ao, segment numbering, fixed width, leading zeros +2014-07-01 ralph@amissah.com +f74de438 +- alphanumeric sorting + +v5 v6: ao, doc objects, layout group open & close, identify, is_for +2014-07-01 ralph@amissah.com +e881dffc + +v5 v6: ao, quote block, insert text indent markup (book index markup unchanged) +2014-07-01 ralph@amissah.com +60411adb + +v5 v6: ao, (param), book index, strip white spaces around terms +2014-07-01 ralph@amissah.com +844f9270 +- fix uppercase first character where spaces used + +v5 v6: ao, code cosmetic rearrangement +2014-07-01 ralph@amissah.com +93470187 + +v5 v6: files renamed: ao_composite.rb, html_concordance.rb +2014-07-01 ralph@amissah.com +41871616 +- ao_composite.rb (from composite.rb) +- html_concordance.rb (from concordance.rb) + +vim syntax, version & date (code block, language syntax; box group; quote) +2014-07-01 ralph@amissah.com +ccb082ff +- now applies to v5 branch + +v5: merge what was sisu_6.0.8 into v5 +2014-07-01 ralph@amissah.com +954419b5 +- ao, + - syntax, able optionally to indicate the language syntax of a code block + - syntax, introduce box text block/group + - syntax, introduce tics quotes markup (blockquote equivalent) +- docbook, + - ocn & footnote numbers (as xml comments) + - metadata header (docinfo) + - quotes (blockquote) + - tables + - images + - code block +- vim syntax, add + - code block, language syntax, optional + - box block + - quote block + +sisu.org minor +2014-07-01 ralph@amissah.com +cc39efe5 + +v5 v6: version & changelog (& rakefile) +2014-07-01 ralph@amissah.com +0c418823 + +ao, fix bug in previous version (5.4.1) from sloppy cherry pick of v6 +2014-06-22 ralph@amissah.com +943cfb45 (tag: sisu_5.4.2) +- ao_doc_str (codeblock) + +v5: version & changelog (& rakefile) +2014-06-22 ralph@amissah.com +c1843293 + +vim syntax, code block, language syntax; box group; quote +2014-06-19 ralph@amissah.com +e6ba0168 (tag: sisu_5.4.1) + +v6: docbook, code block +2014-06-19 ralph@amissah.com +e7ce3d1c + +v6: docbook, images +2014-06-19 ralph@amissah.com +c7eddcb1 + +v6: docbook, tables +2014-06-19 ralph@amissah.com +8ed75b2b + +v6: docbook, quotes (blockquote) +2014-06-19 ralph@amissah.com +16380ed1 + +v6: docbook, metadata header (docinfo) +2014-06-19 ralph@amissah.com +beb28d69 + +v6: docbook, ocn & footnote numbers (as xml comments) +2014-06-19 ralph@amissah.com +e0c38cb8 + +v6: docbook, tags (name touch) +2014-06-19 ralph@amissah.com +4f5b055e + +v6: ao, syntax, introduce tics quotes markup (blockquote equivalent) +2014-06-19 ralph@amissah.com +ac654580 + +v6: ao, syntax, introduce box text block/group +2014-06-19 ralph@amissah.com +dffa2293 + +v6: ao, syntax, able optionally to indicate the language syntax of a code block +2014-06-19 ralph@amissah.com +fa8a1385 + +v5 v6: ao, introduce way of removing unrecognized tic markers +2014-06-19 ralph@amissah.com +64d8e1b1 +- this is to provide some forward compatibility with new markup + (unrecognized new tic marks are removed) +- noisy, reports to screen on tics that are to be removed, unless quiet is on +- review + +v5 v6: ao, Symbol to match grouped text open & close (instead of String) +2014-06-19 ralph@amissah.com +46410b13 + +v5 v6: ao, regex match for tics "```" followed by space tweaked +2014-06-19 ralph@amissah.com +afdedc96 + +v5 v6: ao, turn id numbers (for tags) into a hash +2014-06-19 ralph@amissah.com +de1c3838 + +v5 v6: ao, code blocks, clean trailing newlines +2014-06-19 ralph@amissah.com +5d168b30 + +v5 v6: indent spaces, minor +2014-06-19 ralph@amissah.com +83137da0 + +v5 v6: ao, misc, mostly minor cleaning +2014-06-19 ralph@amissah.com +66b72eae + +v5 v6: version & changelog (& rakefile) +2014-06-19 ralph@amissah.com +d4d50860 + +v5: merge v6 to v5, version bump to 5.4.*, reason adds structure check +2014-05-25 ralph@amissah.com +16c30474 (tag: sisu_5.4.0) +- ao, document structure check, stop processing on major error + (with error message & text at location of failure) + [reason for version bump the addition of structure check] +- utils, add ok code marker +- ao, heading with no ocn, distinguish ~# from -# + - ~# is general & means no ocn (for any object to which it is applied) + - -# is relevant only for 1~ dummy headings & instructs that they should be + removed from output where possible + - applied so far to pdf, odt & plaintext +- ao_images, reduce warnings when ruby RMagic absent as program used directly + - reduced dependency on ruby RMagic library (as some time way back had + issues) +- ao, document markup structure check, skip processing file on major error + - with error message & text at location of failure +- texpdf, urls in creator cause breakage +- texpdf, mailto markup links set for normal text objects +- texpdf, '&' in heading breaks toc (now removed from toc (not heading)), bug + - revisit, bug +- texpdf, for urls switch to sans serif (small fontsize) + - instead of typewriter, latex default +- texpdf, pdf colored hyperlinks configurable + - --pdf-hyperlinks-color + --pdf-hyperlinks-no-color or --pdf-hyperlinks-monochrome + - ['default']['pdf_hyperlinks']='color' + (other options switch hyperlink color off 'no-color' 'color-off' + 'monochrome') +- texpdf, pdf default font size configurable (cli & sisurc.yml) (no fractions) + - --pdf-fontsize-12 --pdf-fontsize-8 + - default: + texpdf_fontsize: 12 +- texpdf, headings and table of contents representation + - fixes 1~ and 2~ result in the same formatting + 1~ 2~ & 3~ now differentiated, see discussion in sisu.org under #744383 + - fixes :A smaller formatted than :B + A~ B~ C~ now the same size, see discussion in sisu.org under #744383 + - :B and :C result in the same formatting, issue explained see sisu.org +- texpdf, (internal coding) fontface, rename texpdf_font texpdf_fontface +- texpdf, (internal coding) use symbols to identify page orientation +- param, metadata rights, line-breaks instead of semicolons separating rights + - fixes remove trailing semicolon after :copyright: +- digests sha512 option implemented + - options sha512 sha256 md5 + - command line --sha512 + - rcconf.yml ['defsault']['digest'] = sha512 +- xml object citation numbering (docbook fictionbook) + +v5 v6: version & changelog (& rakefile) +2014-05-25 ralph@amissah.com +108142f5 +- will merge v6 into v5, 5.4 version bump + +v5 v6: cgi, sample search forms: use ruby-pg & ruby-sqlite3; remove ruby-dbi +2014-05-18 ralph@amissah.com +bcb074af (tag: sisu_5.3.6) + +v5 v6: db, remove ruby-dbi, for: pg ruby-pg, sqlite ruby-sqlite3 (already uses) +2014-05-18 ralph@amissah.com +7bfd5671 +- ruby-pg require for postgresql +- ruby-sqlite3 require for sqlite3 (done previously: already using ruby-sqlite3 + rather than ruby-dbi) +- ruby-dbi remove calls (in any common files & sisu pg and sisu sqlite3) +- separate pg and sqlite db actions + +v5 v6: db, use symbols to identify sql engine +2014-05-18 ralph@amissah.com +307ecb4d + +v6: utils, add ok code marker +2014-05-18 ralph@amissah.com +b17d90bc + +documentation updates +2014-05-18 ralph@amissah.com +569827db +- sisu.org info on ruby-dbi removal affecting sisu in debian +- sisu.org moved to data/doc/sisu (softlinked from root dir) +- CHANGELOG simplify maintenance +- note version changes +- misc + +v5 v6: version & changelog (& rakefile) +2014-05-18 ralph@amissah.com +b76284d1 + +documentation, notes, update +2014-05-12 ralph@amissah.com +e2f6efc6 (tag: sisu_5.3.5) + +v6: ao, heading with no ocn, distinguish ~# from -# +2014-05-12 ralph@amissah.com +cd4b4e42 +- ~# is general & means no ocn (for any object to which it is applied) +- -# is relevant only for 1~ dummy headings & instructs that they should be + removed from output where possible + - applied so far to pdf, odt & plaintext + +v5 v6: bin/sisu, ensure return to start dir +2014-05-12 ralph@amissah.com +57f00b94 + +v6: ao_images, reduce warnings when ruby RMagic absent as program used directly +2014-05-12 ralph@amissah.com +d6f28e09 +- reduced dependency on ruby RMagic library (as some time way back had issues) + +v6: ao, document markup structure check, skip processing file on major error +2014-05-12 ralph@amissah.com +f408992e +- with error message & text at location of failure + +v6: texpdf, urls in creator cause breakage +2014-05-12 ralph@amissah.com +62c48aca +- (Closes: #744541) + +v6: texpdf, mailto markup links set for normal text objects +2014-05-12 ralph@amissah.com +f9fb4020 +- (Closes: #744357) but testing required + +v6: texpdf, '&' in heading breaks toc (now removed from toc (not heading)), bug +2014-05-12 ralph@amissah.com +41d62d53 +- revisit, bug + +v6: texpdf, for urls switch to sans serif (small fontsize) +2014-05-12 ralph@amissah.com +4c27c792 +- instead of typewriter, latex default +- (Closes: #744353) + +v6: texpdf, pdf colored hyperlinks configurable +2014-05-12 ralph@amissah.com +9d76329a +- --pdf-hyperlinks-color + --pdf-hyperlinks-no-color or --pdf-hyperlinks-monochrome +- ['default']['pdf_hyperlinks']='color' + (other options switch hyperlink color off 'no-color' 'color-off' 'monochrome') +- (Closes: #744391) no color on a4 portrait + see discussion in sisu.org + +v6: texpdf, pdf default font size configurable (cli & sisurc.yml) (no fractions) +2014-05-12 ralph@amissah.com +df9e4219 +- --pdf-fontsize-12 --pdf-fontsize-8 +- default: + texpdf_fontsize: 12 +- (Closes: #744405) + +v6: texpdf, headings and table of contents representation +2014-05-12 ralph@amissah.com +2b2e66c1 +- (Closes: #744386) 1~ and 2~ result in the same formatting + 1~ 2~ & 3~ now differentiated, see discussion in sisu.org under #744383 +- (Closes: #744399) :A smaller formatted than :B + A~ B~ C~ now the same size, see discussion in sisu.org under #744383 +- #744383 :B and :C result in the same formatting, issue explained see sisu.org + +v6: texpdf, (internal coding) fontface, rename texpdf_font texpdf_fontface +2014-05-12 ralph@amissah.com +09fc878f + +v6: texpdf, (internal coding) use symbols to identify page orientation +2014-05-12 ralph@amissah.com +1716ccd0 + +v6: param, metadata rights, line-breaks instead of semicolons separating rights +2014-05-12 ralph@amissah.com +d5b13ca5 +- (Closes: #744358) remove trailing semicolon after :copyright: + +v5 v6: param, metadata add 'Copyright:' tag to output related to copyright +2014-05-12 ralph@amissah.com +369b764e +- (Closes: #744381) syntax: inconsistency \:copyright: and \:license: + +v6: digests sha512 option implemented +2014-05-12 ralph@amissah.com +3ea16523 +- options sha512 sha256 md5 +- command line --sha512 +- rcconf.yml ['defsault']['digest'] = sha512 +- (Closes: #744402) + +v5: digests cleaning +2014-05-12 ralph@amissah.com +58020c13 + +v5 v6: metadata, pdf, remove link to manifest page where --no-manifest is used +2014-05-12 ralph@amissah.com +d5b2fa8c +- (Closes: #744378) + +v5 v6: composite (inserts), missing includes doesn't give an error, fix +2014-05-12 ralph@amissah.com +90d3eab4 +- (Closes: #744379) see sisu.org for comment + +v5 v6: composite, fix includes, provide extra newline after inserted comment +2014-05-12 ralph@amissah.com +b28cf1c5 +- (Closes: #744360) [n|u] sisu: includes do not work properly + +syntax hilighting, includes with files in subdirectories fix +2014-05-12 ralph@amissah.com +fbe2d78a +- (Closes: #744355) + +syntax hilighting, line break without spaces
flagged as error, close +2014-05-12 ralph@amissah.com +080d49e6 +- for line breaks in sisu markup use \\ instead of
+- the case described is meant to be flagged as an error +- close bug, no action taken further explanation in sisu.org +- (Closes: #744356) re-open if necessary + +v5 v6: ao_syntax, address possible manual use of url delimiters「」 +2014-05-12 ralph@amissah.com +5b607318 + +sisu.org introduce a bug list +2014-05-12 ralph@amissah.com +e170f0f6 +- primarily DBT (Daniel's welcome bug flood) + +sisu.org start using emacs:evil:org; update .gitignore +2014-05-12 ralph@amissah.com +388eef4b +- (emacs:evil mode gifts a "vim" of "alternative" powers! ;) + heretic + +v6: xml object citation numbering (docbook fictionbook) +2014-05-12 ralph@amissah.com +f06613bb + +v5 v6: coding, various minor cosmetic +2014-05-12 ralph@amissah.com +e38554e5 + +v5 v6: version & changelog (& rakefile) +2014-05-12 ralph@amissah.com +e132337b + +v5 v6: ocn, object citation numbering, --no-numbering option & default tuning +2014-02-14 ralph@amissah.com +06145fcd (tag: sisu_5.3.4) +- add less cryptic --numbering --no-numbering command-line options (to --no-ocn) +- plaintext & odt switch default to ocn==true for consistency with other output +- [decide how fine-grained ocn/numbering switches could be: could be per output + type by command-line instruction (see txt & odt); currently set per sisu + instruction for all outputs] + +v5 v6: version & changelog (& rakefile) +2014-02-14 ralph@amissah.com +7952a48d + +documentation, minor update +2014-02-08 ralph@amissah.com +268a9c5c (tag: sisu_5.3.3) + +examples: nginx conf; cgi search forms pgsql & sqlite +2014-02-08 ralph@amissah.com +61a1a2a8 + +v5 v6: cgi, sample search form (generator), using cgi ENV variables +2014-02-08 ralph@amissah.com +d8cd4b66 + +v5 v6: version & changelog (& rakefile) +2014-02-08 ralph@amissah.com +051517d4 + +manual Rakefile, README & minor config adjustment +2014-02-05 ralph@amissah.com +f6735293 (tag: sisu_5.3.2) + +v5 v6: sysenv, concordance redirected paths, watch +2014-02-05 ralph@amissah.com +bbbb88fa + +v5 v6: utils, code markers & messages, notes/warning/errors, fix +2014-02-05 ralph@amissah.com +9f10ff9b + +v5 v6: ao, html book index linking, follow --strict option +2014-02-05 ralph@amissah.com +ba862b94 + +v5 v6: version & changelog (& rakefile) +2014-02-05 ralph@amissah.com +2ea3e592 + +README & manpage (sisu.1) update +2014-02-05 ralph@amissah.com +4e7fb324 (tag: sisu_5.3.1) + +sisu manual update +2014-02-05 ralph@amissah.com +e13aacbf + +sisu manual directory moved +2014-02-05 ralph@amissah.com +e4ef7cc2 + +removed html man pages (man2html) +2014-02-05 ralph@amissah.com +d6b74b93 + +v5 v6: cgi (pgsql & sqlite), fix +2014-02-05 ralph@amissah.com +0cad9edc + +v5 v6: html, (output) cleaning +2014-02-05 ralph@amissah.com +d79d6050 + +v5 v6: epub, hash digests used only if available +2014-02-05 ralph@amissah.com +4fcfa03d + +v5 v6: html, endnote name and nameref make compliant (epub use same) +2014-02-05 ralph@amissah.com +99c5b5d5 + +v5 v6: ocn: strict html; turn on/off rules for txt & odf +2014-02-05 ralph@amissah.com +a151893e + +v5 v6: options, ocn switch on/off instructions (& defaults for plaintext & odt) +2014-02-05 ralph@amissah.com +728ed462 + +v5 v6: options, html --strict instruction +2014-02-05 ralph@amissah.com +e74053c5 + +v5 v6: html, name tag related (output "cleaning") +2014-02-05 ralph@amissah.com +07ce3445 + +v5 v6: ao, set document tags +2014-02-05 ralph@amissah.com +a7dc41fd + +v5 v6: epub, odt, check availability of zip program +2014-02-05 ralph@amissah.com +58041f06 + +v5 v6: error/warn messages +2014-02-05 ralph@amissah.com +62e27667 + +v5 v6: wrappers round require +2014-02-05 ralph@amissah.com +bd5e9491 + +v5 v6: html, cleaning, minor +2014-02-05 ralph@amissah.com +151f1043 + +v5 v6: version & changelog (& rakefile) +2014-02-05 ralph@amissah.com +0aa76d8a + +v5 v6: made true, branches: v6 development; v5 stable; v4 closed +2014-01-26 ralph@amissah.com +506e3263 (tag: sisu_5.3.0) + +v5 v6: version & changelog (& rakefile), make true on next commit +2014-01-26 ralph@amissah.com +447e260f +- next commit: + - v4 branch closed + - v5 stable branch + - v6 development branch opened (copy v5) + +bin/sisu changes to simplify switching to new stable & development branches +2014-01-26 ralph@amissah.com +64798aee (tag: sisu_4.2.21) + +v4 v5: version & changelog (& rakefile) [v4 about to be closed] +2014-01-26 ralph@amissah.com +d808d24f + +v4 v5: sysenv for texpdf, fix for when tex to pdf generator is absent +2014-01-20 ralph@amissah.com +0d2f83bc (tag: sisu_4.2.20) + +v4 v5: bin/sisu & some related lib changes +2014-01-20 ralph@amissah.com +ee4968f5 +- good time to consider rollover: closing v4 branch, replacing it with v5 & + introducing v6 for development, proposed for this release + 1 + + v4 v5: version & changelog (& rakefile) +2014-01-20 ralph@amissah.com +a65a215e + +rakefile version update for previous version (should have been) +2014-01-20 ralph@amissah.com +76b005fc + +bin/sisu experimentation +2014-01-17 ralph@amissah.com +c00345b2 (tag: sisu_4.2.19) +- start preparing for ruby changes +- work on fix for bug related to gem path & system installed sisu + +README clean info related to unsupported --help option +2014-01-17 ralph@amissah.com +2dff4382 + +v4 v5: version & changelog (& rakefile) +2014-01-17 ralph@amissah.com +0e969552 + +v5: asciidoc, file extension (for now .ad), inline footnotes, minor +2014-01-12 ralph@amissah.com +593766d8 (tag: sisu_4.2.18) + +v5: heading recalibration, code (downstream) changes, continue +2014-01-12 ralph@amissah.com +4aa58e16 + +v5: ao, counter for various grouped / blocked texts & tables +2014-01-12 ralph@amissah.com +81108043 +- of particular use for poems which are broken into verse + +v4 v5: texpdf, report to screen on pdf output, link to a generated file-size +2014-01-12 ralph@amissah.com +0edc0d30 +- decide how to deal with as multiple document file-sizes may be produced + +v4 v5: texinfo, fixes +2014-01-12 ralph@amissah.com +fbf1b643 + +v4 v5: version & changelog (& rakefile) +2014-01-12 ralph@amissah.com +9eca07c3 + +v5: heading recalibration, code (downstream) changes +2014-01-06 ralph@amissah.com +5fb49b57 (tag: sisu_4.2.17) +- here no doubt remains breakage (test, fix & test again) + +v5: vim syntax, v5.2 match heading level D~ +2014-01-06 ralph@amissah.com +3e671eaa + +v5: single document root A~ (recalibrate headings); level D~ possible +2014-01-06 ralph@amissah.com +1832a937 +- :A~ document title, single document root (ln==0) +- introduce additional possible heading level, D~ +- markup rule change: single document root +- breaks much downstream code, recalibrate (fix, test, fix & test again) +- v4 & v5 bifurcate (diverge "un-merge-ably") + +v5: version (5.2 version bump) & changelog (& rakefile) +2014-01-06 ralph@amissah.com +ae676753 +- markup rule change; document structure rule be introduced: + - single document root == document title == heading level A~ + - adds possible level D~ + - (earlier v5, development branch insulated from v4) + +v5: cosmetic code, case statement +2014-01-06 ralph@amissah.com +0e42ce6f + +v5: docbook, fictionbook, some tidying +2014-01-06 ralph@amissah.com +557d7378 + +v5: asciidoc, rename AsciiDoc module, & recalibrate headings +2014-01-06 ralph@amissah.com +f2323485 + +v4 v5: fixes +2014-01-06 ralph@amissah.com +a90463bb +- ao_doc_str, nodes, possible parents, correction +- epub, url closure decoration +- sysenv, qrcode report absent program, minor +- html scroll toc, clean links where none, exclude metadata + +bin/sisu, version dir (fix) & version info +2014-01-06 ralph@amissah.com +42aae8da +- (ensure SiSU_version_dir) fix +- sisu version info, yml info also when installed via ruby gem +- downstream libs + +v5: date 2014: headers bin/sisu & lib/; code constants.rb +2014-01-06 ralph@amissah.com +17f1f887 + +v4 v5: version & changelog (& rakefile) +2014-01-06 ralph@amissah.com +147eba58 + +v4 v5: Rakefile, (installer), reduce actions +2013-12-15 ralph@amissah.com +30e03850 (tag: sisu_4.2.16) + +v4 v5: version & changelog +2013-12-15 ralph@amissah.com +67ff4a2c +- along with date correction for occurrence of disk crash, which happened a week + later than recorded, and in between previous releases. + +v5: docbook, structure, a fix +2013-12-09 ralph@amissah.com +b9bffa35 (tag: sisu_4.2.15) +- construction zone: structure okish; docbook generated not usable + +v4 v5: Rakefile, (installer) improve, re-arrange +2013-12-09 ralph@amissah.com +1af24dcb + +v4 v5: version & changelog +2013-12-09 ralph@amissah.com +29888f91 + +v4 v5: bin/sisu, simplify in relation to sisu gem +2013-12-03 ralph@amissah.com +676eba53 (tag: sisu_4.2.14) + +v4 v5: rake create build & install sisu gemspec; (.gitignore), work on +2013-12-03 ralph@amissah.com +ff66e3f0 +- gemspec adjusted to install only libraries related to a version (v4 or v5) +- select sisu version to create, build & install + +v4 v5: version & changelog +2013-12-03 ralph@amissah.com +bd7ae5db + +v5: documentation related to commands for new outputs in development +2013-12-03 ralph@amissah.com +88b3272a (tag: sisu_4.2.13) + +v5: xml, fictionbook +2013-12-03 ralph@amissah.com +97005184 + +v5: xml, docbook +2013-12-03 ralph@amissah.com +c7f7a265 + +v5: plaintext, smarttext: rst +2013-12-03 ralph@amissah.com +6c153f78 + +v5: plaintext, smarttext: markdown +2013-12-03 ralph@amissah.com +66fde27a + +v5: plaintext, smarttext: asciidoc +2013-12-03 ralph@amissah.com +ce74f66c + +v5: plaintext, smarttext: textile +2013-12-03 ralph@amissah.com +cdda22f5 + +v5: plaintext, rename & simplify +2013-12-03 ralph@amissah.com +32bc9149 + +v5: some file renaming related to: shared files & epub, odf:odt, plaintext +2013-12-03 ralph@amissah.com +6c3930e1 + +v5: some renaming to ao from dal continued +2013-12-02 ralph@amissah.com +3d4ec6de + +v5: renaming files & modules ao & AO (from dal & DAL) +2013-12-02 ralph@amissah.com +9b51aed5 +- ao (abstract objects) shorter, also easily searched, higher sort location + abstract as representation of & extraction of document objects + (dal (document abstraction layer)) + +v4 v5: rake create build & install sisu gemspec; bin/sisugem (add .gitignore) +2013-12-02 ralph@amissah.com +da5e7ffe +- rake gemcbi #(create build install sisu gem) +- rake gemspecscreate && \ + rake gembuild && \ + sudo rake geminstall +- rake gemspecscreate && \ + gem build sisu5.gemspec && \ + sudo gem install --no-rdoc --no-ri \ + sisu-5.1.0.gem +- bin/sisu updated (modified to take account of gems) +- bin/sisugem added +- .gitignore sisu-*.gem sisu*.gemspec + consider inclusion (& tracking) of rake created sisu4.gemspec sisu5.gemspec + (as this makes their availability more obvious) +- once gem is installed: "sisu _5.1.0_ -vM" (to see version, commands otherwise + as usual) if paths are such that sisu is not available "sisugem _5.1.0_ -vM" + should work (as it is installed by gemspec, but not other sisu installers) + +v5: xmlns xlink using xl +2013-12-02 ralph@amissah.com +6e2061aa + +v5: xml sax rename file +2013-12-02 ralph@amissah.com +f0869d13 + +v5: minor code related to line-breaks +2013-12-02 ralph@amissah.com +85ec6bab + +v5: dal_endnotes, removed a space that should no longer be necessary +2013-12-02 ralph@amissah.com +e130be57 +- testing required + +v5: dal_doc_str.rb, changes related to collapsed level +2013-12-02 ralph@amissah.com +f37d75fb +- for headings added for structure, without ocn +- testing required + +v4 v5: version & changelog +2013-12-02 ralph@amissah.com +8cbc5ed7 + +v4 v5: bin/sisu-* +2013-11-08 ralph@amissah.com +897a46ef (tag: sisu_4.2.12) +- use option flag full names +- add sisu-html-scroll, sisu-html-seg, sisu-pdf-portrait, sisu-pdf-landscape + +v4 v5: vim, ftplugin sisu.vim, fix missing +2013-11-08 ralph@amissah.com +0a92145c + +v4 v5: rake (& rant) sisu installer +2013-11-08 ralph@amissah.com +cf8ff1a3 +- do less by default +- remove rant generated sisu-install + +v4 v5: sisu_manual, minor info addition +2013-11-08 ralph@amissah.com +7de03034 + +v4 v5: version & changelog +2013-11-08 ralph@amissah.com +c688ccae + +v5: xml, scaffold, re-activated, split into sisu structure & collapsed structure +2013-11-05 ralph@amissah.com +d6b596f0 (tag: sisu_4.2.11) +- --xml-scaffold-sisu (--xml-scaffold) +- --xml-scaffold-collapse +- output currently to terminal only + +v4 v5: version & changelog +2013-11-05 ralph@amissah.com +762d3008 + +v5: plaintext, reorganize +2013-11-02 ralph@amissah.com +89cc9097 (tag: sisu_4.2.10) + +v4 v5: constants, ocn output delimiter (where used) changed to 「...」 +2013-11-02 ralph@amissah.com +a89fd60f + +v4 v5: version & changelog +2013-11-02 ralph@amissah.com +8c11f325 + +v4 v5: dal, document_structure_check_info +2013-10-27 ralph@amissah.com +d08020e7 (tag: sisu_4.2.9) + +v4 v5: cleaning, minor +2013-10-27 ralph@amissah.com +8090434e + +v4 v5: version & changelog +2013-10-27 ralph@amissah.com +ce2366b9 + +v4 v5: dal, collapsed levels implemented +2013-10-23 ralph@amissah.com +15ff3747 (tag: sisu_4.2.8) +- convenience, collapse sisu's dual level document structure for output of + markup with straight linear structure + +v4 v5: dal, parent & node info, fix +2013-10-23 ralph@amissah.com +f7da57f4 +- used e.g. for mind map type output + (last for kdissert output, no longer supported) + +v5: options & downstream, more use of opt.act instead of opt.cmd +2013-10-23 ralph@amissah.com +edd89902 +- opt.act.*.set==:on instead of opt.cmd =~/\S/ + +v4 v5: version & changelog +2013-10-23 ralph@amissah.com +bc3dade8 + +v4 v5: constants, change a couple of internal processing delimiter characters +2013-10-17 ralph@amissah.com +69c86381 (tag: sisu_4.2.7) +- to characters even less likely to be of use in ordinary (marked up) text + +v4 v5: version & changelog +2013-10-17 ralph@amissah.com +a59324f3 + +v4 v5: constants, change a couple of internal processing delimeter characters +2013-10-16 ralph@amissah.com +78541f1a (tag: sisu_4.2.6) +- that may be used in ordinary marked up text + +v4 v5: comments, remove extra language lists, minor +2013-10-16 ralph@amissah.com +e7ff0923 + +markup sample, update book index markup, appearance, minor +2013-10-16 ralph@amissah.com +48f26680 + +vim, minor update, not syntax related +2013-10-16 ralph@amissah.com +8e35cdf4 + +v4 v5: version & changelog +2013-10-16 ralph@amissah.com +8d302131 + +bin/sisu update language list ja ko zh, fix +2013-09-22 ralph@amissah.com +db038f52 (tag: sisu_4.2.5) + +v4 v5: version & changelog +2013-09-22 ralph@amissah.com +16086918 + +Rakefile to assist in placing sisu markup under po4a management (sisu_manual) +2013-09-21 ralph@amissah.com +5a78c513 (tag: sisu_4.2.4) +- Provided as an example with sisu_manual +- fairly generic, but potentially dangerous, can be used to place sisu markup + source translations under po4a management, but user needs to know what this + is, (and how to set it up, hence sisu_manual as an example (despite the lack + of translations)) as can clobber/destroy files that are not managed by po4a. + +sisu_manual, sisurc*.yml minor +2013-09-21 ralph@amissah.com +d7b7c010 + +sisu_manual, move to en/ sub-dir (permitting translations) +2013-09-21 ralph@amissah.com +1b89f377 +- use of language sub-dir for source sisu markup suited to permitting + translation management by po4a + +v4 v5: i18n CJK: zh ja ko, add languages Chinese, Japanese, Korean +2013-09-21 ralph@amissah.com +235f83d4 +- texpdf, has large texlive xetex dependencies (Korean untested) + +v4: dal, objects, store book index as hash (simplify downstream processing) +2013-09-21 ralph@amissah.com +6a8a7c3c +- merge v5 +- db, book index, convert hash back to string (associated downstream processing + change) + +v4 v5: minor cleaning +2013-09-21 ralph@amissah.com +220c63e5 + +v4 v5: version & changelog +2013-09-21 ralph@amissah.com +3e13a7d9 + +v5: db, book index, convert hash back to string +2013-09-07 ralph@amissah.com +af29258b (tag: sisu_4.2.3) + +v5: dal, book index, hash key, strip whitespace, a (required) fix +2013-09-07 ralph@amissah.com +9aeb2343 + +v4 v5: version & changelog +2013-09-07 ralph@amissah.com +a7fd6bb2 + +v5: dal, objects, store book index as hash (simplify downstream processing) +2013-09-05 ralph@amissah.com +6fd68591 (tag: sisu_4.2.2) + +v4 v5: vim syntax, book index markup, hilight delimeters +2013-09-05 ralph@amissah.com +d711e3f8 + +v4 v5: dal, book index markup, round delimiters: allow spaces or space & newline +2013-09-05 ralph@amissah.com +55617009 +- allow spaces on both sides of delimiters, or a space before & newline + following a delimiter \s+[:|;](\s+|\n) [else parses as before no spaces] + +v4: dal, grouped text with fontface spanning newlines, partial solution +2013-09-05 ralph@amissah.com +d756e906 +- merged from v5 + +v4 v5: version & changelog +2013-09-05 ralph@amissah.com +e9b1f97a + +v5: dal, grouped text with fontface spanning newlines, partial solution, test +2013-08-28 ralph@amissah.com +3f912866 (tag: sisu_4.2.1) +- merge into v4 after testing + +v4 v5: dal, text blocks, tuning +2013-08-28 ralph@amissah.com +349169b7 + +v4 v5: odf:odt, footnotes, fix +2013-08-28 ralph@amissah.com +cd0e55b3 + +v4 v5: pdf (latex) tables, bugfix (fasttrack) +2013-08-28 ralph@amissah.com +d2ad46d7 + +v4 v5: vim syntax, sisu.vim, fix typo +2013-08-28 ralph@amissah.com +b749d203 +- ocn (object numbering) on, off, text block using "--~#" "---#" "--+#" + +v4 v5: manifest, output organised by, info, minor touch +2013-08-28 ralph@amissah.com +93255d4c + +v4 v5: config files (by filetype & filename) touched +2013-08-28 ralph@amissah.com +d78a0ecb + +v4 v5: version & changelog +2013-08-28 ralph@amissah.com +25f7b4f3 + +v4 v5: vim syntax, sisu.vim, improve grouped text match, for blocks using tics +2013-08-25 ralph@amissah.com +c60b34d1 (tag: sisu_4.2.0) +- syntax additions (introduced for 5.0.12) now relevant also for v4 + - ocn (object numbering) on, off, text block using "--~#" "---#" "--+#" + - grouped text, open, close of blocks using tics "```" + +v4: merge v5, syntax additions, block text related (version bump to 4.2.*) +2013-08-25 ralph@amissah.com +9ccfd454 +- syntax add + - switch ocn off and on for a block of content, line containing only + off: "--~#" (omit headings where possible) "---#" on: "--+#" + - alternative open and close for blocks using line starting with "```", e.g. + open code block: "``` code"; close code block: "```" + start poem: "``` poem"; end poem: "```" + - remove need for an empty line between opening & closing of a text block + [ note further refinements will be required; + use of tildes "~~" considered but more problematic, tics not used elsewhere] + +v5: dal, improve font face matching within grouped text (other than code blocks) +2013-08-25 ralph@amissah.com +0e296ebc + +v5: dal, refine grouped text open and close using tics "```" +2013-08-25 ralph@amissah.com +34299895 + +v4 v5: css, html, epub, adjust paragraph spacing, aesthetic +2013-08-25 ralph@amissah.com +07de8418 +- increase whitespace (between paragraphs) +- [review spacing (generally) further] + +v4 v5: version & changelog +2013-08-25 ralph@amissah.com +cf11ff3a + +v5: vim syntax additions, sisu.vim +2013-08-21 ralph@amissah.com +750c6c5a (tag: sisu_4.1.12) +- ocn (object numbering) on, off, text block using "--~#" "---#" "--+#" +- grouped text, open, close of blocks using tics "```" + +v5: alternative open and close for blocks using line starting with "```" +2013-08-21 ralph@amissah.com +27cce87e +- e.g. + open code block: "``` code" + close code block: "```" + start poem: "``` poem" + end poem: "```" +- remove need for an empty line between opening & closing of a text block + +v5: markup syntax add: switch ocn (object numbering) off & on for content block +2013-08-21 ralph@amissah.com +386233f0 +- switch ocn off & on for a block of content, line containing only + off: "--~#" (omit headings where possible) "---#" on: "--+#" + +v4 v5: terminal message, code marker +2013-08-21 ralph@amissah.com +84ff66b6 + +v4 v5: rescued error messages +2013-08-21 ralph@amissah.com +bd4e38f4 + +v4 v5: fuchsia (sp.) +2013-08-21 ralph@amissah.com +c3a53153 + +v4 v5: version & changelog +2013-08-21 ralph@amissah.com +dd40cd83 + +v4 v5: dal_expand_insertions, refinement for monolingual output +2013-08-08 ralph@amissah.com +fa544551 (tag: sisu_4.1.11) + +v4 v5: version & changelog +2013-08-08 ralph@amissah.com +4e562dc8 + +v4: merge v5 lib (5.0.10) +2013-08-08 ralph@amissah.com +2635b72e (tag: sisu_4.1.10) +- output structure by, add monolingual alt for :filetype & :filename, step 1 +- output structure by, monolingual alternative for :filetype or :filename + without language code, if document is in default language + - set a default language, 'en' or as specified + - set in rc file or from command line instruction + - command line e.g. + sisu -hv --monolingual --by-filename sisu_markup.sst + sisu -3v --monolingual --by-filetype sisu_manual.ssm + - sisurc.yml lingual: 'mono' | 'multi' lingual: 'mono' + - note: output by :filetype is roughly equivalent to what monolingual output + by :language would be + - allow command line setting of default language using language code + --default-language='en' --default-lang-en if used together with + --monolingual and --by-filetype or --by-filename the selected default + language document will not have a language code in the output filename +- output structure by, monolingual alternative, documentation +- cgi helper script, sample search form, single form, monolingual option + - single cgi form, (with different internal variables set for output types) + +v5: output structure by, multilingual, monolingual filenames tweak +2013-08-08 ralph@amissah.com +bab4ecc5 + +v4 v5: version & changelog +2013-08-08 ralph@amissah.com +584eb5c2 + +v5: concordance, fix +2013-08-01 ralph@amissah.com +9c29e3cb (tag: sisu_4.1.9) + +v5: output structure by :filename or :filetype, default multilingual, fix +2013-08-01 ralph@amissah.com +80bec6ee + +v4 v5: version & changelog +2013-08-01 ralph@amissah.com +82e74ee2 + +v5: cgi helper script, sample search form, single form, monolingual option +2013-07-30 ralph@amissah.com +9e8a84f5 (tag: sisu_4.1.8) +- single cgi form, (with different internal variables set for output types) +- monolingual output search form option + +v5: output structure by, monolingual alternative, documentation +2013-07-30 ralph@amissah.com +9dffba29 + +v5: output structure by, monolingual alternative for :filetype or :filename +2013-07-30 ralph@amissah.com +3e58296f +- filename without language code, if document is in default language +- set a default language, 'en' or as specified +- set in rc file or from command line instruction + - command line e.g. + sisu -hv --monolingual --by-filename sisu_markup.sst + sisu -3v --monolingual --by-filetype sisu_manual.ssm + - sisurc.yml lingual: 'mono' | 'multi' + lingual: 'mono' +- note: output by :filetype is roughly equivalent to what monolingual output + by :language would be +- allow command line setting of default language using language code + --default-language='en' --default-lang-en if used together with + --monolingual and --by-filetype or --by-filename the selected default + language document will not have a language code in the output filename + +v5: output structure by, add monolingual alt for :filetype & :filename, step 1 +2013-07-30 ralph@amissah.com +363a1c71 + +v4 (v5): misc, minor +2013-07-30 ralph@amissah.com +74c58285 + +v4 v5: version & changelog +2013-07-30 ralph@amissah.com +864e90c1 + +v4 v5: "general code cleaning" fix +2013-06-25 ralph@amissah.com +2cf222a2 (tag: sisu_4.1.7) + +v4 v5: version & changelog +2013-06-25 ralph@amissah.com +d308814b + +v4: general code cleaning, sync with v5 +2013-06-25 ralph@amissah.com +c25fc275 (tag: sisu_4.1.6) + +v5: "general code cleaning" fix +2013-06-25 ralph@amissah.com +335008e5 + +v4 v5: version & changelog +2013-06-25 ralph@amissah.com +251df339 + +v5: general code cleaning +2013-06-22 ralph@amissah.com +f31e286f (tag: sisu_4.1.5) +- propagate back to v4 after testing + +vim, ftplugin sisu.vim, c-\ hard wrap lines to line width (moved from c-j) +2013-06-22 ralph@amissah.com +1e648771 + +vim colorscheme def, mark current line +2013-06-22 ralph@amissah.com +bce2dc32 + +v4 v5: version & changelog +2013-06-22 ralph@amissah.com +d58a2cbb + +v4 v5: cgi helper script, sample search form generator, file name matching +2013-06-06 ralph@amissah.com +13f66fe4 (tag: sisu_4.1.4) + +v4 v5: cgi, cosmetic, drop use of images in sample form +2013-06-06 ralph@amissah.com +f502a172 + +v4 v5: sysenv, requested load warning removed, less screen clutter +2013-06-06 ralph@amissah.com +152d9955 + +v4 v5: db, population of database (--update), import of master files (.ssm), fix +2013-06-06 ralph@amissah.com +5331c088 +- (Note: for .ssm: @md.fns (is set during runtime & is) != @opt.fns @md.opt.fns, + affects construction of unique identifier) + +v4 v5: version & changelog +2013-06-06 ralph@amissah.com +5c1d86ca + +v4 v5: cgi_pgsql, cgi helper script sample search form generator, detail +2013-05-30 ralph@amissah.com +9f4d9a31 (tag: sisu_4.1.3) + +v4 v5: sysenv, pgsql db connect fix +2013-05-30 ralph@amissah.com +462a53a0 + +v4 v5: version & changelog +2013-05-30 ralph@amissah.com +f0a14b71 + +v4 v5: help, documentation update, concentrate on man pages +2013-05-29 ralph@amissah.com +4adb525f (tag: sisu_4.1.2) +- documentation, manpage update +- interactive help, out of date, removed + +v4 v5: cgi helper script, sample search form generator, adjust/improve +2013-05-29 ralph@amissah.com +d8369e7a +- adds settings + - db type --db-pq or db-sqlite + - webserver for cgi script & db --webserv-search='' + - webserver for sisu ouptut files --webserv-output='' + - cgi search form link name --cgi-search-form-name='' + - db user (pg) --db-user='' + +v4 v5: document version check, disable +2013-05-29 ralph@amissah.com +25e9f4f2 +- automatic check disabled +- check and correction of pre 0.38 markup removed + +v4 v5: help, interactive help, out of date, removed +2013-05-29 ralph@amissah.com +9ac9918c +- sysenv, version info moved here from interactive help + +v4 v5: version & changelog +2013-05-29 ralph@amissah.com +6ebe681d + +v4 v5: cgi script for sample search form generator, sqlite, minor fixes +2013-05-19 ralph@amissah.com +4460d0b3 (tag: sisu_4.1.1) +- affects 'sisu -F' (repairs breakage) + +vim, ftplugin, sisu.vim, statusline +2013-05-19 ralph@amissah.com +e101d595 + +CHANGELOG version minor cleaning, redundant +2013-05-19 ralph@amissah.com +1becc7ca + +v4 v5: version & changelog +2013-05-19 ralph@amissah.com +e6100eb7 + +v5 dev branch opened (starts as copy of v4 stable branch); v3 branch closed +2013-05-09 ralph@amissah.com +879a4e6c (tag: sisu_4.1.0) +- 5.0.0 dev opened +- 4.1.0 stable +- 3.* branch gone + +v4: cgi script for sample search form, minor fixes +2013-05-09 ralph@amissah.com +ffe139eb + +v4: defaults, sysenv, simplify default home page (not used by default) +2013-05-09 ralph@amissah.com +2b388028 + +v4: version & changelog +2013-05-09 ralph@amissah.com +076c95cc + +v4: minor sysenv, cgi_sql_common +2013-05-06 ralph@amissah.com +4b97aba3 (tag: sisu_4.0.21) + +v4: version & changelog +2013-05-06 ralph@amissah.com +4c53032f + +v4: cgi sample search form, minor +2013-04-11 ralph@amissah.com +e626600a (tag: sisu_4.0.20) + +v4: sisurc.yml, reorganize configuration files +2013-04-11 ralph@amissah.com +954c48da + +v4: version & changelog +2013-04-11 ralph@amissah.com +00566b34 + +v4: version & changelog, dates touched +2013-04-08 ralph@amissah.com +769e79c9 (tag: sisu_4.0.19) + +v4: zap, delete output files, based on given (existing) source file name +2013-04-07 ralph@amissah.com +d2a0dcbc + +v4: options, exclude manifest links if no manifest (--no-manifest) selected +2013-03-31 ralph@amissah.com +4b1d0dd6 + +v4: sysenv, yamlrc cosmetic +2013-03-31 ralph@amissah.com +48ef624d + +v4 v3: CHANGELOGs note on future closing of v3 & addendum to [71e8f19] in 4.0.18 +2013-03-31 ralph@amissah.com +73f6919d +- CHANGELOG_v3, v3 branch to be closed on opening of 4.1.* branch, imminent +- CHANGELOG_v4, re-characterize/correct commit [71e8f19] in 4.0.18 as it also + fixes a persistent bug with manifest and should be: + - v4: dal, reading/processing of composite markup files (.ssm) + - dbi, import composite files correctly + - manifest, mini-table of contents, for multi-lingual composite files + was/is: v4: dbi, import composite files (.ssm) correctly + +v4: version & changelog +2013-03-31 ralph@amissah.com +4542c1f6 + +v4: version & changelog, dates touched +2013-03-29 ralph@amissah.com +5d087439 (tag: sisu_4.0.18) + +v4: cgi, auto-generated sample search form +2013-03-29 ralph@amissah.com +1a21bfdc +- for various sisu output directory structures +- fixes + +v4: dbi, import composite files (.ssm) correctly +2013-03-28 ralph@amissah.com +71e8f191 + +v4: dal, screen_text_color, distinguish doc abstraction, as start of processing +2013-03-26 ralph@amissah.com +ec23cce1 + +v4: version & changelog +2013-03-26 ralph@amissah.com +301cf2c0 + +v4: version & changelog, dates touched +2013-03-25 ralph@amissah.com +15eb564d (tag: sisu_4.0.17) + +v4: hub, non-verbose terminal info reduced, minor +2013-03-25 ralph@amissah.com +9729a8c4 + +v4: param, guard against situation where no document creator/author given +2013-03-25 ralph@amissah.com +745ce4ee + +v4: sysenv, copy or create homepages, one of the actions taken on --config +2013-03-25 ralph@amissah.com +e6855a21 +- provide info as to where manually created homepages may be stored +- do not make default sisu homepage (previously did) + +v4: manifest & harvest, links to default site home page index.html +2013-03-20 ralph@amissah.com +b2a1d9c6 + +v4: version & changelog +2013-03-20 ralph@amissah.com +e470286e + +v4: sysenv, epub images where processing multilingual doc in lang code sub-dir +2013-03-18 ralph@amissah.com +9c676215 (tag: sisu_4.0.16) + +v4: hub, processing flow, sequence, fix +2013-03-18 ralph@amissah.com +3156fe4d +- re-run manifests at end of general processing run: + - where document source shared and more than one markup file processed; + - where translations of same document exist (determined by filename) + +v4: version & changelog +2013-03-18 ralph@amissah.com +dc852816 + +v4: share document source, markup text file &/or sisupod +2013-03-18 ralph@amissah.com +c4a842ff (tag: sisu_4.0.15) +- processing flow, correct sequence +- terminal reporting + +v4: version & changelog +2013-03-18 ralph@amissah.com +79b75404 + +v4: version & changelog, dates touched +2013-03-16 ralph@amissah.com +f70ecf5e (tag: sisu_4.0.14) + +v4: sysenv, rsync remote placement, output_by? alternatives, tuning +2013-03-14 ralph@amissah.com +6d1eeba7 +- site harvest +- pdf fix +- backround rsync only for processing of single sisu markup files + +v4: manifest, links for output_by? alternatives, harvest & qrcode related +2013-03-14 ralph@amissah.com +f8820c25 + +v4: harvest, links for output_by? filename +2013-03-14 ralph@amissah.com +13143b5a + +v4: harvest, authors, topics, terminal info +2013-03-14 ralph@amissah.com +e5d62092 + +v4: version & changelog +2013-03-14 ralph@amissah.com +787674e1 + +v4: version & changelog, dates touched +2013-03-13 ralph@amissah.com +f9cb4b03 (tag: sisu_4.0.13) + +v4: hub, sql db, fix for actions not requiring files, create, drop, etc. +2013-03-13 ralph@amissah.com +0e87ea14 + +v4: hub, sysenv, remote, work on rsync of document/site build +2013-03-13 ralph@amissah.com +0f85875f + +v4: manifest, link to harvest authors & topics if available, else cosmeitc +2013-03-12 ralph@amissah.com +f88fb6e8 + +v4: terminal reporting, cosmetic +2013-03-12 ralph@amissah.com +79ebe464 + +v4: html_format, manifest red arrow, next (segment), (broken) link fix, to toc +2013-03-10 ralph@amissah.com +280d46e9 + +v4: version & changelog +2013-03-10 ralph@amissah.com +05cf1f8b + +v4: version & changelog, dates touched +2013-03-08 ralph@amissah.com +5fc0b669 (tag: sisu_4.0.12) + +v4: sysenv, cosmetic, minor +2013-03-08 ralph@amissah.com +7c083c2a + +v4: hub, operations, report on absent markup file, if needed by requested action +2013-03-08 ralph@amissah.com +5d7e44a5 + +v4: bin/sisu, process remote sisu markup file or sisupod, where url provided +2013-03-08 ralph@amissah.com +2f0fb405 + +v4: manifest, sysenv, manifests sisupod relative link for output_by language +2013-03-07 ralph@amissah.com +5ca9a5a2 + +v4: share_src, sisu source, permissions, make world readable when shared +2013-03-07 ralph@amissah.com +c6d43f00 + +v4: version & changelog +2013-03-07 ralph@amissah.com +d172907e + +v4: emacs, sisu-mode.el, version touch +2013-03-06 ralph@amissah.com +f647bdc4 (tag: sisu_4.0.11) + +v4: html_format, html segment navigation to toc, fix +2013-03-06 ralph@amissah.com +7725af73 + +v4: options, sisupod, name determination, fix +2013-03-06 ralph@amissah.com +8b8f2e95 +- needed for creation of multiple sisupods + +v4: sysenv, base images path determined from given path for sisu executable +2013-03-06 ralph@amissah.com +f949d5fc +- where system sisu not called directly + +v4: bin/sisu, expand given path for sisu executable +2013-03-06 ralph@amissah.com +0b047c0e +- where system sisu not called directly + +v4: version & changelog +2013-03-06 ralph@amissah.com +8c503894 + +v4: html, epub, minor "cleaning" of output +2013-03-05 ralph@amissah.com +839f0374 (tag: sisu_4.0.10) + +v4: sysenv, set default output (directory layout) type where none configured +2013-03-05 ralph@amissah.com +4dd30e8a +- (also turned off reporting where imagemagick & graphicsmagick not installed) + +v4: texpdf, report to STDERR when pdf not generated (Closes: #617359) +2013-03-05 ralph@amissah.com +27bd56ae +- note: .tex file is almost certainly produced by sisu, this will be a sisu + packaging, texlive dependency issue, preventing its conversion to pdf + +v4: version & changelog +2013-03-05 ralph@amissah.com +f288e2fe + +v4: documentation, sisu markup (sisu_markup.sst, man page sisu.1, sisu.1.html) +2013-02-22 ralph@amissah.com +f6f8918b (tag: sisu_4.0.9) + +v4: emacs, sisu-mode.el +2013-02-22 ralph@amissah.com +90ab101c + +v4: vim syntax, sisu.vim +2013-02-22 ralph@amissah.com +5d116feb + +v4: dal, markup: line across page divider -..- introduced +2013-02-22 ralph@amissah.com +9916bc2d +- an alternative to page breaks -\\- & =\\=, significantly affects pdf & odf +- output formats modified to include (pdf, odf, epub, html, plaintext) + +v4: version & changelog +2013-02-22 ralph@amissah.com +b097acbf + +v4 (v3): version & changelog, dates touched +2013-02-20 ralph@amissah.com +ca69bdd4 (tag: sisu_4.0.8) + +v4 (v3): html, modification to markup of angle brackets [<>] & ampersand [&] +2013-02-20 ralph@amissah.com +32a0e39a + +v4 (v3): epub, tinkering with headers & cleaning of angle brackets '<' & '>' +2013-02-20 ralph@amissah.com +9b67ec92 + +b_epub.png, epub icon (for manifest) updated to use official image +2013-02-20 ralph@amissah.com +3910ef3e + +v4: emacs, sisu-mode.el, sisu headers update, & cosmetic code reshuffle +2013-02-16 ralph@amissah.com +92a292ab + +v4 (v3): vim, ftplugin & colorschemes housekeeping, scheme "def*" added +2013-02-14 ralph@amissah.com +c312b7dd +- :colorscheme def256* defined from 256 colors (primarily 16 of them), terminal + & gui (identical) (terminal scheme based on frugal & extended to cover gui) +- :colorscheme def* cterm defined primarily using 16 colors (a few from 256) + (to be usable tweak .Xdefaults) gui provided along with Xdefault settings to + make cterm match this gui or def256* +- sisu.vim ftplugin pruning + +v4 (v3): cosmetic, minor code shuffle, & remove trailing white-spaces +2013-02-14 ralph@amissah.com +d2fa6daa + +v4 (v3): version & changelog +2013-02-14 ralph@amissah.com +a48ee879 + +v4 (v3): lib, bin/sisu, misc, code headers provide url to online git file source +2013-02-10 ralph@amissah.com +70570e97 (tag: sisu_4.0.7) +- e.g. bin/sisu header * Git + + + +v4 (v3): vim, minimal color schemes, minor edits +2013-02-10 ralph@amissah.com +c87da88d + +v4 (v3): dbi_discrete, discreet should have been discrete, renames accordingly +2013-02-10 ralph@amissah.com +2f8254f7 + +v4 (v3): version & changelog +2013-02-10 ralph@amissah.com +ed08c2b2 + +v4: version & changelog, dates touched +2013-02-07 ralph@amissah.com +ad6bcd26 (tag: sisu_4.0.6) + +v4: documentation, sisu_manual/sisu_commands, manpage & html +2013-02-07 ralph@amissah.com +e68a2c03 + +v4: options, for pdf, concentrate & simplify matching of orientation & papersize +2013-02-07 ralph@amissah.com +75dc380f + +v4: options, param, pdf papersize, command-line options to override sisurc +2013-02-06 ralph@amissah.com +bf57f03b + +v4: pdf (texpdf, options, hub, urls) orientation discrete, individually callable +2013-02-06 ralph@amissah.com +3d165560 + +v4: texpdf, cosmetic code +2013-02-06 ralph@amissah.com +1803ceb1 + +v4: sysenv, webserv dir (output dir), ensure is determined from base markup dir +2013-02-06 ralph@amissah.com +83a88c71 +- where relative path provided (remove possibility of path expansion being done + from a language sub-directory), fix + +v4: utils, SiSU_Utils::Path.new.base_markup provides base markup directory +2013-02-06 ralph@amissah.com +9729605b +- base markup directory contains sisu markup files, any language + sub-directories (with sisu markup files) and sisu resource configuration + sub-directory, if any (./_sisu) (identifies when needed in runtime) + +v4 (v3): utils (debug renamed), SiSU_Utils::CodeMarker (from Debug::Mark) +2013-02-06 ralph@amissah.com +cd01cd76 + +v4: html, screen reporting for --html-scroll, correctly identify output file +2013-02-06 ralph@amissah.com +5b0d2c1f + +v4 (v3): version & changelog +2013-02-06 ralph@amissah.com +6896a4a1 + +v4: documentation, include --html-scroll and --html-seg options +2013-02-03 ralph@amissah.com +0506d0a1 (tag: sisu_4.0.5) +- sisu_manual/sisu_commands +- manpage & html + +v4: html (urls), scroll & seg optionally discrete, individually callable +2013-02-03 ralph@amissah.com +9f278652 +- --html (both), --html-scroll, --html-seg +- [possibly of interest where only one form of html of interest for use &/or to + cut generation time (roughly to 63% for --html-scroll only)] + +v4 (v3): css (html & epub) line spacing reduced, paragraph spacing increased +2013-02-03 ralph@amissah.com +f18b8928 +- may need to tune spacing further to distinguish lines from new paragraphs + (especially where ocn is not used as the distinction may be less + clear/obvious) + +v4 (v3): html, includes book index fix, rest cosmetic +2013-02-04 ralph@amissah.com +7d29da19 + +v4 (v3): sysenv, on --redirect, stop creation of redundant dir +2013-02-03 ralph@amissah.com +3c26df4d + +v4 (v3): version & changelog +2013-02-03 ralph@amissah.com +7231c901 + +v4 (v3): version & changelog, dates touched +2013-01-31 ralph@amissah.com +1976c5ec (tag: sisu_4.0.4) + +v4 v3: dal (obj), html, br_page* behavior in html depending on origin of break +2013-01-31 ralph@amissah.com +fb6abb03 +- markup specified v auto + +v4: epub, constants, debug alternative for various readers ... work on +2013-01-31 ralph@amissah.com +8fe36572 + +v4 v3: dal, on ocn excluded paragraphs (~# -#), hang/indent bullet, fix +2013-01-31 ralph@amissah.com +d335e11e +- [bug reported indirectly by Cory Doctorow (discovered in work with markup)] + +v4: param_make, :cover_image: regex, less finicky match of image & details +2013-01-28 ralph@amissah.com +c0f656c0 +- [bug reported by Mikael Böök] + +v4 (v3): version & changelog +2013-01-28 ralph@amissah.com +02393c16 + +v4 (v3): version & changelog, dates touched +2013-01-27 ralph@amissah.com +65b6e769 (tag: sisu_4.0.3) + +v4: check xml representation of characters (& < > in particular) +2013-01-27 ralph@amissah.com +11907e10 + +v4 v3: epub, toc.ncx fix, navpoint_close +2013-01-27 ralph@amissah.com +46b067aa + +v4 v3: remove markup-sample, first edition of FaiF +2013-01-25 ralph@amissah.com +2e17db83 +- redundant here as 2nd edition (which is a similar type of text) is available +- Bug#698664 leads me to think about it +- free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst + & associated files (images & v3 "skin"), removed + +v4 (v3): 4.0.3 (3.3.6) version & changelog +2013-01-25 ralph@amissah.com +d39c54cf + +v4 v3: epub, epub_format, provide full depth epub table of contents +2013-01-23 ralph@amissah.com +ff824c5c (tag: sisu_4.0.2) +- [request Mikael Böök] + +v4 v3: xhtml structure error, fix missing +2013-01-23 ralph@amissah.com +7cc6d871 +- [bug reported by Mikael Böök] +- fix of additional detail + +v4 v3: epub_format, cosmetic arrangement of code <<-WOK +2013-01-23 ralph@amissah.com +62701442 + +v4 v3: epub_tune html_tune, remove unnecessary conversion of some utf-8 chars +2013-01-23 ralph@amissah.com +dc624352 +- epub, fix, messed up table of contents, toc.ncx + [bug reported by Mikael Böök] + +v4 v3: dal_doc_objects, cosmetic, code arrangement, minor +2013-01-23 ralph@amissah.com +edbb402e + + v4: sysenv, debug tag, triggered where output type not set +2013-01-23 ralph@amissah.com +6bc96aae + +v4 v3: param, match possible sisu versions, detail +2013-01-23 ralph@amissah.com +7363e25d + +v4 v3: texpdf_format, list of .sty files (& their texlive source within Debian) +2013-01-23 ralph@amissah.com +ad3483a9 +- not part of code (relevant for packaging) + + v4 (v3): 4.0.2 (3.3.5) version & changelog +2013-01-23 ralph@amissah.com +74e8462c + +date 2013: version & changelog; headers bin/sisu & lib/; code constants.rb +2013-01-01 ralph@amissah.com +7f0d8276 (tag: sisu_4.0.1) + +v4: documentation, sisu.1 manpage & minor +2012-12-30 ralph@amissah.com +780c5275 + +v4 v3: manpage, attempt to improve output (line-spacing) +2012-12-29 ralph@amissah.com +a757467e + +v4 v3: plaintext, in code blocks retain a blank empty line, a fix +2012-12-29 ralph@amissah.com +c9898a09 +- [known old bug, affects sisu_manual, fix request from SynrG on irc, re + live-manual] + +v4: options, sysenv, check (existing) inclusions & exclusions, fixes +2012-12-29 ralph@amissah.com +0788fabb +- command line, document header, sisurc + +v4 v3: param, minor change any legacy
line break in metadata markup to \\ +2012-12-28 ralph@amissah.com +e92c8626 + +v4 v3: html_segments (by_filename by_filetype) broken internal doc links fixed +2012-12-28 ralph@amissah.com +577f1efe +- filenames need to include lang code +- [chals on irc, re live-manual, debian-live] + +v4: bin/sisu sysenv, rc_path_options, provide fixed path to rc files +2012-12-28 ralph@amissah.com +3d4f38a0 +- added $sisu_document_markup_directory_base_fixed_path +- needed to read right sisurc.yml & sisu_document_make + +v4 v3: largely cosmetic +2012-12-28 ralph@amissah.com +e791dbbd + +v4: sisu: --color flag, which toggles color on/off (Closes: #622171) +2012-12-28 ralph@amissah.com +a4e463e1 +- the fix here is specific to color on/off for reporting of sisu version + - sisu --version --color-off || sisu -v -k || sisu -kv +- there are various ways to control color output to screen + - --color-off or -k switches color off + - --color or --color-on switches color on, which is usually the default + - --color-toggle or -c toggles the default setting (in most cases) + - sisurc.yml can set default color state which affects most screen output + +v4 v3: debug (internal code use), color markers for line number & file name +2012-12-28 ralph@amissah.com +6998914a +- colored location markers to show when line passed within running code + +v4 (v3): 4.0.1 (3.3.4) new branch & version & changelog "opened" +2012-12-28 ralph@amissah.com +607db61a + +v4: 4.0.0 version & changelog, dates touched +2012-12-12 ralph@amissah.com +a75d469b (tag: sisu_4.0.0) + +v4: documentation; markup samples & help +2012-11-18 ralph@amissah.com +eae9bb93 + +v4: vim syntax, sisu.vim, make, new headers +2012-11-18 ralph@amissah.com +7500ecc9 + +v4: document headers, metadata rearranged, wide-ranging effect +2012-11-15 ralph@amissah.com +b147bcd3 + +v4: sisupod, use common make instruction header for documents +2012-11-05 ralph@amissah.com +60149df7 +- sisupod make instruction header file, write & read +- sisu config file names placed in constants + +v4: param, common independent document @make: header file +2012-10-03 ralph@amissah.com +f38a6456 +- ./_sisu/v4/sisu_document_make +- contains @make: header +- can contain @links: header + - @links:+ append links + - @links: default, overwritten if document contains links + +v4: param (header make), pdf, footer +2012-10-03 ralph@amissah.com +c041ea2e + +v4: param (header make), html, home button: text button; image/icon button +2012-10-03 ralph@amissah.com +65033374 + +v4: param (header make), epub, pdf, book cover images +2012-10-03 ralph@amissah.com +7456ed5b + +v4 (&v3): markup samples, for v4 remove skins, separate (v3 & v4) directories +2012-10-03 ralph@amissah.com +e51589fd + +v4: skins, remove +2012-10-03 ralph@amissah.com +2099cce1 +- remove skins +- defaults, rename class Defaults (was InfoSkin) +- sisupod, remove skin +- db + - no skin info to store, omitted from structure + - change prefix name (structure changed) + +v4: defaults, some cleaning +2012-10-03 ralph@amissah.com +bb3101d1 + +v4: bin/sisu $*, hub, make possible to specify dir path for markup files +2012-10-03 ralph@amissah.com +f6bc7d81 +- bin/sisu4 & bin/sisu3 now syslinks to bin/sisu + +v4: bin/sisu $0, make possible to run sisu command on/within project dir tree +2012-10-03 ralph@amissah.com +ac4a6aaa +- (previously sisu needed to be correctly installed with system paths honored) +- NOTE: loading of skins turned off + +v4: 4.0.0 new branch & version & changelog "opened" +2012-10-03 ralph@amissah.com +804a1037 + +v3: 3.3.3 version & changelog, dates touched +2012-10-03 ralph@amissah.com +f08ab383 (tag: sisu_3.3.3) + +v3: markup samples, and help, minor updates +2012-10-01 ralph@amissah.com +78b70334 + +v3: cgi search script, minor +2012-10-01 ralph@amissah.com +610573c4 + +v3: db, book_idx field & minor re-arrangement +2012-10-01 ralph@amissah.com +8e40c8f6 + +v3: header @classify: :topic_register: provide greater classification "depth" +2012-10-01 ralph@amissah.com +d6ef30b3 +- param, manifest +- harvest_topics + +v3: dal, sysenv, file processing, split objects; remove ref to old ruby +2012-10-01 ralph@amissah.com +52e870e3 +- markup file processing, change to sourcefile readlines & split of sourcefile array +- removal of RUBY_VERSION references to older versions of ruby + +v3: some fixes, cleaning, removing +2012-10-01 ralph@amissah.com +d98f2708 + +v3: cosmetic code, remove javascript holders js_ (not used) +2012-10-01 ralph@amissah.com +5e1bcfbb + +v3: cosmetic code, .is_a?(X) replaces .class==X (& some defined? & nil? tests) +2012-10-01 ralph@amissah.com +6b2c4479 + +v3: cosmetic code, if true ; x, remove semicolons replace with "then" +2012-10-01 ralph@amissah.com +32d32bf7 + +v3: cosmetic code, if, else, remove some semicolons (;) replace with newlines +2012-10-01 ralph@amissah.com +02cc96fb + +v3: cosmetic code, true ? x : y +2012-10-01 ralph@amissah.com +7d4665f6 + +v3: vim, ftplugin/sisu.vim +2012-10-01 ralph@amissah.com +ad6cf3c8 +- linenumbering: on; relative; off, nn +- cursor line & column: on; off, cu (existing cu+ & cu-) + +v3: odf, internal links/bookmarks, toc, book index +2012-10-01 ralph@amissah.com +58c13f49 + +v3: vim syntax, sisu.vim, =\\= page new & -\\- page break +2012-10-01 ralph@amissah.com +b553ca81 + +v3: dal_syntax, new syntax: =\\= page new & -\\- page break +2012-10-01 ralph@amissah.com +ef4da2e9 +- alias for <:pn> and <:pb> respectively + +v3: html, epub, group text, bullet, fix +2012-10-01 ralph@amissah.com +e5fe0553 + +v3: texpdf fixes +2012-10-01 ralph@amissah.com +d96753b4 +- group text, bullet +- group text, hardspaces at start of line (indent) +- group text, pass through special characters safe +- poem, bold etc. + +v3: pdflatex, landscape cover page was botched, came out as portrait, fix +2012-10-01 ralph@amissah.com +f90e9b26 + +v3: options, opt_act, limit calls +2012-10-01 ralph@amissah.com +78566728 +- ruby profiler indicates much time spent here, reduce + +v3: sisupod source, paths fix +2012-10-01 ralph@amissah.com +2ea56a48 + +v3: dbi, pgsql, report need for instructions when none given +2012-08-29 ralph@amissah.com +dd13f639 + +v3: some pre-unicode meddling sorted +2012-08-29 ralph@amissah.com +662cd26d +- covers bug reported as middle dot changed to asterisk by chals + +v3: bin/sisu, hub, reorganize call +2012-08-29 ralph@amissah.com +b4694609 + +v3: sisu -v, provide version information, fix +2012-08-29 ralph@amissah.com +8f9076f3 + +v3: constants, year static (current): YEAR=2012 +2012-08-29 ralph@amissah.com +1d401760 + +v3: 3.3.3 version & changelog "opened" +2012-08-29 ralph@amissah.com +c2f44d3b + +sha256 (3.3.2) +2012-06-30 ralph@amissah.com +cbe96983 + +v3: texpdf, xetex screen reporting of warnings off unless sisu -pV used +2012-06-30 ralph@amissah.com +a1a1c16e (tag: sisu_3.3.2) + +v3: 3.3.2 version & changelog "opened" +2012-06-30 ralph@amissah.com +6c8cd334 + +sha256 (3.3.1) +2012-06-23 ralph@amissah.com +22a22000 + +v3: sysenv, rsync put (post to remote site), fix, needs comprehensive check +2012-06-23 ralph@amissah.com +990bafcf (tag: sisu_3.3.1) +- broken since version 3 (did not cope with alternative output structures, + initial fix +- still broken: + - rsync get (sisu source); + - scp put & scp get) + +v3: texpdf_format, urls in headings break pdf documents, fix +2012-06-23 ralph@amissah.com +55e1f9c8 +- e.g. output generation of document sample gpl.fsf.sst pdf fixed + +v3: hub, some re-arrangement +2012-06-23 ralph@amissah.com +ffb99605 + +v3: 3.3.1 version & changelog "opened" +2012-06-23 ralph@amissah.com +1de02aac + +sha256 (3.3.0) +2012-06-17 ralph@amissah.com +7e27b557 + +v3: shared_sisupod_source, common build for sisu (markup) source representations +2012-06-17 ralph@amissah.com +fed01af6 (tag: sisu_3.3.0) +- to be used by sisupod.txz, git, (and src) + - sisupod_make (--sisupod) + - share_source (--source) + NOTE not used git at present +- changed representation of shared sisu source, include related files in + directory rather than just markup file [reason for version bump] + NOTE there are no changes to sisu markup (only the sharing of source files) + +v3: 3.3.0 version & changelog "opened" +2012-06-17 ralph@amissah.com +12adefb6 + +sha256 (3.2.12) +2012-06-07 ralph@amissah.com +0cda3630 + +v3: hub, post bundles, sisupod_make, file selection selection for tar.xz, fix +2012-06-06 ralph@amissah.com +c8d6617b (tag: sisu_3.2.12) + +v3: sysenv, check @md.make.respond_to?(:skin) +2012-06-06 ralph@amissah.com +3ca890e2 + +v3: html_segments, @make.build.html_navigation?, fix, (excludes --exc-html-) +2012-06-06 ralph@amissah.com +7b13cb9a + +v3: html, excludes (options) --exc-html-top-band, touch +2012-06-06 ralph@amissah.com +1e089ff9 +- html (toc & scroll), (html_segments, concordance,) exclude top band + sisu --exc-top-band --html --concordance filename.sst + +v3: screen reporting, ansi colors, cosmetic +2012-06-06 ralph@amissah.com +3c8feda2 + +v3: shared_images, fix +2012-06-06 ralph@amissah.com +6715da88 + +v3: dbi_discreet, screen reporting db location, fix +2012-06-06 ralph@amissah.com +dd790c75 + +Rake, Rant sisu installer require ruby >= 1.9.3 +2012-06-06 ralph@amissah.com +b5323c89 + +v3: 3.2.12 version & changelog "opened" +2012-06-06 ralph@amissah.com +09193958 + +sha256 (3.2.11) +2012-06-03 ralph@amissah.com +64bd8217 + +v3: images, copy (system link removed) +2012-06-03 ralph@amissah.com +35e3bcae (tag: sisu_3.2.11) + +v3: images, regular & sisupod +2012-06-03 ralph@amissah.com +26e5e47c + +v3: manifest, paths, (for command line selection of output type) fix +2012-06-03 ralph@amissah.com +a8876438 + +v3: urls, sisupod, fix +2012-06-03 ralph@amissah.com +9c234e6f + +v3: warn when files to be copied not found, add +2012-06-03 ralph@amissah.com +33417c59 + +v3: error & warning messages touched, revisit +2012-06-03 ralph@amissah.com +2cd635d5 + +v3: 3.2.11 version & changelog "opened" +2012-06-03 ralph@amissah.com +c3a4d655 + +sha256 (3.2.10) +2012-05-28 ralph@amissah.com +e48ecd9e + +v3: html_format, minor cleaning +2012-05-28 ralph@amissah.com +e8b29c36 (tag: sisu_3.2.10) + +v3: hub, share markup source (--source) not available for composite files +2012-05-28 ralph@amissah.com +fae668e5 +- suggest creating a sisupod instead + +v3: sisupod.txz processing +2012-05-28 ralph@amissah.com +45a35b75 +- BUG image copying/processing for sisupod + +v3: hub, manifest re-run where related multilingual documents, fix +2012-05-28 ralph@amissah.com +38e85ccf +- BUG breaks mini table of contents (minitoc) manifest for multilingual files, + better run without manifest minitoc, use --exc-manifest-minitoc + +v3: css, ensure css available for generated content +2012-05-28 ralph@amissah.com +a8493b25 +- checks whether exists if not copies (for --init-site / --configure just + copies, takes as a re-copy request) + +v3: documentation update, command line control of output dir structure +2012-05-28 ralph@amissah.com +3faa85c6 +- --output-by-language; --output-by-filetype; --output-by-filename, or + --by-language; --by-filetype; --by-filename +- sisu_commands.ssi, manpage sisu.1, man2html + +v3: options, command line control of output directory structure +2012-05-28 ralph@amissah.com +ba278b92 +- --output-by-language; --output-by-filetype; --output-by-filename, or + --by-language; --by-filetype; --by-filename + +v3: options, --init-site, --configure, fix +2012-05-28 ralph@amissah.com +6e6602f0 + +v3: hub, "requires", fix +2012-05-28 ralph@amissah.com +23a90535 + +v3: code headers mainly copyright +2012-05-28 ralph@amissah.com +965fe1f6 + +v3: 3.2.10 version & changelog "opened" +2012-05-28 ralph@amissah.com +8cc2ed96 + +sha256 (3.2.9) +2012-05-19 ralph@amissah.com +220350d5 + +v3: options, create manifest touched +2012-05-19 ralph@amissah.com +8754d67b (tag: sisu_3.2.9) + +v3: harvest, fix some details +2012-05-19 ralph@amissah.com +b26ce9d5 +- harvest by filename output paths +- harvest_topics, add level +- harvest_topics, alternative headings, fix + +v3: 3.2.9 version & changelog "opened" +2012-05-19 ralph@amissah.com +bd9d05b9 + +sha256 (3.2.8) +2012-05-12 ralph@amissah.com +784eb3fd + +v3: sisupod make, re-fixed, check again +2012-05-12 ralph@amissah.com +2dee3abf (tag: sisu_3.2.8) + +v3: po4a, runs, needs checking +2012-05-12 ralph@amissah.com +35825d22 + +v3: hub, fixes, still a construction zone +2012-05-12 ralph@amissah.com +64c73059 + +v3: a few misc fixes +2012-05-12 ralph@amissah.com +5fffe95f +- options, omissions and typo fix +- particulars, fix, check +- shared_metadata, fix + +v3: sst_identify_markup, document header SiSU 3.0 +2012-05-12 ralph@amissah.com +782e36f0 +- pretty much as SiSU 2.0, some header additions +- identification not fully implemented + +v3: reporting, composite file names touched +2012-05-12 ralph@amissah.com +5dace955 + +v3: rescue & error warnings, more touched +2012-05-12 ralph@amissah.com +99965a52 + +v3: 3.2.8 version & changelog "opened" +2012-05-12 ralph@amissah.com +0832d42c + +sha256 (3.2.7) +2012-05-07 ralph@amissah.com +d13ffd55 + +v3: hub, options, fixes: dbi: pgsql, sqlite +2012-05-06 ralph@amissah.com +6c38bed1 (tag: sisu_3.2.7) + +v3: qrcode, fixes +2012-05-06 ralph@amissah.com +da82e36f +- ensure manifest is run +- urls fix + +v3: rescue & error warnings, some touched +2012-05-06 ralph@amissah.com +5af7a5e4 + +v3: 3.2.7 version & changelog "opened" +2012-05-06 ralph@amissah.com +d52bc28d + +sha256 (3.2.6) +2012-05-01 ralph@amissah.com +67b15a43 + +v3: hub (seek finer grained control over what happens when; causes breakage) +2012-05-01 ralph@amissah.com +f297b90d (tag: sisu_3.2.6) +- (primarily) cycle files then options (instead of options then files) +- manifest re-run on (currently generated) translated files if any + +v3: misc, minor +2012-05-01 ralph@amissah.com +714a14fc + +v3: harvest (metadata, site/document summary) fixes +2012-05-01 ralph@amissah.com +aae35fa1 +- harvest_topics, sort fix +- harvest_authors, minor fix +- sst content parsing lang dir +- output file location, currently works for (by?) :language & :filetype + +v3: 3.2.6 version & changelog "opened" +2012-05-01 ralph@amissah.com +712054c1 + +sha256 (3.2.5) +2012-04-22 ralph@amissah.com +93e1767e + +v3: shared_html_lite, codeblock fix, affecting sql +2012-04-22 ralph@amissah.com +173a8bec (tag: sisu_3.2.5) +- SELECT ocn,body FROM doc_objects WHERE t_is='code'; + +v3: 3.2.5 version & changelog "opened" +2012-04-22 ralph@amissah.com +f95eb559 + +sha256 (3.2.4) +2012-04-21 ralph@amissah.com +554b061d + +v3: rescue reporting +2012-04-21 ralph@amissah.com +d810b3f1 (tag: sisu_3.2.4) + +v3: sysenv, default processing dir name change +2012-04-21 ralph@amissah.com +5ae11e06 +- distinguish sisu branch, add sisu branch to processing directory name +- if constants, 'DEVELOPER[:maintenance] == :true' then additionally add + sisu version number to processing directory name + +v3: db bugfix in maintenance mode (variable name reused) +2012-04-21 ralph@amissah.com +06520be4 + +v3: 3.2.4 version & changelog "opened" +2012-04-21 ralph@amissah.com +a8b86404 + +sha256 (3.2.3) +2012-04-15 ralph@amissah.com +93f30fc1 + +v3: vim syntax highlighting, document header added (@make:) :substitute: +2012-04-15 ralph@amissah.com +8fefa22f (tag: sisu_3.2.3) + +v3: param, dal_syntax, document header (simple regex) substitution list +2012-04-15 ralph@amissah.com +0013ec9d +- $ and curly braces are escaped (within sisu) to allow the following: + @make:\n :substitute: /${linux-distro}/,'Debian' /${stable}/,'Squeeze' \ + /${testing}/,'Wheezy' +- changes are not made within text object types: code-blocks, tables or + metadata (document headers). Marked up document remains self-referential. +- Note: the substitution list must be written on a single line, without + line-breaks. +- [Substitutions possibility requested by Debian-live, live-manual (Ben + Armstrong & Daniel Baumann)] + +v3: 3.2.3 version & changelog "opened" +2012-04-15 ralph@amissah.com +0e9a8b0c + +sha256 (3.2.2) +2012-04-05 ralph@amissah.com +9de3fc4c + +v3: sql creation -v reporting reduced +2012-04-05 ralph@amissah.com +683ca12c (tag: sisu_3.2.2) + +v3: urls, reporting, some cleaning +2012-04-05 ralph@amissah.com +6a6c011f + +v3: sysenv, path.style (a quick fix, review) +2012-04-05 ralph@amissah.com +19c96080 + +v3: 3.2.2 version & changelog "opened" +2012-04-05 ralph@amissah.com +b9d03b2c + +sha256 (3.2.1) +2012-03-21 ralph@amissah.com +db578f67 + +v3: documentation sisu_commands, manpage, html (man2html) +2012-03-21 ralph@amissah.com +582f1bbd (tag: sisu_3.2.1) + +COPYRIGHT add markup samples "Free as in Freedom" +2012-03-21 ralph@amissah.com +a5873a42 + +v3: 3.2.1 version & changelog "opened" +2012-03-21 ralph@amissah.com +d8beb2f4 + +sha256 (3.2.0) +2012-03-19 ralph@amissah.com +9b91ce64 + +COPYRIGHT, name change using uppercase, format changed +2012-03-19 ralph@amissah.com +6528dc88 (tag: sisu_3.2.0) +- content format influenced by Machine-readable debian/copyright file + + +v3: 3.2 branch is main (v3dv --> v3); dev (v3dv) branch directories removed +2012-03-19 ralph@amissah.com +6811ac91 +- v3dv (3.2) "merged" into v3 (previously 3.1) (& removed) + - conf/sisu/v3dv --> conf/sisu/v3 + - data/sisu/v3dv --> data/sisu/v3 + - lib/sisu/v3dv --> lib/sisu/v3 + - bin/sisu* (v3dv references changed to v3) + - (--dev modifier (superfluous for the time being) runs main v3 branch) + +v3: 3.2.0 version & changelog "opened" +2012-03-19 ralph@amissah.com +349975b7 + +sha256 (3.1.15-2) +2012-03-13 ralph@amissah.com +356854c1 + +sha256 (3.1.15) +2012-03-12 ralph@amissah.com +553f6bab + +v3dv: documentation sisu_commands, add sqlite3 discreet +2012-03-12 ralph@amissah.com +58bc2e51 (tag: sisu_3.1.15) + +v3dv: sqlite3 discreet .sql.db file for each document (possibility added) +2012-03-12 ralph@amissah.com +86b767b0 +- in addition to existing possibility of a shared db in sqlite3 or postgresql + +v3dv: documentation sisu_commands, rearranged & update with regard to excludes +2012-03-12 ralph@amissah.com +b53d63a6 +- sisurc.yml omit list, commented out omit line with single example added + +v3dv: vim syntax highlighting, document header added :omit: (under @make) +2012-03-12 ralph@amissah.com +c79ce1e8 + +v3dv: start using output control hooks +2012-03-12 ralph@amissah.com +756caa5d +- for config file, document headers, & command line +- v3dv: sysenv, ProcessingSettings, start to use hooks to make it possible + to control (via: the command line; the document markup header, or; the + configuration file) the likes of: ocn, toc, segsubtoc, minitoc, + links-to-manifest, search-form, html-navigation, html-navigation-bar, + html-right-pane, html-top-band; these are switched on by default and may + be switched off in omit lists within configuration file, the document + markup header, or command line. The command line takes precedence & may + switch on or off overriding settings within the document markup header or + the sisu configuration file. + - --inc- on by default, but if switched off in doc header or + configuration, the command line --inc- has precedence; for each possible + exclude configuration the --inc- switch that overrides configuration + settings + - --exc- == --no-; exclude/switch off feature (but --inc- include has + precedence) + - document header @build: :omit: [list output features to be omitted] + - configuration (sisurc.yml) omit: + exclude output feature, overrides configuration settings (omit --dev + development branch modifier once merged back to main) + --exc-ocn, html (seg, scroll), epub, xml, pdf + sisu --dev --exc-ocn --html --epub --xml-sax --xml-dom --xhtml -v \ + filename.sst + --exc-toc, html (scroll), epub, pdf + sisu --dev --exc-toc --html --epub --pdf -v filename.sst + --exc-segsubtoc html (seg), epub + sisu --dev --exc-segsubtoc --html --epub -v filename.sst + --exc-minitoc, html (seg), concordance, manifest + sisu --dev --exc-minitoc --html --concordance -v filename.sst + --exc-manifest-minitoc, manifest + sisu --dev --exc-manifest-minitoc --html -v filename.sst + --exc-links_to_manifest, --exc-manifest-links, + html (seg, scroll) + sisu --dev --exc-manifest-links --html -v filename.sst + --exc-search-form, html (seg, scroll), manifest + sisu --dev --exc-search-form --html -v filename.sst + --exc-html-minitoc, html (seg), concordance + sisu --dev --exc-html-minitoc --html --concordance -v filename.sst + --exc-html-navigation, html (seg, scroll)? + sisu --dev --exc-html-navigation --html -v filename.sst + --exc-html-navigation-bar, html (seg) + sisu --dev --exc-html-navigation-bar --html -v filename.sst + --exc-html-search-form, html (seg, scroll) + sisu --dev --exc-html-search-form --html -v filename.sst + --exc-html-right-pane, html (seg, scroll) + sisu --dev --exc-html-right-pane --html -v filename.sst + --exc-html-top-band, html (seg, scroll), concordance (minitoc is + forced on to provide seg navigation) + sisu --dev --exc-html-top-band --html --concordance -v filename.sst + +v3dv: sysenv, param, options, output control hooks code modified +2012-03-12 ralph@amissah.com +4cdfa555 +- for config file, document headers, & command line +- requiring downstream code changes (in commit that follows) + +v3dv: texinfo, fix (break holding back 3.2 merge) +2012-03-12 ralph@amissah.com +231c64ec +- proposed next version starts 3.2, (merge dev branch after 3.1.15) + +v3dv: lib, clean trailing whitespace +2012-03-12 ralph@amissah.com +2e1d0030 + +v3 v3dv: 3.1.15 & 3.2.0~pre version & changelog "opened" +2012-03-12 ralph@amissah.com +dc4c672e + +sha256 (3.1.14) +2012-02-14 ralph@amissah.com +8f91f70e + +v3dv: control hooks +2012-02-14 ralph@amissah.com +6d898f1e (tag: sisu_3.1.14) +- hooks to make it possible to control (via: the command line; the document + markup header, or; the command line) the likes of: toc, manifest, + manifest-links, metadata, html-minitoc, html-navigation, html-navigation-bar; + these are switched on by default and control takes the form of making it + possible to switch them off. + +v3dv: dal, remove sisu_manifest from document structure & toc +2012-02-14 ralph@amissah.com +f653df16 +- html & epub coding affected + +v3dv: --redirect (--redirect=dir_path) & --dump (--dump=dir_path) + consequences +2012-02-14 ralph@amissah.com +2b884fb7 +- --dump places output in directory specified, if none specified in the current + directory (pwd). +- --redirect places output in subdirectory under specified directory, + subdirectory uses the filename (without the suffix). If no output directory is + specified places the subdirectory under the current directory (pwd). +- html, css incorporated into each file (concordance & manifest included) +- html, xhtml & xmls, css copied into css subdirectory (not used by html as + embedded) +- html xmls, images copied to output directory +- no links to manifest +- manifest with relative links only +- longer html filenames given to avoid names clashing (e.g. for toc, manifest, + concordance) +- html, epub, remove manifest toc links +- -j copy images associated with file (images used by html & xmls) + - automatically invoked by --dump & redirect +- v3 v3dv: document --redirect, --dump, -j update sisu_commands.sst + [documents not generated until v3.2.0 (when v3dv branch is merged into v3)] + +v3dv: sysenv, output_dir_structure, rewritten, affected code modified +2012-02-14 ralph@amissah.com +8138e230 + +v2: vim syntax highlighting, patch from Thilo Six applied +2012-02-14 ralph@amissah.com +525b4f1a +- Re: & + + [for v3, see sisu_3.1.13 changelog] + +v2 v3 v3dv: 3.1.14 & 3.2.0~pre (& 2.9.12) version & changelog "opened" +2012-02-14 ralph@amissah.com +7fbe3413 + +sha256 (3.1.13) +2012-02-03 ralph@amissah.com +87f10378 + +v3dv, dal +, use symbols to identify document objects type (is) and group (of) +2012-02-03 ralph@amissah.com +7e3cee57 (tag: sisu_3.1.13) +- (dal & code affected as a result) + +v3 v3dv: path & url links, updates for multiple output directory structures +2012-02-03 ralph@amissah.com +145f3092 + +v3 v3dv: vim syntax highlighting, patch from Thilo Six applied +2012-02-03 ralph@amissah.com +6dd8de87 +- Re: & + + +v3 v3dv: 3.1.13 & 3.2.0~pre version & changelog "opened" +2012-02-03 ralph@amissah.com +071c6dbb + +sha256 (3.1.12) +2012-01-23 ralph@amissah.com +527f9054 + +v3dv: replace use of most ruby exclamation (!) method actions +2012-01-23 ralph@amissah.com +21f5e220 (tag: sisu_3.1.12) + +v3dv: call most methods by full name (include associated module & class names) +2012-01-23 ralph@amissah.com +3d6deb1d +- messing with code, merge back now likely to become v3.2 + +v3dv: sysenv, use "which" instead of "whereis" to locate programs, test +2012-01-23 ralph@amissah.com +45a3eb91 +- [suggested by, Timothy Hume, used to get sisu texpdf to work on MacOS] + +v3 v3dv: texpdf, tampering with "safe" special character transformations, a fix +2012-01-23 ralph@amissah.com +7e9a59ca +- could introduce new issues, watch +- [reported by Timothy Hume, pdf title bug "&" not represented] + +v3 v3dv: urls, odt maintenance path fix +2012-01-23 ralph@amissah.com +0b38bae2 + +v3 v3dv: 3.1.12 & 3.2.0~pre version & changelog "opened" +2012-01-23 ralph@amissah.com +89bbbb52 + +sha256 (3.1.11) +2012-01-10 ralph@amissah.com +aa8f0cea + +v3dv: SiSU_DAL_ for module names in dal, & module Metadata is SiSU_Metadata +2012-01-10 ralph@amissah.com +16db2c67 (tag: sisu_3.1.11) +- v3dv: modify.rb script (& its artifact) removed (after use) from lib/sisu + modify.rb script remains available (in generic form) under: + data/sisu/v3/conf/convert/modify.rb + data/sisu/v3dv/conf/convert/modify.rb + +v3dv: make further changes to module names & test +2012-01-10 ralph@amissah.com +19e69de6 + +v3dv: class names, use more CamelCase +2012-01-10 ralph@amissah.com +df67ee10 + +v3dv: class names, remove "SiSU_" (reserve for module names for consistency) +2012-01-10 ralph@amissah.com +732dca2b + +v3dv: module names, use more CamelCase +2012-01-10 ralph@amissah.com +51ba2d70 + +v3dv, add dev branch (use to make some changes to module & class names & test) +2012-01-10 ralph@amissah.com +75e3bf86 +- (intended as) short term branch, merge back into v3 once tested +- sisu --dev (to invoke) + +v3: date, year 2012, update +2012-01-10 ralph@amissah.com +1677a583 + +v3: modify.rb, prep script for year update, & changing module & class names +2012-01-10 ralph@amissah.com +a0c28268 + +v2: modify, sisu markup version script (take from v3) +2012-01-10 ralph@amissah.com +9d687db1 + +v2 v3: 3.1.11 version & changelog "opened" +2012-01-10 ralph@amissah.com +aef3a251 + +sha256 (3.1.10) +2011-12-31 ralph@amissah.com +c977c099 + +v3: html, epub, (& xml) codeblocks, treatment of '<<' & '>>', fix +2011-12-31 ralph@amissah.com +66d81556 (tag: sisu_3.1.10) +- (remove legacy codeblock match rule, watch) + +v3: 3.1.10 version & changelog "opened" +2011-12-31 ralph@amissah.com +7c9212ef + +sha256 (3.1.9) +2011-12-19 ralph@amissah.com +5712c0bc + +v3: html, seg output, index.html fixes +2011-12-19 ralph@amissah.com +d71c116e (tag: sisu_3.1.9) +- place in correct directory and use language code as appropriate +- remove broken index.html from output [note the existing erroneous file is + not removed by a program run, it has to be removed manually] +- [issue reported by chals (debian live-manual) on irc oftc #sisu] + +v3: sysenv, html files in _sisu/home (*.html) copied as home pages +2011-12-19 ralph@amissah.com +9ef4a603 + +v3: options, --find & --glob, use for general search in base directory +2011-12-19 ralph@amissah.com +598c4fe8 +- cannot be limited by sub-directory, error message provided + +v3: 3.1.9 version & changelog "opened" +2011-12-19 ralph@amissah.com +a39fede4 + +sha256 (3.1.8) +2011-12-13 ralph@amissah.com +cfaad12e + +v3: texpdf, output_by: filetype, fix, language code part of filename, fix +2011-12-13 ralph@amissah.com +b77338f9 (tag: sisu_3.1.8) +- files previously given same name and written over +- [reported by chals (live-manual) on irc oftc #sisu] +- [output_by language and filename ok] + +v3: odf:odt, codeblocks, a match fix, affects e.g. "<<" +2011-12-13 ralph@amissah.com +0607a1bd + +v3: 3.1.8 version & changelog "opened" +2011-12-13 ralph@amissah.com +59a52e3d + +sha256 (3.1.7) +2011-12-08 ralph@amissah.com +a6aadc4d + +v3: documentation, manpage & html (man2html) +2011-12-08 ralph@amissah.com +02607532 (tag: sisu_3.1.7) + +v3: documentation, add --configure, use ascii chars for dir tree, correct typos +2011-12-08 ralph@amissah.com +cda92b55 + +v3: sysenv, only copy external images directory if it exists +2011-12-08 ralph@amissah.com +4c67b33e + +v3: texpdf, codeblocks, use listings package (for grey box) +2011-12-08 ralph@amissah.com +595970ff +- (internally retain possibility to use boites package) + +v3: epub, css, codeblock, grey box +2011-12-08 ralph@amissah.com +9ea7b7f1 + +v3: dal, codeblocks, removed identifier tags, changed markup of "<" & ">" +2011-12-08 ralph@amissah.com +9cdd523c + +v3: 3.1.7 version & changelog "opened" +2011-12-08 ralph@amissah.com +858fc0bd + +sha256 (3.1.6) +2011-12-02 ralph@amissah.com +5989174e + +v3: texpdf, use boites for box round codeblocks +2011-12-02 ralph@amissah.com +d5137332 (tag: sisu_3.1.6) +- use and adapt 'boitecoloriee' (found in boites_examples.sty) +- in boitebox as setup normal tex hardspaces at start of line are removed, + hack required to fix + +v3: dal, codeblocks, start flush left (no buffer spaces at start of line) +2011-12-02 ralph@amissah.com +acd2e817 +- allows cut & paste of codeblocks (from some output formats) + [requested by chals irc.oftc] + +v3, require iconv (removed), should use String#encode instead, watch +2011-12-02 ralph@amissah.com +83f669a0 +- removed iconv, required a number of places without being used, watch + +v3: 3.1.6 version & changelog "opened" +2011-12-02 ralph@amissah.com +fc908660 + +sha256 (3.1.5) +2011-11-21 ralph@amissah.com +a4295e20 + +v3: odf:odt v1.2 +2011-11-21 ralph@amissah.com +2d9e5eca (tag: sisu_3.1.5) +- includes previously unimplemented hanging indents + - done: dal, plaintext, html, epub, xhtml, xml (sax & dom), odt, pdf, sql; + not done: man, info + +v3: param, sisupod_make, sisu markup embedded symbol images regex, case added +2011-11-21 ralph@amissah.com +b19886a0 + +v3: sisu manual, sisu markup, e.g. of link shortcut for multiple sisu documents +2011-11-21 ralph@amissah.com +ecd91fe8 + +v3: dal_expand_insertions, link shortcut for sisu documents, omit codeblocks +2011-11-21 ralph@amissah.com +b5c036a6 + +v3: 3.1.5 version & changelog "opened" +2011-11-21 ralph@amissah.com +b80f7bea + +sha256 (3.1.4) +2011-11-11 ralph@amissah.com +4a239cf6 + +v3: FileUtils, replace system calls +2011-11-11 ralph@amissah.com +b59529b2 (tag: sisu_3.1.4) + +v3: FileUtils, make explicit calls (more verbose, easier to find) +2011-11-11 ralph@amissah.com +d17e7245 + +v3: 3.1.4 version & changelog "opened" +2011-11-11 ralph@amissah.com +d480a1dc + +sha256 (3.1.3) +2011-11-05 ralph@amissah.com +ed249df6 + +v3: fix necessary, Re: (3.1.2) [da4acc7] header, bold & italic pattern matching +2011-11-05 ralph@amissah.com +f3015990 (tag: sisu_3.1.3) +- header, bold & italic pattern matching, ignore case (possibility reinstated) + @make: :bold: :italic: /[regex]/i + +v3: 3.1.3 version & changelog "opened" +2011-11-05 ralph@amissah.com +6404e3e9 + +sha256 (3.1.2) +2011-10-31 ralph@amissah.com +daa1082c + +v3: header, bold & italic pattern matching, ignore case (possibility reinstated) +2011-10-31 ralph@amissah.com +da4acc73 (tag: sisu_3.1.2) +- (bold & italic pattern matching) @make: :bold: :italic: /[regex]/i + +v3: sysenv, skins, a fix +2011-10-31 ralph@amissah.com +87608df7 + +v3: conf/convert/modify.rb minor fixes +2011-10-31 ralph@amissah.com +df67ba29 + +v3: concordance, information to terminal, minor +2011-10-31 ralph@amissah.com +3ba9db64 + +v3: markup-samples, Free as in Freedom 2.0, made use of old book index +2011-10-31 ralph@amissah.com +c148cfd1 +- (made use of old book index) better than none + +v3: markup-samples, Free as in Freedom 2.0 +2011-10-31 ralph@amissah.com +12ffabde + +v3: 3.1.2 version & changelog "opened" +2011-10-31 ralph@amissah.com +9c52c3cc + +sha256 (3.1.1) +2011-10-15 ralph@amissah.com +97df42b6 + +v3: odf:odt, make odt style names more easily recognizable +2011-10-15 ralph@amissah.com +aa06692c (tag: sisu_3.1.1) + +v2 v3: odf:odt v1.0: make odt header easier to track; remove binary blob +2011-10-15 ralph@amissah.com +6d462575 +- make odt header changes easier to track + (this commit maintains rough equivalence to sisu-3.1.0 headers) +- sysenv, builds odf:odt directory structure instead of binary blob +- get rid of odf:odt (binary changeset) blob zipfile (containing odf:odt + directory structure) + +v3: manifest, odt url lnk, fix +2011-10-15 ralph@amissah.com +fadbc35f + +v2 v3: 3.1.1 version & changelog "opened" +2011-10-15 ralph@amissah.com +a29324fc + +sha256 (3.1.0) +2011-10-03 ralph@amissah.com +0dad10b2 + +v2 v3: documenation, html, man2html (sisu.1) +2011-10-03 ralph@amissah.com +85bd7236 (tag: sisu_3.1.0) + +v2 v3: documentation, html, minor (removal of trailing whitespaces) +2011-10-03 ralph@amissah.com +5e53466d + +v2 v3: documentation, manpage +2011-10-03 ralph@amissah.com +e9c80fcc + +v2 v3: documentation, small update +2011-10-03 ralph@amissah.com +7997984e + +v3: sysenv, output_structure_by: filename, fix to output directories created +2011-10-03 ralph@amissah.com +2547d72c + +v3: vim syntax, :texpdf_font_mono: added to @make:; proposed header changes +2011-10-03 ralph@amissah.com +c6f5cd15 +- sisu_next.vim, track proposed syntax (header) changes + +v3: sisrc.yml, texpdf_font (main, mono) Liberation series (main default Sans) +2011-10-03 ralph@amissah.com +53e6d1a3 + +v3: texpdf, fonts, Liberation series default (main: Sans, mono: Mono) +2011-10-03 ralph@amissah.com +7fb6acc0 +- (mono) improved with selection of Liberation Mono as default +- font (main font, mono) configurable in sisurc.yml under + default: (texpdf_font:|texpdf_font_mono:) + or within document under @make: (:texpdf_font:|:texpdf_font_mono:) + +v3: defaults, (sisu) home page, link to git repo, minor fixes +2011-10-03 ralph@amissah.com +8925b881 + +v3: sysenv, rc_path adds ./.sisu/ (to existing ./_sisu/ & ~/.sisu/) +2011-10-03 ralph@amissah.com +a8472db6 + +v2 v3: bin/sisu, default sisu version 3 +2011-10-03 ralph@amissah.com +366895d4 +- Version 3 is now the default (on running sisu) + +v2 v3: 3.1.0 version & changelog "opened" +2011-10-03 ralph@amissah.com +e8daf990 + +sha256 (3.0.19) +2011-09-24 ralph@amissah.com +02540066 + +v3: remote, src & sisupod processing, and rsync placement +2011-09-24 ralph@amissah.com +00817305 (tag: sisu_3.0.19, tag: sisu-3.0.19) + +v3: qrcode, sisu generated manifest output, treat as such +2011-09-24 ralph@amissah.com +b1d08ced +- place qrcode images in directory under manifest (manifest/qrcode) +- fix remote placement of qrcode images when requested + +v3: info files, fix output; remote, include info file & manpage (when selected) +2011-09-24 ralph@amissah.com +344270fa + +v3: hub, processing options, remove cruft +2011-09-24 ralph@amissah.com +794c20f3 + +v3: cosmetic, minor +2011-09-24 ralph@amissah.com +5048519f + +v2 v3: param, matching of date, years 1400 - 21\d\d +2011-09-24 ralph@amissah.com +8edbb138 + +v2: remote, image source url fix +2011-09-24 ralph@amissah.com +18467732 + +v2 v3: 3.0.19 version & changelog "opened" +2011-09-24 ralph@amissah.com +035c6566 + +sha256 (3.0.18) +2011-09-13 ralph@amissah.com +5ade3b6c + +v3: epub +2011-09-13 ralph@amissah.com +e70f6340 (tag: sisu_3.0.18, tag: sisu-3.0.18) +- fix for different output structures, language codes not used + internally (within epub) +- adjustment to image paths for image copy + +v3: image (relative) paths for different sisu output structures +2011-09-13 ralph@amissah.com +c2163c56 +- (re: by_language, by_filetype, by_filename) +- sysenv, set path +- html seg, scroll, manifest (qrcodes), xmls + +v3: dal_images, disabled imagemagick configuration permission check +2011-09-13 ralph@amissah.com +403a52d7 +- until sisupod reads local sisurc.yml (configuration file) + +v3: hub (affecting options +others) sisupod processing (v2 enabled) +2011-09-13 ralph@amissah.com +705ccf77 + +v3: options, (hub), action (opt.act) modified to increase use possibilities +2011-09-13 ralph@amissah.com +af7543c0 + +v3: options, match fix for --glob / --find +2011-09-13 ralph@amissah.com +65e4c063 + +v3: correct sisupod references and path to .txz (replace .zip) +2011-09-13 ralph@amissah.com +2ec7a07f + +v3: CHANGELOG_v3, correct .orig.tar.xz name (>=3.0.15) +2011-09-13 ralph@amissah.com +ab8d19c4 + +v3: 3.0.18 version & changelog "opened" +2011-09-13 ralph@amissah.com +0fdc7c9e + +sha256 (3.0.17) +2011-09-05 ralph@amissah.com +0d5cc01a + +v3: sisupod_v3 make (build); place (rsync); process (generate sisu output from) +2011-09-05 ralph@amissah.com +22f6ac00 (tag: sisu_3.0.17, tag: sisu-3.0.17) +- sisupod v3 + - modify pod dir structure, place sisu source in dir/[lang_code]/ e.g. dir/en/ + - use tar.xz (.txz) + - bundle all language version in pod + - bundle .ssm and all included files for each selected language (rather + than composited .ssm.sst file) + (filename pattern) or named in files to be processed string + - remote placement + - sisu processing from sisupod v3 +- rsync sisupod v3 +- sysenv, check that tree is available and use as desired when available + +v3: Dir.chdir, remove "system cd" (change directory) use Dir.chdir +2011-09-05 ralph@amissah.com +b5712bc3 + +v3: unix conditional tests (? :) remove line break markers before : cosmetic +2011-09-05 ralph@amissah.com +7bc559f8 + +v3: 3.0.17 version & changelog "opened" +2011-09-05 ralph@amissah.com +a0354001 + +sha256 (3.0.16) +2011-08-19 ralph@amissah.com +0bf06f64 + +v3: dal, sisu document links (multiple output versions) shortcut +2011-08-18 ralph@amissah.com +cacb0565 (tag: sisu_3.0.16, tag: sisu-3.0.16) +- links to multiple versions internal documents based on shortcut notation, + e.g. + { "Viral Spiral", David Bollier [3sS]}viral_spiral.david_bollier.sst + resulting in all versions of the document that would be generated by + running the command sisu3 -3sS viral_spiral.david_bollier.sst +- added possibility to specify language where language directory structure + is used for source documents + { "Viral Spiral", David Bollier [3sS]}en/viral_spiral.david_bollier.sst + +v3: concordance, i18n, start adding alternative language alphabets +2011-08-18 ralph@amissah.com +6bd77e1c +- Danish, Norwegian, Swedish + +v3: epub, param, (defaults) epub tuning +2011-08-18 ralph@amissah.com +90ad666b +- include levels A - C as individual sections + (xhtml file with consistent opf & ncx) +- sync ncx with sisu internal structural logic + (correct depth, include level A, place sisu toc) + +v3: sysenv, cosmetic, code arrangement touch +2011-08-18 ralph@amissah.com +084e7d20 + +v3: html_format, texinfo_format, minor, html seg presentation fix +2011-08-18 ralph@amissah.com +3ff0378e + +v3: 3.0.16 version & changelog "opened" +2011-08-18 ralph@amissah.com +5041a3d9 + +sha256 (3.0.15) +2011-08-09 ralph@amissah.com +9c24ffc9 + +v3: epub, constants, experiment with presentation +2011-08-09 ralph@amissah.com +532c0301 (tag: sisu_3.0.15, tag: sisu-3.0.15) +- disable some internal "features" +- make file and directory naming more flexible, now using + 'OEBPS', 'toc.ncx', 'content.opf', +- adjustment of some headers and general tuning +- add opf guide +- clean processing directory between each build +- constants, added constants Ep (for epub) +- constants, added DISABLE (used here with epub) + +v3: constants, re-arranged +2011-08-09 ralph@amissah.com +04d33909 + +v3: texpdf, possibility to translate "Contents" for table of contents +2011-08-09 ralph@amissah.com +7c0a7346 + +v3: prog_text_translation, add contents, remove some repetition +2011-08-09 ralph@amissah.com +a588b8f5 + +v3: po4a, make use of base directory (default) language setting +2011-08-08 ralph@amissah.com +c610cd64 +- set original language, (instead of assuming English) (per directory or wider) + +v3: options, sysenv, sisurc.yml, set/config default language (code) +2011-08-08 ralph@amissah.com +eb474533 +- in absence of setting 'en' assumed +- 'en' previously fixed + +v3: options, default action on running "sisu3 [filename.sst]", fix +2011-08-08 ralph@amissah.com +bd2ba361 + +v2 v3: removed objects.txt, cleaning +2011-08-08 ralph@amissah.com +f0da30bc + +v3: 3.0.15 version & changelog "opened" +2011-08-08 ralph@amissah.com +07065d9e + +sha256 (3.0.14) +2011-07-26 ralph@amissah.com +439b8be4 + +v2 v3: manpage html (man2html) +2011-07-26 ralph@amissah.com +3c0b56d9 (tag: sisu_3.0.14) +- commands: --qrcode -Q; update shortcut options +- markup.sst: indent update; publisher + +v2 v3: manpage +2011-07-26 ralph@amissah.com +520128d4 +- commands: --qrcode -Q; update shortcut options +- markup.sst: indent update; publisher + +v2 v3: sisu_manual +2011-07-26 ralph@amissah.com +bd65e8ad +- sisu_commands: --qrcode -Q; update shortcut options; line-breaks use \\ +- sisu_markup.sst: indent update; publisher + +v3: po4a, indent (check for breakage) +2011-07-26 ralph@amissah.com +d613c978 + +v3: odf, manpage, "new" indent not implemented +2011-07-26 ralph@amissah.com +d9dcd891 + +v3: sql (pg, sqlite), indent ... +2011-07-26 ralph@amissah.com +e3330f16 + +v3: texpdf, indent ... +2011-07-26 ralph@amissah.com +dba6d8b3 + +v3: epub, indent ... +2011-07-26 ralph@amissah.com +727db14c + +v3: html, indent ... +2011-07-26 ralph@amissah.com +392f8d5c + +v3: xhtml, xml sax & dom, indent (partially implemented) ... +2011-07-26 ralph@amissah.com +1abd2f99 + +v3: css, indent ... +2011-07-26 ralph@amissah.com +476ee850 + +v3: plaintext, indent ... +2011-07-26 ralph@amissah.com +051b3216 + +v3: dal, indent, control of first line of indent & rest of paragraph +2011-07-26 ralph@amissah.com +5e292103 +- implements hanging indent, and possibility to set first line step indent +- __[1-9] hanging indent (initial indent 0); paragraph text indent [1-9] +- _[0-9]?_[1-9] initial indent; paragraph text indent +- __[1-9]! bold words \\ part of hanging indent paragraph text + +v3: emacs syntax highlighting sisu-mode.el +2011-07-26 ralph@amissah.com +afa76471 +- markers for hanging indent added +- line-break + +v3: vim sisu syntax highlighting +2011-07-26 ralph@amissah.com +c77953fb +- markers for hanging indent added +- added header for @creator: :editor: +- minor comments added +- deletion of an unused tag + +v3: sql db, constants, cgi-sql, structure changed, creator.editor field added +2011-07-26 ralph@amissah.com +399e6eaa + +v3: param, manifest, qrcode, epub, added creator.editor field +2011-07-26 ralph@amissah.com +2e6af20c + +v3: qrcode, manifest, (++), QR code (metadata) images for manifest +2011-07-26 ralph@amissah.com +f965e590 +- generate images using qrencode + +v3: epub, opf fixes +2011-07-26 ralph@amissah.com +a44bbf20 + +v3: texpdf, XeTeX language settings (setmainlanguage setotherlanguage) +2011-07-26 ralph@amissah.com +427c8b29 +- get from directory or filename if header @make: :language: not set + +v3: xmls (sax, dom, xhtml) use of tidy, correct output location +2011-07-26 ralph@amissah.com +bdc8fb18 + +v3: param, cleanup setting of auto endotes +2011-07-26 ralph@amissah.com +5eb77a9b + +v3: sysenv, cosmetic +2011-07-26 ralph@amissah.com +9c518b45 + +v3: sysenv, avoid creation of spurious directories in output tree +2011-07-26 ralph@amissah.com +b739f3f1 +- an image copy section removed (re-implement correctly later) + +v3: urls, --concordance (hyphen added, descriptive) +2011-07-26 ralph@amissah.com +20084391 + +v3: 3.0.14 version & changelog "opened" +2011-07-26 ralph@amissah.com +9056c5a3 + +sha256 (3.0.13) +2011-06-26 ralph@amissah.com +45a05d0c + +v3: documentation, on additional breaks in document, (remove some old info) +2011-06-26 ralph@amissah.com +1d239f25 (tag: sisu_3.0.13) +- linebreak \\ (previously undocumented
kept but depreciated) + [it is intended that this should close #617298 (post mail)] +- page break (breaks column if column, else breaks page) +- page new (new page, breaks page) +- sisurc.yml set output directory structure by language +- removed section on hyperestraier, too specialised for general manpage + (also section not checked recently) + +v2 v3: sisurc.yml, config settings +2011-06-26 ralph@amissah.com +c5523331 + +v3: urls (ansi screen reporting), add document language code +2011-06-26 ralph@amissah.com +ae914fdb + +v3: manifest, manifest enable additional output & source (if shared) +2011-06-26 ralph@amissah.com +b232545a +- manpage (in fututure have config setting with default false/off) +- info (texinfo) (in fututure have config setting with default false/off) +- hash digests +- locate markup source (if shared) +- sisupod (if shared) + +v3: sysenv, fix some output paths (markup source); accommodate manpage +2011-06-26 ralph@amissah.com +f6f89c95 +- shared source markup (.sst .ssm & sisupod.zip) fix some paths + - placement of markup source, output_path.src.dir, fix + - output_path.src.url, fix +- manifest info +- (epub viewer cosmetic rearrangement) + +v3: info (texinfo) (sysenv), move output; line-breaks within object +2011-06-26 ralph@amissah.com +408bf6b6 +- backslashes & line-breaks +- place under web server directory +- info tool setting prompt +- sysenv, accommodate info page changes + +v3: manpage (sysenv), move output; line-breaks within object +2011-06-26 ralph@amissah.com +def544be +- start to honor line-breaks within objects (revisit) +- show double escape \\ (backslashes) in code blocks +- place under web server directory +- sysenv, accommodate manpage changes + +v3: html_tune, reduce loops; deal with angle-brackets +2011-06-26 ralph@amissah.com +b975bd03 +- deal with angle brackets in markup (test, could cause breakage) +- reduce loops in code + +v3: plaintext, codeblock keep backslashes +2011-06-26 ralph@amissah.com +561b3d6e + +v3: constants, a sisupod & an xml related addition +2011-06-26 ralph@amissah.com +3dafcaeb + +v3: define latex \newcommands for some special characters (for sisu code) +2011-06-26 ralph@amissah.com +d95f8574 +- \newcommands for some special characters to simplify dealing with them + in sisu code \hardspace \caret \pipe \curlyopen \curlyclose \lt \gt + \slash \backslash \underscore \exclaim + +v2 v3: texpdf, define hardspace & provide backslash +2011-06-26 ralph@amissah.com +7ef0302a +- define \hardspace to simplify placing a hardspace +- provide backslash character in code block + +v3: ansi screen reporting include document language code +2011-06-26 ralph@amissah.com +60bd031d + +v2 v3: vim, sisu syntax highlighting, linebreak \\ added (
kept) +2011-06-26 ralph@amissah.com +8294a1dc + +v2 v3: dal_syntax, linebreak in regular text object: ' \\ ' ('
' depreciated) +2011-06-26 ralph@amissah.com +83355806 +- thanks to Jonas Stein for making me look at this (see bug: #617298 & comments + in upstream CHANGELOG_v3) +- testing required, downstream outputs affected + +v2 v3: vim colors, added cursor line & cursor column +2011-06-26 ralph@amissah.com +533909b0 + +v2 v3: 2.9.7 & 3.0.13 version & changelog "opened" +2011-06-26 ralph@amissah.com +3ef64329 + +sha256 (3.0.12) +2011-06-09 ralph@amissah.com +cd0c1c83 + +v3: cgi, sample search form, force utf-8 character encoding to avoid issues +2011-06-09 ralph@amissah.com +5a1e3ba7 (tag: sisu_3.0.12) + +v3: cgi, sample search form reverted to '#!/usr/bin/env ruby' +2011-06-09 ralph@amissah.com +74c346fa +- appears to be a fix in libdbi-ruby1.9.1, see comments in sisu-3.0.8 changelog + +v3: harvest, work for alt output structures; for each language +2011-06-09 ralph@amissah.com +a6651eff +- paths to document manifests etc. for the possible output dir structures +- author and topic lists for available documents, by availability in each + language + +v3: sysenv, limit/prevent the creation of spurious language output directories +2011-06-09 ralph@amissah.com +d0fd14ad + +v3: param, remove unused class variable '@@symlnk' +2011-06-09 ralph@amissah.com +2aba456f + +v3: html, texpdf, syslink to default, adjusted & made similar +2011-06-08 ralph@amissah.com +a011db38 + +v3: manifest, fix a full name +2011-06-08 ralph@amissah.com +36c4c6ac + +v3: --help language, provides list of available languages +2011-06-08 ralph@amissah.com +6a7c87dc +- language (ISO 639-1 code (as varied by po4a) & name) + +v3: options, restrict glob rule checks to glob & find; carry lang info +2011-06-08 ralph@amissah.com +7bf74c7f +- restrict glob rule checks to when --glob (-G) or --find (-f) requested +- carry information on document language (from filename and or directory) +- (additional test) + +v2 v3: help, s/Bul garian/Bulgarian/ (Closes: #619068) +2011-06-07 ralph@amissah.com +5f4c7037 + +v2 v3: 2.9.6 & 3.0.12 version & changelog "opened" +2011-06-07 ralph@amissah.com +93d66090 + +sha256 (3.0.11) +2011-05-29 ralph@amissah.com +21117c49 + +v3: documentation, minor update, includes --find / --glob +2011-05-29 ralph@amissah.com +0e921ada (tag: sisu_3.0.11) + +v3: options --find & --glob (-f -G) added, parses language sub-dirs +2011-05-25 ralph@amissah.com +93cc261e +- options + - filter out files not matching .ss[tm] + - with -f -G (--find|--glob) flag glob all .ss[tm] files in dir including + language sub-directories + sisu3 -3G live-manual + - with -f (--find|--glob) flag and find .ss[tm] files that match given + string in dir including language subdirectories + sisu3 -3GR + +v3: i18n, constants, some language info moved to i18n (from constants) +2011-05-25 ralph@amissah.com +b1648ad6 + +v3: cgi search form, fixes related to language code +2011-05-24 ralph@amissah.com +4d509289 +- filename with language code being required as unique document identifier + +v3: sysenv, url webserver link (manifest) fix +2011-05-24 ralph@amissah.com +0df2126e + +v3: 3.0.11 version & changelog "opened" +2011-05-24 ralph@amissah.com +57940551 + +sha256 (3.0.10) +2011-05-24 ralph@amissah.com +f4bb6f72 + +v3: defaults, fix path to homepage image (more fixes remain...) +2011-05-23 ralph@amissah.com +f18dfa73 (tag: sisu_3.0.10) + +v3: sysenv, rsync, embedded: rsync to remote host alt output structures, fix +2011-05-23 ralph@amissah.com +d6f18ae9 + +v3: options, include markup source "base" path +2011-05-23 ralph@amissah.com +3a07ef3c +- used to parse alternative markup source dir structures + +v3: html, close files; syslink index.html to toc.html +2011-05-23 ralph@amissah.com +154fd687 +- syslink will need revisit (will only "work" properly with by_language dir + structure) + +v3: texpdf, filenames +2011-05-23 ralph@amissah.com +b5b64d1e + +v3: manifest, sysenv, "available outputs" relative paths; available languages +2011-05-23 ralph@amissah.com +eebc0d4f +- relative paths to "available outputs" (for each dir structure), fix +- show language versions published + (needs 2 runs for manifest, polls output as to whether manifest exists) + +v3: param, html, epub, xml, simplify file-naming with language code +2011-05-23 ralph@amissah.com +a11485b8 +- language code occurs in fixed location within file-name (could previously do + so in 1 of 3 configured locations) + +v3: prog_text_translation, language class name fix; languge name matching +2011-05-23 ralph@amissah.com +92fb4ace +- Portuguese language class name (missed 't') +- language name matching ('Portuguese Brazil') +- indentation + +v3: i18n, added language translation table column to hash/table +2011-05-23 ralph@amissah.com +c11ed8c1 +- changelog, version dates touched as well + +v3: sysenv, rsync, get rid of annoying nag to terminal (-v reporting Dir.pwd) +2011-05-17 ralph@amissah.com +f7bad422 +- prevent attempt to change directory unless different directory requested + +v2 v3: 2.9.5 & 3.0.10 version & changelog "opened"; copyright touch +2011-05-17 ralph@amissah.com +3ce63d5a +- copyright, dates for setup.rb + +sha256 (3.0.9) +2011-05-17 ralph@amissah.com +e42cb235 + +v3: po4a re-enabled, related fixes (issues persist) +2011-05-17 ralph@amissah.com +bdd62aba (tag: sisu_3.0.9) + +v3: options, expand name of source file for selected language directories +2011-05-17 ralph@amissah.com +d87f4fff +- only use for single file(name) available in multiple languages e.g. + sisu3 -hv en/free_culture.lawrence_lessig.sst es fr +- english assumed as default language, make default configurable later +- particularly useful for po4a + +v3: embedded, source path +2011-05-17 ralph@amissah.com +f464a77b + +v3: version & changelog date +2011-05-17 ralph@amissah.com +ea971b88 + +v3: cgi sample search form, differ depending on output directory structure +2011-05-15 ralph@amissah.com +a09e2e63 + +v3: sysenv, output_path & place_file, modified, (affects many libraries) +2011-05-15 ralph@amissah.com +b1b2fe8c +- paths for dir, url, relative and rcp that vary with output dir structure +- cope with alterative dir structures + - manifest url paths, fix + - dal_expand_insertions, fix + - rsync, review +- scp disabled + +v3: sysenv, options, output_dir_structure.by? (language|filetype|filename) +2011-05-15 ralph@amissah.com +cfa267b4 + +v3: sysenv, output directory structure check, fix (start testing alternatives) +2011-05-15 ralph@amissah.com +29fcf4ab + +v2 v3: vim cterm colorschemes, touch search color +2011-05-15 ralph@amissah.com +62a6bc0b + +v2 v3: bin/sisu2 introduced (complement bin/sisu3), currently same as bin/sisu +2011-05-15 ralph@amissah.com +5a3b6028 +- later switch bin/sisu to bin/sisu3 +- consider using update-alternatives + +v2 v3: copyright file update, sisu-mode.el assigned to FSF (GNU EMACS) +2011-05-15 ralph@amissah.com +dbd7dce7 + +v2 v3: copyright file, softlink, make more visible in tarball +2011-05-15 ralph@amissah.com +91ada8a0 + +v2 v3: 2.9.4 & 3.0.9 version & changelog "opened" +2011-05-15 ralph@amissah.com +6148816d + +sha256 (3.0.8) +2011-05-05 ralph@amissah.com +015d5f04 + +v3: i18n, sysenv, class variable to prevent unnecessary re-construction of hash +2011-05-05 ralph@amissah.com +8b7a793a (tag: sisu_3.0.8) +- prevent program from becoming as slow as treacle, a fix + +v3: date, version, changelog +2011-05-05 ralph@amissah.com +e54612bd + +v3: sample search form, revert to generating ruby 1.8.7 sample +2011-05-04 ralph@amissah.com +c7c3ab1b +- sisu3 using ruby >=1.9.2p180 generates search form for ruby 1.8.7, so: + generate sample form using sisu3 -F (options), then; start webrick using + ruby 1.8.7 & sisu -W (not sisu3) +- take account of alternative output directory structures [work on, test] + +v3: db, review, directory structure changed, database prefix renamed +2011-05-04 ralph@amissah.com +2d79257e +- language_document_char field made larger [consider renaming] +- title, src_filename and language_document_char fields mandatory + (title, title_main, src_filename, language_document_char) +- review of unique key setting, now based on combination of filename + and language (filename no longer sufficient with intro of language + subdirectories) +- [retest sqlite3] + +v3: urls, sqlite, a fix +2011-05-04 ralph@amissah.com +5f0bc4a7 + +v3: i18n, sysenv, options, language setting changes +2011-05-04 ralph@amissah.com +8ece5064 +- must be able to set language at options stage from filename or directory +- affects many files +- old i18n more appropriately renamed prog_text_translation + +v3: options, language setting, based on directory structure or filename +2011-05-04 ralph@amissah.com +46eebe8b +- affects multiple libraries + +v3: concordance, output path, screen info correction +2011-05-04 ralph@amissah.com +9a9c3668 + +v2 v3: vim colorschemes minor review +2011-05-04 ralph@amissah.com +75e80f2f + +v2 v3: bin/ cosmetic +2011-05-04 ralph@amissah.com +6a20d40e + +v2 v3: note (CHANGELOG) on ruby DBI bug affecting sisu cgi sample search forms +2011-04-27 ralph@amissah.com +5fa19b62 +- see however, it + affects sqlite3 in the same way as pgsql (the driver against which it is + reported) +- includes possible workarounds (for sisu sample search forms) + +v*: manpages escaped hyphens reinstated +2011-04-27 ralph@amissah.com +6b0a64fd + +v2 v3: manpage, reinstate escaping of hyphens +2011-04-27 ralph@amissah.com +416d0ec8 + +v2 v3: bin/ type fix for ruby version check +2011-04-27 ralph@amissah.com +03073b71 + +v2 v3: vim (8 color cterm) colorschemes, 8, frugal, sparse +2011-04-26 ralph@amissah.com +e2089729 +- sparse series uses dark grey on black, on which reverse cursors may + disappear, usually looks better +- frugal series avoids dark grey +- slate for cterm now incorporates frugal-cterm-sisu + +v2 v3: vim, sisu syntax change of a couple of color groups +2011-04-26 ralph@amissah.com +1e84a4d5 + +v2 v3: sysenv, refer to lowriter, update +2011-04-26 ralph@amissah.com +624f72b8 +- v2 lowriter instead of oowriter +- v3 lowriter instead of libreoffice + +v2 v3: bin/ improved ruby version check +2011-04-26 ralph@amissah.com +5102422f + +v2 v3: 2.9.3 & 3.0.8 version & changelogs "opened" +2011-04-26 ralph@amissah.com +89e5a25a + +sha256 (3.0.7) +2011-04-20 ralph@amissah.com +e1e81c7f + +v2 v3: sisu-mode.el, header notes copyright assignment to FSF (GNU EMACS) +2011-04-20 ralph@amissah.com +07976599 (tag: sisu_3.0.7) +- assignment to FSF +- header includes url to git repo (when possible track GNU EMACS location) + +v2 v3: vim colorschemes, headers touched, url to git repo provided +2011-04-20 ralph@amissah.com +4bc8b769 + +v3: harvest, sysenv, place with document manifests, variable directory path +2011-04-19 ralph@amissah.com +cc7bc6de +- sysenv, variable directory path fixing (language, filetype, filname), making + the stub for at least manifest and html available early for processing + that do not or should not need to process individual markup files + completely, such as the cgi search form and harvest +- harvest + - place with document manifests + - variable directory path fixing (language, filetype, filname) + +v3: param, md remove md.cmd and md.mod shortcut methods, use use md.opt +2011-04-19 ralph@amissah.com +44464e28 +- affects many files that now use @md.opt.cmd & @md.opt.mod + (instead of @md.cmd & @md.mod) + +v3: options, hub, introduce opt.act booleans, more setting in options +2011-04-19 ralph@amissah.com +17d1555c +- opt.act booleans more flexible than opt.cmd + (start to favor use of opt.act over opt.cmd) +- move option setting from hub to options where possible +- separate out a few methods + +v3: urls, minor fixes +2011-04-19 ralph@amissah.com +dcfbef65 +- fix maintenance urls -M (where processing files are kept for examination) +- odf maintenance added + +v3: odf:odt processing in separate subdirectories +2011-04-19 ralph@amissah.com +f3309533 +- processing in separate subdirectories that can be kept for maintenance +- odt.zip (bin) directory renamed odt from odf +- sysenv, odf:odt paths adjusted for changes in maintenance & odt.zip + +v2 v3: options, -M / --maintenance, new alias --keep-processing-files +2011-04-19 ralph@amissah.com +ba819966 +- new alias --keep-processing-files (see Bug#622902) +- document "--keep-processing-files" alias for "-M" ("--maintenance") +- minor rearrangement of regex +- (Closes: #622902) + +v2 v3: cgi, sample-search-form +2011-04-19 ralph@amissah.com +5b647bdb +- results still not right, (ruby1.9.2 libraries? double check script) +- not yet done variable directory path fixing for result links + +v3: screen_text_color (ansi colors) touched, consider reviewing later +2011-04-19 ralph@amissah.com +2dcb16c5 + +v2 v3: vim cterm colorschemes "8" and "frugal" added +2011-04-19 ralph@amissah.com +ccc33550 + +v2 v3: vim slate colorscheme, conflicting group colors reviewed +2011-04-19 ralph@amissah.com +a7413a2f + +v3: dates - version, changelog; v2: 2.9.2 opened - version, changelog +2011-04-19 ralph@amissah.com +1f360483 + +v3: urls, reuse/share code, fix -U +2011-04-05 ralph@amissah.com +cc1c6832 +- share code between show selected urls and show all urls +- fix -U which has not been properly updated for v3 + +v3: 3.0.7 version & changelog "opened" +2011-04-05 ralph@amissah.com +2dec1568 + +sha256 (3.0.6) +2011-03-31 ralph@amissah.com +54b31e16 + +vim colorscheme slate, rearrange +2011-03-30 ralph@amissah.com +ebd803aa (tag: sisu_3.0.6) + +vim colorscheme slate, review console colors +2011-03-30 ralph@amissah.com +6324d3d0 + +v2, v3: dal_doc_str.rb, table structure issue +2011-03-30 ralph@amissah.com +af4d5210 +- ruby1.9.2 transition related +- double spaced empty line creates spurious newline + +v2, v3: dal_doc_str, empty line not paragraph object +2011-03-30 ralph@amissah.com +b06c1e8a +- ruby1.9.2 transition related + +v2, v3: dal_images, image path setting +2011-03-30 ralph@amissah.com +709e8067 +- ruby1.9.2 transition related + +v2, v3: cgi, sample-search-form, string output (+ clean unused help text) +2011-03-30 ralph@amissah.com +d5d39d4e +- ruby1.9.2 transition related + +v2, v3: sysenv, remove repeated method +2011-03-30 ralph@amissah.com +9542185b + +v2: param, nested regex match fix (backport from v3) +2011-03-30 ralph@amissah.com +350efc6d + +v2, v3: 3.0.6 version & changelog "opened" +2011-03-30 ralph@amissah.com +b0955dc8 + +sha256 (3.0.5-3) +2011-03-27 ralph@amissah.com +2d6d4973 + +sha256 (3.0.5-2) +2011-03-26 ralph@amissah.com +663832e2 + +sha256 (3.0.5) +2011-03-24 ralph@amissah.com +90bf54da + +v2, v3: texpdf bugfix, where map_nametags not found, drop tag, rather than crash +2011-03-24 ralph@amissah.com +e5d3440b (tag: sisu_3.0.5) +- Debian-live, live-manual (Ben Armstrong, chals?, reported new bug in a + number of translations (that crashed the pdf generator). It turns out + where map_nametags is not found the document crashes. Fix. + +v3, v2: bin/sisu*: v3 development ruby >=1.9.2p180; v2 maintenance ruby >=1.8.7 +2011-03-23 ralph@amissah.com +9e82ccef +- bin/sisu* version checks + +v2, v3: vim syntax highlighting, fix typo +2011-03-20 ralph@amissah.com +18eefb23 + +v3: changelog & version 3.0.5 +2011-03-20 ralph@amissah.com +21cadb83 + +sha256 (3.0.4) +2011-03-11 ralph@amissah.com +f577abb1 + +sisu_manual, sisu_download, remove references to versions of sisu +2011-03-11 ralph@amissah.com +1c052f55 (tag: sisu_3.0.4) + +v3: changelog & version 3.0.4 +2011-03-11 ralph@amissah.com +e19720cb + +sha256 (3.0.3) +2011-03-11 ralph@amissah.com +32f83cb5 + +v2, v3: changelog git.sisudoc.org tag-points [3.0.3-1] +2011-03-11 ralph@amissah.com +bfa2a017 (tag: sisu_3.0.3) + +syntax highlighting updates, emacs, vim +2011-03-11 ralph@amissah.com +61c7438e +- emacs sisu headers updated (subheaders omitted for now) sisu-mode.el +- vim cleaning sisu.vim + +param: tidy, remove redundant document header tags +2011-03-11 ralph@amissah.com +d3a09245 + +manpage: sisu.1 and html regenerated +2011-03-10 ralph@amissah.com +57ad1a1e + +documentation more link fixes (remove redundant), remove repeated skin +2011-03-10 ralph@amissah.com +a6042b05 + +v2, v3: help (markup): correct path to markup-samples +2011-03-10 ralph@amissah.com +e4ca6d04 + +v3 (v2): manpage, param, urls: manpage output presentation fixes +2011-03-10 ralph@amissah.com +93308a6a +- manpage: lowercase .br; correct newlines before .nf and after .fi; no + escape of hyphens; remove redundant links; endnotes array requires flatten; + screen info on output path) +- param: manpage header .br and no escape of hyphens +- urls: correct output path for manpage + +v2, v3: dal_doc_str: fix, looks like typo in regex +2011-03-10 ralph@amissah.com +cbcf26cd + +v2, v3: dal_substitutions_and_insertions: sisu header matching in codeblock, fix +2011-03-10 ralph@amissah.com +63251bd4 + +v2, v3: dal_syntax: (internal document) link matching, a fix +2011-03-10 ralph@amissah.com +259351d4 + [Debian-live, live-manual (Jose Luis Zabalza, Ben Armstrong, reported bug in + Spanish translation markup (that crashed the pdf generator). Bug in markup + subsequently identified as "versátil,#{iso-hybrid}#, se" which the interpreter + identified as an internal document link to a comma (instead of as being + monospace markup), markup should have been "versátil, #{iso-hybrid}#, se" this + fix prevents that incorrect match, (but the markup remains faulty and the + monospace markup is not identified as such without the corrected spacing). + Unfortunate "grave" results for what is a pretty insignificant data entry + typo (there are no doubt other such situations).] + +v2, v3: dal_syntax + downstream output, email regex revised +2011-03-10 ralph@amissah.com +755acef8 +- revised pattern match for email address, (removes occasional interference + with urls having embedded email addresses) (dal_syntax and affected + downstream output modules) + +v2, v3: texpdf, url (regex) pattern match fix +2011-03-10 ralph@amissah.com +78170753 + +v2, v3: 3.0.3 version & changelog "opened" +2011-03-10 ralph@amissah.com +9dea2a81 + +sha256 (3.0.2) +2011-03-05 ralph@amissah.com +589d36be + +v2, v3: changelog updates +2011-03-05 ralph@amissah.com +6991d5ad (tag: sisu_3.0.2) + +documentation, minor tidy +2011-03-05 ralph@amissah.com +02c16699 + +manpage + html: sylink sisu.1 to sisu3.1 +2011-03-05 ralph@amissah.com +5b124911 + +documentation, remove some files +2011-03-05 ralph@amissah.com +1ffd1da3 + +html manpages, re-run man2html +2011-03-05 ralph@amissah.com +0c872f4f + +sisu.8 manpage & html deleted, needs rewrite, unhelpful +2011-03-05 ralph@amissah.com +f3aefadb + +manpages: sisu.1 update; sisu_vim.7 cleaning +2011-03-05 ralph@amissah.com +cce96b70 + +markup samples, manual, headers: links and other details +2011-03-05 ralph@amissah.com +c9440e39 + +doc/sisu user_txt, minor update & pruning +2011-03-05 ralph@amissah.com +b9723041 + +v2, v3: manpage, adjust output (backslash ('\') escapes reduced) +2011-03-05 ralph@amissah.com +a512dfec + +v2, v3: defaults, default homepage tidy & update links +2011-03-05 ralph@amissah.com +278c945f + +v3: version & changelog, touch date +2011-03-05 ralph@amissah.com +73c312da + +conf/skin prune skins * remove less important skins * use syslink to share doc/skin_sisu.rb +2011-03-04 ralph@amissah.com +ceb35acd + +CHANGELOG_v{1,2,3}, syslink, avoid duplication * CHANGELOG_v3 updated * CHANGELOG & README locations pruned +2011-03-02 ralph@amissah.com +572064e8 + +v2, v3: consolidate manual & markup samples +2011-03-02 ralph@amissah.com +59b7f849 +- reinstate lang dir structure for manual when v3 becomes default + +v3: sysenv, separate out processing_path method plus consequences +2011-03-01 ralph@amissah.com +5abc5721 + +v3: space between each and opening curly brace e.g. "x.each {|y| p y}" +2011-03-01 ralph@amissah.com +f2ab439c + +v3: ruby 1.9 hash symbol syntax adopted +2011-03-01 ralph@amissah.com +05a3fd23 + +v3: use rb1.9.2 "require_relative" syntax +2011-03-01 ralph@amissah.com +f09f45a1 + +v3: use "encoding: utf-8" (instead of coding) +2011-03-01 ralph@amissah.com +d4c06757 + +make sisu: v2 require >=ruby1.8.7; v3 require >=ruby1.9.2 +2011-03-01 ralph@amissah.com +0aff0553 +- bin/sisu bin/sisu3 modified accordingly + note: there are issues with sisu and early versions of ruby1.9.2 + ruby1.9.2p0 is known to segfault on a number of operations + ruby1.9.2p180 does not have these issues +- v3 includes changelog updates +- v2 includes changelog updates and version update 2.8.1 + +v3: sisu version 3.0.2-beta-rb1.9.2p180 +2011-03-01 ralph@amissah.com +af2ffd7f + +v3: changelog, open 3.0.2, target ruby1.9.2 +2011-03-01 ralph@amissah.com +baa7f205 + +v3: hub, minor rearrangement +2011-03-01 ralph@amissah.com +abaab645 + +v3: urls, param, two unrelated regex fixes, check +2011-03-01 ralph@amissah.com +a800c2b6 + +v2: changelog fix +2011-03-01 ralph@amissah.com +494b0b53 + +sha256 (3.0.1) +2011-03-01 ralph@amissah.com +a6673bc5 + +changelogs, gitweb urls: debian release tags +2011-02-16 ralph@amissah.com +596d4cea (tag: sisu_3.0.1) + +changelog & version (3.0.1) +2011-02-16 ralph@amissah.com +d6ba607d + +css, fix css paths for xhtml, xml dom & xml sax +2011-02-15 ralph@amissah.com +9a2448e9 + +sysenv, sisurc.yml & elsewhere as affected, output_dir_structure (conf & tests) +2011-02-15 ralph@amissah.com +3a263de6 +- (by_language_code; by_filetype; by_filename) + +console feedback on selected files being processed, updates & fixes +2011-02-15 ralph@amissah.com +9f4166c7 + +sysenv & sisurc.yml: libreoffice, default odf reader +2011-02-15 ralph@amissah.com +5ae32a29 + +sha256 (3.0.0) +2011-02-08 ralph@amissah.com +3582bcf6 + +update changelogs & version date +2011-02-07 ralph@amissah.com +5b0efc5b (tag: sisu_3.0.0) + +documentation & man pages, add sisu3, sisu-po and touches +2011-02-07 ralph@amissah.com +b571083d + +REMOVE sisu v1 +2011-02-07 ralph@amissah.com +c19e5c61 + +increment year (2011) for bin and lib/sisu/v3 +2011-02-07 ralph@amissah.com +b04b5d4d + +v3 po4a, options, shortcut representation for processing, keep working on +2011-02-01 ralph@amissah.com +0491018d +- sisu --po4a en/live-manual.ssm fr + instead of: + sisu --po4a en/live-manual.ssm fr/live-manual.ssm + test: + sisu --po4a en/live-manual.ssm fr de + +v3 introduced as development branch, invoked using "sisu --v3 [instructions] +2011-02-01 ralph@amissah.com +4b51bc00 + +prepare for v3 branch +2011-02-01 ralph@amissah.com +f26f1b37 + +remove skin_gutenberg from sisu, unused +2011-02-01 ralph@amissah.com +9e504255 + +document objects: page break; object separator (introduced & used, adjust later) +2010-12-16 ralph@amissah.com +ff4ceb26 +- object separator introduced + (requested Cory Doctorow, implementation not discussed) + - dal_syntax, object separator syntax (<:---> or <:ols>) + - constants, object separator + - vim syntax highlighting, match object separator +- document objects: page break; object separator + (introduced & used) + - dal, page break and object separator objects + - represent page break and object separator: plaintext, html, epub, odf, + texpdf (adjust later) + +dal_syntax, sisu syntax modification (insist on curly braces) +2010-12-13 ralph@amissah.com +5e3e7429 +- enforce use of curly braces in markup, remove single word markup without curly + braces + (requested fix, Ben Armstrong (live-manual), problematic for technical + writing) +- also removed some undocumented alternative markup attributes + +open v2.7.10 +2010-12-13 ralph@amissah.com +6e066fee + +sha256 (2.7.9) +2010-12-09 ralph@amissah.com +1b259aed + +changelog, cosmetic +2010-12-09 ralph@amissah.com +74911938 (tag: sisu_2.7.9) + +dal, markup syntax (fontface) multi-line match, for line-wrap text +2010-12-09 ralph@amissah.com +5f1bdade + +dal, multiline-match to permit line-wrap on bullet text (and headings) +2010-12-08 ralph@amissah.com +ca5f3517 +(requested fix, Ben Armstrong (live-manual)) + +document manifest link (plaintext, odf) +2010-12-07 ralph@amissah.com +67b6edcf +- plaintext, link to "document manifest" fix(links to individual output types + removed) +- odf, manifest link fix +- html, cosmetic touch + +html, link to "document manifest" & search form reviewed (testing required) +2010-12-04 ralph@amissah.com +74f7e0ad + +html, link to "document manifest" remains (individual output links removed) +2010-12-03 ralph@amissah.com +f0f647e3 + +texpdf: toc now contains level 3~ consistent with other output formats +2010-11-29 ralph@amissah.com +b4566320 +(requested fix, Ben Armstrong (live-manual)) + +epub: ocn (object numbers) now link to themselves +2010-11-29 ralph@amissah.com +371dfc5c +- jumps to top of viewer + +html & css: ocn (object numbers) now link to themselves +2010-11-29 ralph@amissah.com +e54d00b5 +- jumps to top of browser +- provides link url +(requested, Ben Armstrong (live-manual)) + +texpdf, use of monospace in headings causes table of contents breakage, fix +2010-11-11 ralph@amissah.com +a64f0c80 +(requested fix, Ben Armstrong) + +open v2.7.9 +2010-11-11 ralph@amissah.com +d6d33ae4 + +sha256 (2.7.8) +2010-10-31 ralph@amissah.com +8bac1a74 + +texpdf_format, i18n, set tex document header language (polyglossia) +2010-10-25 ralph@amissah.com +0da0a262 (tag: sisu_2.7.8) +- i18n, introduce header @make: :language: internationalization using codes + from http://www.debian.org/international/l10n/po/ at this time for texpdf, + (able to satify needs of polyglossia for the likes of Brazilian Portugues) + and in future for po files, where iso:639 for this purpose appears to have + use limitations http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes + - i18n, add code list and associated language (as listed by polyglossia) + - texpdf_format, use param (@make: :language: (default english)), to set + tex document language header (previously used file naming convention) + +i18n, introduce header @make: :language: +2010-10-25 ralph@amissah.com +70e74b82 +- internationalization using codes from + http://www.debian.org/international/l10n/po/ +- param, extract @make: :language: information if provided, default "english" +- sisu.vim recognize @make: :language: + (also elsewhere shortened :lang_code: from :language_code:) + +version date +2010-10-25 ralph@amissah.com +96f80566 + +html, quick ref links_guide configurable, boolean +2010-10-24 ralph@amissah.com +ed1a1041 +- true/false (config.yml commented out, default false) +(requested off option, Daniel Baumann) + +html segments, title banner (including "copy @" mark) configurable, boolean +2010-10-24 ralph@amissah.com +f0776648 +- true/false (config.yml commented out, default false) +(requested off option, Daniel Baumann) + +html, remove "copy @" mark +2010-10-24 ralph@amissah.com +8b2317a5 +(requested, Daniel Baumann) + +version date +2010-10-24 ralph@amissah.com +368f63c5 + +internal links, punctuation & parentheses issue, refix +2010-10-23 ralph@amissah.com +0528ba40 + +internal links, punctuation & parentheses issue, fix +2010-10-23 ralph@amissah.com +07fcd016 +- dal, exclude parentheses and square brackets from matching + (requested fix, Ben Armstrong) +- html, remove space between link & following punctuation, parentheses &/or + square brackets + (requested fix, Ben Armstrong) +- epub, remove space between link & following punctuation, parentheses &/or + square brackets + +version date +2010-10-23 ralph@amissah.com +aaffb848 + +epub, internal link: remove space between link & parentheses or square brackets +2010-10-22 ralph@amissah.com +b2918451 + +html, internal link: remove space between link & parentheses or square brackets +2010-10-22 ralph@amissah.com +6632e435 + +dal, internal link: exclude parentheses and square brackets from matching +2010-10-22 ralph@amissah.com +fda25aa0 +(requested fix, Ben Armstrong) + +version date +2010-10-22 ralph@amissah.com +73f43c42 + +epub, internal link: remove space between link & following punctuation +2010-10-21 ralph@amissah.com +7da9ff24 + +html, internal link: remove space between link & following punctuation +2010-10-21 ralph@amissah.com +41b812e5 +(requested fix, Ben Armstrong) + +open v2.7.8 +2010-10-21 ralph@amissah.com +db2ec9ee + +sha256 (2.7.7) +2010-10-17 ralph@amissah.com +3425ce01 + +version date +2010-10-17 ralph@amissah.com +bf16d31b (tag: sisu_2.7.7) + +CHANGELOG update requested by +2010-10-17 ralph@amissah.com +8f9ef031 + +texpdf, codeblocks do not permit empty lines, fix +2010-10-15 ralph@amissah.com +505c66ab + +sisu_markup, date typo fix +2010-10-15 ralph@amissah.com +a258d50c + +texpdf, bullet text, hanging indent, fix (works for regular text (not grouped text) +2010-10-14 ralph@amissah.com +1f20600f +(requested fix, Ben Armstrong) + +codeblocks, numbered markup option, fix +2010-10-14 ralph@amissah.com +9a32a074 +(requested fix needed by debian-live:live-manual, +Ben Armstrong & Mark Schneider) +- numbered codeblocks, , where codeblock opens with code{# + - dal changes as required, flag markup request and number + - constants, provide vertical line symbol, use to separate numbered + codeblock from code + - texpdf substitute \vline for numbered codeblock line separator + +documentation related minor updates and fixes +2010-10-14 ralph@amissah.com +dc6f4fba + +dal_endnotes, cosmetic code arrangement +2010-10-14 ralph@amissah.com +2956c8fa + +version 2.7.7 +2010-10-14 ralph@amissah.com +93597e61 + +texpdf, first space following a bullet should be fixed width (also), fix +2010-10-13 ralph@amissah.com +9314a7a3 + +texpdf, first space following a bullet should be fixed width, fix +2010-10-13 ralph@amissah.com +406eed70 +(requested fix and suggested solution, Ben Armstrong) + +CHANGELOG v2, on requested changes & open 2.7.7 +2010-10-13 ralph@amissah.com +45b2c50b + +sha256 (2.7.6) +2010-10-11 ralph@amissah.com +0fe4c7cb + +update version (2.7.6) +2010-10-11 ralph@amissah.com +b55b1ef4 (tag: sisu_2.7.6) + +texpdf, codeblocks, code-line continuation backslash dropped, fix +2010-10-11 ralph@amissah.com +d9d0054e +(requested fix, Ben Armstrong) + +shared_metadata, odf, url characters to not match +2010-10-11 ralph@amissah.com +4f2d1d3f + +sisu_convert, basic conversion script, preliminary fix +2010-10-11 ralph@amissah.com +3ca7f281 + +CHANGELOG v2, recount where some requests came from +2010-10-11 ralph@amissah.com +6cc08786 +- some of this information is already provided in debian/changelogs + +sha256 (2.7.5) also date +2010-10-09 ralph@amissah.com +f3bf535d + +version date +2010-10-09 ralph@amissah.com +41902ef3 (tag: sisu_2.7.5) + +update version (2.7.5) +2010-10-09 ralph@amissah.com +10b211ff + +param, metadata rights, keep colon separator from interfering with urls (+changelog) +2010-10-09 ralph@amissah.com +fb20770a + +odt fix cornercase breakage matching and representing " ", "&" and urls (+changelog) +2010-10-09 ralph@amissah.com +7010772e +- odf, " " and "&" + (prior to this fix, odt for viral_spiral is broken in sisu-markup-samples) +- shared_metadata, " ", "&" and urls in metadata +more consistent open document text results + +sha256 (2.7.4) +2010-10-08 ralph@amissah.com +1c84bbb8 + +update version (2.7.4) +2010-10-08 ralph@amissah.com +2f0b6b28 (tag: sisu_2.7.4) + +epub (epub_tune) scaling of images, fix (+changelog) +2010-10-08 ralph@amissah.com +50137a3a +(requested fix) + +html (html_tune) scaling of images, fix (+changelog) +2010-10-08 ralph@amissah.com +bbcd934b +(requested fix) + +odf:odt, incorporation and scaling of images, fix (+changelog) +2010-10-08 ralph@amissah.com +20d511b8 +(requested fix) + +texpdf, scaling of images (below the set max size), fix (+changelog) +2010-10-08 ralph@amissah.com +c7f4ff94 +(requested fix) + +sha256 (2.7.3) +2010-10-07 ralph@amissah.com +79ef5fd0 + +sisu_markup.sst, document a fix (v1 & 2) +2010-10-06 ralph@amissah.com +6bd30f0b (tag: sisu_2.7.3) + +dal_images, where image dimensions are set in an object, use those (+changelog & version date) +2010-10-06 ralph@amissah.com +c7bd43fb + +version & changelog 2.7.3 (squeeze freeze, fixes) +2010-10-03 ralph@amissah.com +6c5d44da + +hub, fix breakage when -y (manifest) is run without -m +2010-10-03 ralph@amissah.com +daf29aa2 +- hub, fix sisu breakage when -y (manifest) is run without the explicit or + implicit calling of -m (creation of document abstraction for processing), + (e.g. when --source or --sisupod is called on its own). + +urls, cleaning +2010-10-03 ralph@amissah.com +3eaa952a + +a few aliases added (long options) +2010-10-03 ralph@amissah.com +86c848ac + +sha256 (2.7.2) +2010-10-01 ralph@amissah.com +f019e7fa + +version & changelog 2.7.2 (squeeze freeze, fixes) +2010-10-01 ralph@amissah.com +41bb8b5b (tag: sisu_2.7.2) + +hub, test whether user name set, fix +2010-10-01 ralph@amissah.com +13b9e561 +(requested fix) + +epub, fix breakage where angle brackets used in used metadata header +2010-10-01 ralph@amissah.com +1d30e1a8 + +texpdf_format, remove a few commented out lines +2010-10-01 ralph@amissah.com +a8dbd882 + +sha256 (2.7.1) +2010-10-01 ralph@amissah.com +f0336c13 + +version & changelog 2.7.1 (squeeze freeze, bugfix) +2010-10-01 ralph@amissah.com +b2b581db (tag: sisu_2.7.1) + +shared_metadata, odt fix breakage where angle brackets used in metadata headers; & a typo fix +2010-10-01 ralph@amissah.com +fa305361 +- odt protect against breakage from angle brackets in metadata headers + (requested fix) + +manifest, typo fix +2010-10-01 ralph@amissah.com +ff6ec4b4 + +param, a few fixes (checks, aliases, typo) +2010-10-01 ralph@amissah.com +2fa09eb0 + +hub, removed commented out option (git), (already enabled elsewhere) +2010-10-01 ralph@amissah.com +0addde55 + +share_src, remove repetition, redundancy +2010-10-01 ralph@amissah.com +af86517f + +texpdf, a5, increase headheight (+changelog) +2010-09-27 ralph@amissah.com +5b92d55a + +texpdf, provide line-break-points for long directory names (+changelog) +2010-09-27 ralph@amissah.com +bbc1ea81 +(requested fix) + +texinfo, urls cleaned & with angle bracket decoration (+changelog) +2010-09-25 ralph@amissah.com +6132f2f2 + +texinfo ocn decoration a hash (instead of angle braces) (+changelog) +2010-09-25 ralph@amissah.com +a6917413 + +version update 2.7.1 +2010-09-25 ralph@amissah.com +674c34ef + +changelog 2.7.1 (squeeze freeze, bugfix) +2010-09-25 ralph@amissah.com +03247947 + +texinfo_format, texinfo output broken, fix (Closes #598063) +2010-09-25 ralph@amissah.com +3bf42456 + +sha256 (2.7.0) +2010-09-25 ralph@amissah.com +a2218b6f + +version & changelog sisu-2.7.0 +2010-09-21 ralph@amissah.com +3c5d60e2 (tag: sisu_2.7.0) +- Debian Squeeze equivalent (2.6.3-6 ported upstream) + +[sha256 (2.6.3-6) debian package rebuilt] +2010-09-20 ralph@amissah.com +769442ea + +changelog 2.6.3-6 [debian package rebuilt (squeeze freeze)] +2010-09-20 ralph@amissah.com +db3e84c4 + +html, v2 update (including --long-options) (manpage sync adds files) +2010-09-20 ralph@amissah.com +5e506682 + +manpage, v2 update (including --long-options) +2010-09-20 ralph@amissah.com +1b271cac + +sisu_commands.sst v2 update (including --long-options) +2010-09-20 ralph@amissah.com +36e2f004 + +help, minor update, revisit (includes minor fixes) +2010-09-20 ralph@amissah.com +08c8a523 + +identify markup, update ... revisit +2010-09-20 ralph@amissah.com +094fefb9 + +urls, sysenv, set manpage viewer to "man" +2010-09-18 ralph@amissah.com +244f9e96 + +options, bullet proof matches for --long-options (effects minor fix) +2010-09-18 ralph@amissah.com +a6867468 +- fixes issue noted with --sample-search-form (-F) (in the selection of + webrick (--webserv-webrick)) + +epub, fix xhtml line-break in rights metadata, results in unreadable epub (Closes: #596736) +2010-09-13 ralph@amissah.com +8fb333ce +- epub output not readable by all epub-reader software (Closes: #596736) + (else epub output can be viewed in calibre, but not in fbreader or okular) + +options, add expressive options --[name] as alternative to flags -[x] +2010-09-13 ralph@amissah.com +95a44653 + +changelog 2.6.3-4 [debian package rebuilt (squeeze freeze)] +2010-09-09 ralph@amissah.com +fd2a8474 + +param, remove redundancy in fix +2010-08-31 ralph@amissah.com +59134324 + +html headers do not include the "title" field, fix (Closes: #594949) +2010-08-31 ralph@amissah.com +ad8c8b5c +- param, variable not set (presumably since change from v1 to v2) + +yml metadata, add subheading for a title +2010-08-31 ralph@amissah.com +b3d4d3c6 + +html_format, xml_format, reduce visibility of sisu in output +2010-08-25 ralph@amissah.com +a56e6cd2 + +changelog 2.6.3-3 +2010-08-22 ralph@amissah.com +be94ecb2 + +markup sample (headers & yaml), links added/updated +2010-08-22 ralph@amissah.com +9b9d977a + +markup sample, minor book index fix +2010-08-22 ralph@amissah.com +2d0b8265 + +markup sample, cleaning of headers +2010-08-22 ralph@amissah.com +b11e4b81 + +[debian package rebuilt, sha256 (2.6.3-2)] +2010-07-29 ralph@amissah.com +6b159722 + +[debian package rebuilt, sha256 (2.6.3-3)] +2010-08-24 ralph@amissah.com +7b86e7a6 + +[debian package rebuilt, sha256 (2.6.3-2)] +2010-07-29 ralph@amissah.com +941845e7 + +options, minor code shuffling +2010-07-29 ralph@amissah.com +3946a7b8 + +sha256 (2.6.3) +2010-07-28 ralph@amissah.com +44ccd0a8 + +sisu-2.6.3 changelog, date, version +2010-07-28 ralph@amissah.com +0cf9b6b1 (tag: sisu_2.6.3) + +odf, footnotes, asterisk series (**) fix +2010-07-28 ralph@amissah.com +3d092a1c + +html_format, epub_format: subtoc, footnote content bug (fix) +2010-07-27 ralph@amissah.com +248be7a7 + +odf: lt (<), gt (>) fix for codeblocks; & fix, messy +2010-07-27 ralph@amissah.com +f5d98e3f + +epub_format, removed some title & author info, check +2010-07-27 ralph@amissah.com +5d2db4bd + +epub_tune,
(from
) +2010-07-27 ralph@amissah.com +c13a288d + +epub_format, within head, title & author +2010-07-27 ralph@amissah.com +2f171cf0 + +epub, toc copyat link removed +2010-07-27 ralph@amissah.com +d774b0db + +manifest, defaults, minimal sisu footer +2010-07-27 ralph@amissah.com +9cc6657b + +hub, add metaverse run for git (composite files) +2010-07-27 ralph@amissah.com +c5734e63 + +git, param, refine filename regex for composite files +2010-07-27 ralph@amissah.com +738c59b6 + +sysenv, cosmetic +2010-07-27 ralph@amissah.com +d80c096e + +git sisu directory structure, lang dir beneath txt +2010-07-26 ralph@amissah.com +de4b7d3e +- git sisu directory structure becomes more complicated + +html, links to output formats, remove icons +2010-07-26 ralph@amissah.com +e4e85022 + +manifest, minitoc configurable (true/false) +2010-07-26 ralph@amissah.com +61d3ba34 + +start moving homepage links, add listserv, update hompage (further updates required) +2010-07-21 ralph@amissah.com +725ec226 + +[debian package rebuilt, sha256 (2.6.2-2)] +2010-07-17 ralph@amissah.com +5a76ccd6 + +sha256 (2.6.2) +2010-07-15 ralph@amissah.com +b8de42c9 + +sisu-2.6.2 changelog, date, version +2010-07-15 ralph@amissah.com +05946d15 (tag: sisu_2.6.2) + +html_segments, line space between end of text and section bottom navigation bar +2010-07-13 ralph@amissah.com +6b2b8965 + +texpdf, codeblocks, left margin flush +2010-07-13 ralph@amissah.com +2b27e5ae + +sisu-harvest, alias for sisu --harvest (with man page) +2010-07-12 ralph@amissah.com +4d6f0440 + +texpdf, if no "copy @" info remove; rename left footer; asterisk issue +2010-07-12 ralph@amissah.com +59a86332 + +param, rights (all) add line breaks between copyright, license and other rights +2010-07-12 ralph@amissah.com +88909db5 + +vim syntax, in bulleted and indented text recognize bold +2010-07-12 ralph@amissah.com +51e263dc + +param, header reading more robust (re: commented out parts) +2010-07-10 ralph@amissah.com +063a3a50 + +sha256 (2.6.1) +2010-07-09 ralph@amissah.com +4392e22c + +changelog update +2010-07-09 ralph@amissah.com +b1c9cbe9 (tag: sisu_2.6.1) + +texpdf, monospace fix +2010-07-09 ralph@amissah.com +628f1f2b + +monospace (avoid url match false positive) +2010-07-09 ralph@amissah.com +07db6874 + +sysenv default output path fix +2010-07-09 ralph@amissah.com +0e550ce0 + +html_scroll, deals with index & endnotes +2010-07-09 ralph@amissah.com +788e0a8b + +dal, manifest & metadata headings, non-substantive, ocn removed +2010-07-09 ralph@amissah.com +b00b98bb + +sisu_manual, minor cleaning +2010-07-09 ralph@amissah.com +a62893a7 + +markup-samples, remove content, non-modifiable etc. +2010-07-08 ralph@amissah.com +b26a3f5c +- move to sisu-markup-samples in non-free + +moved markup samples +2010-07-08 ralph@amissah.com +2f28c5c8 +to data/doc/sisu/v2/markup-samples from data/doc/sisu/v2/sisu_markup_samples + +sha256 (2.6.0) +2010-07-08 ralph@amissah.com +4056a5a2 + +manpage for sisu-concordance alias +2010-07-08 ralph@amissah.com +c4256937 (tag: sisu_2.6.0) + +manpages, (also html) +2010-07-07 ralph@amissah.com +8498a120 + +Adding manpages for newly added sisu aliases. +2010-07-08 daniel@debian.org +cf845378 + +some cleaning of default outputs, ongoing +2010-07-07 ralph@amissah.com +fd20f4a7 + +provide alternative sisu command names sisu-pg & sisu-sqlite +2010-07-07 ralph@amissah.com +a058f50d + +sisu version & changelog +2010-07-07 ralph@amissah.com +3b080ad4 + +sisu.vim sisu version & date +2010-07-07 ralph@amissah.com +dd6b763d + +documentation, minor updates +2010-07-07 ralph@amissah.com +74849f94 + +manpage, remove monospace tag +2010-07-07 ralph@amissah.com +75e7a1c2 + +sysenv, version.yml moved to /usr/share/sisu (from /etc/sisu) +2010-07-07 ralph@amissah.com +ce3eec09 + +shared_xml, monospace marker for monospace tag +2010-07-06 ralph@amissah.com +e395e6f7 + +shared_html_lite, db_import, monospace font (codeblock & monospace tag) +2010-07-06 ralph@amissah.com +1866f5d2 + +db_import, remove monospace tag +2010-07-06 ralph@amissah.com +401aefb2 + +plaintext, remove monospace tag +2010-07-06 ralph@amissah.com +61f8426e + +texpdf, monospace font (codeblock & monospace tag) +2010-07-06 ralph@amissah.com +69cb98f9 + +odf, monospace font (codeblock & monospace tag) +2010-07-06 ralph@amissah.com +d714ab1d + +epub, monospace font (codeblock & monospace tag) +2010-07-06 ralph@amissah.com +839fa947 + +html, monospace font (codeblock & monospace tag) +2010-07-06 ralph@amissah.com +07e97b04 + +vim syntax, recognize #{ monospace }# tag +2010-07-06 ralph@amissah.com +b3597e94 + +dal_syntax, constants, introduce #{ monospace }# tag +2010-07-06 ralph@amissah.com +57c41630 + +urls, output info -t produces plaintext output +2010-07-06 ralph@amissah.com +267ba4e0 + +texpdf_format, output special characters, special circumstance fix +2010-07-06 ralph@amissah.com +896caee8 + +sysenv, make output directory if needed (if possible) +2010-07-02 ralph@amissah.com +1b62b854 + +Removing useless whitespaces from upstream files at EOL. +2010-06-29 daniel@debian.org +77d84aaf + +provide alternatives for producing single output types +2010-07-02 ralph@amissah.com +ee5b20c8 + +hub, make -t produce plaintext output, (documentation needs update) +2010-07-02 ralph@amissah.com +7799148a + +Free as in Freedom, add oclc (Online Computer Library Center) number and isbn +2010-06-29 ralph@amissah.com +aff29263 + +sha256 (2.5.1) +2010-06-12 ralph@amissah.com +80e3cbf9 + +update: changelog, version (2.5.1) +2010-06-12 ralph@amissah.com +8f2b1145 (tag: sisu_2.5.1) + +texpdf, ensure default font is set (Liberation Sans) +2010-06-12 ralph@amissah.com +906976cf +- a fix, (before this unless configured breaks) + +sha256 (2.5.0) +2010-06-11 ralph@amissah.com +f136873c + +debian/changelog (2.5.0-1) +2010-06-11 ralph@amissah.com +85415176 (tag: sisu_2.5.0) + +sisurc.yml, mention alternative ebook-viewers +2010-06-11 ralph@amissah.com +f55634c0 + +table, (xhtml, odf): empty cell (single tilde to indicate); allow line breaks +2010-06-11 ralph@amissah.com +2da35997 + +texpdf_format: add fontface to tables +2010-06-11 ralph@amissah.com +cb4968be +- tables add fontfaces (e.g. bold, italics, superscript) + +dal_syntax, apply fontfaces also to tables +2010-06-11 ralph@amissah.com +ba7bc578 +- bold, italics, superscript etc. + +vim syntax, highlight header @make: :texpdf_font: +2010-06-11 ralph@amissah.com +fdb1d0a3 + +texpdf set/select font, default "Liberation Sans" +2010-06-11 ralph@amissah.com +4ceb5eca +- requires that Liberation fonts be installed, hence version bump +- set font in: + sisurc.yml under default: texpdf_font: + marked up document under @make: :texpdf_font: + default if nothing set "Liberation Sans" + +param, fix breakage on malformed sisu identifier (top header line) +2010-06-11 ralph@amissah.com +4e298b68 +'% SiSU ...' [where badly formed] + +minor (cosmetic, & info retention) +2010-06-11 ralph@amissah.com +15a3a15a + +css (for html), right pane dark, distinguish from selected content +2010-06-11 ralph@amissah.com +bcbbdf4b + +sha256 (2.4.3) +2010-06-05 ralph@amissah.com +dd2989e9 + +update: changelog, version (2.4.3) +2010-06-05 ralph@amissah.com +1c921cbd (tag: sisu_2.4.3) + +vim/ftplugin/sisu.vim, make less intrusive +2010-06-05 ralph@amissah.com +7367105c +includes: +- ls dir files placed in vertically split window (also dir) +- rd search and replace down (in file) +- rg search and replace globally (in file) +- rr search and replace using ruby gsub (global search and replace) +Note: rf not used, ambiguous (replace forward or replace in file?) +- remove language and spelling american english, can't have a fixed default +- remove G (search and replace) binding +- remove F for fold file removed, use still available :F instead + +sha256 (2.4.2) +2010-06-01 ralph@amissah.com +35bd9574 + +update: changelog, version (2.4.2) +2010-06-01 ralph@amissah.com +6691e567 (tag: sisu_2.4.2) + +documentation, text, much todo +2010-06-01 ralph@amissah.com +2432349f + +remote file processing fix (url instead of local file), minor fix +2010-06-01 ralph@amissah.com +506bdded +(related to reporting "http" file not found) + +texpdf, start using polyglossia (xelatex) (instead of babel) +2010-06-01 ralph@amissah.com +236a63e8 + +sha256 (2.4.1) +2010-05-26 ralph@amissah.com +2bb04d2d + +update: changelog, version (2.4.1) +2010-05-26 ralph@amissah.com +da2cd465 (tag: sisu_2.4.1) + +general extension of regex matches for http: to include https: +2010-05-26 ralph@amissah.com +752cfd30 + +dal syntax, doc_str, http: matches to include https: +2010-05-26 ralph@amissah.com +1084e675 +also dal_syntax fix, no auto-bold or italics on relative or internal links + +texpdf_format, https: url match with tilde, fix +2010-05-26 ralph@amissah.com +2f5a240e + +epub & odf, regex matches for http: to include https: +2010-05-26 ralph@amissah.com +4aff107c + +sha256 (2.4.0) +2010-05-26 ralph@amissah.com +84e6d09e + +update: changelog, version (2.4.0) +2010-05-26 ralph@amissah.com +9fab84fc (tag: sisu_2.4.0) + +sisu documentation related mostly on markup +2010-05-26 ralph@amissah.com +fc32ec3c + +output formats internal document (and relative) linking as possible +2010-05-26 ralph@amissah.com +fec639c5 + +sysenv, require constants, (issue with webrick) +2010-05-26 ralph@amissah.com +bf068fde + +dal (syntax, doc_str, numbering) add internal document link to tagged point (including ocn) +2010-05-26 ralph@amissah.com +a2130055 + +vim syntax highlighter, added tag for internal document link to tagged point (including ocn) also new link markup to other documents in same collection directory +2010-05-26 ralph@amissah.com +f964fd1f +{ Linked text }#tagname + new link markup to other documents in same collection directory: +{ Linked text }:relative/link.html#23 +is the preferred equivalent of: +{ Linked text }../relative/link.html#23 + +sisurc.yml minor update and cleaning +2010-05-26 ralph@amissah.com +a3d0e86f + +sha256 (2.3.5) +2010-05-19 ralph@amissah.com +16e4ef02 + +update: changelog, version (2.3.5) +2010-05-18 ralph@amissah.com +503ba0d6 (tag: sisu_2.3.5) + +dal_doc_str, name tags fix +2010-05-18 ralph@amissah.com +176af370 + +dal_syntax, url match fix +2010-05-18 ralph@amissah.com +7c10db58 + +data/sisu/v2/conf/editor-syntax-etc/vim/templates .sst .ssm .ssi added +2010-05-16 ralph@amissah.com +bd36e13b + +sisu_markup.sst, documentation update *{emphasis}* !{bold text}! +2010-05-14 ralph@amissah.com +0d136555 + +sha256 (2.3.4) +2010-05-13 ralph@amissah.com +36e60044 + +urls, screen output control +2010-05-13 ralph@amissah.com +a7e63d14 (tag: sisu_2.3.4) + +update: changelog, version (2.3.4) +2010-05-12 ralph@amissah.com +38d6d813 + +sysenv, switch default hash digest fingerprints to sha256 (rather than md5) +2010-05-12 ralph@amissah.com +c50a51d5 + +dal_syntax, italics match fix +2010-05-12 ralph@amissah.com +fe748bd9 + +urls, screen output control +2010-05-12 ralph@amissah.com +2f70bd46 + +sha256 (2.3.3) +2010-05-05 ralph@amissah.com +2ed17e16 + +update: changelog, version (2.3.3) +2010-05-05 ralph@amissah.com +36982593 + +texpdf, special word optional break point detail +2010-05-05 ralph@amissah.com +2e5503eb (tag: sisu_2.3.3) + +defaults, reduce image sizes to fit landscape pdfs, (however, also used in equivalent portrait) +2010-05-05 ralph@amissah.com +4c3fbdc6 + +shared_metadata, texpdf, reduce text display size of digests +2010-05-05 ralph@amissah.com +bc114034 + +texpdf, url braces, (add, fix) +2010-05-05 ralph@amissah.com +70fdec5b + +texpdf, special word and number optional break points +2010-05-05 ralph@amissah.com +221cc959 + +sysenv, sisurc.yml, default shortform command flags +2010-05-05 ralph@amissah.com +f9dc0ff6 +- mostly taking out verbose as default, add -v when needed, e.g.: +sisu -3v filename.sst + +ansi, urls screen info, minor +2010-05-05 ralph@amissah.com +211ea9a9 + +sha256 (2.3.2) +2010-05-03 ralph@amissah.com +c4981256 + +update: changelog, version (2.3.2) +2010-05-03 ralph@amissah.com +39988018 (tag: sisu_2.3.2) + +ansi, screen info related, arranging +2010-05-03 ralph@amissah.com +67e49a2b + +dal_numbering, heading auto-numbering, a fix +2010-05-03 ralph@amissah.com +19b72494 + +shared_txt, text wrap,
related, revert, issues when indented, revisit +2010-05-03 ralph@amissah.com +78e75a4c + +screen output, & minor arranging +2010-05-02 ralph@amissah.com +003c1fac + +share source and sisupod make, control screen output +2010-05-01 ralph@amissah.com +d5a35a0e + +sisurc.yml, default: text_wrap: (78) & emphasis: (bold|italics|underscore) +2010-05-01 ralph@amissah.com +069631da + +urls, screen info control tuning +2010-05-01 ralph@amissah.com +24469afb + +-{emphasis}* display configurable as being bold, italics or underscore +2010-05-01 ralph@amissah.com +2708d32e + - markup for *{emphasis}* configurable as being displayed as bold, italics or + underscore, the default is that emphasis output is in bold so there is no + change unless configured, either in sisurc.yml (default: emphasis: 'bold'), or + the markup source document header @make: :emphasis: 'bold' + +reduce screen output unless some verbose flag (such as -v) is used +2010-05-01 ralph@amissah.com +d9763aeb + +param_identify_markup, identify version 2 markup +2010-04-30 ralph@amissah.com +90c65af1 + +texpdf, tell file being processed +2010-04-30 ralph@amissah.com +50c13fdb + +shared_txt, text wrap, deal with
markers where they occur +2010-04-30 ralph@amissah.com +719627cb + +manifest, expand on description of book indexes in manifest +2010-04-30 ralph@amissah.com +fbbae1ca + +vim syntax highlighter adds configuration of emphasis and plaintext_wrap to @make: +2010-04-30 ralph@amissah.com +890b8758 +- plaintext_wrap (@make: :plaintext_wrap:) +- emphasis (@make: :emphasis:) + +emphasis display and plaintext line wrap configurable in document or sis +2010-04-30 ralph@amissah.com +88029687 +- markup for *{emphasis}* configurable as being displayed either bold or + italics, the default is that emphasis output is in bold so there is no + at present unless configured, either in sisurc.yml (default: emphasis: + 'italics'), or the markup source document header @make: :emphasis: 'it + [requested] +- plaintext, wrap width configurable between 20 to 200 characters, the + default width being 78, configuration eithe rin sisurc.yml (default: t + 78), or the markup source document header (@make: :plaintext_wrap: 78) + +markup for *{emphasis}* configurable as being either bold or italics +2010-04-29 ralph@amissah.com +72180b72 +- the default is that emphasis output is in bold so there is no change at + present unless sisurc.yml is configured (markup: emphasis: 'italics') + [requested] + +dal, markup, auto-level 1~ conversion of hash to number +2010-04-28 ralph@amissah.com +c11185f9 +In cases where the line is interpreted as level 1~ (either by explicit 1~ tag +or @make: :heading:) a hash (#) [octothorpe] will be auto-incremented, markup +e.g. "1~ Chapter #: My Way". + +sha256 (2.3.1) +2010-04-28 ralph@amissah.com +512fb10b + +update: changelog, version (2.3.1) +2010-04-28 ralph@amissah.com +0b74735c (tag: sisu_2.3.1) + +param, for topic_register, an additional check required, bug fix, repost +2010-04-27 ralph@amissah.com +15e863ad + +sha256 (2.3.0) +2010-04-27 ralph@amissah.com +efb456ab + +update: changelog, version (2.3.0) +2010-04-27 ralph@amissah.com +fbd6fdfd (tag: sisu_2.3.0) + +i18n, mark OCLC number for translation +2010-04-27 ralph@amissah.com +74e7af80 + +switch markup for bold and emphasis, now !{bold}! and *{emphasis}* +2010-04-27 ralph@amissah.com +39943bc9 +(emphais output defaults to bold, later make it possible to configure emphasis +output optionally as being represented by italics) + +plaintext, clean up bulleted grouped text output (still not line-wrapped though) +2010-04-27 ralph@amissah.com +02afaef5 + +update: changelog, version (2.3.0) still under review +2010-04-26 ralph@amissah.com +bc4e077e + +vim syntax highlighter adds oclc to classify +2010-04-26 ralph@amissah.com +fae1f62c + +metadata, db sql (table structure), adds OCLC number, and; html metadata, renables showing of topic_register +2010-04-26 ralph@amissah.com +361032d4 +- db (sql) add oclc (Online Computer Library Center) number, affects table + structure, (hence breakage & version bump) + - new db name prefix "sisu_v2c_"; new pgsql db name prefix "SiSUv2c_" +- OCLC == Online Computer Library Center + +git, start experimenting with an alternative/parallel git based sisu document structure +2010-04-26 ralph@amissah.com +8b3f9e83 +- git, start to experiment with file structure to replace sisupod -g and will + be in configure options, to track changes to document, enable creation of + "pods" (zipped content) and allow for remote versioned (or unversioned) + placement of content source; ideally would end up with two co-existing, + distinct parse-able structures whether local or remote, the existing directory + structure with multiple documents and document images etc. and git directories + with all content associated with a single document (including other language + versions of it); cannot guarantee at this stage that the file structure will be + retained, which may mean recreating any directory started and defeat the + purpose of using it, though it is in a version control repo, so perhaps not ... + best left alone (unused) for now + +sisupod_make, take new markup into account, done for :skin: +2010-04-23 ralph@amissah.com +4cff73e6 +- not perfect, improve upon, should probably match @make: then :skin: + +defaults, for default home search form, always point to latest db version +2010-04-23 ralph@amissah.com +59fda008 + +constants, reduce max limit for SQL VARCHAR to 2500 to be within default postgresql range +2010-04-21 ralph@amissah.com +0bb8889d + +defaults, default sisu home, correct links to document examples and to summary +2010-04-21 ralph@amissah.com +9800f4b2 + +sisu_download.ssi link to breakage info not of current interest +2010-04-21 ralph@amissah.com +e2a4d3ff + +sha256 (2.2.0) +2010-04-20 ralph@amissah.com +4bc96b7b + +reverts unique words list column and indexes; fix for drop indexes; changelog & version update +2010-04-20 ralph@amissah.com +d348ae93 (tag: sisu_2.2.0) +- reverts unique word list column on doc_objects and endnotes and associated + indexes, may reintroduce at a later time +- db_drop, drop TEXT indexes for sqlite only +- update: changelog, version date + +update: changelog, version (2.2.0), review +2010-04-20 ralph@amissah.com +64ad02a5 + +cgi take account of db name prefix change SiSUv2b_ and changed column names +2010-04-20 ralph@amissah.com +7d5cf5f3 + +db name, tables, columns, indexes changes, review (need another version bump 2.2.0) +2010-04-20 ralph@amissah.com +63c5a3ce +- db (sql) table structure, further review and changes (hence breakage & version bump) + - new pgsql db name prefix "sisu_v2b_" + - new table column words in doc_objects & endnotes, VARCHAR 3000 to contain + list of unique sorted words in object + - increase use of VARCHAR + - constants takes on related additions +- param, extensive db column size checks for metadata + +dal, minor cosmetic re-arrangement +2010-04-20 ralph@amissah.com +7fc56d1d + +update: changelog, version (2.1.1) +2010-04-19 ralph@amissah.com +66d4fb55 (tag: sisu_2.1.1) + +shared_html_lite, markup heading objects +2010-04-19 ralph@amissah.com +9d34c408 + +db_select, check for whether db exists before attempting certain actions (note this does not check whether tables have been created) +2010-04-17 ralph@amissah.com +d1eeab54 + +db_import sqlite, prevent multiple import of file with same filename(.sst) (cgi form should work correctly, without multiple entries) +2010-04-17 ralph@amissah.com +9f5b2818 +db_import, db_remove: +- wrap some sqlite actions in sqlite check; +- cosmetic code arrangement + +db_create, on processing screen output appropriate display for pgsql & sqlite, minor fix +2010-04-17 ralph@amissah.com +85eb3805 +- previously reported pgsql info for sqlite processing + +db_sqltxt, issue with: escaping backslashes (that works for both pgsql & sqlite); missing author and/or title (where called in first heading) +2010-04-17 ralph@amissah.com +3ae376c8 + +db_dbi, cosmetic +2010-04-17 ralph@amissah.com +fb823467 + +cgi_sql_common, sample search form, on navigation of matched results +2010-04-17 ralph@amissah.com +fc01f2cd + +param, information on missing author, title, or copyright +2010-04-17 ralph@amissah.com +178ce66b + +shared_metadata, fix wrong reference to md.gutenberg instead of md.pg prevents building of latex/pdf in affected cases +2010-04-17 ralph@amissah.com +1ec06b89 + +dal, on processing screen output display, minor +2010-04-17 ralph@amissah.com +35e8a112 + +sha256 (2.1.0) +2010-04-16 ralph@amissah.com +df791cb9 + +update: changelog, version (2.1.0) (version bump for sql db structural changes) +2010-04-16 ralph@amissah.com +a99b58f9 (tag: sisu_2.1.0) + +cgi sample search form (cgi_sql_common): take account of db structure changes; match limit options +2010-04-16 ralph@amissah.com +c9d42a44 +- update to work with database structure changes +- add radio buttons to set increased match limit + +db, sysenv, sisurc.yml determine whether to share sisu markup source in db +2010-04-16 ralph@amissah.com +221cfa40 + +param checks metadata string lengths against set db column sizes +2010-04-16 ralph@amissah.com +dbc227d7 +- param, checks metadata string lengths against set db column sizes, drops + entries that are too long with warning +- param, classify "populated" a fix + +db sql table and column structure changes, name prefix "sisu_v2a_" resulting sisu version bump 2.1.0, plus other lesser fixes [Note: it is necessary to create new database and tables and to populate them] +2010-04-16 ralph@amissah.com +aa47d1db +- db (sql) database table name and column structure changes, new pgsql db name + prefix "sisu_v2a_" (version bump), continue to review + (db_columns, db_create, db_import, db_sqltxt) +- db remove and update fix, match filename for removal with = (not LIKE or ~) +- db sqlite, issue with --recreate, bugfix + (db_drop) + +db, shared_html_lite, link back to footnote/endnote reference, fix +2010-04-16 ralph@amissah.com +12479b34 + +vim syntax highlighting, minor +2010-04-16 ralph@amissah.com +787b5d9c + +sha256 (2.0.5) +2010-03-31 ralph@amissah.com +aba8f88a + +update: changelog, version (2.0.5) +2010-03-31 ralph@amissah.com +ab4974ca (tag: sisu_2.0.5) + +db_create, comments causing issues for sqlite, fix +2010-03-31 ralph@amissah.com +8dec9def + +cgi sql search form: comparison bug fix; clearer information when results exceed match limit set +2010-03-27 ralph@amissah.com +e4cc7091 +v2 and ino on limit set backported to v1 + +sysenv, search_widget, small adjustments +2010-03-27 ralph@amissah.com +9996dab2 + +harvest (v2): add search widgets; fixes bug in harvest_topics; other minor +2010-03-27 ralph@amissah.com +5ac46db4 + +sha256 (2.0.4) +2010-03-23 ralph@amissah.com +e603e6c3 + +update: changelog, version (2.0.4) +2010-03-23 ralph@amissah.com +f43fcebe (tag: sisu_2.0.4) + +free_as_in_freedom, link, additional material, minor +2010-03-23 ralph@amissah.com +fa5c94eb + +correct method call for md.title.full a number of places +2010-03-23 ralph@amissah.com +f5ea5dbe +- [in db_import, results in failure of doc import when called] + +sha256 (2.0.3) +2010-03-22 ralph@amissah.com +e5be411e + +update: changelog, version (2.0.3) +2010-03-22 ralph@amissah.com +77c941a6 (tag: sisu_2.0.3) + +xml_dom, behavior fixes +2010-03-22 ralph@amissah.com +fc14d487 + +shared_matadata, odf metadata use
[prevent
breakage] +2010-03-22 ralph@amissah.com +f2e312f5 + +odf, shared_xml, texpdf: grouped bulleted text +2010-03-22 ralph@amissah.com +804d1054 + +sha256 for 2.0.2 +2010-03-21 ralph@amissah.com +15781333 + +update: changelog, version +2010-03-21 ralph@amissah.com +fd47fd06 (tag: sisu_2.0.2) + +db_import, special character escape special endnote content +2010-03-21 ralph@amissah.com +7259fa99 +- e.g. ~[* such an endnote]~ +db_import (unrelated), remove condition (if @opt.cmd !~/e/), +minor, watch + +param, recommended links (reinstated) +2010-03-21 ralph@amissah.com +94a1eef9 + +sisu v1 vim syntax highlighter version and date +2010-03-21 ralph@amissah.com +77989d9d + +sisu v2 vim syntax highlighter version and date updated/corrected +2010-03-18 ralph@amissah.com +7acacafa + +sha256 for 2.0.1 +2010-03-17 ralph@amissah.com +59653d44 + +update version 2.0.1 +2010-03-17 ralph@amissah.com +4c4f8cf4 (tag: sisu_2.0.1) + +plaintext docoration (more flexible markings) +2010-03-17 ralph@amissah.com +f7a5bfcd + +param, adjustment for manpage synopsis +2010-03-17 ralph@amissah.com +0350589f + +documentation minor update, add epub, modify some dir paths +2010-03-17 ralph@amissah.com +fcad39c0 + +html tables fix (in html_segments, an erroneous assignment where there should have been comparison) +2010-03-12 ralph@amissah.com +93817753 + +vim syntax highlight, minor addition +2010-03-12 ralph@amissah.com +d8f4db00 + +sysenv, html_promo, db name prefix from constants (now SiSUv2_) +2010-03-10 ralph@amissah.com +438f9863 + +texpdf_format, where image missing, escape image markup loop +2010-03-10 ralph@amissah.com +750ea614 + +epub, html: make robust where missing param values +2010-03-10 ralph@amissah.com +c36e976c + +sha256 for 2.0.0 in other changelog +2010-03-10 ralph@amissah.com +5ad00611 + +sha256 for 2.0.0 +2010-03-06 ralph@amissah.com +a1838881 + +introducing version 2, major patch, (version 1 libraries retained) +2010-03-06 ralph@amissah.com +306aed5b (tag: sisu_2.0.0) + +skin_sisu utf-8 marker +2010-02-28 ralph@amissah.com +28cb7f91 + +sha256 for 1.0.3 +2010-02-17 ralph@amissah.com +d9009430 + +changelog & version update +2010-02-17 ralph@amissah.com +afd5812f (tag: sisu_1.0.3) + +document sample skins specify utf-8 (in some cases required by ruby 1.9.1) +2010-02-17 ralph@amissah.com +2b1c6be1 + +plaintext fix for footnotes/endnotes +2010-02-17 ralph@amissah.com +d88d970f +footnotes to occur immediately after paragraph that contains them +(unless endnotes selected instead) + +sha256 for 1.0.2 +2010-02-10 ralph@amissah.com +941c90aa + +markup samples minor adjustment +2010-02-10 ralph@amissah.com +d7c6cd9c (tag: sisu_1.0.2) + +Free as in Freedom (on RMS), by Sam Williams, sample markup, markup variation, affects document numbering +2010-02-10 ralph@amissah.com +d6650243 + +sha256 for 1.0.1 +2010-02-09 ralph@amissah.com +a96a43ec + +changelog, detail +2010-02-08 ralph@amissah.com +fdbcfb8a (tag: sisu_1.0.1) + +version +2010-02-08 ralph@amissah.com +d7ab2918 + +version, changelog, readme, touches +2010-02-08 ralph@amissah.com +e4d06fa6 + +param, sysenv, minor adjustments +2010-02-08 ralph@amissah.com +a2993b08 + +html grouped text that is bulleted +2010-02-08 ralph@amissah.com +0fae8cd0 + +data/doc/sisu/v1/sisu_markup_samples/samples, renaming of dfsg sub-dir +2010-02-05 ralph@amissah.com +c3abb9fa + +cosmetic +2010-02-04 ralph@amissah.com +83216775 + +CHANGELOG & README ... +2010-02-04 ralph@amissah.com +ff555f6a + + blob update, odt.zip fixes heading bug in odt representations +2010-02-04 ralph@amissah.com +31ec14a4 + +sha256 for 1.0.0 +2009-12-21 ralph@amissah.com +36560607 + +documentation get paths to reflect directory structure changes +2009-12-21 ralph@amissah.com +7145a299 (tag: sisu_1.0.0) + +data/doc/sisu some files moved to v1 dir +2009-12-20 ralph@amissah.com +746a74a4 + +documentation, small changes to description of -m & -n processing flags (closing debian bug #555496) +2009-12-19 ralph@amissah.com +9a29fdc4 + +changelog, & version number updates +2009-12-19 ralph@amissah.com +1f7535d1 + +cgi_sql_common, minor style related, (mostly enclosing of used variables in curly braces) +2009-12-19 ralph@amissah.com +cbd35cfd + +manpage, fix +2009-12-19 ralph@amissah.com +2c1c6e72 + +param & dal, includes removal of older header markup, simplification to allow cleaner v1 & v2 +2009-12-19 ralph@amissah.com +c55796e3 + +minor code adjustments +2009-12-19 ralph@amissah.com +31d9927f + +document samples, v1 minor fixes +2009-12-19 ralph@amissah.com +41fe06f7 + +directory structure changes to accommodate the introduction of sisu v2 +2009-12-19 ralph@amissah.com +51e583aa + +sisu.vim adjustments +2009-11-27 ralph@amissah.com +3151b3be + + harvest_authors, minor fix +2009-11-27 ralph@amissah.com +9866f881 + +cgi search, cosmetic +2009-08-31 ralph@amissah.com +0f69b7cd + +sha256 for 0.71.4 +2009-08-30 ralph@amissah.com +02236448 + +sql, fix, different solutions for postgresql and sqlite to populate database using ruby-dbi +2009-08-29 ralph@amissah.com +1c07669d (tag: sisu_0.71.4) + +sha256 for 0.71.3 +2009-08-28 ralph@amissah.com +617b72c5 + +dal images, where rmagick cannot be loaded use imagemagick directly if available +2009-08-28 ralph@amissah.com +a3e1f8bf (tag: sisu_0.71.3) + +sha256 for 0.71.2 +2009-08-02 ralph@amissah.com +b87c8735 + +sysenv sha256 fix, set pwd +2009-07-31 ralph@amissah.com +10cf38d0 (tag: sisu_0.71.2) + +html book index, batch processing fix, re-initialize variable after use +2009-07-28 ralph@amissah.com +6b436cd5 + +sha256 for 0.71.1 +2009-07-24 ralph@amissah.com +4ed6b9fc + +html seg, navigation band button placement +2009-07-24 ralph@amissah.com +20a2f636 (tag: sisu_0.71.1) + +dal images, if no rmagick, system call imagemagick directly if available +2009-07-24 ralph@amissah.com +39e72afa + +manifest, include book index if available +2009-07-23 ralph@amissah.com +0a0b3e17 +(after all, is usually more interesting than concordance file) + +html scroll left margin +2009-07-23 ralph@amissah.com +abfd15ad + +interim version number 0.71.1-pre +2009-07-23 ralph@amissah.com +2d98793e + +sha256 for 0.71.0 +2009-07-09 ralph@amissah.com +dfcc58f0 + +date for changelog and version +2009-07-09 ralph@amissah.com +62235748 (tag: sisu_0.71.0) + +duplicate changelog updated +2009-07-05 ralph@amissah.com +2052117d + +move lib to version 1 directory, (lib/sisu/v1) and make related changes +2009-07-04 ralph@amissah.com +7372f560 + +changelog, update +2009-07-04 ralph@amissah.com +7e99b8b5 + +xml related minor touches +2009-07-04 ralph@amissah.com +387104a1 + +texpdf mostly minor cleaning +2009-07-04 ralph@amissah.com +e3286ac4 + +html various minor: use suffix provided in constants; module SiSU_HTML_Tune; html promo +2009-07-04 ralph@amissah.com +4e4ce5d3 +html promo, possibility of use of adsense, or other + +dal_numbering, minor regex reduction +2009-07-04 ralph@amissah.com +9cbb974b + +dal_idx, book_idx_html, match sysenv +2009-07-04 ralph@amissah.com +a7774c04 + +make sisu and ruby version info ruby instance methods +2009-07-04 ralph@amissah.com +53a4ec45 + +version number + +2009-07-04 ralph@amissah.com +56c64ee2 + +bin file permissions set to 644 in repo +2009-07-03 ralph@amissah.com +41ab0aaf + +copyright date update and removed some white space +2009-07-02 ralph@amissah.com +627afc99 + +sha256 for 0.70.6 +2009-07-01 ralph@amissah.com +db97e85f + +changelog & version update +2009-07-01 ralph@amissah.com +e00c5485 (tag: sisu_0.70.6) + +cgi generated sample search form, fix +2009-07-01 ralph@amissah.com +1f70e711 + +db dbi, interfaces to sqlite and pgsql, fixes, pass individual sql statements +2009-07-01 ralph@amissah.com +0cdd579c + +minor fixes and touches +2009-07-01 ralph@amissah.com +643cc5c5 + +sha256 for 0.70.5 +2009-01-18 ralph@amissah.com +d372eb61 + +copyright presentation changed, remains substantively the same; minor sisu version bump +2009-01-18 ralph@amissah.com +a9891476 (tag: sisu_0.70.5) +copyright file uses (debian) machine parsable format +use: + - Copyright: (C) 1997 - 2009 Ralph Amissah All Rights Reserved. +to mean: + - Copyright: (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, + 2007, 2008, 2009 Ralph Amissah All Rights Reserved. +CHANGELOG updated and minor version bump 0.70.5 + +harvest, other language filenames +2009-01-01 ralph@amissah.com +c0f25024 + +year rollover +2009-01-01 ralph@amissah.com +013140d9 + +sha256 for 0.70.4 +2008-12-31 ralph@amissah.com +80a5b14f + +changelog and version updated +2008-12-31 ralph@amissah.com +3e1a65d5 (tag: sisu_0.70.4) + +latex/pdf tilde mark (bug in texlive, missing (at this instant) provide workaround) +2008-12-31 ralph@amissah.com +7d42c7a0 + +sha256 for 0.70.3 +2008-12-24 ralph@amissah.com +0351a192 + +changelog and version updated +2008-12-24 ralph@amissah.com +73ce7354 (tag: sisu_0.70.3) + +sqlite3 fix, populate do using rb sqlite3 driver directly (rb dbi problematic at present) +2008-12-22 ralph@amissah.com +71223cf6 +sqlite fix, change ruby driver used to populate sisu sqlite3 db to rb sqlite3 +for the time being. Use rb sqlite3 driver directly rather (than more convenient +when working) rb dbi interface to populate content. Used to bypass problems +with rb dbi sqlite3 interface noted in sisu 0.66.2 (2008-04-25) and 0.66.3 +(2008-05-11) that have have persisted (apparently worked at end 2007 (v.0.62.4) +and start of 2008 (v.0.64.0) +- sqlite dropall, fix +- fix to auto-generated sqlite cgi script sample, only works if at least one +existing populated sisu sqlite database is found during the generation process + +SiSU's sqlite module still broken for the time being: inconsistent ruby dbi api for sqlite3, (unable to begin and commit transaction) provide explicit message +2008-12-17 ralph@amissah.com +2f97cf3f +problem noted already in v.0.66.2 (2008-04) and last in v.0.66.3 (2008-05) +module (& rb dbi) apparently worked at end 2007 (v.0.62.4) and start of 2008 +(v.0.64.0) ... (did not expect broken state to last, sorry) +include maintenance mode info with -M flag + +html & css cosmetic changes (index & concordance), run "sisu -CC"; changelog +2008-12-16 ralph@amissah.com +b2d26ed3 + +close html

tag for "letter" class +2008-12-16 ralph@amissah.com +0c4c1608 + +sha256 for 0.70.2 +2008-12-16 ralph@amissah.com +8b4d8117 + +changelog and version updated +2008-12-16 ralph@amissah.com +86be8ced (tag: sisu_0.70.2) + +changelog, now build +2008-12-16 ralph@amissah.com +7f0e4fd4 + +harvest_authors, sort authors works +2008-12-16 ralph@amissah.com +ea4fafff + +i18n, fix related to variable renaming +2008-12-16 ralph@amissah.com +8f87662e +likely bug introduced: fb1e1bf0cb8a2202eda1ab254b01b997df60a6db +(with comment: metadata, variable renaming (requires testing)) + +minor touches +2008-12-16 ralph@amissah.com +8f66f086 + +manpage, help include: sisu --harvest *.ss[tm] +2008-12-16 ralph@amissah.com +d5841faf + +sha256 for 0.70.1 +2008-12-14 ralph@amissah.com +ac1dacca + +changelog and version updated +2008-12-14 ralph@amissah.com +0107793f (tag: sisu_0.70.1) + +changelog synced and man pages, minor updates +2008-12-14 ralph@amissah.com +1deffbef + +emacs syntax highlighting, updated metadata fields +2008-12-14 ralph@amissah.com +1784bcc4 + +param & dal, cosmetic, text placement +2008-12-14 ralph@amissah.com +c27f4dff + +markup samples, minor updates +2008-12-14 ralph@amissah.com +38275568 + +metadata, variable renaming (requires testing) +2008-12-13 ralph@amissah.com +fb1e1bf0 +metadata, variable renaming (dropped use of dc_ to signify dublin core metadata +as is subset of what is used and cumbersome to identify) - testing required +manpage minor touch + +mostly additional metadata fields +2008-12-13 ralph@amissah.com +f20476d3 +additional metadata fields +css minor touch +help minor info touch + +help and changelog update +2008-12-11 ralph@amissah.com +4a660c92 + +sysenv, cosmetic touch +2008-12-11 ralph@amissah.com +a2d74ab5 + +html tables, fix to structure and for (specified) column widths +2008-12-11 ralph@amissah.com +6149eecb + +tex/pdf, bullet mark, workaround current absence from tex-live) +2008-12-11 ralph@amissah.com +5948a4e5 +bug in tex-live, no doubt temporary + +param, enfoorce name formatting rule (recently introduced) across name fields +2008-12-11 ralph@amissah.com +54d88760 + +harvest, better integrated into sisu +2008-12-11 ralph@amissah.com +1b8c2dbf +[note sql module not yet updated to include topic_register, as requires +recreation of all sisu db(s)] + +odf_format, copyright notice consistency +2008-12-11 ralph@amissah.com +0fa51361 + +sha256 for 0.70.0 +2008-12-03 ralph@amissah.com +f6dbb690 + +changelog and version updated +2008-12-03 ralph@amissah.com +b3d3b3f8 (tag: sisu_0.70.0) + +sisu harvest, introduce module along with header syntax addition & modification +2008-12-02 ralph@amissah.com +0e6fc15a +- sisu markup, additional header and new format rule: + - @creator: / @author: header field, introduced author name format rules + for more usable metadata harvesting: surname comma other names, additional + authors separated by semi-colon + - param added meta-tag, @topic_register: formatting topic levels are + separated from sub-levels by a colon, a semi-colon separates main topics + if there are multiple topics at lowest sub-level, a pipe can be used to + create multiple headings +- harvest module, harvests metadata from document set currently extracts: (i) + authors and their writings from document set; (ii) topics and associated + writings from document set (topics use topic_register header). harvest + (when run against documents common to a directory of a site) extracts + metadata and organises the documents on a site by author and topic + information provided (there is a new "topic_register" header, with + formatting rules similar to those of the book index), results are placed in + [output_path]/sisu_site_metadata. + sisu --harvest *.sst + - by author (see change in param @creator: / @author: header field) + - by topic / subject index (see addition in param of @topic_register: + header field) + initially there should be an example samples here: + http://www.jus.uio.no/sisu/sisu_site_metadata/harvest_authors.html + http://www.jus.uio.no/sisu/sisu_site_metadata/harvest_topics.html + together with update markup source files + The authors and their writings list will be made to take on a more + biblographical form, with the use of additional fields as required. + (concept example, suitable for medium sized sites [to remove size + constraint: implement SQL equivalent]) make feature more robust +- css, for harvest output added +- remote placement of sisu_site_metadata (output produced by metadata harvest) +- sisu markup, update document samples accordingly +- tidy copyright marks in program headers, remove repetition of dates +[version bump because formatting rule introduced to author / creator header - +where new site metadata harvest feature is used, (at present changes changes +should not be noticed except when using metadata harvest)] + +sha256 for 0.69.4 +2008-11-03 ralph@amissah.com +51413fd9 + +changelog and version updated +2008-11-03 ralph@amissah.com +edc7d97f (tag: sisu_0.69.4) + +sisu-mode.el make version number match this sisu version where introduced +2008-11-03 ralph@amissah.com +917b58bb + +changelog updated +2008-11-03 ralph@amissah.com +6e5c6c22 + +ruby1.9 some testing minor changes +2008-11-03 ralph@amissah.com +868478a6 +opened to run with ruby1.9, (however not all used libraries ported on system) +continue to use ruby1.8 series >= ruby1.8.4 + +regex match refinement +2008-11-03 ralph@amissah.com +c662fb09 + +dal and param various changes (some affecting other files) +2008-11-03 ralph@amissah.com +9458eedd +dal, minor changes including +related to bold line instruction and, +variable name change affecting other files +param, header tag for document index, create site index of documents +use, add info on document content, harvest info provided from document set for +metadata to create site index of documents (similar sub-sytax to book index) +also variable name +others variable name change, made earlier in dal and param + +software libré, accent +2008-11-03 ralph@amissah.com +454d3b84 + +diakonos editor syntax highilighting, updated conf file from v0.8.6 +2008-11-03 ralph@amissah.com +27d38e54 + +sisu-mode.el, emacs syntax highlighting contributed by Ambrose Kofi Laing +2008-11-03 ralph@amissah.com +c523a513 +based on work by Tong Sun (doc-mode.el) and included with his kind permission + +vim syntax, header, version number updated +2008-10-14 ralph@amissah.com +33016270 + +sha256 for 0.69.3 +2008-10-10 ralph@amissah.com +5744266c + +changelog and version updated +2008-10-10 ralph@amissah.com +bf4d928f (tag: sisu_0.69.3) + +date touch +2008-10-10 ralph@amissah.com +3642ce76 + +book code, minor adjustment; and fix to manifest reporting of the creation of sisupod (zip) +2008-10-10 ralph@amissah.com +bf2a99e8 + +sha256 for 0.69.2 +2008-09-19 ralph@amissah.com +07834082 + +changelog and version updated +2008-09-19 ralph@amissah.com +13e1b36c (tag: sisu_0.69.2) + +sample sisu markup "Free as in Freedom": book index markers included, and; identify markup helpers updated * sample sisu markup "Free as in Freedom": book index markers included * identify markup helpers updated +2008-09-19 ralph@amissah.com +452f2c20 + +sha256 for 0.69.1 +2008-09-17 ralph@amissah.com +a82216e1 + +changelog and version updated +2008-09-17 ralph@amissah.com +7681e3d5 (tag: sisu_0.69.1) + +dal fix, dal_substitutions_and_insertions get skin info +2008-09-17 ralph@amissah.com +cb4f9d5b + +sha256 for 0.69.0 & note on addition to vim syntax included in version +2008-09-16 ralph@amissah.com +8c5ab6b4 + +changelog and version updated +2008-09-16 ralph@amissah.com +b6654602 (tag: sisu_0.69.0) + +fixes: alphabet list (concordance, dal_idx), and file types (dal_expand_insertions) +2008-09-16 ralph@amissah.com +f555e077 + +changelog date, touch +2008-09-15 ralph@amissah.com +a4bc8604 + +various small fixes * html segments, name more accurately * rough description of how book index markup works * clean out book index from these outputs * book markup sample, free as in freedom, start doing book index, only letter "A" done so far * texpdf, url matching, special characters * # Please enter the commit message for your changes. +2008-09-15 ralph@amissah.com +87a7cfcd + +dal_idx, and concordance, letter list for navigation +2008-09-13 ralph@amissah.com +dbde53fb + +dal_idx: capitalize first letter of index lev1 for sort; provide letter a-z navigation +2008-09-13 ralph@amissah.com +b3f2c67f + +dal_idx: strip before sort; fix bug where first lev is range +2008-09-12 ralph@amissah.com +bb1e2142 + +primarily on book index where (markup) provided * book index, html, tex/pdf, xml * texpdf no ocn if ocn is 0 * odf, plaintext, if book index? remove ... do other outputs for which not relevant * concordance, better matches * constants, dal special character for hardspace changed as (ruby) regx bug in replacing it in xml, odd but move on Note: to fix html seg headers for endnotes and for index +2008-09-10 ralph@amissah.com +291080c0 + +book index, sample html file and to screen sisu markup sample added (-M flag) +2008-09-08 ralph@amissah.com +1529e474 + +dal, several modules split into separate files +2008-09-08 ralph@amissah.com +798d710d + +book index (markup adjustment, dal module); dal numbering moved to separate module; version date +2008-09-07 ralph@amissah.com +36559403 + +minor unicode for a type of cross +2008-09-07 ralph@amissah.com +e4626408 + +character given to represent non-break space in internal code (dal, constants and affected downstream code) +2008-09-05 ralph@amissah.com +9432d034 + +dal, bullet footnotes fix (check numbered bullets, should also be ok) +2008-09-05 ralph@amissah.com +7c96df7f + +dal, left and right quotes (single & double) kept; previously converted to ordinary quotes (watch) +2008-09-03 ralph@amissah.com +fc826abe + +xml character encoding adjusted; xml image match; odf issue with '@' symbol in url +2008-09-03 ralph@amissah.com +2a738f52 + +html segments; sql db field lengths increased +2008-09-02 ralph@amissah.com +b2ef4107 + +texpdf: paper use dimensions, tolerance, url matching; removal of dummy headings when not used; manifest presentation * texpdf: paper use dimensions, tolerance, url matching; * removal of dummy headings when not used (html scroll, latex/pdf, odf) * manifest presentation +2008-08-29 ralph@amissah.com +749e0d84 + +texpdf: removed space at beginning of paragraph; grouped text url fix +2008-08-28 ralph@amissah.com +a0012a41 + +texpdf, footnotes align left (ragged), footnote numbers removed from margin +2008-08-27 ralph@amissah.com +c01a2c64 + +texpdf: landscape tables in two column text fixed; footnote margin increased +2008-08-27 ralph@amissah.com +602a7b49 + +texpdf: paper use dimensions url and urlbreaks removal of a maths package gives back typeface changes like bold better representation of tilde changelog update +2008-08-27 ralph@amissah.com +c6d41d93 + +minitoc added, used by manifest and concordance; html css div sorting +2008-08-24 ralph@amissah.com +f1fe4547 +a earlier commit relies on minitoc prior to its addition, this fixes that issue +html css divs, need to be watched across different html output + +minitoc added to concordance and manifest; dal, precision in endnote matching +2008-08-23 ralph@amissah.com +2a93f7b9 + +pass Hash to Format classes; some match tuning in dal +2008-08-23 ralph@amissah.com +08c69d07 + +a bit of a cleanup, and change reference to null to ordinary +2008-08-18 ralph@amissah.com +5787bd8e + +rsync, replace --delete-after with --delete apparently not all versions of rsync accept more specific option +2008-08-17 ralph@amissah.com +d74651a9 + +html document structure, div markers, watch +2008-08-17 ralph@amissah.com +0c15db87 + +html segments structure and info provided (a bit verbose), and css +2008-08-17 ralph@amissah.com +0ec26776 + +html segments, links to concordance file only if made, fix +2008-08-16 ralph@amissah.com +89d5ace0 + +html css and div related +2008-08-16 ralph@amissah.com +afb83150 + +texpdf, fix: image dimension match (for post 0.68.0 changed middle layer representation) +2008-08-14 ralph@amissah.com +e2fb7c37 + +html format, consolidate html_format file, prune later; version number bumped version number bump: is necessary to re-initialize using new css for html presentation sisu -CC +2008-08-14 ralph@amissah.com +6759751b + +html, css and related markup, touch +2008-08-14 ralph@amissah.com +f42c740c + +html, css and related markup +2008-08-14 ralph@amissah.com +e2533559 + +interim version info +2008-08-12 ralph@amissah.com +d2121e12 + +html increased use of css; dal, middle layer, url representation, interim commit +2008-08-12 ralph@amissah.com +d43865fb + +sisu-0.68.0 + sha256 +2008-07-22 ralph@amissah.com +c9ab55b6 + +changelog and version updated +2008-07-22 ralph@amissah.com +a9aba79c (tag: sisu_0.68.0) + +sisu-0.68.0 proposed * middle layer document representation changed, (accounting for substantial patch) * texpdf multiple document sizes as specified in config * numerous small fixes [should on the whole be easier to maintain] +2008-07-22 ralph@amissah.com +d29a3e54 + +action response query fix +2008-07-19 ralph@amissah.com +839d4f18 + +texpdf papersize adjustments primarily for portrait sizes a5 & b5 +2008-07-13 ralph@amissah.com +677885e5 + +sisu-0.67.5 + sha256 +2008-07-12 ralph@amissah.com +59e154d5 + +changelog and version updated +2008-07-12 ralph@amissah.com +d1985f50 (tag: sisu_0.67.5) + +texpdf fixes, xetex and xelatex processing commands, and fix for a5 landscape pdf +2008-07-12 ralph@amissah.com +d7ec8e17 + +sisu-0.67.4 + sha256 +2008-07-12 ralph@amissah.com +22cd1d4e + +changelog and version updated +2008-07-12 ralph@amissah.com +7ffd3583 (tag: sisu_0.67.4) + +minor fixes: remote sourcefile; processing directory; manifest info +2008-07-12 ralph@amissah.com +14d7b8a5 + +sisu-0.67.3 + sha256 packaged urgency="medium" +2008-07-03 ralph@amissah.com +bcf3cef6 + +changelog and version updated +2008-07-03 ralph@amissah.com +c1103fcf (tag: sisu_0.67.3) + +rebuild, "sisu --help env" fix and texpdf papersize re-fixed +2008-07-03 ralph@amissah.com +c28c5943 + +changelog and version updated +2008-07-02 ralph@amissah.com +189c8f05 (tag: sisu_0.67.2) + +sysenv/texpdf, xetex landscape pdf fix +2008-07-02 ralph@amissah.com +f0bfa230 + +sysenv/texpdf, fix required for xetex landscape pdfs +2008-07-02 ralph@amissah.com +36bead6d + +changelog and version updated +2008-06-22 ralph@amissah.com +6fdd6406 + +sisu-0.67.1 + sha2s +2008-05-27 ralph@amissah.com +f0083bff + +changelog and version updated +2008-05-27 ralph@amissah.com +0f9b3024 (tag: sisu_0.67.1) + +syntax highlighting minor adjustments +2008-05-27 ralph@amissah.com +f6bfcead + +update to kate syntax highlighter +2008-05-25 ralph@amissah.com +094a67c6 + +sisu-0.67.0 + sha256 +2008-05-23 ralph@amissah.com +24a4716f + +sisu-0.67.0 + md5s +2008-05-22 ralph@amissah.com +53f876ac + +changelog and version updated +2008-05-22 ralph@amissah.com +c689f2d0 (tag: sisu_0.67.0) + +version update in documentation +2008-05-22 ralph@amissah.com +e1aea639 + +update man pages and version +2008-05-22 ralph@amissah.com +5a62d708 + +simplify syntax for import of external files, e.g.: +2008-05-22 ralph@amissah.com +4cd184d2 +<< filename.sst +minor related syntax changes, automatic version bump +make appropriate additions to vim-syntax +consider use of vim-addon manager + +sisu-0.66.3 + md5s +2008-05-11 ralph@amissah.com +f8e79d11 + +changelog and version updated +2008-05-11 ralph@amissah.com +16727b04 (tag: sisu_0.66.3) + +minor sync +2008-05-11 ralph@amissah.com +6c62ebc7 + +retained existing homepage +2008-05-10 ralph@amissah.com +b470801d + +update changelog +2008-05-10 ralph@amissah.com +654d12a3 + +introduced particulars (rename later) for commonly used document and environment details, and cleaned up some requires +2008-05-10 ralph@amissah.com +34cee014 + +syenv updates, mostly sql related +2008-05-10 ralph@amissah.com +738c2473 + +some re-arrangement related to sqlite3 testing (including a rudimentary sql import file, dbi by-pass) +2008-05-10 ralph@amissah.com +d004875c + +addition of a couple of multiline search tags, and minor rearrangement +2008-05-10 ralph@amissah.com +dc0648fe + +sisu-0.66.2 + md5s +2008-04-25 ralph@amissah.com +29d6ad93 + +changelog and version updated +2008-04-25 ralph@amissah.com +e373b94f (tag: sisu_0.66.2) + +update changelog +2008-04-25 ralph@amissah.com +303107cd + +sqlite3 complete transaction issue not yet resolved +2008-04-24 ralph@amissah.com +a8c78d0c + +move to sqlite3, an issue with finalising transactions (commit, close...) +2008-04-24 ralph@amissah.com +ebda41b0 + +sisu-0.66.1 + md5s +2008-03-30 ralph@amissah.com +16b42d24 + +changelog and version updated +2008-03-30 ralph@amissah.com +c504ed42 (tag: sisu_0.66.1) + +minor fixes, changelog note on debian debhelper compat >=6 +2008-03-30 ralph@amissah.com +cf4ac1d8 + +tex to pdf, xetex (utf8) added as alternative to pdftex +2008-03-22 ralph@amissah.com +bbd1100d + +track a couple of questions +2008-03-14 ralph@amissah.com +cb0a9b1b + +extend semantic shorthand +2008-03-01 ralph@amissah.com +439a0b77 + +sisu-0.66.0 done +2008-02-25 ralph@amissah.com +d79ff267 + +changelog and version updated +2008-02-24 ralph@amissah.com +68114cb6 (tag: sisu_0.66.0) + +clean screen output +2008-02-24 ralph@amissah.com +623b97ad + +CHANGELOG 0.66 and ruby identify program files as utf-8 +2008-02-24 ralph@amissah.com +2ff88bb0 + +information update +2008-02-24 ralph@amissah.com +7de4fcdd + +enable conversion from sst to various forms of input xml and back including 0.66 tags +2008-02-24 ralph@amissah.com +ec9282e2 +sst_to_s_xml (sax/dom/node) semantic xml mockup naive conversion of known abbreviated tags, +in flux, e.g. + sisu --to-sax autonomy_markup0.sst +back to sst markup with: + sisu --from-sxml autonomy_markup0.sxs.xml +sst_to_s_dom fix to footnote/endnote conversion + +make possible to strip 0.66 markup in dal commit +2008-02-24 ralph@amissah.com +db151024 + +for now strip sisu-0.66 semantic markup tags +2008-02-24 ralph@amissah.com +528875ec + +extract identification of use of sisu-0.66 markup tags +2008-02-24 ralph@amissah.com +654d4984 + +identify sisu-0.66 tags +2008-02-24 ralph@amissah.com +5c5510b3 + +vim syntax highlighting for sisu-0.66 +2008-02-24 ralph@amissah.com +b3e9f8db +refinements to semantic tag matching +still no error checking and match wider than likely to be ultimately +check for earlier versions of vim removed +updated to use "hi def link" instead of HiLink + +sisu-0.65.0 +2008-02-16 ralph@amissah.com +2d88e919 + +changelog and version updated +2008-02-16 ralph@amissah.com +b1544cda (tag: sisu_0.65.0) + +regex matches vim syntax hilighting +2008-02-16 ralph@amissah.com +9e789c86 + +markup tag match refinement +2008-02-16 ralph@amissah.com +daf2b7fe + +refinement to semantic tag regex matching +2008-02-15 ralph@amissah.com +2cd36957 + +sisu-0.64.4-1 + md5s +2008-02-14 ralph@amissah.com +34b727d1 + +changelog and version updated +2008-02-14 ralph@amissah.com +ec5e2d9f + +manpage clean +2008-02-14 ralph@amissah.com +d6092833 (tag: sisu_0.64.4) + +changelog and version +2008-02-14 ralph@amissah.com +774847f0 + +for now render new markup syntax inactive +2008-02-14 ralph@amissah.com +7322b33b + +enable identification of new markup +2008-02-14 ralph@amissah.com +6d345eae + +introduce syntax highlighting for new syntax markers +2008-02-14 ralph@amissah.com +40e09659 + +minor information/help (man page) related +2008-02-14 ralph@amissah.com +2aa25d8c + +sisu-0.64.3 +2008-02-06 ralph@amissah.com +df792b86 + +changelog and version updated +2008-02-06 ralph@amissah.com +d9583c54 (tag: sisu_0.64.3) + +date +2008-02-06 ralph@amissah.com +56b4da68 + +minor update +2008-02-05 ralph@amissah.com +e9a250f9 + +version rolled back, not ready to open ruby 1.9 some libraries not yet available +2008-02-05 ralph@amissah.com +8bec16e3 + +comment +2008-02-05 ralph@amissah.com +bcde2dab + +minor info updates +2008-02-05 ralph@amissah.com +65ceda53 + +ruby 1.9 open; future pgsql testing on 8.3; encoding utf-8 checks; version bump 0.65.0 +2008-02-05 ralph@amissah.com +4c36cadd +- ruby 1.9 use opened, testing required +- db sql pgsql future testing on version 8.3 +- encoding utf-8 some compatibility checks + +for update replace LIKE with '=' ; required by pg8.3 bigint +2008-02-02 ralph@amissah.com +a97f505a + +sisu-0.64.2 + md5s +2008-01-19 ralph@amissah.com +199a4ec2 + +changelog and version updated +2008-01-19 ralph@amissah.com +9311a548 (tag: sisu_0.64.2) + +mkdir_p, and again close running of ruby 1.9 +2008-01-19 ralph@amissah.com +d6b580c9 +- mkdir_p, [instead of ftools file.mkpath] +- running against ruby 1.9 closed for now + raise request for use of version 1.8 branch +- manual update version + +permit to run on ruby 1.9, debian unstable requires it +2008-01-18 ralph@amissah.com +48bbce70 + +sisu-0.64.1 + md5s +2008-01-09 ralph@amissah.com +83b61a60 + +changelog and version updated +2008-01-09 ralph@amissah.com +0d88f12f (tag: sisu_0.64.1) + +odf bug (angle brackets) preliminary fix +2008-01-09 ralph@amissah.com +c4cc1e5a +odf bug reported related to use of angle brackets in markup +affects some odf output, preliminary fix + +correct a date +2008-01-03 ralph@amissah.com +f158725f + +sisu-0.64.0 + md5s +2008-01-02 ralph@amissah.com +2362b15e + +changelog and version updated +2008-01-02 ralph@amissah.com +5e4f7f21 (tag: sisu_0.64.0) + +manual download version updated, minor +2008-01-02 ralph@amissah.com +8bc1d842 + +changelog update on packaging bug #454372, on purge, postrm removal of /etc/sisu +2008-01-02 ralph@amissah.com +9a2a8b83 + +bump version number +2008-01-02 ralph@amissah.com +58084d17 + +sql, postgresql allow tcp/ip connections, parameters from rc file, sisurc.yml +2008-01-02 ralph@amissah.com +084433a8 + +year updated to 2008 - happy new year +2007-12-31 ralph@amissah.com +e70f4053 + +adjustments for ruby1.9 (xmas), in sysenv moved default location of processing directory +2007-12-31 ralph@amissah.com +79ec1b33 +sysenv, processing in subdirectory under /tmp/_sisu_processing~ [instead +of within home], (subdirectory) named after owner with permissions +restricted to owner + +change primary key indexes to bigint (requested) +2007-12-31 ralph@amissah.com +1dd09c87 + +sisu-0.63.0 + md5s +2007-12-20 ralph@amissah.com +a34b7c62 + +changelog and version updated +2007-12-20 ralph@amissah.com +67074fe9 (tag: sisu_0.63.0) + +sisupod, bugfixes for rsync placement and for download and processing +2007-12-20 ralph@amissah.com +3535397c + +rsync sisupod, bugfix +2007-12-17 ralph@amissah.com +b1afa422 + +texpdf, generate sisu latex output in a single pass +2007-12-17 ralph@amissah.com +a9d166c6 +implications if additional modules added +e.g. provide dvi file without latex pdf headers +or generate an A6 document by default for e-readers capable of reading pdf +(this would otherwise require a separate pass/loop of content for each +type to be generated) +current shortcoming, images are sized for smaller landscape output by +default, image dimension adjustments not yet made (for different +orientation) + +sisu-0.62.4 + md5s +2007-12-14 ralph@amissah.com +25fca204 + +changelog and version updated +2007-12-14 ralph@amissah.com +2b9542e0 (tag: sisu_0.62.4) + +gpl links etc. +2007-12-14 ralph@amissah.com +1ce7060c + +vim search and replace default set to C-@ +2007-12-08 ralph@amissah.com +a4b2e0c5 + +changelog and version updated +2007-12-08 ralph@amissah.com +084d10a9 + +gpl links updated and added link to plaintext as allows for convenient use of vim gf +2007-12-03 ralph@amissah.com +48318c93 + +vim ftplugin/sisu and colors/slate +2007-12-03 ralph@amissah.com +60ac9183 +ftplugin, added toggle for menu +slate, added cursor line and column color black ... may not provide enough contrast for some, this way i use it though + +sisu-0.62.3-3 + md5s +2007-11-30 ralph@amissah.com +da12ef26 + +changelog and version updated +2007-11-30 ralph@amissah.com +7b51b2f8 + +note made in changelog about need to prefix Dm-Upload-Allowed with -XS +2007-11-30 ralph@amissah.com +158fc754 + +sisu-0.62.3-2 + md5s +2007-11-29 ralph@amissah.com +76e9f80f + +changelog and version updated +2007-11-29 ralph@amissah.com +b2ba824e + +sisu-0.62.3 + md5s +2007-11-27 ralph@amissah.com +5c56af2b + +changelog and version updated +2007-11-27 ralph@amissah.com +8149d722 (tag: sisu_0.62.3) + +html scroll more convenient (code) placement of line separator

+2007-11-27 ralph@amissah.com +c87c41a5 + +Dm-Upload-Allowed: yes +2007-11-26 ralph@amissah.com +61773282 + +0.62.3 version pre-build +2007-11-26 ralph@amissah.com +a0034e64 + +html scroll line separator before document information +2007-11-26 ralph@amissah.com +061ef005 + +html scroll,
line separator before endnotes and metadata +2007-11-26 ralph@amissah.com +6b9b5203 + +sisu_download.ssi version number info +2007-11-26 ralph@amissah.com +99b2f566 + +sysenv, scp provide variable, fix +2007-11-26 ralph@amissah.com +6ce42d65 + +sysenv step in remote images test needs to be retained +2007-11-26 ralph@amissah.com +b0b8fd1f + +various small adjustments for 0.62.3 +2007-11-26 ralph@amissah.com +bee31a90 +- html
follows text, before footnotes (refine later) +- rsync remote images partial fix +- minor bug fix, related to error message passing, in texpdf and url +- sisu_manual version info +- vim ftplugin, status line info on cursor position modified + +sisu-0.62.2 + md5s +2007-11-03 ralph@amissah.com +fa196b1f + +changelog and version updated +2007-11-03 ralph@amissah.com +7b7f6708 (tag: sisu_0.62.2) + +linitan override for homepage field +2007-11-03 ralph@amissah.com +487179ac + +touch +2007-11-03 ralph@amissah.com +f238bd9d + +remote markup source, image download; vim ftplugin sisu.vim status line; vim colors reporting of slate.vim +2007-11-03 ralph@amissah.com +07a81e99 + +generate from remote markup source, image path fix and some cosmetic re-arrangement +2007-11-01 ralph@amissah.com +cfe3d294 + +note on debian/control Homepage header +2007-10-26 ralph@amissah.com +8fa4231c + +db rearranging, create, drop, import (and a renaming: db_dbi from shared_db) +2007-10-26 ralph@amissah.com +96049bf5 + +sisu-0.62.1 + md5s +2007-10-22 ralph@amissah.com +b180201d + +changelog and version updated +2007-10-22 ralph@amissah.com +b9e1e445 + +version change 0.62.1 +2007-10-22 ralph@amissah.com +4f0ea624 (tag: sisu_0.62.1) + +regex to match composite file names in db common and cgi +2007-10-22 ralph@amissah.com +c3254743 + +sisu-0.62.0 + md5s +2007-10-20 ralph@amissah.com +bc35b52f + +changelog and version updated +2007-10-20 ralph@amissah.com +d0231794 (tag: sisu_0.62.0) + +dal, available shared output shortcut, adjustment needed for footnote/endnote +2007-10-20 ralph@amissah.com +f21af4b5 + +dal todo with path to shared source; shared xml cosmetic +2007-10-20 ralph@amissah.com +8f62a8cc + +build most likely after midnight +2007-10-19 ralph@amissah.com +20658d27 + +manifest image paths +2007-10-19 ralph@amissah.com +93777412 + +mostly paths for shared markup source (txt and pod), also... +2007-10-19 ralph@amissah.com +8c67d466 +also current Debian/Sid ruby1.9 upgrade removes a bug, so a related +test/warning in options.rb removed + +mostly adjustment to image paths (for local and remote operations) +2007-10-19 ralph@amissah.com +d41a9542 + +adjust detail for 0.62 build +2007-10-19 ralph@amissah.com +8eceaceb + +first pass at fictionbook output; images posted with document rsync; also ... +2007-10-19 ralph@amissah.com +db15c23a +- first pass at fictionbook output - fictionbook is interesting, (develop over + time or drop support) +- images in document posted with document rsync +- ruby1.9 strip bug re-encountered in debian sid build version, (unless it is + my setup) +see changelog + +minor detail +2007-10-17 ralph@amissah.com +6a95a0e1 + +manpage, todo with rearrangement of conditionals, adjusted and sisu.1 regenerated +2007-10-16 ralph@amissah.com +b0d16176 + +image list, extracting conditions and regex visited +2007-10-16 ralph@amissah.com +45acf3b7 + +mostly the arrangement of conditionals +2007-10-15 ralph@amissah.com +e1ec4bd2 + +regex matching of images, (and rearrangement of conditionals) +2007-10-15 ralph@amissah.com +8e092e0f + +remote_conn, accepting multiple remote hosts, sysenv also beginning of rearrangement of conditionals +2007-10-15 ralph@amissah.com +33adab3a + +remote server configuration info set in sisurc.yml for multiple hosts, sysenv and help +2007-10-15 ralph@amissah.com +4ef892c9 +sisurc.yml remote host settings takes both old and new configuration notation +new being through use of Array for each host '-' separator, [example is provided] + +composite master renaming, and; multiple remote puts (rsync|scp) +2007-10-15 ralph@amissah.com +7c6478d2 +- composite master files: eliminate ._sst, replace with .ssm.sst +- multiple remote hosts ("distributed" rsyncing), yml config files remote now + uses array +with all recent changes (directory shunting) much testing is yet to be done, +state is unstable some things are known not to work this instant, e.g. sisu -V + +default image directories moved, more convenient/logical [test] +2007-10-14 ralph@amissah.com +75d9ef83 + +shared markup source output moved to own common src directory +2007-10-14 ralph@amissah.com +69e8c052 + +remote, (put, get) in single file; embedded content, posted locally and remotely using rsync +2007-10-13 ralph@amissah.com +84666b3d + +start version marking interim releases +2007-10-13 ralph@amissah.com +a35a675f + +man page update +2007-10-13 ralph@amissah.com +7e55cfa8 + +underscore exception requires additional tweaking of regexes, solution not optimal (sisu_markup as basic test) +2007-10-13 ralph@amissah.com +48f57660 + +sisu manual download page, clean +2007-10-12 ralph@amissah.com +a59b3c4f + +sisu-0.61.0 + md5s +2007-10-12 ralph@amissah.com +5564435e + +sisu_vim, manpage issue +2007-10-12 ralph@amissah.com +be7cc72e (tag: sisu_0.61.0) + +special character exceptions, some fixes, primarily underscore +2007-10-12 ralph@amissah.com +6acc0270 + +xml dom extract footnote from grouped text +2007-10-12 ralph@amissah.com +b05af207 + +available outputs shortcut display, description of odf:odt expanded +2007-10-12 ralph@amissah.com +01f5d52b + +for html and latex/pdf permit switch off of object numbering display from within skins +2007-10-12 ralph@amissah.com +c6090f3f + +minor cleaning, note that object character numbering for html and pdf can be changed within skin +2007-10-12 ralph@amissah.com +6867253e + +sisu manual and man page update +2007-10-12 ralph@amissah.com +640d12c3 + +start readying for 0.61 +2007-10-12 ralph@amissah.com +eacca80e + +changelog bring forward release; sisu_manual, small things +2007-10-11 ralph@amissah.com +38d0e06f + +sisupod_make, composite file is an exception +2007-10-11 ralph@amissah.com +39bf7a71 + +shared markup source, composite documents, fix look to processing directory for: text share source and binary sisupod (make) +2007-10-11 ralph@amissah.com +2178c097 + +sisu_manual right column, use absolute url paths and some url fixes +2007-10-11 ralph@amissah.com +4a8968d1 + +sysenv, extra check for sisurc search info (and a cosmetic change (quotes)) +2007-10-10 ralph@amissah.com +c07cf366 + +changelog update +2007-10-09 ralph@amissah.com +e2a0ca35 + +markup header, cleaning of obsoleted url_png marker +2007-10-09 ralph@amissah.com +74de5591 + +texpdf, when not to output numbers on text objects +2007-10-09 ralph@amissah.com +55e57fd8 + +dal_syntax, relative links changed to absolute, may wish to reconsider +2007-10-09 ralph@amissah.com +b93fb15a +relative links primarily of interest for html output, for which may wish to retain + +command line processing shortcuts changed +2007-10-09 ralph@amissah.com +73ab0fc4 +-1 does only -hwpoyv and (obsoleted) -A changed in sysenv with -a + +dal, permit writing of note before and after autogen of available outputs shortcut +2007-10-09 ralph@amissah.com +e834150d + +manual, change source links to archive rather than transient repo +2007-10-08 ralph@amissah.com +3c2c67ec + +dal, shortcut for available outputs, present as grouped text object +2007-10-08 ralph@amissah.com +37f81bc4 +this makes more sense for search results - matches all available versions of a +document +[affects document objects and numbering where used, hence version number bump] + +sisu-0.60.1 + md5s +2007-10-07 ralph@amissah.com +e9a6c2f6 + +changelog and version updated +2007-10-07 ralph@amissah.com +d0c52566 (tag: sisu_0.60.1) + +touch download version +2007-10-07 ralph@amissah.com +88b536c9 + +cleaning, and make sure in xml   rather than   is used +2007-10-07 ralph@amissah.com +3804f096 + +dal, fix shortcult for listing available generated output (without source); html, keep ocn id where no visible ocn +2007-10-06 ralph@amissah.com +2386d74a + +document header, link to markup and book examples +2007-10-06 ralph@amissah.com +3be4b9a5 + +param, multi-line parse, fixing @link: header +2007-10-06 ralph@amissah.com +17dfb02b + +0.60.0 debian package rebuilt (-2) with debian/control reference to "sisu-doc" removed +2007-10-04 ralph@amissah.com +c59ad12e + +changelog and version updated +2007-10-04 ralph@amissah.com +9f872ec2 + +changelog mention 0.60.0-2 debian build, debian/control remove mention of sisu-doc +2007-10-04 ralph@amissah.com +1c4972bd + +sisu_download, keep changing version? +2007-10-04 ralph@amissah.com +431c8958 + +sisu-0.60.0 + md5s +2007-10-03 ralph@amissah.com +268d38f7 + +changelog and version updated +2007-10-03 ralph@amissah.com +e29c178b (tag: sisu_0.60.0) + +0.60, build and post +2007-10-03 ralph@amissah.com +92e09d39 + +minor changes for 0.60, hub removes -A -e -E, all under -a; termsheet make path instead of dir +2007-10-03 ralph@amissah.com +652e850d + +set /tmp/_sisu_processing directory permissions to 777, (each user has a sub-directory thereunder) +2007-10-01 ralph@amissah.com +9c1de41b + +sitemaps touch commented out +2007-10-01 ralph@amissah.com +63212d19 + +proposed as sisu-0.60.0, see updated CHANGELOG +2007-10-01 ralph@amissah.com +ad5fbbc1 +- parameter reading on first run of file, (initialization of parameters) +- composite files (.ssm) building moved to processing directory, to overcome + problem of non-writable sisu-source document directories, perhaps also + cleaner (management of files) +- latex/pdf minor cleaning, + - caret '^' is latex special character, additional match for escaping + - clean major headings of markup heading tag with tilde and name + e.g. '1~meta' +- param / metadata, hash sums now returns has sum and file-name only even for + sisu-skin + +small update and fix +2007-09-30 ralph@amissah.com +d0081f94 + +changelog, minor edit +2007-09-29 ralph@amissah.com +b00fd983 + +hash test now will return only filename, no path, man page and man2html update +2007-09-29 ralph@amissah.com +d71ead0c + +man2html regenerated +2007-09-29 ralph@amissah.com +064ca6df + +minor adjustment for man-pages pdf, postgresql, sqlite, as primarily used there +2007-09-29 ralph@amissah.com +f5cc951f + +start preparing sisu-auto-generated man pages for 0.60 release +2007-09-29 ralph@amissah.com +c5e3e37e + +prepare documentation for use ... +2007-09-29 ralph@amissah.com +7b09e652 + +sisu documentation related +2007-09-29 ralph@amissah.com +7d9fced3 + +reorganising documentation +2007-09-29 ralph@amissah.com +761f2323 + +defaults & configuration of suggested manpage generating/viewing tool/display +2007-09-28 ralph@amissah.com +5240532e + +removal of auto-generated manpages +2007-09-28 ralph@amissah.com +7903fdb6 + +remove additional (auto-generated) manpages, re-evaluate each addition +2007-09-28 ralph@amissah.com +8efb2177 + +param parsing changed to multi-line (affects regex matching, watch); manpage related changes, manpage header @man: added in param and used in manpage +2007-09-28 ralph@amissah.com +7475e34f + +hub, help info provided on typing sisu change +2007-09-28 ralph@amissah.com +d0b04c36 + +for now remove (sphinx or robot) images, obtain compatible copyright permission from author, likely not to be a problem, but clarify +2007-09-28 ralph@amissah.com +162fe2a5 + +matches to take account of internal new naming/tagging of "document information" heading 1~meta +2007-09-26 ralph@amissah.com +3f282d76 + +sisu-0.60 intruduces separate sisu-doc package, rationale in CHANGELOG +2007-09-26 ralph@amissah.com +8d5f29f4 + +gen manual pages alone for testing +2007-09-26 ralph@amissah.com +594d7bb0 + +make "rant" document generation possible without copying of files into sisu package +2007-09-26 ralph@amissah.com +2a391443 + +changelog info updated +2007-09-26 ralph@amissah.com +7ca12a4b + +segmented html fix for batch processing placement of heading :A-:C footnotes in first segment +2007-09-26 ralph@amissah.com +9f52af3d + +dal, make metaverse heading :A (represented internally as 1~) easily distinguishable, (tagged 1~meta) +2007-09-26 ralph@amissah.com +b49c8cdc + +help, (hub), minor reorganisation and a change in response for typing 'sisu' without options +2007-09-26 ralph@amissah.com +a36b83da + +sysenv, sisurc.yml allow use of relative output paths, expand to absolute +2007-09-26 ralph@amissah.com +0770dd95 + +document gen rantfile, use relative path, (cleaning) +2007-09-26 ralph@amissah.com +b04ac0d9 + +changelog explains rational behind sisu-0.60 removal of generated document output from the main sisu +2007-09-26 ralph@amissah.com +15e330dc +- changelog explains rational behind sisu-0.60 removal of generated document output from the main (sisu) source tarball +- configuration files changed to output generated content to sisu-doc tarball directory tree + +remove generated output from main package +2007-09-25 ralph@amissah.com +a72e66db + +move generated output out of main package +2007-09-25 ralph@amissah.com +3282dbf3 + +regen +2007-09-25 ralph@amissah.com +beb6cfdf + +sisu-0.59.1 + md5s +2007-09-25 ralph@amissah.com +aa8f20b5 + +changelog and version updated +2007-09-25 ralph@amissah.com +d549a9a8 (tag: sisu_0.59.1) + +documentation regenerated +2007-09-25 ralph@amissah.com +3d67c3ba + +manual homepage for now +2007-09-25 ralph@amissah.com +be92fd0e + +sisu documentation minor updates +2007-09-25 ralph@amissah.com +2c9d9472 + +document generation Rantifle config fix, and config file path change +2007-09-25 ralph@amissah.com +f63e4194 + +cosmetic: html table of contents; urls html output +2007-09-25 ralph@amissah.com +9208f711 + +documentation regenerated, large diff +2007-09-24 ralph@amissah.com +a6d72d82 + +changelog update +2007-09-24 ralph@amissah.com +a25e6dc1 + +toc, css, distinguish "Document Information (metadata)" link from other links, made smaller +2007-09-24 ralph@amissah.com +57486aeb + +html toc, css, cosmetic fix for rights and prefix in toc +2007-09-24 ralph@amissah.com +7a77fb05 + +html table of contents, cosmetic fix for rights and prefix appearing with toc +2007-09-24 ralph@amissah.com +d345aacb + +changelog update +2007-09-24 ralph@amissah.com +ff9fc025 + +plaintext, space between endnotes where --endnote option selected +2007-09-24 ralph@amissah.com +9ce8e0c7 + +manpage, special character fixes +2007-09-24 ralph@amissah.com +341e92ed + +minor cleaning of documentation source, headers +2007-09-24 ralph@amissah.com +0c414e38 + +documentation, sisu_download.ssi maintenance NOTE: +2007-09-24 ralph@amissah.com +eb0175ca +for version of document insert kept within packge: +- update sisu version numbers to build to be created, and +- keep stripped of package version hashes + (which are only available subsequent to build) + +sisu-0.59.0 + md5s uploaded to sisudoc.org debian repo 2007-09-23 (Accra @ Uncle Jack's) +2007-09-24 ralph@amissah.com +a558d2e6 + +changelog and version updated +2007-09-23 ralph@amissah.com +5fd7eb0a (tag: sisu_0.59.0) + +minor cleaning +2007-09-23 ralph@amissah.com +4ac76c46 + +primarily todo with sisu documentation, changelog reproduced below: +2007-09-23 ralph@amissah.com +50d45c6d +- start documenting sisu using sisu + - sisu markup source files in + data/doc/sisu/sisu_markup_samples/sisu_manual/ + /usr/share/doc/sisu/sisu_markup_samples/sisu_manual/ + - default output [sisu -3] in + data/doc/manuals_generated/sisu_manual/ + /usr/share/doc/manuals_generated/sisu_manual/ + (adds substantially to the size of sisu package!) +- help related edits +- manpage, work on ability to generate manpages, improved +- param, exclude footnote mark count when occurs within code block +- plaintext changes made +- shared_txt, line wrap visited +- file:// link option introduced (in addition to existing https?:// and + ftp://) a bit arbitrarily, diff here, [double check changes in sysenv and + hub] +- minor adjustments + - html url match refinement + - css added tiny_center +- plaintext + - endnotes fix + - footnote adjustment to make more easily distinguishable from substantive + text + - flag -a only [flags -A -e -E dropped] + controlled by modifiers --unix/msdos --footnote/endnote +- defaults, homepage + - renamed homepage (instead of index) implications for modifying skins, + which need likewise to have any homepage entry renamed + - added link to sisu_manual in homepage +- css the css for the default homepage is renamed homepage.css (instead of + index.css) [consider removing this and relying on html.css] +- ruby version < ruby1.9 + - place stop on installation and working with for now [ruby String.strip + broken in ruby 1.9.0 (2007-09-10 patchlevel 0) [i486-linux], + 2007-09-18:38/2] + - debian/control restrict use to ruby > 1.8.4 and ruby < 1.9 +- debian + - debian/control restrict use to ruby > 1.8.4 and ruby < 1.9 + - sisu-doc new sub-package for sisu documentation + debian/control and sisu-doc.install + +sisu-0.58.3 + md5s +2007-09-06 ralph@amissah.com +b98abcba + +changelog and version updated +2007-09-06 ralph@amissah.com +380c2aa4 (tag: sisu_0.58.3) + +cosmetic output fixes related to 'Copy @' default note +2007-09-06 ralph@amissah.com +d11d4c51 + +distinguish param's markup type identifier module from standalone +2007-09-06 ralph@amissah.com +e483f855 + +sisu-0.58.2 + md5s +2007-09-05 ralph@amissah.com +1234561b + +changelog and version updated +2007-09-05 ralph@amissah.com +0020fb24 (tag: sisu_0.58.2) + +code-block exceptions for composite documents sisu-0.58.2 +2007-09-05 ralph@amissah.com +459119df + +sisu-0.58.1 + md5s +2007-09-04 ralph@amissah.com +dd3fb566 + +changelog and version updated +2007-09-04 ralph@amissah.com +8d5cf231 (tag: sisu_0.58.1) + +dal detail, code-block exception to header markup of bold and italics +2007-09-04 ralph@amissah.com +cd0649bf + +comment +2007-09-04 ralph@amissah.com +ea4deaae + +grouped text, pdf indents and size +2007-09-04 ralph@amissah.com +f153bba3 + +code-block exceptions +2007-09-04 ralph@amissah.com +f7a6194c + +sisu-0.58.0 + md5s +2007-09-04 ralph@amissah.com +8d66ef70 + +changelog and version updated +2007-09-03 ralph@amissah.com +70ec44da (tag: sisu_0.58.0) + +changelog note on minor change to debian/control +2007-09-03 ralph@amissah.com +74e49e21 + +sisu-0.58 work towards making it possible to describe sisu and sisu markup within sisu +2007-09-03 ralph@amissah.com +2cd558f6 + +sisu-0.57.0 md5s +2007-08-23 ralph@amissah.com +f3387d9b + +changelog and version updated +2007-08-23 ralph@amissah.com +94eed15f (tag: sisu_0.57.0) + +recognise .ssm filetype in hup, make sisu --identify parse .ssm files without complaining, (check for kockon) +2007-08-23 ralph@amissah.com +9721c3a4 + +version bump to 0.57, minor addition to markup (a header to heading shortcut) and sisurc.yml update for additional search form option (hyperestraier) +2007-08-22 ralph@amissah.com +91f5be6f + - markup addition, headings, shortcut for top level title (and author) + :A~ @title @author (also available for level 2 (or 3) author) [version bump] + - param markup identifier (and identifier) updated to identify markup + addition in 0.57, :A~ @title + - html search form in navigation band/banner and promo, adjustments, + hyperestraier option offered in promo, requires change in sisurc.yml + - sisurc.yml requires changes to make use search form options, [version + bump] sample updated and commented out + +small fixes to manifest and html_scroll, and adjustment to html navigation band use in concordance and manifest +2007-08-21 ralph@amissah.com +7ef4f9a3 +- manifest + - use relative link by default + - in absence of configured url_root (http://) use info on location on local + filesystem (file://) +- html outputs, navigation band/banner adjustment, in concordance and manifest +- html scroll, fix to document information link in table of contents + +0.56.3 md5s +2007-08-21 ralph@amissah.com +5bacb121 + +changelog and version updated +2007-08-19 ralph@amissah.com +a15a426a (tag: sisu_0.56.3) + +sisu-0.56.3 minor update, small fixes +2007-08-19 ralph@amissah.com +a19b7494 + - manifest make file-type descriptions simpler to understand + - copyright restricted to rights tag, unless none, in which case rights tag + gets creator information + - copyright mark picked up in rights if 'Copyright (C)' is used + - tex/pdf url matching semi-colon following url + - endnote heading, apply tag to exclude numbering and segment heading where + there is no segment + - html scroll endnote text minor fix + - initialize site structure, make copy site images default (sisu -CC) + +sisu-0.56.2 + md5s +2007-07-31 ralph@amissah.com +0e5ffbf0 + +changelog and version updated +2007-07-31 ralph@amissah.com +807964d7 + +odf regex matches, 0.56.2 +2007-07-31 ralph@amissah.com +5aa5fb54 + +changelog and version updated +2007-07-31 ralph@amissah.com +b34082b8 + +info related to match change +2007-07-31 ralph@amissah.com +65ddb9b6 (tag: sisu_0.56.1) + +endnote,url regex matching, refinement - still a limitation in mixed use of shortcut +2007-07-31 ralph@amissah.com +c54fc5e3 + +sisu 0.56.0 + md5s +2007-07-31 ralph@amissah.com +9c64fde5 + +changelog and version updated +2007-07-31 ralph@amissah.com +cde0c4c1 (tag: sisu_0.56.0) + +note on new version number +2007-07-31 ralph@amissah.com +380ff9c4 + +rebuild with new version number +2007-07-31 ralph@amissah.com +e7b1b0c6 + +sisu-0.55.7 + md5s +2007-07-31 ralph@amissah.com +6b8574fc + +changelog and version updated +2007-07-31 ralph@amissah.com +6e97528e (tag: sisu_0.55.7) + +changelog date +2007-07-31 ralph@amissah.com +76a97e3b + +man page date minor +2007-07-30 ralph@amissah.com +cdf35004 + +-0 no longer produces output without numbering (ocn), help info updated +2007-07-30 ralph@amissah.com +b5c601bd + +replace tabs with spaces +2007-07-30 ralph@amissah.com +b44d71f6 + +replace unintended tabs with spaces +2007-07-30 ralph@amissah.com +f17c8b94 + +processed number added for urls and remote placement +2007-07-30 ralph@amissah.com +8643893b + +mention need to rebuild database +2007-07-30 ralph@amissah.com +4ab55930 + +increase size of identifier in db, url (identifier) automatically constructed in param +2007-07-30 ralph@amissah.com +3725ec08 + +url matching, semi-colon as possible terminator, in dal match https +2007-07-30 ralph@amissah.com +a99e0de5 + +using postive lookahead for url matching, test if to change +2007-07-28 ralph@amissah.com +31745ffc + +sisu-0.55.6 urgency=medium +md5s +2007-07-28 ralph@amissah.com +262ae3c5 + +changelog and version updated +2007-07-28 ralph@amissah.com +a85bbc6a (tag: sisu_0.55.6) + +url matching, refinement necessary, use of positive lookahead not avoided, correction and rebuilt +2007-07-28 ralph@amissah.com +a407aff4 + +changelog touch +2007-07-28 ralph@amissah.com +97b20df5 + +mention of rake +2007-07-28 ralph@amissah.com +adf89025 + +dir names changed +2007-07-28 ralph@amissah.com +30733c44 + +commit rbuild as common rake rant build file +2007-07-27 ralph@amissah.com +580a36e5 + +maintain rinstall as a common rant (Rantfile), rake (Rakefile) +2007-07-27 ralph@amissah.com +01777d7a + +rant installer adjustments +2007-07-27 ralph@amissah.com +b4946f88 + +multiple url matching refinements, open archive initiative +2007-07-26 ralph@amissah.com +a1fd226e + +changelog, info touch +2007-07-24 ralph@amissah.com +d91b99e2 + +changelog, info touch +2007-07-24 ralph@amissah.com +169af668 + +open archive initiative for metadata harvesting, initial implementation, decide use later -O +2007-07-24 ralph@amissah.com +b0481de5 + +matching of multiple urls within paragraph, fix +2007-07-24 ralph@amissah.com +55d54980 + +note on debian vim dealings +2007-07-23 ralph@amissah.com +93089756 + +vim syntax copy posted to bram, time stamped +2007-07-23 ralph@amissah.com +a6e080d3 + +copyright tidy +2007-07-22 ralph@amissah.com +5167ede3 + +vim directory moved from within addons +2007-07-22 ralph@amissah.com +55132691 + +sisu-0.55.5 + md5s urgency medium, Closes: #434168, vim syntax and ftplugin moved to vim-scripts directory +2007-07-22 ralph@amissah.com +d307da76 + +changelog and version updated +2007-07-22 ralph@amissah.com +5588c376 (tag: sisu_0.55.5) + +comment on moving of vim syntax and ftplugin to /usr/share/vim-scripts +2007-07-22 ralph@amissah.com +546b06cb + +refinement to underscore match for single word in dal +2007-07-22 ralph@amissah.com +566a186f + +changelog update to reflect recent changes +2007-07-22 ralph@amissah.com +379f5183 + +output note on software libre +2007-07-22 ralph@amissah.com +d4a27daa + +dal, matching of underscore so as not to be too greedy +2007-07-22 ralph@amissah.com +43897469 + +vim syntax, matching of url with escape url decoration tag (_url) +2007-07-22 ralph@amissah.com +0bc57c34 + +comment on open standards, qualification +2007-07-21 ralph@amissah.com +91cfdd0b + +init output dir fix, and comment on open standards +2007-07-21 ralph@amissah.com +06275fe7 + +sisu-0.55.4 + md5s +2007-07-20 ralph@amissah.com +8d97ca06 + +changelog and version updated +2007-07-20 ralph@amissah.com +24ab90e5 (tag: sisu_0.55.4) + +output comment on better reliance on standards and being software libre +2007-07-20 ralph@amissah.com +54e91dad + +scope in matches of individual documents where AND is used as text matching criteria +2007-07-16 ralph@amissah.com +1aac76e1 + +cgi_sql_common, generated sample search form, indentation +2007-07-16 ralph@amissah.com +7b15f4d0 + +refactoring, tidy +2007-07-16 ralph@amissah.com +3993be7d + +changelog and version updated +2007-07-14 ralph@amissah.com +4f009ef7 (tag: sisu_0.55.3) + +better name for method in sample search; nedit syntax does not work +2007-07-14 ralph@amissah.com +8b3fd2d1 + +sample search form, previous next arrows +2007-07-14 ralph@amissah.com +4b26d5da + +clean +2007-07-13 ralph@amissah.com +eefb75b9 + +syntax hilighting (gedit), sisu rights and other info in outputs, cgi sample search improvements, see changelog +2007-07-13 ralph@amissah.com +546ea64f + +various fixes: cgi search for, manifest, concordance, diakonos syntax highlghting +2007-07-11 ralph@amissah.com +214c1b72 +- cgi search subtitle and odf link +- manifest and concordance, subtitle and author info +- diakonos syntax highligthing; + +cgi search form worked on and presentation, (an info button added and used) +2007-07-10 ralph@amissah.com +22fab950 +- cgi, generated sample search form, rearranged presentation +- editor syntax highlighting, kate, kwrite visited + +improved url matching, and texpdf tolerance and indentation levels set +2007-07-09 ralph@amissah.com +fdd1489c + +sisu-0.55.2 + md5s +2007-07-07 ralph@amissah.com +70949c60 + +changelog and version updated +2007-07-07 ralph@amissah.com +3a76bfa8 (tag: sisu_0.55.2) + +cgi-sample search form; texinfo fix; xml scaffold; help, man pages etc. visited; screen output, color set to true; docbook entries removed +2007-07-07 ralph@amissah.com +52f8b9c0 +- cgi generated sample search form + - order results on files of the same title, in multiple files (with + different filenames) + - postgresql, character case sensitivity, control, on/off + - tail decoration, gplv3 & sisu info +- texinfo/info (pinfo) module starts to do something vaguely useful again + [not a much used module, testing required] +- print XML rendition of document structure to screen -T +- sisurc.yml default, color set to true + [apologies if this causes anyone any inconvenience, it is configurable in + sisurc.yml] +- help, man pages, README (man(8) related and env, 'sisu -V') +- docbook entries removed for the present time +- sisu-install (install ruby rant script renamed) and permissions set to + executable + +0.55.1 sync +2007-07-04 ralph@amissah.com +765c40e5 + +sisu-0.55.1 + md5s +2007-07-02 ralph@amissah.com +8b75f58a + +version yml ! +2007-07-02 ralph@amissah.com +c20ebc52 (tag: sisu_0.55.1) + +version.yml fix and changelog update +2007-07-02 ralph@amissah.com +aecab590 + +odf problem where project name not included in conf dir +2007-07-02 ralph@amissah.com +98e238d8 + +- dal, auto-numbering (minor) fix for segments/headings * cosmetic fixes, * screen output of project name * screen output when generating tex pdf * debian documents skins * html indent levels, regular and bulleted text +2007-07-02 ralph@amissah.com +7432be8d + +sisu-0.55.0, gpl3 md5s +2007-07-01 ralph@amissah.com +c2f1de99 + +rant sisu installer +2007-07-01 ralph@amissah.com +dc57a4e6 (tag: sisu_0.55.0) + +Rantfile header info +2007-07-01 ralph@amissah.com +35f42b01 + +additions, gpl text and images +2007-07-01 ralph@amissah.com +e7ae14fb + +primarily gpl3 changes, license changed, license included, images added +2007-07-01 ralph@amissah.com +074d3109 +skins cleaned a bit and output info on sisu modified, esp. in html +html no link to concordance if generated on document above word count 260k +odf url match bug fix +dal text block fix for dealing with url to be followed by
+minor cosmetic stuff + +minor cleaning of rant file +2007-06-25 ralph@amissah.com +6d4d5978 + +sisu-0.54.1 + md5s +2007-06-15 ralph.amissah@gmail.com +130aca11 + +cgi search script fix, related to highlighting matches, changelog update, rest removal of hanging whitespace +2007-06-15 ralph.amissah@gmail.com +6be61200 (tag: sisu_0.54.1) + +sisu-0.54.0 (minor additions to syntax, indent range extended) +2007-06-14 ralph.amissah@gmail.com +4c11eebf (tag: sisu_0.54.0) +- indent levels (1-9) added [previously two levels] done for plaintext, html, + xml, odf, latex/pdf [minor syntax addition (_3 - _9), version number + change] +- bullet indent levels (1-9) added [previously two levels] done for + plaintext, html, odf, latex/pdf [minor syntax addition (_3* - _9*), version + number change] +- url decoration, open close, default angle brackets +- fixes, some line-breaking for plaintext (and text groups for) odf and xml +- css, modifications for extended indents in html and xml [sisu -CC (for + update)] +- vim syntax highlighter updated to take account of extended indent range +- rant installer minor changes for future ruby +- conversion script in data/sisu/conf/convert/sisu_convert + +0.53.0, pre-build, see changelog, library naming changed for scm, placed under v0 (instead of 0.53) +2007-06-02 ralph.amissah@gmail.com +26767cc8 (tag: upstream/0.53.0, tag: sisu_0.53.0) + +restrict use to ruby1.8 branch, i.e. < 1.9 +2007-05-24 ralph.amissah@gmail.com +d1221f43 + +restrict use to ruby1.8, plus some minor housekeeping changes file exist? instead of exists? +2007-05-23 ralph.amissah@gmail.com +c94f5919 + +sisu-0.52.7 + md5s +2007-05-22 ralph.amissah@gmail.com +49840705 + +Imported upstream version 0.52.7 +2007-05-22 ralph.amissah@gmail.com +65477054 (tag: upstream/0.52.7, tag: sisu_0.52.7) diff --git a/lib/sisu/sisu_thor_lib.rb b/lib/sisu/sisu_thor_lib.rb index 3212e923..80ad6fe2 100644 --- a/lib/sisu/sisu_thor_lib.rb +++ b/lib/sisu/sisu_thor_lib.rb @@ -1,3 +1,55 @@ +# encoding: utf-8 +# - Name: SiSU +# +# - Description: documents, structuring, processing, publishing, search +# sisu build +# +# - Author: Ralph Amissah +# +# +# - Copyright: (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, +# 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2019, +# 2020, 2021, Ralph Amissah, +# All Rights Reserved. +# +# - License: GPL 3 or later: +# +# SiSU, a framework for document structuring, publishing and search +# +# Copyright (C) Ralph Amissah +# +# This program is free software: you can redistribute it and/or modify it +# under the terms of the GNU General Public License as published by the Free +# Software Foundation, either version 3 of the License, or (at your option) +# any later version. +# +# This program is distributed in the hope that it will be useful, but WITHOUT +# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for +# more details. +# +# You should have received a copy of the GNU General Public License along with +# this program. If not, see . +# +# If you have Internet connection, the latest version of the GPL should be +# available at these locations: +# +# +# +# +# +# - SiSU uses: +# - Standard SiSU markup syntax, +# - Standard SiSU meta-markup syntax, and the +# - Standard SiSU object citation numbering and system +# +# - Homepages: +# +# +# - Git +# +# +# module SiSU_Po4a_Actions require_relative 'utils_response' # utils_response.rb include SiSU_Response diff --git a/nix/pkglst/packages.nix b/nix/pkglst/packages.nix new file mode 100644 index 00000000..1c623afc --- /dev/null +++ b/nix/pkglst/packages.nix @@ -0,0 +1,13 @@ +{ pkgs ? import {} }: +with pkgs; [ + + ruby_2_7 + rubyPackages_2_7.rake + rubyPackages_2_7.sqlite3 + rubyPackages_2_7.thor + sqlite + unzip + xz + zip + #texlive-combined-full +] diff --git a/nix/pkglst/packages_rauby_2_6.nix b/nix/pkglst/packages_rauby_2_6.nix new file mode 100644 index 00000000..1c623afc --- /dev/null +++ b/nix/pkglst/packages_rauby_2_6.nix @@ -0,0 +1,13 @@ +{ pkgs ? import {} }: +with pkgs; [ + + ruby_2_7 + rubyPackages_2_7.rake + rubyPackages_2_7.sqlite3 + rubyPackages_2_7.thor + sqlite + unzip + xz + zip + #texlive-combined-full +] diff --git a/nix/pkglst/packages_rauby_2_7.nix b/nix/pkglst/packages_rauby_2_7.nix new file mode 100644 index 00000000..1c623afc --- /dev/null +++ b/nix/pkglst/packages_rauby_2_7.nix @@ -0,0 +1,13 @@ +{ pkgs ? import {} }: +with pkgs; [ + + ruby_2_7 + rubyPackages_2_7.rake + rubyPackages_2_7.sqlite3 + rubyPackages_2_7.thor + sqlite + unzip + xz + zip + #texlive-combined-full +] diff --git a/org/sisu_build.org b/org/sisu_build.org new file mode 100644 index 00000000..0380a5ee --- /dev/null +++ b/org/sisu_build.org @@ -0,0 +1,6000 @@ +-*- mode: org -*- +#+TITLE: SiSU +#+DESCRIPTION: sisu build +#+FILETAGS: :sisu:build: +#+AUTHOR: Ralph Amissah +#+EMAIL: [[mailto:ralph.amissah@gmail.com][ralph.amissah@gmail.com]] +#+COPYRIGHT: Copyright (C) 2015 - 2020 Ralph Amissah +#+LANGUAGE: en +#+STARTUP: content hideblocks hidestars noindent entitiespretty +#+OPTIONS: H:3 num:nil toc:t \n:nil @:t ::t |:t ^:nil _:nil -:t f:t *:t <:t +#+PROPERTY: header-args :exports code +#+PROPERTY: header-args+ :noweb yes +#+PROPERTY: header-args+ :eval no +#+PROPERTY: header-args+ :results no +#+PROPERTY: header-args+ :cache no +#+PROPERTY: header-args+ :padline no + +* sisu git CHANGELOG TODO +** git used TODO + +#+BEGIN_SRC sh +CHL="data/doc/sisu/CHANGELOG" +git log --pretty=format:'-_-%+s %+as %ae%+h%d%+b' --no-merges \ +| sed "/^\\s*$/d" | sed "s/^\([ ]\)*\*/\1-/" | sed "s/ \+$//" | sed "s/^-_-$//" \ +> ${CHL} +#+END_SRC + +** alt + +#+BEGIN_SRC sh +CHL="data/doc/sisu/CHANGELOG" +git log --pretty=format:"-_-_%+s %+as %ae%+h%d%+b" --no-merges \ +> ${CHL} && sed -i '/^$/d; s/^\([ ]\)*\*/\1-/; s/ \+$//; s/^-_-_//' ${CHL} +#+END_SRC + +** +considered+ + +#+BEGIN_SRC sh +LOG_0="changelog_0_" +git log --decorate --sparse --date=short --no-merges --abbrev-commit --format=medium \ +> ${LOG_0} && sed -i 's/^[ ]\+$//; /^$/d' ${LOG_0} +#+END_SRC + +#+BEGIN_SRC sh +LOG_1="changelog_1_" +git log --pretty=format:"%h %as - %s%d <%ae> %+b" --no-merges \ +> ${LOG_1} && sed -i '/^$/d; s/^\([ ]\)*\*/\1-/; s/ \+$//' ${LOG_1} +#+END_SRC + +#+BEGIN_SRC sh +LOG_2="data/doc/sisu/CHANGELOG_1_" +git log --pretty=format:"%h %ad - %s%d [%an]" --graph --date=short --no-merges > ${LOG_2} +#+END_SRC + +* sisu version TODO + +#+BEGIN_SRC ruby :tangle ../setup/sisu_version.rb +#% constants +module SiSUversion + SiSU_version = '7.2.1' +end +module Dev + GPGpubKey = '1BB4B289' +end +#+END_SRC + +* +makefile+ :makefile: + +#+BEGIN_SRC makefile :NO-tangle ../makefile +#+END_SRC + +* qi (quick install) +** bin + +#+BEGIN_SRC ruby :tangle ../qi :tangle-mode (identity #o755) :shebang #!/usr/bin/env ruby +=begin + +- Description: + +- Homepage: + +- Download: + +- Copyright: (C) 2015, 2020 Ralph Amissah + +- License: + +- Ralph Amissah + +=end +#% manual settings, edit/update as required (note current default settings are obtained from sisu version yml file) +begin + require 'thor' +rescue LoadError + puts 'thor (package ruby-thor) not found' +end +begin + require './setup/sisu_version' # ./setup/sisu_version.rb + include SiSUversion +rescue LoadError + puts 'this does not appear to be a SiSU development directory' + exit +end +require_relative 'setup/qi_libs' # setup/qi_libs.rb +require 'find' +require 'fileutils' + include FileUtils +require 'pathname' +require 'rbconfig.rb' +require 'yaml' +module SiSUconf + class Configure < Thor + class_option :verbose, :type => :boolean + desc 'setup --all --bin --lib --conf --data --alt --dryrun', + 'setup sisu' + options \ + :all => :boolean, + :bin => :boolean, + :lib => :boolean, + :conf => :boolean, + :data => :boolean, + :share => :boolean, + :man => :boolean, + :vim => :boolean, + :alt => :boolean, + :dryrun => :boolean, + :is => :boolean + def setup + unless options.length >= 1 \ + and not (options[:bin] \ + or options[:lib] \ + or options[:conf] \ + or options[:data] \ + or options[:share] \ + or options[:man] \ + or options[:vim]) + puts 'setup --all --bin --lib --conf --data --share --man --vim' + end + act=(options[:dryrun]) ? (:dryrun) : (:action) + if options[:is] + puts Version_info.version_number_info_stable + end + if not options[:alt] + if options[:all] \ + or options[:bin] + exclude_files=['sisugem'] + Install.setup_find_create( + 'bin', + Project_details.dir.bin, + exclude_files, + act + ) if File.directory?('bin') + end + if options[:all] \ + or options[:lib] + Install.setup_find_create( + 'lib', + Project_details.dir.lib, + act + ) if File.directory?('lib') + end + if options[:all] \ + or options[:conf] + Install.setup_find_create( + 'conf', + Project_details.dir.conf, + act + ) if File.directory?('conf') + end + if options[:all] \ + or options[:data] + Install.setup_find_create( + 'data', + Project_details.dir.data, + act + ) if File.directory?('data') + end + if options[:all] \ + or options[:share] + Install.setup_find_create( + 'data/sisu', + Project_details.dir.share, + act + ) if File.directory?('data/sisu') + end + if options[:all] \ + or options[:man] + Install.setup_find_create( + 'man', + Project_details.dir.man, + act + ) if File.directory?('man') + end + if options[:all] \ + or options[:vim] + Install.setup_find_create( + 'data/vim', + Project_details.dir.vim, + act + ) if File.directory?('data/vim') + end + else + if options[:all] \ + or options[:bin] + Install.setup_find_cp_r( + 'bin', + Project_details.dir.bin, + act + ) if File.directory?('bin') + end + if options[:all] \ + or options[:bin] + Install.setup_find_cp_r( + 'lib', + Project_details.dir.lib, + act + ) if File.directory?('lib') + end + if options[:all] \ + or options[:conf] + Install.setup_find_cp_r( + 'conf', + Project_details.dir.conf, + act + ) if File.directory?('conf') + end + if options[:all] \ + or options[:data] + Install.setup_find_cp_r( + 'data', + Project_details.dir.data, + act + ) if File.directory?('data') + end + if options[:all] \ + or options[:share] + Install.setup_find_cp_r( + 'data/sisu', + Project_details.dir.share, + act + ) if File.directory?('data/sisu') # + end + if options[:all] \ + or options[:man] + Install.setup_find_cp_r( + 'man', + Project_details.dir.man, + act + ) if File.directory?('man') + end + #if options[:all] \ + #or options[:vim] + # Install.setup_find_cp_r('data/vim',"#{Project_details.dir.data}/vim") \ + # if File.directory?('data/vim') + #end + end + end + desc 'pkg', + 'package maintenance tasks, ' \ + + 'of no general interest ' \ + + '(maintainer specific for package maintainer\'s convenience)' + options \ + :open_version=> :boolean, + :version_and_tag_for_release=> :boolean, + :tip => :boolean, + :is => :boolean + def pkg + if options[:is] + puts Version_info.version_number_info_stable + end + if options[:tip] + Package.sequence + end + if options[:open_version] + Version_info::Update.update_documentation + Version_info::Update.update_stable(:pre_release) + Version_info::Update.update_pkgbuild_stable(:pre_release) + Version_info::Update.changelog_header_stable_pre_release + Version_info::Update.changelog_header_commit(:pre_release) + end + if options[:version_and_tag_for_release] + Version_info::Update.update_documentation + Version_info::Update.update_stable(:release) + Version_info::Update.update_pkgbuild_stable(:release) + Version_info::Update.changelog_header_stable + Version_info::Update.changelog_header_commit_tag_upstream(:release) + end + if options.length == 0 + system("#{$called_as} help pkg") + system("#{$called_as} pkg --tip") + end + end + desc 'gem --create --build --install', + 'gem create build and install' + options \ + :create => :boolean, + :build => :boolean, + :install => :boolean, + :git_version_number => :boolean, + :is => :boolean + def gem + if options[:is] + puts Version_info.version_number_info_stable + end + if options[:create] + version=(options[:git_version_number]) \ + ? :version_git + : :version_standard + Gemspecs::Current.create_stable(version) + puts 'created gemspec' \ + if options[:verbose] + end + if options[:build] + Gemspecs::Current.build_stable + puts 'built gem' \ + if options[:verbose] + end + if options[:install] + version=(options[:git_version_number]) \ + ? :version_git + : :version_standard + Gemspecs::Current.install_stable(version) + puts 'installed gem, version: stable' \ + if options[:verbose] + end + unless options.length > 0 + system("#{$called_as} help gem") + end + end + end +end +begin + $called_as,$argv=$0,$* + SiSUconf::Configure.start(ARGV) +rescue +end +__END__ +#+END_SRC + +** qi_lib + +#+BEGIN_SRC ruby :tangle ../setup/qi_libs.rb +require_relative 'sisu_version' +module Project_details + include SiSUversion + def self.name + 'SiSU' + end + def self.summary + 'documents - structuring, publishing in multiple formats & search' + end + def self.description + 'documents - structuring, publishing in multiple formats & search' + end + def self.homepage + 'http://www.sisudoc.org' + end + def self.thor + "ruby-thor files for the installation/setup of #{name}" + end + def self.platform_notice + "[#{name} is for Linux/Unix Platforms]" + end + def self.env + RbConfig::CONFIG + end + def self.host + env['host'] + end + def self.dir + def self.proj + Project_details.name.downcase + end + def self.arch + env['archdir'] + end + def self.sitearch + env['sitearchdir'] + end + def self.bin + env['bindir'] + end + def self.lib + env['sitelibdir'] + end + def self.data + env['datadir'] + end + def self.share + "#{env['datadir']}/sisu" + end + def self.conf + env['sysconfdir'] + end + def self.man + env['mandir'] + end + def self.vim + "#{env['datadir']}/sisu/vim" + end + def self.out + "#{env['localstatedir']}/#{proj}" + end + def self.rubylib + env['LIBRUBYARG_SHARED'] + end + def self.pwd + Dir.pwd #ENV['PWD'] + end + self + end + def self.version + stamp={} + v="#{dir.pwd}/data/sisu/version.yml" + if File.exist?(v) + stamp=YAML::load(File::open(v)) + stamp[:version] + else '' + end + end + def self.system_info + ##{Project_details.platform_notice} + puts <<-WOK + Host + host: #{Project_details.host} + arch: #{Project_details.dir.arch} + sitearch: #{Project_details.dir.sitearch} + Directories for installation + bin: #{Project_details.dir.bin} + lib (site-ruby): #{Project_details.dir.lib}/#{Project_details.dir.proj}/v* + conf [etc]: #{Project_details.dir.conf}/#{Project_details.dir.proj} + data (odf, shared images): #{Project_details.dir.share} + vim (vim syntax, highlighting, ftplugin): #{Project_details.dir.data}/sisu/vim + data (README, version_manifest): #{Project_details.dir.data}/doc/#{Project_details.dir.proj} + man (manual pages): #{Project_details.dir.man} + output: #{Project_details.dir.out} + processing: #{Project_details.dir.out}/processing + www: #{Project_details.dir.out}/www + rubylib: #{Project_details.dir.rubylib} + + WOK + end + def self.gem_env + system("gem env") + end +end +module Utils + def self.answer?(ask) + resp='redo' + print ask + " ['yes', 'no' or 'quit']: " + resp=File.new('/dev/tty').gets.strip #resp=gets.strip + if resp == 'yes' then true + elsif resp == 'no' then false + elsif resp =~/^quit|exit$/ then exit + else puts "[please type: 'yes', 'no' or 'quit']" + answer?(ask) + end + end + def self.default_notice # local help not implemented description incorrect + ans= %{#{Project_details.thor} + Information on alternative actions is available using: + [if ruby-thor is installed:] + "#{$called_as} help") + Default action selected - "install #{Project_details.name}" proceed? } + resp=answer?(ans) + exit unless resp + end + def self.chmod_file(place) + if place =~/\/bin/; File.chmod(0755,place) + else File.chmod(0644,place) + end + end + def self.chmod_util(place) + if place =~/\/bin/; chmod(0755,place) + else chmod(0644,place) + end + end + def self.system_date + `date "+%Y-%m-%d"`.strip + end + def self.system_date_stamp + `date "+%Yw%W/%u"`.strip + end + def self.program_found?(prog) + found=`which #{prog}` #`whereis #{make}` + (found =~/bin\/#{prog}\b/) ? :true : :false + end +end +module Install + #%% using a directory and its mapping + def self.setup_find_create(dir_get,dir_put,exclude_files=['\*'],act) #primary, + begin + Find.find("#{Project_details.dir.pwd}/#{dir_get}") do |f| + stub=f.scan(/#{Project_details.dir.pwd}\/#{dir_get}\/(\S+)/).join + place="#{dir_put}/#{stub}" + action=case + when File.file?(f) + unless f =~/#{exclude_files.join("|")}/ + unless act==:dryrun + cp(f,place) + Utils.chmod_file(place) + end + "-> #{dir_put}/" + end + when File.directory?(f) + if not FileTest.directory?(place) \ + and not act==:dryrun + FileUtils.mkpath(place) + end + "./#{dir_get}/" + else '?' + end + puts "#{action}#{stub}" + end + rescue + puts "\n\n[ are you root? required for install ]" + end + end + def self.setup_find_cp_r(dir_get,dir_put,act) #secondary, using recursive copy + begin + Find.find("#{Project_details.dir.pwd}/#{dir_get}") do |f| + stub=f.scan(/#{Project_details.dir.pwd}\/#{dir_get}\/(\S+)/).join + place="#{dir_put}/#{stub}" + case + when File.file?(f) + unless act==:dryrun + cp_r(f,place) + Utils.chmod_util(place) + else + puts "--> #{place}" + end + when File.directory?(f) + unless FileTest.directory?(place) + unless act==:dryrun + mkdir(place) + else + puts "mkdir -p #{place}" + end + end + end + end + rescue + puts "\n\n[ are you root? required for install ]" + end + end +end +module Version_info + def self.contents(vi,rel=:release) + release=rel ==:pre_release \ + ? '_pre_rel' + : '' + <<-WOK +--- +:project: #{vi[:project]} +:version: #{vi[:version]}#{release} +:date_stamp: #{vi[:date_stamp]} +:date: "#{vi[:date]}" + WOK + end + def self.git_version_extract + if FileTest.file?('/usr/bin/git') + x=`git describe --long --tags 2>&1`.strip. + gsub(/^[a-z_-]*([0-9.]+)/,'\1'). + gsub(/([^-]*-g)/,'r\1'). + gsub(/-/,'.') + x=(x=~/^[0-9]+\.[0-9]+\.[0-9]+\.r[0-9]+\.g[0-9a-f]{7}/) \ + ? x + : nil + else nil + end + end + def self.version_number(vi) + vi[:version] + end + def self.version_number_use(vi) + (git_version_extract.nil?) \ + ? (vi[:version]) + : git_version_extract + end + def self.version_number_info(vi) + (Version_info.version_number_use(vi) != vi[:version_number]) \ + ? (%{#{vi[:version_number]} from git #{Version_info.version_number_use(vi)}}) + : vi[:version_number] + end + def self.version_number_info_stable + vi=Version_info::Current.setting_stable + (Version_info.version_number_use(vi) != vi[:version_number]) \ + ? (%{#{vi[:version_number]} from git #{Version_info.version_number_use(vi)}}) + : vi[:version_number] + end + module Current + def self.yml_file_path + 'data/sisu/version.yml' + end + def self.settings(file) + v="#{Dir.pwd}/#{file}" + if File.exist?(v) + YAML::load(File::open(v)) + else '' + end + end + def self.changelog_file_stable + 'data/doc/sisu/CHANGELOG_v7' + end + def self.file_stable + yml_file_path + end + def self.setting_stable + hsh=settings(file_stable) + hsh[:version_number]=/([0-9]+\.[0-9]+\.[0-9]+)/. + match(hsh[:version])[1] + hsh + end + def self.version_number + Version_info::Current.setting_stable[:version_number] + end + def self.content_stable + Version_info.contents(setting_stable) + end + end + module Next + def self.settings(v) + { + project: "#{Project_details.name}", + version: "#{v}", + date: "#{Utils.system_date}", + date_stamp: "#{Utils.system_date_stamp}", + } + end + def self.setting_stable + settings(SiSU_version) + end + def self.content_stable(rel) + Version_info.contents(setting_stable,rel) + end + end + module Update + def self.version_number(vi) + /([0-9]+\.[0-9]+\.[0-9]+)/.match(vi[:version])[1] + end + def self.version_number_stable + vi=Version_info::Current.setting_stable + /([0-9]+\.[0-9]+\.[0-9]+)/.match(vi[:version])[1] + end + def self.version_info_update_commit(filename,vi_hash_current,vi_content_current,vi_hash_next,vi_content_next) + ans=%{update #{Project_details.name.downcase} version info replacing: + #{vi_hash_current.sort} +with: + #{vi_hash_next.sort} + +#{vi_content_current} +becoming: +#{vi_content_next} +proceed? } + resp=Utils.answer?(ans) + if resp + fn="#{Dir.pwd}/#{filename}" + if File.writable?("#{Dir.pwd}/.") + file_version=File.new(fn,'w+') + file_version << vi_content_next + file_version.close + else + puts %{*WARN* is the file or directory writable? could not create #{filename}} + end + end + end + def self.update_documentation + fn="#{Dir.pwd}/data/doc/sisu/markup-samples/manual/_sisu/sisu_document_make" + if File.file?(fn) \ + and File.writable?(fn) + ver_no_stable=Version_info::Current.setting_stable[:version_number] + debian_stable='Jessie' + debian_testing='Stretch' + sisu_doc_make = IO.readlines(fn) + sisu_doc_make_next=sisu_doc_make.each.map do |line| + line=line.gsub(/(\/$\{sisu_stable\}\/,)'[0-9]+\.[0-9]+\.[0-9]+'/,"\\1'#{ver_no_stable}'"). + gsub(/(\/$\{debian_stable\}\/,)'\*\{[A-Z][a-z]+\}\*'/, + "\\1'*{#{debian_stable}}*'"). + gsub(/(\/$\{debian_testing\}\/,)'\*\{[A-Z][a-z]+\}\*'/, + "\\1'*{#{debian_testing}}*'") + line + end + if sisu_doc_make_next.length == sisu_doc_make.length + sisu_doc_make_file=File.new(fn,'w+') + sisu_doc_make_next.flatten.each do |line| + sisu_doc_make_file << line + end + sisu_doc_make_file.close + else puts "expected changelog arrays to have same length, in: #{pkgbuild.length}, out: #{pkgbuild_next.length}" + end + end + end + def self.update_stable(rel=:release) + version_info_update_commit( + Version_info::Current.file_stable, + Version_info::Current.setting_stable, + Version_info::Current.content_stable, + Version_info::Next.setting_stable, + Version_info::Next.content_stable(rel), + ) + end + def self.update_pkgbuild_stable(rel=:release) + vn=version_number_stable + ans=%{update PKGBUILD version info: +pkgver=#{vn} + +proceed? } + resp=Utils.answer?(ans) + if resp + filename='PKGBUILD_tar_xz' + fn="#{Dir.pwd}/setup/#{filename}" + if File.writable?(fn) + pkgbuild = IO.readlines(fn) + pkgbuild_next=pkgbuild.each.map do |line| + if line =~/^\s*pkgver=/ + line=line.gsub(/^\s*(pkgver=)[0-9.]+/,"\\1#{vn}") + else line + end + end + if pkgbuild.length == pkgbuild_next.length + pkgbuild_file=File.new(fn,'w+') + pkgbuild_next.flatten.each do |line| + pkgbuild_file << line + end + pkgbuild_file.close + else puts "expected changelog arrays to have same length, in: #{pkgbuild.length}, out: #{pkgbuild_next.length}" + end + end + end + end + def self.changelog_header(vi) + vn=version_number(vi) + <<-WOK +- sisu_#{vn}.orig.tar.xz (#{vi[:date]}:#{vi[:date_stamp].gsub(/20\d\dw/,'')}) + http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/sisu_#{vn} + WOK + end + def self.changelog_header_release(filename,ch,vi) + ans=%{update #{Project_details.name.downcase} changelog header, open version: + + #{ch} +proceed? } + resp=Utils.answer?(ans) + if resp + fn="#{Dir.pwd}/#{filename}" + if File.writable?(fn) + changelog_arr_current = IO.readlines(fn) + changelog_arr_next=changelog_arr_current.each.map do |line| + if line =~/^\*\s+sisu_[0-9]+\.[0-9]+\.[0-9]+(?:_pre_rel)?\.orig\.tar\.xz \(Open commit window: [0-9]{4}-[0-9]{2}-[0-9]{2}; Pre-Release\)$/ + "* sisu_#{vi[:version]}.orig.tar.xz " \ + + "(#{vi[:date]}:#{vi[:date_stamp].gsub(/20\d\dw/,'')})\n" + else line + end + end + if changelog_arr_current.length == changelog_arr_next.length + changelog_file=File.new(fn,'w+') + changelog_arr_next.flatten.each do |line| + changelog_file << line + end + changelog_file.close + else puts "expected changelog arrays to have same length, in: #{changelog_arr_current.length}, out: #{changelog_arr_next.length}" + end + else + puts %{*WARN* is the file or directory writable? could not create #{filename}} + end + end + end + def self.changelog_header_stable_filename + Version_info::Current.changelog_file_stable + end + def self.changelog_header_stable + ch=changelog_header(Version_info::Current.setting_stable) + changelog_header_release( + changelog_header_stable_filename, + ch, + Version_info::Current.setting_stable + ) + end + def self.changelog_header_pre_release(vi) + vn=version_number(vi) + <<-WOK +- sisu_#{vn}.orig.tar.xz (Open commit window: #{vi[:date]}; Pre-Release) + http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/sisu_#{vn} + WOK + end + def self.changelog_header_pre_release_write(filename,ch) + ans=%{update #{Project_details.name.downcase} changelog header, open version: + + #{ch} +proceed? } + resp=Utils.answer?(ans) + if resp + fn="#{Dir.pwd}/#{filename}" + if File.writable?(fn) + changelog_arr_current = IO.readlines(fn) + changelog_arr_next=changelog_arr_current.each.map do |line| + if line =~/^--- HEAD ---$/ + line << ("\n" + ch) + else line + end + end + if changelog_arr_current.length == changelog_arr_next.length + changelog_file=File.new(fn,'w+') + changelog_arr_next.flatten.each do |line| + changelog_file << line + end + changelog_file.close + else puts "expected changelog arrays to have same length, in: #{changelog_arr_current.length}, out: #{changelog_arr_next.length}" + end + else + puts %{*WARN* is the file or directory writable? could not create #{filename}} + end + end + end + def self.changelog_header_stable_pre_release + ch=changelog_header_pre_release(Version_info::Current.setting_stable) + changelog_header_pre_release_write(changelog_header_stable_filename,ch) + end + def self.commit_changelog(rel=:release,msg) + system(%{ + git commit -a -m"#{msg}" + git commit --amend + }) + end + def self.tag_upstream + system(%{ + git tag -af sisu_#{SiSU_version} -m"SiSU #{SiSU_version}" + }) + end + def self.changelog_header_commit(rel=:release) + msg=(rel == :pre_release) \ + ? "version & changelog, open commit window" + : "version & changelog, tag for release" + ans=%{commit #{msg}:\n\nproceed? } + resp=Utils.answer?(ans) + if resp + commit_changelog(rel,msg) + end + end + def self.changelog_header_commit_tag_upstream(rel=:release) + msg=(rel == :pre_release) \ + ? "version & changelog, open commit window" + : "version & changelog, tag for release" + ans=%{commit #{msg}:\n\nproceed? } + resp=Utils.answer?(ans) + if resp + commit_changelog(rel,msg) + tag_upstream + end + end + end + self +end +module GitExtractTaggedVersionBuild + def upstream + system(%{ git checkout upstream }) + end + def self.git_tagged_versions(tag=nil) + if tag + v=if tag =~/sisu_[0-9](?:\.[0-9]){0,2}$/ then tag + elsif tag =~/^[0-9](?:\.[0-9]){0,2}$/ then 'sisu_' + tag + else 'sisu_' + end + system(%{ git tag -l | ag --nocolor '^#{v}' }) + end + end + def self.git_checkout_and_build_and_install_version(tag,options) + begin + ver=if tag =~/sisu_[0-9]\.[0-9]+\.[0-9]+/ then tag + elsif tag =~/^[0-9]\.[0-9]+\.[0-9]+/ then 'sisu_' + tag + else branch + end + create=options[:create] ? '--create ' : '' + build=options[:build] ? '--build ' : '' + install=options[:install] ? '--install ' : '' + commands =<<-WOK + git checkout #{ver} && + #{$called_as} gem #{ver} #{create}#{build}#{install}; + WOK + puts commands + begin + system(commands) + rescue + end + rescue + ensure + system(%{ + git checkout upstream + }) + end + end +end +module Gemspecs + def self.info(vi) + puts <<-WOK +-- +name: #{vi[:project].downcase} +version: #{vi[:version_number]} +date: #{vi[:date]} +summary: #{vi[:project]} + WOK + end + def self.contents(vi) + <<-WOK +Gem::Specification.new do |s| + s.name = '#{vi[:project].downcase}' + s.version = '#{vi[:version_number]}' + s.date = '#{vi[:date]}' + s.summary = '#{Project_details.summary} (linux calls)' + s.description = '#{Project_details.description} [#{Version_info.version_number_info(vi)}] (linux calls & without external dependencies)' + s.homepage = '#{Project_details.homepage}' + s.authors = ["Ralph Amissah"] + s.email = 'ralph.amissah@gmail.com' + s.license = 'GPL-3.0-or-later' + s.files = Dir['lib/#{Project_details.name.downcase}.rb'] + + Dir['lib/#{Project_details.name.downcase}/*.rb'] + + Dir['data/#{Project_details.name.downcase}/version.yml'] + + Dir['data/#{Project_details.name.downcase}/image/*'] + + Dir['bin/#{Project_details.name.downcase}gem'] + + Dir['bin/#{Project_details.name.downcase}'] + s.executables << '#{Project_details.name.downcase}gem' << '#{Project_details.name.downcase}' + s.has_rdoc = false +end + WOK + end + def self.contents_git(vi) + <<-WOK +Gem::Specification.new do |s| + s.name = '#{vi[:project].downcase}' + s.version = '#{Version_info.version_number_use(vi)}' + s.date = '#{vi[:date]}' + s.summary = '#{Project_details.summary} (linux calls)' + s.description = '#{Project_details.description} [#{Version_info.version_number_info(vi)}] (linux calls & without external dependencies)' + s.homepage = '#{Project_details.homepage}' + s.authors = ["Ralph Amissah"] + s.email = 'ralph.amissah@gmail.com' + s.license = 'GPL-3.0-or-later' + s.files = `git ls-files -z lib`.split("\x0") + + Dir['data/#{Project_details.name.downcase}/version.yml'] + + Dir['data/#{Project_details.name.downcase}/image/*'] + + Dir['bin/#{Project_details.name.downcase}gem'] + + Dir['bin/#{Project_details.name.downcase}'] + s.executables << '#{Project_details.name.downcase}gem' << '#{Project_details.name.downcase}' + s.has_rdoc = false +end + WOK + end + def self.create(filename,gemspec) + fn="#{Dir.pwd}/#{filename}.gemspec" + if File.writable?("#{Dir.pwd}/.") + file_sisu_gemspec=File.new(fn,'w+') + file_sisu_gemspec << gemspec + file_sisu_gemspec.close + else + puts %{*WARN* is the file or directory writable? could not create #{filename}} + end + end + def self.build(fn) + system(%{ gem build #{fn}.gemspec }) + end + def self.install(vn) + system(%{ + sudo gem install --local --no-document --verbose sisu-#{vn}.gem + }) + end + module Current + def self.filename + Project_details.name.downcase + end + def self.filename_stable + Project_details.name.downcase \ + + '-' \ + + Version_info::Current.setting_stable[:version_number] + end + def self.info_stable + Gemspecs.info(Version_info::Current.setting_stable) + end + def self.current_stable + Gemspecs.contents( + Version_info::Current.setting_stable, + ) + end + def self.current_git_version + Gemspecs.contents_git( + Version_info::Current.setting_stable, + ) + end + def self.create_stable(version=:version_standard) + (version==:version_git) \ + ? (Gemspecs.create(filename,current_git_version)) + : (Gemspecs.create(filename,current_stable)) + end + def self.build_stable + Gemspecs.build(filename) + end + def self.install_stable(version=:version_standard) + vi=Version_info::Current.setting_stable + vn=((version==:version_git) \ + && (Version_info.version_number_use(vi) != vi[:version_number])) \ + ? (Version_info.version_number_use(vi)) + : (vi[:version_number]) + Gemspecs.install(vn) + end + end +end +module Package + def self.sequence + puts <<-WOK + --open-version # update package version + --version-and-tag-for-release # git tags upstream version + # not included: + # --merge # git merge upstream tag into debian/sid + # --dch # dch create and edit + # --dch-commit # dch commit + # --build # git-buildpackage + # --git_push # git push changes + # --dput # dput package + # --reprepro_update # reprepro update + # --reprepro_push # reprepro rsync changes + WOK + end +end +__END__ +#+END_SRC + +* sisu thor lib + +#+BEGIN_SRC ruby :tangle ../lib/sisu/sisu_thor_lib.rb +# <> +module SiSU_Po4a_Actions + require_relative 'utils_response' # utils_response.rb + include SiSU_Response + @@source=@@targets=nil + def project_details + def name + 'SiSU translations under po4a management' + end + def name_warning + <<-WOK +#{name} + +WARNING all sisu markup files (.ssm, .sst, .ssi) in languages other than #{language.source_language_selected} +are managed by po4a, through translations of the source language to other languages. + +#{language.info_on_selection} + WOK + end + def setup_project + "Setup file for placing #{name}" + end + self + end + def notice + def warn_and_proceed? + '*WARNING* this software module creates, destroys, overwrites directories' + "\n" \ + + '*WARNING*: Use this Software at your own risk!' + end + def default(selection=nil) + selections=:strict #selections=:short + ans=if selection + case selection + when selection.is_a?(String) + selections=:strict + <<-WOK + #{project_details.setup_project} + Default action selected - "#{selection} #{project_details.name}" +#{warn_and_proceed?} + WOK + when :make + selections=:strict + <<-WOK + #{project_details.setup_project} + "--#{selection}" selected - #{selection} #{project_details.name} + selected (or configured) languages to be used + source language: #{language.source_language_available_str} + target languages: #{language.translation_languages_selected_that_are_available.inspect} + + WARNING: this action assumes (and places) this project is under po4a + (translation) management. It will create sub-directories for the + selected (or configured) target languages: + #{language.translation_languages_selected_that_are_available.inspect} + & the po4a configuration file: #{filename.po4a_cfg} + in the current directory: + #{Dir.pwd} + It will populate the sub-directories with translation files created from + the pot and po files found under the corresponding language + sub-directories, (under #{dir.pot}/ & #{dir.po}/). + (OVERWRITING any existing translated .ssm .sst .ssi files + in language subdirectories that are not under po4a management). + + You should backup the current directory: + #{Dir.pwd} + +#{warn_and_proceed?} + WOK + when :clean + selections=:strict + <<-WOK + #{project_details.setup_project} + "--#{selection}" selected - #{selection} #{project_details.name} +#{warn_and_proceed?} + WOK + when :distclean + selections=:strict + <<-WOK + #{project_details.setup_project} + "--#{selection}" selected - #{selection} #{project_details.name} + WARNING: this action assumes (and places) this project is under po4a + (translation) management. It will remove the sub-directories (if they exist): + #{language.possible_translations.inspect} + + #{language.translation_languages_selected_that_are_available.inspect} + & file: #{filename.po4a_cfg} + in the current directory: + #{Dir.pwd} + Note: these sub-directories & the config file #{filename.po4a_cfg} + should be auto-generated from pot and po files if this project translation + is under po4a management. + This query is to give you the chance to make sure you know what you are doing. +#{warn_and_proceed?} + WOK + when :rebuild + selections=:strict + <<-WOK + #{project_details.setup_project} + "--#{selection}" selected - #{selection} #{project_details.name} + WARNING: this action assumes (and places) this project is under po4a + (translation) management. It will destroy/clobber and then create again the + sub-directories: + #{language.translation_languages_selected_that_are_available.inspect} + populating them with translation files created from the pot and po files + found under the corresponding language sub-directories in (#{dir.pot}/ + & #{dir.po}/). + It will also generate the file: #{filename.po4a_cfg} + These actions will be taken in the current directory: + #{Dir.pwd} + This query is to give you the chance to make sure you know what you are doing. +#{warn_and_proceed?} + WOK + else + selections=:strict + <<-WOK + #{project_details.setup_project} + Default action selected - "#{selection} #{project_details.name}" +#{warn_and_proceed?} + WOK + end + else + selections=:strict + <<-WOK + #{project_details.setup_project} + Default action selected - "install and to setup #{project_details.name}" +#{warn_and_proceed?} + WOK + end + exit unless query.answer?(ans) + end + def project_help + puts <<-WOK +#{project_details.name} +#{project_details.setup_project} + +This setup file is primarily to assist with having sisu markup files under po4a +translation management. It assumes that the source language files are placed +under the sub-directory identifying the source language set, which is currently +#{language.source_language_selected} +The files there are used to make the source translation file in the directory #{dir.pot}/ +Which is then used to create files for translation under the directory #{dir.po}/ +in sub-directories bearing the translation languages ISO code. + +The current language translation selection is: #{translation_languages_selected_str} +The languages selected are located in the file: #{filename.languages_src_tgt} + +sisu available language list: #{sisu_languages_available_str} + + WOK + end + self + end + def generate + def readme + system(%{ruby ../../../../../bin/sisu6 --txt -v --no-manifest --dump='../../../../../..' en/README.ssm}) + end + def manpage + system(%{ruby ../../../../../bin/sisu6 --manpage -v --no-manifest --dump='../../../../../../man/man1' en/sisu.ssm}) + end + self + end + def filename + def languages_src_tgt + #'translation_languages' + 'languages_source_and_targets' + end + def po4a_cfg + 'po4a.cfg' + end + self + end + def dir + def pwd + Dir.pwd + end + def po4a_ + 'po4a/' # '' + end + def pot + po4a_ + 'pot' + end + def po + po4a_ + 'po' + end + self + end + def dir_mk(dir) + FileUtils::mkdir_p(dir) unless FileTest.directory?(dir) + end + def po4a_flags + def debug + '-d -v' + end + def normal + '' + end + def quiet + '-q' + end + self + end + def languages_from_file + def language_source + if @@source.is_a?(String) \ + and @@source =~ /w{2,4}/ + else languages_extract_from_file + end + @@source + end + def language_targets + if @@targets.is_a?(Array) \ + and @@targets.length > 0 + else languages_extract_from_file + end + @@targets + end + def languages_extract_from_file + if (@@source.is_a?(String) \ + and @@source =~/\w{2,4}/) \ + and (@@targets.is_a?(Array) \ + and @@targets.length > 0) + else + if FileTest.file?(filename.languages_src_tgt) + puts 'file: "' + filename.languages_src_tgt + '" found and used (unless overridden)' + langs=IO.read(filename.languages_src_tgt, mode: 'r:utf-8').scan(/source:\s+\w+|target:\s+\w.+/) + langs.each do |sel| + case sel + when /source:/ + source=sel.split(/source:\s*|\s+/).join + source=(source =~/\w{2,4}/) ? source : nil + @@source=unless @@source.is_a?(String) \ + and @@source =~/\w{2,4}/ + source + else @@source + end + when /target:/ + @@targets=unless @@targets.is_a?(Array) + sel.split(/targets?:\s*|\s+/) - [''] + else @@targets + end + end + end + else + puts %{(create) missing instruction file: "#{filename.languages_src_tgt}"\n contents e.g.:\n source: en\n target: de fr es ja ru zh\n no po target languages found} + exit + end + end + end + self + end + def language + def source_language_selected(src=nil) + @@source=if not @@source.nil? \ + and @@source.is_a?(String) \ + and @@source =~/\w{2,4}/ + @@source + elsif (src \ + && src.is_a?(String) \ + && src.length > 1) + src + else + src=languages_from_file.language_source + end + end + def translation_languages_selected(targets=nil) #translation_languages + @@targets=if not @@targets.nil? \ + and @@targets.is_a?(Array) \ + and @@targets.length > 0 + @@targets + elsif (targets \ + && targets.is_a?(Array) \ + && targets.length > 0) + targets + else + targets=languages_from_file.language_targets + end + end + def source_language_available + [source_language_selected] & sisu_languages_available + end + def translation_languages_selected_that_are_available + translation_languages_selected & sisu_languages_available + end + def info_on_selection + if translation_languages_selected != translation_languages_selected_that_are_available + <<-WOK +WARNING: language selections mismatch + +The current language translation selection appears to be: #{translation_languages_selected_str} +Of which the following are valid (available) selections: #{translation_languages_selected_that_are_available_str} + +sisu available language list: #{sisu_languages_available_str} + +the following will be used: #{translation_languages_selected_that_are_available_str} +The languages selected are located in the file: #{filename.languages_src_tgt} + WOK + else + <<-WOK +The current language translation selection is: #{translation_languages_selected_str} +The languages selected are located in the file: #{filename.languages_src_tgt} + +sisu available language list: #{sisu_languages_available_str} + WOK + end + end + def sisu_languages_available + $SiSU_Language_Codes.language_list.codes + end + def possible_translations + sisu_languages_available - [source_language_selected] + end + def translation_languages_selected_str + language.translation_languages_selected.join(' ') + end + def source_language_available_str + source_language_available.join + end + def translation_languages_selected_that_are_available_str + language.translation_languages_selected_that_are_available.join(' ') + end + def sisu_languages_available_str + language.sisu_languages_available.join(' ') + end + def posible_translations_str + language.posible_translations.join(' ') + end + self + end + def files_src + def ssm + Dir.glob("#{language.source_language_selected}/*.ssm").sort + end + def sst + Dir.glob("#{language.source_language_selected}/*.sst").sort + end + def ssi + Dir.glob("#{language.source_language_selected}/*.ssi").sort + end + def all + Dir.glob("#{language.source_language_selected}/*{.ssm,.sst,.ssi}").sort + end + self + end + def po4a_cfg_file + File.open("#{Dir.pwd}/#{filename.po4a_cfg}",'w') + end + def po4a_create + def configure #po4a_cfg + po4a_cfg_arr=[] + po4a_cfg_arr \ + << "[po4a_langs] #{language.translation_languages_selected_that_are_available_str}" + po4a_cfg_arr \ + << "[po4a_paths] #{dir.pot}/$master.pot $lang:#{dir.po}/$lang/$master.po" + files_src.ssm.each do |file_src| + file_src_fn=file_src.gsub(/#{language.source_language_selected}\//,'') + po4a_cfg_arr \ + << "[type: text] #{file_src} $lang:$lang/#{file_src_fn}" + end + files_src.sst.each do |file_src| + file_src_fn=file_src.gsub(/#{language.source_language_selected}\//,'') + po4a_cfg_arr \ + << "[type: text] #{file_src} $lang:$lang/#{file_src_fn}" + end + files_src.ssi.each do |file_src| + file_src_fn=file_src.gsub(/#{language.source_language_selected}\//,'') + po4a_cfg_arr \ + << "[type: text] #{file_src} $lang:$lang/#{file_src_fn}" + end + file=po4a_cfg_file + po4a_cfg_arr.each do |txt| + puts txt + file << txt << "\n" + end + file.close + cmd='po4a --keep 0 ' \ + + po4a_flags.normal + ' ' \ + + filename.po4a_cfg + #cmd='po4a --keep 0 --no-backups --package-name ' \ + ,#+ 'sisu-manual' + ' ' \ + ,#+ po4a_flags.normal + ' ' \ + ,#+ filename.po4a_cfg + system(cmd); puts cmd + end + self + end + def project + def make + dir_mk(dir.pot) + language.translation_languages_selected_that_are_available.each do |lang_dir| + dir_lang="#{Dir.pwd}/#{dir.po}/#{lang_dir}" + dir_mk(dir_lang) + end + po4a_create.configure + end + def clean + #rm -f po/*/*.po~ + #rm -rf ../build + FileUtils.rm_f Dir.glob("./#{dir.po}/*/*.po~") + end + def distclean + #rm -f po4a.cfg + #rm -rf $(LANGUAGES) + FileUtils::rm_f(filename.po4a_cfg) + FileUtils::rm_r(language.possible_translations,:force => true) + end + self + end +end +__END__ +#+END_SRC + +* Rake & Rant +** Rake & Rant + +#+BEGIN_SRC ruby :tangle ../setup/rbuild :tangle-mode (identity #o755) :shebang #!/usr/bin/env ruby +=begin + Common Rakefile, Rantfile installer for SiSU + softlink Rakefile and Rantfile to this file + + - Homepage: + - Download: + + Copyright (C) 2007 Ralph Amissah + + - License: LGPL - GNU Lesser General Public License + [same license as Rant provided within the Rant package] + + - Ralph Amissah + + Rake is a Ruby build program by Jim Weirich + - Rake may be downloaded and installed from: + + + Rant is a Ruby build program by Stefan Lang + - Rant may be downloaded and installed from: + + + Notes on use: + [if rake is preferred and installed] + rake -T + [if rant is preferred and installed] + rant -T + + SiSU can also be Setup/Installation using: + * Minero Aoki's setup.rb, provided along with SiSU, or + +=end +#%% produce a makefile suitable for the target platform +#require 'mkmf' +#create_makefile("sisu") +#% manual settings, edit/update as required (note current default settings are obtained from sisu version yml file) +require 'find' +require 'fileutils' +#require 'ftools' +require 'rbconfig.rb' +require 'yaml' +include FileUtils +require_relative 'sisu_version' # sisu_version.rb + include SiSUversion +require_relative 'rbuild_libs' # rbuild_libs.rb + include Project_details + include Utils + include Version_info + include Gemspecs + include GitExtractTaggedVersionBuild +require_relative 'rbuild_help' # rbuild_help.rb + include Help +#% tasks +desc "show rake/rant tasks for sisu install, and sisu gem (create spec, build &) install" +task :default => + [:note_sources,:tasks,:note_installation] #[:default_notice,:setup_base] +desc "Setup/Install #{Project_details.name}" +task :setup_project=> + [:setup_bin_,:setup_lib_,:setup_conf_,:setup_share_,:setup_data_,:setup_man_,:setup_vim_,:src_note] +task :project=> \ + [:setup_project] +desc "Setup/Install #{Project_details.name}" +task :setup=> + [:setup_bin_, :setup_lib_,:setup_conf_,:setup_share_,:setup_data_] #, :help] +desc "Setup/Install #{Project_details.name}: bin, lib and conf (no data)" +task :setup_base=> + [:setup_bin_,:setup_lib_,:setup_conf_,:setup_share_,:setup_man_,:setup_vim_,:note_sources] +task :base=> + [:setup_base] +desc "Setup/Install #{Project_details.name}: bin, lib, conf & data" +task :setup_with_data=> + [:setup_base,:setup_data] +desc "check package version" +task :sisuversion => + [:sisu_version] +task :version => + [:sisu_version] +#desc "set package version" +task :sisuversionset => + [:sisu_version_set,:changelog_headers] +desc "check gemspec info" +task :gem_spec => + [:gemspec_info] +desc "create sisu v_stable gemspec" +task :gem_create_spec_stable => + [:gemspecs_stable_create_default_version] +task :gem5cs => + [:gem_create_spec_stable] +task :gem5createspecs => + [:gemspecs_stable_create_default_version] +desc "create gemspec" +task :gem_create_spec => + [:gemspecs_create_default_version] +task :gem_create => + [:gemspecs_create_default_version] +task :gemc => + [:gemspecs_create_default_version] +#--- +desc "build gem" +task :gem_build => + [:gem_build_] +task :gemb => + [:gem_build] +task :gembuild => + [:gem_build] +desc "build sisu v_stable gem" +task :gem_build_stable => + [:gem_stable_build] +task :gem5b => + [:gem_build_stable] +task :gem5build => + [:gem_build_stable] +#--- +desc "create, build & install sisu v_stable gem" + task :gem_create_build_install_stable => + [:gemspecs_stable_create_default_version,:gem_stable_build,:gem_stable_install] +task :gem5cbi => + [:gem_create_build_install_stable] +desc "create, build & install sisu gem" +task :gem_create_build_install => + [:gemspecs_create_default_version,:gem_build_,:gem_install_] +task :gemcbi => + [:gem_create_build_install] +#--- +desc "install gem" +task :gem_install => + [:gem_install_] +task :gemi => + [:gem_install] +task :geminstall => + [:gem_install] +desc "build & install sisu v_stable gem" +task :gem_build_install_stable => + [:gem_stable_build,:gem_install_] +task :gem5bi => + [:gem_build_install_stable] +desc "build & install gem" +task :gem_build_install => + [:gem_build,:gem_install_] +task :gembi => + [:gem_build_install] +#-- manually set next version +#desc "create sisu v_stable gemspec, manually set next version" +task :gem5csn => + [:gemspecs_stable_create_next_version] +#desc "create gemspec, manually set next version" +task :gemcsn => + [:gemspecs_create_next_version] +task :gemcn => + [:gemspecs_create_next_version] +#desc "build gem, manually set next version" +task :gembn => + [:gem_build_next_version] +#desc "build sisu v_stable gem, manually set next version" +task :gem5bn => + [:gem_stable_build_next_version] +#desc "install gem, manually set next version" +task :gemin => + [:gem_install_next_version] +#desc "build & install sisu v_stable gem, manually set next version" +task :gem5bin => + [:gem_stable_build_next_version,:gem_install_next_version] +#desc "build & install gem, manually set next version" +task :gembin => + [:gem_build_next_version,:gem_install_next_version] +#desc "create, build & install sisu v_stable gem, manually set next version" +task :gem5cbin => + [:gemspecs_stable_create_next_version,:gem_stable_build_next_version,:gem_stable_install_next_version] +#desc "create, build & install sisu gem, manually set next version" +task :gemcbin => + [:gemspecs_create_next_version,:gem_build_next_version,:gem_install_next_version] +#--- +#desc "check changelog headers" +task :changelogheaders => + [:changelog_headers] +task :dev => + [:note_developer] +task :developer_note => + [:note_developer] +if File.directory?('bin') + desc "Setup #{Project_details.name} bin only, synonym :bin" + task :setup_bin => + [:setup_bin_] + task :bin => + [:setup_bin] +end +if File.directory?('lib') + desc "Setup #{Project_details.name} lib only, synonym :lib" + task :setup_lib => + [:setup_lib_] + task :lib => + [:setup_lib] +end +if File.directory?('conf') + desc "Setup #{Project_details.name} conf only, synonyms :conf & :etc" + task :setup_conf => + [:setup_conf_] + task :conf => + [:setup_conf] + task :setup_etc => + [:setup_conf] + task :etc => + [:setup_conf] +end +if File.directory?('data') + desc "Setup #{Project_details.name} data only, synonyms :data & :examples" + task :setup_data => + [:setup_data_] + task :data => + [:setup_data] + task :setup_examples => + [:setup_data] + task :examples => + [:setup_data] +end +if File.directory?('data/sisu') + #desc "Setup #{Project_details.name} shared data only (odf & shared images)" + task :setup_share => + [:setup_share_] + task :share => + [:setup_share] +end +if File.directory?('man') + desc "Setup #{Project_details.name} man pages only, synonyms :man" + task :setup_man => + [:setup_man_] + task :man => + [:setup_man] +end +if File.directory?('data/vim') + desc "Setup #{Project_details.name} vim config files only, synonyms :vim" + task :setup_vim => + [:setup_vim_] + task :vim => + [:setup_vim] +end +desc "Remove #{Project_details.name} (all versions)" +task :remove_package => + [:remove_bin, :remove_lib, :remove_conf] +if File.directory?('bin') + #desc "Remove #{Project_details.name} bin only" + task :remove_bin => + [:remove_bin] +end +if File.directory?('lib') + #desc "Remove #{Project_details.name} lib only" + task :remove_lib => + [:remove_lib] +end +if File.directory?('conf') + #desc "Remove #{Project_details.name} conf only" + task :remove_conf => + [:remove_conf] +end +desc "Re-setup #{Project_details.name}, synonym :reinstall" +task :resetup => + [:remove, :setup] +task :reinstall => + [:remove, :setup] +#desc "Re-setup #{Project_details.name}: bin, lib, conf (ignore data), synonym :reinstall" +task :resetup_base => + [:remove, :setup_base_] +task :reinstall_base => + [:remove, :setup_base_] +if File.directory?('bin') + #desc "Re-setup #{Project_details.name} bin, synonym :reinstall" + task :resetup_bin => + [:remove_bin, :setup_bin_] + task :reinstall_bin => + [:remove_bin, :setup_bin_] +end +if File.directory?('lib') + #desc "Re-setup #{Project_details.name} lib, synonym :reinstall_lib" + task :resetup_lib => + [:remove_lib, :setup_lib_] + task :reinstall_lib => + [:remove_lib, :setup_lib_] +end +if File.directory?('conf') + #desc "Re-setup #{Project_details.name} conf, synonyms :reinstall_conf & :resetup_etc" + task :resetup_conf => + [:remove_conf, :setup_conf_] + task :reinstall_conf => + [:remove_conf, :setup_conf_] + task :resetup_etc => + [:remove_conf, :setup_conf_] + task :reinstall_etc => + [:remove_conf, :setup_conf_] +end +if File.directory?('data/sisu') + #desc "Re-setup #{Project_details.name} shared data, (odf & images)" + task :resetup_share => + [:remove_share, :setup_share_] + task :reinstall_share => + [:remove_share, :setup_share_] +end +if File.directory?('man') + #desc "Re-setup #{Project_details.name} man, synonym :reinstall_man" + task :resetup_man => + [:remove_man, :setup_man_] + task :reinstall_man => + [:remove_man, :setup_man_] +end +desc 'Setup Note' +task :setup_note => + [:help] +desc "System information used by #{Project_details.name}" +task :system => + [:system_info,:project_help,:note_sources] +desc "show all system info available - parameters found" +task :system_param => + [:system_param_] +desc "Gem environment information used ruby gems for #{Project_details.name}" +task :gem_env => + [:gem_env_] +desc 'Help' +task :help => + [:project_help,:system_info,:tasks] +#desc "Setup/Install #{Project_details.name} (uses filelist)" +task :install => + [:default_notice,:project] +task :install_bin => + [:setup_bin_] +#desc "search for a version tag e.g. 'tag[5.6.0]'" +task :tag, [:tag] do |t, args| + args.with_defaults(:tag => Version_info::Next.setting_stable[:version]) + puts "Check for Version Tag: #{args.tag}" + print "Version Tag: " + GitExtractTaggedVersionBuild::git_tagged_versions(args) +end +#desc "build and install a specific git tagged version of sisu, e.g. 'build[5.6.0]'" +task :build, [:tag, :branch] => :done do |t, args| + args.with_defaults(:tag => '5.6.0', :branch => 'stable') + puts "Version Tag: #{args.tag}" + puts "Branch: #{args.branch}" + GitExtractTaggedVersionBuild::git_tagged_versions(args.tag) + ans= <<-WOK +Gem Install SiSU Version + WOK + resp=Utils.answer?(ans) + exit unless resp + GitExtractTaggedVersionBuild::git_checkout_and_build_version(args) +end +task :done do + puts 'done' +end + #%% setup/install tasks +task :rant_independence do #notice + resp='' + while resp.length < 4 + resp='sisu-install' #default name install + print %{#{Project_details.rake_rant} + Create a rant dependency independent file + provide filename default name is "install" + [Warning, will overwrite file of name provided + provide name or "quit" to exit]: } + exit if resp =~/^(?:n|quit|exit)$/ + end + remove='y' #remove='n' + if remove =~/y/ + system("rant-import --force --auto #{resp}; + chmod 755 #{resp} + ") + else #puts "#{resp} not replaced" + end +end + +task :default_notice do #notice + Utils.default_notice +end +task :default2 do #secondary + setup_find_cp_r('bin',Project_details.dir.bin) \ + if File.directory?('bin') + setup_find_cp_r('lib',Project_details.dir.lib) \ + if File.directory?('lib') + setup_find_cp_r('conf',Project_details.dir.conf) \ + if File.directory?('conf') + setup_find_cp_r('data/sisu',Project_details.dir.share) \ + if File.directory?('data/sisu') # + setup_find_cp_r('data',Project_details.dir.data) \ + if File.directory?('data') + setup_find_cp_r('data/vim',"#{Project_details.dir.data}/vim") \ + if File.directory?('data/vim') + setup_find_cp_r('man',Project_details.dir.man) \ + if File.directory?('man') +end +task :setup_bin_ do + exclude_files=['sisugem'] + Install.setup_find_create('bin',Project_details.dir.bin,exclude_files) \ + if File.directory?('bin') +end +task :setup_lib_ do + Install.setup_find_create('lib',Project_details.dir.lib) \ + if File.directory?('lib') +end +task :setup_conf_ do + Install.setup_find_create('conf',Project_details.dir.conf) \ + if File.directory?('conf') +end +task :setup_share_ do + Install.setup_find_create('data/sisu',Project_details.dir.share) \ + if File.directory?('data/sisu') +end +task :setup_data_ do + Install.setup_find_create('data',Project_details.dir.data) \ + if File.directory?('data') +end +task :setup_man_ do + Install.setup_find_create('man',Project_details.dir.man) \ + if File.directory?('man') + Install.setup_find_create('man.deb/man',Project_details.dir.man) \ + if File.directory?('man.deb/man') +end +task :setup_vim_ do + Install.setup_find_create('data/vim',Project_details.dir.vim) \ + if File.directory?('data/vim') +end +task :gemspec_info do + Gemspecs.info_stable +end +task :gemspecs_stable_create_default_version do + Gemspecs::Current.create_stable +end +task :gemspecs_create_default_version do + Gemspecs::Current.create_stable +end +task :gemspecs_stable_create_next_version do + Gemspecs::Next.create_stable +end +task :gemspecs_create_next_version do + Gemspecs::Next.create_stable +end +task :gem_stable_build do + Gemspecs::Current.build_stable +end +task :gem_build_ do + Gemspecs::Current.build_stable +end +task :gem_stable_build_next_version do + Gemspecs::Next.build_stable +end +task :gem_build_next_version do + Gemspecs::Next.build_stable +end +task :gem_stable_install do + Gemspecs::Current.install_stable +end +task :gem_install_ do + Gemspecs::Current.install_stable +end +task :gem_stable_install_next_version do + Gemspecs::Next.install_stable +end +task :gem_install_next_version do + Gemspecs::Next.install_stable +end +task :changelog_headers do + puts '---' + puts Version_info::Update.changelog_header_stable +end +task :sisu_version do + puts Version_info::Next.setting_stable + puts '---' + puts Version_info::Current.setting_stable[:project] + puts Version_info::Current.setting_stable[:version] + puts Version_info::Current.setting_stable[:date] + puts Version_info::Current.setting_stable[:date_stamp] +end +task :sisu_version_set do + Version_info::Update.update_stable +end + #%% post install + #%% clobber/remove tasks +task :remove_bin do + rm_r "#{Project_details.dir.bin}/#{Project_details.dir.proj}" \ + if FileTest.file?("#{Project_details.dir.bin}/#{Project_details.dir.proj}") +end +task :remove_lib do + rm_r "#{Project_details.dir.lib}/#{Project_details.dir.proj}" \ + if FileTest.directory?("#{Project_details.dir.lib}/#{Project_details.dir.proj}") +end +task :remove_conf do + rm_r "#{Project_details.dir.conf}/#{Project_details.dir.proj}" \ + if FileTest.directory?("#{Project_details.dir.conf}/#{Project_details.dir.proj}") +end +task :remove_man do + rm_r "#{Project_details.dir.man}/**/#{Project_details.dir.proj}" \ + if FileTest.directory?("#{Project_details.dir.man}/man1/#{Project_details.dir.proj}") +end +task :remove_version do + rm_r "#{Project_details.dir.bin}/#{Project_details.dir.proj}" \ + if FileTest.file?("#{Project_details.dir.bin}/#{Project_details.dir.proj}") + rm_r "#{Project_details.dir.lib}/#{Project_details.dir.proj}/#{Project_details.version}" \ + if FileTest.directory?("#{Project_details.dir.lib}/#{Project_details.dir.proj}/#{Project_details.version}") + rm_r "#{Project_details.dir.conf}/#{Project_details.dir.proj} \ + if FileTest.directory?("#{Project_details.dir.conf}/#{Project_details.dir.proj}") +end +task :remove_package do + rm_r "#{Project_details.dir.bin}/#{Project_details.dir.proj}" \ + if FileTest.file?("#{Project_details.dir.bin}/#{Project_details.dir.proj}") + rm_r "#{Project_details.dir.lib}/#{Project_details.dir.proj}" \ + if FileTest.directory?("#{Project_details.dir.lib}/#{Project_details.dir.proj}") + rm_r "#{Project_details.dir.conf}/#{Project_details.dir.proj}" \ + if FileTest.directory?("#{Project_details.dir.conf}/#{Project_details.dir.proj}") +end +task :note_sources do + puts <<-WOK + + SiSU project: + + + sisu source code is available at: + + + sisu markup samples are provided/packaged separately as sisu-markup-samples: + + WOK +end +task :note_installation do + puts <<-WOK + alternative 0: distribution install, rather than this Rakefile + a distribution install pulls in the many dependencies used by sisu after + initial processing to generate and store output, significant amongst these are + XeTeX & databases (sqlite3 and postgresql) + + alternative 1: gem install, you need to: + create the gemspec; build the gem (from the gemspec); install the gem + which 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: + rake gem_create_build_install_stable # (to build and install sisu v5, alias gem5cbi) + for individual steps (create, build, install) see rake options, rake -T + to specify sisu version for sisu installed via gem + sisu _#{Version_info::Current.setting_stable[:version]}_ --version + to uninstall sisu installed via gem + sudo gem uninstall --verbose sisu + WOK +end +task :note_developer do + puts <<-WOK + + changelogheaders + + sisuversion + sisuversionset + + gemcsn gem5csn gem6csn + gembn gem5bn gem6bn + gemin gem5in gem6in + gembin gem5bin gem6bin + gemcbin gem5cbin gem6cbin + WOK +end + #%% help & system info +task :system_info do + Project_details.system_info +end +task :system_param_ do + Project_details.env.each {|c| puts c.inspect } +end +task :gem_env_ do + Project_details.gem_env +end +task :project_help do + Help.project_help +end +task :tasks do + Help.tasks +end +#+END_SRC + +** Rake & Rant libs + +#+BEGIN_SRC ruby :tangle ../setup/rbuild_libs.rb +module Project_details + require_relative 'sisu_version' + include SiSUversion + def self.name + 'SiSU' + end + def self.thor + "ruby-thor files for the installation/setup of #{name}" + end + def self.platform_notice + "[#{name} is for Linux/Unix Platforms]" + end + def self.env + RbConfig::CONFIG + end + def self.host + env['host'] + end + def self.dir + def self.proj + Project_details.name.downcase + end + def self.arch + env['archdir'] + end + def self.sitearch + env['sitearchdir'] + end + def self.bin + env['bindir'] + end + def self.lib + env['sitelibdir'] + end + def self.data + env['datadir'] + end + def self.share + "#{env['datadir']}/sisu" + end + def self.conf + env['sysconfdir'] + end + def self.man + env['mandir'] + end + def self.vim + "#{env['datadir']}/sisu/vim" + end + def self.out + "#{env['localstatedir']}/#{proj}" + end + def self.rubylib + env['LIBRUBYARG_SHARED'] + end + def self.pwd + Dir.pwd #ENV['PWD'] + end + self + end + def self.version + stamp={} + v="#{dir.pwd}/data/sisu/version.yml" + if File.exist?(v) + stamp=YAML::load(File::open(v)) + stamp[:version] + else '' + end + end + def self.system_info + ##{Project_details.platform_notice} + puts <<-WOK + Host + host: #{Project_details.host} + arch: #{Project_details.dir.arch} + sitearch: #{Project_details.dir.sitearch} + Directories for installation + bin: #{Project_details.dir.bin} + lib (site-ruby): #{Project_details.dir.lib}/#{Project_details.dir.proj}/v* + conf [etc]: #{Project_details.dir.conf}/#{Project_details.dir.proj} + data (odf, shared images): #{Project_details.dir.share} + vim (vim syntax, highlighting, ftplugin): #{Project_details.dir.data}/sisu/vim + data (README, version_manifest): #{Project_details.dir.data}/doc/#{Project_details.dir.proj} + man (manual pages): #{Project_details.dir.man} + output: #{Project_details.dir.out} + processing: #{Project_details.dir.out}/processing + www: #{Project_details.dir.out}/www + rubylib: #{Project_details.dir.rubylib} + + WOK + end + def self.gem_env + system("gem env") + end +end +module Utils + def self.answer?(ask) + resp='redo' + print ask + " ['yes', 'no' or 'quit']: " + resp=File.new('/dev/tty').gets.strip #resp=gets.strip + if resp == 'yes' then true + elsif resp == 'no' then false + elsif resp =~/^quit|exit$/ then exit + else puts "[please type: 'yes', 'no' or 'quit']" + answer?(ask) + end + end + def self.default_notice # local help not implemented description incorrect + ans= %{#{Project_details.thor} + Information on alternative actions is available using: + [if ruby-thor is installed:] + "rake help") + Default action selected - "install #{Project_details.name}" proceed? } + resp=answer?(ans) + exit unless resp + end + def self.chmod_file(place) + if place =~/\/bin/; File.chmod(0755,place) + else File.chmod(0644,place) + end + end + def self.chmod_util(place) + if place =~/\/bin/; chmod(0755,place) + else chmod(0644,place) + end + end + def self.system_date + `date "+%Y-%m-%d"`.strip + end + def self.system_date_stamp + `date "+%Yw%W/%u"`.strip + end + def self.program_found?(prog) + found=`which #{prog}` #`whereis #{make}` + (found =~/bin\/#{prog}\b/) ? :true : :false + end +end +module Install + #%% using a directory and its mapping + def self.setup_find_create(dir_get,dir_put,exclude_files=['\*'],act) #primary, + begin + Find.find("#{Project_details.dir.pwd}/#{dir_get}") do |f| + stub=f.scan(/#{Project_details.dir.pwd}\/#{dir_get}\/(\S+)/).join + place="#{dir_put}/#{stub}" + action=case + when File.file?(f) + unless f =~/#{exclude_files.join("|")}/ + cp(f,place) + Utils.chmod_file(place) + "-> #{dir_put}/" + end + when File.directory?(f) + FileUtils.mkpath(place) \ + unless FileTest.directory?(place) + "./#{dir_get}/" + else '?' + end + puts "#{action}#{stub}" + end + rescue + puts "\n\n<< are you root? required for install >>" + end + end + def self.setup_find_cp_r(dir_get,dir_put) #secondary, using recursive copy + begin + Find.find("#{Project_details.dir.pwd}/#{dir_get}") do |f| + stub=f.scan(/#{Project_details.dir.pwd}\/#{dir_get}\/(\S+)/).join + place="#{dir_put}/#{stub}" + case + when File.file?(f) + cp_r(f,place) + Utils.chmod_util(place) + when File.directory?(f) + mkdir(place) \ + unless FileTest.directory?(place) + end + end + rescue + puts "\n\n<< are you root? required for install >>" + end + end +end +module Version_info + def self.contents(vi) + <<-WOK +--- +:project: #{vi[:project]} +:version: #{vi[:version]} +:date_stamp: #{vi[:date_stamp]} +:date: "#{vi[:date]}" + WOK + end + def self.git_version_extract + if FileTest.file?('/usr/bin/git') + x=`git describe --long --tags 2>&1`.strip. + gsub(/^[a-z_-]*([0-9.]+)/,'\1'). + gsub(/([^-]*-g)/,'r\1'). + gsub(/-/,'.') + x=(x=~/^[0-9]+\.[0-9]+\.[0-9]+\.r[0-9]+\.g[0-9a-f]{7}/) \ + ? x + : nil + else nil + end + end + def self.version_number_use(vi) + (git_version_extract.nil?) \ + ? (vi[:version]) + : git_version_extract + end + def self.version_number_info(vi) + (Version_info.version_number_use(vi) != vi[:version_number]) \ + ? (%{#{vi[:version_number]} from git #{Version_info.version_number_use(vi)}}) + : vi[:version_number] + end + def self.version_number_info_stable + vi=Version_info::Current.setting_stable + (Version_info.version_number_use(vi) != vi[:version_number]) \ + ? (%{#{vi[:version_number]} from git #{Version_info.version_number_use(vi)}}) + : vi[:version_number] + end + module Current + def self.yml_file_path + 'data/sisu/version.yml' + end + def self.settings(file) + v="#{Dir.pwd}/#{file}" + if File.exist?(v) + YAML::load(File::open(v)) + else '' + end + end + def self.file_stable + yml_file_path + end + def self.setting_stable + hsh=settings(file_stable) + hsh[:version_number]=/([0-9]+\.[0-9]+\.[0-9]+)/. + match(hsh[:version])[1] + hsh + end + def self.content_stable + Version_info.contents(setting_stable) + end + end + module Next + def self.settings(v) + { + project: "#{Project_details.name}", + version: "#{v}", + date: "#{Utils.system_date}", + date_stamp: "#{Utils.system_date_stamp}", + } + end + def self.setting_stable + settings(SiSU_version) + end + def self.content_stable + Version_info.contents(setting_stable) + end + end + module Update + def self.version_info_update_commit(filename,vi_hash_current,vi_content_current,vi_hash_next,vi_content_next) + ans=%{update #{Project_details.name.downcase} version info replacing: + #{vi_hash_current.sort} +with: + #{vi_hash_next.sort} + +#{vi_content_current} becoming: +#{vi_content_next} +proceed? } + resp=Utils.answer?(ans) + if resp + fn="#{Dir.pwd}/#{filename}" + if File.writable?("#{Dir.pwd}/.") + file_version=File.new(fn,'w+') + file_version << vi_content_next + file_version.close + else + puts %{*WARN* is the file or directory writable? could not create #{filename}} + end + end + end + def self.update_stable + version_info_update_commit( + Version_info::Current.file_stable, + Version_info::Current.setting_stable, + Version_info::Current.content_stable, + Version_info::Next.setting_stable, + Version_info::Next.content_stable + ) + end + def self.changelog_header(vi) + <<-WOK +-- #{vi[:version]}.orig.tar.xz (#{vi[:date]}:#{vi[:date_stamp].gsub(/20\d\dw/,'')}) +http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/sisu_#{vi[:version]} +http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/debian/sisu_#{vi[:version]}-1 +http://www.jus.uio.no/sisu/pkg/src/sisu_#{vi[:version]}.orig.tar.xz + sisu_#{vi[:version]}.orig.tar.xz + sisu_#{vi[:version]}-1.dsc + WOK + end + def self.changelog_header_stable + changelog_header(Version_info::Current.setting_stable) + end + end + self +end +module GitExtractTaggedVersionBuild + def upstream + system(%{ git checkout upstream }) + end + def self.git_tagged_versions(vb=nil) + if vb.tag + v=if vb.tag =~/sisu_[0-9](?:\.[0-9]){0,2}$/ then vb.tag + elsif vb.tag =~/^[0-9](?:\.[0-9]){0,2}$/ then 'sisu_' + vb.tag + else 'sisu_' + end + system(%{ git tag -l | ag --nocolor '^#{v}' }) + end + end + def self.git_checkout_and_build_version(vb) + begin + ver=if vb.tag =~/sisu_[0-9]\.[0-9]+\.[0-9]+/ then vb.tag + elsif vb.tag =~/^[0-9]\.[0-9]+\.[0-9]+/ then 'sisu_' + vb.tag + else vb.branch + end + install_branch='gem_create_build_stable' + commands =<<-WOK + git checkout #{ver} && + rake #{install_branch}; + WOK + puts commands + system(commands) + ensure + system(%{ + git checkout upstream + }) + end + end + def self.git_checkout_and_build_and_install_version(vb) + begin + ver=if vb.tag =~/sisu_[0-9]\.[0-9]+\.[0-9]+/ then vb.tag + elsif vb.tag =~/^[0-9]\.[0-9]+\.[0-9]+/ then 'sisu_' + vb.tag + else vb.branch + end + install_branch='gem_create_build_install_stable' + commands =<<-WOK + git checkout #{ver} && + rake #{install_branch}; + WOK + puts commands + system(commands) + ensure + system(%{ + git checkout upstream + }) + end + end +end +module Gemspecs + def self.info(vi) + puts <<-WOK +-- +name: #{vi[:project].downcase} +version: #{vi[:version_number]} +date: #{vi[:date]} +summary: #{vi[:project]} + WOK + end + def self.contents(vi) + #s.summary = '#{vi[:project]}' + <<-WOK +Gem::Specification.new do |s| + s.name = '#{vi[:project].downcase}' + s.version = '#{vi[:version_number]}' + s.date = '#{vi[:date]}' + s.summary = '#{Version_info.version_number_info(vi)}' + s.description = 'documents - structuring, publishing in multiple formats and search' + s.authors = ["Ralph Amissah"] + s.email = 'ralph.amissah@gmail.com' + s.files = Dir['lib/#{Project_details.name.downcase}/*.rb'] + + Dir['data/#{Project_details.name.downcase}/version.yml'] + + Dir['data/#{Project_details.name.downcase}/image/*'] + + Dir['bin/#{Project_details.name.downcase}gem'] + + Dir['bin/#{Project_details.name.downcase}'] + s.license = 'GPL-3.0-or-later' + s.executables << '#{Project_details.name.downcase}gem' << '#{Project_details.name.downcase}' +end + WOK + end + def self.create(filename,gemspec) + fn="#{Dir.pwd}/#{filename}.gemspec" + if File.writable?("#{Dir.pwd}/.") + file_sisu_gemspec=File.new(fn,'w+') + file_sisu_gemspec << gemspec + file_sisu_gemspec.close + else + puts %{*WARN* is the file or directory writable? could not create #{filename}} + end + end + def self.build(fn) + system(%{ gem build #{fn}.gemspec }) + end + def self.install(fn) + system(%{ + sudo gem install --no-document --verbose #{fn}.gem + }) + end + module Current + def self.filename_stable + Project_details.name.downcase \ + + '-' \ + + Version_info::Current.setting_stable[:version_number] + end + def self.info_stable + Gemspecs.info(Version_info::Current.setting_stable) + end + def self.current_stable + Gemspecs.contents( + Version_info::Current.setting_stable, + ) + end + def self.create_stable + Gemspecs.create(filename_stable,current_stable) + Gemspecs.create( + "#{Project_details.name.downcase}-stable", + current_stable + ) + end + def self.build_stable + Gemspecs.build(filename_stable) + end + def self.install_stable + Gemspecs.install(filename_stable) + end + end + module Next + def self.filename_stable + Project_details.name.downcase \ + + '-' \ + + Version_info::Next.setting_stable[:version_number] + end + def self.setting_stable + Gemspecs.contents( + Version_info::Next.setting_stable, + ) + end + def self.create_stable + Gemspecs.create(filename_stable,setting_stable) + end + def self.build_stable + Gemspecs.build(filename_stable) + end + def self.install_stable + Gemspecs.install(filename_stable) + end + end +end +#+END_SRC + +** Rake & Rant help + +#+BEGIN_SRC ruby :tangle ../setup/rbuild_help.rb +module Help + def self.project_help + puts </dev/null; then + echo "direnv: using lorri from PATH ($(type -p lorri))" + eval "$(lorri direnv)" +else + # fall back to using direnv's builtin nix support + # to prevent bootstrapping problems. + use nix + NIX_ENFORCE_PURITY=0 +fi +# source an additional user-specific .envrc in ./.envrc-local +if [ -e .envrc-local ]; then + source .envrc-local +fi +#+END_SRC + +** shell.nix + +*** shell.nix TODO + +#+BEGIN_SRC nix :tangle ../shell.nix +{ pkgs ? import {} }: +pkgs.mkShell { + buildInputs = [ + (import ./nix/pkglst/packages.nix { inherit pkgs; }) + ]; +} +#+END_SRC + +#+BEGIN_SRC nix :NO-tangle ../shell.nix +{ pkgs ? import {} }: +let +in pkgs.mkShell { + buildInputs = with pkgs; [ + nix + bundler + bundix + <> + sqlite + unzip + xz + zip + #texlive-combined-full + ]; +} +#+END_SRC + +*** packages.nix +**** default + +#+BEGIN_SRC nix :tangle ../nix/pkglst/packages.nix +{ pkgs ? import {} }: +with pkgs; [ + <> + <> + <> +] +#+END_SRC + +**** ruby 2.7 + +#+BEGIN_SRC nix :tangle ../nix/pkglst/packages_rauby_2_7.nix +{ pkgs ? import {} }: +with pkgs; [ + <> + <> + <> +] +#+END_SRC + +**** ruby 2.6 + +#+BEGIN_SRC nix :tangle ../nix/pkglst/packages_rauby_2_6.nix +{ pkgs ? import {} }: +with pkgs; [ + <> + <> + <> +] +#+END_SRC + +*** ruby legacy + +#+NAME: ruby_legacy +#+BEGIN_SRC nix +<> +#+END_SRC +*** ruby current + +#+NAME: ruby_current +#+BEGIN_SRC nix +<> +#+END_SRC + +*** ruby next + +#+NAME: ruby_next +#+BEGIN_SRC nix +<> +#+END_SRC + +*** ruby 2.5 - ruby_version_2_5 + +#+NAME: ruby_version_2_5 +#+BEGIN_SRC nix +ruby_2_5 +rubyPackages_2_5.rake +rubyPackages_2_5.sqlite3 +rubyPackages_2_5.thor +#+END_SRC + +*** ruby 2.6 - ruby_version_2_6 + +#+NAME: ruby_version_2_6 +#+BEGIN_SRC nix +ruby +rubyPackages.rake +rubyPackages.sqlite3 +rubyPackages.thor +#+END_SRC + +*** ruby 2.7 - ruby_version_2_7 + +#+NAME: ruby_version_2_7 +#+BEGIN_SRC nix +ruby_2_7 +rubyPackages_2_7.rake +rubyPackages_2_7.sqlite3 +rubyPackages_2_7.thor +#+END_SRC + +*** nix related packages + +#+NAME: nix_packages +#+BEGIN_SRC nix +nix +bundler +bundix +#+END_SRC + +*** project relevant packages + +#+NAME: packages_project_relevant +#+BEGIN_SRC nix + sqlite + unzip + xz + zip + #texlive-combined-full +#+END_SRC + +* descriptions +** README + +#+BEGIN_SRC md :tangle ../README +SISU - README +============= + +INTRODUCTION +************ + +INTRODUCTION - WHAT IS SISU? +---------------------------- + +*SiSU* is a lightweight markup based document creation and publishing framework +that is controlled from the command line. Prepare documents for *SiSU* using +your text editor of choice, then use *SiSU* to generate various output document +formats. + +From a single lightly prepared document (plain-text /UTF-8/) sisu custom builds +several standard output formats which share a common (text object) numbering +system for citation of content within a document (that also has implications +for search). The sisu engine works with an abstraction of the document's +structure and content from which it is possible to generate different forms of +representation of the document. *SiSU* produces: plain-text, /HTML/, /XHTML/, +/XML/, /EPUB/, /ODF/: /ODT/ (Opendocument), /LaTeX/, /PDF/, and populates an +/SQL/ database (/PostgreSQL/ or /SQLite/) with text objects, roughly, paragraph +sized chunks so that document searches are done at this level of granularity. + +Outputs share a common citation numbering system, associated with text objects +and any semantic meta-data provided about the document. + +*SiSU* also provides concordance files, document content certificates and +manifests of generated output. Book indexes may be made. + +Some document markup samples are provided in the package sisu -markup-samples. + +Homepages: +- + +INSTALL OR RUN WITHOUT INSTALLATION +*********************************** + +SOURCE TREE +----------- + +RUN OFF SOURCE PACKAGE DIRECTORY TREE (WITHOUT INSTALLING) +.......................................................... + +Download & unpack the latest source tarball + +or + +Git clone the latest source, to clone the latest source without the repo +history: + +git clone --depth 1 git://git.sisudoc.org/git/code/sisu.git --branch upstream + +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) + +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 +........... + +Gem install, you need to: + +(i) create the gemspec; (ii) build the gem (from the gemspec); (iii) install +the gem + + +---------------------------------------- + +GEM INSTALL WITH QI (QUICK INSTALL) SCRIPT +.......................................... + +(This requires that ruby -thor is installed). + +qi (quick install) can go through the steps required to install the gem: + + qi gem --create --build --install --stable + +or + + qi gem --create --build --install --unstable + + +---------------------------------------- + +GEM INSTALL WITH RAKE +..................... + +Provided you have ruby & rake, this can be done with the single command: + + rake gem_create_build_install # (to build and install, alias gemcbi) + +for individual steps (create, build, install) see rake options, rake -T to +specify sisu version for sisu installed via gem + +For a list of alternative actions you may type: + + rake help + + rake -T + +Rake: + + +---------------------------------------- + +MISC GEM +........ + +gem search sisu + + sisu _7.0.0_ --version + + sisu _7.0.0_ --version + +to uninstall sisu installed via gem + + sudo gem uninstall --verbose sisu + +DIRECT INSTALLATION WITH QI (QUICK INSTALL) SCRIPT +.................................................. + +(This requires that ruby -thor is installed). + +Root will be requested as required: + + qi setup --bin --lib --conf --data --share --man + +or + + qi setup --all + +You may wish to do a dryrun to see where files would be installed without +copying them, to do so add the flag --dryrun + +INSTALLATION WITH SETUP.RB +.......................... + +It should also be possible to install sisu using 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 + +UNIX/LINUX DISTRIBUTION +----------------------- + +A distribution install should take care of the dependencies of sisu for +producing various outputs. + +DEBIAN +...... + +*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. + +DEPENDENCIES +------------ + +Here is a list of sisu' s current dependencies,[^2] which depend on such +factors as whether you want to generate pdf, whether you will be using *SiSU* +with or without a database, ...). sisu_markup-samples may also be of interest. + +Package: sisu +Depends: ruby | ruby-interpreter, openssl, rsync, unzip, zip +Recommends: sisu-pdf, sisu-sqlite, sisu-postgresql, imagemagick | +graphicsmagick, keychain, openssh-client | lsh-client, po4a, qrencode, rake, +ruby-rmagick, tidy, tree, vim-addon-manager +Suggests: lv, calibre, pinfo, poedit, texinfo, trang + +Package: sisu-complete +Depends: ruby | ruby-interpreter, sisu (= ${source:Version}), sisu-pdf (= +${source:Version}), sisu-postgresql (= ${source:Version}), sisu-sqlite (= +${source:Version}) +Description-en: installs all SiSU related packages + +Package: sisu-pdf +Depends: ruby | ruby-interpreter, sisu (= ${source:Version}), +texlive-latex-base, texlive-fonts-recommended, texlive-generic-recommended, +texlive-latex-recommended, texlive-latex-extra, texlive-math-extra, +texlive-xetex, fonts-liberation, lmodern, latex-cjk-all, texlive-lang-cjk +Suggests: evince | pdf-viewer + +Package: sisu-postgresql +Depends: ruby | ruby-interpreter, sisu (= ${source:Version}), postgresql, +ruby-dbd-pg, ruby-dbi, ruby-fcgi +Suggests: postgresql-contrib + +Package: sisu-sqlite +Depends: ruby | ruby-interpreter, sisu (= ${source:Version}), sqlite3, +ruby-sqlite3, ruby-dbd-sqlite3, ruby-dbi, ruby-fcgi + +Package: sisu-markup-samples +Depends: sisu + +COMMANDS +******** + +COMMANDS SUMMARY +---------------- + +DESCRIPTION +........... + +*SiSU* is a document publishing system, that from a simple single marked-up +document, produces multiple output formats including: /plaintext/, /HTML/, +/XHTML/, /XML/, /EPUB/, /ODT/ (/OpenDocument/ (/ODF/) text), /LaTeX/, /PDF/, +info, and /SQL/ (/PostgreSQL/ and /SQLite/) , which share text object numbers +("object citation numbering") and the same document structure information. For +more see: or + +DOCUMENT PROCESSING COMMAND FLAGS +................................. + +*-[0-9] [filename/wildcard]* +see --act + +*--ao [filename/wildcard/url]* +assumed for most other flags, creates new intermediate files for processing +(abstract objects, document abstraction) that is used in all subsequent +processing of other output. This step is assumed for most processing flags. To +skip it see -n. Alias -m. + +*--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 + +*--asciidoc [filename/wildcard]* +asciidoc, smart text (not available) + +*-b [filename/wildcard]* +see --xhtml + +*--by-** +see --output-by-* + +*-C* +configure/initialise shared output directory files initialize shared output +directory (config files such as css and dtd files are not updated if they +already exist unless modifier is used). -C --init-site configure/initialise +site more extensive than -C on its own, shared output directory files/force +update, existing shared output config files such as css and dtd files are +updated if this modifier is used. + +*-c [filename/wildcard]* +see --color-toggle + +*--color* +see --color-on + +*--color-off* +turn off color in output to terminal + +*--color-on* +turn on color in output to terminal + +*--color-toggle [filename/wildcard]* +screen toggle ansi screen colour on or off depending on default set (unless -c +flag is used: if sisurc colour default is set to 'true', output to screen will +be with colour, if sisurc colour default is set to 'false' or is undefined +screen output will be without colour). Alias -c + +*--configure* +configure/initialise shared output directory files initialize shared output +directory (config files such as css and dtd files are not updated if they +already exist unless modifier is used). The equivalent of: -C --init-site +configure/initialise site, more extensive than -C on its own, shared output +directory files/force update, existing shared output config files such as css +and dtd files are updated if -CC is used. + +*--concordance [filename/wildcard]* +produces concordance (wordmap) a rudimentary index of all the words in a +document. (Concordance files are not generated for documents of over 260,000 +words unless this limit is increased in the file sisurc.yml). Alias -w + +*-d [filename/wildcard/url]* +see --docbook + +*--dal [filename/wildcard/url]* +(abstract objects, document abstraction renamed abstract objects in sisu5) see +--ao + +*--delete [filename/wildcard]* +see --zap + +*--digests [filename/wildcard/url]* +document digest or document content certificate ( DCC ) as sha digest tree of +the document: the digest for the document, and digests for each object +contained within the document (together with information on software versions +that produced it) (digest.txt). --digests -V for verbose digest output to +screen. + +*--docbook [filename/wildcard/url]* +docbook xml + +*--dom [filename/wildcard/url]* +see --xml-dom + +*--dump[=directory_path] [filename/wildcard]* +places output in directory specified, if none is specified in the current +directory (pwd). Unlike using default settings /HTML/ files have embedded css. +Compare --redirect + +*-e [filename/wildcard]* +see --epub + +*--epub [filename/wildcard]* +produces an epub document, [sisu version >=2 ] (filename.epub). Alias -e + +*--errors-as-warnings* +override stop processing on error. Alias --no-stop + +*--exc-** +exclude output feature, overrides configuration settings --exc-numbering, see +--exc-ocn; --exc-ocn, (exclude "object citation numbering", (switches off +object citation numbers), affects html (seg, scroll), epub, xhtml, xml, pdf) ; +--exc-toc, (exclude table of contents, affects html (scroll), epub, pdf) ; +--exc-links-to-manifest, --exc-manifest-links, (exclude links to manifest, +affects html (seg, scroll)); --exc-search-form, (exclude search form, affects +html (seg, scroll), manifest); --exc-minitoc, (exclude mini table of contents, +affects html (seg), concordance, manifest); --exc-manifest-minitoc, (exclude +mini table of contents, affects manifest); --exc-html-minitoc, (exclude mini +table of contents, affects html (seg), concordance); --exc-html-navigation, +(exclude navigation, affects html (seg)); --exc-html-navigation-bar, (exclude +navigation bar, affects html (seg)); --exc-html-search-form, (exclude search +form, affects html (seg, scroll)); --exc-html-right-pane, (exclude right +pane/column, affects html (seg, scroll)); --exc-html-top-band, (exclude top +band, affects html (seg, scroll), concordance (minitoc forced on to provide seg +navigation)); --exc-segsubtoc (exclude sub table of contents, affects html +(seg), epub) ; see also --inc-* + +*-F [--webserv=webrick]* +see --sample-search-form + +*-f [optional string part of filename]* +see --find + +*--fictionbook [filename/wildcard/url]* +fictionbook xml (not available) + +*--find [optional string part of filename]* +see --glob + +*-G [optional string part of filename]* +see --glob + +*-g [filename/wildcard]* +see --git + +*--git [filename/wildcard]* +produces or updates markup source file structure in a git repo (experimental +and subject to change). Alias -g + +*--glob [optional string part of filename]* +without match string, glob all .sst .ssm files in directory (including language +subdirectories). With match string, find files that match given string in +directory (including language subdirectories). Alias -G, -f, --find + +*-h [filename/wildcard]* +see --html + +*--harvest *.ss[tm]* +makes two lists of sisu output based on the sisu markup documents in a +directory: list of author and authors works (year and titles), and; list by +topic with titles and author. Makes use of header metadata fields (author, +title, date, topic_register). Can be used with maintenance (-M) and remote +placement (-R) flags. + +*--html [filename/wildcard]* +produces html output, in two forms (i) segmented text with table of contents +(toc.html and index.html) and (ii) the document in a single file (scroll.html). +Alias -h + +*--html-scroll [filename/wildcard]* +produces html output, the document in a single file (scroll.html) only. Compare +--html-seg and --html + +*--html-seg [filename/wildcard]* +produces html output, segmented text with table of contents (toc.html and +index.html). Compare --html-scroll and --html + +*--html-strict [filename/wildcard]* +produces html with --strict option. see --strict + +*-I [filename/wildcard]* +see --texinfo + +*-i [filename/wildcard]* +see --manpage + +*--i18n-** +these flags affect output by filetype and filename): --i18n-mono +(--monolingual) output filenames without language code for default language +('en' or as set); --i18n-multi (--multilingual) language code provided as part +of the output filename, this is the default. Where output is in one language +only the language code may not be desired. see also --output-by-* + +*--inc-** +include output feature, overrides configuration settings, (usually the default +if none set), has precedence over --exc-* (exclude output feature). Some detail +provided under --exc-*, see --exc-* + +*-j [filename/wildcard]* +copies images associated with a file for use by html, xhtml & xml outputs +(automatically invoked by --dump & redirect). + +*-k* +see --color-off + +*--keep-processing-files [filename/wildcard/url]* +see --maintenance + +*-M [filename/wildcard/url]* +see --maintenance + +*-m [filename/wildcard/url]* +see --dal (document abstraction level/layer) + +*--machine [filename/wildcard/url]* +see --dal (document abstraction level/layer) + +*--maintenance [filename/wildcard/url]* +maintenance mode, interim processing files are preserved and their locations +indicated. (also see -V). Aliases -M and --keep-processing-files. + +*--manifest [filename/wildcard]* +produces an html summary of output generated (hyperlinked to content) and +document specific metadata (sisu_manifest.html). This step is assumed for most +processing flags. + +*--manpage [filename/wildcard]* +produces man page of file, not suitable for all outputs. Alias -i + +*--markdown [filename/wildcard/url]* +markdown smart text (not available) + +*--monolingual* +see --i18n-* + +*--multilingual* +see --i18n-* + +*-N [filename/wildcard/url]* +see --digests + +*-n [filename/wildcard/url]* +skip the creation of intermediate processing files (document abstraction) if +they already exist, this skips the equivalent of -m which is otherwise assumed +by most processing flags. + +*--no-** +see --exc-* + +*--no-stop* +override stop processing on error. Alias --erros-as-warnings + +*--numbering* +turn on "object citation numbers". See --inc-ocn and --exc-ocn + +*-o [filename/wildcard/url]* +see --odt + +*--ocn* +"object citation numbers". See --inc-ocn and --exc-ocn + +*--odf [filename/wildcard/url]* +see --odt + +*--odt [filename/wildcard/url]* +output basic document in opendocument file format (opendocument.odt). Alias -o + +*--output-by-** +select output directory structure from 3 alternatives: --output-by-language, +(language directory (based on language code) with filetype (html, epub, pdf +etc.) subdirectories); --output-by-filetype, (filetype directories with +language code as part of filename); --output-by-filename, (filename directories +with language code as part of filename). This is configurable. Alias --by-* + +*-P [language_directory/filename language_directory]* +see --po4a + +*-p [filename/wildcard]* +see --pdf + +*--papersize-(a4|a5|b5|letter|legal)* +in conjunction with --pdf set pdf papersize, overriding any configuration +settings, to set more than one papersize repeat the option --pdf --papersize-a4 +--papersize-letter. See also --papersize=* + +*--papersize=a4,a5,b5,letter,legal* in conjunction with --pdf set pdf +papersize, overriding any configuration settings, to set more than one +papersize list after the equal sign with a comma separator +--papersize=a4,letter. See also --papersize-* + +*--pdf [filename/wildcard]* +produces /LaTeX/ pdf (portrait.pdf & landscape.pdf). Orientation and papersize +may be set on the command-line. Default paper size is set in config file, or +document header, or provided with additional command line parameter, e.g. +--papersize-a4 preset sizes include: 'A4', U.S. 'letter' and 'legal' and book +sizes 'A5' and 'B5' (system defaults to A4), and; --landscape or --portrait, +so: e.g. "sisu --pdf-a4 --pdf-letter --landscape --verbose [filename/wildcard]" +or "sisu --pdf --landscape --a4 --letter --verbose [filename/wildcard]". --pdf +defaults to both landscape & portrait output, and a4 if no other papersizes are +configured. Related options --pdf-landscape --pdf-portrait --pdf-papersize-* +--pdf-papersize=[list]. Alias -p + +*--pdf-l [filename/wildcard]* +See --pdf-landscape + +*--pdf-landscape [filename/wildcard]* +sets orientation, produces /LaTeX/ pdf landscape.pdf. Default paper size is set +in config file, or document header, or provided with additional command line +parameter, e.g. --papersize-a4 preset sizes include: 'A4', U.S. 'letter' and +'legal' and book sizes 'A5' and 'B5' (system defaults to A4). Related options +--pdf --pdf-portrait. See also --papersize-* or --papersize=[list]. Alias +--pdf-l or in conjunction with --pdf --landscape + +*--pdf-p [filename/wildcard]* +See --pdf-portrait + +*--pdf-portrait [filename/wildcard]* +sets orientation, produces /LaTeX/ pdf portrait.pdf.pdf. Default paper size is +set in config file, or document header, or provided with additional command +line parameter, e.g. --papersize-a4 preset sizes include: 'A4', U.S. 'letter' +and 'legal' and book sizes 'A5' and 'B5' (system defaults to A4). Related +options --pdf --pdf-landscape. See also --papersize-* or --papersize=[list]. +Alias --pdf-p or in conjunction with --pdf --portrait + +*--pg-[instruction] [filename]* +database /PostgreSQL/ ( --pgsql may be used instead) possible instructions, +include: --pg-createdb; --pg-create; --pg-dropall; --pg-import [filename]; +--pg-update [filename]; --pg-remove [filename]; see database section below. + +*--po [language_directory/filename language_directory]* +see --po4a + +*--po4a [language_directory/filename language_directory]* +produces .pot and po files for the file in the languages specified by the +language directory. *SiSU* markup is placed in subdirectories named with the +language code, e.g. en/ fr/ es/. The sisu config file must set the output +directory structure to multilingual. v3, experimental + +*-Q [filename/wildcard]* +see --qrcode + +*-q [filename/wildcard]* +see --quiet + +*--qrcode [filename/wildcard]* +generate QR code image of metadata (used in manifest). + +*--quiet [filename/wildcard]* +quiet less output to screen. + +*-R [filename/wildcard]* +see --rsync + +*-r [filename/wildcard]* +see --scp + +*--redirect[=directory_path] [filename/wildcard]* +places output in subdirectory under specified directory, subdirectory uses the +filename (without the suffix). If no output directory is specified places the +subdirectory under the current directory (pwd). Unlike using default settings +/HTML/ files have embedded css. Compare --dump + +*--rst [filename/wildcard/url]* +ReST (rST restructured text) smart text (not available) + +*--rsync [filename/wildcard]* +copies sisu output files to remote host using rsync. This requires that +sisurc.yml has been provided with information on hostname and username, and +that you have your "keys" and ssh agent in place. Note the behavior of rsync +different if -R is used with other flags from if used alone. Alone the rsync +--delete parameter is sent, useful for cleaning the remote directory (when -R +is used together with other flags, it is not). Also see --scp. Alias -R + +*-S* +see --sisupod + +*-S [filename/wildcard]* +see --sisupod + +*-s [filename/wildcard]* +see --source + +*--sample-search-form [--db-(pg|sqlite)]* +generate examples of (naive) cgi search form for /SQLite/ or PgSQL depends on +your already having used sisu to populate an /SQLite/ or PgSQL database, (the +/SQLite/ version scans the output directories for existing sisu_sqlite +databases, so it is first necessary to create them, before generating the +search form) see --sqlite & --pg and the database section below. Optional +additional parameters: --db-user='www-data'. The samples are dumped in the +present work directory which must be writable, (with screen instructions given +that they be copied to the cgi-bin directory). Alias -F + +*--sax [filename/wildcard/url]* +see --xml-sax + +*--scp [filename/wildcard]* +copies sisu output files to remote host using scp. This requires that +sisurc.yml has been provided with information on hostname and username, and +that you have your "keys" and ssh agent in place. Also see --rsync. Alias -r + +*--sha256* +set hash digest where used to sha256 + +*--sha512* +set hash digest where used to sha512 + +*--sqlite-[instruction] [filename]* +database type set to /SQLite/, this produces one of two possible databases, +without additional database related instructions it produces a discreet +/SQLite/ file for the document processed; with additional instructions it +produces a common /SQLite/ database of all processed documents that (come from +the same document preparation directory and as a result) share the same output +directory base path (possible instructions include: --sqlite-createdb; +--sqlite-create; --sqlite-dropall; --sqlite-import [filename]; --sqlite-update +[filename]; --sqlite-remove [filename]); see database section below. + +*--sisupod* +produces a sisupod a zipped sisu directory of markup files including sisu +markup source files and the directories local configuration file, images and +skins. Note: this only includes the configuration files or skins contained in +./_sisu not those in ~/.sisu -S [filename/wildcard] option. Note: (this option +is tested only with zsh). Alias -S + +*--sisupod [filename/wildcard]* +produces a zipped file of the prepared document specified along with associated +images, by default named sisupod.zip they may alternatively be named with the +filename extension .ssp This provides a quick way of gathering the relevant +parts of a sisu document which can then for example be emailed. A sisupod +includes sisu markup source file, (along with associated documents if a master +file, or available in multilingual versions), together with related images and +skin. *SiSU* commands can be run directly against a sisupod contained in a +local directory, or provided as a url on a remote site. As there is a security +issue with skins provided by other users, they are not applied unless the flag +--trust or --trusted is added to the command instruction, it is recommended +that file that are not your own are treated as untrusted. The directory +structure of the unzipped file is understood by sisu, and sisu commands can be +run within it. Note: if you wish to send multiple files, it quickly becomes +more space efficient to zip the sisu markup directory, rather than the +individual files for sending). See the -S option without [filename/wildcard]. +Alias -S + +*--source [filename/wildcard]* +copies sisu markup file to output directory. Alias -s + +*--strict* +together with --html, produces more w3c compliant html, for example not having +purely numeric identifiers for text, the location object url#33 becomes url#o33 + +*-T [filename/wildcard (*.termsheet.rb)]* +standard form document builder, preprocessing feature + +*-t [filename/wildcard]* +see --txt + +*--texinfo [filename/wildcard]* +produces texinfo and info file, (view with pinfo). Alias -I + +*--textile [filename/wildcard/url]* +textile smart text (not available) + +*--txt [filename/wildcard]* +produces /plaintext/ with Unix linefeeds and without markup, (object numbers +are omitted), has footnotes at end of each paragraph that contains them [ -A +for equivalent dos (linefeed) output file] [see -e for endnotes]. (Options +include: --endnotes for endnotes --footnotes for footnotes at the end of each +paragraph --unix for unix linefeed (default) --msdos for msdos linefeed). Alias +-t + +*--txt-asciidoc [filename/wildcard]* +see --asciidoc + +*--txt-markdown [filename/wildcard]* +see --markdown + +*--txt-rst [filename/wildcard]* +see --rst + +*--txt-textile [filename/wildcard]* +see --textile + +*-U [filename/wildcard]* +see --urls + +*-u [filename/wildcard]* +provides url mapping of output files for the flags requested for processing, +also see -U + +*--urls [filename/wildcard]* +prints url output list/map for the available processing flags options and +resulting files that could be requested, (can be used to get a list of +processing options in relation to a file, together with information on the +output that would be produced), -u provides url output mapping for those flags +requested for processing. The default assumes sisu_webrick is running and +provides webrick url mappings where appropriate, but these can be switched to +file system paths in sisurc.yml. Alias -U + +*-V* +on its own, provides *SiSU* version and environment information (sisu --help +env) + +*-V [filename/wildcard]* +even more verbose than the -v flag. + +*-v* +on its own, provides *SiSU* version information + +*-v [filename/wildcard]* +see --verbose + +*--verbose [filename/wildcard]* +provides verbose output of what is being generated, where output is placed (and +error messages if any), as with -u flag provides a url mapping of files created +for each of the processing flag requests. Alias -v + +*--very-verbose [filename/wildcard]* +provides more verbose output of what is being generated. See --verbose. Alias +-V + +*--version* +sisu version + +*-W* +see --webrick + +*-w [filename/wildcard]* +see --concordance + +*--webrick* +starts ruby' s webrick webserver points at sisu output directories, the default +port is set to 8081 and can be changed in the resource configuration files. +[tip: the webrick server requires link suffixes, so html output should be +created using the -h option rather than -H ; also, note -F webrick ]. Alias -W + +*--wordmap [filename/wildcard]* +see --concordance + +*--xhtml [filename/wildcard]* +produces xhtml//XML/ output for browser viewing (sax parsing). Alias -b + +*--xml-dom [filename/wildcard]* +produces /XML/ output with deep document structure, in the nature of dom. Alias +-X + +*--xml-sax [filename/wildcard]* +produces /XML/ output shallow structure (sax parsing). Alias -x + +*-X [filename/wildcard]* +see --xml-dom + +*-x [filename/wildcard]* +see --xml-sax + +*-Y [filename/wildcard]* +produces a short sitemap entry for the document, based on html output and the +sisu_manifest. --sitemaps generates/updates the sitemap index of existing +sitemaps. (Experimental, [g,y,m announcement this week]) + +*-y [filename/wildcard]* +see --manifest + +*-Z [filename/wildcard]* +see --zap + +*--zap [filename/wildcard]* +Zap, if used with other processing flags deletes output files of the type about +to be processed, prior to processing. If -Z is used as the lone processing +related flag (or in conjunction with a combination of -[mMvVq]), will remove +the related document output directory. Alias -Z + +COMMAND LINE MODIFIERS +---------------------- + +*--no-ocn* +[with --html --pdf or --epub] switches off /object citation numbering/. Produce +output without identifying numbers in margins of html or /LaTeX//pdf output. + +*--no-annotate* +strips output text of editor endnotes[^*1] denoted by asterisk or dagger/plus +sign + +*--no-asterisk* +strips output text of editor endnotes[^*2] denoted by asterisk sign + +*--no-dagger* +strips output text of editor endnotes[^+1] denoted by dagger/plus sign + +DATABASE COMMANDS +----------------- + +*dbi - database interface* + +*--pg or --pgsql* set for /PostgreSQL/ *--sqlite* default set for /SQLite/ -d +is modifiable with --db=[database type (PgSQL or /SQLite/) ] + +*--pg -v --createall* +initial step, creates required relations (tables, indexes) in existing +/PostgreSQL/ database (a database should be created manually and given the same +name as working directory, as requested) (rb.dbi) [ -dv --createall /SQLite/ +equivalent] it may be necessary to run sisu -Dv --createdb initially NOTE: at +the present time for /PostgreSQL/ it may be necessary to manually create the +database. The command would be 'createdb [database name]' where database name +would be SiSU_[present working directory name (without path)]. Please use only +alphanumerics and underscores. + +*--pg -v --import* +[filename/wildcard] imports data specified to /PostgreSQL/ db (rb.dbi) [ -dv +--import /SQLite/ equivalent] + +*--pg -v --update* +[filename/wildcard] updates/imports specified data to /PostgreSQL/ db (rb.dbi) +[ -dv --update /SQLite/ equivalent] + +*--pg --remove* +[filename/wildcard] removes specified data to /PostgreSQL/ db (rb.dbi) [ -d +--remove /SQLite/ equivalent] + +*--pg --dropall* +kills data" and drops (/PostgreSQL/ or /SQLite/) db, tables & indexes [ -d +--dropall /SQLite/ equivalent] + +The -v is for verbose output. + +COMMAND LINE WITH FLAGS - BATCH PROCESSING +.......................................... + +In the data directory run sisu -mh filename or wildcard eg. "sisu -h cisg.sst" +or "sisu -h *.{sst,ssm}" to produce html version of all documents. + +Running sisu (alone without any flags, filenames or wildcards) brings up the +interactive help, as does any sisu command that is not recognised. Enter to +escape. + +INTRODUCTION TO SISU MARKUP[^3] +------------------------------- + +SUMMARY +....... + +*SiSU* source documents are /plaintext/ (/UTF-8/)[^4] files + +All paragraphs are separated by an empty line. + +Markup is comprised of: + +- at the top of a document, the document header made up of semantic meta-data +about the document and if desired additional processing instructions (such an +instruction to automatically number headings from a particular level down) + +- followed by the prepared substantive text of which the most important single +characteristic is the markup of different heading levels, which define the +primary outline of the document structure. Markup of substantive text includes: + + * heading levels defines document structure + + * text basic attributes, italics, bold etc. + + * grouped text (objects), which are to be treated differently, such as code + blocks or poems. + + * footnotes/endnotes + + * linked text and images + + * paragraph actions, such as indent, bulleted, numbered-lists, etc. + +MARKUP RULES, DOCUMENT STRUCTURE AND METADATA REQUIREMENTS +.......................................................... + +minimal content/structure requirement: + +[metadata] + +A~ (level A [title]) + +1~ (at least one level 1 [segment/(chapter)]) + +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 *() +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 *() + +*(B~ if none other used; + if C~ is last used: C~ or B~; + if D~ is used: D~, C~ or B~) + +- 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) + +MARKUP EXAMPLES +............... + + +---------------------------------------- + +ONLINE +...... + +Online markup examples are available together with the respective outputs +produced from or from + + +There is of course this document, which provides a cursory overview of sisu +markup and the respective output produced: + + +an alternative presentation of markup syntax: +/usr/share/doc/sisu/on_markup.txt.gz + + +---------------------------------------- + +INSTALLED +......... + +With *SiSU* installed sample skins may be found in: +/usr/share/doc/sisu/markup-samples (or equivalent directory) and if sisu +-markup-samples is installed also under: +/usr/share/doc/sisu/markup-samples-non-free + +MARKUP OF HEADERS +----------------- + +Headers contain either: semantic meta-data about a document, which can be used +by any output module of the program, or; processing instructions. + +Note: the first line of a document may include information on the markup +version used in the form of a comment. Comments are a percentage mark at the +start of a paragraph (and as the first character in a line of text) followed by +a space and the comment: + +% this would be a comment + +SAMPLE HEADER +............. + +This current document is loaded by a master document that has a header similar +to this one: + +% SiSU master 4.0 + +@title: SiSU + :subtitle: Manual + +@creator: + :author: Amissah, Ralph + +@publisher: [publisher name] + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@classify: + :topic_register: SiSU:manual;electronic documents:SiSU:manual + :subject: ebook, epublishing, electronic book, electronic publishing, + electronic document, electronic citation, data structure, + citation systems, search + +% used_by: manual + +@date: + :published: 2008-05-22 + :created: 2002-08-28 + :issued: 2002-08-28 + :available: 2002-08-28 + :modified: 2010-03-03 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :bold: /Gnu|Debian|Ruby|SiSU/ + :home_button_text: {SiSU}http://sisudoc.org; {git}http://git.sisudoc.org + :footer: {SiSU}http://sisudoc.org; {git}http://git.sisudoc.org + :manpage: name=sisu - documents: markup, structuring, publishing in multiple standard formats, and search; + synopsis=sisu [-abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0-9] [filename/wildcard ] + . sisu [-Ddcv] [instruction] + . sisu [-CcFLSVvW] + +@links: + { SiSU Homepage }http://www.sisudoc.org/ + { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/ + { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU Git repo }http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=summary + { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + +AVAILABLE HEADERS +................. + +Header tags appear at the beginning of a document and provide meta information +on the document (such as the /Dublin Core/) , or information as to how the +document as a whole is to be processed. All header instructions take the form +@headername: or on the next line and indented by once space :subheadername: All +/Dublin Core/ meta tags are available + +*@identifier:* information or instructions + +where the "identifier" is a tag recognised by the program, and the +"information" or "instructions" belong to the tag/identifier specified + +Note: a header where used should only be used once; all headers apart from +@title: are optional; the @structure: header is used to describe document +structure, and can be useful to know. + +This is a sample header + +% SiSU 2.0 [declared file-type identifier with markup version] + +@title: [title text] [this header is the only one that is mandatory] + :subtitle: [subtitle if any] + :language: English + +@creator: + :author: [Lastname, First names] + :illustrator: [Lastname, First names] + :translator: [Lastname, First names] + :prepared_by: [Lastname, First names] + +@date: + :published: [year or yyyy-mm-dd] + :created: [year or yyyy-mm-dd] + :issued: [year or yyyy-mm-dd] + :available: [year or yyyy-mm-dd] + :modified: [year or yyyy-mm-dd] + :valid: [year or yyyy-mm-dd] + :added_to_site: [year or yyyy-mm-dd] + :translated: [year or yyyy-mm-dd] + +@rights: + :copyright: Copyright (C) [Year and Holder] + :license: [Use License granted] + :text: [Year and Holder] + :translation: [Name, Year] + :illustrations: [Name, Year] + +@classify: + :topic_register: SiSU:markup sample:book;book:novel:fantasy + :type: + :subject: + :description: + :keywords: + :abstract: + :loc: [Library of Congress classification] + :dewey: [Dewey classification + +@identify: + :isbn: [ISBN] + :oclc: + +@links: { SiSU }http://www.sisudoc.org + { FSF }http://www.fsf.org + +@make: + :num_top: 1 + :headings: [text to match for each level + (e.g. PART; Chapter; Section; Article; or another: none; BOOK|FIRST|SECOND; none; CHAPTER;) + :breaks: new=:C; break=1 + :promo: sisu, ruby, sisu_search_libre, open_society + :bold: [regular expression of words/phrases to be made bold] + :italics: [regular expression of words/phrases to italicise] + :home_button_text: {SiSU}http://sisudoc.org; {git}http://git.sisudoc.org + :footer: {SiSU}http://sisudoc.org; {git}http://git.sisudoc.org + +@original: + :language: [language] + +@notes: + :comment: + :prefix: [prefix is placed just after table of contents] + +MARKUP OF SUBSTANTIVE TEXT +-------------------------- + +HEADING LEVELS +.............. + +Heading levels are :A~ ,:B~ ,:C~ ,1~ ,2~ ,3~ ... :A - :C being part / section +headings, followed by other heading levels, and 1 -6 being headings followed by +substantive text or sub-headings. :A~ usually the title :A~? conditional level +1 heading (used where a stand-alone document may be imported into another) + +*:A~ [heading text]* Top level heading [this usually has similar content to the +title @title: ] NOTE: the heading levels described here are in 0.38 notation, +see heading + +*:B~ [heading text]* Second level heading [this is a heading level divider] + +*:C~ [heading text]* Third level heading [this is a heading level divider] + +*1~ [heading text]* Top level heading preceding substantive text of document or +sub-heading 2, the heading level that would normally be marked 1. or 2. or 3. +etc. in a document, and the level on which sisu by default would break html +output into named segments, names are provided automatically if none are given +(a number), otherwise takes the form 1~my_filename_for_this_segment + +*2~ [heading text]* Second level heading preceding substantive text of document +or sub-heading 3 , the heading level that would normally be marked 1.1 or 1.2 +or 1.3 or 2.1 etc. in a document. + +*3~ [heading text]* Third level heading preceding substantive text of document, +that would normally be marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a +document + +1~filename level 1 heading, + +% the primary division such as Chapter that is followed by substantive text, and may be further subdivided (this is the level on which by default html segments are made) + +FONT ATTRIBUTES +............... + +*markup example:* + +normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}", +^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}-, #{monospace}# + +normal text + +*{emphasis}* [note: can be configured to be represented by bold, italics or underscore] + +!{bold text}! + +/{italics}/ + +_{underscore}_ + +"{citation}" + +^{superscript}^ + +,{subscript}, + ++{inserted text}+ + +-{strikethrough}- + +#{monospace}# + +*resulting output:* + +normal text, *emphasis*, *bold text*, /italics/, _underscore_, "citation", +^superscript^, [subscript], +inserted text+, -strikethrough-, #monospace# + +normal text + +*emphasis* [note: can be configured to be represented by bold, italics or +underscore] + +*bold text* + +/italics/ + +_underscore_ + +"citation" + +^superscript^ + +[subscript] + ++inserted text+ + +-strikethrough- + +#monospace# + +INDENTATION AND BULLETS +....................... + +*markup example:* + +ordinary paragraph + +_1 indent paragraph one step + +_2 indent paragraph two steps + +_9 indent paragraph nine steps + +*resulting output:* + +ordinary paragraph + + indent paragraph one step + + indent paragraph two steps + + indent paragraph nine steps + +*markup example:* + +_* bullet text + +_1* bullet text, first indent + +_2* bullet text, two step indent + +*resulting output:* + +- bullet text + + * bullet text, first indent + + * bullet text, two step indent + +Numbered List (not to be confused with headings/titles, (document structure)) + +*markup example:* + +# numbered list numbered list 1., 2., 3, etc. + +_# numbered list numbered list indented a., b., c., d., etc. + +HANGING INDENTS +............... + +*markup example:* + +_0_1 first line no indent, +rest of paragraph indented one step + +_1_0 first line indented, +rest of paragraph no indent + +in each case level may be 0-9 + +*resulting output:* + +first line no indent, rest of paragraph indented one step; first line no + indent, rest of paragraph indented one step; first line no indent, rest of + paragraph indented one step; first line no indent, rest of paragraph indented + one step; first line no indent, rest of paragraph indented one step; first + line no indent, rest of paragraph indented one step; first line no indent, + rest of paragraph indented one step; first line no indent, rest of paragraph + indented one step; first line no indent, rest of paragraph indented one step; + +A regular paragraph. + + first line indented, rest of paragraph no indent first line indented, rest of +paragraph no indent first line indented, rest of paragraph no indent first line +indented, rest of paragraph no indent first line indented, rest of paragraph no +indent first line indented, rest of paragraph no indent first line indented, +rest of paragraph no indent first line indented, rest of paragraph no indent +first line indented, rest of paragraph no indent first line indented, rest of +paragraph no indent first line indented, rest of paragraph no indent + +in each case level may be 0-9 + +*live-build* A collection of scripts used to build customized *Debian* + Livesystems. /live-build/ was formerly known as live-helper, and even earlier + known as live-package. + +*live-build* + A collection of scripts used to build customized *Debian* Livesystems. + /live-build/ was formerly known as live-helper, and even earlier known as + live-package. + +FOOTNOTES / ENDNOTES +.................... + +Footnotes and endnotes are marked up at the location where they would be +indicated within a text. They are automatically numbered. The output type +determines whether footnotes or endnotes will be produced + +*markup example:* + +~{ a footnote or endnote }~ + +*resulting output:* + +[^5] + +*markup example:* + +normal text~{ self contained endnote marker & endnote in one }~ continues + +*resulting output:* + +normal text[^6] continues + +*markup example:* + +normal text ~{* unnumbered asterisk footnote/endnote, insert multiple asterisks if required }~ continues + +normal text ~{** another unnumbered asterisk footnote/endnote }~ continues + +*resulting output:* + +normal text [^*] continues + +normal text [^**] continues + +*markup example:* + +normal text ~[* editors notes, numbered asterisk footnote/endnote series ]~ continues + +normal text ~[+ editors notes, numbered plus symbol footnote/endnote series ]~ continues + +*resulting output:* + +normal text [^*3] continues + +normal text [^+2] continues + +*Alternative endnote pair notation for footnotes/endnotes:* + +% note the endnote marker "~^" + +normal text~^ continues + +^~ endnote text following the paragraph in which the marker occurs + +the standard and pair notation cannot be mixed in the same document + +LINKS +..... + + +---------------------------------------- + +NAKED URLS WITHIN TEXT, DEALING WITH URLS +......................................... + +urls found within text are marked up automatically. A url within text is +automatically hyperlinked to itself and by default decorated with angled +braces, unless they are contained within a code block (in which case they are +passed as normal text), or escaped by a preceding underscore (in which case the +decoration is omitted). + +*markup example:* + +normal text http://www.sisudoc.org/ continues + +*resulting output:* + +normal text continues + +An escaped url without decoration + +*markup example:* + +normal text _http://www.sisudoc.org/ continues + +deb _http://www.jus.uio.no/sisu/archive unstable main non-free + +*resulting output:* + +normal text http://www.sisudoc.org/ continues + +deb http://www.jus.uio.no/sisu/archive unstable main non-free + +where a code block is used there is neither decoration nor hyperlinking, code +blocks are discussed later in this document + +*resulting output:* + +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 + + +---------------------------------------- + +LINKING TEXT +............ + +To link text or an image to a url the markup is as follows + +*markup example:* + +about { SiSU }http://url.org markup + +*resulting output:* + +about SiSU [link: ] markup + +A shortcut notation is available so the url link may also be provided +automatically as a footnote + +*markup example:* + +about {~^ SiSU }http://url.org markup + +*resulting output:* + +about SiSU [link: ] [^7] markup + +Internal document links to a tagged location, including an ocn + +*markup example:* + +about { text links }#link_text + +*resulting output:* + +about text links + +Shared document collection link + +*markup example:* + +about { SiSU book markup examples }:SiSU/examples.html + +*resulting output:* + +about *SiSU* book markup examples + + +---------------------------------------- + +LINKING IMAGES +.............. + +*markup example:* + +{ tux.png 64x80 }image + +% various url linked images +[image: "a better way"] + [image: "Way Better - with Gnu/Linux, Debian and Ruby"] + +{~^ ruby_logo.png "Ruby" }http://www.ruby-lang.org/en/ + +*resulting output:* + +tux.png 64x80 [link: local image] + +tux.png 64x80 "Gnu/Linux - a better way" [link: ] + +GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian +and Ruby" [link: ] + +ruby_logo.png 70x90 "Ruby" [link: ] [^8] + +*linked url footnote shortcut* + +{~^ [text to link] }http://url.org + +% maps to: { [text to link] }http://url.org ~{ http://url.org }~ + +% which produces hyper-linked text within a document/paragraph, with an endnote providing the url for the text location used in the hyperlink + +text marker *~name + +note at a heading level the same is automatically achieved by providing names +to headings 1, 2 and 3 i.e. 2~[name] and 3~[name] or in the case of +auto-heading numbering, without further intervention. + + +---------------------------------------- + +LINK SHORTCUT FOR MULTIPLE VERSIONS OF A SISU DOCUMENT IN THE SAME DIRECTORY +TREE +.............................................................................. + +*markup example:* + +!_ /{"Viral Spiral"}/, David Bollier + +{ "Viral Spiral", David Bollier [3sS]}viral_spiral.david_bollier.sst + +*/"Viral Spiral"/, David Bollier* + +"Viral Spiral", David Bollier [link: ] + document manifest [link: ] + html, segmented text [link: ] + html, scroll, document in one [link: ] + epub [link: ] + pdf, landscape [link: ] + pdf, portrait [link: ] + odf: odt, open document text [link: ] + xhtml scroll [link: ] + xml, sax [link: ] + xml, dom [link: ] + concordance [link: ] + dcc, document content certificate (digests) [link: ] + markup source text [link: ] + markup source (zipped) pod [link: ] + +GROUPED TEXT / BLOCKED TEXT +........................... + +There are two markup syntaxes for blocked text, using curly braces or using +tics + + +---------------------------------------- + +BLOCKED TEXT CURLY BRACE SYNTAX +............................... + +at the start of a line on its own use name of block type with an opening curly +brace, follow with the content of the block, and close with a closing curly +brace and the name of the block type, e.g. + +code{ +this is a code block + +}code + +poem{ + +this here is a poem + +}poem + + +---------------------------------------- + +BLOCKED TEXT TIC SYNTAX +....................... + +``` code +this is a code block + +``` + +``` poem + +this here is a poem + +``` + +start a line with three backtics, a space followed by the name of the name of +block type, follow with the content of the block, and close with three back +ticks on a line of their own, e.g. + + +---------------------------------------- + +TABLES +...... + +Tables may be prepared in two either of two forms + +*markup example:* + +table{ c3; 40; 30; 30; + +This is a table +this would become column two of row one +column three of row one is here + +And here begins another row +column two of row two +column three of row two, and so on + +}table + +*resulting output:* + +This is a table┆this would become column two of row one┆column three of row one is here』And here begins another row┆column two of row two┆column three of row two, and so on』 + +a second form may be easier to work with in cases where there is not much +information in each column + +*markup example:*[^9] + +!_ Table 3.1: Contributors to Wikipedia, January 2001 - June 2005 + +{table~h 24; 12; 12; 12; 12; 12; 12;} + |Jan. 2001|Jan. 2002|Jan. 2003|Jan. 2004|July 2004|June 2006 +Contributors* | 10| 472| 2,188| 9,653| 25,011| 48,721 +Active contributors** | 9| 212| 846| 3,228| 8,442| 16,945 +Very active contributors*** | 0| 31| 190| 692| 1,639| 3,016 +No. of English language articles| 25| 16,000| 101,000| 190,000| 320,000| 630,000 +No. of articles, all languages | 25| 19,000| 138,000| 490,000| 862,000|1,600,000 + +- Contributed at least ten times; ** at least 5 times in last month; *** more than 100 times in last month. + +*resulting output:* + +*Table 3.1: Contributors to Wikipedia, January 2001 - June 2005* + +┆Jan. 2001┆Jan. 2002┆Jan. 2003┆Jan. 2004┆July 2004┆June 2006』Contributors*┆10┆472┆2,188┆9,653┆25,011┆48,721』Active contributors**┆9┆212┆846┆3,228┆8,442┆16,945』Very active contributors***┆0┆31┆190┆692┆1,639┆3,016』No. of English language articles┆25┆16,000┆101,000┆190,000┆320,000┆630,000』No. of articles, all languages┆25┆19,000┆138,000┆490,000┆862,000┆1,600,000』 + +- Contributed at least ten times; ** at least 5 times in last month; *** more +than 100 times in last month. + + +---------------------------------------- + +POEM +.... + +*basic markup:* + +poem{ + + Your poem here + +}poem + +Each verse in a poem is given an object number. + +*markup example:* + +poem{ + + `Fury said to a + mouse, That he + met in the + house, + "Let us + both go to + law: I will + prosecute + YOU. --Come, + I'll take no + denial; We + must have a + trial: For + really this + morning I've + nothing + to do." + Said the + mouse to the + cur, "Such + a trial, + dear Sir, + With + no jury + or judge, + would be + wasting + our + breath." + "I'll be + judge, I'll + be jury," + Said + cunning + old Fury: + "I'll + try the + whole + cause, + and + condemn + you + to + death."' + +}poem + +*resulting output:* + + `Fury said to a + mouse, That he + met in the + house, + "Let us + both go to + law: I will + prosecute + YOU. --Come, + I'll take no + denial; We + must have a + trial: For + really this + morning I've + nothing + to do." + Said the + mouse to the + cur, "Such + a trial, + dear Sir, + With + no jury + or judge, + would be + wasting + our + breath." + "I'll be + judge, I'll + be jury," + Said + cunning + old Fury: + "I'll + try the + whole + cause, + and + condemn + you + to + death."' + + +---------------------------------------- + +GROUP +..... + +*basic markup:* + +group{ + + Your grouped text here + +}group + +A group is treated as an object and given a single object number. + +*markup example:* + +group{ + + `Fury said to a + mouse, That he + met in the + house, + "Let us + both go to + law: I will + prosecute + YOU. --Come, + I'll take no + denial; We + must have a + trial: For + really this + morning I've + nothing + to do." + Said the + mouse to the + cur, "Such + a trial, + dear Sir, + With + no jury + or judge, + would be + wasting + our + breath." + "I'll be + judge, I'll + be jury," + Said + cunning + old Fury: + "I'll + try the + whole + cause, + and + condemn + you + to + death."' + +}group + +*resulting output:* + + `Fury said to a + mouse, That he + met in the + house, + "Let us + both go to + law: I will + prosecute + YOU. --Come, + I'll take no + denial; We + must have a + trial: For + really this + morning I've + nothing + to do." + Said the + mouse to the + cur, "Such + a trial, + dear Sir, + With + no jury + or judge, + would be + wasting + our + breath." + "I'll be + judge, I'll + be jury," + Said + cunning + old Fury: + "I'll + try the + whole + cause, + and + condemn + you + to + death."' + + +---------------------------------------- + +CODE +.... + +Code tags # code{ ... }code # (used as with other group tags described above) +are used to escape regular sisu markup, and have been used extensively within +this document to provide examples of *SiSU* markup. You cannot however use code +tags to escape code tags. They are however used in the same way as group or +poem tags. + +A code-block is treated as an object and given a single object number. [an +option to number each line of code may be considered at some later time] + +*use of code tags instead of poem compared, resulting output:* + + `Fury said to a + mouse, That he + met in the + house, + "Let us + both go to + law: I will + prosecute + YOU. --Come, + I'll take no + denial; We + must have a + trial: For + really this + morning I've + nothing + to do." + Said the + mouse to the + cur, "Such + a trial, + dear Sir, + With + no jury + or judge, + would be + wasting + our + breath." + "I'll be + judge, I'll + be jury," + Said + cunning + old Fury: + "I'll + try the + whole + cause, + and + condemn + you + to + death."' + +From *SiSU* 2.7.7 on you can number codeblocks by placing a hash after the +opening code tag # code{# # as demonstrated here: + +1 ┆ `Fury said to a +2 ┆ mouse, That he +3 ┆ met in the +4 ┆ house, +5 ┆ "Let us +6 ┆ both go to +7 ┆ law: I will +8 ┆ prosecute +9 ┆ YOU. --Come, +10 ┆ I'll take no +11 ┆ denial; We +12 ┆ must have a +13 ┆ trial: For +14 ┆ really this +15 ┆ morning I've +16 ┆ nothing +17 ┆ to do." +18 ┆ Said the +19 ┆ mouse to the +20 ┆ cur, "Such +21 ┆ a trial, +22 ┆ dear Sir, +23 ┆ With +24 ┆ no jury +25 ┆ or judge, +26 ┆ would be +27 ┆ wasting +28 ┆ our +29 ┆ breath." +30 ┆ "I'll be +31 ┆ judge, I'll +32 ┆ be jury," +33 ┆ Said +34 ┆ cunning +35 ┆ old Fury: +36 ┆ "I'll +37 ┆ try the +38 ┆ whole +39 ┆ cause, +40 ┆ and +41 ┆ condemn +42 ┆ you +43 ┆ to +44 ┆ death."' + +ADDITIONAL BREAKS - LINEBREAKS WITHIN OBJECTS, COLUMN AND PAGE-BREAKS +..................................................................... + + +---------------------------------------- + +LINE-BREAKS +........... + +To break a line within a "paragraph object", two backslashes \\ +with a space before and a space or newline after them +may be used. + +To break a line within a "paragraph object", +two backslashes \\ with a space before +and a space or newline after them \\ +may be used. + +The html break br enclosed in angle brackets (though undocumented) is available +in versions prior to 3.0.13 and 2.9.7 (it remains available for the time being, +but is depreciated). + +To draw a dividing line dividing paragraphs, see the section on page breaks. + + +---------------------------------------- + +PAGE BREAKS +........... + +Page breaks are only relevant and honored in some output formats. A page break +or a new page may be inserted manually using the following markup on a line on +its own: + +page new =\= breaks the page, starts a new page. + +page break -\- breaks a column, starts a new column, if using columns, else +breaks the page, starts a new page. + +page break line across page -..- draws a dividing line, dividing paragraphs + +page break: + +-\\- + +page (break) new: + +=\\= + +page (break) line across page (dividing paragraphs): + +-..- + +BIBLIOGRAPHY / REFERENCES +......................... + +There are three ways to prepare a bibliography using sisu (which are mutually +exclusive): (i) manually preparing and marking up as regular text in sisu a +list of references, this is treated as a regular document segment (and placed +before endnotes if any); (ii) preparing a bibliography, marking a heading level +1~!biblio (note the exclamation mark) and preparing a bibliography using +various metadata tags including for author: title: year: a list of which is +provided below, or; (iii) as an assistance in preparing a bibliography, marking +a heading level 1~!biblio and tagging citations within footnotes for inclusion, +identifying citations and having a parser attempt to extract them and build a +bibliography of the citations provided. + +For the heading/section sequence: endnotes, bibliography then book index to +occur, the name biblio or bibliography must be given to the bibliography +section, like so: + +1~!biblio + + +---------------------------------------- + +A MARKUP TAGGED METADATA BIBLIOGRAPHY SECTION +............................................. + +Here instead of writing your full citations directly in footnotes, each time +you have new material to cite, you add it to your bibliography section (if it +has not been added yet) providing the information you need against an available +list of tags (provided below). + +The required tags are au: ti: and year: [^10] an short quick example might be +as follows: + +1~!biblio + +au: von Hippel, E. +ti: Perspective: User Toolkits for Innovation +lng: (language) +jo: Journal of Product Innovation Management +vo: 18 +ed: (editor) +yr: 2001 +note: +sn: Hippel, /{User Toolkits}/ (2001) +id: vHippel_2001 +% form: + +au: Benkler, Yochai +ti: The Wealth of Networks +st: How Social Production Transforms Markets and Freedom +lng: (language) +pb: Harvard University Press +edn: (edition) +yr: 2006 +pl: U.S. +url: http://cyber.law.harvard.edu/wealth_of_networks/Main_Page +note: +sn: Benkler, /{Wealth of Networks}/ (2006) +id: Benkler2006 + +au: Quixote, Don; Panza, Sancho +ti: Taming Windmills, Keeping True +jo: Imaginary Journal +yr: 1605 +url: https://en.wikipedia.org/wiki/Don_Quixote +note: made up to provide an example of author markup for an article with two authors +sn: Quixote & Panza, /{Taming Windmills}/ (1605) +id: quixote1605 + +Note that the section name !biblio (or !bibliography) is required for the +bibliography to be treated specially as such, and placed after the +auto-generated endnote section. + +Using this method, work goes into preparing the bibliography, the tags author +or editor, year and title are required and will be used to sort the +bibliography that is placed under the Bibliography section + +The metadata tags may include shortname (sn:) and id, if provided, which are +used for substitution within text. Every time the given id is found within the +text it will be replaced by the given short title of the work (it is for this +reason the short title has sisu markup to italicize the title), it should work +with any page numbers to be added, the short title should be one that can +easily be used to look up the full description in the bibliography. + +The following footnote~{ quixote1605, pp 1000 - 1001, also Benkler2006 p 1. }~ + +would be presented as: + +Quixote and Panza, /Taming Windmills/ (1605), pp 1000 - 1001 also, Benkler, +/Wealth of Networks/, (2006) p 1 or rather[^11] + +au: author Surname, FirstNames (if multiple semi-colon separator) + (required unless editor to be used instead) +ti: title (required) +st: subtitle +jo: journal +vo: volume +ed: editor (required if author not provided) +tr: translator +src: source (generic field where others are not appropriate) +in: in (like src) +pl: place/location (state, country) +pb: publisher +edn: edition +yr: year (yyyy or yyyy-mm or yyyy-mm-dd) (required) +pg: pages +url: http://url +note: note +id: create_short_identifier e.g. authorSurnameYear + (used in substitutions: when found within text will be + replaced by the short name provided) +sn: short name e.g. Author, /{short title}/, Year + (used in substitutions: when an id is found within text + the short name will be used to replace it) + + +---------------------------------------- + +TAGGING CITATIONS FOR INCLUSION IN THE BIBLIOGRAPHY +................................................... + +Here whenever you make a citation that you wish be included in the +bibliography, you tag the citation as such using special delimiters (which are +subsequently removed from the final text produced by sisu) + +Here you would write something like the following, either in regular text or a +footnote + +See .: Quixote, Don; Panza, Sancho /{Taming Windmills, Keeping True}/ (1605) :. + +*SiSU* will parse for a number of patterns within the delimiters to try make +out the authors, title, date etc. and from that create a Bibliography. This is +more limited than the previously described method of preparing a tagged +bibliography, and using an id within text to identify the work, which also +lends itself to greater consistency. + +GLOSSARY +........ + +Using the section name 1~!glossary results in the Glossary being treated +specially as such, and placed after the auto-generated endnote section (before +the bibliography/list of references if there is one). + +The Glossary is ordinary text marked up in a manner deemed suitable for that +purpose. e.g. with the term in bold, possibly with a hanging indent. + +1~!glossary + +_0_1 *{GPL}* An abbreviation that stands for "General Purpose License." ... + +_0_1 [provide your list of terms and definitions] + +In the given example the first line is not indented subsequent lines are by one +level, and the term to be defined is in bold text. + +BOOK INDEX +.......... + +To make an index append to paragraph the book index term relates to it, using +an equal sign and curly braces. + +Currently two levels are provided, a main term and if needed a sub-term. +Sub-terms are separated from the main term by a colon. + + Paragraph containing main term and sub-term. + ={Main term:sub-term} + +The index syntax starts on a new line, but there should not be an empty line +between paragraph and index markup. + +The structure of the resulting index would be: + + Main term, 1 + sub-term, 1 + +Several terms may relate to a paragraph, they are separated by a semicolon. If +the term refers to more than one paragraph, indicate the number of paragraphs. + + Paragraph containing main term, second term and sub-term. + ={first term; second term: sub-term} + +The structure of the resulting index would be: + + First term, 1, + Second term, 1, + sub-term, 1 + +If multiple sub-terms appear under one paragraph, they are separated under the +main term heading from each other by a pipe symbol. + + Paragraph containing main term, second term and sub-term. + ={Main term: + sub-term+2|second sub-term; + Another term + } + + A paragraph that continues discussion of the first sub-term + +The plus one in the example provided indicates the first sub-term spans one +additional paragraph. The logical structure of the resulting index would be: + + Main term, 1, + sub-term, 1-3, + second sub-term, 1, + Another term, 1 + +COMPOSITE DOCUMENTS MARKUP +-------------------------- + +It is possible to build a document by creating a master document that requires +other documents. The documents required may be complete documents that could be +generated independently, or they could be markup snippets, prepared so as to be +easily available to be placed within another text. If the calling document is a +master document (built from other documents), it should be named with the +suffix *.ssm* Within this document you would provide information on the other +documents that should be included within the text. These may be other documents +that would be processed in a regular way, or markup bits prepared only for +inclusion within a master document *.sst* regular markup file, or *.ssi* +(insert/information) A secondary file of the composite document is built prior +to processing with the same prefix and the suffix *._sst* + +basic markup for importing a document into a master document + +<< filename1.sst + +<< filename2.ssi + +The form described above should be relied on. Within the /Vim/ editor it +results in the text thus linked becoming hyperlinked to the document it is +calling in which is convenient for editing. + +SUBSTITUTIONS +------------- + +*markup example:* + +The current Debian is ${debian_stable} the next debian will be ${debian_testing} + +Configure substitution in _sisu/sisu_document_make + +@make: +:substitute: /${debian_stable}/,'*{Wheezy}*' /${debian_testing}/,'*{Jessie}*' + +*resulting output:* + +The current *Debian* is *Jessie* the next debian will be *Stretch* + +Configure substitution in _sisu/sisu_document_make + + +---------------------------------------- + + [1]: + + [2]: from the *Debian* control file + + [*1]: square brackets + + [*2]: square brackets + + [+1]: square brackets + + [3]: From sometime after SiSU 0.58 it should be possible to describe SiSU markup + using SiSU, which though not an original design goal is useful. + + [4]: files should be prepared using /UTF-8/ character encoding + + [5]: a footnote or endnote + + [6]: self contained endnote marker & endnote in one + + [*]: unnumbered asterisk footnote/endnote, insert multiple asterisks if required + + [**]: another unnumbered asterisk footnote/endnote + + [*3]: editors notes, numbered asterisk footnote/endnote series + + [+2]: editors notes, numbered plus symbol footnote/endnote series + + [7]: + + [8]: + + [9]: Table from the Wealth of Networks by Yochai Benkler + + + + [10]: for which you may alternatively use the full form author: title: and year: + + [11]: Quixote and Panza, /Taming Windmills/ (1605), pp 1000 - 1001 also, Benkler, + /Wealth of Networks/ (2006), p 1 + #+END_SRC + +** a description + +(emacs:evil mode gifts a "vim" of enticing "alternative" powers! ;) +(vim, my _editor_ of choice also in the emacs environment :) + +*** What is SiSU? + + Multiple output formats with a nod to the strengths of each output format and + the ability to cite text easily across output formats. + +**** debian/control desc + + documents - structuring, publishing in multiple formats and search + SiSU is a lightweight markup based, command line oriented, document + structuring, publishing and search, static content tool for document + collections. + . + With minimal preparation of a plain-text (UTF-8) file, using sisu markup syntax + in your text editor of choice, SiSU can generate various document formats, most + of which share a common object numbering system for locating content, including + plain text, HTML, XHTML, XML, EPUB, OpenDocument text (ODF:ODT), LaTeX, PDF + files, and populate an SQL database with objects (roughly paragraph-sized + chunks) so searches may be performed and matches returned with that degree of + granularity. Think of being able to finely match text in documents, using + common object numbers, across different output formats and across languages if + you have translations of the same document. For search, your criteria is met + by these documents at these locations within each document (equally relevant + across different output formats and languages). To be clear (if obvious) page + numbers provide none of this functionality. Object numbering is particularly + suitable for "published" works (finalized texts as opposed to works that are + frequently changed or updated) for which it provides a fixed means of reference + of content. Document outputs can also share provided semantic meta-data. + . + SiSU also provides concordance files, document content certificates and + manifests of generated output and the means to make book indexes that make use + of its object numbering. + . + Syntax highlighting and folding (outlining) files are provided for the Vim and + Emacs editors. + . + Dependencies for various features are taken care of in sisu related packages. + The package sisu-complete installs the whole of SiSU. + . + Additional document markup samples are provided in the package + sisu-markup-samples which is found in the non-free archive. The licenses for + the substantive content of the marked up documents provided is that provided + by the author or original publisher. + . + SiSU uses utf-8 & parses left to right. Currently supported languages: + am bg bn br ca cs cy da de el en eo es et eu fi fr ga gl he hi hr hy ia is it + ja ko la lo lt lv ml mr nl nn no oc pl pt pt_BR ro ru sa se sk sl sq sr sv ta + te th tk tr uk ur us vi zh (see XeTeX polyglossia & cjk) + . + SiSU works well under po4a translation management, for which an administrative + sample Rakefile is provided with sisu_manual under markup-samples. + +**** take two + + SiSU may be regarded as an open access document publishing platform, applicable + to a modest but substantial domain of documents (typically law and literature, + but also some forms of technical writing), that is tasked to address certain + challenges I identified as being of interest to me over the years in open + publishing. + + The idea and implementation may be of interest to consider as some of the + issues encountered and that it seeks to address are known and common to such + endeavors. Amongst them: + + * how do you ensure what you do now can be read in decades? + * how do you keep up with new changing and technologies? + * do you select a canonical format to represent your documents, if so + what? + * how do you reliably cite (locate) material in different document + representations? + * how do you deal with multilingual texts? + * what of search? + * how are documents contributed to the collection? + + (these questions are selected in to help describe the direction of efforts with + regard to sisu). + + My Dabblings in the Domain of Open Publishing + --------------------------------------------- + + The system is called SiSU, it is an offshoot of my early efforts at finding out + what to make of the web, that started at the University of Tromsø in 1993 (an + early law website Ananse/ International Trade Law Project / Lex Mercatoria). I + have worked on SiSU continually since 1997 and it has been open source in 2005 + (under a license called GPL3+), though I remain its developer. + + In working in this field I have had to address some of the common issues. + + So how do you ensure what you do now can be read in decades to come? There are + alternative solutions. (i) stick with a widely used and not overly complicated + well document open standard, and for that the likes of odf is an excellent + choice (ii) alternatively go for the most basic representation of a document + that meets your needs, in my case based on UTF-8 text and some markup tags, + fairly easily parsable by the human eye and as long as utf8 is in use it will + always be possible to extract the information + + How do you keep up with new changing and technologies? Here my solution has + been to generate new versions of the substantive content so as to always have + the latest document representations available e.g. HTML has changed a lot over + the years, different specifications come out for various formats including ODF, + electronic readers have become an important viewing alternative, introducing + the open reader format EPUB. Output representations are generated from source + documents. Different open document file formats can be produced and databases + and search engines populated. (The source documents and interpreter are all + that are required to re-create site content. Source documents can be made + public or retained privately). The strict separation of a simple source + document from the output produced, means that with updates to SiSU (the + interpreter/processor/generator), outputs can be updated technically as + necessary, and new output formats added when needed. Amongst the output formats + currently supported are HTML, LaTeX generated Pdfs (A4, letter, other; + landscape, portrait), Epub, Open Document Format text. Returning to HTML as an + example, it has changed a lot over the years I have worked with it, this way of + working has meant it is possible to keep producing current versions of HTML, + retaining the original substantive document... and new formats have been added + as thought desired. There is no attempt to make output in different document + formats/ representations look alike let alone identical. Rather the attempt is + to optimize output for the particular document filetype, (there is no reason + why an epub document would look or behave like an open document text or that a + Pdf would look like HTML output; rather PDF is optimized for paper viewing, + HTML for screen etc.) Wherever possible features associated with the + particular output type are taken advantage of. This freedom is made possible to + a large extent by the answer to the question that follows. + + How do you reliably cite (locate) material in different document + representations? The traditional answer has been to have a canonical + publication, and resulting fixed page numbers. This was not a viable solution + for HTML (which changes from one viewer to another and with selectable font + faces & size etc.); nor is it otherwise ideal in an electronic age with the + possibility of presenting/interacting with material/documents in so many + different ways. Why be so restricted? Here my solution has been "object + citation numbering". What the various generated document formats have in + common is a shared object numbering system that identifies the location of text + and that is available for citation purposes. Object numbers are: sequential + numbers assigned to each identified object in a document. Objects are logical + units of text (or equivalent parts of a document), usually paragraphs, but also + document headings, tables, images, in a poem a verse etc. [In an electronic + publishing age are page numbers the best we can come up with? Change font + type, font size, page orientation, paper size (sometimes even the viewer) and + where are you with them? And paper though a favorite medium of mine is no + longer the sole (or sometimes primary) means of interacting with documents/text + or of sharing knowledge] + + What object numbers mean (unlike page numbers) is e.g. + + * if you cite text in any format, the resulting output can be reliably located + in any other document format type. Cite HTML and the reader can choose to + view in Epub or Pdf (the PDFs being an independent output, generated by + book publishing software XeTeX/LaTeX). + + * if you do a search, you can be given a result "index" indicating that your + search criteria is met by these documents, and at these specific locations + within each document, and the "index" is relevant not only for content + within the database, but for all document formats. + + * if you have a translated text prepared for sisu, then your citations are + relevant across languages e.g. you can specify exactly where in a Chinese + document text is to be found. + + * generated document index references & concordance list references etc. are + relevant across all output formats. + + What of search? For search, see the implications of object numbers for search + mentioned above. The system currently loads an SQL server (Postgresql) with + object sized text chunks. It could just as well populate an analytical engine + with larger sections or chapters of text for analytical purposes (such as the + currently popular Elasticsearch), whilst availing itself also of the concept of + objects and object numbers in search results. + + How do you deal with multilingual texts? If you have translated text prepared + for sisu, then your citations are relevant across languages. Object numbers + also provide an easy way to compare, discuss text (translations) across + languages. Text found/cited in one language has the same object number in its + translations, a given paragraph will be the same in another language, just + change the language code. (documents are prepared in UTF-8, current language + restrictions are: through use of LaTeX tools, Polyglosia & CJK (Chinese, + Japanese & Korean), and from the fact that sisu parses left to right) + + How are materials prepared for contribution to the collection? (a) The easiest + solution if the system allows is for submission in the format in which work is + authored, usually a word processor, for which odf may be a decent selection. + (b) I have stuck with enhanced plaintext, UTF-8 with minimal markup. Source + documents are prepared in UTF-8 text, with a minimalist native markup to + indicate the document structure (headings and their relative levels), + footnotes, and other document "features". This markup is easily parsable to the + human eye, and plays well with version control systems. Documents are prepared + in a text editor. Front ends such as markup assistants in a word processor that + can save to sisu text format or other tool whist possible do not exist. [(c) + yet another form of submission for collaborative work are wikis which have + shown their strength in efforts such as Wikipedia.] + + The system has proven to be a good testing ground for ideas and is flexible and + extensible. (things that could usefully be done: apart from a front end for + simpler user interaction; feed text to an analytical search engine, like + Elasticsearch/Lucene; it still needs a bibliography parser (auto-generation of + a bibliography from footnotes); and it might be useful to allow rough auto + translation documents on the fly by passing text through a translator (such as + Google translate)). + + In any event, my resulting technical opinions (in my modest domain of + action) may be regarded as encapsulated within SiSU + [http://www.sisudoc.org/] + + http://www.sisudoc.org/ + http://www.jus.uio.no/sisu/ + + git clone git://git.sisudoc.org/git/code/sisu.git --branch upstream + http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=summary + (there may be additional commits in the upstream branch) + git clone --depth 1 git://git.sisudoc.org/git/code/sisu.git --branch upstream + + git clone git://git.sisudoc.org/git/doc/sisu-markup-samples.git --branch upstream + git clone --depth 1 git://git.sisudoc.org/git/doc/sisu-markup-samples.git --branch upstream + Development work is on Linux and the easiest way to install it is through the + Debian Linux package as this takes care of optional external dependencies such + as XeTeX for PDF output and Postgresql or Sqlite for search. + +**** multiple document formats + + Text can be represented in multiple output formats with different + characteristics that are (or may be) regarded as strengths/advantages and + therefore preferred in different contexts. + + Given the different strengths and characteristics of various output formats, it + makes little sense to try too hard to make different representations of a + document look the same. More interesting is have document representations that + take advantage of each given outputs strengths. As valuable if not more so is + the ability to cite, find, discuss text with ease, across the different output + formats. + + For citation across output formats, SiSU uses object citation numbers. + +**** document structure and document objects + + SiSU breaks marked up text into document structure and objects + + Document structure being the document heading hierarchy (having separated out + the document header). + +***** What are document objects? + An object is an identified meaningful unit of a document, most commonly a + paragraph of text, but also for example a table, code block, verse or image. + + SiSU tracks these substantive document units as document objects (and their + relationship to the document structure). + +**** object citation numbers + +***** What are object citation numbers? + + An object citation number is a sequential number assigned to a document object. + + In sisu output documents share this common object numbering system (dubbed + "object citation numbering" (ocn)) that is meaningful (machine & human readable) + across various digital outputs whether paper, screen, or database oriented, + (PDF, html, XML, EPUB, sqlite, postgresql), and across multilingual content if + prepared appropriately. This numbering system can be used to reference content + across output types. + +***** Why might I want object citation numbering? + + The ability to cite and quickly locate text can be invaluable if not essential. + (whether for instruction or discussion). + + In this digital & Internet age we have multiple ways to represent documents and + multiple document output formats as options with different characteristics, + strengths/advantages etc. We need a way to cite text that works and is relevant + independent of the document format used. + + I want to discuss (cite) html text how do I do this? + how do I refer to / cite / discuss text in html? + Issue: html may be viewed online or printed, it is not tied to paper (as + e.g. pdf) and prints differently depending on selected font face and font size. + + I want to discuss (cite) text that is available in multiple formats (e.g. pdf, + epub, html) without having to worry about the output format that is referred + to. + How do I refer to / discuss text that is available in more than one format, + uncertain of what format is preferred, used or available to my colleagues? + e.g. html and epub or pdf have rather different text representations, how do I + discuss ... + + I would like to have a book index that is relevant (can be used) across multiple + output formats (e.g. pdf, epub, html) + + How do I make a book index (or a concordance file) that works across multiple + output formats? + + I would like to have search results indicating where in a document matches are + found and I would like it to be relevant across available output formats (e.g. + pdf, epub, html) + How do I get search results for locations of text within each relevant document + + I would like to be able to discuss a text that has been translated ... + how do I find text across languages? + Where I have a nicely translated document, how do I point to or discuss with my + foreign language counterpart some detail of the text, or, how do I point my + foreign language counterpart to the text I would like to bring to his + attention. + +**** "Granular" Search + + Of interest is the ease of streaming documents to a relational database, at an + object (roughly paragraph) level and the potential for increased precision in + the presentation of matches that results thereby. The ability to serialize + html, LaTeX, XML, SQL, (whatever) is also inherent in / incidental to the + design. + +**** Summary + SiSU information Structuring Universe + Structured information, Serialized Units or + software for electronic texts, document collections, + books, digital libraries, and search, with "atomic search" and text positioning + system (shared text citation numbering: "ocn") + outputs include: plaintext, html, XHTML, XML, ODF (OpenDocument), EPUB, LaTeX, + PDF, SQL (PostgreSQL and SQLite) + +**** SiSU Short Description + + SiSU is a comprehensive future-resilient electronic document management system. + Built-in search capabilities allow you to search across multiple documents and + highlight matches in an easy-to-follow format. Paragraph numbering system + allows you to cite your electronic documents in a consistent manner across + multiple file formats. Multiple format outputs allow you to display your + documents in plain text, PDF (portrait and horizontal), OpenDocument format, + HTML, or e-book reading format (EPUB). Word mapping allows you to easily create + word indexes for your documents. Future-resilient flexibility allows you to + quickly adapt your documents to newer output formats as needed. All these and + many other features are achieved with little or no additional work on your + documents - by marking up the documents with a super simplistic markup + language, leaving the SiSU engine to handle the heavy-lifting processing. + + Potential users of SiSU include individual authors who want to publish their + books or articles electronically to reach a broad audience, web publishers who + want to provide multiple channels of access to their electronic documents, or + any organizations which centrally manage a medium or large set of electronic + documents, especially governmental organizations which may prefer to keep their + documents in easily accessible yet non-proprietary formats. + + SiSU is an Open Source project initiated and led by Ralph Amissah + and can be contacted via mailing list + at . SiSU is + licensed under the GNU General Public License. + +***** notes + + For less markup than the most elementary HTML you can have more. SiSU - + Structured information, Serialized Units for electronic documents, is an + information structuring, transforming, publishing and search framework with the + following features: + + (i) markup syntax: (a) simpler than html, (b) mnemonic, influenced by + mail/messaging/wiki markup practices, (c) human readable, and easily writable, + + (ii) (a) minimal markup requirement, (b) single file marked up for multiple outputs, + + * documents are prepared in a single UTF-8 file using a minimalistic mnemonic + syntax. Typical literature, documents like "War and Peace" require almost no + markup, and most of the headers are optional. + + * markup is easily readable/parsed by the human eye, (basic markup is simpler + and more sparse than the most basic html), [this may also be converted to XML + representations of the same input/source document]. + + * markup defines document structure (this may be done once in a header + pattern-match description, or for heading levels individually); basic text + attributes (bold, italics, underscore, strike-through etc.) as required; and + semantic information related to the document (header information, extended + beyond the Dublin core and easily further extended as required); the headers + may also contain processing instructions. + + (iii) (a) multiple output formats, including amongst others: plaintext (UTF-8); + html; (structured) XML; ODF (Open Document text); EPUB; LaTeX; PDF (via LaTeX); + SQL type databases (currently PostgreSQL and SQLite). SiSU produces: + concordance files; document content certificates (md5 or sha256 digests of + headings, paragraphs, images etc.) and html manifests (and sitemaps of + content). (b) takes advantage of the strengths implicit in these very different + output types, (e.g. PDFs produced using typesetting of LaTeX, databases + populated with documents at an individual object/paragraph level, making + possible granular search (and related possibilities)) + + (iv) outputs share a common numbering system (dubbed "object citation + numbering" (ocn)) that is meaningful (to man and machine) across various + digital outputs whether paper, screen, or database oriented, (PDF, html, XML, + EPUB, sqlite, postgresql), this numbering system can be used to reference + content. + + (v) SQL databases are populated at an object level (roughly headings, + paragraphs, verse, tables) and become searchable with that degree of + granularity, the output information provides the object/paragraph numbers which + are relevant across all generated outputs; it is also possible to look at just + the matching paragraphs of the documents in the database; [output indexing also + work well with search indexing tools like hyperesteier]. + + (vi) use of semantic meta-tags in headers permit the addition of semantic + information on documents, (the available fields are easily extended) + + (vii) creates organised directory/file structure for (file-system) output, + easily mapped with its clearly defined structure, with all text objects + numbered, you know in advance where in each document output type, a bit of text + will be found (e.g. from an SQL search, you know where to go to find the + prepared html output or PDF etc.)... there is more; easy directory management + and document associations, the document preparation (sub-)directory may be used + to determine output (sub-)directory, the skin used, and the SQL database used, + + (viii) "Concordance file" wordmap, consisting of all the words in a document + and their (text/ object) locations within the text, (and the possibility of + adding vocabularies), + + (ix) document content certification and comparison considerations: (a) the + document and each object within it stamped with an sha256 hash making it + possible to easily check or guarantee that the substantive content of a document + is unchanged, (b) version control, documents integrated with time based source + control system, default RCS or CVS with use of $Id$ tag, which SiSU checks + + (x) SiSU's minimalist markup makes for meaningful "diffing" of the substantive + content of markup-files, + + (xi) easily skinnable, document appearance on a project/site wide, directory + wide, or document instance level easily controlled/changed, + + (xii) in many cases a regular expression may be used (once in the document + header) to define all or part of a documents structure obviating or reducing + the need to provide structural markup within the document, + + (xiii) prepared files may be batch process, documents produced are static files + so this needs to be done only once but may be repeated for various reasons as + desired (updated content, addition of new output formats, updated technology + document presentations/representations) + + (xiv) possible to pre-process, which permits: the easy creation of standard + form documents, and templates/term-sheets, or; building of composite documents + (master documents) from other sisu marked up documents, or marked up parts, + i.e. import documents or parts of text into a main document should this be + desired + + there is a considerable degree of future-resilience, output representations are + "upgradeable", and new document formats may be added. + + (xv) there is a considerable degree of future-resilience, output representations + are "upgradeable", and new document formats may be added: (a) modular, (thanks + in no small part to Ruby) another output format required, write another + module.... (b) easy to update output formats (eg html, XHTML, LaTeX/PDF + produced can be updated in program and run against whole document set), (c) + easy to add, modify, or have alternative syntax rules for input, should you + need to, + + (xvi) scalability, dependent on your file-system (ext3, Reiserfs, XFS, + whatever) and on the relational database used (currently Postgresql and + SQLite), and your hardware, + + (xvii) only marked up files need be backed up, to secure the larger document + set produced, + + (xviii) document management, + + (xix) Syntax highlighting for SiSU markup is available for a number of text + editors. + + (xx) remote operations: (a) run SiSU on a remote server, (having prepared sisu + markup documents locally or on that server, i.e. this solution where sisu is + installed on the remote server, would work whatever type of machine you chose + to prepare your markup documents on), (b) generated document outputs may be + posted by sisu to remote sites (using rsync/scp) (c) document source (plaintext + utf-8) if shared on the net may be identified by its url and processed locally + to produce the different document outputs. + + (xxi) document source may be bundled together (automatically) with associated + documents (multiple language versions or master document with inclusions) and + images and sent as a zip file called a sisupod, if shared on the net these too + may be processed locally to produce the desired document outputs, these may be + downloaded, shared as email attachments, or processed by running sisu against + them, either using a url or the filename. + + (xxii) for basic document generation, the only software dependency is Ruby, and + a few standard Unix tools (this covers plaintext, html, XML, ODF, EPUB, LaTeX). + To use a database you of course need that, and to convert the LaTeX generated + to PDF, a LaTeX processor like tetex or texlive. + + as a developers tool it is flexible and extensible + +**** description + + SiSU ("SiSU information Structuring Universe" or "Structured information, + Serialized Units"),1 is a Unix command line oriented framework for document + structuring, publishing and search. Featuring minimalistic markup, multiple + standard outputs, a common citation system, and granular search. Using markup + applied to a document, SiSU can produce plain text, HTML, XHTML, XML, + OpenDocument, LaTeX or PDF files, and populate an SQL database with objects2 + (equating generally to paragraph-sized chunks) so searches may be performed and + matches returned with that degree of granularity (e.g. your search criteria is + met by these documents and at these locations within each document). Document + output formats share a common object numbering system for locating content. + This is particularly suitable for "published" works (finalized texts as opposed + to works that are frequently changed or updated) for which it provides a fixed + means of reference of content. How it works + + SiSU markup is fairly minimalistic, it consists of: a (largely optional) + document header, made up of information about the document (such as when it was + published, who authored it, and granting what rights) and any processing + instructions; and markup within text which is related to document structure and + typeface. SiSU must be able to discern the structure of a document, (text + headings and their levels in relation to each other), either from information + provided in the instruction header or from markup within the text (or from a + combination of both). Processing is done against an abstraction of the document + comprising of information on the document's structure and its objects,2 which + the program serializes (providing the object numbers) and which are assigned + hash sum values based on their content. This abstraction of information about + document structure, objects, (and hash sums), provides considerable flexibility + in representing documents different ways and for different purposes (e.g. + search, document layout, publishing, content certification, concordance etc.), + and makes it possible to take advantage of some of the strengths of established + ways of representing documents, (or indeed to create new ones). + + 1. also chosen for the meaning of the Finnish term "sisu". + + 2 objects include: headings, paragraphs, verse, tables, images, but not + footnotes/endnotes which are numbered separately and tied to the object from + which they are referenced. + + More information on SiSU provided at: + + SiSU was developed in relation to legal documents, and is strong across a wide + variety of texts (law, literature...(humanities, law and part of the social + sciences)). SiSU handles images but is not suitable for formulae/ statistics, + or for technical writing at this time. + + SiSU has been developed and has been in use for several years. Requirements to + cover a wide range of documents within its use domain have been explored. + + + + + + 2010 + w3 since October 3 1993 +*** Finding SiSU +**** source + http://git.sisudoc.org/gitweb/ + +***** sisu + sisu git repo: + http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=summary + +****** most recent source without repo history + git clone --depth 1 git://git.sisudoc.org/git/code/sisu.git --branch upstream +****** full clone + git clone git://git.sisudoc.org/git/code/sisu.git --branch upstream + +***** 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 + + + + +*** Installation + +**** 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 --branch upstream + git clone --depth 1 git://git.sisudoc.org/git/code/sisu.git --branch upstream + + 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. + +**** Arch Linux + +*** sisu markup :sisu: + +**** markup :markup: + +***** sisu document parts + - header + - metadata + - make instructionS + - substantive (& other) content + (sisu markup) + - endnotes + (markup within substantive content) + - glossary + (section, special markup) + - bibliography + (section, special markup) + - book index + (markup attached to substantive content objects) + + |---------------------+-----------------------------------------------------------------------+------------------------+--------| + | header | sisu /header markup/ | markup | | + | - metadata | | | | + | - make instructions | | | | + |---------------------+-----------------------------------------------------------------------+------------------------+--------| + | substantive content | sisu /content markup/ | markup | output | + | | headings (providing document structure), paragraphs, | (regular content) | | + | | blocks (code, poem, group, table) | | | + |---------------------+-----------------------------------------------------------------------+------------------------+--------| + | endnotes | markup within substantive content | markup | output | + | | (extracted from sisu /content markup/) | (from regular content) | | + |---------------------+-----------------------------------------------------------------------+------------------------+--------| + | glossary | identify special section, regular /content markup/ | markup | output | + |---------------------+-----------------------------------------------------------------------+------------------------+--------| + | bibliography | identify section, special /bibliography markup/ | markup | output | + |---------------------+-----------------------------------------------------------------------+------------------------+--------| + | book index | extracted from markup attached to related substantive content objects | markup | output | + | | (special tags in sisu /content markup/) | (from regular content) | | + |---------------------+-----------------------------------------------------------------------+------------------------+--------| + | metadata | | (from regular header) | output | + |---------------------+-----------------------------------------------------------------------+------------------------+--------| + +***** structure - headings, levels + - headings (A-D, 1-3) + + 'A~ ' NOTE title level + + 'B~ ' NOTE optional + 'C~ ' NOTE optional + 'D~ ' NOTE optional + + '1~ ' NOTE chapter level + '2~ ' NOTE optional + '3~ ' NOTE optional + + * 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 + +***** notes (footnotes/ endnotes) + 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 + built from hints in newline text following a paragraph and starting with ={} has identifying rules for main and subsidiary text + + #% comment + * comment + + #% misc + * term & definition + +**** syntax highlighting :syntax:highlighting: + +***** 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 + +*** todo + sisu_todo.org + +* document header + +#+NAME: sisu_document_header +#+BEGIN_SRC text +encoding: utf-8 +- Name: SiSU + + - Description: documents, structuring, processing, publishing, search + sisu build + + - Author: Ralph Amissah + + + - Copyright: (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, + 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2019, + 2020, 2021, Ralph Amissah, + All Rights Reserved. + + - License: GPL 3 or later: + + SiSU, a framework for document structuring, publishing and search + + Copyright (C) Ralph Amissah + + This program is free software: you can redistribute it and/or modify it + under the terms of the GNU General Public License as published by the Free + Software Foundation, either version 3 of the License, or (at your option) + any later version. + + This program is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + more details. + + You should have received a copy of the GNU General Public License along with + this program. If not, see . + + If you have Internet connection, the latest version of the GPL should be + available at these locations: + + + + + + - SiSU uses: + - Standard SiSU markup syntax, + - Standard SiSU meta-markup syntax, and the + - Standard SiSU object citation numbering and system + + - Homepages: + + + - Git + + + +#+END_SRC diff --git a/qi b/qi index 24d383b6..7b6d64d9 100755 --- a/qi +++ b/qi @@ -1,18 +1,17 @@ #!/usr/bin/env ruby =begin -** Description: +- Description: -** Homepage: +- Homepage: -** Download: +- Download: -** Copyright: (C) 2015 Ralph Amissah +- Copyright: (C) 2015, 2020 Ralph Amissah -** License: +- License: -** Ralph Amissah - Ralph Amissah +- Ralph Amissah =end #% manual settings, edit/update as required (note current default settings are obtained from sisu version yml file) diff --git a/setup/qi_libs.rb b/setup/qi_libs.rb index 1c294b05..0de6cf0f 100644 --- a/setup/qi_libs.rb +++ b/setup/qi_libs.rb @@ -389,7 +389,7 @@ proceed? } def self.changelog_header(vi) vn=version_number(vi) <<-WOK -* sisu_#{vn}.orig.tar.xz (#{vi[:date]}:#{vi[:date_stamp].gsub(/20\d\dw/,'')}) +- sisu_#{vn}.orig.tar.xz (#{vi[:date]}:#{vi[:date_stamp].gsub(/20\d\dw/,'')}) http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/sisu_#{vn} WOK end @@ -437,7 +437,7 @@ proceed? } def self.changelog_header_pre_release(vi) vn=version_number(vi) <<-WOK -* sisu_#{vn}.orig.tar.xz (Open commit window: #{vi[:date]}; Pre-Release) +- sisu_#{vn}.orig.tar.xz (Open commit window: #{vi[:date]}; Pre-Release) http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/sisu_#{vn} WOK end @@ -569,7 +569,7 @@ Gem::Specification.new do |s| s.homepage = '#{Project_details.homepage}' s.authors = ["Ralph Amissah"] s.email = 'ralph.amissah@gmail.com' - s.license = 'GPL3' + s.license = 'GPL-3.0-or-later' s.files = Dir['lib/#{Project_details.name.downcase}.rb'] + Dir['lib/#{Project_details.name.downcase}/*.rb'] + Dir['data/#{Project_details.name.downcase}/version.yml'] + @@ -592,7 +592,7 @@ Gem::Specification.new do |s| s.homepage = '#{Project_details.homepage}' s.authors = ["Ralph Amissah"] s.email = 'ralph.amissah@gmail.com' - s.license = 'GPL3' + s.license = 'GPL-3.0-or-later' s.files = `git ls-files -z lib`.split("\x0") + Dir['data/#{Project_details.name.downcase}/version.yml'] + Dir['data/#{Project_details.name.downcase}/image/*'] + diff --git a/setup/rbuild b/setup/rbuild old mode 100644 new mode 100755 index 32017d4f..ddba6999 --- a/setup/rbuild +++ b/setup/rbuild @@ -3,24 +3,22 @@ Common Rakefile, Rantfile installer for SiSU softlink Rakefile and Rantfile to this file - * Homepage: - - * Download: + - Homepage: + - Download: Copyright (C) 2007 Ralph Amissah - * License: LGPL - GNU Lesser General Public License + - License: LGPL - GNU Lesser General Public License [same license as Rant provided within the Rant package] - * Ralph Amissah - Ralph Amissah + - Ralph Amissah Rake is a Ruby build program by Jim Weirich - * Rake may be downloaded and installed from: + - Rake may be downloaded and installed from: Rant is a Ruby build program by Stefan Lang - * Rant may be downloaded and installed from: + - Rant may be downloaded and installed from: Notes on use: diff --git a/setup/rbuild_help.rb b/setup/rbuild_help.rb index fc56c2fa..0dd395be 100644 --- a/setup/rbuild_help.rb +++ b/setup/rbuild_help.rb @@ -33,4 +33,3 @@ WOK end end end - diff --git a/setup/rbuild_libs.rb b/setup/rbuild_libs.rb index 75ba2847..8ff53052 100644 --- a/setup/rbuild_libs.rb +++ b/setup/rbuild_libs.rb @@ -291,7 +291,7 @@ proceed? } end def self.changelog_header(vi) <<-WOK -** #{vi[:version]}.orig.tar.xz (#{vi[:date]}:#{vi[:date_stamp].gsub(/20\d\dw/,'')}) +-- #{vi[:version]}.orig.tar.xz (#{vi[:date]}:#{vi[:date_stamp].gsub(/20\d\dw/,'')}) http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/sisu_#{vi[:version]} http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/debian/sisu_#{vi[:version]}-1 http://www.jus.uio.no/sisu/pkg/src/sisu_#{vi[:version]}.orig.tar.xz @@ -383,7 +383,7 @@ Gem::Specification.new do |s| Dir['data/#{Project_details.name.downcase}/image/*'] + Dir['bin/#{Project_details.name.downcase}gem'] + Dir['bin/#{Project_details.name.downcase}'] - s.license = 'GPL3' + s.license = 'GPL-3.0-or-later' s.executables << '#{Project_details.name.downcase}gem' << '#{Project_details.name.downcase}' end WOK diff --git a/shell.nix b/shell.nix new file mode 100644 index 00000000..80173752 --- /dev/null +++ b/shell.nix @@ -0,0 +1,6 @@ +{ pkgs ? import {} }: +pkgs.mkShell { + buildInputs = [ + (import ./nix/pkglst/packages.nix { inherit pkgs; }) + ]; +} -- cgit v1.2.3