Adding manpages for newly added sisu aliases.
[software/sisu] / CHANGELOG
1 %% SiSU versions 1 & 2, 2010
2 Homepage: <http://www.jus.uio.no/sisu>
3 * README CHANGELOG CHANGELOG_v1 CHANGELOG_v2
4
5 Herein (this package) reside SiSU versions 1 and 2.
6
7 README CHANGELOG_v1 CHANGELOG_v2
8
9 This tarball contains two versions of SiSU, the stable version 1 and the
10 under-development version 2. The input for the two versions, a SiSU marked-up
11 document is almost the same (document headers have been changed in v2), and
12 output is substantively the same with a similar range of output formats, and
13 the addition of epub in v2.
14
15 As version 2 is the current implementation the source tarball is named after
16 it, and the command sisu by default runs version 2. To run version one add the
17 flag --v1, i.e. sisu --v1 [filename]
18
19 Compatibility Notes
20
21 Versions 1 and 2 are not quite compatible, version 1 and version 2 will run
22 against each other's documents but document metadata, and processing
23 instructions may be lost.
24
25 On the input side, version 1 and 2 headers are different, version 2 headers
26 have been tidied, see document markup samples provided
27
28 On the output side, the sql databases produced if search is to be implemented
29 are not the same and a database must be generated for each version, most other
30 differences should be relatively cosmetic.
31
32 Changes
33
34 From a developer's perspective the substantive change between the two versions
35 is to the middle layer, (the document abstraction, the intermediate document
36 representation used in processing). Version 1 uses strings and relies on
37 regular expressions to identify document objects, while Version 2 uses ruby
38 objects. The version 1 approach whilst programming language neutral offers less
39 control, and leads to complicated code; version 2 approach takes advantage of
40 features within the ruby language suited to what the application does.
41 Development is curently on version 2, version 1 is likely to remain for some
42 time as a reference implementation.
43
44 * homepage at: <http://www.jus.uio.no/sisu>
45 * <http://www.jus.uio.no/sisu/SiSU/download>
46 * <http://www.jus.uio.no/sisu/SiSU/changelog>
47 * <http://sisudoc.org/sisu/sisu_manual>
48 * data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_manual.ssm
49 * data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_download.ssi
50 * CHANGELOG CHANGELOG_v1 CHANGELOG_v2 README data/doc/sisu/