diff options
author | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2014-11-19 17:13:33 +0100 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2014-11-20 09:38:23 +0100 |
commit | 092a924a5b1af1a0061fcd564cc811f31c272434 (patch) | |
tree | 1c749e8092ebe078c62020597bec2180e653ce74 /doc/api | |
parent | 9181e06ef2e50d79d55a8093b0e68c1067dd29a2 (diff) | |
download | qt-creator-092a924a5b1af1a0061fcd564cc811f31c272434.tar.gz |
Doc: updated the instructions for writing documentation
Only Qt 5 supported for building docs from 3.3 on.
Added info on using https://tinypng.com to shrink PNG files.
Change-Id: I450c0cf34e34abc54511fef93e8e5caac5ba89ac
Reviewed-by: Eike Ziller <eike.ziller@theqtcompany.com>
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/qtcreator-documentation.qdoc | 52 |
1 files changed, 30 insertions, 22 deletions
diff --git a/doc/api/qtcreator-documentation.qdoc b/doc/api/qtcreator-documentation.qdoc index 06a3693f75..c97f952f3d 100644 --- a/doc/api/qtcreator-documentation.qdoc +++ b/doc/api/qtcreator-documentation.qdoc @@ -150,6 +150,13 @@ You can illustrate your documentation by using screen shots, diagrams, and other images. + Use the \c {\image} and \c {\inlineimage} QDoc commands to refer to images + from the text. You do not need to add paths to image names. For example: + + \code + \image riot.png + \endcode + \section2 Taking Screen Shots \QC has the native look and feel on Windows, Linux, and OS X, and @@ -200,7 +207,11 @@ Before committing images, optimize them by using an image optimization tool. Optimization should not visibly reduce image quality. If it does, do not do - it. You can use the Radical Image Optimization Tool (RIOT) on Windows (very + it. + + You can use a web service, such as \l{https://tinypng.com}, or an image + optimization tool to shrink the images. For example, you + can use the Radical Image Optimization Tool (RIOT) on Windows (very efficient) or ImageOptim on OS X (much less efficient), or some other tool available on Linux. @@ -209,17 +220,6 @@ \section3 Using RIOT - Use the \c {\image} and \c {\inlineimage} QDoc commands to refer to images - from the text. You do not need to add paths to image names. For example: - - \code - - \image riot.png - - \endcode - - \section2 Optimizing Images - Download and install \l{http://luci.criosweb.ro/riot/}{RIOT}. \image riot.png @@ -255,18 +255,26 @@ The content and formatting of documentation are separated in QDoc. The documentation configuration, style sheets, and templates have - changed over time, so they differ between Qt and \QC versions. In Qt 4, - separate style sheets are used to generate help files for \QC and online - documentation for the Web. + changed over time, so they differ between Qt and \QC versions. Since \QC + version 3.3, only Qt 5 is supported for building documentation. The + templates to use are defined by the + \c qt5\qtbase\doc\global\qt-html-templates-offline.qdocconf} and + \c {qt5\qtbase\doc\global\qt-html-templates-online.qdocconf} configuration + file. They are fetched from Qt sources by adding the following lines to the + qdocconf file: - In Qt 5, only one set of templates is used, as defined by the - \c {qt5\qtbase\doc\global\qt-module-defaults.qdocconf} configuration file. - It is fetched from Qt sources by adding the following line to the qdocconf - file: + \list - \c {include ($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)} + \li \c {include ($QT_INSTALL_DOCS/global/qt-html-templates-offline.qdocconf)} + for publishing on the web + \li \c {include ($QT_INSTALL_DOCS/global/qt-html-templates-online.qdocconf)} + for help files + \endlist - To pick the Qt to use, run qmake from either Qt 4 or Qt 5. + \note If the styles look wrong to you when reading help files in \QC or \QA, + you might be looking at them in the QTextBrowser instead of the WebKit + browser. This happens if you build \QC and \QA with a self-built Qt and did + not build Qt WebKit. To build documentation for the sources from the qtcreator master branch, use build scripts defined in the doc.pri file. To build all \QC docs in the @@ -288,7 +296,7 @@ on OS X. You can view the HTML files in a browser and the help files in the \QC \gui Help mode. For more information about adding the help files to \QC, see - \l{http://qt-project.org/doc/qtcreator-2.8/creator-help.html#adding-external-documentation} + \l{http://qt-project.org/doc/qtcreator/creator-help.html#adding-external-documentation} {Adding External Documentation}. Besides \c docs, you have the following options: |