aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/sisu/CHANGELOG
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2010-03-06 09:47:55 -0500
committerRalph Amissah <ralph@amissah.com>2010-03-06 09:47:55 -0500
commit306aed5b8a559aad2fb944a946ffdda9713f07ec (patch)
treecf627bc6438dba6103d4e05a1d5cff678f78df6f /data/doc/sisu/CHANGELOG
parentskin_sisu utf-8 marker (diff)
introducing version 2, major patch, (version 1 libraries retained)sisu_2.0.0
Diffstat (limited to 'data/doc/sisu/CHANGELOG')
-rw-r--r--data/doc/sisu/CHANGELOG50
1 files changed, 50 insertions, 0 deletions
diff --git a/data/doc/sisu/CHANGELOG b/data/doc/sisu/CHANGELOG
new file mode 100644
index 00000000..666f670f
--- /dev/null
+++ b/data/doc/sisu/CHANGELOG
@@ -0,0 +1,50 @@
+%% SiSU versions 1 & 2, 2010
+Homepage: <http://www.jus.uio.no/sisu>
+* README CHANGELOG v1/CHANGELOG v2/CHANGELOG
+
+Herein (this package) reside SiSU versions 1 and 2.
+
+README CHANGELOG_v1 CHANGELOG_v2
+
+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.
+
+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]
+
+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
+
+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>
+* <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_v1 CHANGELOG_v2 README data/doc/sisu/