AuroraMiddleware/qt5base-lts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
dd0c886783
qt5base-lts/doc/global/qt-html-templates-offline-simple.qdocconf

30 lines
1.2 KiB
Plaintext
Raw Normal View History

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 <venugopal.shivashankar@digia.com>
2015-08-31 10:13:01 +00:00
# Specify a custom CSS file used by this template
HTML.stylesheets += template/style/offline-simple.css
qhp.extraFiles += style/offline-simple.css
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>
2015-10-20 08:36:57 +00:00
# Override the header styles
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 <venugopal.shivashankar@digia.com>
2015-08-31 10:13:01 +00:00
HTML.headerstyles = \
" <link rel=\"stylesheet\" type=\"text/css\" href=\"style/offline-simple.css\" />\n" \
" <script type=\"text/javascript\">\n" \
Fix navigation with offline style When the switching to the non-simple offline style is done after document load, the navigation to anchors completely breaks. So, do the switch without the additional delay. Task-number: QTCREATORBUG-18448 Change-Id: I5abbc3bbe1c743d2a5e493bb9e0916c5d092942a Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2017-06-26 13:52:59 +00:00
" document.getElementsByTagName(\"link\").item(0).setAttribute(\"href\", \"style/offline.css\");\n" \
Fix jumping to anchors with offline style If the style changes after the browser already jumped to an anchor, the resulting browser position will be messed up. So, after we changed the style we need to make sure that we jump to the anchor again. Since browsers do not jump to anchors that they already jumped to, that means first jumping to the top, then to the actual anchor. Task-number: QTCREATORBUG-18448 Change-Id: I86c736adab6940903276f8a896b4054ddae11ebe Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2017-07-21 07:57:00 +00:00
" // loading style sheet breaks anchors that were jumped to before\n" \
" // so force jumping to anchor again\n" \
" setTimeout(function() {\n" \
" var anchor = location.hash;\n" \
" // need to jump to different anchor first (e.g. none)\n" \
" location.hash = \"#\";\n" \
" setTimeout(function() {\n" \
" location.hash = anchor;\n" \
" }, 0);\n" \
" }, 0);\n" \
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 <venugopal.shivashankar@digia.com>
2015-08-31 10:13:01 +00:00
" </script>\n"
Doc: Use a navigation separator in the simple offline template As we cannot style the navigation elements freely with the restricted version of CSS that QTextBrowser supports, we need to inject separator elements between the prev/next page links. This change adds a 'bullet' character wrapped in a <span> as a separator. A rule is added to the standard offline CSS to hide the separator as it's not needed there. Change-Id: I13220a2a60e2d3063f94bc7dff0e4320d0bed4f6 Reviewed-by: Martin Smith <martin.smith@digia.com>
2015-10-27 11:12:43 +00:00
HTML.navigationseparator = \
"<span class=\"naviSeparator\"> &#9702; </span>\n"
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 <venugopal.shivashankar@digia.com>
2015-08-31 10:13:01 +00:00
# Add some padding around code snippets, as we cannot
# currectly style them for QTextBrowser using only CSS.
Doc: Adjust offline style for the litehtml rendering engine Qt Creator now has the option to use the litehtml backend as a replacement for the QTextBrowser-based help viewer. Fix a few issues that the offline style has with the litehtml renderer: - Fall back to using an unordered list for the navigation bar. - Remove the background image for #buildversion and adjust font size. - Adjust the generated padding around code snippets. Keep the script that switches the offline-simple.css style to the full offline style (offline.css) for JavaScript-enabled browsers. The litehtml backend in Qt Creator will handle this switch internally. With these changes, the generated offline documentation looks acceptable when rendered with QTextBrowser, litehtml, or desktop web browsers. Fixes: QTBUG-82567 Change-Id: I86b179b1985b7ef54feddab30cb227b28021efe5 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-03-23 10:08:23 +00:00
codeindent = 1
codeprefix = "\n"
codesuffix = "\n"
Reference in New Issue Copy Permalink