Doc: Use the \QBS macro for the product name

This ensures that the name is always written in the
same way and makes it easy to change, as only the value
of the macro needs to be changed.

Removed the product name from most titles as macros cannot
be used in titles. It would break linking to titles.

Please always use the macro in the future.

Change-Id: I116abffc316edbb861034f5e431ca8e27b5a5d03
Reviewed-by: Jake Petroules <jake.petroules@petroules.com>
Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>

11 files changed, 55 insertions, 54 deletions

diff --git a/doc/config/macros.qdocconf b/doc/config/macros.qdocconf
index 7dc0a90d3..5d7a9665b 100644
--- a/doc/config/macros.qdocconf
+++ b/doc/config/macros.qdocconf
@@ -21,6 +21,7 @@ macro.QL                = "\\e{Qt Linguist}"
 macro.QMLD              = "\\e{Qt Quick Designer}"
 macro.QQV               = "\\e{Qt QML Viewer}"
 macro.QSDK              = "\\e{Qt SDK}"
+macro.QBS               = "Qbs"
 macro.qbsversion        = $QBS_VERSION
 macro.param             = "\\e"
 macro.raisedaster.HTML  = "<sup>*</sup>"
diff --git a/doc/qbs.qdoc b/doc/qbs.qdoc
index d633434a9..7376c712a 100644
--- a/doc/qbs.qdoc
+++ b/doc/qbs.qdoc
@@ -43,11 +43,11 @@
 
     \section1 Version \qbsversion
 
-    Qt Build Suite (Qbs) is a tool that helps simplify the build process for
-    developing projects across multiple platforms. Qbs can be used for any
+    Qt Build Suite (\QBS) is a tool that helps simplify the build process for
+    developing projects across multiple platforms. \QBS can be used for any
     software project, whether it is written in Qt or not.
 
-    Qbs is an all-in-one tool that generates a build graph from a high-level
+    \QBS is an all-in-one tool that generates a build graph from a high-level
     project description (like qmake or cmake) and additionally undertakes the
     task of executing the commands in the low-level build graph (like make).
 
