Commit 44c107c2 authored by Leena Miettinen's avatar Leena Miettinen

Doc: move misc overview topics to a separate folder

Change-Id: I7bcf4edb2e23c669b000e08a1d6ce14b3982fd0d
Reviewed-on: http://codereview.qt-project.org/5610Reviewed-by: default avatarQt Sanity Bot <qt_sanity_bot@ovi.com>
Reviewed-by: default avatarEike Ziller <eike.ziller@nokia.com>
Reviewed-by: default avatarCasper van Donderen <casper.vandonderen@nokia.com>
parent 76b59d03
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.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 info@qt.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-glossary.html
\page creator-acknowledgements.html
\title Acknowledgements
\section1 Third-party Components
\QC contains the following third-party components:
\list
\o \bold{Open Source front-end for C++ (license MIT)}, enhanced for use
in \QC.\br
Roberto Raggi <roberto.raggi@gmail.com>\br
QtCreator/src/shared/cplusplus\br\br
\o \bold{Botan, a C++ crypto library. Version 1.8.8}\br
\list
\o Copyright (C) 1999-2004 The Botan Project. All rights
reserved.
\o Copyright (C) 1999-2009 Jack Lloyd
\o 2001 Peter J Jones
\o 2004-2007 Justin Karneges
\o 2005 Matthew Gregan
\o 2005-2006 Matt Johnston
\o 2006 Luca Piccarreta
\o 2007 Yves Jerschow
\o 2007-2008 FlexSecure GmbH
\o 2007-2008 Technische Universitat Darmstadt
\o 2007-2008 Falko Strenzke
\o 2007-2008 Martin Doering
\o 2007 Manuel Hartl
\o 2007 Christoph Ludwig
\o 2007 Patrick Sona
\endlist
All rights reserved.\br\br
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:\br\br
1. Redistributions of source code must retain the above copyright
notice, this list of conditions, and the following disclaimer.\br\br
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions, and the following disclaimer in the
documentation and/or other materials provided with the distribution.\br
\br
THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) "AS IS" AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE,
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR(S) OR CONTRIBUTOR(S) BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\br\br
The source code of Botan C++ crypto library can be found
here:
\list
\o QtCreator/src/libs/3rdparty
\o \l{http://qt.gitorious.org/qt-creator/qt-creator/trees/master/src/libs/3rdparty}
\endlist
\br\br
\o \bold{NetSieben SSH Library is a Secure Shell client library for C++.
Version 1.3.2}\br
\list
\o \bold{Commercial License:} For organizations who do not want to
release the source code for their applications as open source/
free software; in other words they do not want to comply with the
GNU General Public License (GPL) or Q Public License.
\o \bold{Non Commercial / Open Source License:} NetSieben believes in
contributing back to the open source community, thus it has released
the SSH Library under Q Public License as it is defined by Trolltech
AS of Norway. The Open Source License allows the user to use software
under an open source / free software license, and distribute it
freely. The software can be used at no charge with the condition
that if the user uses the SSH Library in an application they wish to
redistribute, then the complete source code for your application must
be available and freely redistributable under reasonable conditions.
For more information on the used QPL License see:
QtCreator/src/libs/3rdparty/net7ssh/LICENSE.QPL
\endlist\br\br
The source code of NetSieben Secure Shell C++ Library can be found
here:
\list
\o QtCreator/src/libs/3rdparty
\o \l{http://qt.gitorious.org/qt-creator/qt-creator/trees/master/src/libs/3rdparty}
\endlist
\endlist
*/
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.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 info@qt.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-help.html
\page creator-advanced.html
\nextpage creator-os-supported-platforms.html
\title Advanced Use
\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.
This following topics describe advanced use of \QC:
\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 the Build Issues Pane}
\o \l{Using Command Line Options}
\o \l{Keyboard Shortcuts}
\o \l{Glossary}
\endlist
*/
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.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 info@qt.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-running-valgrind-remotely.html
\page creator-deployment.html
\nextpage creator-deployment-symbian.html
\title Deploying Applications 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}
\o \l{Deploying Applications to Maemo or MeeGo Harmattan Devices}
\o \l{Publishing Maemo Applications to Extras-devel}
\o \l{Publishing Applications to Ovi Store}
\o \l{Building with Remote Compiler}
\endlist
\endif
*/
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.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 info@qt.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-publishing-to-maemo-extras.html
\page creator-publish-ovi.html
\nextpage creator-publish-ovi-symbian.html
\title Publishing Applications to Ovi Store
Ovi Store is the global content market of Nokia, which reaches millions of
people worldwide. Consumers can access Ovi Store through either of these
platforms:
\list
\o Ovi 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.
The process and requirements to publish Qt applications to Ovi 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 Ovi Store} wiki.
This section describes how to generate installation packages that you can
publish to Ovi Store.
\if defined(qcmanual)
\list
\o \l{Publishing Qt Content for Symbian Devices}
\o \l{Publishing Qt Content for Maemo Devices}
\o \l{Publishing Qt Content for MeeGo Harmattan Devices}
\endlist
\endif
*/
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.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 info@qt.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-editor-fakevim.html
\page creator-design-mode.html
\nextpage creator-visual-editor.html
\title Developing Application UI
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}.
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.
You can edit QML code in the code editor or in the integrated \QMLD.
\image qtcreator-design-mode.png "Design mode"
The integration includes project management and code completion.
\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
The following sections describe how to develop application UI:
\list
\o \l{Developing Qt Quick Applications}
\if defined(qcmanual)
\o \l{Developing Widget Based Applications}
\endif
\o \l{Optimizing Applications for Mobile Devices}
\endlist
*/
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.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 info@qt.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-quick-tour.html
\page creator-getting-started.html
\nextpage creator-build-example-application.html
\title Getting Started
This section contains examples that illustrate how to use \QC to create,
build, and run simple applications:
\list
\o \l{Building and Running an Example Application}
\o \l{Creating a Qt Quick Application}
\if defined(qcmanual)
\o \l{Creating a Qt Quick Application Using Qt Quick Components}
\o \l{Creating a Qt Widget Based Application}
\o \l{Creating a Qt Widget Based Mobile Application}
\endif
\endlist
*/
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.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 info@qt.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 technical-support.html
\page creator-glossary.html
\nextpage creator-acknowledgements.html
\title Glossary
\table
\header
\o Term
\o Meaning
\row
\o
\raw HTML
Qt&nbsp;in&nbsp;PATH
\endraw
\target glossary-system-qt
\o This is the Qt
version for the \c qmake command found in your \c PATH
environment variable.
This is likely to be the system's Qt version.
\row
\o
\raw HTML
Project&nbsp;Qt
\endraw
\target glossary-project-qt
\o The version of Qt configured in the \gui{Projects} mode,
\gui {Build Settings}, \gui {Qt Version} field. This is the Qt
version that is actually used by a particular project.
\row
\o
\raw HTML
Shadow&nbsp;build
\endraw
\target glossary-shadow-build
\o Shadow building means building a project in a separate
directory, the \e{build directory}. The build directory is
different from the source directory. One of the benefits of
shadow building is that it keeps your source directory clean.
Shadow building is the best practice if you need many build
configurations for a single set of source.
\row
\o
\raw HTML
Target
\endraw
\target glossary-development-target
\o Target means the software platform for which you develop an
application. Qt Creator groups platform specific settings (such
as build configurations, compatible tool chains, and supported
Qt versions) as targets to make cross-platform development
easier.
\endtable
*/
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.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 info@qt.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-tips.html
\page creator-known-issues.html
\nextpage technical-support.html
\title Known Issues
This section 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.
For a list of fixed issues and added features, see the changelog file in
the \c{qtcreator\dist} folder or the \l{https://bugreports.qt.nokia.com}
{Qt Bug Tracker}.
\section1 General Issues
\list
\o If you change the Input Languages in Windows, \QC might not
respond for 30 seconds. This is a known issue in the Advanced Text
Service of Microsoft Windows.
\o \QC uses SQLite for storing some of its settings. SQLite is
known to have problems with certain NFS servers (most notably the
nfs-user-server 2.2beta), since they can lock up the application
when it tries to lock the database. If your home directory is on an
NFS share and you encounter this issue, one option would be to
switch to the nfs-kernel-server, or create a symlink so that the
settings are stored locally.
\o The Okteta KDE custom widget plugin might be installed as part of
some Linux distributions. It can cause Qt Designer to crash. For
more information, see:
\list
\o \l{https://bugs.launchpad.net/ubuntu/+source/kdeutils/+bug/662005}
{Ubuntu bug 662005}
\o \l{https://bugreports.qt.nokia.com/browse/QTBUG-12025}
{QTBUG-12025}
\endlist
To resolve the issue, enter the following command to remove the
package:
\code
sudo apt-get remove okteta
\endcode
Or delete the following file:
\c /usr/lib/kde4/plugins/designer/oktetadesignerplugin.so.
\endlist
\section1 Editing Issues
\list