summaryrefslogtreecommitdiffstats
path: root/doc/global/template/style/offline.css
Commit message (Collapse)AuthorAgeFilesLines
* Doc: Adjust CSS of 'extra' information elements for functions/propertiesTopi Reinio2023-12-121-1/+10
| | | | | | | | | | | | QDoc generates a <code> element adjacent to function/property signatures with information on when something was introduced or deprecated. The location and attributes of this code element are changed in 6.7 - adjust CSS accordingly. Task-number: QTBUG-117152 Change-Id: I64523f38ece4f5ea7663f86769bb0e73de3e7fe6 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Add CSS styling and icon for 'technical preview' itemsTopi Reinio2023-05-101-0/+14
| | | | | | | | | | | | | | QDoc adds a 'Status' field to the table on top of type reference pages. One common status for Qt modules/types is 'Technical preview'. Add an icon that is displayed next to the status description, highlighting the fact that the type is in tech. preview and therefore subject to change. Pick-to: 6.5 Task-number: QTBUG-113026 Change-Id: Ibe6ca2a562cc7810fe27e7dcf514c711cd022894 Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Fix alignment of next/prev links in offline styleKai Köhne2022-05-061-1/+1
| | | | | | | | | | With the old value, they were placed above the header bar. Moving them a few pixels below looks less broken. Pick-to: 6.2 6.3 5.15 Change-Id: Iddd9d5e0b5c199fe35a9c8b8a7cac9a472901a21 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Add styling for note/warning/important admonitionsTopi Reinio2021-11-031-28/+7
| | | | | | | | | | | The offline CSS already had some related rules, but at some point QDoc lost the ability to produce the required markup. It has now been reintroduced. Pick-to: 6.2 5.15 Task-number: QTBUG-97448 Change-Id: I5165cd01f3653dfb35854ca6b8040e8daa434347 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* doc: Remove vertical space before youtube video links in offline modeKai Köhne2021-06-041-4/+0
| | | | | | | | | | The vspan was originally added for iframes. They are not needed (and look weird) for normal images/links. Pick-to: 6.1 Fixes: QTBUG-92266 Change-Id: I9da2b52234b2e49bc0cdef4bf8f0865fb092bb31 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Offline documentation CSS: Remove external link icon from video linksTopi Reinio2021-02-191-0/+4
| | | | | | Pick-to: 6.1 Change-Id: I1fddad28399f83bfb8bfb7bbc0c4825907dfeb4d Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Offline CSS: Reduce excess vertical spacingTopi Reinio2021-02-191-9/+8
| | | | | | | Pick-to: 6.1 5.15 Fixes: QTBUG-89829 Change-Id: I0beb43fb2f40cbd1e5b36c95322f1a1530f5acf4 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Offline docs: Improve styling of unordered lists and external linksTopi Reinio2020-12-221-10/+24
| | | | | | | | | | | Use list-style-type correctly and replace background-image with ::before content for external link icons. Pick-to: 6.0 Fixes: QTBUG-89470 Fixes: QTBUG-89471 Change-Id: Ib11a45baf5e92565b22e21f3bd1a929cbbbef608 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Doc: Update global documentation config for Qt 6Topi Reinio2020-06-081-7/+1
| | | | | | | | | | | | | | - Set base URL path to /qt - Define 'qt6' for use in conditionals - Omit \since information for everything introduced before Qt 5 - Make use of the new expandable variables to allow component-specific URLs in commercial templates - Adjust CSS for changes in QDoc's output Change-Id: I74581f0fb49cd176f92d6451c388e7b7ddf1baa4 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Doc: Adjust offline style for the litehtml rendering engineTopi Reinio2020-03-261-1/+4
| | | | | | | | | | | | | | | | | | | | | | | 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>
* Doc: Add styling for function groupsTopi Reinio2017-08-151-0/+3
| | | | | | | | Add CSS rules for grouped function documentation; that is, multiple function signatures sharing the same documentation body. Change-Id: I28de3805a8f5f972a59f6ea4ae32262ac36b69a6 Reviewed-by: Martin Smith <martin.smith@qt.io>
* Doc: Add macro for embedding YouTube videosTopi Reinio2017-03-061-0/+20
| | | | | | | | | | | | | | | | | | This macro adds a \youtube <ID> command that embeds a YouTube link into the documentation. The video container scales to a specified percentage of the available horizontal area. It assumes a source aspect ratio of 16:9, but looks acceptable with other ratios. For backends that do not support <iframe> (e.g. QTextBrowser), shows a clickable video thumbnail that open the YouTube link in an external browser window. Unfortunately, QTextBrowser cannot load images from a remote URL, so we need to store a thumbnail image in the .qch file. Change-Id: I3a3a0c5a20dd90e5cec6357ba70a23ee47dbe825 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Merge remote-tracking branch 'origin/5.6' into 5.7Liang Qi2016-10-311-2/+6
|\ | | | | | | | | | | | | Conflicts: src/plugins/platforms/minimalegl/qminimaleglintegration.cpp Change-Id: Ia6ab42a6daadbf8abc085c971545904d49ea4b56
| * Doc: CSS: Add styling for content generated with \legalese commandTopi Reinio2016-10-281-2/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Even though the \legalese command is no longer used in Qt 5 documentation as it doesn't support collating legalese texts across modules, it may still be useful for stand-alone doc projects. Add CSS rules so the \legalese text is styled similarly to code blocks, to make it stand out from the rest of the content. Change-Id: I533d8e2375ea2f8054c0671ff34dfa6f0dfe01d1 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* | Doc: Template: Add CSS rules for bordered imagesTopi Reinio2016-10-281-1/+5
|/ | | | | | | | | 9f45d2ab added a documentation macro for bordered images - Add the corresponding CSS rules to apply a drop shadow for such images. Change-Id: I18c4fbd7498db7b9391f33e568219e67b329e618 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Remove hiding of .main div in offline pagesKai Koehne2016-08-051-3/+0
| | | | | | | | | The section got introduced in commit 93d35c07d06fcc, but is ignored by browsers so far due to a non-blank space (0xc2 0xa0). Task-number: QTBUG-55115 Change-Id: Ie0668b89c7151c934f40e033100a544011a583d8 Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
* Make documentation readable with dark color schemes.Volker Krause2016-01-281-0/+1
| | | | | | | | 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>
* Doc: Add the missing styles to get multi-column classes listVenugopal Shivashankar2015-12-071-0/+15
| | | | | | | | | 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>
* Doc: Add ordered list-specific stylesVenugopal Shivashankar2015-11-301-1/+12
| | | | | | | | | | 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>
* Doc: Use a navigation separator in the simple offline templateTopi Reinio2015-10-281-0/+1
| | | | | | | | | | | | | 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>
* qdoc: Conditionally generate the navigation bar items as table cellsTopi Reinio2015-10-191-1/+18
| | | | | | | | | | | | | | | | | | | 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>
* Merge remote-tracking branch 'origin/5.4' into devFrederik Gladhorn2014-11-241-3/+17
|\ | | | | | | | | | | | | | | | | | | | | | | 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
| * qdoc: Prepare QDoc for the new style on qt.ioTopi Reinio2014-11-111-2/+17
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
| * Documentation CSS: remove body text colorShawn Rutledge2014-11-051-1/+0
| | | | | | | | | | | | | | | | Help text should use the QPalette color. Task-number: QTBUG-42399 Change-Id: Ibc8658b4a7affc2481d895c13cfa673b50a872e0 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* | qdoc: Generate cross-module links-to-links pagesMartin Smith2014-11-111-0/+5
|/ | | | | | | | | | | | | | | 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>
* qdoc: Highlight selected section / entry in the documentationTopi Reinio2014-09-051-0/+16
| | | | | | | | | | | | | | | | 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>
* Doc: Add CSS rules for subtitlesTopi Reinio2014-08-261-0/+4
| | | | | | | | | | | | | | | 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>
* Doc: Fix template code for unordered listsTopi Reinio2014-04-091-1/+1
| | | | | | | | | | 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>
* Doc: Updated CSS used by the offline documentation.Jerome Pasion2014-02-201-85/+51
| | | | | | | | | | | | -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>
* Doc: Fixed footer style and information for offline builds.Jerome Pasion2013-11-011-27/+23
| | | | | | | | | | | | -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>
* Doc: Changed CSS text-align from "justify" to "left".Jerome Pasion2013-08-281-2/+2
| | | | | | | | | | | | | | | -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>
* Doc: Edited CSS files in doc/global/templateJerome Pasion2013-07-231-511/+507
| | | | | | | | -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>
* Doc: Fixed QDoc's navigation mechanism.Jerome Pasion2013-06-251-2/+70
| | | | | | | | | | | | | | | | | | | | | | | | 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>
* Doc: Various changes to global CSS files.Jerome Pasion2013-02-281-14/+27
| | | | | | | | | -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>
* Doc: Added margin to the QML API description.Jerome Pasion2013-02-151-4/+3
| | | | | | | -added a margin to "qmldoc" div class. Change-Id: I7297aff4de5d41a7e4de14a09c0a70acb8006bb9 Reviewed-by: Jens Bache-Wiig <jens.bache-wiig@digia.com>
* Doc CSS: Edited CSS line-height of paragraphs and landing page.Jerome Pasion2012-12-111-1/+4
| | | | | | | | -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>
* Doc: Restored CSS images for the offline HTML and QCH buildJerome Pasion2012-12-101-67/+11
| | | | | | | | | | | | | Revert "Doc: Removing entry in CSS for adding icons to HTTP links" This reverts commit ceb2799163c7e80148ef0bffafac9b05269514d7. 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>
* Doc: Updated CSS style for QML code snippetsJerome Pasion2012-12-051-1/+1
| | | | | | | -padding should be the same as C++ code snippet. Change-Id: Idba44d252f411f70b6957161b83626811c1c69f2 Reviewed-by: Sergio Ahumada <sergio.ahumada@digia.com>
* Doc: Adding empty tags in the HTMLJerome Pasion2012-11-301-6/+0
| | | | | Change-Id: I7251b77b645a2085d25443826aa2b9550a373d88 Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Removing entry in CSS for adding icons to HTTP linksJerome Pasion2012-11-301-10/+0
| | | | | | | | | | 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>
* Doc: Modified CSS according to a graphic designer's recommendations.Jerome Pasion2012-11-301-0/+33
| | | | | | | -Landing page in qtdoc uses the CSS classes. Change-Id: I05efae40d4d6d1802585c129a0a12b2af7eee5e7 Reviewed-by: Lars Knoll <lars.knoll@digia.com>
* Doc: Various modifications to the online and offline stylesheets.Jerome Pasion2012-11-211-34/+19
| | | | | | | | -used Qt Project colors -changed margins and paddings Change-Id: If7a533ac3a32debbaca7b403aa68290c2b9aab2c Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Fixing templatedir paths according to the fix to QTBUG-27878Jerome Pasion2012-11-091-0/+706
Change-Id: Ib95be5267514e4afadad4f6fbfd48514a7552227 Reviewed-by: Martin Smith <martin.smith@digia.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-25 00:57:57 +0000