From eb74f5b71effa0c394fe859efa2eb129dbe7f091 Mon Sep 17 00:00:00 2001
From: Leena Miettinen <riitta-leena.miettinen@qt.io>
Date: Wed, 23 Aug 2017 13:07:57 +0200
Subject: [PATCH] Doc: Add information about using the number icons and OptiPNG
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
...to the Extending Qt Creator Manual
Change-Id: I85dea1d815037af8334aed09c7b4ad8611d4170c
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: Tarja Sundqvist <tarja.sundqvist@qt.io>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
---
doc/api/qtcreator-documentation.qdoc | 37 ++++++++++++++++++++++++++++
1 file changed, 37 insertions(+)
diff --git a/doc/api/qtcreator-documentation.qdoc b/doc/api/qtcreator-documentation.qdoc
index 8d53f03bbec..935f6d10690 100644
--- a/doc/api/qtcreator-documentation.qdoc
+++ b/doc/api/qtcreator-documentation.qdoc
@@ -195,6 +195,31 @@
save space.
\endlist
+ \section2 Hightlighting Parts of the Screen
+
+ You can use number icons in screenshots to highlight parts of the screenshot
+ (instead of using red arrows or borders, or something similar). You can then
+ refer to the numbers in text. For and example, see the
+ \l{http://doc.qt.io/qt-5/topics-app-development.html}{Development Tools}
+ topic in the Qt reference documentation.
+
+ This improves the consistency of the look and feel of Qt documentation,
+ and eliminates the need to describe parts of the UI in the text, because
+ you can just insert the number of the element you are referring to in
+ brackets.
+
+ You can find a set of images that show the numbers from 1 to 10 in the
+ \c doc\images\numbers directory (or in the \c qtdoc module sources in
+ \c doc\images\numbers).
+
+ To use the numbers:
+
+ \list
+ \li Take a screenshot as described above.
+ \li After resizing the screenshot, copy-paste the number images on
+ the screenshot to the places that you want to refer to from text.
+ \endlist
+
\section2 Optimizing Images
Save images in the PNG format in the \QC project folder in the
@@ -241,6 +266,18 @@
You can also see the sizes of the initial and optimized image.
+ \section3 Using OptiPNG
+
+ Download and install \l{https://sourceforge.net/projects/optipng/}{OptiPNG}.
+
+ OptiPNG is a command-line tool that you can invoke from the \QC project
+ folder (or any folder that contains your project). To optimize a screenshot,
+ enter the following command (here, from the \QC project folder):
+
+ \code
+ optipng -o 7 -strip all doc/images/<screenshot_name>
+ \endcode
+
\section1 Building Documentation
You use QDoc to build the documentation. Build the documentation from time
--
GitLab