Works the same as in our PBS documentation and is generally common for
documentations.
Very useful for linking specific sections of the documentation in other
places. Previously, this always had to be done by getting the correct
anchor from the HTML directly via e.g. browser devtools.
Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
Tested-by: Max Carrara <m.carrara@proxmox.com>
In the manpage output the sections get rendered as refsections, but
those only go up to level 3:
> In DocBook, RefSect3 is the lowest-level section allowed in a
> RefEntry. There is no element analogous to a Sect4.
-- https://tdg.docbook.org/tdg/4.5/refsect3
While nesting refsect3 would work output wise, the DTD schema does not
allows this, and disabling schema validation can lead to graver
issues, so rather avoid that and use a formalpara [0], a paragraph
with a title, instead, but only for the title, as the inner content
will be a simpara (simple paragraph) that cannot be nested inside a
formalpara, but the resulting rendering works out well enough.
[0]: https://tdg.docbook.org/tdg/4.5/formalpara
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
Else h6 was quite a bit tinier than the actual paragraph text, and it
doesn't hurts that h4 stands a bit out more.
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
E.g., render them as h6 for the HTML output.
Level 5 headings are the +++++ ones in the full page output, in the
per-chapter outputs they are level 4 and worked fine already.
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
The inline icons for admotions (note, tip, warning, ...) are missing
on builts with the asciidoc package shipped by Debian Bookworm.
As workaround set the "iconsdir" attribute manually to
"/usr/share/asciidoc/icons", as recommend by the DM in the respective
Debian bug report [0].
[0]: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1036030#10
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
there are a few more changes to last stable upstream asciidoc 9.1.0
release, but for now port only those over which are absolutely
necessary.
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
break-work affects very long lines on all widths, as pre/monospaced
elements are limited in their available width. This is only a
rendering word break, i.e., if one copies the data they will get the
original "unbroken" one.
The "max-width=100%" enforces only better visuals where space is
limited anyway.
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
To change the codename for Ceph in one place, the patch adds the
asciidoc attribute 'ceph_codename'. Replaces the outdated references to
luminous and the http -> https on the links in pveceph.adoc.
Signed-off-by: Alwin Antreich <a.antreich@proxmox.com>
Requested by Martin as the support@ address is now quite wired to the
enterprise support ticket system, and office is for more general
requests.
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
we save quite a few build (reverse-)dependencies with this change
rsvg-convert is also a lot faster.
both use the same backend to process SVGs – cairo
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
We can define PVE related attributes here (will replace attributes.txt).
Install all asciidoc-pve config files to /usr/share/pve-doc-generator/asciidoc
