Doc: Organize the front page into four columns

Lots of the information from the first column will still
move into the How To and Reference sections in future releases.

- Remove obsolete sub-TOC topics.
- Rename the "Overview" as "Developing with Qt Creator" and place it
  first in the TOC.

Task-number: QTCREATORBUG-29361
Change-Id: I8af0460b2391f3152606e5326bb7e8f630f64531
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
This commit is contained in:
Leena Miettinen
2024-03-21 15:12:58 +01:00
parent 1d086c5479
commit e31942fb23
10 changed files with 40 additions and 110 deletions

View File

@@ -5,13 +5,20 @@
</div> </div>
<div class="sectionlist normallist"> <div class="sectionlist normallist">
<div class="heading"> <div class="heading">
<h2>Getting Started</h2> <h2>Developing with Qt Creator</h2>
</div> </div>
<div class="indexboxcont indexboxbar"> <div class="indexboxcont indexboxbar">
<ul> <ul>
<li><a href="creator-overview.html">Overview</a></li> <li><a href="creator-overview.html">Overview</a></li>
<li><a href="creator-quick-tour.html">User Interface</a></li> <li><a href="creator-getting-started.html">Getting Started</a></li>
<li><a href="creator-configuring.html">Configuring Qt Creator</a></li> <li><a href="creator-project-creating.html">Creating Projects</a></li>
<li><a href="creator-configuring-projects.html">Configuring Projects</a></li>
<li><a href="creator-live-preview.html">Validating with Target Hardware</a></li>
<li><a href="creator-connecting-mobile.html">Connecting Devices</a></li>
<li><a href="creator-deployment.html">Deploying to Devices</a></li>
<li><a href="creator-debugging.html">Debugging</a></li>
<li><a href="creator-analyze-mode.html">Analyzing Code</a></li>
<li><a href="creator-squish.html">Using Squish</a></li>
</ul> </ul>
</div> </div>
</div> </div>
@@ -34,26 +41,6 @@
</ul> </ul>
</div> </div>
</div> </div>
<div class="sectionlist normallist">
<div class="heading">
<h2>Running on Devices</h2>
</div>
<ul>
<li><a href="creator-live-preview.html">Validating with Target Hardware</a></li>
<li><a href="creator-deployment.html">Deploying to Devices</a></li>
<li><a href="creator-connecting-mobile.html">Connecting Devices</a></li>
</ul>
</div>
<div class="sectionlist normallist">
<div class="heading">
<h2>Debugging and Analyzing</h2>
</div>
<ul>
<li><a href="creator-debugging.html">Debugging</a></li>
<li><a href="creator-analyze-mode.html">Analyzing Code</a></li>
<li><a href="creator-squish.html">Using Squish</a></li>
</ul>
</div>
<div class="sectionlist normallist"> <div class="sectionlist normallist">
<div class="heading"> <div class="heading">
<h2>How To</h2> <h2>How To</h2>

Binary file not shown.

Before

Width:  |  Height:  |  Size: 676 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 715 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 905 B

View File

@@ -25,11 +25,11 @@
\li \inlineimage front-ui.png \li \inlineimage front-ui.png
\li \inlineimage front-advanced.png \li \inlineimage front-advanced.png
\row \row
\li \b {\l{Overview}} \li \b {\l{Developing with \QC}}
If you have not used an integrated development environment (IDE) If you have not used an integrated development environment (IDE)
before, or want to know what kind of IDE \QC is, go to before, or want to know what kind of IDE \QC is, go to
\l{Overview}. \l{Developing with \QC}.
\li \b {\l{User Interface}} \li \b {\l{User Interface}}
If you have not used \QC before, and want to become familiar If you have not used \QC before, and want to become familiar

View File

@@ -8,11 +8,11 @@
// ********************************************************************** // **********************************************************************
/*! /*!
\previouspage creator-getting-started.html \previouspage index.html
\page creator-overview.html \page creator-overview.html
\nextpage creator-quick-tour.html \nextpage creator-getting-started.html
\title Overview \title Developing with \QC
\QC is a cross-platform, complete integrated development environment \QC is a cross-platform, complete integrated development environment
(IDE) that you can use to create applications for desktop, embedded, (IDE) that you can use to create applications for desktop, embedded,
@@ -235,6 +235,11 @@
a suitable native debugger for each kit from the ones it finds on the a suitable native debugger for each kit from the ones it finds on the
computer. Edit the kits to override this choice. computer. Edit the kits to override this choice.
If you install \QC with \QOI, the GNU Symbolic Debugger is installed
automatically and you should be ready to start debugging after you create
a new project. However, you can change the setup to use debugging tools for
Windows, for example.
Connect devices to your computer to debug processes running on the devices. Connect devices to your computer to debug processes running on the devices.
For more information, see \l{Debugging}. For more information, see \l{Debugging}.

View File

@@ -4,7 +4,7 @@
/*! /*!
\page creator-reference.html \page creator-reference.html
\previouspage creator-how-tos.html \previouspage creator-how-tos.html
\nextpage creator-known-issues.html \nextpage creator-acknowledgements.html
\title Reference \title Reference

View File

@@ -1,44 +0,0 @@
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\previouspage creator-build-process-customizing.html
\page creator-testing.html
\nextpage creator-debugging.html
\title Debugging and Analyzing
\image front-testing.png
\list
\li \l{Debugging}
If you install \QC with \QOI, the GNU Symbolic Debugger
is installed automatically and you should be ready to start
debugging after you create a new project. However, you can
change the setup to use debugging tools for Windows, for
example. You can connect \l{glossary-device}{devices} to your
development host and debug processes running on the devices.
\li \l{Analyzing Code}
Use tools for analyzing C++ and QML code to identify issues in
memory management, CPU usage, coding constructs, and so on. You
must install and configure the tools on your system to use them
from \QC. However, the QML Profiler is installed as part of \QC
for profiling Qt Quick applications.
\li \l{Using Squish}
Map AUTs to \QC and run Squish test suites and cases from it.
\endlist
*/

