Qt5/Documentation/OverviewClassification: Difference between revisions

From KDE Community Wiki
No edit summary
Line 34: Line 34:
|-
|-
|[http://doc-snapshot.qt-project.org/5.0-newdocs/qtdoc/supported-platforms.html Supported Platforms] || <span style="color:red">Fix</span> || Bring up to date regarding which desktop platforms we support, and also write a bit about the embedded and mobile platforms
|[http://doc-snapshot.qt-project.org/5.0-newdocs/qtdoc/supported-platforms.html Supported Platforms] || <span style="color:red">Fix</span> || Bring up to date regarding which desktop platforms we support, and also write a bit about the embedded and mobile platforms
|-
|[http://doc-snapshot.qt-project.org/5.0-newdocs/qtdoc/licensing.html Licensing and Credits] || <span style="color:red">Fix</span> || Write high-level introduction/overview to Qt Licensing
|}
|}



Revision as of 08:34, 20 November 2012

Classification of pages based on the structure defined in Qt5/Documentation/OverviewStructure, along with information about what might need fixing on each of the pages.

How to help out

  1. Pick an entry that has "Fix" in the "Status" column.
  2. Put your name into the Owner field, and save the page
  3. Follow the instructions in the Action column, and fix whatever else needs fixing on the page
  4. Change status to either OK or Fix language if you want a language check on what you've written

Needs action

Title Status Action Owner
How to Report a Bug Fix "FAQs" is a dead link, and "Qt repository" links to Gitorious instead of Gerrit.
Codecs OK Empty list, remove?
Configuring Qt Fix Is this even supported anymore? It doesn't even build
Qt Performance Tuning Fix At least the part about QDirectPainter needs to go; probably best to Kill it

Introduction

As described in Qt5/Documentation/OverviewStructure#Introduction, source at qtdoc/doc/src/index.qdoc, current snapshot: http://doc-snapshot.qt-project.org/5.0-newdocs/qtdoc/index.html

Title Status Action Sub-topic Owner
Introduction to Qt 5 Fix List of API changes don't show up. It's a QDoc issue which is being fixed as part of QTBUG-27695.
What is Qt Fix Flesh out according to existing outline
Supported Platforms Fix Bring up to date regarding which desktop platforms we support, and also write a bit about the embedded and mobile platforms
Licensing and Credits Fix Write high-level introduction/overview to Qt Licensing

Porting from Qt 4

Title Status Action Sub-topic Owner
Porting QML Applications to Qt 5 Fix The page is yet to merged from master to the newdocs branch.
Porting Applications from QtMobility Sensors to Qt Sensors OK -
Porting Guidelines OK -

SDK

As described in Qt5/Documentation/OverviewStructure#.22Application_Development_.28tools_and_Qt_Creator.29.22_Topic_Page, source at qtdoc/doc/src/developmenttools.qdoc, current snapshot: http://doc-snapshot.qt-project.org/5.0-newdocs/qtdoc/topics-app-development.html

Title Status Action Sub-topic Owner
Development Tools Fix Needs polish, get rid of qvfb reference (no longer relevant in Qt 5)
Configuration Options for Qt Fix Not updated to match options in Qt 5
CMake Manual OK

Tools

Using Qt Assistant as a Custom Help Viewer Fix Mentions CD-ROMs like it's state of the art, so it sounds super-old. Talks about Qt 4.4 like it's the latest version. Leena -
Qt Assistant http://doc-snapshot.qt-project.org/5.0/assistant.html Fix Screenshot says "Qt 4.4" and has a HUGE Trolltech-logo :P. Mentions of Qt 4.4.0 and Qt 4.4.1 in examples. Lots of Qt 4.4 screenshots done on Windows XP. Maybe we should update those? Claims Assistant is better than a web browser since it can do full text search, which we plan to implement in the web page as well? Also, Google might have something to cover that stuff. Leena
Creating and Using Components for Qt Designer OK -
QtDesigner Module OK -
Resource Compiler (rcc) OK -
Qt's Tools http://doc-snapshot.qt-project.org/5.0/qttools.html OK Some of these have been moved into the QtTools add-on, I think
User Interface Compiler (uic) OK -
Resource Compiler (rcc) OK -

General

Developing Qt Applications for Mac OS X OK - - -
Cross-Platform and Platform-Specific Development OK -
Exception Safety OK -
General Qt Requirements Fix Update to QPA
Qt for Mac OS X Requirements OK -
Qt for Windows CE Requirements Fix Looks outdated; is CE even supported anymore?
Qt for Windows Requirements OK But rename QML2 to QtQuick2
Qt for X11 Requirements Fix Outdated, doesn't mention xcb

qmlscene

Prototyping with qmlscene OK - - -

Deployment

Deploying Qt Applications Fix Outdated list of modules, and outdated list of platforms? - -
Deploying an Application on Mac OS X Fix Is this up-to-date? The deployment tool mentioned here does not seem to exist. What about Creator?
Deploying Plugins Fix Has several mentions of Qt 4 version numbers as examples.
Deploying an Application on Windows OK OK with some reservations: Does not mention SDK or Qt Creator at all.. Should it?
Deploying an Application on X11 Platforms OK OK with some reservations: Does not mention SDK or Qt Creator at all.. Should it?

Qt Designer

Qt Designer's Buddy Editing Mode OK - - -
Qt Designer's Signals and Slots Editing Mode OK -
Creating Custom Widget Extensions OK -
Creating Custom Widgets for Qt Designer OK -
Creating Main Windows in Qt Designer OK -
Customizing Qt Designer Forms Fix Refers to QWidget include file as <QtGui/QWidget> Leena
Qt Designer's Editing Modes OK -
Using Layouts in Qt Designer Fix Talks about QFormLayout as if it's the new sliced bread Leena
Qt Designer Manual Fix Should be clear about this being a designer for Widget apps specifically and that there are options.
Saving, Previewing and Printing Forms in Qt Designer OK -
A Quick Start to Qt Designer OK -
Editing Resources with Qt Designer OK -
Using Stylesheets with Qt Designer OK -
Qt Designer's Tab Order Editing Mode OK -
Getting to Know Qt Designer Fix Outdated information on how to start application (should probably focus on Qt Creator integration). Contains a reference to old "Qt Software" branding. Leena
Qt Designer's UI File Format OK XML-schema missing, but this will probably be picked up by a qdoc error.
Using a Designer UI File in Your Application OK Some iffy code snippets
Using Containers in Qt Designer OK -
Using Custom Widgets with Qt Designer OK -
Qt Designer's Widget Editing Mode Fix Contains a TODO: "### Screenshot of widget box, again" Leena

Cross-platform development

Supported Platforms Fix See QTBUG-27250. Also mentions Nokia. Consider syncing with Digia's page - -
Platform and Compiler Notes Fix Remove "embedded linux"
Platform Notes - INTEGRITY Fix Says it's community-port based on Qt for Embedded Linux. Should it be killed as well?
Platform and Compiler Notes - Mac OS X Fix Code snippet won't compile because it uses QApplication without including QtWidgets. Also has an empty section labelled "Binary Package".
Platform and Compiler Notes - QNX Fix Says it's community-port based on Qt for Embedded Linux. Should it be killed as well?
Platform and Compiler Notes - VxWorks Fix References Qt embedded.
Platform and Compiler Notes - Windows Fix Refers to compiling Qt 4. Contains the macro "%VERSION%": Is this supposed to be expanded by qdoc?
Platform and Compiler Notes - X11 Fix A lot of this information is outdated
Platform-Specific Documentation Fix outdated

qmake

qmake Advanced Usage OK - - -
qmake Common Projects OK -
Configuring qmake's Environment OK -
qmake Function Reference OK -
qmake Manual OK -
qmake Platform Notes Fix Contains sections about Symbian Leena
Using Precompiled Headers Fix Contains some 4.0 versioning in the code snippets and claims we still support VC6. Leena
qmake Project Files Fix Outdated examples where you have to do "CONFIG += qt thread" to get a multithreaded Qt application. Outdated list of modules. Leena
qmake Reference OK -
Running qmake OK -
qmake Tutorial OK -
Using qmake OK -
qmake Variable Reference Fix Contains information particular to Symbian and Maemo. Layout is all crazy. Module list for QT variable is outdated. Contains information about variables that have been deprecated since Qt 4.2. Leena

sdk

Title Status Action Sub-topic Owner
Getting Started Programming with Qt Fix Called "Getting started with Qt" instead of "Getting started with QtWidgets"
Installation OK Expand with more platforms? Installation
Installing Qt for Mac OS X Fix Should focus on SDK instead of source builds? Installation
Installing Qt for Windows CE Fix Should focus on SDK instead of source builds? Installation
Installing Qt for Windows Fix Should focus on SDK instead of source builds? Installation
Installing Qt for X11 Platforms Fix Should focus on SDK instead of source builds? Installation
Qt Linguist Manual: Text ID Based Translations OK - Linguist
Qt Linguist Manual: Release Manager OK - Linguist
Qt Linguist Manual OK - Linguist
Qt Linguist Manual: Programmers Fix Include information about QML Linguist
Qt Linguist Manual: Translators Fix First section only says "Contents". Placeholder? Linguist
Qt Linguist Manual: TS File Format Fix Missing DTD Linguist
Support for Linux/X11 Fix List of features includes graphics view and QtOpenGL, but not QML. Platforms
Support for Mac OS X Fix List of features includes graphics view and QtOpenGL, but not QML. Platforms
Qt for Mac OS X - Specific Issues Fix Suggests contacting technical support. Should perhaps redirect to mailing lists and forums instead? Also mentions that Q_WS_MAC is no longer defined, but still uses it in a code snippet. Platforms
Using the Meta-Object Compiler (moc) Fix Says that "moc does not expand macros", but I think Lars added a fully functioning preprocessor? Tools



Title Status Action Sub-topic Owner
Debugging QML Applications OK - QML
Deploying QML Applications Fix Claims that QQuickView is QWidget-based and uses QApplication instead of QGuiApplication in examples. QML

Build system

Title Status Action Sub-topic Owner
Creating Shared Libraries OK -

User Interfaces

As described in Qt5/Documentation/OverviewStructure#.22User_Interface.22_Topic_Page, source at qtdoc/doc/src/userinterfaces.qdoc, current snapshot: http://doc-snapshot.qt-project.org/5.0-newdocs/qtdoc/topics-ui.html

General

Title Status Action Sub-topic Owner
User Interfaces Fix Complete the overview page according to the instructions it currently contains -
Standard Accelerator Keys Fix Contains a reference to Q3Accel as the "best practice" for accelerators in Qt... The list of standard accelerators might be useful to some people, though. -
Accessibility Fix Make this less confrontational? -
Animation Framework Fix QEasingCurve needs a description, otherwise it's fine. -
The Animation Framework Fix Mentions "Kinetic" and "Graphics View". Might need some generalization. -
Setting the Application Icon Fix Widget-specific and might (I hope) be out of date, but that needs to be checked. -
Performance Considerations And Suggestions OK - -
Restoring a Window's Geometry Fix Update to QWindow (also, QWidget::saveGeometry is buggy) -
Overview of Qt's Undo Framework OK - -
Scalability OK But maybe mention desktop as well as devices -
Session Management OK -
Books about GUI Design Fix Should mention that the Qt 4-book is mainly relevant for widgets development and other. We'll just have to assume that our charity-agreement with Amazon (our favorite bookstore apparently) is still valid? -
UI Design with Qt OK - -
The Qt GUI Module OK - -
Qt GUI Module Overview OK - -
Desktop Integration OK See QTBUG-25524 -
Getting Started Guides Fix Differentiating between Qt and QML as two different toolkits. Should be "widgets" and "QML"? -

QML and QtQuick

Title Status Action Sub-topic Owner
Important C++ Classes Provided By The Qt QML Module OK - -
Embedding C++ Objects into QML with Context Properties OK - -
Data Type Conversion Between QML and C++ OK - -
Defining QML Types from C++ OK - -
Exposing Attributes of C++ Types to QML OK - -
Interacting with QML Objects from C++ OK - -
Integrating QML and C++ OK - -
Defining Object Types through QML Documents OK - -
Resource Loading and Network Transparency OK - -


Title Status Action Sub-topic Owner
QML Module QtQuick.Window 2.0 OK - -
Qt Quick Module - C++ Classes OK - Reference
Qt Quick Release Notes OK - QML
Qt Quick Licensing Information OK This topic is missing from the newdocs snapshot, so the link it pointing to the doc-snapshot version of it. Licensing


Positioning with Anchors OK - - -
Item Layouts OK - -
Right-to-left User Interfaces OK - -
Important Concepts In Qt Quick - Positioning OK - -
QML Types Provided by Qt Quick OK - -
Quick Start Guide - QML Basics OK - -
Quick Start Guide - QML Essentials OK - -
Animation and Transitions in Qt Quick OK - -
Using Qt Quick Behaviors with States OK - -
Qt Quick States OK - -
Important Concepts in Qt Quick - States, Transitions and Animations OK - -
Usecase - Animations In QML OK - -
Use Case - Integrating JavaScript in QML OK Last link in document doesn't work -
Use Case - Layouts In QML OK - -
Use Case - Style And Theme Support OK - -
Use Case - Displaying Text In QML OK - -
Use Case - Responding To User Input in QML OK - -
Use Case - Visual Elements In QML OK - -
Concepts - Visual Coordinates in Qt Quick OK - -
Important Concepts In Qt Quick - The Visual Canvas OK - -
Concepts - Visual Parent in Qt Quick OK - -
Important Concepts In Qt Quick - Visual Types OK - -
Title Status Action Sub-topic Owner
C++ Extension Points Provided By Qt Quick OK - QML
Composing User Interfaces with QML Fix Missing snippets and images QML
Creating C++ Plugins for QML OK - QML
Defining JavaScript Resources In QML OK - QML
Defining Reusable Components Fix Contains lots of ######## comments QML
Dynamic QML Object Creation from JavaScript OK - QML
Generating Items with Repeaters OK - QML
Identified Modules OK - QML
Important Concepts In Qt Quick - Convenience Types OK - QML
Important Concepts In Qt Quick - Graphical Effects OK - QML
Important Concepts In Qt Quick - User Input OK - QML
Importing JavaScript Resources in QML OK - QML
Importing QML Document Directories OK - QML
Import Statements OK - QML
Integrating QML and JavaScript OK - QML
Internationalization and Localization with Qt Quick OK - QML
Introduction to Qt Quick Fix Talks about QtDeclarative, Symbian and Maemo and has screenshot with Symbian in it QML
JavaScript Expressions in QML Documents OK - QML
[http://doc-snapshot.qt-project.org/5.0-newdocs/qtquick/qtqml-javascript-hostenvironment.html JavaScript Host Environment OK - QML
Keyboard Focus in Qt Quick OK A bit too much QWidget QML
Legacy Modules OK - QML
List of JavaScript Objects and Functions OK - QML
Module Definition qmldir Files OK - QML
Mouse Events OK - QML
Particle System Performance Guide OK - QML
Property Binding OK Fix the ### TODO QML
QML Application Developer Resources OK But update list of essential modules (Qt3D is no longer essential) QML
QML Application Development Tools Fix Talks about Maemo and has screenshot with Symbian in it QML
QML Basic Types OK - QML
QML Best Practices Guides OK - QML
QML Best Practices Fix Maybe change QtQuick 1.0 -> QtQuick 2.0 QML
QML Best Practices Fix This document contains empty sections QML
QML Coding Conventions Fix Why have two coding conventions documents, this and qml-best-practices-coding.html? QML
QML Concepts and Syntax Fix Missing snippets and images QML
QML Documents OK - QML
QML Features OK - QML
QML Global Object OK - QML
QML Modules OK - QML
QML Object Attributes OK - QML
QML Object Types OK - QML
QML Syntax Basics OK - QML
QML Types Provided By The QtQml Module OK - QML
Qt QML OK - QML
Qt QML Module - C++ Classes OK - QML
Qt QML Release Notes OK - QML
Qt Quick Glossary Of Terms OK - QML
Qt Quick OK - QML
Qt Quick Text Input Handling and Validators OK Remove QRegExp reference? QRegularExpression is the new class in 5.0. QML
Scope and Naming Resolution OK - QML
Signal and Handler Event System OK - QML
Sprite Animations Fix Broken HTML for links and some broken qdoc syntax at the top. QML
Structure of a QML Document OK - QML
The QML Type System OK - QML
User Interaction with QML Fix Missing snippets QML
[qml-behaviors-and-states.html Using QML Behaviors with States] OK - QML
Using the Qt Quick Particle System OK - QML
Introduction
Getting Started Programming with QML Fix Several anachronisms, old code samples, etc. See QTBUG-25621 - -

Widgets

Title Status Action Sub-topic Owner
Abstract Widget Classes Fix Page is empty.
Advanced Widgets Fix Just a list of widgets. Seems incomplete.
Widget Appearance and Style OK -
Window and Dialog Widgets Fix Very widget-specific and overloads the term "Window" which now has a different meaning.
Basic Widgets Fix -
Organizers OK -
QtOpenGL Module Fix This module is deprecated. The Motif reference might not be relevant any more
Dialog Windows OK -
Cleanlooks Style Widget Gallery Fix Kill? We have to find out if CleanLooks is part of Qt 5 or not.
GTK Style Widget Gallery Fix Doesn't the GTK style use the system theme? Should be clarified if that's the case.
Qt Widget Gallery Fix Mentions "Qt 4" as current version.
Macintosh Style Widget Gallery OK Has a table-breaking image, but mostly fine.
Plastique Style Widget Gallery Fix Kill? We have to find out if Plastique is part of Qt 5 or not.
Windows Style Widget Gallery OK -
Windows Vista Style Widget Gallery OK -
Windows XP Style Widget Gallery OK -
Layout Classes OK -
QtWidgets Module OK - - -
Styling OK -
Graphics View Classes OK - Graphicsview
Graphics View Framework OK - Graphicsview
Standard Dialogs OK -
Styles and Style Aware Widgets OK -
Customizing Qt Widgets Using Style Sheets OK -
Qt Designer Integration OK -
Qt Style Sheets OK -
Qt Style Sheets Reference OK -
The Style Sheet Syntax OK -
Application Main Window OK - Widgets
Layout Management OK - Widgets
Main Window and Related Classes OK - Widgets
Widgets and Layouts OK Mention QtQuick Widgets

User input

Title Status Action Sub-topic Owner
Keyboard Focus Fix Widget-specific. Should contain info about keyboard-focus in QML.
Gestures Programming Fix Focuses on QWidget and Graphics View. Should probably focus on QWidget and QML?

Drag and drop

Drag and Drop Fix Needs to describe QtQuick/QWindow (QWidget part is OK) - -

Rich text

Title Status Action Sub-topic Owner
Advanced Rich Text Processing OK -
Common Rich Text Editing Tasks OK - - -
The QTextCursor Interface OK -
Rich Text Processing OK -
Supported HTML Subset OK -
Document Layouts OK -
Rich Text Processing APIs OK -
Rich Text Document Structure OK -

i18n

Title Status Action Sub-topic Owner
Internationalization with Qt Fix Very widget-centric, outdated Norwegian ortography in example, wrongfully identifies Scandinavian languages as "exotic" i18n
Qt Classes for Internationalization OK - i18n
Translation Rules for Plurals OK - i18n
Writing Source Code for Translation Fix Should also mention how to do this for QML i18n

Model/View

Title Status Action Sub-topic Owner
Important Concepts In Qt Quick - Data - Models, Views and Data Storage OK - Model/View
Models and Views in Qt Quick OK - Model/View
Model/View Classes OK - Model/View
Model/View Programming Fix Should cover QML usage, mentions Qt 4 as if it's new, mentions porting from Qt 3. Model/View
Model/View Tutorial Fix Very focused on widgets. It should be clear that widgets and QML are both first class citizens when it comes to presenting the contents of a model. Also lists a few Qt 4 books, so it should be made clear there that they describe concepts which are still relevant, but that they don't contain information about the new additions in Qt 5 (or, probably, the laters versions of Qt 4). Model/View
Using C++ Models with QtQuick Views OK - Model/View

Core fundamentals

As described in Qt5/Documentation/OverviewStructure#.22Core_fundamentals.22_Topic_Page, source at qtdoc/doc/src/core.qdoc, current snapshot: http://doc-snapshot.qt-project.org/5.0-newdocs/qtdoc/topics-core.html

General

Title Status Action Sub-topic Owner
Core Fundamentals Fix Write an overview, make sure all the links work
Non-GUI Classes OK
Unicode in Qt OK
Calling Qt Functions From Unix Signal Handlers OK -
Implementing Atomic Operations OK -
Creating Custom Qt Types OK Should probably mention QtQuick
Debugging Techniques OK -
http://doc-snapshot.qt-project.org/5.0-newdocs/qtcore/qtalgorithms.html lt;QtAlgorithms> - Generic Algorithms] OK -
QtCore Module OK -
<QtEndian> - Endian Conversion Functions OK -
Using qt.conf OK -

Event system

Title Status Action Sub-topic Owner
The Event System OK -
Event Classes OK -


IPC

Title Status Action Sub-topic Owner
D-Bus OK - IPC
Inter-Process Communication in Qt Fix Remove QCop IPC
Declaring Signals in D-Bus Adaptors OK -
Declaring Slots in D-Bus Adaptors OK -
QDBus Namespace OK -
The QtDBus Type System OK -
D-Bus Viewer Fix The link is BROKEN. This topic is under qttools which is yet to be modularized. The link will be fixed once that is done and qdocconf files are added to the repo.
QtDBus XML compiler (qdbusxml2cpp) OK -

Plugins

Title Status Action Sub-topic Owner
How to Create Qt Plugins OK -
Qt Module QML Plugins OK -

Object model

Title Status Action Sub-topic Owner
Object Model OK -
Object Trees & Ownership Fix QWidget is not "the base class of everything that appears on the screen" Object ownership model
The Meta-Object System Fix Should mention that the meta object can also be used to make functions and properties available from QML. Meta object system
The Property System OK -
Title Status Action Sub-topic Owner
Signals & Slots OK A bit too much focus on QWidget?
Why Doesn't Qt Use Templates for Signals and Slots? OK -
Timers OK Change to be less QWidget-focused

QPA

Title Status Action Sub-topic Owner
kmap2qmap Fix Rewrite to mention QPA instead of Qt/Embedded

Platform specific

Mac
Title Status Action Sub-topic Owner
Qt is Mac OS X Native OK -
WinCE
Title Status Action Sub-topic Owner
Qt for Windows CE OK What's the status for CE?
Windows CE - Using shadow builds Fix WinCE?
Windows CE - Introduction to using Qt Fix is CE still supported? WinCE
Windows CE - Working with Custom SDKs Fix is CE still supported? WinCE
Qt for Windows CE and OpenGL ES Fix Outdated: Only mentions QGLWidget; is CE still supported? WinCE
Windows CE - Signing Fix Is CE still supported? WinCE

Threads and Concurrency

Title Status Action Sub-topic Owner
Threading Basics Fix Update archaic technique of reimplementing QThread::run() (See QTBUG-23635). Change to be less QWidget-focused
Threading Classes OK -
Thread Support in Qt OK Link back to Threading Basics in Recommended Reading
Thread-Support in Qt Modules OK -
Threads and QObjects Fix Update archaic technique of reimplementing QThread::run() (See QTBUG-23635). Change to be less QWidget-focused
Concurrent Programming OK -
Reentrancy and Thread-Safety OK -
Starting Threads with QThread Fix Update archaic technique of reimplementing QThread::run() (See QTBUG-23635). Change QApplication to QGuiApplication
Synchronizing Threads OK -
QtConcurrent Module Fix No links

Container classes

Title Status Action Sub-topic Owner
Container Classes OK -
Classes for String Data OK -
Implicitly Shared Classes OK -
Implicit Sharing Fix List of classes needs to be updated Object ownership model

State Machine

Title Status Action Sub-topic Owner
The State Machine Framework OK -
State Machine Classes OK -

Data Structure and Storage

As described in Qt5/Documentation/OverviewStructure#.22Data_Structure_and_Storage.22_Topic_Page, source at qtdoc/doc/src/datastorage.qdoc, current snapshot: http://doc-snapshot.qt-project.org/5.0-newdocs/qtdoc/topics-data-storage.html

Title Status Action Sub-topic Owner
Data Structures and Storage Fix Complete the "### Todo" style sections
Database Classes OK -
Serializing Qt Data Types OK -
JSON Support in Qt OK - Serialization
Input/Output and Networking OK - IO
Qt Quick Local Storage QML Types OK -
Qt Quick XmlListModel QML Types OK -

Resources

The Qt Resource System OK Remove reference to obsoleted Qt 3 functionality - -

SQL

Title Status Action Sub-topic Owner
SQL in Qt OK -
Qt SQL OK -
Qt SQL Module - C++ Classes OK -

Databases

Title Status Action Sub-topic Owner
Connecting to Databases OK -
SQL Database Drivers OK Correct qmake usage. See QTBUG-27325, QTBUG-25600
Creating Data-Aware Forms OK -
Using the SQL Model Classes OK -
Presenting Data in a Table View OK -
SQL Programming OK -
Executing SQL Statements OK -
Data Types for Qt-supported Database Systems OK -

XML

Title Status Action Sub-topic Owner
XQuery Fix Missing snippets XML
A Short Path to XQuery Fix Missing snippets XML

Multimedia

As described in Qt5/Documentation/OverviewStructure#.22Multimedia.22_Topic_Page, source at qtdoc/doc/src/multimedia.qdoc, current snapshot: http://doc-snapshot.qt-project.org/5.0-newdocs/qtdoc/topics-multimedia.html

Title Status Action Sub-topic Owner
Multimedia Fix Complete the overview page by implementing all the "### TODO"-style comments
Positional Audio OK Strange orthography, so maybe it should be brushed up, but content is fine.
Audio Overview OK -
Camera Overview Fix Contains a TBD "note-to-self"-type-thing
Changes in Qt Multimedia OK -
Multimedia Backend Development OK -
Qt Multimedia Overview OK -
Qt Multimedia - QML Types OK -
Video Overview Fix Missing snippets
Qt Multimedia QML API OK - QML
QtMultimedia Namespace OK -
Qt Multimedia OK -
MetaData Namespace OK -
Qt Multimedia - C++ Classes OK -
QAudio Namespace OK -
Radio Overview OK -

Networking and Connectivity

As described in Qt5/Documentation/OverviewStructure#.22Connectivity_and_Networking.22_Topic_Page, source at qtdoc/doc/src/connectivity.qdoc, current snapshot: http://doc-snapshot.qt-project.org/5.0-newdocs/qtdoc/topics-network-connectivity.html

Title Status Action Sub-topic Owner
Networking and Connectivity Fix Complete the overview page by implementing all the "### TODO"-style comments
Bearer Management OK -
Qt Bluetooth C++ API Fix The link is BROKEN The page is missing from the newdocs build.
Qt Bluetooth QML API Fix The link is BROKEN The page is missing from the newdocs build.
Network Programming API OK -
Qt Bluetooth OK -
Qt Bluetooth Overview OK -
QtDBus module OK -
Qt Network OK -
Qt Network - C++ Classes OK -
Network Programming with Qt OK -
Secure Sockets Layer (SSL) Classes OK Says "classes below", but there is no class list (this was also the fact in 4.8)
Using QtDBus Adaptors OK -
QBluetooth Namespace OK -

Graphics

As described in Qt5/Documentation/OverviewStructure#.22Graphics.22_Topic_Page, source at qtdoc/doc/src/graphics.qdoc, current snapshot: http://doc-snapshot.qt-project.org/5.0-newdocs/qtdoc/topics-graphics.html

Title Status Action Sub-topic Owner
Graphics Fix Complete the overview page by implementing all the "### TODO"-style comments
Coordinate System OK -
Graphical Effects Fix This page is missing in the newdocs build Graphicsview
Qt Quick Particles QML Types OK -
Qt Graphical Effects Fix This page is missing in the newdocs build
Qt Graphics and Printing OK -
QtPrintSupport Module OK -
Printing with Qt OK -

QPainter

Title Status Action Sub-topic Owner
Painting Classes OK -
Paint Devices and Backends Fix Remove the references to QGL-classes (replace with QOpenGLPaintDevice)
Drawing and Filling OK -
Paint System OK -
Reading and Writing Image Files OK -
<qdrawutil.h> - Drawing Utility Functions OK -
QGL Namespace OK Isn't QtOpenGL deprecated?
Qt Quick Scene Graph OK -

Reference

As described in Qt5/Documentation/OverviewStructure#References, source at qtdoc/doc/src/index.qdoc

Title Status Action Sub-topic Owner
Best Practice Guides Fix Needs links to QML articles
Class and Function Documentation Fix Qt 3D seems overrepresented compared to other modules
Annotated Class List Fix QEasingCurve needs a description
All Overviews and HOWTOs Fix If this list is not generated, it will need fixing
Programming with Qt Fix Add QtQuick/QWindow-based topics
QService Namespace OK -
QSql Namespace OK -
QSsl Namespace OK -
Groups Of Related Classes OK - Reference
Inheritance Hierarchy OK - Reference
Known Issues OK -
All Modules OK - Reference
All Namespaces Fix Add QtQuick-related namespaces Reference
<QtGlobal> - Global Qt Declarations OK -
Qt Namespace OK -
<QtPlugin> - Defining Plugins OK -
Qt and Key Technologies OK -
Tutorials Fix Outdated

Legal

Title Status Action Sub-topic Owner
Qt Commercial Edition Fix Contains some contact information for Digia and links to *GPL licenses, but otherwise outdated.
Thanks! OK
Third-Party Licenses Used in Qt OK -
CatharonLicense.txt OK -
Big5-HKSCS Text Codec OK -
Big5 Text Codec OK -
EUC-JP Text Codec OK -
EUC-KR Text Codec OK -
GBK Text Codec OK -
Shift-JIS Text Codec OK -
ISO 2022-JP (JIS) Text Codec OK -
TSCII Text Codec OK -
Poly2Tri Polygon Triangulation Library OK -
Contributions to the Following Cocoa platform plugin files: qcocoaapplication.h, qcocoaapplication.mm, qcocoaapplicationdelegate.h, qcocoaapplicationdelegate.mm, qcocoaeventdispatcher.h, qcocoaeventdispatcher.mm, qmacdefines_mac.h OK -
The qtmain Library OK -
Notes about PDF Licensing OK -
Trademarks Fix Nokia -> Digia
GNU General Public License (GPL) Fix "Copyright Nokia" Licensing
GNU Lesser General Public License (LGPL) Fix s/Nokia/Digia Licensing
Other Licenses Used in Qt OK But remove link to killed page Licensing
Open Source Versions of Qt Fix s/Nokia/Digia/ Licensing
Implementation of the Recursive Shadow Casting Algorithm in Qt Designer OK -
Qt Editions Fix Fix links

Scripting

As described in Qt5/Documentation/OverviewStructure#.22Scripting.22_Topic_Page, source at qtdoc/doc/src/scripting.qdoc, current snapshot: http://doc-snapshot.qt-project.org/5.0-newdocs/qtdoc/topics-scripting.html

Title Status Action Sub-topic Owner
Scriping Fix Complete the overview according to the suggested section outline
Making Applications Scriptable OK -
ECMAScript Reference OK -

QtScript

Title Status Action Sub-topic Owner
Qt Script Debugger Manual Fix QtScript goes away?
Creating QtScript Extensions Fix QtScript goes away?
QtScript Module Fix QtScript goes away?
QtScriptTools Module Fix QtScript goes away?
Scripting Classes and Overviews Fix QtScript goes away?
Making Applications Scriptable Fix QtScript goes away?

Testing

Source at qtdoc/doc/src/testing.qdoc, current snapshot: http://doc-snapshot.qt-project.org/5.0-newdocs/qtdoc/testing-and-debugging.html

Title Status Action Sub-topic Owner
Testing and debugging Fix Complete the overview page by implementing all the "### TODO"-style comments
QTest Namespace Fix Missing snippets
QTestLib Manual Fix Get rid of "provided by Nokia" ? Does cetest still work for remote execution of tests on Windows CE?
Chapter 1: Writing a Unit Test Fix Missing snippets
Chapter 2: Data Driven Testing Fix Missing snippets
Chapter 3: Simulating GUI Events Fix Missing snippets
Chapter 4: Replaying GUI Events Fix Missing snippets
Chapter 5: Writing a Benchmark Fix Missing snippets, broken link
QTestLib Tutorial OK -
QtTest Module OK -

Qt Quick Test

Title Status Action Sub-topic Owner
QtQuickTest Reference Documentation OK - QML

Add-ons

The topics listed in this section take lower priority for the Qt 5.0 release, as most of these modules are not part of the release package. Documentation source can be found at qtdoc/doc/src/addons.qdoc, current snapshot: http://doc-snapshot.qt-project.org/5.0-newdocs/qtdoc/addons.html

General

Title Status Action Sub-topic Owner
Addons Fix Complete the addons overview page by implementing all the "### TODO"-style comments on the page

QtXML (deprecated)

Title Status Action Sub-topic Owner
An Introduction to Namespaces OK - XML
Working with the DOM Tree OK - XML
XML Processing OK - XML
The SAX interface OK - XML
XML Streaming Fix Missing snippets XML
XML Classes OK - XML
QtXml Module OK Is this really OK? The module is deprecated and replaced by APIs in QtCore. XML

QtXMLPatterns

Title Status Action Sub-topic Owner
Qt XML Patterns Module Fix Add the missing module page.

QtSVG

Title Status Action Sub-topic Owner
QtSvg Module fix Add the missing module page.

Sensors

Title Status Action Sub-topic Owner
QtSensorGestures C++ API OK -
Qt Sensors C++ API OK -
Porting Applications from QtMobility Sensors to Qt Sensors OK -
QtSensorGestures Emulator OK -
QtSensorGestures Plugins Fix Illustrations look like Nokia form factor. Is that ok? Sensors
Qt Sensors Backend OK - Sensors
Creating a sensor plugin OK - Sensors
Compatibility Map OK - Sensors
Determining the default sensor for a type Fix Nokia-specific (talks about a .conf file in /etc/xdg/Nokia). Sensors
Dynamic Sensor Backend Registration OK - Sensors
Generic Backend OK - Sensors
Qt Sensors OK - Sensors

QtTools

Title Status Action Sub-topic Owner
QtUiTools Module OK -

QtVersit

Title Status Action Sub-topic Owner
Qt Versit OK -
QtVersit Module OK -
Supported vCard Features OK -
Qt Versit C++ API Fix This topic is missing in the newdocs build.
Qt Versit Overview OK - Versit
Qt Versit Plugins OK - Versit
Supported iCalendar Features OK - Versit

Qt Publish and Subscribe

Title Status Action Sub-topic Owner
QValueSpace Namespace OK -
Qt Publish Subscribe Module OK -
Publish and Subscribe QML Plugin OK -