aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/sisu/CHANGELOG_v3
diff options
context:
space:
mode:
Diffstat (limited to 'data/doc/sisu/CHANGELOG_v3')
-rw-r--r--data/doc/sisu/CHANGELOG_v3192
1 files changed, 192 insertions, 0 deletions
diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3
new file mode 100644
index 00000000..db83cd2c
--- /dev/null
+++ b/data/doc/sisu/CHANGELOG_v3
@@ -0,0 +1,192 @@
+%% SiSU version 3
+
+* homepage at: <http://www.jus.uio.no/sisu>
+* <http://www.jus.uio.no/sisu/SiSU/download>
+* <http://www.jus.uio.no/sisu/SiSU/changelog>
+* <http://sisudoc.org/sisu/sisu_manual>
+* data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_manual.ssm
+* data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_download.ssi
+* CHANGELOG CHANGELOG_v2 CHANGELOG_v3 README data/doc/sisu/
+
+Reverse Chronological:
+
+%% Development branch UNSTABLE
+v3 branch once stable will supersede & replace current stable v2 branch
+
+%% 3.0.2.orig.tar.gz (2011-03-02:09/3)
+http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.2.orig.tar.gz
+ sisu_3.0.2.orig.tar.gz
+ sisu_3.0.2-1.dsc
+ sisu_3.0.2-1.debian.tar.gz
+
+ v3, target ruby1.9.2, ruby1.9.2p180 is ok
+ 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
+
+ * make sisu: v3 require >=ruby1.9.2 (v2 require >=ruby1.8.7)
+ bin/sisu bin/sisu3 modified accordingly
+
+ * use rb1.9.2 "require_relative" syntax
+
+ * ruby 1.9 hash symbol syntax adopted
+
+ * space between each and opening curly brace e.g. "x.each {|y| p y}"
+
+ * use "encoding: utf-8" (instead of coding)
+
+ * sysenv, processing_path method (separated from path) and resulting
+ necessary changes
+
+ * urls, param, two unrelated regex fixes, check
+
+ * hub, minor rearranging
+
+ * v2, v3: consolidate manual & markup samples
+
+%% 3.0.1.orig.tar.gz (2011-02-16:07/3)
+http://git.sisudoc.org/?p=code/sisu.git;a=shortlog;h=refs/tags/debian/3.0.1-1
+http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.1.orig.tar.gz
+ 881a1fa51154c706c053c6cf136fbaa7c1f3abe96dd203dc649d42875dd55482 2716285 sisu_3.0.1.orig.tar.gz
+ 9320cf50485fdc05a7c1b12d1f85257a9d8b8cdbb31786589ec79e5aea5935bd 1216 sisu_3.0.1-1.dsc
+ c69a80680d786e3f9b9090997e9ba7bc39c048681564fa0af4e59d2cec74e3dc 279711 sisu_3.0.1-1.debian.tar.gz
+
+ * sysenv, sisurc.yml and elsewhere as affected, output_dir_structure:
+ by_language_code; by_filetype; by_filename
+
+ * css, fix css paths for xhtml, xml dom & xml sax
+
+ * console feedback on selected files being processed, updates & fixes
+
+ * sysenv & sisurc.yml: libreoffice, default odf reader
+
+%% 3.0.0.orig.tar.gz (2011-02-07:06/1)
+http://git.sisudoc.org/?p=code/sisu.git;a=shortlog;h=refs/tags/debian/3.0.0-1
+http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.0.orig.tar.gz
+ 53b9629bde5d27c504005ebc02c722d5d7d6cc3556e9dbfd1802dac682c52856 2716588 sisu_3.0.0.orig.tar.gz
+ 7cd26f5d70bb5bfac33d74dc69eb0d00bf5d3864612c984f5db3e1c2058635cb 1222 sisu_3.0.0-1.dsc
+ 3a319dc5863742c3b2e461b19802b284dfdb51240771d7f9517d1761a2912d06 279707 sisu_3.0.0-1.debian.tar.gz
+
+ NOTE: Processing defaults to v2, for v3 use 'sisu3' or 'sisu --v3'
+
+ Versions 3 is experimental and attempts to introduce output more compatible
+ with mobile devices and other non-web use and more internationalisation
+ possibilities.
+
+ NOTE: v3 branch opened, big patch, changes interim/incomplete (with
+ possibility of breakage) primarily for: ebook-readers and other downloading
+ viewers (alternative directory structures and use of title based filenames);
+ internationalisation (use with po4a, export pot & po, alternative directory
+ structures, use of git to ensure changes not lost).
+
+ In v3 SiSU markup files may be organised in language directories that are
+ given their language code. There are alternative output directory structures
+ depending on whether you want: the v2 layout (mostly in a directory of the
+ given filename/a generic filetype name); a monolingual version 3 layout,
+ which organises files by filetype/given file name; multilingual v3 layout,
+ which organises files by language code/filetype/given which is illustrated
+ below
+
+ * alternative output directory structures, configurable
+ ├── en
+ │   ├── epub
+ │   ├── hashes
+ │   ├── html
+ │   │   └── live-manual
+ │   ├── manifest
+ │   ├── odt
+ │   ├── pdf
+ │   ├── sitemaps
+ │   ├── txt
+ │   ├── xhtml
+ │   └── xml
+ ├── fr
+ │   ├── epub
+ │   ├── hashes
+ │   ├── html
+ │   │   └── live-manual
+ │   ├── manifest
+ │   ├── odt
+ │   ├── pdf
+ │   ├── sitemaps
+ │   ├── txt
+ │   ├── xhtml
+ │   └── xml
+ ├── po4a
+ │   └── live-manual
+ │   ├── po
+ │   │   └── fr
+ │   └── pot
+ └── _sisu
+ ├── css
+ ├── image
+ ├── image_sys -> ../../_sisu/image_sys
+ └── xml
+ ├── rnc
+ ├── rng
+ └── xsd
+ [FIX todo:
+ * post rsync,
+ * output url paths,
+ * also processing of url,
+ * processing of sisupod,
+ * search db?,
+ * search cgi
+ ]
+
+ * sisu processing possibility of using directory path and sisu source
+ filename, rather than only content in current directory by filename
+ [rc config rules are that if not processing from current directory, or
+ directory above language sub-directory, will not find _sisu in sisu source
+ file directory, but rather will use ~/.sisu if any or /etc/sisu]
+
+ * po4a, work on
+ * pot, po output from source language and translation
+ * directory structure
+ * alternative source directory structures: source and translation files
+ organised either by existing file naming convention (file.sst
+ filename~es.sst filname~fr.sst filename~de.sst), or; by placement in
+ language subdirectories (that follow debian po4a language identification
+ convention) ( ./en/file.sst ./es/file.sst ./fr/file.sst ./de/file.sst
+ [./_sisu])
+ * process po4a source composite file (.ssm) together with its includes
+ (.ssi and/or .sst), by identifying composite file to process ... includes
+ are identified and processed as well
+ [extensive testing required, initial tests passed on "free_culture" and
+ "live-manual" and translations]
+ * integrate use of git, ensure changes are not lost
+
+ * sisupod git, revisiting
+ * internationalize directory structure
+ ├── conf
+ │   └── skin
+ ├── mm
+ │   └── image
+ ├── po4a
+ │   ├── po
+ │   │   ├── en
+ │   │   └── fr
+ │   └── pot
+ └── src
+ ├── en
+ └── fr
+ [FIX todo: sisu parsing, not sorted!, directory path parsing major step]
+
+ * object, block text of='block' (instead of 'group'), introduce is='block'
+ * dal_doc_str, dal_doc_objects, identify
+ * dal_syntax, introduce block syntax block{ }block, like group
+ * vim syntax highlighting, match block
+ * related downstream changes (many files affected)
+ Note: adjust output representation later
+
+ [UGLY HACKS:
+ po4a, en assumed as source lanuage, should be configurable
+ po4a, only configured so far to recognise fr & es, fix
+ po4a for processing .ssm .ssi, skipping of md title & author
+ ]
+ [FIX todo:
+ directory structure for multilingual outputs
+ breakage to epub, where src and trans dirs
+ manifest
+ decide what to do about source output & po4a & git
+ ]