Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance HTML/CSS of the generated ODF documentation #183

Open
svanteschubert opened this issue Sep 15, 2022 · 0 comments
Open

Enhance HTML/CSS of the generated ODF documentation #183

svanteschubert opened this issue Sep 15, 2022 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@svanteschubert
Copy link
Contributor

With the update of the ODFDOM Java generation, the generation of the ODF documentation was updated as well, but the HTML/CSS format is still very bad, perhaps someone would like to give it a try!

Yesterday, I just spend an hour testing & updating a few things (but only updated the ODF 1.3 references).

The former/current way for ODF 1.2: https://tdf.github.io/odftoolkit/odf1.2/OpenDocument-v1.2-reference.html
A slightly updated documentation for ODF 1.3: https://tdf.github.io/odftoolkit/odf1.3/OpenDocument-v1.3-reference.html

If someone would like to give the Velocity Template a try:
https://github.com/tdf/odftoolkit/blob/odf-codegen/generator/schema2template/src/test/resources/test-input/odf/generation/odf-reference/odf-reference-template.vm

Velocity Syntax is pretty straightforward:
https://velocity.apache.org/engine/2.3/user-guide.html

The syntax is likely best viewed and edited by the Visual Studio Code extension - https://marketplace.visualstudio.com/items?itemName=Quidgest.vscode-velocity

In the OdfReference.html we might also link to the ODF elements & attributes description of the ODF specification (there is a fragment identifier pattern)

  1. https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part3-schema/OpenDocument-v1.3-os-part3-schema.html#element-table_table
  2. https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part3-schema/OpenDocument-v1.3-os-part3-schema.html#attribute-table_protected

and the RNG grammar that I have added to the standard as HTML:

  1. http://docs.oasis-open.org/office/OpenDocument/v1.3/os/schemas/OpenDocument-v1.3-schema-rng.html#table-table

(just realized that only RNG definitions are being referenced, this can be improved and is not yet fully generated either, see https://github.com/oasis-tcs/odf-tc/blob/master/src/test/resources/odf1.3/tools/rng2html/HowToCreateRNG-HTML.md)

PS: I believe one VSCode Velocity plugin was able to indent the velocity files (but I wanted to postpone that till build & tests worked. If someone figures this out, we might switch the whitespace gobbling of Velocity in the generator)

@svanteschubert svanteschubert added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Sep 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant