Bug #4131
openosmo-gsm-manuals: Use leveloffset attribute on common documents
0%
Description
Right now, all documents under osmo-gsm-manuals.git/commons/ start with title level 1 (==). However, if one wishes to add a document with level 2 (===) so it can also be included in other repository document, it will make osmo-gsm-manuals.git "make check" fail due to osmo-gsm-manuals/tests/Makefile.am:22:
echo "include::$${chapter}[]" >> $@; \
Which includes stuff under a test document with level 0 (=). If a document with level different than 1 (==) is added, then it will fail on some versions (like jenkins):
"asciidoc: WARNING: mgcp_extension_osmux.adoc: line 2: section title out of sequence: expected level 1, got level 2"
See for instance commit osmo-gsm-manuals.git 061cca4d7345bc4f496324d0b4d30bc51e1f8d23, which had to be fixed up later.
The solution here is to use "leveloffset" attribute. To make our life easier in the future, we need to move all documents under common/ to start with level 0 (=), and then use "leveloffset" on all includes in all other repositories using them. This way same document can easily be added on different levels on different documents.
Important! It seems this syntax doesn't work for me:
include::chapter2.adoc[leveloffset=+1]
However, this does and it's basically the same:
:leveloffset: 1 include::chapter1.adoc[] :leveloffset: 0
Related information:
https://github.com/asciidoctor/asciidoctor.org/blob/master/docs/_includes/include-directive.adoc
https://mrhaki.blogspot.com/2016/09/awesome-asciidoctor-change-level-offset.html
http://asciidoc.org/userguide.txt
Related issues
