Commit Graph

47 Commits

Author SHA1 Message Date
Volker Krause
e5cd556cd1 Make documentation readable with dark color schemes.
All other colors are hard-coded in here, only the background followed the
palette.

Change-Id: If8033a72f85f953358ffeec4edd80a36b8494c7f
Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
2016-01-28 20:07:10 +00:00
Topi Reinio
e8c7f77854 Doc: Online style: CSS fixes for image alignment
- Remove duplicated rules
    - Add a rule for class centerAlign
    - Remove width restriction from paragraphs in table cells

These fixes enable proper horizontal center-align of images in
table cells.

Change-Id: I68a4863fe642a552260dfd6dbbb5d9675a8d2b4d
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
2015-12-09 13:54:27 +00:00
Venugopal Shivashankar
df57e3a33f Doc: Add the missing styles to get multi-column classes list
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>
2015-12-07 19:38:04 +00:00
Venugopal Shivashankar
60e2aa6532 Doc: Add ordered list-specific styles
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>
2015-11-30 11:18:30 +00:00
Topi Reinio
7c22e14300 Doc: Online style: Decrease font size of enum tables' Value column
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>
2015-11-23 14:15:24 +00:00
Topi Reinio
616f690761 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-28 11:55:05 +00:00
Topi Reinio
06d90c14b4 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-10-19 08:22:19 +00:00
Topi Reinio
afcc26619f qdoc: Conditionally generate the navigation bar items as table cells
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>
2015-10-19 08:22:15 +00:00
Topi Reinio
03d621cbff Doc: Update online documentation template
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>
2015-08-26 09:45:55 +00:00
Venugopal Shivashankar
fdcea3a7ca Doc: Updated the footer in the online template
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>
2015-07-01 12:26:37 +00:00
Liang Qi
605617b5dc Merge remote-tracking branch 'origin/5.4' into 5.5
Change-Id: I004854a25ebbf12b1fda88900162fe7878716c58
2015-04-15 09:09:24 +02:00
Topi Reinio
d238f7e019 Doc: Update online documentation template
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>
2015-04-14 08:32:46 +00:00
Liang Qi
ce9519593a Merge remote-tracking branch 'origin/5.4' into 5.5
Conflicts:
	mkspecs/android-g++/qmake.conf
	qmake/generators/unix/unixmake2.cpp
	src/gui/image/qimage_conversions.cpp

Change-Id: Ib76264b8c2d29a0228438ec02bd97d4b97545be0
2015-03-31 10:03:31 +02:00
Topi Reinio
2002103baa Doc: Update the online documentation template
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>
2015-03-11 09:17:39 +00:00
Oswald Buddenhagen
8ac63a3323 Merge remote-tracking branch 'origin/5.4' into 5.5
Change-Id: I556be99cc7ad3fc6f7177542b7444269616a7478
2015-03-04 13:44:29 +01:00
Dmitry Shachnev
30e3a2beb1 Remove unneeded exec permission from icomoon fonts
Change-Id: I47f111b4fa1278889689c28da762fabe94b95015
Reviewed-by: Lisandro Damián Nicanor Pérez Meyer <perezmeyer@gmail.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2015-03-02 10:39:24 +00:00
Oswald Buddenhagen
2b5982aac8 Merge remote-tracking branch 'origin/5.4' into 5.5
Change-Id: I95b3a87c5068c6b8068b30a35655b4c2419e7f9e
2015-03-02 09:23:07 +01:00
Topi Reinio
ba5f93956b Doc: Update online documentation template
- 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>
2015-02-26 12:26:15 +00:00
Simon Hausmann
015002fec9 Merge remote-tracking branch 'origin/5.4' into dev
Conflicts:
	doc/global/template/style/online.css
	mkspecs/android-g++/qmake.conf

Change-Id: Ib39ea7bd42f5ae12e82a3bc59a66787a16bdfc61
2014-12-10 07:58:06 +01:00
Topi Reinio
457496b830 Doc: new template for qt.io online style
An online documentation template that follows the
style of qt.io site.

Update the url variable for Qt modules to point
to doc.qt.io/qt-5/.

Task-number: QTBUG-42086
Change-Id: I5428a02cd503aef2217efd7361f4c8b7b5895a52
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
2014-12-03 12:20:07 +01:00
Frederik Gladhorn
34aba4724f Merge remote-tracking branch 'origin/5.4' into dev
Conflicts:
	src/corelib/io/qiodevice.cpp
	src/plugins/bearer/linux_common/qofonoservice_linux.cpp
	src/plugins/bearer/linux_common/qofonoservice_linux_p.h
	src/plugins/platforms/android/qandroidplatformtheme.cpp
	src/tools/bootstrap/bootstrap.pro
	src/widgets/styles/qmacstyle_mac.mm

Change-Id: Ia02aab6c4598ce74e9c30bb4666d5e2ef000f99b
2014-11-24 13:39:13 +01:00
Topi Reinio
1ad78f5f29 qdoc: Prepare QDoc for the new style on qt.io
The new template and CSS have some requirements that need changes
in the generated .html:

    - Generate a new div 'sidebar' and place the TOC (if one
      exists) inside it, allowing the template to extend the
      sidebar contents dynamically. Do this for all pages
      except index.html.

    - Change the DOCTYPE declaration to be html5-compliant

    - Replace <tt> tags with <code> to be html5-compliant

    - Add a new config variable HTML.prologue - this allows
      the template to insert custom html into beginning of
      the page, before the page title but after any navigation
      or table-of-contents items.

    - Wrap tables inside <div> elements. This allows for
      better-working CSS design for small-screen devices.

    - Write out extra parameters first when outputting
      function synopsis to have better styling.

    - Inject zero-width-space characters into function
      names to allow the browser break up long function
      signatures in a nice manner.

    - Edit the CSS for the offline style to adapt to
      above changes.

Task-number: QTBUG-42086
Change-Id: I3075cdc11bcb07a66150388519263fd721c8002b
Reviewed-by: Martin Smith <martin.smith@digia.com>
2014-11-11 20:42:35 +01:00
Martin Smith
17472a2ba3 qdoc: Generate cross-module links-to-links pages
The cross-module link report is modified so that each module
listed in the table is a link to a subpage on which all the
links from the current module to that module are listed. To
check that these links go to the correct place, click on one
to be taken to the actual link. The actual link is marked
with red asterisks. Click on that link to check that the link
goes to the correct page. Repeat this process for all the
links in the table.

Change-Id: Ifddf7108ed7ef090c4063909fdbd10dac1f2566b
Task-number: QTBUG-41850
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2014-11-11 15:35:33 +01:00
Shawn Rutledge
7eb7dd555c Documentation CSS: remove body text color
Help text should use the QPalette color.

Task-number: QTBUG-42399
Change-Id: Ibc8658b4a7affc2481d895c13cfa673b50a872e0
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2014-11-05 10:36:16 +01:00
Alessandro Portale
82e266a83b New Qt logo
This patch replaces the old Qt logo with the new, flatter one.

The PNGs were optimized via: optipng  -o7 -strip "all"

Task-number: QTBUG-41685
Change-Id: I51983a45144373bf7aee31a32990ecbb2582f488
Reviewed-by: Robert Loehning <robert.loehning@digia.com>
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@digia.com>
Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>
Reviewed-by: Lars Knoll <lars.knoll@digia.com>
2014-11-05 08:10:42 +01:00
Topi Reinio
2e667c9171 qdoc: Highlight selected section / entry in the documentation
This commit adds id tags with the anchor reference as the value
to html entities for documentation section titles and function
signatures, properties etc. for both C++ and QML documentation
pages.

Together with new CSS rules, we can dynamically highlight the
title that the user clicked on. This helps to locate the item
of interest on a crowded page or when the page cannot be
scrolled down enough to place the selected item on top.

Change-Id: I7d1db2ed4e12779e1a9e571996ee65c3befa4e7a
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
2014-09-05 14:17:29 +02:00
Topi Reinio
f286e0813b Doc: Add CSS rules for subtitles
In the offline template, the floating elements in the navigation bar
interfere with the layout of any elements displayed next to it. In
particular, subtitles used for example files and nested class
documentation have wrong horizontal position.

This change adds CSS for the subtitles to be displayed as block
elements, and disallows floating elements on the left side - TOC
is still allowed to float on the right side.

Task-number: QTBUG-40924
Change-Id: I89be3844985e6cf95263db575768034d9270d140
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2014-08-26 20:08:21 +02:00
Topi Reinio
4f31b01e36 Doc: Fix template code for unordered lists
The CSS for unordered lists placed a nested list
vertically too close to its parent list item.
This commit fixes the issue.

Task-number: QTBUG-38217
Change-Id: Ia5003f2aab197f455ed5bbea2e1ee2e6475aaffe
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2014-04-09 20:53:06 +02:00
Jerome Pasion
93d35c07d0 Doc: Updated CSS used by the offline documentation.
-new layout for landing page
-updates to title sizes and changes to footer
-fixes to general paragraph issues

-index.qdoc changed in qtdoc repository

Task-number: QTBUG-36411
Change-Id: Icb4fb0374e474137686f4cb67c64dc0249fef2c4
Reviewed-by: Martin Smith <martin.smith@digia.com>
2014-02-20 11:06:40 +01:00
Jerome Pasion
616b431a21 Doc: Fixed footer style and information for offline builds.
-footer is left aligned and smaller text.
-footer contains fewer <div> which were not used.
-CSS rules for footer changed to accommodate new specifications.
-information not relevant in offline builds taken out.

Task-number: QTBUG-33802
Change-Id: Icc57bad9ead8ce812d5df8e72a7bac8c22831b5f
Reviewed-by: Sami Makkonen <sami.makkonen@digia.com>
Reviewed-by: hjk <hjk121@nokiamail.com>
2013-11-01 12:56:46 +01:00
Jerome Pasion
ea94afca56 Doc: Changed CSS text-align from "justify" to "left".
-Documentation looks weird when viewed in a narrow window because
 much of the text are long.
