office-gobmx/schema
Skyler Grey 32c588dd11 tdf#86790: Add support for a word-style styleref
STYLEREF is a field type in Word which changes its content based on
nearby paragraphs. For example, upon creating a styleref referencing
"Heading 1" you will see the text of the nearest "Heading 1"-styled
paragraph that is above the field.

This patch implements STYLEREF in Writer as a cross-reference. By using
"insert>cross-reference>styles" you'll be presented with a list of
styles. Selecting one and clicking "insert" will create a field which
has text from the "most relevant" instance of the style. To find the
most relevant instance we first search up for paragraphs with the style,
and if there are any we take the closest. If there weren't any, we
search down for paragraphs with the style.

This patch also updates our use of STYLEREF for chapters exported to
docx by using it for all chapters not only those in headers and footers.
This allows us to approximate more chapter field functionality even when
moving between Writer and Word.

Finally, this patch adds some tests for STYLEREF:
- testTdf86790 tests that the "sample file with STYLEREF" document from
  tdf#86790 has the correct fields
- testStyleRefSearchUp tests that the STYLEREF searches up when there
  are bits of text both above and below it
- testStyleRefSearchDown tests that the STYLEREF searches down when
  there are bits of text below it only
- testMarginalStyleRef tests that the STYLEREF searches from the page
  top when it is placed in a footer
- testFootnotetyleRef tests that the STYLEREF searches from the
  reference mark when it is placed in a footnote

Still TODO:
- [  ] Update documentation
- [  ] Implement reverse-searching (\l) and nondelimiter
       suppression (\t)
       - Probably these 2 will be in a followup patch

Change-Id: I25dd7a6940abee5651a784b9059fe23b32547d6c
Signed-off-by: Skyler Grey <skyler.grey@collabora.com>
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/157456
Tested-by: Jenkins
Reviewed-by: Miklos Vajna <vmiklos@collabora.com>
2023-10-20 08:53:34 +02:00
..
libreoffice tdf#86790: Add support for a word-style styleref 2023-10-20 08:53:34 +02:00
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 schemas
  • odf1.3: current OASIS draft ODF 1.3 RelaxNG schema
  • libreoffice: 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

[2] https://wiki.documentfoundation.org/Development/ODF_Implementer_Notes/List_of_LibreOffice_ODF_Extensions