From 04fe7af33fdb3c50171b769baa43195e2613a802 Mon Sep 17 00:00:00 2001
From: Topi Reinio <topi.reinio@digia.com>
Date: Tue, 20 Oct 2015 10:36:57 +0200
Subject: Doc: Improve selection of offline template type

Qt 5.6 now includes a version of the offline documentation template
with simplified CSS suited for rendering HTML with a QTextBrowser
backend.

Select the template in qt-html-templates-offline.qdocconf, instead
of the higher-level qt-module-defaults-offline.qdocconf. This is
better because many projects external to qt5 (including Qt Creator)
do not use qt-module-* includes. This way, we can control the
template selection for all projects from a config file.

Change-Id: I766af422d829f3c9519c5a45093473175363d600
Reviewed-by: Martin Smith <martin.smith@digia.com>
---
 doc/global/qt-html-templates-offline-simple.qdocconf | 10 +---------
 doc/global/qt-html-templates-offline.qdocconf        |  5 +++++
 doc/global/qt-module-defaults-offline.qdocconf       |  5 +----
 3 files changed, 7 insertions(+), 13 deletions(-)

(limited to 'doc')

diff --git a/doc/global/qt-html-templates-offline-simple.qdocconf b/doc/global/qt-html-templates-offline-simple.qdocconf
index b19bdd513f..cd924c64e3 100644
--- a/doc/global/qt-html-templates-offline-simple.qdocconf
+++ b/doc/global/qt-html-templates-offline-simple.qdocconf
@@ -1,16 +1,8 @@
-#include standard set of HTML header and footer.
-include(html-config.qdocconf)
-include(html-header-offline.qdocconf)
-include(html-footer.qdocconf)
-
-# Uncomment if navigation bar is not wanted
-#HTML.nonavigationbar      = "true"
-
 # Specify a custom CSS file used by this template
 HTML.stylesheets  += template/style/offline-simple.css
 qhp.extraFiles    += style/offline-simple.css
 
-# override the header styles
+# Override the header styles
 HTML.headerstyles  = \
     "  <link rel=\"stylesheet\" type=\"text/css\" href=\"style/offline-simple.css\" />\n" \
     "  <script type=\"text/javascript\">\n" \
diff --git a/doc/global/qt-html-templates-offline.qdocconf b/doc/global/qt-html-templates-offline.qdocconf
index cd8315aa9a..d5780a35da 100644
--- a/doc/global/qt-html-templates-offline.qdocconf
+++ b/doc/global/qt-html-templates-offline.qdocconf
@@ -26,3 +26,8 @@ qhp.extraFiles +=   style/offline.css \
                     images/bullet_dn.png \
                     images/bullet_sq.png \
                     images/bgrContent.png
+
+# By default, include override definitions for a simplified template/CSS,
+# suited for rendering HTML with QTextBrowser. Comment out this line to
+# select the standard CSS.
+include(qt-html-templates-offline-simple.qdocconf)
diff --git a/doc/global/qt-module-defaults-offline.qdocconf b/doc/global/qt-module-defaults-offline.qdocconf
index 36874e8fc1..ee9557fe5c 100644
--- a/doc/global/qt-module-defaults-offline.qdocconf
+++ b/doc/global/qt-module-defaults-offline.qdocconf
@@ -8,10 +8,7 @@ include(compat.qdocconf)
 include(manifest-meta.qdocconf)
 include(fileextensions.qdocconf)
 
-# By default, select the 'simple' offline template, suited for rendering
-# HTML with QTextBrowser.
-include(qt-html-templates-offline-simple.qdocconf)
-#include(qt-html-templates-offline.qdocconf)
+include(qt-html-templates-offline.qdocconf)
 
 #extra configuration data such as file extensions
 include(config.qdocconf)
-- 
cgit v1.2.3