ToDo List

List of minor fixups/features:

  • Make the DOCX Stub stub optional. There is no reason to have it if the user is OK with using the default styles provided by the python-docx template. It means that the lowest level default hard-coded styles used by Imprint should match what is in that document.
  • Add a step to normalize the configuration when it is loaded: add missing logging keys from the defaults. Add the max caption depth, etc. Defaults should not be implemented through function parameters (e.g., the defaults for haggis.logs.configure_logger). Tag descriptors should not be forced to call state.keywords.get to determine if images should be dumped, for example.
  • For all exceptions that are raised through the engine, add location information before re-raising.
  • Make keywords available in the data configuration. haggis already supports such injection on load.

Internal ToDos

Todo

Some of the last paragraph above probably belongs in the plugin tutorial, not here.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/imprint/checkouts/latest/doc/tutorials/additional_topics_2.rst, line 156.)

Todo

This has been totally changed by the ??? keyword.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/imprint/checkouts/latest/doc/tutorials/plugin_tutorial.rst, line 126.)

Todo

Add an example

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/imprint/checkouts/latest/doc/tutorials/plugin_tutorial.rst, line 128.)

Todo

Add an example

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/imprint/checkouts/latest/doc/tutorials/plugin_tutorial.rst, line 146.)

Todo

Add a big blurb about the fact that this only works because the default list styles are sensibly set in the global defaults file. If not, the most default default list style is actually not very useful (indents by 4 tabs).

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/imprint/checkouts/latest/doc/tutorials/styles_tutorial.rst, line 99.)

Todo

Add the following:

> This tutorial covers the creation of a basic XML tag. It does not delve > into the subject of tags with plugins. This advanced > topic is covered in the content_tutorial.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/imprint/checkouts/latest/doc/tutorials/tag_tutorial.rst, line 39.)