aboutsummaryrefslogtreecommitdiffhomepage
path: root/CHANGELOG
blob: d5764704017a48c320661c2e26fe189659edc5e4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
%% SiSU versions 1 & 2, 2010
Homepage: <http://www.jus.uio.no/sisu>
* README CHANGELOG CHANGELOG_v1 CHANGELOG_v2

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/