From cd998a7164e30cee896cccd190846b79ebb4355f Mon Sep 17 00:00:00 2001 From: Dimitri van Heesch Date: Sun, 9 May 2021 20:00:27 +0200 Subject: 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. --- doc/CMakeLists.txt | 1 + doc/customize.doc | 10 ++ doc/layout_noindex_and_sidebar.png | Bin 0 -> 11914 bytes src/config.xml | 34 +++++-- src/htmlgen.cpp | 22 +++-- templates/html/header.html | 16 ++++ templates/html/resize.js | 2 +- templates/html/search.css | 178 ------------------------------------ templates/html/search_common.css | 178 ++++++++++++++++++++++++++++++++++++ templates/html/search_fixedtabs.css | 175 ----------------------------------- templates/html/search_nomenu.css | 178 +----------------------------------- templates/html/search_sidebar.css | 93 +++++++++++++++++++ 12 files changed, 342 insertions(+), 545 deletions(-) create mode 100644 doc/layout_noindex_and_sidebar.png create mode 100644 templates/html/search_common.css create mode 100644 templates/html/search_sidebar.css 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 new file mode 100644 index 0000000..f0cd225 Binary files /dev/null and b/doc/layout_noindex_and_sidebar.png differ 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:
DISABLE_INDEX
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).
GENERATE_TREEVIEW
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.
SEARCHENGINE
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.
PROJECT_NAME
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.
PROJECT_NUMBER
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.
PROJECT_BRIEF
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.
PROJECT_LOGO
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. +
FULL_SIDEBAR
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.
TITLEAREA
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. ]]> +