Si2 Delta
The package leverages the trusty Unix diff tool and the html2text package,
along with custom scripts and PHP code, to generate an easily readable,
side-by-side comparison of OA API doc files.
Four indexes of links are generated grouping files
- present in one release only
- present in the other release only
- common in both but with differences
- common in both but without differences
Each link in the "differences index" traverses to a side-by-side, line-by-line
comparison of the two files, using background highlighting to guide the eyes right to
the deltas.
This set of scripts and code is tailored for the particular structure of the
OA API doc tree. The code could be modified to diff any pair of files or trees;
however, it includes a significant amount of
pruning and pre/post-processing of artifacts specific to the API doc
structure essential to
produce a meaningful
set of differences.
Si2 Delta differences between selected OA releases have been
integrated into the Si2 Online Docs.
Si2 uses the Delta tool as part of its arsenal of techniques
to determine changes that
must be made in the Si2 OA Tutorial.
A different customization of
the Si2 Delta tool is used to generate and display changes made
between versions of the Si2 OA 2.2 Online Course
(https://openeda.si2.org/oaCourse22/Html/index.html).
|
