feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity
Files
ddffbe676de3d87e71a7379db3405853ebee518a
qt-creator/doc/config/macros.qdocconf

72 lines
3.1 KiB
Plaintext
Raw Normal View History

Updated the configuration files to use the updated qdoc. Updated qdoc to remove hard-coded dependencies on style sheets. Simplified the offline documentation, introducing an offline.css file to be used for documentation in Qt Creator.
2010-12-17 20:21:27 +01:00
macro.aacute.HTML = "á"
macro.Aring.HTML = "Å"
macro.aring.HTML = "å"
macro.Auml.HTML = "Ä"
Doc: replace deprecated QDoc commands The \i and \o commands were replaced with \li and \bold was replaced with \b in QDoc for Qt 5. The \input command was replaced with \include in the docs. Change-Id: I257d1bebb8ebc739ca20e0d29fcf0406ecb14534 Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
2013-02-06 08:50:23 +01:00
macro.author = "\\b{Author:}"
Updated the configuration files to use the updated qdoc. Updated qdoc to remove hard-coded dependencies on style sheets. Simplified the offline documentation, introducing an offline.css file to be used for documentation in Qt Creator.
2010-12-17 20:21:27 +01:00
macro.br.HTML = "<br />"
macro.BR.HTML = "<br />"
macro.copyright.HTML = "&copy;"
macro.eacute.HTML = "&eacute;"
Doc: replace deprecated QDoc commands The \i and \o commands were replaced with \li and \bold was replaced with \b in QDoc for Qt 5. The \input command was replaced with \include in the docs. Change-Id: I257d1bebb8ebc739ca20e0d29fcf0406ecb14534 Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
2013-02-06 08:50:23 +01:00
macro.gui = "\\b"
Updated the configuration files to use the updated qdoc. Updated qdoc to remove hard-coded dependencies on style sheets. Simplified the offline documentation, introducing an offline.css file to be used for documentation in Qt Creator.
2010-12-17 20:21:27 +01:00
macro.hr.HTML = "<hr />"
macro.iacute.HTML = "&iacute;"
Doc: replace deprecated QDoc commands The \i and \o commands were replaced with \li and \bold was replaced with \b in QDoc for Qt 5. The \input command was replaced with \include in the docs. Change-Id: I257d1bebb8ebc739ca20e0d29fcf0406ecb14534 Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
2013-02-06 08:50:23 +01:00
macro.key = "\\b"
macro.menu = "\\b"
Doc: Introduce a macro \macos to adapt to upcoming renamings Start with an initial value 'macOS' and use in uncontroversial places in the docs. Some explicit references to older versions are untouched in this patch. Change-Id: Ibea4115c45fc2ff2c9a0518d92797df26fd4138f Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2016-08-03 16:46:29 +02:00
macro.macos = "macOS"
Doc: replace deprecated QDoc commands The \i and \o commands were replaced with \li and \bold was replaced with \b in QDoc for Qt 5. The \input command was replaced with \include in the docs. Change-Id: I257d1bebb8ebc739ca20e0d29fcf0406ecb14534 Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
2013-02-06 08:50:23 +01:00
macro.note = "\\b{Note:}"
Updated the configuration files to use the updated qdoc. Updated qdoc to remove hard-coded dependencies on style sheets. Simplified the offline documentation, introducing an offline.css file to be used for documentation in Qt Creator.
2010-12-17 20:21:27 +01:00
macro.oslash.HTML = "&oslash;"
macro.ouml.HTML = "&ouml;"
Doc: Describe converting projects from Qt 3D Studio to Qt Design Studio Draft of the migration guide describing the best practices and including a step-by-step guide for the converting process. Fixes: QDS-2252 Change-Id: I501b57450525cd3122510d5f9d784804996dd70f Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Alessandro Portale <alessandro.portale@qt.io> Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io>
2020-06-29 13:31:42 +03:00
macro.Q3DS = "Qt 3D Studio"
Doc: add and edit macros to remove emphasis for product names Change-Id: I077c721c661a2b9fa8dfbd93dd9888a8d700f5c5 Reviewed-on: http://codereview.qt-project.org/5603 Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com> Reviewed-by: Eike Ziller <eike.ziller@nokia.com> Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
2011-09-27 11:21:55 +02:00
macro.QA = "Qt Assistant"
Doc: Move Qt Bridge product name macros to the common macros file ..from the Qt Design Studio Manual doc configuration file. Change-Id: Iebbfb5404cae4ef277f05c867e7259997b19a27e Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2020-05-14 10:56:00 +02:00
macro.QB = "Qt Bridge"
macro.QBPS = "Qt Bridge for Adobe Photoshop"
Doc: Add Qt-Bridge plugin docs for adobe XD Task-number: QDS-4615 Change-Id: Ie3c7d814fbf59841f112315cf71553076ec7e0d7 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2021-09-23 14:40:44 +02:00
macro.QBXD = "Qt Bridge for Adobe XD"
Doc: Move Qt Bridge product name macros to the common macros file ..from the Qt Design Studio Manual doc configuration file. Change-Id: Iebbfb5404cae4ef277f05c867e7259997b19a27e Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2020-05-14 10:56:00 +02:00
macro.QBSK = "Qt Bridge for Sketch"
Doc: Describe using Qt Bridge for Figma Task-number: QDS-2525 Change-Id: I5c574c291bfb526452a2429a91920a875e1573a5 Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-12-11 14:33:15 +01:00
macro.QBF = "Qt Bridge for Figma"
Pass IDE_DISPLAY_NAME et al to qdoc and use it for manual Change-Id: I5d52c9561d4c49df503c0e99c8765979516e5b5c Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2018-06-18 16:03:42 +02:00
macro.QC = "$IDE_DISPLAY_NAME"
macro.QCE = "$IDE_DISPLAY_NAME Enterprise"
Doc: add and edit macros to remove emphasis for product names Change-Id: I077c721c661a2b9fa8dfbd93dd9888a8d700f5c5 Reviewed-on: http://codereview.qt-project.org/5603 Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com> Reviewed-by: Eike Ziller <eike.ziller@nokia.com> Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
2011-09-27 11:21:55 +02:00
macro.QD = "Qt Designer"
Doc: Describe converting Qt Quick UI Prototypes to Applications Qt Quick UI Prototype projects (.qmlproject) are used in Qt Design Studio, but they must be converted to Qt Quick Application projects for building and running them in Qt Creator. Add example files and quote code from them. Task-number: QDS-357 Change-Id: Ib0bf1b342ec54faeca108e5586389730a85b5116 Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2019-01-10 14:39:01 +01:00
macro.QDS = "Qt Design Studio"
Doc: Update QQEM parts in doc Task-number: QDS-9588 Change-Id: I3ae76bf708549e18e8024122d809bd15cb63de05 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-05-10 09:46:35 +03:00
macro.QQEM = "Qt Quick Effect Maker"
Doc: Describe using Qt Design Viewer For running Qt Quick UI projects (.qmlproject) in web browsers. Change-Id: Ied9b971755ccef9f94e9e0ffb578d3ecbd0ef6c0 Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2019-10-23 15:31:30 +02:00
macro.QDV = "Qt Design Viewer"
Doc: add and edit macros to remove emphasis for product names Change-Id: I077c721c661a2b9fa8dfbd93dd9888a8d700f5c5 Reviewed-on: http://codereview.qt-project.org/5603 Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com> Reviewed-by: Eike Ziller <eike.ziller@nokia.com> Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
2011-09-27 11:21:55 +02:00
macro.QL = "Qt Linguist"
Doc: Add Qt for MCUs macro Added a new Qt for MCUs macro and modified a number of related topics accordingly. Task-number: QDS-9609 Change-Id: I6506a9cb6671c29d5b164d53cb01c827639ecb16 Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2023-04-03 15:03:32 +03:00
macro.QMCU = "Qt for MCUs"
Doc: add and edit macros to remove emphasis for product names Change-Id: I077c721c661a2b9fa8dfbd93dd9888a8d700f5c5 Reviewed-on: http://codereview.qt-project.org/5603 Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com> Reviewed-by: Eike Ziller <eike.ziller@nokia.com> Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
2011-09-27 11:21:55 +02:00
macro.QMLD = "Qt Quick Designer"
macro.QQV = "Qt QML Viewer"
Doc: don't use the term SDK in connection with Qt Replace with "Qt distributions" or "installers" or rewrite in some other way. Remove references to installing Qt 4 SDK, because it is no longer available for downloading. Change-Id: I291f82702e21d953f2efbb0e634d6454b4bc17b9 Reviewed-by: hjk <hjk121@nokiamail.com>
2014-03-14 16:02:01 +01:00
macro.QSDK = "Qt"
Doc: Add Qt Quick Ultralite macro Task-number: QDS-9613 Change-Id: I8b3dc970d2ca335f9efb320eb22b41891d96f498 Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-04-04 10:09:12 +03:00
macro.QUL = "Qt Quick Ultralite"
Doc: Unify product naming Unify naming for Qt Online Installer and Qt Maintenance Tool. Ass macros for theses as well. Task-number: QTBUG-116573 Change-Id: I90247956300607b852a17df96aa667bf55805e36 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
2023-09-12 16:02:31 +03:00
macro.QOI = "Qt Online Installer"
macro.QMT = "Qt Maintenance Tool"
Updated the configuration files to use the updated qdoc. Updated qdoc to remove hard-coded dependencies on style sheets. Simplified the offline documentation, introducing an offline.css file to be used for documentation in Qt Creator.
2010-12-17 20:21:27 +01:00
macro.qtcversion = $QTC_VERSION
macro.param = "\\e"
Doc: Add a \preferences macro and use it everywhere The macro can be used to show the path to Preferences on Windows, Linux, and macOS. The current value expands to: "Edit (or Qt Creator on macOS) > Preferences". We can now change this in one place if we so wish. Task-number: QTCREATORBUG-29734 Change-Id: I9afe4f7093dbcc8e62a2b18e1ae3f6f243bbb72b Reviewed-by: hjk <hjk@qt.io> Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-10-17 16:19:40 +02:00
macro.preferences = "\\uicontrol Edit (or \\uicontrol {\\QC} on \\macos) > \\uicontrol Preferences"
Updated the configuration files to use the updated qdoc. Updated qdoc to remove hard-coded dependencies on style sheets. Simplified the offline documentation, introducing an offline.css file to be used for documentation in Qt Creator.
2010-12-17 20:21:27 +01:00
macro.raisedaster.HTML = "<sup>*</sup>"
macro.rarrow.HTML = "&rarr;"
macro.reg.HTML = "<sup>&reg;</sup>"
macro.return = "Returns"
macro.starslash = "\\c{*/}"
macro.begincomment = "\\c{/*}"
macro.endcomment = "\\c{*/}"
macro.uuml.HTML = "&uuml;"
macro.mdash.HTML = "&mdash;"
Doc: add a "commercial" icon to commercial-only topics For purely commercial apps, this is done by using the template, but Qt Creator is mostly open source, so an image is used. Use a \commercial macro with a tooltip and link to the image. Change-Id: I5e3df953821551331afef2ec642b482b52ff909e Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2015-04-08 12:43:38 +02:00
macro.commercial = "\\raw HTML\n<p><a title=\"Available under certain Qt licenses.\"><img src=\"images/commercial.png\"/></a></p>\n\\endraw"
Updated the configuration files to use the updated qdoc. Updated qdoc to remove hard-coded dependencies on style sheets. Simplified the offline documentation, introducing an offline.css file to be used for documentation in Qt Creator.
2010-12-17 20:21:27 +01:00
macro.beginfloatleft.HTML = "<div style=\"float: left; margin-right: 2em\">"
macro.beginfloatright.HTML = "<div style=\"float: right; margin-left: 2em\">"
macro.endfloat.HTML = "</div>"
macro.clearfloat.HTML = "<br style=\"clear: both\" />"
macro.emptyspan.HTML = "<span></span>"
QmlDesigner: Create Figma Quick Control Template merge doc There is a new feature, which lets to have Figma users templates from Qt Design studio on Figma end. And later getting components imported from Figma to Qt Design studio to have them accurately as local components. This document aims to note that process. Fixes: QDS-8719 Change-Id: I8b375730c32c8a41bbeebcacc616ed2a295bf881 Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2023-01-30 14:56:57 +01:00
macro.externallink.HTML = "<a href=\"\1\" target=\"_blank\">\2</a>"
Doc: Add support for the \youtube macro Show links to Youtube videos using thumbnails with a play button. Change-Id: I131f24b1fb723c817c2387429bbf52997003f105 Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2020-11-26 16:36:29 +01:00
# Embed YouTube content by video ID - Example: \youtube dQw4w9WgXcQ
# Also requires a <ID>.jpg thumbnail for offline docs. In .qdocconf, add:
#
# HTML.extraimages += images/dQw4w9WgXcQ.jpg
# qhp.ProjectName.extraFiles += images/dQw4w9WgXcQ.jpg
#
Doc: Fix the \youtube macro for use with liteHTML help backend Create a common directory for extra image files, and move the video thumbnails there. This folder structure is required to work around the fact that relative image paths passed to qhp.<project>.extraFiles are not resolved correctly when loading the generated help project. Change-Id: Iff5583a9a318670571b7f706182723e54e0ec466 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2020-11-27 18:21:33 +01:00
macro.youtube.HTML = "<div class=\"video\">\n" \
Doc: Add support for the \youtube macro Show links to Youtube videos using thumbnails with a play button. Change-Id: I131f24b1fb723c817c2387429bbf52997003f105 Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2020-11-26 16:36:29 +01:00
"<a href=\"https://www.youtube.com/watch/?v=\1\">\n"\
"<img src=\"images/\1.jpg\"" \
"title=\"Click to play in a browser\" /></a>\n" \
Doc: Fix the \youtube macro for use with liteHTML help backend Create a common directory for extra image files, and move the video thumbnails there. This folder structure is required to work around the fact that relative image paths passed to qhp.<project>.extraFiles are not resolved correctly when loading the generated help project. Change-Id: Iff5583a9a318670571b7f706182723e54e0ec466 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2020-11-27 18:21:33 +01:00
"</div>\n"
Copy Permalink