@@ -55,21 +55,21 @@
     \l{http://bugreports.qt-project.org/}{Qt Bug Tracker}.
 
     \list
-       \li  \l{Introducing Qbs}
-       \li  \l{Setting Up Qbs}
+       \li  \l{Introduction}
+       \li  \l{Setup}
            \list
                \li  \l{System Requirements}
-               \li  \l{Building Qbs}
-               \li  \l{Configuring Qbs}
+               \li  \l{Building}
+               \li  \l{Configuring}
                \li  \l{Managing Qt Versions}
            \endlist
-       \li  \l{Using Qbs}
+       \li  \l{Usage}
            \list
                \li  \l{Language Introduction}
-               \li  \l{Building Applications with Qbs}
+               \li  \l{Building Applications}
                \li  \l{Running Applications}
                \li  \l{Installing Files}
-               \li  \l{Using Qbs Shell}
+               \li  \l{Using the Shell}
            \endlist
        \li  \l{Reference}
     \endlist
@@ -82,9 +82,9 @@
     \page overview.html
     \nextpage setup.html
 
-    \title Introducing Qbs
+    \title Introduction
 
-    Qbs builds applications based on the information in a project file that you
+    \QBS builds applications based on the information in a project file that you
     specify in a QML dialect. Each project file specifies one project that can
     contain several \l{Product Item}{products}. You specify the type of the product: application,
     library, and so on.
@@ -97,12 +97,12 @@
     \page setup.html
     \nextpage system-requirements.html
 
-    \title Setting Up Qbs
+    \title Setup
 
     \list
         \li  \l{System Requirements}
-        \li  \l{Building Qbs}
-        \li  \l{Configuring Qbs}
+        \li  \l{Building}
+        \li  \l{Configuring}
         \li  \l{Managing Qt Versions}
     \endlist
 */
@@ -116,7 +116,7 @@
 
     \title System Requirements
 
-    To build Qbs from the source, you need the following:
+    To build \QBS from the source, you need the following:
 
     \list
 
@@ -133,9 +133,9 @@
     \page building.html
     \nextpage configuring.html
 
-    \title Building Qbs
+    \title Building
 
-    To build Qbs, enter the following command:
+    To build \QBS, enter the following command:
 
     \code
         qmake -r qbs.pro && make
@@ -143,13 +143,13 @@
 
     \section1 Configure Options
 
-    Qbs recognizes the following qmake CONFIG options to customize the build:
+    \QBS recognizes the following qmake CONFIG options to customize the build:
 
     \table
     \header \li Option              \li Notes
     \row    \li all_tests           \li Enable additional autotests.
     \row    \li disable_rpath       \li Disable the use of rpath. This can be used when packaging
-                                        Qbs for distributions which do not permit the use of rpath,
+                                        \QBS for distributions which do not permit the use of rpath,
                                         such as Fedora.
     \row    \li qbs_no_dev_install  \li Exclude header files from installation, that is, perform a
                                         non-developer build.
@@ -164,7 +164,7 @@
     \page configuring.html
     \nextpage qt-versions.html
 
-    \title Configuring Qbs
+    \title Configuring
 
     Open a build shell (on Windows open an MSVC command prompt,
     on other platforms you can usually open the default shell):
@@ -178,7 +178,7 @@
     qbs config --list profiles
     \endcode
 
-    Now you should be ready to build your first project with Qbs.
+    Now you should be ready to build your first project with \QBS.
     Go into qbs/tests/manual/hello and type:
 
     \code
@@ -200,7 +200,7 @@
 
     \section1 Introduction
 
-    To let Qbs know where the Qt build or Qt version is that you want to use,
+    To let \QBS know where the Qt build or Qt version is that you want to use,
     you must register it.
 
     Register a Qt version like this:
@@ -296,14 +296,14 @@
     \page usage.html
     \nextpage language-introduction.html
 
-    \title Using Qbs
+    \title Usage
 
     \list
         \li  \l{Language Introduction}
-        \li  \l{Building Applications with Qbs}
+        \li  \l{Building Applications}
         \li  \l{Running Applications}
         \li  \l{Installing Files}
-        \li  \l{Using Qbs Shell}
+        \li  \l{Using the Shell}
     \endlist
 
 */
@@ -317,13 +317,13 @@
 
     \title Language Introduction
 
-    Qbs uses project files (*.qbs) to describe the contents of a project.
+    \QBS uses project files (*.qbs) to describe the contents of a project.
     A project contains one or more \l{Product Item}{products}. A product is the target of a build
     process, typically an application, library or maybe a tar ball.
 
     \section1 The Obligatory Hello World Example
 
-    Qbs project files are written using a QML dialect.
+    \QBS project files are written using a QML dialect.
     A very simple C++ hello world project looks like this:
     \code ---helloworld.qbs---
         import qbs 1.0
@@ -353,13 +353,13 @@
     Unlike QML, the right-hand side can be either a string or a string list.
     A single string is converted to a stringlist containing just one element.
 
-    \a Depends adds the dependency to the module \l{Module cpp}{cpp}. This is necessary to let Qbs know that
+    \a Depends adds the dependency to the module \l{Module cpp}{cpp}. This is necessary to let \QBS know that
     we have a C++ project and want to compile main.cpp with a C++ compiler. For more information
-    about Qbs modules, see \l{Modules}.
+    about \QBS modules, see \l{Modules}.
 
 
-    \section1 Reusing Qbs Project File Code
-    QML-like inheritance works also in Qbs.
+    \section1 Reusing Project File Code
+    QML-like inheritance works also in \QBS.
 
     \code
     ---CrazyProduct.qbs---
@@ -578,7 +578,7 @@
 
     \section1 File Tags and Taggers
 
-    Qbs itself knows nothing about C++ files or file extensions. All source files
+    \QBS itself knows nothing about C++ files or file extensions. All source files
     in a product are handled equally. However, you can assign \a{file tags} to an artifact
     to act as a marker or to specify a file type.
 
@@ -647,13 +647,13 @@
 
     \section1 Rules
 
-    Qbs applies a \e rule to a pool of artifacts (in the beginning it is just the set of
+    \QBS applies a \e rule to a pool of artifacts (in the beginning it is just the set of
     source files of the project) and chooses the ones that match the input file
     tags specified by the rule. Then it creates output artifacts in the build graph that have other
     filenames and file tags. It also creates a script that transforms the input artifact into the
     output artifact.
 
-    For examples of rules, see the share/qbs/modules directory in the Qbs
+    For examples of rules, see the share/qbs/modules directory in the \QBS
     repository.
 
     You can define rules in your own module to be provided along with
@@ -669,7 +669,7 @@
     \page building-applications.html
     \nextpage running-applications.html
 
-    \title Building Applications with Qbs
+    \title Building Applications
 
     To build applications from the command line, enter the following commands:
 
@@ -728,7 +728,7 @@
     Here, we want the installDir properties from the project file to be interpreted relative
     to the directory \c{/tmp/myProjectRoot}, and we want that directory to be removed first.
     If the \c{--install-root} option is not given, a default is used, namely \c{<build root>/install-root}.
-    Qbs understands the special install root value \c{@sysroot}, which stands for the value of
+    \QBS understands the special install root value \c{@sysroot}, which stands for the value of
     the property \c{qbs.sysroot}.
 */
 
@@ -759,9 +759,9 @@
     \page shell.html
     \nextpage reference.html
 
-    \title Using Qbs Shell
+    \title Using the Shell
 
-    To use the Qbs shell, enter the following command:
+    To use the \QBS shell, enter the following command:
 
     \code
     qbs shell
diff --git a/doc/reference/items/filetagger.qdoc b/doc/reference/items/filetagger.qdoc
index 367612fef..f7ecdaade 100644
--- a/doc/reference/items/filetagger.qdoc
+++ b/doc/reference/items/filetagger.qdoc
@@ -38,7 +38,7 @@
 
     This item maps file patterns to tags. It can be attached to a product or a module.
     In the latter case, its effect is the same as if it had been attached to all products having
-    a dependency on the respective module. For instance, the cpp module of Qbs has, among others,
+    a dependency on the respective module. For instance, the cpp module of \QBS has, among others,
     the following file tagger:
     \code
     FileTagger {
diff --git a/doc/reference/items/group.qdoc b/doc/reference/items/group.qdoc
index 17eb57799..41f7e526d 100644
--- a/doc/reference/items/group.qdoc
+++ b/doc/reference/items/group.qdoc
@@ -65,7 +65,7 @@
      }
      \endcode
      When specifying files, you can use the wildcards "*", "?" and "[]", which have their usual meaning.
-     By default, matching files are only picked up directly from the parent directory, but you can tell Qbs to
+     By default, matching files are only picked up directly from the parent directory, but you can tell \QBS to
      consider the whole directory tree. It is also possible to exclude certain files from the list.
      The pattern ** used in a pathname expansion context will match all files and zero or more
      directories and subdirectories.
diff --git a/doc/reference/items/product.qdoc b/doc/reference/items/product.qdoc
index f5203f70c..e41b8204c 100644
--- a/doc/reference/items/product.qdoc
+++ b/doc/reference/items/product.qdoc
@@ -50,7 +50,7 @@
     The \c type property specifies what will be built (an executable). The \c files property specifies
     the input files (one C++ source file), and the \c Depends item pulls in the logic from the \c cpp module
     about how to do the necessary transformations.
-    For some often-used types of products, Qbs pre-defines special derived items that save
+    For some often-used types of products, \QBS pre-defines special derived items that save
     users some typing. These are:
     \list
         \li Application
@@ -132,7 +132,7 @@
                 Info.plist files in OS X and iOS application and framework bundles, for example.
     \endtable
 
-    The following properties are automatically set by qbs and usually are not changed by the user:
+    The following properties are automatically set by \QBS and usually are not changed by the user:
 
     \table
         \header
diff --git a/doc/reference/items/rule.qdoc b/doc/reference/items/rule.qdoc
index aca2acbb9..6a864d57d 100644
--- a/doc/reference/items/rule.qdoc
+++ b/doc/reference/items/rule.qdoc
@@ -41,7 +41,7 @@
     one or more artifacts (e.g. C++ linker).
     A \e {non-multiplex rule} creates one transformer per matching input file (e.g. C++
     compiler).
-    As a real-world example of a non-multiplex rule, here is a simplified version of qbs' rule for
+    As a real-world example of a non-multiplex rule, here is a simplified version of \QBS' rule for
     transforming C++ sources into object files using gcc:
     \code
     Rule {
diff --git a/doc/reference/jsextensions/jsextensions-general.qdoc b/doc/reference/jsextensions/jsextensions-general.qdoc
index 8c14360df..2a24b1c4e 100644
--- a/doc/reference/jsextensions/jsextensions-general.qdoc
+++ b/doc/reference/jsextensions/jsextensions-general.qdoc
@@ -36,7 +36,7 @@
     \brief Provides various operations.
 
     These are operations that do not fit into any of the other categories.
-    They are automatically available in any qbs project file.
+    They are automatically available in any \QBS project file.
 
     \section1 Available Operations
 
@@ -51,7 +51,7 @@
     \code
     qbs.getHostOS(name)
     \endcode
-    Returns the name of the operating system on which qbs is running.
+    Returns the name of the operating system on which \QBS is running.
     \note Do not confuse this with the \c{qbs.targetOS} property, which represents the operating
-    system on which the binaries produced by qbs will run.
+    system on which the binaries produced by \QBS will run.
 */
diff --git a/doc/reference/modules/nsis-module.qdoc b/doc/reference/modules/nsis-module.qdoc
index 745207239..e1ba7dd64 100644
--- a/doc/reference/modules/nsis-module.qdoc
+++ b/doc/reference/modules/nsis-module.qdoc
@@ -42,7 +42,7 @@
     This module is only available on Windows.
 
     \note A typical NSIS script includes an OutFile command to set the filename of the generated
-    installer executable. However, Qbs overrides any OutFile commands found in the script, and
+    installer executable. However, \QBS overrides any OutFile commands found in the script, and
     therefore, you must use the targetName property to set the filename.
 
     \section1 General Properties
diff --git a/doc/reference/modules/qbs-module.qdoc b/doc/reference/modules/qbs-module.qdoc
index 36957656b..38daf995e 100644
--- a/doc/reference/modules/qbs-module.qdoc
+++ b/doc/reference/modules/qbs-module.qdoc
@@ -87,7 +87,7 @@
     \row    \li \b{Type:}            \li \c{stringList} (read only)
     \endtable
 
-    This property is set by qbs internally and specifies the OS qbs is running on.
+    This property is set by \QBS internally and specifies the OS \QBS is running on.
     The possible values for this property are the values of \c targetOS,
     though some may not be supported.
 
@@ -268,7 +268,7 @@
 
     Specifies the global installation prefix. It is implicitly prepended to all values
     of \c installDir. The \c installPrefix itself is relative to the install root, which is not
-    a property of qbs, but an external installation parameter.
+    a property of \QBS, but an external installation parameter.
 
     \section1 pathListSeparator
 
diff --git a/doc/reference/modules/wix-module.qdoc b/doc/reference/modules/wix-module.qdoc
index 6184bc6eb..c46d8ac45 100644
--- a/doc/reference/modules/wix-module.qdoc
+++ b/doc/reference/modules/wix-module.qdoc
@@ -85,7 +85,7 @@
     \endtable
 
     Passes most of the same preprocessor macros to the compiler as Visual Studio does.
-    This allows easier authoring WiX files that are compatible with both QBS and MSBuild.
+    This allows easier authoring WiX files that are compatible with both \QBS and MSBuild.
 
     \section2 includePaths
 
diff --git a/doc/reference/reference.qdoc b/doc/reference/reference.qdoc
index feabe2ca4..8b227584e 100644
--- a/doc/reference/reference.qdoc
+++ b/doc/reference/reference.qdoc
@@ -44,7 +44,7 @@
     \contentspage reference.html
     \group list-of-builtin-services
     \title List of Built-in Services
-    Qbs provides the following built-in JavaScript extensions to simplify operations that
+    \QBS provides the following built-in JavaScript extensions to simplify operations that
     are expected to be needed often in project files.
 */
 
@@ -52,12 +52,12 @@
     \contentspage reference.html
     \group list-of-modules
     \title List of Modules
-    These are the modules shipped with qbs.
+    These are the modules shipped with \QBS.
 */
 
 /*!
     \contentspage reference.html
     \group list-of-items
     \title List of Language Items
-    Qbs provides the following built-in QML items to define projects.
+    \QBS provides the following built-in QML items to define projects.
 */