From 06d90c14b4571184c4ae67067ead9292c94ac026 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Mon, 31 Aug 2015 12:13:01 +0200 Subject: Doc: A simplified style for rendering docs with QTextBrowser Add a new documentation template, with simplified CSS rules that work better when using QTextBrowser as a backend for Qt Assistant or Qt Creator Help. Select this new template by default for offline documentation builds, but keep the old offline template as part of the template files; use JavaScript to switch to the 'standard' CSS when the generated files are viewed with a web browser. Task-number: QTBUG-48322 Change-Id: Ib197896200bb482935f6e9f3a38976133a1e804d Reviewed-by: Venugopal Shivashankar --- .../qt-html-templates-offline-simple.qdocconf | 40 +++++ doc/global/qt-module-defaults-offline.qdocconf | 6 +- doc/global/template/style/offline-simple.css | 176 +++++++++++++++++++++ 3 files changed, 221 insertions(+), 1 deletion(-) create mode 100644 doc/global/qt-html-templates-offline-simple.qdocconf create mode 100644 doc/global/template/style/offline-simple.css (limited to 'doc') diff --git a/doc/global/qt-html-templates-offline-simple.qdocconf b/doc/global/qt-html-templates-offline-simple.qdocconf new file mode 100644 index 0000000000..b19bdd513f --- /dev/null +++ b/doc/global/qt-html-templates-offline-simple.qdocconf @@ -0,0 +1,40 @@ +#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 +HTML.headerstyles = \ + " \n" \ + " \n" + +HTML.postheader = \ + "\n" \ + "
\n"\ + "
\n" \ + "
\n" \ + "
\n" \ + " \n" + +HTML.postpostheader = \ + "
\n"\ + "
\n" \ + "
\n" \ + "
\n" \ + "
\n" \ + "
\n" + +# Add some padding around code snippets, as we cannot +# currectly style them for QTextBrowser using only CSS. +codeindent = 2 +codeprefix = "\n\n" +codesuffix = "\n\n" diff --git a/doc/global/qt-module-defaults-offline.qdocconf b/doc/global/qt-module-defaults-offline.qdocconf index af7afdd96f..36874e8fc1 100644 --- a/doc/global/qt-module-defaults-offline.qdocconf +++ b/doc/global/qt-module-defaults-offline.qdocconf @@ -7,7 +7,11 @@ include(qt-cpp-defines.qdocconf) include(compat.qdocconf) include(manifest-meta.qdocconf) include(fileextensions.qdocconf) -include(qt-html-templates-offline.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) #extra configuration data such as file extensions include(config.qdocconf) diff --git a/doc/global/template/style/offline-simple.css b/doc/global/template/style/offline-simple.css new file mode 100644 index 0000000000..3e1c527761 --- /dev/null +++ b/doc/global/template/style/offline-simple.css @@ -0,0 +1,176 @@ +body { + font-size: 14px; +} + +pre { + background-color: #f0f0f0; + font-family: Courier, monospace; + font-size: 15px; + font-weight: 600; + vertical-align: top; + margin: 15px 85px 15px 35px; + padding: 25px; + width: 90%; + overflow-x:auto; +} + +pre a[href] { + color: #5caa15; +} + +p { + width: 70%; + margin: 15px 0px 10px 15px; +} + +table p { + margin: 0px; + padding: 0px; +} + +a[href] { + color: #007330; + text-decoration: none; +} + +/* Different color for ext. links */ +a[href|="http://"], a[href|="https://"] { + color: #6bb8db; +} + +h1.title { + margin-top: 30px; + margin-left: 6px; + font-size: 32px; + padding: 6px; +} + +h2, p.h2 { + background-color: #F2F3F4; + padding: 4px; + margin: 30px 0px 20px 10px; +} + +h3 { + font-size: 16px; + margin: 30px 0px 30px 6px; +} + +ul, ol { + margin-top: 4px; + margin-bottom: 0px; +} + +ul li, ol li { + margin-bottom: 8px; +} + +.mainContent li.level2 { + margin-left: 16px; +} + +.rightAlign { + text-align: right; +} + +h3.fn, span.fn { + border-width: 3px; + border-style: solid; + border-color: #aaaaaa; + background-color: #eeeeee; + word-spacing: 3px; + padding: 5px; + text-decoration: none; + font-weight: 400; + font-size: 16px; + margin: 45px 0px 0px 6px; +} + +table { + max-width: 80%; + padding: 15px 45px 15px 15px; +} + +table th { + text-align: left; + padding: 8px; +} + +table td { + padding: 6px 10px 6px 10px; +} + +table tr.odd { + background-color: #eeeeee; +} + +table.qmlname td { + padding: 0px; + margin-left: 6px; + font-size: 16px; +} + +table.qmlname p .name, +h3.fn .name, h3.fn .type { + font-weight: bold; +} + +.context h3.fn { + font-weight: 400; +} + +.qmlreadonly, .qmldefault { + font-family: Courier, monospace; + margin-right: 6px; +} + +tr > td > pre { + font-size: 14px; +} + +code { + font-family: Courier, monospace; + font-size: 16px; + font-weight: 400; +} + +p.naviNextPrevious { + text-align: right; + margin-right: 40px; +} + +q.prevPage, a.nextPage { + margin-left: 30px; + } + +.toc h3 { + margin: 0px 0px 10px 6px; +} + +.toc ul { + list-style-type: none; +} + +.navigationbar table { + padding: 0; + margin: 0; +} + +.navigationbar table tr { + background-color: #eeeeee; +} + +td#buildversion { + background-color: #ffffff; +} + +.footer, .footer p { + padding: 5px 0px 5px 0px; + margin: 45px 15px 5px 15px; + font-size: 10px; + background-color: #cccccc; +} + +.footer p { + margin: 0px; +} -- cgit v1.2.3