Doc: Rename "Adding Custom Wizards" and move it to "Reference"

- Create an "Add wizards" how-to topic

Task-number: QTCREATORBUG-29361
Change-Id: I37b1f39ba78fd1c39f4b111051f5eef1acee4caf
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
This commit is contained in:
Leena Miettinen
2023-08-29 11:50:04 +02:00
parent 5f02cadeab
commit 495c826c55
9 changed files with 66 additions and 14 deletions

View File

@@ -223,7 +223,7 @@
\li -customwizard-verbose
\li ProjectExplorer plugin: display additional information when
loading custom wizards. For more information about custom
wizards, see \l{Adding New Custom Wizards}
wizards, see \l{Custom Wizards}
\row
\li -ensure-kit-for-binary <path to binary>

View File

@@ -63,6 +63,7 @@
\li \l {Add a license header template for C++ code}
\li \l {Add libraries to projects}
\li \l {Add subprojects to projects}
\li \l {Add wizards}
\li \l {Create C++ classes}
\li \l {Create files}
\li \l {Create OpenGL fragment and vertex shaders}

View File

@@ -8,7 +8,7 @@
\title Reference
The following topics describe the different parts of the UI in detail.
\annotatedlist creator-reference
\section1 Sidebar Views

View File

@@ -110,7 +110,7 @@
\l{Using Variables in Wizards}{predefined wizard variables} to specify the
path and filename of the license to use in the source and header files.
\sa {Create files}, {Use project wizards}, {Adding New Custom Wizards}
\sa {Create files}, {Use project wizards}, {Custom Wizards}
*/
/*!

View File

@@ -0,0 +1,49 @@
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\page creator-how-to-add-wizards.html
\previouspage creator-project-qmake-libraries.html
\nextpage creator-version-control.html
\ingroup creator-how-to-projects
\title Add wizards
\QC has wizards for adding classes, files, and projects that you can copy
and edit to create your own wizards. Create the wizard directory in the
\c {templates/wizards/} directory in your \l{Locating Wizards}
{user settings directory}.
\image qtcreator-cpp-class-wizard.png
To create a new wizard:
\list 1
\li Start \QC with the \c {-customwizard-verbose} argument to receive
feedback during wizard development. For more information, see
\l {Verbose Output}.
\li Set keyboard shortcuts for the \uicontrol Inspect and
\uicontrol {Factory.Reset} actions, as described in
\l {Tips for Wizard Development}.
\li Copy a directory that contains a wizard and rename it. For example,
copy \c {share/qtcreator/templates/wizards/classes/cpp} as
\c {$HOME/.config/QtProject/qtcreator/templates/wizards/classes/mycpp}.
\li Use the \uicontrol {Factory.Reset} action to make the wizard appear
in \uicontrol File > \uicontrol {New File} without
restarting \QC.
\li Open the wizard configuration file, \c {wizard.json} for editing, as
described in \l {Custom Wizards}.
\li Change the \c id to something unique. Wizards are sorted by the ID in
alphabetic order within a \c category. You can use a leading letter
to specify the position of the wizard. For example, \c B.MyClass.
\endlist
\sa {Custom Wizards}, {Find settings files}
*/

View File

@@ -69,7 +69,7 @@
install and configure some additional software on the devices to be able to
\l{Connecting Devices}{connect} to them from the development PC.
\sa {Manage Projects}{How-to: Manage Projects}, {Adding New Custom Wizards}
\sa {Manage Projects}{How-to: Manage Projects}, {Custom Wizards}
*/
/*!

View File

@@ -89,7 +89,7 @@
\li Make a copy of \c {share/qtcreator/templates/wizards/classes/cpp}
and rename it. For example,
\c {share/qtcreator/templates/wizards/classes/mycpp}
\c {$HOME/.config/QtProject/qtcreator/templates/wizards/classes/mycpp}.
\li Use the \uicontrol {Factory.Reset} action to make the wizard appear
in \uicontrol File > \uicontrol {New File} without

View File

@@ -1,4 +1,4 @@
// Copyright (C) 2022 The Qt Company Ltd.
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
// **********************************************************************
@@ -8,11 +8,14 @@
// **********************************************************************
/*!
\previouspage creator-project-qmake-libraries.html
\page creator-project-wizards.html
\nextpage creator-version-control.html
\previouspage creator-reference.html
\title Adding New Custom Wizards
\ingroup creator-reference
\title Custom Wizards
\brief Wizard types and JSON wizard format.
If you have a team working on a large application or several applications,
you might want to standardize the way the team members create projects and
@@ -57,14 +60,14 @@
\list
\li Shared directory:
\li Predefined wizards in the shared directory:
\list
\li On Windows: \c {share\qtcreator\templates\wizards}
\li On Linux: \c {share/qtcreator/templates/wizards}
\li On \macos:
\c{Qt Creator.app/Contents/Resources/templates/wizards}
\endlist
\li Local user's settings directory:
\li Your custom wizards in the local user's settings directory:
\list
\li On Windows:
\c {%APPDATA%\QtProject\qtcreator\templates\wizards}

View File

@@ -24,9 +24,6 @@
\li \l{Managing Projects}
\list
\li \l{Creating Projects}
\list
\li \l{Adding New Custom Wizards}
\endlist
\li \l{Using Version Control Systems}
\list
\li \l{Using Bazaar}
@@ -276,6 +273,7 @@
\li \l {Add a license header template for C++ code}
\li \l {Add libraries to projects}
\li \l {Add subprojects to projects}
\li \l {Add wizards}
\li \l {Create C++ classes}
\li \l {Create files}
\li \l {Create OpenGL fragment and vertex shaders}
@@ -296,6 +294,7 @@
\endlist
\li \l{Reference}
\list
\li \l {Custom Wizards}
\li Sidebar Views
\list
\li \l {Call Hierarchy}