Re: [office] Review of style use in ODF 1.3 specifications

[Svante Schubert <svante.schubert@gmail.com>]

Hi Francis,

Thanks for the update! Allow me three follow-up questions & suggestions:

1. How about adding those editing subtasks to JIRA, perhaps those to be fixed for ODF 1.3 CS02 becoming part of OFFICE-4079Âand those for later as a new ODF 1.4 editorialÂissue.
2. What makes your review preliminary? What is missing? Could you point the documents you base your experiencesÂfrom JIRA (and/or put your latest working draft to GitHub)?
   
3. How about adding the automated tooling for changing the styles as part of the ODF-TC repo - these search & replace tasks should be done by automation.

Thanks for your help!

Talks to youÂsoon!

Svante

Am So., 5. Juli 2020 um 23:52ÂUhr schrieb Francis Cave <francis@franciscave.com>:

My action under item 5 of the TC meeting on June 29 was to report in my review of use of styles in the ODF 1.3 specifications.

Â

I have performed a preliminary review of the use of paragraph, character and list styles in Parts 2, 3 and 4 of the specifications, considering all drafts issued between July 2018 and January 2020 (CSD02).

Â

All three Parts exhibit similar problems, of which the main cases are:

Â

• Two or more styles being used for the same purpose within a draft, e.g. the paragraph styles âText Bodyâ and âDefault Styleâ both being used for body text.
• New styles being introduced in later drafts, e.g. the conditional paragraph style âAppendix Headingâ being replaced by the non-conditional paragraph style âAppendixHeading1â in CSD02 only.
• Styles being dropped in later drafts, e.g. the paragraph style âDefault Valueâ, applied to paragraphs that contain default attribute values, was somehow removed from Part 3 in WD13-03 onwards.
• Many styles whose purpose is unclear and which appear to overlap other styles, e.g. in Part 3 there are four character styles âAttribute Valueâ, âAttribute Value Fragmentâ, âAttribute Value Instanceâ and âAttribute Value Paramâ. Another example: Part 4 contains list styles âExample Numberingâ, âNumbering 1â and âNumbering 5â (what happened to âNumbering 2â, ââ 3â and ââ 4â?).
• Poor naming of styles, e.g. the character style âFurmula Subâ [sic] in Part 3, and inconsistent use of title case in style names.
• Lack of stability in style definitions, which seem to change, especially in CSD01 and CSD02, e.g. changes to space above and below paragraphs, font sizes, background colors, etc.

Â

My proposal is that the first Working Draft of ODF 1.4 should be based upon a template in which the named styles are well-defined in terms of their naming conventions, their definitions and their planned usage. For this to be achieved, the editors should ensure that:

Â

• A well-defined style schema is prepared, detailing the names, properties and intended usage of all paragraph, character and list styles.
• There is a single text template to be used as a basis for drafting all Parts of ODF 1.4 and future editions, in which all styles conform to the style schema.
• When ODF 1.3 is issued as a Candidate OASIS Standard, a version of the text of all four Parts is created in which all styles follow the style schema.
• The text so created is imported into the new template to generate a clean working draft of ODF 1.4.

Â

In order to create a well-defined style schema, the editors will need to complete the current review of styles in ODF 1.3, deciding which styles are needed, what properties they should have and how they should be used. I anticipate that this process, ending with the issue of style schema, template and first working draft of ODF 1.4, will take a further two or three weeks.

Â

In order to support work on extracting default attribute values from the Part 3 specification, and to improve the HTML generated from the ODT file, I have already prepared an informal draft of Part 3, based upon CSD02, in which the style definitions are reset to what they were in early working drafts (which corresponded better to the styles used in ODF 1.2) and the paragraph style âDefault Valueâ is re-applied to paragraphs in which default attribute values are specified.

Â

Francis