Added new layout option: full height side bar + navigation tabs

To enable this layout set:
- DISABLE_INDEX     = NO
- GENERATE_TREEVIEW = YES
- FULL_SIDEBAR      = YES

Author: doxygen

doc/CMakeLists.txt

@@ -115,6 +115,7 @@ set(DOC_FILES
         install.dox
         layout_index_and_notreeview.png
         layout_index_and_treeview.png
+        layout_index_and_sidebar.png
         layout_noindex_and_notreeview.png
         layout_noindex_and_treeview.png
         layout_noindex_and_sidebar.png

doc/customize.dox

@@ -81,10 +81,20 @@ or even have both forms of navigation:
 
 - \ref cfg_disable_index "DISABLE_INDEX" = \c NO
 - \ref cfg_generate_treeview "GENERATE_TREEVIEW" = \c YES
+- \ref cfg_full_sidebar "FULL_SIDEBAR" = \c NO
 
 \image html layout_index_and_treeview.png
 \image latex layout_index_and_treeview.png width=8cm
 
+and this also works with the side bar spanning the full height
+
+- \ref cfg_disable_index "DISABLE_INDEX" = \c NO
+- \ref cfg_generate_treeview "GENERATE_TREEVIEW" = \c YES
+- \ref cfg_full_sidebar "FULL_SIDEBAR" = \c YES
+
+\image html layout_index_and_sidebar.png
+\image latex layout_index_and_sidebar.png width=8cm
+
 if you already use an external index (i.e. have one of the following
 options enabled
 \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP",

doc/layout_index_and_sidebar.png

@@ -108,7 +108,7 @@ static void writeServerSearchBox(TextStream &t,const QCString &relPath,bool high
   }
   t << "\" method=\"get\">\n";
   t << "              <span id=\"MSearchSelectExt\">&#160;</span>\n";
-  if (!highlightSearch)
+  if (!highlightSearch || !Config_getBool(HTML_DYNAMIC_MENUS))
   {
     t << "              <input type=\"text\" id=\"MSearchField\" name=\"query\" value=\"\" placeholder=\""
       << theTranslator->trSearch() << "\" size=\"20\" accesskey=\"S\" \n";
@@ -343,7 +343,7 @@ static QCString substituteHtmlKeywords(const QCString &str,
   bool hasProjectBrief = !Config_getString(PROJECT_BRIEF).isEmpty();
   bool hasProjectLogo = !Config_getString(PROJECT_LOGO).isEmpty();
   bool hasProjectIcon = !Config_getString(PROJECT_ICON).isEmpty();
-  bool hasFullSideBar = Config_getBool(FULL_SIDEBAR) && disableIndex && treeView;
+  bool hasFullSideBar = Config_getBool(FULL_SIDEBAR) && /*disableIndex &&*/ treeView;
   bool hasCopyClipboard = Config_getBool(HTML_COPY_CLIPBOARD);
   bool hasCookie = treeView || searchEngine || Config_getEnum(HTML_COLORSTYLE)==HTML_COLORSTYLE_t::TOGGLE;
   static bool titleArea = (hasProjectName || hasProjectBrief || hasProjectLogo || (disableIndex && searchEngine));
@@ -425,7 +425,7 @@ static QCString substituteHtmlKeywords(const QCString &str,
 
     if (!serverBasedSearch)
     {
-      if (disableIndex || !Config_getBool(HTML_DYNAMIC_MENUS))
+      if (disableIndex || !Config_getBool(HTML_DYNAMIC_MENUS) || Config_getBool(FULL_SIDEBAR))
       {
         searchCssJs += "<script type=\"text/javascript\">\n"
 					"/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */\n"
@@ -2818,25 +2818,36 @@ static void renderQuickLinksAsTabs(TextStream &t,const QCString &relPath,
       {
         bool searchEngine      = Config_getBool(SEARCHENGINE);
         bool serverBasedSearch = Config_getBool(SERVER_BASED_SEARCH);
+        bool disableIndex      = Config_getBool(DISABLE_INDEX);
+        bool generateTreeView  = Config_getBool(GENERATE_TREEVIEW);
+        bool fullSidebar       = Config_getBool(FULL_SIDEBAR);
+        // case where DISABLE_INDEX=NO & GENERATE_TREEVIEW=YES & FULL_SIDEBAR=YES has search box in the side panel
         if (searchEngine)
         {
           t << "      <li>\n";
-          if (!serverBasedSearch) // pure client side search
+          if (disableIndex || !generateTreeView || !fullSidebar)
           {
-            writeClientSearchBox(t,relPath);
-            t << "      </li>\n";
-          }
-          else // server based search
-          {
-            writeServerSearchBox(t,relPath,highlightSearch);
-            if (!highlightSearch)
+            if (!serverBasedSearch) // pure client side search
             {
+              writeClientSearchBox(t,relPath);
               t << "      </li>\n";
             }
+            else // server based search
+            {
+              writeServerSearchBox(t,relPath,highlightSearch);
+              if (!highlightSearch)
+              {
+                t << "      </li>\n";
+              }
+            }
+          }
+          else
+          {
+            t << "      </li>\n";
           }
         }
-        if (!highlightSearch) // on the search page the index will be ended by the
-          // page itself
+        if (!highlightSearch || Config_getBool(FULL_SIDEBAR))
+          // on the search page the index will be ended by the page itself if the search box is part of the navigation bar
         {
           endQuickIndexList(t);
         }
@@ -2855,9 +2866,11 @@ static void writeDefaultQuickLinks(TextStream &t,
                                    const QCString &relPath)
 {
   bool serverBasedSearch = Config_getBool(SERVER_BASED_SEARCH);
-  bool searchEngine = Config_getBool(SEARCHENGINE);
-  bool externalSearch = Config_getBool(EXTERNAL_SEARCH);
-  bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
+  bool searchEngine      = Config_getBool(SEARCHENGINE);
+  bool externalSearch    = Config_getBool(EXTERNAL_SEARCH);
+  bool generateTreeView  = Config_getBool(GENERATE_TREEVIEW);
+  bool fullSidebar       = Config_getBool(FULL_SIDEBAR);
+  bool disableIndex      = Config_getBool(DISABLE_INDEX);
   LayoutNavEntry *root = LayoutDocManager::instance().rootNavEntry();
   LayoutNavEntry::Kind kind = LayoutNavEntry::None;
   LayoutNavEntry::Kind altKind = LayoutNavEntry::None; // fall back for the old layout file
@@ -2908,7 +2921,7 @@ static void writeDefaultQuickLinks(TextStream &t,
     case HighlightedItem::Search: break;
   }
 
-  if (!Config_getBool(DISABLE_INDEX) && Config_getBool(HTML_DYNAMIC_MENUS))
+  if (!disableIndex && Config_getBool(HTML_DYNAMIC_MENUS))
   {
     QCString searchPage;
     if (externalSearch)
@@ -2925,7 +2938,7 @@ static void writeDefaultQuickLinks(TextStream &t,
     t << "/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */\n";
     t << "$(function() {\n";
     t << "  initMenu('" << relPath << "',"
-      << (searchEngine?"true":"false") << ","
+      << (searchEngine && !(generateTreeView && fullSidebar)?"true":"false") << ","
       << (serverBasedSearch?"true":"false") << ",'"
       << searchPage << "','"
       << theTranslator->trSearch() << "',"
@@ -2949,7 +2962,7 @@ static void writeDefaultQuickLinks(TextStream &t,
     t << "</script>\n";
     t << "<div id=\"main-nav\"></div>\n";
   }
-  else if (!Config_getBool(DISABLE_INDEX)) // && !Config_getBool(HTML_DYNAMIC_MENUS)
+  else if (!disableIndex) // && !Config_getBool(HTML_DYNAMIC_MENUS)
   {
     // find highlighted index item
     LayoutNavEntry *hlEntry = root->find(kind,kind==LayoutNavEntry::UserGroup ? file : QCString());
@@ -2971,12 +2984,18 @@ static void writeDefaultQuickLinks(TextStream &t,
         hlEntry = e;
       }
     }
+    t << "<div id=\"main-nav\">\n";
     renderQuickLinksAsTabs(t,relPath,hlEntry,kind,highlightParent,hli==HighlightedItem::Search);
+    t << "</div>\n";
   }
-  else if (!Config_getBool(GENERATE_TREEVIEW))
+  else if (!generateTreeView)
   {
     renderQuickLinksAsTree(t,relPath,root);
   }
+  if (generateTreeView && !disableIndex && fullSidebar)
+  {
+     t << "<div id=\"doc-content\">\n";
+  }
 }
 
 void HtmlGenerator::endQuickIndices()
@@ -2998,12 +3017,12 @@ QCString HtmlGenerator::writeSplitBarAsString(const QCString &name,const QCStrin
   {
     QCString fn = name;
     addHtmlExtensionIfMissing(fn);
-    if (!Config_getBool(DISABLE_INDEX) || !Config_getBool(FULL_SIDEBAR))
+    if (/*!Config_getBool(DISABLE_INDEX) ||*/ !Config_getBool(FULL_SIDEBAR))
     {
       result += QCString(
         "<div id=\"side-nav\" class=\"ui-resizable side-nav-resizable\">\n");
     }
-    result+= QCString(
+    result+=
      "  <div id=\"nav-tree\">\n"
      "    <div id=\"nav-tree-contents\">\n"
      "      <div id=\"nav-sync\" class=\"sync\"></div>\n"
@@ -3015,12 +3034,15 @@ QCString HtmlGenerator::writeSplitBarAsString(const QCString &name,const QCStrin
      "</div>\n"
      "<script type=\"text/javascript\">\n"
      "/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */\n"
-     "$(function(){initNavTree('") + fn +
-     QCString("','") + relpath +
-     QCString("'); initResizable(true); });\n"
+     "$(function(){initNavTree('" + fn +
+     "','" + relpath +
+     "'); initResizable(true); });\n"
      "/* @license-end */\n"
-     "</script>\n"
-     "<div id=\"doc-content\">\n");
+     "</script>\n";
+     if (Config_getBool(DISABLE_INDEX) || !Config_getBool(FULL_SIDEBAR))
+     {
+       result+="<div id=\"doc-content\">\n";
+     }
   }
   else
   {
@@ -3071,10 +3093,12 @@ void HtmlGenerator::writeQuickLinks(HighlightedItem hli,const QCString &file)
 // PHP based search script
 void HtmlGenerator::writeSearchPage()
 {
-  bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
-  bool disableIndex = Config_getBool(DISABLE_INDEX);
-  QCString projectName = Config_getString(PROJECT_NAME);
-  QCString htmlOutput = Config_getString(HTML_OUTPUT);
+  bool disableIndex            = Config_getBool(DISABLE_INDEX);
+  bool generateTreeView        = Config_getBool(GENERATE_TREEVIEW);
+  bool fullSidebar             = Config_getBool(FULL_SIDEBAR);
+  bool quickLinksAfterSplitbar = !disableIndex && generateTreeView && fullSidebar;
+  QCString projectName         = Config_getString(PROJECT_NAME);
+  QCString htmlOutput          = Config_getString(HTML_OUTPUT);
 
   // OPENSEARCH_PROVIDER {
   QCString configFileName = htmlOutput+"/search_config.php";
@@ -3087,6 +3111,7 @@ void HtmlGenerator::writeSearchPage()
     t << "  'PROJECT_NAME' => \"" << convertToHtml(projectName) << "\",\n";
     t << "  'GENERATE_TREEVIEW' => " << (generateTreeView?"true":"false") << ",\n";
     t << "  'DISABLE_INDEX' => " << (disableIndex?"true":"false") << ",\n";
+    t << "  'FULL_SIDEBAR' => " << (fullSidebar?"true":"false") << ",\n";
     t << ");\n\n";
     t << "$translator = array(\n";
     t << "  'search_results_title' => \"" << theTranslator->trSearchResultsTitle() << "\",\n";
@@ -3097,7 +3122,6 @@ void HtmlGenerator::writeSearchPage()
     t << "  ),\n";
     t << "  'search_matches' => \"" << theTranslator->trSearchMatches() << "\",\n";
     t << "  'search' => \"" << theTranslator->trSearch() << "\",\n";
-    t << "  'split_bar' => \"" << substitute(substitute(writeSplitBarAsString("search",""), "\"","\\\""), "\n","\\n") << "\",\n";
     t << "  'logo' => \"" << substitute(substitute(writeLogoAsString(""), "\"","\\\""), "\n","\\n") << "\",\n";
     t << ");\n\n";
     t << "?>\n";
@@ -3123,14 +3147,21 @@ void HtmlGenerator::writeSearchPage()
       << "search/\",'" << Doxygen::htmlFileExtension << "');\n";
 		t << "/* @license-end */\n";
     t << "</script>\n";
-    if (!Config_getBool(DISABLE_INDEX))
+
+    if (!disableIndex && !quickLinksAfterSplitbar)
     {
       writeDefaultQuickLinks(t,HighlightedItem::Search,QCString(),QCString());
     }
-    else
+    if (generateTreeView)
     {
-      t << "</div>\n";
+      t << "</div><!-- top -->\n";
     }
+    t << writeSplitBarAsString("search.php",QCString());
+    if (quickLinksAfterSplitbar)
+    {
+      writeDefaultQuickLinks(t,HighlightedItem::Search,QCString(),QCString());
+    }
+    t << "<!-- generated -->\n";
 
     t << "<?php\n";
     t << "require_once \"search_functions.php\";\n";
@@ -3162,9 +3193,12 @@ void HtmlGenerator::writeSearchPage()
 
 void HtmlGenerator::writeExternalSearchPage()
 {
-  bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
-  QCString dname = Config_getString(HTML_OUTPUT);
-  QCString fileName = dname+"/search"+Doxygen::htmlFileExtension;
+  bool disableIndex            = Config_getBool(DISABLE_INDEX);
+  bool generateTreeView        = Config_getBool(GENERATE_TREEVIEW);
+  bool fullSidebar             = Config_getBool(FULL_SIDEBAR);
+  bool quickLinksAfterSplitbar = !disableIndex && generateTreeView && fullSidebar;
+  QCString dname               = Config_getString(HTML_OUTPUT);
+  QCString fileName            = dname+"/search"+Doxygen::htmlFileExtension;
   std::ofstream f = Portable::openOutputStream(fileName);
   if (f.is_open())
   {
@@ -3179,27 +3213,21 @@ void HtmlGenerator::writeExternalSearchPage()
       << "search/\",'" << Doxygen::htmlFileExtension << "');\n";
 		t << "/* @license-end */\n";
     t << "</script>\n";
-    if (!Config_getBool(DISABLE_INDEX))
+
+    if (!disableIndex && !quickLinksAfterSplitbar)
     {
       writeDefaultQuickLinks(t,HighlightedItem::Search,QCString(),QCString());
-      if (!Config_getBool(HTML_DYNAMIC_MENUS)) // for dynamic menus, menu.js creates this part
-      {
-        t << "            <input type=\"text\" id=\"MSearchField\" name=\"query\" value=\"\" placeholder=\"" << theTranslator->trSearch() <<
-             "\" size=\"20\" accesskey=\"S\" onfocus=\"searchBox.OnSearchFieldFocus(true)\" onblur=\"searchBox.OnSearchFieldFocus(false)\"/>\n";
-      }
-      t << "            </form>\n";
-      t << "          </div><div class=\"right\"></div>\n";
-      t << "        </div>\n";
-      t << "      </li>\n";
-      t << "    </ul>\n";
-      t << "  </div>\n";
-      t << "</div>\n";
     }
-    else
+    if (generateTreeView)
     {
-      t << "</div>\n";
+      t << "</div><!-- top -->\n";
     }
-    t << writeSplitBarAsString("search","");
+    t << writeSplitBarAsString("search.php",QCString());
+    if (quickLinksAfterSplitbar)
+    {
+      writeDefaultQuickLinks(t,HighlightedItem::Search,QCString(),QCString());
+    }
+
     t << "<div class=\"header\">\n";
     t << "  <div class=\"headertitle\">\n";
     t << "    <div class=\"title\">" << theTranslator->trSearchResultsTitle() << "</div>\n";