-Qt Project's CSS uses "left".
-This change affects any documentation which uses the global
 templates.

Change-Id: I8605a191904cb727b4818d8a1abf127ce2e45eb9
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
Reviewed-by: Jens Bache-Wiig <jens.bache-wiig@digia.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2013-08-28 12:15:43 +02:00
Jerome Pasion
b625cddcd8 Doc: Edited CSS files in doc/global/template
-edited style convention for readability (as opposed to file size)
-removed extra CSS rule which does nothing

Change-Id: Ica9cbdf0c63bae87a8446afcbc22f74403e3247e
Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-07-23 16:30:06 +02:00
Jerome Pasion
b11cb96f28 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>
2013-06-25 14:03:24 +02:00
Jerome Pasion
7b48954df2 Doc: Applying new qt-project.org style to "online" style.
-added images
-modified template and CSS file

Change-Id: I0d50f940271d6af80ade38f50d4efa2028441dba
Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-06-25 14:03:13 +02:00
Oswald Buddenhagen
e80841f113 make images non-executable
Change-Id: I7d6c28e7fd18125c95e56eca2d0d6d67003f9c5d
Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-06-17 15:42:00 +02:00
Jerome Pasion
cbe6aafc11 Doc: Various changes to global CSS files.
-added style for JavaScript code blocks
-code blocks is scrollable when viewed in a narrow window
-improved alignment of table of contents

Change-Id: I45acdb4c7aa0ae57fe030e7e68a230c1a7d41b8f
Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
2013-02-28 17:14:54 +01:00
Jerome Pasion
57953e0fea Doc: Added margin to the QML API description.
-added a margin to "qmldoc" div class.

Change-Id: I7297aff4de5d41a7e4de14a09c0a70acb8006bb9
Reviewed-by: Jens Bache-Wiig <jens.bache-wiig@digia.com>
2013-02-15 17:48:36 +01:00
Jerome Pasion
529110343d Doc CSS: Edited CSS line-height of paragraphs and landing page.
-value copied from qt-project.org
-more room between lines of text and the list at the landing page.

Change-Id: Iee995325ded0c803feca44d112c5e73a024917bb
Reviewed-by: hjk <qthjk@ovi.com>
2012-12-11 16:27:14 +01:00
Jerome Pasion
fac02ddc39 Doc: Restored CSS images for the offline HTML and QCH build
Revert "Doc: Removing entry in CSS for adding icons to HTTP links"
This reverts commit ceb2799163.

Also:
-edited image to use Qt Project brand colors
-removed breadcrumbs from CSS

Change-Id: I3c2e655f8eac463677b20b68bc2ffa0efd2fd468
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Eike Ziller <eike.ziller@digia.com>
2012-12-10 23:10:43 +01:00
Jerome Pasion
3aee20d4ab Doc: Updated CSS style for QML code snippets
-padding should be the same as C++ code snippet.

Change-Id: Idba44d252f411f70b6957161b83626811c1c69f2
Reviewed-by: Sergio Ahumada <sergio.ahumada@digia.com>
2012-12-05 17:29:46 +01:00
Jerome Pasion
3d4729a377 Doc: Adding empty tags in the HTML
Change-Id: I7251b77b645a2085d25443826aa2b9550a373d88
Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-11-30 23:56:15 +01:00
Jerome Pasion
ceb2799163 Doc: Removing entry in CSS for adding icons to HTTP links
This is a temporary solution to
QDoc bug https://bugreports.qt-project.org/browse/QTBUG-28307

The links will not have the icon.

Change-Id: Ib81bcc9c55cd5f403c85fdd38c0ee71219091e76
Reviewed-by: Paul Olav Tvete <paul.tvete@digia.com>
2012-11-30 18:38:49 +01:00
Jerome Pasion
85e77b3e17 Doc: Modified CSS according to a graphic designer's recommendations.
-Landing page in qtdoc uses the CSS classes.

Change-Id: I05efae40d4d6d1802585c129a0a12b2af7eee5e7
Reviewed-by: Lars Knoll <lars.knoll@digia.com>
2012-11-30 00:49:49 +01:00
Jerome Pasion
2862697e90 Doc: Various modifications to the online and offline stylesheets.
-used Qt Project colors
-changed margins and paddings

Change-Id: If7a533ac3a32debbaca7b403aa68290c2b9aab2c
Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-11-21 11:03:48 +01:00
Jerome Pasion
fbbcea907f Doc: Adding subtitle to the online snapshot HTML
-other fixes to the HTML template.

Change-Id: I85070c615796c4342a89cc730ab2ca8ab51dd5e6
Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
2012-11-19 16:10:18 +01:00
Jerome Pasion
e508e26915 Doc: Adding online styles
-Has the Qt logo
-For generating the archives and online snapshot

Change-Id: I88d1d6335c0ba600a62868a25fadaed8a751f2b4
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2012-11-19 13:51:18 +01:00
Jerome Pasion
b60c76fa09 Doc: Fixing templatedir paths according to the fix to QTBUG-27878
Change-Id: Ib95be5267514e4afadad4f6fbfd48514a7552227
Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-11-09 15:30:39 +01:00