Commit 88e29feb authored by Leena Miettinen's avatar Leena Miettinen
Browse files

Doc: restructure doc according to developer workflow



Add and remove illustrations.
Add landing pages.

Change-Id: I927d62aee9dc43814ef7f4d7424a83eee2af156b
Reviewed-by: default avatarErik Verbruggen <erik.verbruggen@nokia.com>
parent aeebb26e
......@@ -76,10 +76,10 @@
\o \gui Welcome mode for opening projects.
\o \gui{\l{Using the Editor}{Edit}} mode for editing project and source
\o \gui{\l{Coding}{Edit}} mode for editing project and source
files.
\o \gui{\l{Developing Application UI}{Design}} mode for designing and
\o \gui{\l{Designing User Interfaces}{Design}} mode for designing and
developing application user interfaces. This mode is available for
UI files.
......
......@@ -27,9 +27,9 @@
/*!
\contentspage index.html
\previouspage creator-project-generic.html
\previouspage creator-project-wizards.html
\page creator-version-control.html
\nextpage adding-plugins.html
\nextpage creator-configuring-projects.html
\title Using Version Control Systems
......
......@@ -21,7 +21,7 @@
/*!
\contentspage index.html
\previouspage creator-keyboard-shortcuts.html
\previouspage creator-help.html
\page creator-faq.html
\nextpage creator-tips.html
......
......@@ -29,7 +29,7 @@
\contentspage index.html
\previouspage creator-deployment-symbian.html
\page creator-deployment-maemo.html
\nextpage creator-publishing-to-maemo-extras.html
\nextpage creator-connecting-mobile.html
\title Deploying Applications to Maemo or MeeGo Harmattan Devices
......
......@@ -27,9 +27,9 @@
/*!
\contentspage index.html
\previouspage creator-editor-external.html
\previouspage creator-build-process-customizing.html
\page creator-maemo-emulator.html
\nextpage creator-mime-types.html
\nextpage creator-remote-compiler.html
\title Using Maemo or MeeGo Harmattan Emulator
......
......@@ -27,9 +27,9 @@
/*!
\contentspage index.html
\previouspage creator-deployment-maemo.html
\previouspage creator-publish-ovi-meego.html
\page creator-publishing-to-maemo-extras.html
\nextpage creator-publish-ovi.html
\nextpage creator-advanced.html
\title Publishing Maemo Applications to Extras-devel
......
......@@ -29,15 +29,11 @@
\contentspage index.html
\previouspage creator-publish-ovi-maemo.html
\page creator-publish-ovi-meego.html
\nextpage creator-remote-compiler.html
\nextpage creator-publishing-to-maemo-extras.html
\title Publishing Qt Content for MeeGo Harmattan Devices
You cannot publish applications that are built with the beta version of the
MeeGo Harmattan tool chain to Nokia Store.
However, you can prepare for publishing by making sure that your application
meets the
The applications that you publish to Nokia Store, must meet the
\l{http://www.developer.nokia.com/info/sw.nokia.com/id/44affcd1-ceba-4aca-8b65-670ce2cbbd1e/MeeGo_1_2_Harmattan_Applications_Ovi_Store_Entry_Requirements.html}
{MeeGo 1.2 Harmattan Applications: Nokia Store Entry Requirements}.
......
......@@ -23,7 +23,7 @@
\contentspage index.html
\if defined(qcmanual)
\previouspage creator-sharing-project-settings.html
\previouspage creator-connecting-mobile.html
\else
\previouspage creator-developing-symbian.html
\endif
......
......@@ -27,7 +27,7 @@
/*!
\contentspage index.html
\previouspage creator-glossary.html
\previouspage technical-support.html
\page creator-acknowledgements.html
\title Acknowledgements
......
......@@ -27,45 +27,69 @@
/*!
\contentspage index.html
\previouspage creator-help.html
\previouspage creator-publishing-to-maemo-extras.html
\page creator-advanced.html
\nextpage creator-os-supported-platforms.html
\title Advanced Use
\image creator_advanceduse.png
\QC attempts to meet your development needs, whether you are an
experienced Qt developer or a newcomer to Qt. When you install \QC
as a part of \QSDK, the default configuration allows you to start coding,
building, running and debugging applications with very little effort.
However, you can easily change or extend the default configuration, by
choosing a different build system, adding project wizards, integrating
external tools, or editing the standard MIME types that \QC uses
to recognize your files.
You can start \QC and specify some options for running it from the
command line.
choosing a different build system or integrating external tools.
This following topics describe advanced use of \QC:
You can also use special options to start \QC from the command line and use
it mainly from the keyboard.
\list
\o \l{Supported Platforms}
\o \l{Adding New Custom Wizards}
\o \l{Setting Up a CMake Project}
\o \l{Setting Up a Generic Project}
\o \l{Using Version Control Systems}
\if defined(qcmanual)
\o \l{Adding Qt Designer Plugins}
\endif
\o \l{Using External Tools}
\if defined(qcmanual)
\o \l{Using Maemo or MeeGo Harmattan Emulator}
\endif
\o \l{Editing MIME Types}
\o \l{Showing Task List Files in Issues Pane}
You can install and run \QC on several operating systems to create
applications for multiple desktop and mobile device platforms.
\o \l{Using Other Build Systems}
\QC is integrated with cross-platform systems for build automation:
qmake and CMake. In addition, you can import generic projects that
do not use qmake or CMake, and specify that \QC ignores your build
system.
\o \l{Using Command Line Options}
You can start \QC and specify some options for running it from the
command line.
\o \l{Keyboard Shortcuts}
\o \l{Glossary}
\QC provides various keyboard shortcuts to speed up your development
process. You can change the keyboard shortcuts, as well as import
and export keyboard shortcut mapping schemes.
\o \l{Using External Tools}
You can use external tools directly from \QC. Qt Linguist,
QML Viewer, the default text editor for your system, and the \c sort
tool are preconfigured for use. You can change their default
configurations and configure new tools.
\endlist
\section1 Related Topics
\list
\o \l{Showing Task List Files in Issues Pane}
You can load report files created by code scanning and analysis
tools to the \gui Issues output pane. You can navigate to the
corresponding source code by clicking the error message.
\endlist
*/
......@@ -27,31 +27,43 @@
/*!
\contentspage index.html
\previouspage creator-running-valgrind-remotely.html
\previouspage creator-running-targets.html
\page creator-deployment.html
\nextpage creator-deployment-symbian.html
\title Deploying Applications to Mobile Devices
\title Deploying to Mobile Devices
Deploy configurations in the \gui Project mode \gui {Run Settings} handle
the packaging of the application as an executable and copying it to a
location you want to run the executable at. The files can be copied to a
location in the file system of the development PC or a mobile device.
When you are ready to publish the application on a publishing channel, you
must make sure that the installation file meets the requirements for
publishing and installing applications to the target devices. The following
sections describe the steps that you have to take to create installation
packages for publishing on different channels:
\if defined(qcmanual)
\list
\o \l{Deploying Applications to Symbian Devices}
When you deploy the application for the \gui{Symbian Device} target,
\QC automatically generates a Symbian installation system (SIS) file
in the project folder and copies it to the connected device. You can
sign the SIS file and wrap it in a Nokia Smart Installer for Symbian
package. You can test and debug the application on the device.
\o \l{Deploying Applications to Maemo or MeeGo Harmattan Devices}
\o \l{Publishing Maemo Applications to Extras-devel}
\o \l{Publishing Applications to Nokia Store}
\o \l{Building with Remote Compiler}
When you deploy the application on the \gui{Maemo5} or
\gui Harmattan target, \QC generates a Debian installation package
in the build directory and copies it to the connected device. You
can test and debug the application on the device.
\endlist
\endif
\section1 Related Topics
\list
\o \l{Publishing}
When you are ready to publish the application on a publishing
channel, you must make sure that the installation file meets the
requirements for publishing and installing applications to the
target devices.
\endlist
*/
......@@ -27,42 +27,53 @@
/*!
\contentspage index.html
\previouspage creator-publishing-to-maemo-extras.html
\previouspage creator-running-valgrind-remotely.html
\page creator-publish-ovi.html
\nextpage creator-publish-ovi-symbian.html
\title Publishing Applications to Nokia Store
\title Publishing
Nokia Store is the global content market of Nokia, which reaches millions of
people worldwide. Consumers can access Nokia Store through either of these
platforms:
\image creator_publishing.png
\list
\o Nokia Store applications on mobile devices
\o Web browsers on desktop computers, laptops, netbooks, and tablets
\endlist
Consumers have access to a wide selection of content and can download
content in a few easy clicks.
You can publish applications to app stores, such as Nokia Store, and other
channels, such as Extras-devel for Maemo applications. Nokia Store is the
global content market of Nokia that consumers can access directly from Nokia
devices or through Web browsers.
The process and requirements to publish Qt applications to Nokia Store are
described in the
\l {http://www.developer.nokia.com/Community/Wiki/Guide_to_Publishing_Qt_Applications_to_the_Ovi_Store}
{Guide to Publishing Qt Applications to the Nokia Store} wiki.
This section describes how to generate installation packages that you can
publish to Nokia Store.
\if defined(qcmanual)
\list
\o \l{Publishing Qt Content for Symbian Devices}
\o \l{Publishing Qt Content for Maemo Devices}
The \gui {Publish Qt Symbian Applications to Nokia Store}
wizard ensures that your application can be published to Nokia
Store by verifying that the the application UID, vendor name,
and the capabilities used meet the Nokia Publish criteria.
\o \l{Publishing Qt Content for MeeGo Harmattan Devices}
\QC generates installation packages that you can publish to
Nokia Store. However, you must make sure that the packages meet
the requirements of the Nokia Store.
\o \l{Publishing Qt Content for Maemo Devices}
\QC generates installation packages that you can publish to
Nokia Store. However, you must make sure that the packages meet
the requirements of the Nokia Store.
\o \l{Publishing Maemo Applications to Extras-devel}
You can use the \gui {Publish for Fremantle Extras-devel Free
Repository} wizard to create a source archive and, optionally,
upload it to a build server for compiling and packaging. The
package is then moved to the Extras-devel repository that
contains free Maemo applications.
\endlist
\endif
*/
......@@ -27,48 +27,48 @@
/*!
\contentspage index.html
\previouspage creator-editor-fakevim.html
\previouspage creator-project-managing-sessions.html
\page creator-design-mode.html
\nextpage creator-visual-editor.html
\title Developing Application UI
\title Designing User Interfaces
Large high-resolution screens, touch input, and significant graphics power
are becoming common in portable consumer devices, such as mobile phones,
media players, set-top boxes, and netbooks. To fully benefit from these
features and to create intuitive, modern-looking, fluid user interfaces,
you can use \l {http://doc.qt.nokia.com/4.7/qtquick.html}{Qt Quick}.
\image creator_designinguserinterface.png
Qt Quick consists of a rich set of user interface elements, a declarative
language for describing user interfaces, and a language runtime. A
collection of C++ APIs is used to integrate these high level features with
classic Qt applications.
\QC provides two integrated visual editors, \QMLD and \QD. The integration
includes project management and code completion.
You can edit QML code in the code editor or in the integrated \QMLD.
\list
\image qtcreator-design-mode.png "Design mode"
\o \l{Developing Qt Quick Applications}
The integration includes project management and code completion.
You can either create Qt Quick projects from scratch or import
existing projects to \QC. You can use the code editor (Edit mode)
or the visual editor (Design mode) to develop Qt Quick applications.
\o \l{Developing Widget Based Applications}
\if defined(qcmanual)
If you need a traditional user interface that is clearly structured and
enforces a platform look and feel, you can use the integrated \QD. You can
compose and customize your widgets or dialogs and test them using different
styles and resolutions.
\endif
Widgets and forms created with \QD are integrated seamlessly with
programmed code by using the Qt signals and slots mechanism that
allows you to easily assign behavior to graphical elements. All
properties set in \QD can be changed dynamically within the code.
Furthermore, features such as widget promotion and custom
plugins allow you to use your own widgets with \QD.
\o \l{Optimizing Applications for Mobile Devices}
The following sections describe how to develop application UI:
Mobile devices have been designed for use when mobile. Keep the
characteristics of mobile devices in mind when you create
applications for them.
\list
\endlist
\o \l{Developing Qt Quick Applications}
\section1 Related Topics
\if defined(qcmanual)
\o \l{Developing Widget Based Applications}
\endif
\list
\o \l{Optimizing Applications for Mobile Devices}
\o \l{Adding Qt Designer Plugins}
\endlist
You can use Qt APIs to create plugins that extend Qt applications.
This enables you to add your own widgets to \QD.
\endlist
*/
......@@ -27,7 +27,7 @@
/*!
\contentspage index.html
\previouspage index.html
\previouspage creator-glossary.html
\page creator-getting-started.html
\nextpage creator-overview.html
......@@ -40,22 +40,22 @@
\i \inlineimage creator-gs-03.png
\i \inlineimage creator-gs-04.png
\row
\i \l{IDE Overview}
\o \bold {\l{IDE Overview}}
If you have not used an integrated development environment (IDE)
before, or want to know what kind of IDE \QC is, go to
\l{IDE Overview}.
\i \l{User Interface}
\o \bold {\l{User Interface}}
If you have not used \QC before, and want to become familiar
with the parts of the user interface, go to \l{User Interface}.
\i \l{Building and Running an Example Application}
\o \bold {\l{Building and Running an Example Application}}
To check that \l{glossary-development-target}{targets} were
successfully installed as part of the \QSDK installation, open
an example application and run it. If you have not done so
before, go to \l{Building and Running an Example Application}.
\i \l{Tutorials}
\o \bold {\l{Tutorials}}
Now you are ready to start developing your own applications.
Pick a tutorial to follow in \l{Tutorials}
......
......@@ -27,9 +27,9 @@
/*!
\contentspage index.html
\previouspage technical-support.html
\previouspage creator-known-issues.html
\page creator-glossary.html
\nextpage creator-acknowledgements.html
\nextpage technical-support.html
\title Glossary
......
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
**
** GNU Free Documentation License
**
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
****************************************************************************/
// **********************************************************************
// 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.
// **********************************************************************
/*!
\contentspage index.html
\previouspage creator-task-lists.html
\page creator-help-overview.html
\nextpage creator-help.html
\title Getting Help
\image creator_gettinghelp.png
\list
\o \l{Using the Help Mode}
\QC comes fully integrated with Qt documentation and examples using
the Qt Help plugin. You can add external documentation to the
\gui Help mode and filter the documents displayed to find relevant
information faster. In addition, you can add bookmarks to help
pages.
\o \l{FAQ}
Contains answers to some frequently asked questions about \QC.
\o \l{Tips and Tricks}
Lists useful Qt Creator features.
\o \l{Known Issues}
Lists known issues in \QC version \qtcversion. The development team
is aware of them, and therefore, you do not need to report them as
bugs.
\o \l{Glossary}
Lists special terms used in \QC.
\endlist
\section1 Related Topics
\list
\o \l{Technical Support}
Lists Qt support sites and other useful sites.
\o \l{Acknowledgements}
Lists the third-party components in \QC.
\endlist
*/
......@@ -29,7 +29,7 @@
\contentspage index.html
\previouspage creator-tips.html
\page creator-known-issues.html
\nextpage technical-support.html
\nextpage creator-glossary.html
\title Known Issues
......
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
**
** GNU Free Documentation License
**
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
****************************************************************************/
// **********************************************************************
// 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.
// **********************************************************************
/*!
\contentspage index.html
\previouspage creator-deployment-maemo.html
\page creator-connecting-mobile.html
\nextpage creator-developing-meego.html
\title Connecting Mobile Targets
You can connect mobile devices to the development PC to build, run, debug,
and analyze applications on them from \QC. When you install mobile targets
as part of the \QSDK, the build and run settings for the target devices are
set up automatically in \QC. Currently, the tool chain for building
applications for generic Linux devices is not included in \QSDK.
You can connect the device to the development PC using a USB connection.
Additionally, you can connect Linux-based devices by using a WLAN
connection.
\list
\o \l{Connecting Generic Linux Devices}
If you have the tool chain for building applications for generic
Linux devices (with no MADDE support) installed on the development
PC, you can add it to \QC. Create device configurations and select
them in the \QC run settings.
\o \l{Connecting MeeGo Harmattan Devices}
MeeGo Harmattan is a Linux-based software platform developed by
Nokia and preinstalled on Nokia N950 and Nokia N9. It enables
developers to create applications using the Qt framework.
Use the SDK Connectivity tool that is preinstalled on the device to
create the device-side end point for USB and WLAN connections.
\o \l{Connecting Maemo Devices}