View File

@@ -12,21 +12,16 @@
\uicontrol Search function in the \l{https://doc.qt.io/qtcreator/} \uicontrol Search function in the \l{https://doc.qt.io/qtcreator/}
{Qt documentation} portal or in the \l {Get help}{Help} mode. {Qt documentation} portal or in the \l {Get help}{Help} mode.
\list
\li \l{Developing with \QC}
\list \list
\li \l{Getting Started} \li \l{Getting Started}
\list \list
\li \l{Overview}
\list
\li \l{Creating Projects}
\li \l{Configuring Projects}
\endlist
\li \l{User Interface} \li \l{User Interface}
\li \l{Configuring Qt Creator} \li \l{Configuring Qt Creator}
\endlist \endlist
\li \l{Tutorials} \li \l{Creating Projects}
\generatelist creator-tutorials \li \l{Configuring Projects}
\li \l{Running on Devices}
\list
\li \l{Validating with Target Hardware} \li \l{Validating with Target Hardware}
\list \list
\li \l{Previewing on Desktop} \li \l{Previewing on Desktop}
@@ -52,9 +47,6 @@
\li \l{Connecting Remote Linux Devices} \li \l{Connecting Remote Linux Devices}
\li \l{Building Applications for the Web} \li \l{Building Applications for the Web}
\endlist \endlist
\endlist
\li \l{Debugging and Analyzing}
\list
\li \l{Debugging} \li \l{Debugging}
\list \list
\li \l{Setting Up Debugger} \li \l{Setting Up Debugger}
@@ -97,6 +89,8 @@
\endlist \endlist
\li \l{Using Squish} \li \l{Using Squish}
\endlist \endlist
\li \l{Tutorials}
\generatelist creator-tutorials
\li \l{How To} \li \l{How To}
\list \list
\li Analyze \li Analyze

View File

@@ -9,7 +9,7 @@
/*! /*!
\page index.html \page index.html
\nextpage creator-getting-started.html \nextpage creator-overview.html
\title Qt Creator Manual \title Qt Creator Manual
@@ -27,37 +27,27 @@
\table \table
\row \row
\li {4,1} \b {\l{All Topics}{Click Here for a List of All Topics}} \li {4,1} \b {\l{All Topics}}
\row \row
\li \inlineimage front-gs.png \li \inlineimage front-gs.png
\li \inlineimage front-coding.png \li \inlineimage front-coding.png
\li \inlineimage front-preview.png
\row
\li \b {\l{Getting Started}}
\list
\li \l{Overview}
\li \l{User Interface}
\li \l{Configuring Qt Creator}
\endlist
\li \b {\l{Tutorials}}
\generatelist creator-tutorials
\li \b {\l{Running on Devices}}
\list
\li \l{Validating with Target Hardware}
\li \l{Deploying to Devices}
\li \l{Connecting Devices}
\endlist
\row
\li \inlineimage front-testing.png
\li \inlineimage front-help.png \li \inlineimage front-help.png
\li \inlineimage front-advanced.png \li \inlineimage front-advanced.png
\row \row
\li \b {\l{Debugging and Analyzing}} \li \b {\l{Developing with \QC}}
\list \list
\li \l{Getting Started}
\li \l{Creating Projects}
\li \l{Configuring Projects}
\li \l{Validating with Target Hardware}
\li \l{Connecting Devices}
\li \l{Deploying to Devices}
\li \l{Debugging} \li \l{Debugging}
\li \l{Analyzing Code} \li \l{Analyzing Code}
\li \l{Using Squish} \li \l{Using Squish}
\endlist \endlist
\li \b {\l{Tutorials}}
\generatelist creator-tutorials
\li \b {\l{How To}} \li \b {\l{How To}}
\list \list
\li \l{Analyze} \li \l{Analyze}
@@ -70,7 +60,6 @@
\li \l{Test} \li \l{Test}
\li \l{Use \QC} \li \l{Use \QC}
\li \l{Use the UI} \li \l{Use the UI}
\li \l{How To}{See All}
\endlist \endlist
\li \b {\l{Reference}} \li \b {\l{Reference}}
\list \list
@@ -83,7 +72,6 @@
\li \l {Supported Platforms} \li \l {Supported Platforms}
\li \l {Version Control Systems} \li \l {Version Control Systems}
\li \l {Views} \li \l {Views}
\li \l {Reference}{See All}
\endlist \endlist
\endtable \endtable
*/ */