diff options
author | Jerome Pasion <jerome.pasion@digia.com> | 2013-02-19 17:54:54 +0100 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-06-25 14:03:24 +0200 |
commit | b11cb96f282fb1037ad31fbafe279c9a8a8dfeda (patch) | |
tree | a3fbef8df032458b0d7c745edfd40fbe9478de12 /doc/global/html-header-online.qdocconf | |
parent | 7b48954df25930208491a4434127119b1825161d (diff) |
Doc: Fixed QDoc's navigation mechanism.
The HTML pages need to display minimal navigation such
as a link to the module landing page or Qt 5's index.html.
-new variables available in qdocconf files:
navigation.landingpage
navigation.homepage
navigation.cppclassespage
navigation.qmltypespage
buildversion
The navigation variables are for the new navigation bar.
The buildversion variable is to insert documentation build
information into the pages.
Note about compatibility with Qt Creator docs:
The HTML template files for Qt Creator is retained to keep
Qt Creator compatible with 5.0.x and 5.1.x.
Change-Id: Ibb4d7cada19644204457d822b6b77b2aa7b70f8d
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
Diffstat (limited to 'doc/global/html-header-online.qdocconf')
-rw-r--r-- | doc/global/html-header-online.qdocconf | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/doc/global/html-header-online.qdocconf b/doc/global/html-header-online.qdocconf new file mode 100644 index 0000000000..5c21644a39 --- /dev/null +++ b/doc/global/html-header-online.qdocconf @@ -0,0 +1,64 @@ +#HTML Header with Qt Project branding and online links + +HTML.stylesheets = template/style/online.css + +#for including files into the qch file. Relative to the outputdir of a QDoc build. +# $QT_INSTALL_DOCS/qtquick/style/online.css for example +qhp.extraFiles += style/online.css + +HTML.headerstyles = \ + " <link rel=\"stylesheet\" type=\"text/css\" href=\"style/online.css\" />\n" + +HTML.endheader = \ + "</head>\n" + +HTML.postheader = \ + "<body>\n" \ + "<div class=\"header\" id=\"qtdocheader\"></div>\n" \ + " <div class=\"nav\" id=\"qt13a-header\">\n" \ + " <div class=\"qt13a-gradient\">\n" \ + " <div class=\"qt13a-container qt13a-dynamicREMOVE\" >\n" \ + " <div id=\"qt13a-register\">\n" \ + " <a href=\"http://qt-project.org/\">Qt Home</a>\n" \ + " <a href=\"https://bugreports.qt-project.org/\">Bug Tracker</a>\n" \ + " <a href=\"https://codereview.qt-project.org/\">Code Review</a>\n" \ + " </div>\n" \ + " <div class=\"qt13a-sixCol\">\n" \ + " <div id=\"qt13a-logo\">\n" \ + " <a href=\"http://qt-project.org/\" class=\"qt13a-site-logo\">\n" \ + " <img src=\"images/Qt-logo.png\" alt=\"Qt\"></img>\n" \ + " </a>\n" \ + " </div>\n" \ + " <div id=\"qt13a-title_nav\">\n" \ + " <div id=\"qt13a-title\">\n" \ + " <p class=\"qt13a-title\">Qt Documentation Snapshots</p>\n" \ + " </div>\n" \ + " <div class=\"qt13a-nav\">\n" \ + " <ul>\n" \ + " <li>\n" \ + " <a href=\"http://doc-snapshot.qt-project.org\">Snapshots</a>\n" \ + " </li>\n" \ + " <li>\n" \ + " <a href=\"http://qt-project.org/doc\">Released</a>\n" \ + " </li>\n" \ + " <li>\n" \ + " <a href=\"http://doc.qt.digia.com\">Archives</a>\n" \ + " </li>\n" \ + " </ul>\n" \ + " </div>\n" \ + " </div>\n" \ + " </div>\n" \ + " </div>\n" \ + " </div>\n" \ + " </div>\n" \ + " <div class=\"main\">\n" \ + " <div class=\"main-rounded\">\n" \ + " <div class=\"navigationbar\">\n" \ + " <ul>\n" \ + +HTML.postpostheader = \ + " </ul>\n" \ + " </div>\n" \ + "<div class=\"content\">\n" \ + " <div class=\"line\">\n" \ + " <div class=\"content mainContent\">\n" \ |