diff options
| author | Dimitri van Heesch <doxygen@gmail.com> | 2021-05-09 18:00:27 (GMT) |
|---|---|---|
| committer | Dimitri van Heesch <doxygen@gmail.com> | 2021-05-09 18:00:27 (GMT) |
| commit | cd998a7164e30cee896cccd190846b79ebb4355f (patch) | |
| tree | 36228200640a1cf5e57979b0e755c9d10200d320 | |
| parent | 57ef51ac1d1917f46cd36a9f75aa81bc9c4d086d (diff) | |
| download | Doxygen-cd998a7164e30cee896cccd190846b79ebb4355f.zip Doxygen-cd998a7164e30cee896cccd190846b79ebb4355f.tar.gz Doxygen-cd998a7164e30cee896cccd190846b79ebb4355f.tar.bz2 | |
Reintroducing the sidebar layout via new FULL_SIDEBAR option.
- This new page layout is only enabled if DISABLE_INDEX=YES, GENERATE_TREEVIEW=YES,
and FULL_SIDEBAR=YES.
| -rw-r--r-- | doc/CMakeLists.txt | 1 | ||||
| -rw-r--r-- | doc/customize.doc | 10 | ||||
| -rw-r--r-- | doc/layout_noindex_and_sidebar.png | bin | 0 -> 11914 bytes | |||
| -rw-r--r-- | src/config.xml | 34 | ||||
| -rw-r--r-- | src/htmlgen.cpp | 22 | ||||
| -rw-r--r-- | templates/html/header.html | 16 | ||||
| -rw-r--r-- | templates/html/resize.js | 2 | ||||
| -rw-r--r-- | templates/html/search.css | 178 | ||||
| -rw-r--r-- | templates/html/search_common.css | 178 | ||||
| -rw-r--r-- | templates/html/search_fixedtabs.css | 175 | ||||
| -rw-r--r-- | templates/html/search_nomenu.css | 178 | ||||
| -rw-r--r-- | templates/html/search_sidebar.css | 93 |
12 files changed, 342 insertions, 545 deletions
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 7dbe120..9fc5e26 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -86,6 +86,7 @@ set(DOC_FILES layout_index_and_treeview.png layout_noindex_and_notreeview.png layout_noindex_and_treeview.png + layout_noindex_and_sidebar.png lists.doc markdown.doc output.doc diff --git a/doc/customize.doc b/doc/customize.doc index c95c4c2..55ddbdc 100644 --- a/doc/customize.doc +++ b/doc/customize.doc @@ -59,10 +59,20 @@ you can switch to an interactive navigation tree as sidebar using - \ref cfg_disable_index "DISABLE_INDEX" = \c YES - \ref cfg_generate_treeview "GENERATE_TREEVIEW" = \c YES +- \ref cfg_generate_treeview "FULL_SIDEBAR" = \c NO \image html layout_noindex_and_treeview.png \image latex layout_noindex_and_treeview.png width=8cm +you can also make the content span the title area of the screen using + +- \ref cfg_disable_index "DISABLE_INDEX" = \c YES +- \ref cfg_generate_treeview "GENERATE_TREEVIEW" = \c YES +- \ref cfg_generate_treeview "FULL_SIDEBAR" = \c YES + +\image html layout_noindex_and_sidebar.png +\image latex layout_noindex_and_sidebar.png width=8cm + or even have both forms of navigation: - \ref cfg_disable_index "DISABLE_INDEX" = \c NO diff --git a/doc/layout_noindex_and_sidebar.png b/doc/layout_noindex_and_sidebar.png Binary files differnew file mode 100644 index 0000000..f0cd225 --- /dev/null +++ b/doc/layout_noindex_and_sidebar.png diff --git a/src/config.xml b/src/config.xml index be890c3..1527601 100644 --- a/src/config.xml +++ b/src/config.xml @@ -1914,21 +1914,25 @@ doxygen -w html new_header.html new_footer.html new_stylesheet.css YourConfigFil The following block names are supported: <dl> <dt><code>DISABLE_INDEX</code><dd>Content within this block is copied to the output - when the \ref cfg_disable_index "DISABLE_INDEX" option is enabled (so when the index is disabled). + if the \ref cfg_disable_index "DISABLE_INDEX" option is enabled (so when the index is disabled). <dt><code>GENERATE_TREEVIEW</code><dd>Content within this block is copied to the output - when the \ref cfg_generate_treeview "GENERATE_TREEVIEW" option is enabled. + if the \ref cfg_generate_treeview "GENERATE_TREEVIEW" option is enabled. <dt><code>SEARCHENGINE</code><dd>Content within this block is copied to the output - when the \ref cfg_searchengine "SEARCHENGINE" option is enabled. + if the \ref cfg_searchengine "SEARCHENGINE" option is enabled. <dt><code>PROJECT_NAME</code><dd>Content within the block is copied to the output - when the \ref cfg_project_name "PROJECT_NAME" option is not empty. + if the \ref cfg_project_name "PROJECT_NAME" option is not empty. <dt><code>PROJECT_NUMBER</code><dd>Content within the block is copied to the output - when the \ref cfg_project_number "PROJECT_NUMBER" option is not empty. + if the \ref cfg_project_number "PROJECT_NUMBER" option is not empty. <dt><code>PROJECT_BRIEF</code><dd>Content within the block is copied to the output - when the \ref cfg_project_brief "PROJECT_BRIEF" option is not empty. + if the \ref cfg_project_brief "PROJECT_BRIEF" option is not empty. <dt><code>PROJECT_LOGO</code><dd>Content within the block is copied to the output - when the \ref cfg_project_logo "PROJECT_LOGO" option is not empty. + if the \ref cfg_project_logo "PROJECT_LOGO" option is not empty. + <dt><code>FULL_SIDEBAR</code><dd>Content within the block is copied to the output + if the \ref cfg_full_sidebar "FULL_SIDEBAR", + \ref cfg_disable_index "DISABLE_INDEX" and \ref cfg_generate_treeview "GENERATE_TREEVIEW" + options are all enabled. <dt><code>TITLEAREA</code><dd>Content within this block is copied to the output - when a title is visible at the top of each page. This is the case + if a title is visible at the top of each page. This is the case if either \ref cfg_project_name "PROJECT_NAME", \ref cfg_project_brief "PROJECT_BRIEF", \ref cfg_project_logo "PROJECT_LOGO" is filled in or if both \ref cfg_disable_index "DISABLE_INDEX" and @@ -2391,7 +2395,21 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. ]]> </docs> </option> + <option type='bool' id='FULL_SIDEBAR' defval='0' depends='GENERATE_HTML'> + <docs> +<![CDATA[ + When both \c GENERATE_TREEVIEW and \c DISABLE_INDEX are set to YES, then the + \c FULL_SIDEBAR option determines if the side bar is limited to only the + treeview area (value \c NO) or if it should extend to the full height of the + window (value \c YES). Setting this to \c YES gives a layout similar to + https://docs.readthedocs.io with more room for contents, + but less room for the project logo, title, and description. + If either \c GENERATOR_TREEVIEW or \c DISABLE_INDEX is set to \c NO, this option + has no effect. +]]> + </docs> + </option> <option type='int' id='ENUM_VALUES_PER_LINE' minval='0' maxval='20' defval='4' depends='GENERATE_HTML'> <docs> <