From 5b0efc5b454309bab2c6efe3507c54b4191152bc Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Mon, 7 Feb 2011 13:56:28 -0500 Subject: update changelogs & version date --- CHANGELOG | 45 +++++++++++++-------------------------------- 1 file changed, 13 insertions(+), 32 deletions(-) (limited to 'CHANGELOG') diff --git a/CHANGELOG b/CHANGELOG index d5764704..c13296bf 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,45 +1,26 @@ -%% SiSU versions 1 & 2, 2010 +%% SiSU versions 2 & 3, 2011 Homepage: -* 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: * -- cgit v1.2.3