summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2011-02-07 18:56:28 +0000
committerRalph Amissah <ralph@amissah.com>2011-02-07 18:56:28 +0000
commit5b0efc5b454309bab2c6efe3507c54b4191152bc (patch)
treec1f31fd8e38f97997ada73a3af0bcea661ff5d7a
parentdocumentation & man pages, add sisu3, sisu-po and touches (diff)
downloadsisu-5b0efc5b454309bab2c6efe3507c54b4191152bc.zip
sisu-5b0efc5b454309bab2c6efe3507c54b4191152bc.tar.xz
update changelogs & version datesisu_3.0.0
-rw-r--r--CHANGELOG45
-rw-r--r--CHANGELOG_v26
-rw-r--r--CHANGELOG_v324
-rw-r--r--data/doc/sisu/v2/CHANGELOG6
-rw-r--r--data/doc/sisu/v3/CHANGELOG24
-rw-r--r--data/sisu/v2/v/version.yml4
-rw-r--r--data/sisu/v3/v/version.yml6
7 files changed, 64 insertions, 51 deletions
diff --git a/CHANGELOG b/CHANGELOG
index d576470..c13296b 100644
--- a/CHANGELOG
+++ b/CHANGELOG
@@ -1,45 +1,26 @@
-%% SiSU versions 1 & 2, 2010
+%% SiSU versions 2 & 3, 2011
Homepage: <http://www.jus.uio.no/sisu>
-* README CHANGELOG CHANGELOG_v1 CHANGELOG_v2
+* README CHANGELOG CHANGELOG_v1 CHANGELOG_v2 CHANGELOG_v3
-Herein (this package) reside SiSU versions 1 and 2.
+Herein (this package) reside SiSU versions 2 and 3.
-README CHANGELOG_v1 CHANGELOG_v2
+README CHANGELOG_1 CHANGELOG_v2 CHANGELOG_v3
-This tarball contains two versions of SiSU, the stable version 1 and the
-under-development version 2. The input for the two versions, a SiSU marked-up
-document is almost the same (document headers have been changed in v2), and
-output is substantively the same with a similar range of output formats, and
-the addition of epub in v2.
+This tarball contains two versions of SiSU, the stable version 2 and the
+under-development version 3. For version 1 look to sisu 2.7 and earlier.
+
+The input for v2 & v3, a SiSU marked-up document is the same.
As version 2 is the current implementation the source tarball is named after
-it, and the command sisu by default runs version 2. To run version one add the
-flag --v1, i.e. sisu --v1 [filename]
+it, and the command sisu by default runs version 2. To run version 3 add the
+flag --v3, i.e. sisu --v3 [filename], or run sisu3
Compatibility Notes
-Versions 1 and 2 are not quite compatible, version 1 and version 2 will run
-against each other's documents but document metadata, and processing
-instructions may be lost.
-
-On the input side, version 1 and 2 headers are different, version 2 headers
-have been tidied, see document markup samples provided
-
-On the output side, the sql databases produced if search is to be implemented
-are not the same and a database must be generated for each version, most other
-differences should be relatively cosmetic.
-
-Changes
+Versions 3 is experimental and attempts to introduce output more compatible
+with mobile devices and other non-web use and more internationalisation
+possibilities. Please see CHANGELOG_v3
-From a developer's perspective the substantive change between the two versions
-is to the middle layer, (the document abstraction, the intermediate document
-representation used in processing). Version 1 uses strings and relies on
-regular expressions to identify document objects, while Version 2 uses ruby
-objects. The version 1 approach whilst programming language neutral offers less
-control, and leads to complicated code; version 2 approach takes advantage of
-features within the ruby language suited to what the application does.
-Development is curently on version 2, version 1 is likely to remain for some
-time as a reference implementation.
* homepage at: <http://www.jus.uio.no/sisu>
* <http://www.jus.uio.no/sisu/SiSU/download>
diff --git a/CHANGELOG_v2 b/CHANGELOG_v2
index 98f1295..e7c49a1 100644
--- a/CHANGELOG_v2
+++ b/CHANGELOG_v2
@@ -6,7 +6,7 @@
* <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_v1 CHANGELOG_v2 README data/doc/sisu/
+* CHANGELOG CHANGELOG_v2 CHANGELOG_v3 README data/doc/sisu/
Reverse Chronological:
@@ -18,7 +18,9 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_2.8.0.orig.tar.gz
sisu_2.8.0-1.dsc
sisu_2.8.0-1.diff.gz
- * note opening of version 3 branch, see v3 changelog
+ * opening of version 3 branch, see v3 changelog
+
+ * closing of version 1 branch
[post Debian Squeeze]
diff --git a/CHANGELOG_v3 b/CHANGELOG_v3
index f51ac30..be7fe54 100644
--- a/CHANGELOG_v3
+++ b/CHANGELOG_v3
@@ -6,25 +6,39 @@
* <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
- gi* CHANGELOG CHANGELOG_v1 CHANGELOG_v2 README data/doc/sisu/
+* 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.0.orig.tar.gz (2011-01-12:02/3)
+%% 3.0.0.orig.tar.gz (2011-02-07:06/1)
http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.0.orig.tar.gz
sisu_3.0.0.orig.tar.gz
sisu_3.0.0-1.dsc
sisu_3.0.0-1.diff.gz
- NOTE: 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); use of git;
+ 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
diff --git a/data/doc/sisu/v2/CHANGELOG b/data/doc/sisu/v2/CHANGELOG
index 98f1295..a679e6c 100644
--- a/data/doc/sisu/v2/CHANGELOG
+++ b/data/doc/sisu/v2/CHANGELOG
@@ -6,7 +6,7 @@
* <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_v1 CHANGELOG_v2 README data/doc/sisu/
+* ../CHANGELOG ../v2/CHANGELOG ../v3/CHANGELOG ../README ../
Reverse Chronological:
@@ -18,7 +18,9 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_2.8.0.orig.tar.gz
sisu_2.8.0-1.dsc
sisu_2.8.0-1.diff.gz
- * note opening of version 3 branch, see v3 changelog
+ * opening of version 3 branch, see v3 changelog
+
+ * closing of version 1 branch
[post Debian Squeeze]
diff --git a/data/doc/sisu/v3/CHANGELOG b/data/doc/sisu/v3/CHANGELOG
index 750fb74..8209e43 100644
--- a/data/doc/sisu/v3/CHANGELOG
+++ b/data/doc/sisu/v3/CHANGELOG
@@ -6,25 +6,39 @@
* <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 ../v1/CHANGELOG ../v2/CHANGELOG ../README ../
+* ../CHANGELOG ../v2/CHANGELOG ../v3/CHANGELOG ../README ../
Reverse Chronological:
%% Development branch UNSTABLE
v3 branch once stable will supersede & replace current stable v2 branch
-%% 3.0.0.orig.tar.gz (2011-01-12:02/3)
+%% 3.0.0.orig.tar.gz (2011-02-07:06/1)
http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.0.orig.tar.gz
sisu_3.0.0.orig.tar.gz
sisu_3.0.0-1.dsc
sisu_3.0.0-1.diff.gz
- NOTE: 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); use of git;
+ 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
diff --git a/data/sisu/v2/v/version.yml b/data/sisu/v2/v/version.yml
index 2a8d794..131e0b6 100644
--- a/data/sisu/v2/v/version.yml
+++ b/data/sisu/v2/v/version.yml
@@ -1,5 +1,5 @@
---
:version: 2.8.0
-:date_stamp: 2011w05/2
-:date: "2011-02-01"
+:date_stamp: 2011w06/1
+:date: "2011-02-07"
:project: SiSU
diff --git a/data/sisu/v3/v/version.yml b/data/sisu/v3/v/version.yml
index 506e5d6..4fd8386 100644
--- a/data/sisu/v3/v/version.yml
+++ b/data/sisu/v3/v/version.yml
@@ -1,5 +1,5 @@
---
-:version: 3.0.0-beta-0
-:date_stamp: 2011w05/2
-:date: "2011-02-01"
+:version: 3.0.0-beta
+:date_stamp: 2011w06/1
+:date: "2011-02-07"
:project: SiSU