© 2004
Canonical Ltd.
•
Terms of use
•
Data privacy
•
Contact Launchpad Support
•
Blog
•
Careers
•
System status
•
1b1ed1a
(Get the code!)
Here are my thoughts right now:
Antora will automatically set the "title" of the browser page when the document has a "title" which is translated from the main heading line in the document. I've noticed that some of our documents start out with level 2 headers (Example):
Parts Level Hold
~~~~~~~~~~~~~~~~
Which is the "second" heading. The main heading needs to look like this:
Main Header
===========
We have a small issue here. As-is, the Antora pages will have HTML in the <head> block that looks like this:
<title>Untitled :: Evergreen Documentation<
We could write a script to automatically change all of our docs to have the main header. While we are at it, I was thinking that it would be nice to convert all of the headings to the "other" syntax. Like this:
From:
Parts Level Hold
~~~~~~~~~~~~~~~~
to:
=== Parts Level Hold ===
and
Placing Multiple Holds on Same Title
^^^^^^^
to
==== Placing Multiple Holds on Same Title ====
and
Holds Pull List
+++++++++++++++
to
===== Holds Pull List =====
It seems that we have skipped "Level 1" sometimes? Lifted from https:/
Level 1
-------
Text.
Level 2
~~~~~~~
Text.
Level 3
^^^^^^^
Text.
Level 4
+++++++
Text.
Looking at our wiki:
https:/
We direct people to https:/
I assume in the cases where we don't have a main header we should? In those cases should we "upgrade" level 2 -> 1 and 3 -> 2 and 4 -> 3 ?
Also - a table of contents (per page) would be nice. The same script could also add the :toc: syntax directly below the main header.
In summary
1. Create a main header line for documents that don't have one (and upgrade the other headings up a level in those cases)
2. Convert the header style lines to moustache style (number of equal signs on each side)
3. Add a table of contents to each document where one doesn't appear.