ea5641baee
Previously, all of the README files have been renamed to README.md and now, the contents of these files were changed to use Markdown format. Other than format inconsistency, some README.md files lacked information about modules, or were out of date. By using LibreOffice / OpenOffice wiki and other documentation websites, these files were updated. Now every README.md file has a title, and some description. The top-level README.md file is changed to add links to the modules. The result of processing the Markdown format README.md files can be seen at: https://docs.libreoffice.org/ Change-Id: Ic3b0c3c064a2498d6a435253b041df010cd7797a Reviewed-on: https://gerrit.libreoffice.org/c/core/+/113424 Tested-by: Jenkins Reviewed-by: Michael Stahl <michael.stahl@allotropia.de> Reviewed-by: Adolfo Jayme Barrientos <fitojb@ubuntu.com> |
||
|---|---|---|
| .. | ||
| libreoffice | ||
| mathml2 | ||
| odf1.0 | ||
| odf1.1 | ||
| odf1.2 | ||
| odf1.3 | ||
| README.md | ||
Schemas for Validating ODF Files
Schemas that can be used for validating ODF files
subdirs:
mathml2: W3C MathML 2.0 XML Schema (needed for Math embedded objects)odf1.0,odf1.1,odf1.2: official OASIS RelaxNG schemasodf1.3: current OASIS draft ODF 1.3 RelaxNG schemalibreoffice: draft ODF schema, with additional LO extensions
The extension schema in libreoffice/ is used by all unit tests if
--with-export-validation is given, which is the default.
Notably this means that if you add a new feature to the ODF filters and you add the required unit test for the new feature, then most likely the test will fail with a complaint from the validator; in this case the schema needs to be updated to contain the new elements and attributes.
The extension schema uses the RelaxNG "include" feature to refer to the ODF
schema; this means that it only contains those parts of the schema that
actually need to be changed - this works well in many cases because the ODF
schema is quite well structured with many named patterns, but unfortunately
there are a few places where that isn't the case and large chunks needed to be
copied to override them.
In the easy case, to add an attribute you just want to search for the
corresponding element, which will have a "foo-attlist" named pattern, and then
add another attribute like this:
<rng:define name="draw-enhanced-geometry-attlist" combine="interleave"> rng:optional <rng:attribute name="drawooo:sub-view-size"> <rng:ref name="string"/> </rng:attribute> </rng:optional> </rng:define>
Currently only the features that are actually exported in the unit tests have been added to the schema; there is still some work to do here to add everything; the crashtesting script also does ODF validation of all files and now also uses the custom schema.
Unfortunately it turned out that there are a lot of extensions already for which no proposal exists [1], and in many cases not even an entry on the Wiki [2], so clearly something like this extension schema is needed.
[1] git grep TODO schema/libreoffice