Arcane  4.1.12.0
User documentation
Loading...
Searching...
No Matches
Documentation Customization

This page contains several options for customizing the documentation theme.

This new theme is quite different from the old theme (the default Doxygen theme), so this page allows you to adjust certain elements to have a more pleasant documentation experience.

Each section of this page is dedicated to one option. Generally, there are three elements per section: text indicating whether an option is active or not, an "Enable"/"Disable" button allowing you to activate or deactivate an option, and a "Test Option" button allowing you to see the option's effect directly.

This page has another particularity: it does not call the already activated options. This allows you to revert an option to default if there is a problem. The only way to see the effect of an option on this page is to click the "Test Option" buttons.

Note
Some of these options are experimental and may have undesirable effects (effects which are nevertheless specified when they exist).

Expand Selected Item

This option allows you to expand the sub-pages of the visited item. If you press the "Test Option" button, you will see the option's effect in the left navigation bar.

Once activated, this option will expand the visited item every time, allowing you to view the content of a chapter directly from the navigation bar.



Table of Contents Always Above (Doxygen 1.13.0 and earlier)

This option allows you to display the table of contents above the text. This saves space on the right, which is reserved by default for the table of contents.

Warning
If the table of contents is very large, part of the text will be permanently hidden.
Note
If the options Table of Contents Always Above (Doxygen 1.13.0 and earlier) and Old Table of Contents Location (Doxygen 1.13.0 and earlier) are activated together, the option Old Table of Contents Location (Doxygen 1.13.0 and earlier) will be taken into account.



Old Table of Contents Location (Doxygen 1.13.0 and earlier)

Before the theme update, the table of contents was fixed at the top of the page. This option allows you to restore the original location of the table of contents.

Note
If the options Table of Contents Always Above (Doxygen 1.13.0 and earlier) and Old Table of Contents Location (Doxygen 1.13.0 and earlier) are activated together, the option Old Table of Contents Location (Doxygen 1.13.0 and earlier) will be taken into account.



Page Text Width

This option allows you to modify the width dedicated to displaying the text. This new theme adopts the principles of modern web pages and therefore sets the maximum width a page can take on a large screen. Since this new display mode does not suit everyone, this option allows you to change that.

The theme authors set the width to 1050px (pixels). The slider below allows you to modify this value. After modifying the width, the "Test Option" button allows you to see what it looks like. The "Save Width" button allows you to save the modification in the browser's memory. The "100% Screen Width (old theme)" button allows you to set the width to "100%", which allows you to recover the format of the original theme.





Button to Expand Menu

This option allows you to add another button next to the round button at the bottom of the left menu:

This button, after activating the option, allows you to expand the menu. This allows you to get an overview of all the chapters.

Note
This button will not appear on this page; you must go to another page for it to appear (if the option is activated).