summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2014-02-11 14:56:54 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-03-25 14:52:43 +0100
commitd16aa234441ff2417fae867c3e3f8c994a5a55b6 (patch)
treea29f8b286954b13afe858283a6a2b6aadc705c6b
parent1763f9c0ca35b66a8eebdc8ad02b1339276e5517 (diff)
downloadqtdoc-d16aa234441ff2417fae867c3e3f8c994a5a55b6.tar.gz
Doc: Edited main Qt Examples and Tutorials landing page.
-applied a three column style -examples categorized with Qt Creator tutorials more prominent -added information about where to find the examples Task-number: QTBUG-33597 Change-Id: Ia23089aec8aa453890a80bbcf03e117e0fd3c955 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
-rw-r--r--doc/src/examples.qdoc189
-rw-r--r--doc/src/getting-started/examples.qdoc114
2 files changed, 189 insertions, 114 deletions
diff --git a/doc/src/examples.qdoc b/doc/src/examples.qdoc
new file mode 100644
index 00000000..bb20d026
--- /dev/null
+++ b/doc/src/examples.qdoc
@@ -0,0 +1,189 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia. For licensing terms and
+** conditions see http://qt.digia.com/licensing. For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Free Documentation License Usage
+** 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. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \page qtexamplesandtutorials.html
+ \title Qt Examples And Tutorials
+ \brief A list of Qt examples and tutorials.
+
+ A collection of code samples and tutorials are provided with Qt to
+ help new users get started with Qt development. These documents cover a
+ range of topics, from basic use of widgets to step-by-step tutorials that
+ show how an application is put together.
+
+ The examples are part of the Qt packages. Visit the \l Downloads page for
+ more information.
+
+ \section2 Running the Examples
+
+ Open and run examples within Qt Creator's \gui{Welcome} mode. Most of the
+ examples run on various platforms and to search for platform-specific
+ examples, type the platform name (or any keywords) in the search field. For
+ example, typing \c Android in the search field lists the examples that are
+ fully compatible with Android.
+
+ For more information about running examples in Qt Creator, visit the
+ \l{Qt Creator: Building and Running an Example}{Building and Running an Example}
+ page.
+
+ To view a list of all Qt examples, visit the \l{List of Qt Examples} page.
+
+ \div {class="landingicons"}
+ \div {class="icons1of3"}
+ \bold{Setting Up Projects}
+ \list
+ \li \l{Qt Creator: Creating Qt Quick Projects}{Qt Quick Projects}
+ \li \l{Qt Creator: Creating a Qt Widget Based Application}{Qt Widget Projects}
+ \li \l{Qt Creator: Configuring Projects}{Configuring Projects}
+ \endlist
+
+ \enddiv
+ \div {class="icons1of3"}
+ \bold{Essentials}
+ \list
+ \li \l{Qt Creator: Building for Multiple Platforms}{Building for Multiple Platforms}
+ \li \l{Qt Creator: Running on Multiple Platforms}{Running on Multiple Platforms}
+ \li \l{Qt Creator: Deploying to Mobile Devices}{Deploying to Mobile Devices}
+ \li \l{Qt Creator: Connecting Mobile Devices}{Connecting Mobile Devices}
+ \endlist
+ \list
+ \li \l{Qt Creator: Building and Running}{See more}
+ \endlist
+ \enddiv
+ \div {class="icons1of3"}
+ \enddiv
+ \enddiv
+
+ \div {class="landingicons"}
+ \div {class="icons1of3"}
+ \bold{QML and Qt Quick}
+ \list
+ \li \l{First Steps with QML}
+ \li \l{Qt Creator: Developing Qt Quick Applications}{Developing Qt Quick Applications}
+ \li \l{Qt Quick Controls - Gallery}{Controls Gallery}
+ \li \l{QML Advanced Tutorial}{SameGame}
+ \endlist
+ \list
+ \li \l{Qt Quick Examples and Tutorials}{See more}
+ \endlist
+ \enddiv
+ \div {class="icons1of3"}
+ \bold{Widgets}
+ \list
+ \li \l{Getting Started Programming with Qt Widgets}{Text Editor}
+ \li \l{modelview.html}{Model-View}
+ \li \l{Item Views Examples}
+ \li \l{Main Window Examples}
+ \endlist
+ \list
+ \li \l{Qt Widgets Examples}{See more}
+ \endlist
+ \enddiv
+ \div {class="icons1of3"}
+ \bold{Graphics}
+ \list
+ \li \l{Scene Graph - OpenGL Under QML}{OpenGL Under QML}
+ \li \l{Scene Graph - Painted Item}{Painted Item}
+ \li \l{Painting Examples}
+ \li \l{Graphics View Examples}
+ \li \l{Rich Text Examples}
+ \li \l{Animation Framework Examples}
+ \endlist
+ \enddiv
+ \enddiv
+
+ \div {class="landingicons"}
+ \div {class="icons1of3"}
+ \bold{Data and Networking}
+ \list
+ \li \l{Network Examples}
+ \li \l{SQL Examples}
+ \li \l{XML Examples}
+ \li \l{JSON Save Game Example}
+ \li \l{Qt WebSockets Examples}
+ \endlist
+ \enddiv
+ \div {class="icons1of3"}
+ \bold{Applications}
+ \list
+ \li \l{Application Example}
+ \li \l{Qt Quick Examples - Window and Screen}{Window and Screen Example}
+ \li \l{How to Create Qt Plugins}
+ \li \l{Plug & Paint Example} (Plugin Example)
+ \endlist
+ \enddiv
+ \div {class="icons1of3"}
+ \bold{Processes and Threads}
+ \list
+ \li \l{Threading Basics}
+ \li \l{Threading and Concurrent Programming Examples}
+ \li \l{D-Bus Examples}
+ \li \l{IPC Examples}{Inter-Process Communication (IPC) Examples}
+ \endlist
+ \enddiv
+ \enddiv
+
+
+ \div {class="landingicons"}
+ \div {class="icons1of3"}
+ \bold{Multimedia}
+ \list
+ \li \l{Media Player Example}{Media Player}
+ \li \l{Video Widget Example}{Video Widget}
+ \li \l{Camera Example}
+ \endlist
+ \list
+ \li \l{Qt Multimedia Examples}{See more}
+ \endlist
+ \enddiv
+ \div {class="icons1of3"}
+ \bold{Peripheral Devices}
+ \list
+ \li \l{Qt Serial Port Examples}
+ \li \l{Qt Bluetooth Examples}
+ \li \l{Qt NFC Examples}
+ \li \l{Qt Sensors Examples}
+ \li \l{Qt Positioning Examples}
+ \endlist
+ \enddiv
+ \div {class="icons1of3"}
+ \bold{Tools}
+ \list
+ \li \l{Qt Assistant Examples}
+ \li \l{Qt Designer Examples}
+ \li \l{Qt Help Examples}
+ \li \l{Qt Linguist Examples}
+ \li \l{Qt Creator Manual}
+ \endlist
+ \enddiv
+ \enddiv
+
+ \section1 Community Examples
+
+ To view and run examples provided through the Qt Project, visit the
+ \l{http://qt-project.org/wiki/Category:Learning::Demos_and_Examples}{Community Examples} page.
+*/
diff --git a/doc/src/getting-started/examples.qdoc b/doc/src/getting-started/examples.qdoc
index 604b1fe4..50475ef3 100644
--- a/doc/src/getting-started/examples.qdoc
+++ b/doc/src/getting-started/examples.qdoc
@@ -26,120 +26,6 @@
****************************************************************************/
/*!
- \page qtexamplesandtutorials.html
- \title Qt Examples And Tutorials
- \brief Explains step by step basic Qt programming
-
- \section1 Tutorials
-
- A collection of tutorials and \e walkthrough guides are provided with Qt to
- help new users get started with Qt development. These documents cover a
- range of topics, from basic use of widgets to step-by-step tutorials that
- show how an application is put together.
-
- \section2 Qt Creator
- Qt Creator is the integrated development environment (IDE) for Qt.
- \list
- \li \l{Qt Creator Manual} - The manual contains
- information on how to achieve development tasks
- These are excerpts from the manual:
- \list
- \li \l{Qt Creator: Tutorials}{Tutorials}
- \li \l{Qt Creator: Creating Projects}{Creating Projects}
- \li \l{Qt Creator: Building and Running}{Building and Running}
- \li \l{Qt Creator: Debugging}{Debugging}
- \endlist
- \endlist
-
- \section2 Qt Quick Essentials
- Qt Quick and QML features are covered in several tutorials, ranging from
- easy introductions to advanced tutorials that mix QML with C++ and
- JavaScript.
- \list
- \li \l{QML Tutorial}{Hello World} - A very simple QML example that
- demonstrates the basic QML features
- \li \l{Getting Started Programming with Qt Quick}{QML Text Editor} - An
- intermediate QML tutorial that covers many QML features such as states,
- plugins, and C++ development
- \li \l{QML Advanced Tutorial}{SameGame} - A walkthrough of creating a
- simple game using QML for the interface and JavaScript for the game
- logic
- \omit broken links
- \image qml-samegame-demo-small.png Samegame
- \endomit
- \endlist
-
- \omit
- Omitted for now since the links are broken.
- \section2 Qt WebKit
- \list
- \li \l{QtWebKit Guide} - An introductory guide to the features of QtWebKit
- and HTML5.
- \list
- \li \l{QtWebKit Guide - Level 3 CSS}{CSS Chapter} - Covers what is
- possible with CSS3 and QtWebKit.
- \li \l{Canvas Graphics}{HTML5 Canvas Chapter} - Covers the basics of
- integrating the <canvas> element into web applications.
- \li \l{QtWebKit Guide - Client Storage}{Client Storage Chapter} -
- Describes the basics of storing information on the client side.
- \endlist
- \endlist
- \endomit
-
- \section2 Qt Essentials
- The basic concepts and technologies in Qt are introduced in these essential
- tutorials.
- \list
- \li \l{Getting Started Programming with Qt Widgets}{Qt Text Editor} - A simple
- tutorial detailing the creation of a basic Qt application
- Introduces the use of slots and signals, file operations, and widgets.
- \li \l{Address Book Tutorial}{Address Book} - A beginner's guide to
- widgets, container classes, and layouts.
- \omit broken links
- \image addressbook-tutorial.png AddressBook
- \endomit
- \li \l{modelview.html}{ModelView} - This tutorial gives an introduction to
- ModelView programming using the Qt cross-platform framework
- \li\l{thread-basics.html}{Threads} - A short tutorial about thread concepts
- in general and basic Qt classes to handle threads
- \endlist
-
- \section2 Qt Utilities
- \list
- \li \l{Qt Test Tutorial}{Qt Test} - This tutorial gives a short
- introduction to how to use some of the features of Qt's unit-testing
- framework, Qt Test. It is divided into four chapters.
- \li \l{Getting Started}{qmake} - This tutorial teaches you how to use \c
- qmake. We recommend that you read the \l{qmake Manual}{qmake user guide}
- after completing this tutorial.
- \li \l{Qt Linguist Manual: Developers#Tutorials}{Qt Linguist} - A guided
- tour through the translations process, explaining the tools provided for
- developers, translators and release managers.
- \omit broken links
- \image linguist-examples.png Qt Linguist
- \endomit
- \endlist
-
- \section1 Examples
-
- Qt includes a set of examples that cover nearly every aspect of Qt
- development. They demonstrate usage of various modules and technologies.
-
- The examples include a project file and some include documentation.
- Qt Creator can directly run these examples through the Welcome Page.
-
- The \l{Qt Widget Gallery} also provides overviews of selected Qt
- widgets in each of the styles used on various supported platforms.
-
- Most examples are provided under the terms of the
- \l{New and Modified BSD Licenses}{Modified BSD License}. Some examples
- are however provided under the terms of the
- \l{GNU Lesser General Public License (LGPL)}{GNU LGPL version 2.1}.
-
- \annotatedlist all-examples
-*/
-
-/*!
\group all-examples
\title List of Qt Examples
\brief Alphabetical listing of Qt Examples