Add a line to load footer content from the global style folder.
Change-Id: If57f13c2301e6145a26b3a4d04c7cb4695fe55fe
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
Add two- and three-column layouts for the 'All C++ Classes'
list. Also affects the layout of 'All QML Types' page.
Task-number: QTBUG-49376
Change-Id: I80953c0955dbc37db5aa4c60eb9ea8e3023a77f2
Reviewed-by: Martin Smith <martin.smith@theqtcompany.com>
These additional styles enable the use of lower and uppercase
alphabets to number the list items. They are useful especially
in nested ordered lists where numbering all the list items
using decimal numbers could be confusing.
Change-Id: If1bdf98ff37c2c191d66dfb66a3e8f20d8fa83e5
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
A table in enum doc may have long literal strings defined
as enum values - they take up space from the Description column,
and often force a scrollbar to appear, making the entire
table difficult to read.
Alleviate this by reducing the font size for the text in Value
column.
Change-Id: I18495a4f506851f9eff2cd94f5cdfcb03096c698
Task-number: QTWEBSITE-658
Reviewed-by: Martin Smith <martin.smith@theqtcompany.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
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>
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>
Now that Qt Location is a fully-supported module in 5.6, it is
worth highlighting an example that demonstrates the new feature.
Change-Id: I70553f84af5587e3604115684ea1ea75203b91ce
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Reviewed-by: Alex Blasche <alexander.blasche@theqtcompany.com>
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>
The new offline template for Qt 5.6, including simplified CSS rules
suitable for rendering with a QTextBrowser, requires the navigation
bar to be generated as an HTML table instead of the previously-used
unordered list.
Make QDoc select between the two based on the contents of
HTML.postheader .qdocconf variable, which defines the header of
the navigation bar.
Modify the old offline CSS to look good also when the nav. bar
is a table.
Task-number: QTBUG-48322
Change-Id: I00e16c24f436e0be049b85d4bcfc916c33ea6b73
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
Reviewed-by: Martin Smith <martin.smith@digia.com>
Currently the shader code is not accessible from the examples
documentation page. This patch fixes this by adding .glsl to the file
extensions list for examples
Change-Id: Iafe327d1bd99b78641a89863f9dbaf8112651c45
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Update the online documentation template with following fixes:
- Improve responsivess for narrow screens: TOC and sidebar
now collapse into drop-down menus
- React to hashchange events: When the user edits the anchor
tag in URL and presses enter, the page is scrolled
correctly to bring the selected section title into view.
- Handle Ctrl and Meta keys correctly
- Improve colors for target section highlighting
- Minor CSS fixes
Task-number: QTWEBSITE-634
Task-number: QTWEBSITE-657
Change-Id: I7221f38cf4988497f0f24ee66e62b7b7d770a121
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
The existing recentfiles example was basically a clone of the SDI
example with a "Recent" menu added. Assuming it is better to have
it all in one place, the functionality is merged into the existing
SDI/MDI examples.
- Implement recently opened files handling using a submenu and a
QSettings array in the SDI/MDI examples.
- Remove recentfiles example.
Change-Id: Id5a1ab9fa1c2e6b9ec81309cfe74cf86f450392a
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
QDoc needs to ignore Q_DECLARE_SHARED_NOT_MOVABLE_UNTIL_QT6,
introduced in commit 075769ca, to avoid failures when parsing
the header files.
Change-Id: I07510248590e290e7a2460d51c8333c135647bcb
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Marc Mutz <marc.mutz@kdab.com>
Enumeration QSysInfo::MacVersion uses a macro to define
enumeration values. QDoc gets confused about it and
prints a lot of warnings.
Adding the macro to ignored directives does not resolve
the documentation issue completely (enum values still
show up as '?'), but it gets rid of the warnings.
Task-number: QTBUG-43810
Change-Id: Ie4009646a78c62b5f1860d29855d3941e79d9388
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Also fixed a broken facebook like image link in the footer.
Change-Id: I51e9b46d3e90763c41a125bf26ee4dccd375e744
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
Q_DECL_CF_RETURNS_RETAINED and Q_DECL_NS_RETURNS_AUTORELEASED are
added to qdoc's list of ignored tokens. Without them, qdoc fails
to parse a few function declarations.
Change-Id: If59066a765882d88881eed7db31b4b52a6e570ea
Task-number: QTBUG-46920
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
Q_ATTRIBUTE_FORMAT_PRINTF is added to qdoc's list of ignored
directives. Without it, qdoc fails to parse a few function
declarations.
Change-Id: Ie24a58d9a5dcdffb8c103b2f5e34dd09b9471f06
Task-number: QTBUG-46920
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
Remove highlighting for a number of older and less relevant examples.
Add examples from new modules, and examples that have been visually
polished.
Task-number: QTBUG-37203
Change-Id: I4e9be9a54f1ecea3bb407c049c1d44a7c00333a6
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
These examples now define their own images. Having duplicate
definitions is bad as it results in invalid example manifest
xml, and Qt Creator fails to detect all examples declared in
that file.
Task-number: QTBUG-41996
Change-Id: Ia9d6cd0b3ec4e82b79b1df54774c2d9cea279a59
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@theqtcompany.com>
Reviewed-by: Liang Qi <liang.qi@theqtcompany.com>
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
The wiki will be linked to from the Qt Multimedia
index page.
Change-Id: I2b60c203f759494cdf12021659847817007639f1
Task-number: QTBUG-30381
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
Reviewed-by: Yoann Lopes <yoann.lopes@theqtcompany.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
This change brings the online template up to date with recent
changes:
- Update links in header and footer.
- To improve page load time and reduce load on qt.io,
do not load images from the main site.
- Fix auto-scroll/highlight jQuery to work on anchors
containing full stop ('.') characters
- Responsiveness: Fix menu issues with narrow views
- Fix styling of subscript/superscript HTML tags
- Make script URIs protocol-agnostic
Change-Id: I219e8ce6ff2e70f9374ad5e037ceda8f710a6a10
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Gitorious is closing down, so point to code.qt.io instead.
Change-Id: Ibc453f05e59cf227a7a7086201b008cf7b576a26
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
The link does not work anymore and it is not referenced anywhere in Qt
Change-Id: I54dd7a40668c5a3963c8c1e95a9684385e5ac083
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
This change fixes a number of issues in the online template:
- Missing vertical line after the login icon in the header
- Update header, footer links and appearance
- Adjust alternate background color of table cells to improve
readability
- Fix style of cookie notification in the html header
- Add The Qt Company logo in the footer
- Adjust list item marker image
- Improve responsiveness of footer
Change-Id: I77147b4b4161d6001c095a4b67e15552132100e6
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
- Online CSS tweaks: Max-width, font-sizes,
font-weights to improve readability, other
minor fixes
- Remove duplicate include statement and unnecessary
definitions for online template
Change-Id: I713bddd0e175235668c4d9790d0df58b4131d19f
Reviewed-by: Martin Smith <martin.smith@digia.com>
This change updates the copyright information as it appears
in the footer for both offline and online documentation
templates.
- Update copyright year to 2015
- Update copyright holder to The Qt Company Ltd
Change-Id: I82fef6067dee42ec9db561aef9c3c506beafb3c6
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
Q_ENUM and Q_FLAG were not listed in the Cpp.ignoredirectives variable
in qt-cpp-defines.qdocconf. This never used to cause parsing errors in
qdoc, but now it does. The cause for this change was not determined at
the time of this fix, which is to add Q_ENUM and Q_FLAG to the ignore
directives list.
Change-Id: I717c9101f7706097869f23b53eeca8cb1a0fee0a
Task-number: QTBUG-44510
Reviewed-by: Olivier Goffart (Woboq GmbH) <ogoffart@woboq.com>
