forked from qt-creator/qt-creator
Doc: Add a Reference topic
For listing reference topics. Task-number: QTCREATORBUG-29361 Change-Id: I1d0463c4bfcd826464535a377da533509d838435 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
This commit is contained in:
Leena Miettinen
@@ -101,7 +101,8 @@
|
||||
<ul>
|
||||
<li><a href="creator-help.html">Using the Help Mode</a></li>
|
||||
<li><a href="creator-faq.html">FAQ</a></li>
|
||||
<li><a href="creator-how-tos.html">How-tos</a></li>
|
||||
<li><a href="creator-how-tos.html">How-to</a></li>
|
||||
<li><a href="creator-reference.html">Reference</a></li>
|
||||
<li><a href="creator-known-issues.html">Known Issues</a></li>
|
||||
<li><a href="creator-glossary.html">Glossary</a></li>
|
||||
<li><a href="technical-support.html">Technical Support</a></li>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
\page creator-how-to-macos.html
|
||||
\if defined(qtcreator)
|
||||
\previouspage creator-how-tos.html
|
||||
\nextpage creator-known-issues.html
|
||||
|
||||
\endif
|
||||
\ingroup creator-how-to-ui
|
||||
\ingroup studio-how-to
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
\page creator-how-to-set-high-dpi-scaling.html
|
||||
\if defined(qtcreator)
|
||||
\previouspage creator-how-tos.html
|
||||
\nextpage creator-known-issues.html
|
||||
|
||||
\endif
|
||||
\ingroup creator-how-to-ui
|
||||
\ingroup studio-how-to
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
\page creator-how-to-switch-ui-themes.html
|
||||
\if defined(qtcreator)
|
||||
\previouspage creator-how-tos.html
|
||||
\nextpage creator-known-issues.html
|
||||
|
||||
\endif
|
||||
\ingroup creator-how-to-ui
|
||||
\ingroup studio-how-to
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
\page creator-how-to-view-images.html
|
||||
\if defined(qtcreator)
|
||||
\previouspage creator-how-tos.html
|
||||
\nextpage creator-known-issues.html
|
||||
|
||||
\endif
|
||||
\ingroup creator-how-to-design
|
||||
\ingroup studio-how-to-image-viewer
|
||||
@@ -47,7 +47,7 @@
|
||||
\page creator-how-to-export-svg-images.html
|
||||
\if defined(qtcreator)
|
||||
\previouspage creator-how-tos.html
|
||||
\nextpage creator-known-issues.html
|
||||
|
||||
\endif
|
||||
\ingroup creator-how-to-design
|
||||
\ingroup studio-how-to-image-viewer
|
||||
|
||||
@@ -793,7 +793,7 @@
|
||||
\nextpage studio-projects.html
|
||||
\else
|
||||
\previouspage creator-how-tos.html
|
||||
\nextpage creator-known-issues.html
|
||||
|
||||
\endif
|
||||
|
||||
\ingroup creator-how-to-ui
|
||||
@@ -854,7 +854,7 @@
|
||||
\nextpage studio-projects.html
|
||||
\else
|
||||
\previouspage creator-how-tos.html
|
||||
\nextpage creator-known-issues.html
|
||||
|
||||
\endif
|
||||
|
||||
\ingroup creator-how-to-ui
|
||||
@@ -888,7 +888,7 @@
|
||||
\nextpage studio-projects.html
|
||||
\else
|
||||
\previouspage creator-how-tos.html
|
||||
\nextpage creator-known-issues.html
|
||||
|
||||
\endif
|
||||
|
||||
\title Import and export keyboard shortcuts
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
/*!
|
||||
\page creator-how-to-enable-plugins.html
|
||||
\previouspage creator-how-tos.html
|
||||
\nextpage creator-known-issues.html
|
||||
|
||||
\ingroup creator-how-to-use
|
||||
|
||||
\title Enable and disable plugins
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
/*!
|
||||
\page creator-how-to-find-settings-files.html
|
||||
\previouspage creator-how-tos.html
|
||||
\nextpage creator-known-issues.html
|
||||
|
||||
\ingroup creator-how-to-use
|
||||
|
||||
\title Find settings files
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
/*!
|
||||
\page creator-how-to-install-plugins.html
|
||||
\previouspage creator-how-tos.html
|
||||
\nextpage creator-known-issues.html
|
||||
|
||||
\ingroup creator-how-to-use
|
||||
|
||||
\title Install plugins
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
/*!
|
||||
\previouspage creator-faq.html
|
||||
\page creator-how-tos.html
|
||||
\nextpage creator-known-issues.html
|
||||
\nextpage creator-reference.html
|
||||
|
||||
\title How-to
|
||||
|
||||
@@ -76,7 +76,7 @@
|
||||
/*!
|
||||
\page creator-how-to-move-between-open-files.html
|
||||
\previouspage creator-how-tos.html
|
||||
\nextpage creator-known-issues.html
|
||||
|
||||
\ingroup creator-how-to-edit
|
||||
|
||||
\title Move between open files
|
||||
@@ -96,7 +96,7 @@
|
||||
/*!
|
||||
\page creator-how-to-switch-to-edit-mode.html
|
||||
\previouspage creator-how-tos.html
|
||||
\nextpage creator-known-issues.html
|
||||
|
||||
\ingroup creator-how-to-edit
|
||||
|
||||
\title Switch to Edit mode
|
||||
@@ -118,7 +118,7 @@
|
||||
/*!
|
||||
\page creator-how-to-find-preferences.html
|
||||
\previouspage creator-how-tos.html
|
||||
\nextpage creator-known-issues.html
|
||||
|
||||
\ingroup creator-how-to-ui
|
||||
|
||||
\title Find a particular preference
|
||||
@@ -132,7 +132,7 @@
|
||||
/*!
|
||||
\page creator-how-to-run-from-cli.html
|
||||
\previouspage creator-how-tos.html
|
||||
\nextpage creator-known-issues.html
|
||||
|
||||
\ingroup creator-how-to-use
|
||||
|
||||
\title Run \QC from the command line
|
||||
@@ -150,7 +150,7 @@
|
||||
/*!
|
||||
\page creator-how-to-move-to-symbols.html
|
||||
\previouspage creator-how-tos.html
|
||||
\nextpage creator-known-issues.html
|
||||
|
||||
\ingroup creator-how-to-edit
|
||||
|
||||
\title Move to symbols
|
||||
@@ -173,7 +173,7 @@
|
||||
/*!
|
||||
\page creator-how-to-locate-files-using-keyboard.html
|
||||
\previouspage creator-how-tos.html
|
||||
\nextpage creator-known-issues.html
|
||||
|
||||
\ingroup creator-how-to-edit
|
||||
|
||||
\title Locate files using the keyboard
|
||||
@@ -198,7 +198,7 @@
|
||||
/*!
|
||||
\page creator-how-to-perform-calculations.html
|
||||
\previouspage creator-how-to-move-between-open-files.html
|
||||
\nextpage creator-known-issues.html
|
||||
|
||||
\ingroup creator-how-to-edit
|
||||
|
||||
\title Perform calculations
|
||||
@@ -215,7 +215,7 @@
|
||||
/*!
|
||||
\page creator-how-to-jump-to-functions-in-qml-code.html
|
||||
\previouspage creator-how-tos.html
|
||||
\nextpage creator-known-issues.html
|
||||
|
||||
\ingroup creator-how-to-edit
|
||||
|
||||
\title Jump to a function in QML code
|
||||
@@ -227,7 +227,7 @@
|
||||
/*!
|
||||
\page creator-how-to-add-license-header-templates.html
|
||||
\previouspage creator-how-tos.html
|
||||
\nextpage creator-known-issues.html
|
||||
|
||||
\ingroup creator-how-to-projects
|
||||
|
||||
\title Add a license header template for C++ code
|
||||
@@ -258,7 +258,7 @@
|
||||
/*!
|
||||
\page creator-how-to-paste-text-from-clipboard-history.html
|
||||
\previouspage creator-how-tos.html
|
||||
\nextpage creator-known-issues.html
|
||||
|
||||
\ingroup creator-how-to-edit
|
||||
|
||||
\title Paste text from clipboard history
|
||||
@@ -271,7 +271,7 @@
|
||||
/*!
|
||||
\page creator-how-to-sort-lines-alphabetically.html
|
||||
\previouspage creator-how-tos.html
|
||||
\nextpage creator-known-issues.html
|
||||
|
||||
\ingroup creator-how-to-edit
|
||||
|
||||
\title Sort lines alphabetically
|
||||
@@ -284,7 +284,7 @@
|
||||
/*!
|
||||
\page creator-enclose-code-in-characters.html
|
||||
\previouspage creator-how-tos.html
|
||||
\nextpage creator-known-issues.html
|
||||
|
||||
\ingroup creator-how-to-edit
|
||||
|
||||
\title Enclose selected code in curly braces, parentheses, or double quotes
|
||||
@@ -309,7 +309,7 @@
|
||||
/*!
|
||||
\page creator-how-to-select-enclosing-block.html
|
||||
\previouspage creator-how-tos.html
|
||||
\nextpage creator-known-issues.html
|
||||
|
||||
\ingroup creator-how-to-edit
|
||||
|
||||
\title Select the enclosing block in C++
|
||||
@@ -320,7 +320,7 @@
|
||||
/*!
|
||||
\page creator-how-to-add-code-snippets.html
|
||||
\previouspage creator-how-tos.html
|
||||
\nextpage creator-known-issues.html
|
||||
|
||||
\ingroup creator-how-to-edit
|
||||
|
||||
\title Add code snippets to the auto-complete menu
|
||||
@@ -337,7 +337,7 @@
|
||||
/*!
|
||||
\page creator-how-to-write-notes.html
|
||||
\previouspage creator-how-tos.html
|
||||
\nextpage creator-known-issues.html
|
||||
|
||||
\ingroup creator-how-to-edit
|
||||
|
||||
\title Write down notes
|
||||
@@ -366,7 +366,7 @@
|
||||
/*!
|
||||
\page creator-how-to-set-recent-files.html
|
||||
\previouspage creator-how-tos.html
|
||||
\nextpage creator-known-issues.html
|
||||
|
||||
\ingroup creator-how-to-ui
|
||||
|
||||
\title Set the number of recent files shown
|
||||
@@ -386,7 +386,7 @@
|
||||
/*!
|
||||
\page creator-how-to-search-and-replace-using-regexp.html
|
||||
\previouspage creator-how-to-move-between-open-files.html
|
||||
\nextpage creator-known-issues.html
|
||||
|
||||
\ingroup creator-how-to-edit
|
||||
|
||||
\title Search and replace across files using a regular expression
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
// Copyright (C) 2023 The Qt Company Ltd.
|
||||
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
|
||||
|
||||
/*!
|
||||
\page creator-reference.html
|
||||
\previouspage creator-how-tos.html
|
||||
\nextpage creator-known-issues.html
|
||||
|
||||
\title Reference
|
||||
|
||||
The following topics describe the different parts of the UI in detail.
|
||||
|
||||
\section1 Sidebar Views
|
||||
|
||||
\annotatedlist creator-reference-sidebar-views
|
||||
|
||||
\section1 Output Views
|
||||
|
||||
\annotatedlist creator-reference-output-views
|
||||
|
||||
\sa {User Interface}, {Show and hide sidebars}, {View output}
|
||||
*/
|
||||
@@ -239,6 +239,7 @@
|
||||
\li \l{Using the Help Mode}
|
||||
\li \l{FAQ}
|
||||
\li \l{How-to}
|
||||
\li \l{Reference}
|
||||
\li \l{Known Issues}
|
||||
\li \l{Glossary}
|
||||
\li \l{Technical Support}
|
||||
|
||||
@@ -104,6 +104,7 @@
|
||||
\li \l{Using the Help Mode}
|
||||
\li \l{FAQ}
|
||||
\li \l{How-to}
|
||||
\li \l{Reference}
|
||||
\li \l{Known Issues}
|
||||
\li \l{Glossary}
|
||||
\endlist
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
\previouspage creator-projects-view.html
|
||||
\nextpage creator-open-documents-view.html
|
||||
\else
|
||||
\previouspage creator-how-to-show-and-hide-sidebars.html
|
||||
\previouspage creator-reference.html
|
||||
\endif
|
||||
|
||||
\ingroup creator-reference-sidebar-views
|
||||
|
||||
@@ -73,13 +73,13 @@
|
||||
|
||||
Some output views do not support finding and filtering.
|
||||
|
||||
\if defined(qtcreator)
|
||||
\sa {Output Views}
|
||||
\else
|
||||
\section1 Output views
|
||||
|
||||
The following views show output:
|
||||
|
||||
\if defined(qtcreator)
|
||||
\annotatedlist creator-reference-output-views
|
||||
\else
|
||||
\annotatedlist studio-reference-output-views
|
||||
\endif
|
||||
*/
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
/*!
|
||||
\page creator-how-to-show-and-hide-sidebars.html
|
||||
\previouspage creator-how-tos.html
|
||||
\nextpage creator-known-issues.html
|
||||
|
||||
\ingroup creator-how-to-ui
|
||||
|
||||
\title Show and hide sidebars
|
||||
@@ -32,12 +32,8 @@
|
||||
(\uicontrol {Close}).
|
||||
\endlist
|
||||
|
||||
\section1 Sidebar views
|
||||
|
||||
Manage projects and files in the following views:
|
||||
|
||||
\annotatedlist creator-reference-sidebar-views
|
||||
|
||||
In some views, right-clicking opens a context menu that has functions
|
||||
for managing the objects listed in the view.
|
||||
|
||||
\sa {Sidebar Views}
|
||||
*/
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
/*!
|
||||
\page creator-how-to-switch-between-modes.html
|
||||
\previouspage creator-how-tos.html
|
||||
\nextpage creator-known-issues.html
|
||||
|
||||
\ingroup creator-how-to-ui
|
||||
|
||||
\title Switch between modes
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
/*!
|
||||
\page creator-outline-view.html
|
||||
\previouspage creator-how-to-show-and-hide-sidebars.html
|
||||
\previouspage creator-reference.html
|
||||
\ingroup creator-reference-sidebar-views
|
||||
|
||||
\title Outline
|
||||
@@ -31,7 +31,7 @@
|
||||
|
||||
/*!
|
||||
\page creator-class-view.html
|
||||
\previouspage creator-how-to-show-and-hide-sidebars.html
|
||||
\previouspage creator-reference.html
|
||||
\ingroup creator-reference-sidebar-views
|
||||
|
||||
\title Class View
|
||||
@@ -51,7 +51,7 @@
|
||||
|
||||
/*!
|
||||
\page creator-call-hierarchy-view.html
|
||||
\previouspage creator-how-to-show-and-hide-sidebars.html
|
||||
\previouspage creator-reference.html
|
||||
\ingroup creator-reference-sidebar-views
|
||||
|
||||
\title Call Hierarchy
|
||||
@@ -73,7 +73,7 @@
|
||||
|
||||
/*!
|
||||
\page creator-type-hierarchy.html
|
||||
\previouspage creator-how-to-show-and-hide-sidebars.html
|
||||
\previouspage creator-reference.html
|
||||
\ingroup creator-reference-sidebar-views
|
||||
|
||||
\title Type Hierarchy
|
||||
@@ -105,7 +105,7 @@
|
||||
|
||||
/*!
|
||||
\page creator-include-hierarchy-view.html
|
||||
\previouspage creator-how-to-show-and-hide-sidebars.html
|
||||
\previouspage creator-reference.html
|
||||
\ingroup creator-reference-sidebar-views
|
||||
|
||||
\title Include Hierarchy
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
/*!
|
||||
\page creator-reference-terminal-view.html
|
||||
\previouspage creator-how-to-view-output.html
|
||||
\previouspage creator-reference.html
|
||||
|
||||
\ingroup creator-reference-output-views
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
/*!
|
||||
\page creator-reference-to-do-entries-view.html
|
||||
\previouspage creator-how-to-view-output.html
|
||||
\previouspage creator-reference.html
|
||||
|
||||
\ingroup creator-reference-output-views
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
\previouspage creator-file-system-view.html
|
||||
\nextpage studio-content-library.html
|
||||
\else
|
||||
\previouspage creator-how-to-show-and-hide-sidebars.html
|
||||
\previouspage creator-reference.html
|
||||
\endif
|
||||
|
||||
\ingroup creator-reference-sidebar-views
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
\previouspage qtquick-curve-editor.html
|
||||
\nextpage creator-file-system-view.html
|
||||
\else
|
||||
\previouspage creator-how-to-show-and-hide-sidebars.html
|
||||
\previouspage creator-reference.html
|
||||
\endif
|
||||
|
||||
\ingroup creator-reference-sidebar-views
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
|
||||
/*!
|
||||
\page creator-reference-issues-view.html
|
||||
\previouspage creator-how-to-view-output.html
|
||||
\previouspage creator-reference.html
|
||||
|
||||
\ingroup creator-reference-output-views
|
||||
\ingroup studio-reference-output-views
|
||||
@@ -117,7 +117,7 @@
|
||||
|
||||
/*!
|
||||
\page creator-reference-search-results-view.html
|
||||
\previouspage creator-how-to-view-output.html
|
||||
\previouspage creator-reference.html
|
||||
|
||||
\ingroup creator-reference-output-views
|
||||
\ingroup studio-reference-output-views
|
||||
@@ -143,7 +143,7 @@
|
||||
|
||||
/*!
|
||||
\page creator-reference-application-output-view.html
|
||||
\previouspage creator-how-to-view-output.html
|
||||
\previouspage creator-reference.html
|
||||
|
||||
\ingroup creator-reference-output-views
|
||||
\ingroup studio-reference-output-views
|
||||
@@ -185,7 +185,7 @@
|
||||
|
||||
/*!
|
||||
\page creator-reference-compile-output-view.html
|
||||
\previouspage creator-how-to-view-output.html
|
||||
\previouspage creator-reference.html
|
||||
|
||||
\ingroup creator-reference-output-views
|
||||
\ingroup studio-reference-output-views
|
||||
|
||||
@@ -76,7 +76,7 @@
|
||||
For information about new features and bug fixes in each \QC release,
|
||||
select \uicontrol Help > \uicontrol {Change Log}.
|
||||
|
||||
\sa {Use the UI}{How-to: Use the UI}
|
||||
\sa {Use the UI}{How-to: Use the UI}, {Reference}
|
||||
|
||||
\else
|
||||
|
||||
|
||||
Reference in New Issue
Block a user