Qt5/Documentation/RenewalProjectOverview: Difference between revisions
m (→The result) |
|||
| Line 566: | Line 566: | ||
|} | |} | ||
====OK pages with actions==== | |||
{| | |||
|- | |||
! Title !! Link !! Status !! Action | | |||
|- | |||
| Positional Audio || http://doc-snapshot.qt-project.org/5.0/audioengineoverview.html || X || Strange orthography, so maybe it should be brushed up, but content is fine. | |||
|- | |||
| Creating Custom Qt Types || http://doc-snapshot.qt-project.org/5.0/custom-types.html || X || Should probably mention QtQuick | |||
|- | |||
| Chapter 2: Connecting to C++ Methods and Signals || http://doc-snapshot.qt-project.org/5.0/declarative-tutorials-extending-chapter2-methods.html || X || Contains some iffy code snippets | |||
|- | |||
| Chapter 3: Adding Property Bindings || http://doc-snapshot.qt-project.org/5.0/declarative-tutorials-extending-chapter3-bindings.html || X || Contains some iffy code snippets | |||
|- | |||
| Chapter 4: Using Custom Property Types || http://doc-snapshot.qt-project.org/5.0/declarative-tutorials-extending-chapter4-custompropertytypes.html || X || Contains some iffy code snippets | |||
|- | |||
| Chapter 5: Using List Property Types || http://doc-snapshot.qt-project.org/5.0/declarative-tutorials-extending-chapter5-listproperties.html || X || Contains some iffy code snippets | |||
|- | |||
| QML Advanced Tutorial 1 - Creating the Game Canvas and Blocks || http://doc-snapshot.qt-project.org/5.0/declarative-tutorials-samegame-samegame1.html || X || Contains some iffy code snippets | |||
|- | |||
| QML Advanced Tutorial 2 - Populating the Game Canvas || http://doc-snapshot.qt-project.org/5.0/declarative-tutorials-samegame-samegame2.html || X || Contains some iffy code snippets | |||
|- | |||
| QML Advanced Tutorial 3 - Implementing the Game Logic || http://doc-snapshot.qt-project.org/5.0/declarative-tutorials-samegame-samegame3.html || X || Contains some iffy code snippets | |||
|- | |||
| QML Advanced Tutorial 4 - Finishing Touches || http://doc-snapshot.qt-project.org/5.0/declarative-tutorials-samegame-samegame4.html || X || Contains some iffy code snippets | |||
|- | |||
| Deploying an Application on Windows || http://doc-snapshot.qt-project.org/5.0/deployment-windows.html || X || X with some reservations: Does not mention SDK or Qt Creator at all.. Should it? | |||
|- | |||
| Deploying an Application on X11 Platforms || http://doc-snapshot.qt-project.org/5.0/deployment-x11.html || X || X with some reservations: Does not mention SDK or Qt Creator at all.. Should it? | |||
|- | |||
| Qt Designer's UI File Format || http://doc-snapshot.qt-project.org/5.0/designer-ui-file-format.html || X || XML-schema missing, but this will probably be picked up by a qdoc error. | |||
|- | |||
| Using a Designer UI File in Your Application || http://doc-snapshot.qt-project.org/5.0/designer-using-a-ui-file.html || X || Some iffy code snippets | |||
|- | |||
| Using Custom Widgets with Qt Designer || http://doc-snapshot.qt-project.org/5.0/designer-using-custom-widgets.html || X || | |||
|- | |||
| Desktop Integration || http://doc-snapshot.qt-project.org/5.0/desktop-integration.html || X || See [https://bugreports.qt-project.org/browse/QTBUG-25524 QTBUG-25524] | |||
|- | |||
| Macintosh Style Widget Gallery || http://doc-snapshot.qt-project.org/5.0/gallery-macintosh.html || X || Has a table-breaking image, but mostly fine. | |||
|- | |||
| Installation || http://doc-snapshot.qt-project.org/5.0/installation.html || X || Expand with more platforms? | |||
|- | |||
| Other Licenses Used in Qt || http://doc-snapshot.qt-project.org/5.0/licenses.html || X || But remove link to killed page | |||
|- | |||
| Notifications || http://doc-snapshot.qt-project.org/5.0/notifications.html || X || Maybe add JSON DB to the title | |||
|- | |||
| Object Indexes || http://doc-snapshot.qt-project.org/5.0/object-indexes.html || X || Maybe add JSON DB to the title | |||
|- | |||
| qlalr - References to External Information || http://doc-snapshot.qt-project.org/5.0/qlalr-external-references.html || X || Missing actually, but that seems to have been the case in 4.x as well | |||
|- | |||
| qlalr - Writing Grammars || http://doc-snapshot.qt-project.org/5.0/qlalr-files.html || X || Missing actually, but that seems to have been the case in 4.x as well | |||
|- | |||
| qlalr - Generating Code from Grammar Specifications || http://doc-snapshot.qt-project.org/5.0/qlalr-generating.html || X || Missing actually, but that seems to have been the case in 4.x as well | |||
|- | |||
| qlalr - qlalr Grammar Specification || http://doc-snapshot.qt-project.org/5.0/qlalr-grammar-specification.html || X || Missing actually, but that seems to have been the case in 4.x as well | |||
|- | |||
| qlalr - Handling Conflicts || http://doc-snapshot.qt-project.org/5.0/qlalr-handling-conflicts.html || X || Missing actually, but that seems to have been the case in 4.x as well | |||
|- | |||
| qlalr - Error Handling and Recovery || http://doc-snapshot.qt-project.org/5.0/qlalr-handling-errors.html || X || Missing actually, but that seems to have been the case in 4.x as well | |||
|- | |||
| qlalr || http://doc-snapshot.qt-project.org/5.0/qlalr.html || X || Missing actually, but that seems to have been the case in 4.x as well | |||
|- | |||
| QML Basic Elements || http://doc-snapshot.qt-project.org/5.0/qmlbasicelements.html || X || Missing but presumably part of QML 1 | |||
|- | |||
| QML Signal and Handler Event System || http://doc-snapshot.qt-project.org/5.0/qmlevents.html || X || Missing but presumably part of QML 1 | |||
|- | |||
| Using QML elements || http://doc-snapshot.qt-project.org/5.0/qmlinuse.html || X || Missing but presumably part of QML 1 | |||
|- | |||
| Importing Reusable Components || http://doc-snapshot.qt-project.org/5.0/qmlreusablecomponents.html || X || Missing but presumably part of QML 1 | |||
|- | |||
| Qt Declarative UI Runtime || http://doc-snapshot.qt-project.org/5.0/qmlruntime.html || X || Missing but presumably part of QML 1 | |||
|- | |||
| QML Syntax || http://doc-snapshot.qt-project.org/5.0/qmlsyntax.html || X || Missing but presumably part of QML 1 | |||
|- | |||
| QML Viewer || http://doc-snapshot.qt-project.org/5.0/qmlviewer.html || X || Missing but presumably part of QML 1 | |||
|- | |||
| QtWebKit QML Module || http://doc-snapshot.qt-project.org/5.0/qmlwebkit.html || X || Missing but presumably part of QML 1 | |||
|- | |||
| Using QML Bindings in C++ Applications || http://doc-snapshot.qt-project.org/5.0/qtbinding.html || X || Missing but probably QML 1 | |||
|- | |||
| Property Binding || http://doc-snapshot.qt-project.org/5.0/qtqml-syntax-propertybinding.html || X || <span style="color:red">Fix</span> the <span style="color:red">### TODO</span> | |||
|- | |||
| QML Application Developer Resources || http://doc-snapshot.qt-project.org/5.0/qtquick-applicationdevelopers.html || X || But update list of essential modules (Qt3D is no longer essential) | |||
|- | |||
| Keyboard Focus in Qt Quick || http://doc-snapshot.qt-project.org/5.0/qtquick-input-focus.html || X || A bit too much QWidget | |||
|- | |||
| Qt Quick Text Input Handling and Validators || http://doc-snapshot.qt-project.org/5.0/qtquick-input-textinput.html || X || Remove QRegExp reference? QRegularExpression is the new class in 5.0. | |||
|- | |||
| Use Case - Integrating JavaScript in QML || http://doc-snapshot.qt-project.org/5.0/qtquick-usecase-integratingjs.html || X || Last link in document doesn't work | |||
|- | |||
| Qt for Windows Requirements || http://doc-snapshot.qt-project.org/5.0/requirements-win.html || X || But rename QML2 to QtQuick2 | |||
|- | |||
| The Qt Resource System || http://doc-snapshot.qt-project.org/5.0/resources.html || X || Remove reference to obsoleted Qt 3 functionality | |||
|- | |||
| Scalability || http://doc-snapshot.qt-project.org/5.0/scalability.html || X || But maybe mention desktop as well as devices | |||
|- | |||
| Signals & Slots || http://doc-snapshot.qt-project.org/5.0/signalsandslots.html || X || A bit too much focus on QWidget? | |||
|- | |||
| SQL Database Drivers || http://doc-snapshot.qt-project.org/5.0/sql-driver.html || X || Correct qmake usage. See [https://bugreports.qt-project.org/browse/QTBUG-27325 QTBUG-27325], [https://bugreports.qt-project.org/browse/QTBUG-25600 QTBUG-25600] | |||
|- | |||
| Secure Sockets Layer (SSL) Classes || http://doc-snapshot.qt-project.org/5.0/ssl.html || X || Says "classes below", but there is no class list (this was also the fact in 4.8) | |||
|- | |||
| Threading Basics || http://doc-snapshot.qt-project.org/5.0/thread-basics.html || X || Change to be less QWidget-focused | |||
|- | |||
| Thread Support in Qt || http://doc-snapshot.qt-project.org/5.0/threads.html || X || Link back to Threading Basics in Recommended Reading | |||
|- | |||
| Threads and QObjects || http://doc-snapshot.qt-project.org/5.0/threads-qobject.html || X || Change to be less QWidget-focused | |||
|- | |||
| Starting Threads with QThread || http://doc-snapshot.qt-project.org/5.0/threads-starting.html || X || Change QApplication to QGuiApplication | |||
|- | |||
| Timers || http://doc-snapshot.qt-project.org/5.0/timers.html || X || Change to be less QWidget-focused | |||
|- | |||
| Widgets and Layouts || http://doc-snapshot.qt-project.org/5.0/widgets-and-layouts.html || X || Mention QtQuick | |||
|- | |||
| Widgets Tutorial || http://doc-snapshot.qt-project.org/5.0/widgets-tutorial.html || X || Mention QtQuick | |||
|} | |||
===For reference=== | |||
(Maybe move to a separate page?) | |||
====The whole list==== | ====The whole list==== | ||
Revision as of 10:33, 26 September 2012
Triaging of existing documentation pages
The following is a list of existing overview documentation in Qt. We don't know how good it is, but we need to find out. We need to quickly read through all the following pages and place them in three categories:
- Kill - The content is hopelessly wrong or outdated, and not worth the effort. Just delete the whole page and forget it ever existed. Note that this refers to the content of the page as it is now: if the page stinks, but it would nice to have a good page with the same title, it's still a Kill. (Edge case: completely blank pages are also Kills.)
- Fix - This page has serious problems, but there is some content that is worth salvaging, maybe as part of a different page.
- OK - This page is useful as it is now, may need some fixing up, but not major restructuring.
We are not triaging the class reference documentation (there is a separate task for that) or the example documentation (there is a separate example project).
The process
- Pick a page that has "X" in the "Triage" column.
- Put your name in place of the X, and save the page
- Read through the page, and determine the quality of the text/images it contains according to the scale above
- If Kill, put
'''Kill'''
in the Triage field, and go to step 1 - If Fix, put
<span style="color:red">Fix</span>
in the Triage field, write what needs to be done in the Action field, and go to step 1 - If OK, put
<span style="color:green">OK</span>
in the Triage field, (optionally write something in the Action field) and go to step 1
The result
The missing pages
The Kill List
The Fix List
| Title | Link | Status | |
|---|---|---|---|
| Standard Accelerator Keys | http://doc-snapshot.qt-project.org/5.0/accelerators.html | X | 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 | http://doc-snapshot.qt-project.org/5.0/accessible.html | X | Make this less confrontational? |
| The dumpcpp Tool (ActiveQt) | http://doc-snapshot.qt-project.org/5.0/activeqt-dumpcpp.html | X | Is ActiveQt removed? |
| The dumpdoc Tool (ActiveQt) | http://doc-snapshot.qt-project.org/5.0/activeqt-dumpdoc.html | X | Is ActiveQt removed? |
| IDC - The Interface Description Compiler (ActiveQt) | http://doc-snapshot.qt-project.org/5.0/activeqt-idc.html | X | Is ActiveQt removed? |
| testcon - An ActiveX Test Container (ActiveQt) | http://doc-snapshot.qt-project.org/5.0/activeqt-testcon.html | X | Is ActiveQt removed? |
| Advanced Widgets | http://doc-snapshot.qt-project.org/5.0/advanced.html | X | Just a list of widgets. Seems incomplete. |
| Animation Framework | http://doc-snapshot.qt-project.org/5.0/animation.html | X | QEasingCurve needs a description, otherwise it's fine. |
| The Animation Framework | http://doc-snapshot.qt-project.org/5.0/animation-overview.html | X | Mentions "Kinetic" and "Graphics View". Might need some generalization. |
| Annotated Class List | http://doc-snapshot.qt-project.org/5.0/annotated.html | X | QEasingCurve needs a description |
| Setting the Application Icon | http://doc-snapshot.qt-project.org/5.0/appicon.html | X | Widget-specific and might (I hope) be out of date, but that needs to be checked. |
| Window and Dialog Widgets | http://doc-snapshot.qt-project.org/5.0/application-windows.html | X | Very widget-specific and overloads the term "Window" which now has a different meaning. |
| Using Qt Assistant as a Custom Help Viewer | http://doc-snapshot.qt-project.org/5.0/assistant-custom-help-viewer.html | X | 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. |
| Qt Assistant | http://doc-snapshot.qt-project.org/5.0/assistant.html | X | 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. |
| Best Practice Guides | http://doc-snapshot.qt-project.org/5.0/best-practices.html | X | Needs links to QML articles |
| Qt Bluetooth QML API | http://doc-snapshot.qt-project.org/5.0/bluetooth-qml.html | X | Missing QML types (empty list) |
| How to Report a Bug | http://doc-snapshot.qt-project.org/5.0/bughowto.html | X | "FAQs" is a dead link, and "Qt repository" links to Gitorious instead of Gerrit. |
| Camera Overview | http://doc-snapshot.qt-project.org/5.0/cameraoverview.html | X | Contains a TBD "note-to-self"-type-thing |
| Class and Function Documentation | http://doc-snapshot.qt-project.org/5.0/classlists.html | X | Qt 3D seems overrepresented compared to other modules |
| Qt Commercial Edition | http://doc-snapshot.qt-project.org/5.0/commercialedition.html | X | Contains some contact information for Digia and links to *GPL licenses, but otherwise outdated. |
| Configuration Options for Qt | http://doc-snapshot.qt-project.org/5.0/configure-options.html | X | Not updated to match options in Qt 5 |
| Chapter 6: Writing an Extension Plugin | http://doc-snapshot.qt-project.org/5.0/declarative-tutorials-extending-chapter6-plugins.html | X | Mention of QML Viewer |
| Deploying Qt Applications | http://doc-snapshot.qt-project.org/5.0/deployment.html | X | Outdated list of modules, and outdated list of platforms? |
| Deploying an Application on Mac OS X | http://doc-snapshot.qt-project.org/5.0/deployment-mac.html | X | Is this up-to-date? The deployment tool mentioned here does not seem to exist. What about Creator? |
| Deploying Plugins | http://doc-snapshot.qt-project.org/5.0/deployment-plugins.html | X | Has several mentions of Qt 4 version numbers as examples. |
| Customizing Qt Designer Forms | http://doc-snapshot.qt-project.org/5.0/designer-customizing-forms.html | X | Refers to QWidget include file as <QtGui/QWidget> |
| Using Layouts in Qt Designer | http://doc-snapshot.qt-project.org/5.0/designer-layouts.html | X | Talks about QFormLayout as if it's the new sliced bread |
| Qt Designer Manual | http://doc-snapshot.qt-project.org/5.0/designer-manual.html | X | Should be clear about this being a designer for Widget apps specifically and that there are options. |
| Getting to Know Qt Designer | http://doc-snapshot.qt-project.org/5.0/designer-to-know.html | X | Outdated information on how to start application (should probably focus on Qt Creator integration). Contains a reference to old "Qt Software" branding. |
| Qt Designer's Widget Editing Mode | http://doc-snapshot.qt-project.org/5.0/designer-widget-mode.html | X | Contains a TODO: "### Screenshot of widget box, again" |
| Determining the default sensor for a type | http://doc-snapshot.qt-project.org/5.0/determining-the-default-sensor-for-a-type.html | X | Nokia-specific (talks about a .conf file in /etc/xdg/Nokia). |
| Drag and Drop | http://doc-snapshot.qt-project.org/5.0/dnd.html | X | Needs to describe QtQuick/QWindow (QWidget part is OK) |
| Qt Editions | http://doc-snapshot.qt-project.org/5.0/editions.html | X | X links |
| Keyboard Focus | http://doc-snapshot.qt-project.org/5.0/focus.html | X | Widget-specific. Should contain info about keyboard-focus in QML. |
| Cleanlooks Style Widget Gallery | http://doc-snapshot.qt-project.org/5.0/gallery-cleanlooks.html | X | Kill? We have to find out if CleanLooks is part of Qt 5 or not. |
| GTK Style Widget Gallery | http://doc-snapshot.qt-project.org/5.0/gallery-gtk.html | X | Doesn't the GTK style use the system theme? Should be clarified if that's the case. |
| Qt Widget Gallery | http://doc-snapshot.qt-project.org/5.0/gallery.html | X | Mentions "Qt 4" as current version. |
| Plastique Style Widget Gallery | http://doc-snapshot.qt-project.org/5.0/gallery-plastique.html | X | Kill? We have to find out if Plastique is part of Qt 5 or not. |
| Gestures Programming | http://doc-snapshot.qt-project.org/5.0/gestures-overview.html | X | Focuses on QWidget and Graphics View. Should probably focus on QWidget and QML? |
| Getting Started Guides | http://doc-snapshot.qt-project.org/5.0/gettingstarted.html | X | Differentiating between Qt and QML as two different toolkits. Should be "widgets" and "QML"? |
| Getting Started Programming with QML | http://doc-snapshot.qt-project.org/5.0/gettingstartedqml.html | X | Several anachronisms: Qt 4.7 given as latest version, old code samples, etc. See QTBUG-25621 |
| Getting Started Programming with Qt | http://doc-snapshot.qt-project.org/5.0/gettingstartedqt.html | X | Called "Getting started with Qt" instead of "Getting started with QtWidgets" |
| GNU General Public License (GPL) | http://doc-snapshot.qt-project.org/5.0/gpl.html | X | "Copyright Nokia" |
| Books about GUI Design | http://doc-snapshot.qt-project.org/5.0/guibooks.html | X | 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? |
| Writing Source Code for Translation | http://doc-snapshot.qt-project.org/5.0/i18n-source-translation.html | X | Should also mention how to do this for QML |
| Implicit Sharing | http://doc-snapshot.qt-project.org/5.0/implicit-sharing.html | X | List of classes needs to be updated |
| Qt Location | http://doc-snapshot.qt-project.org/5.0/index-qtlocation-module.html | X | Talks about the default "nokia" plugin. Also seems to focus on Qt 4 APIs with a short list of Qt 5 updates at the end. |
| Installing Qt for Mac OS X | http://doc-snapshot.qt-project.org/5.0/install-mac.html | X | Should focus on SDK instead of source builds? |
| Installing Qt for Windows CE | http://doc-snapshot.qt-project.org/5.0/install-wince.html | X | Should focus on SDK instead of source builds? |
| Installing Qt for Windows | http://doc-snapshot.qt-project.org/5.0/install-win.html | X | Should focus on SDK instead of source builds? |
| Installing Qt for X11 Platforms | http://doc-snapshot.qt-project.org/5.0/install-x11.html | X | Should focus on SDK instead of source builds? |
| Internationalization with Qt | http://doc-snapshot.qt-project.org/5.0/internationalization.html | X | Very widget-centric, outdated Norwegian ortography in example, wrongfully identifies Scandinavian languages as "exotic" |
| Inter-Process Communication in Qt | http://doc-snapshot.qt-project.org/5.0/ipc.html | X | Remove QCop |
| GNU Lesser General Public License (LGPL) | http://doc-snapshot.qt-project.org/5.0/lgpl.html | X | s/Nokia/Digia |
| Qt Linguist Manual: Programmers | http://doc-snapshot.qt-project.org/5.0/linguist-programmers.html | X | Include information about QML |
| Qt Linguist Manual: Translators | http://doc-snapshot.qt-project.org/5.0/linguist-translators.html | X | First section only says "Contents". Placeholder? |
| Qt Linguist Manual: TS File Format | http://doc-snapshot.qt-project.org/5.0/linguist-ts-file-format.html | X | Missing DTD |
| Support for Linux/X11 | http://doc-snapshot.qt-project.org/5.0/linuxx11-support.html | X | List of features includes graphics view and QtOpenGL, but not QML. |
| Qt for Mac OS X - Specific Issues | http://doc-snapshot.qt-project.org/5.0/mac-differences.html | X | 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. |
| Support for Mac OS X | http://doc-snapshot.qt-project.org/5.0/mac-support.html | X | List of features includes graphics view and QtOpenGL, but not QML. |
| The Meta-Object System | http://doc-snapshot.qt-project.org/5.0/metaobjects.html | X | Should mention that the meta object can also be used make functions and properties available from QML. |
| Using the Meta-Object Compiler (moc) | http://doc-snapshot.qt-project.org/5.0/moc.html | X | Says that "moc does not expand macros", but I think Lars added a fully functioning preprocessor? |
| Model/View Tutorial | http://doc-snapshot.qt-project.org/5.0/modelview.html | X | 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 Programming | http://doc-snapshot.qt-project.org/5.0/model-view-programming.html | X | Should cover QML usage, mentions Qt 4 as if it's new, mentions porting from Qt 3. |
| All Namespaces | http://doc-snapshot.qt-project.org/5.0/namespaces.html | X | Add QtQuick-related namespaces |
| Object Trees & Ownership | http://doc-snapshot.qt-project.org/5.0/objecttrees.html | X | QWidget is not "the base class of everything that appears on the screen" |
| Open Source Versions of Qt | http://doc-snapshot.qt-project.org/5.0/opensourceedition.html | X | s/Nokia/Digia/ |
| All Overviews and HOWTOs | http://doc-snapshot.qt-project.org/5.0/overviews.html | X | If this list is not generated, it will need fixing |
| Paint Devices and Backends | http://doc-snapshot.qt-project.org/5.0/paintsystem-devices.html | X | Remove the references to QGL-classes (replace with QOpenGLPaintDevice) |
| Supported Platforms | http://doc-snapshot.qt-project.org/5.0/platform-details.html | X | See QTBUG-27250 also mentions Nokia |
| Platform and Compiler Notes | http://doc-snapshot.qt-project.org/5.0/platform-notes.html | X | Remove "embedded linux" |
| Platform Notes - INTEGRITY | http://doc-snapshot.qt-project.org/5.0/platform-notes-integrity.html | X | Says it's community-port based on Qt for Embedded Linux. Should it be killed as well? |
| Platform and Compiler Notes - Mac OS X | http://doc-snapshot.qt-project.org/5.0/platform-notes-mac.html | X | 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 | http://doc-snapshot.qt-project.org/5.0/platform-notes-qnx.html | X | Says it's community-port based on Qt for Embedded Linux. Should it be killed as well? |
| Platform and Compiler Notes - VxWorks | http://doc-snapshot.qt-project.org/5.0/platform-notes-vxworks.html | X | References Qt embedded. |
| Platform and Compiler Notes - Windows | http://doc-snapshot.qt-project.org/5.0/platform-notes-windows.html | X | Refers to compiling Qt 4. Contains the macro "%VERSION%": Is this supposed to be expanded by qdoc? |
| Platform and Compiler Notes - X11 | http://doc-snapshot.qt-project.org/5.0/platform-notes-x11.html | X | A lot of this information is outdated |
| Platform-Specific Documentation | http://doc-snapshot.qt-project.org/5.0/platform-specific.html | X | outdated |
| Property Binding | http://doc-snapshot.qt-project.org/5.0/propertybinding.html | X | Missing snippets |
| QML Animation and Transitions | http://doc-snapshot.qt-project.org/5.0/qdeclarativeanimation.html | X | Missing snippets |
| QML Performance | http://doc-snapshot.qt-project.org/5.0/qdeclarativeperformance.html | X | Mostly OK, but need to get rid of the part mentioning graphicssystems and QDeclarativeView etc |
| QML Scope | http://doc-snapshot.qt-project.org/5.0/qdeclarativescope.html | X | Should have import QtQuick 2.0 instead of 1.0 |
| QML Security | http://doc-snapshot.qt-project.org/5.0/qdeclarativesecurity.html | X | Should have import QtQuick 2.0 instead of 1.0 |
| QML States | http://doc-snapshot.qt-project.org/5.0/qdeclarativestates.html | X | Missing code snippets |
| qmake Platform Notes | http://doc-snapshot.qt-project.org/5.0/qmake-platform-notes.html | X | Contains sections about Symbian |
| Using Precompiled Headers | http://doc-snapshot.qt-project.org/5.0/qmake-precompiledheaders.html | X | Contains some 4.0 versioning in the code snippets and claims we still support VC6. |
| qmake Project Files | http://doc-snapshot.qt-project.org/5.0/qmake-project-files.html | X | Outdated examples where you have to do "CONFIG += qt thread" to get a multithreaded Qt application. Outdated list of modules. |
| qmake Variable Reference | http://doc-snapshot.qt-project.org/5.0/qmake-variable-reference.html | X | 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. |
| QML Example - Toggle Switch | http://doc-snapshot.qt-project.org/5.0/qmlexampletoggleswitch.html | X | Missing snippets |
| Acceptance tests for Qt3D | http://doc-snapshot.qt-project.org/5.0/qt3d-acceptance.html | X | Missing images |
| Qt3D Classes | http://doc-snapshot.qt-project.org/5.0/qt3d-all-classes.html | X | Lists _all_ Qt classes, not just Qt3D |
| Qt 3D Annotated Class List | http://doc-snapshot.qt-project.org/5.0/qt3d-annotated.html | X | Lists _all_ Qt classes, not just Qt3D |
| Building QtQuick3D | http://doc-snapshot.qt-project.org/5.0/qt3d-building.html | X | Missing images |
| Camera and View Frustum | http://doc-snapshot.qt-project.org/5.0/qt3d-camera-frustum.html | X | Missing images |
| Qt 3D Classes | http://doc-snapshot.qt-project.org/5.0/qt3d-classes.html | X | Lists __all_ Qt classes, not just Qt3D |
| Contributing to QtQuick3D and Qt3D | http://doc-snapshot.qt-project.org/5.0/qt3d-contrib.html | X | Or OK, this page is simply missing |
| Declarative Scenegraph Creation | http://doc-snapshot.qt-project.org/5.0/qt3d-declarative-scenegraph.html | X | Missing images |
| Qt 3D Inheritance Hierarchy | http://doc-snapshot.qt-project.org/5.0/qt3d-hierarchy.html | X | Lists _all_ Qt classes, not just Qt3D |
| Qt3D Classes | http://doc-snapshot.qt-project.org/5.0/qt3d.html | X | Or OK, this page is simply missing |
| Qt 3D | http://doc-snapshot.qt-project.org/5.0/qt3d-index.html | X | Missing images |
| 3D Math Basis | http://doc-snapshot.qt-project.org/5.0/qt3d-math-basis.html | X | Missing images |
| QtQuick3D Troubleshooting Guide | http://doc-snapshot.qt-project.org/5.0/qt3d-troubleshooting.html | X | Missing images |
| What's New in Qt 5 | http://doc-snapshot.qt-project.org/5.0/qt5-intro.html | X | Not complete. Too focused on mobile |
| Programming with Qt | http://doc-snapshot.qt-project.org/5.0/qt-basic-concepts.html | X | Add QtQuick/QWindow-based topics |
| QtConcurrent Module | http://doc-snapshot.qt-project.org/5.0/qtconcurrent-module.html | X | No links |
| Configuring Qt | http://doc-snapshot.qt-project.org/5.0/qtconfig.html | X | Is this even supported anymore? It doesn't even build |
| Qt Contacts | http://doc-snapshot.qt-project.org/5.0/qtcontacts-index.html | X | Missing snippets |
| kmap2qmap | http://doc-snapshot.qt-project.org/5.0/qt-embedded-kmap2qmap.html | X | Rewrite to mention QPA instead of Qt/Embedded |
| QTest Namespace | http://doc-snapshot.qt-project.org/5.0/qtest.html | X | Missing snippets |
| QTestLib Manual | http://doc-snapshot.qt-project.org/5.0/qtestlib-manual.html | X | Get rid of "provided by Nokia" ? Does cetest still work for remote execution of tests on Windows CE? |
| Chapter 1: Writing a Unit Test | http://doc-snapshot.qt-project.org/5.0/qtestlib-tutorial1.html | X | Missing snippets |
| Chapter 2: Data Driven Testing | http://doc-snapshot.qt-project.org/5.0/qtestlib-tutorial2.html | X | Missing snippets |
| Chapter 3: Simulating GUI Events | http://doc-snapshot.qt-project.org/5.0/qtestlib-tutorial3.html | X | Missing snippets |
| Chapter 4: Replaying GUI Events | http://doc-snapshot.qt-project.org/5.0/qtestlib-tutorial4.html | X | Missing snippets |
| Chapter 5: Writing a Benchmark | http://doc-snapshot.qt-project.org/5.0/qtestlib-tutorial5.html | X | Missing snippets, broken link |
| Qt Graphical Effects | http://doc-snapshot.qt-project.org/5.0/qtgraphicaleffects-index.html | X | Missing snippet |
| QtOpenGL Module | http://doc-snapshot.qt-project.org/5.0/qtopengl-module.html | X | The Motif reference might not be relevant any more |
| Qt Performance Tuning | http://doc-snapshot.qt-project.org/5.0/qt-performance.html | X | At least the part about QDirectPainter needs to go |
| QML Tutorial 1 - Basic Types | http://doc-snapshot.qt-project.org/5.0/qtquick2-qml-tutorial1.html | X | Says to use "qmlviewer" to view example, but that's called "qmlscene" now, right? |
| Defining Reusable Components | http://doc-snapshot.qt-project.org/5.0/qtquick-appdevguide-components.html | X | Contains lots of ######## comments |
| Deploying QML Applications | http://doc-snapshot.qt-project.org/5.0/qtquick-deployment.html | X | Claims that QQuickView is QWidget-based and uses QApplication instead of QGuiApplication in examples. |
| Sprite Animations | http://doc-snapshot.qt-project.org/5.0/qtquick-effects-sprites.html | X | Broken HTML for links and some broken qdoc syntax at the top. |
| Qt Script Debugger Manual | http://doc-snapshot.qt-project.org/5.0/qtscriptdebugger-manual.html | X | QtScript goes away? |
| Creating QtScript Extensions | http://doc-snapshot.qt-project.org/5.0/qtscriptextensions.html | X | QtScript goes away? |
| QtScript Module | http://doc-snapshot.qt-project.org/5.0/qtscript-module.html | X | QtScript goes away? |
| QtScriptTools Module | http://doc-snapshot.qt-project.org/5.0/qtscripttools-module.html | X | QtScript goes away? |
| General Qt Requirements | http://doc-snapshot.qt-project.org/5.0/requirements.html | X | Update to QPA |
| Qt for Windows CE Requirements | http://doc-snapshot.qt-project.org/5.0/requirements-wince.html | X | Looks outdated; is CE even supported anymore? |
| Qt for X11 Requirements | http://doc-snapshot.qt-project.org/5.0/requirements-x11.html | X | Outdated, doesn't mention xcb |
| Restoring a Window's Geometry | http://doc-snapshot.qt-project.org/5.0/restoring-geometry.html | X | Update to QWindow (also, QWidget::saveGeometry is buggy) |
| Scripting Classes and Overviews | http://doc-snapshot.qt-project.org/5.0/script.html | X | QtScript goes away? |
| Making Applications Scriptable | http://doc-snapshot.qt-project.org/5.0/scripting.html | X | QtScript goes away? |
| QtSensorGestures Plugins | http://doc-snapshot.qt-project.org/5.0/sensorgesture-plugins-topics.html | X | Illustrations look like Nokia form factor. Is that ok? |
| Qt Service Framework | http://doc-snapshot.qt-project.org/5.0/service-frameworks.html | X | URLs of bug reports and 4.7 docs, and littered with mentions of "nokia" in the examples etc. |
| Windows CE - Using shadow builds | http://doc-snapshot.qt-project.org/5.0/shadow.html | X | WinCE? |
| Trademarks | http://doc-snapshot.qt-project.org/5.0/trademarks.html | X | Nokia -> Digia |
| Tutorials | http://doc-snapshot.qt-project.org/5.0/tutorials.html | X | Outdated |
| Video Overview | http://doc-snapshot.qt-project.org/5.0/videooverview.html | X | Missing snippets |
| The Webkit Bridge Tutorial - Hybrid Client Application | http://doc-snapshot.qt-project.org/5.0/webkit-imageanalyzer.html | X | Missing snippets / images |
| Windows CE - Introduction to using Qt | http://doc-snapshot.qt-project.org/5.0/wince-with-qt-introduction.html | X | is CE still supported? |
| Windows CE - Working with Custom SDKs | http://doc-snapshot.qt-project.org/5.0/windowsce-customization.html | X | is CE still supported? |
| Qt for Windows CE and OpenGL ES | http://doc-snapshot.qt-project.org/5.0/windowsce-opengl.html | X | Outdated: Only mentions QGLWidget; is CE still supported? |
| Windows CE - Signing | http://doc-snapshot.qt-project.org/5.0/windowsce-signing.html | X | Is CE still supported? |
| XQuery | http://doc-snapshot.qt-project.org/5.0/xmlprocessing.html | X | Missing snippets |
| XML Streaming | http://doc-snapshot.qt-project.org/5.0/xml-streaming.html | X | Missing snippets |
| A Short Path to XQuery | http://doc-snapshot.qt-project.org/5.0/xquery-introduction.html | X | Missing snippets |
| QML Best Practices | http://doc-snapshot.qt-project.org/5.0/qml-best-practices-coding.html | X | Maybe change QtQuick 1.0 -> QtQuick 2.0 |
| QML Best Practices | http://doc-snapshot.qt-project.org/5.0/qml-best-practices-datatypes.html | X | This document contains empty sections |
| QML Coding Conventions | http://doc-snapshot.qt-project.org/5.0/qml-coding-conventions.html | X | Contains mostly the same content as qml-condingconventions.html but with broken snippets |
| QML Coding Conventions | http://doc-snapshot.qt-project.org/5.0/qml-codingconventions.html | X | Why have two coding conventions documents, this and qml-best-practices-coding.html? |
| Extending QML Functionalities using C++ | http://doc-snapshot.qt-project.org/5.0/qml-extending.html | X | Missing snippets |
| QML Feedback API | http://doc-snapshot.qt-project.org/5.0/qml-feedback-api.html | X | "Feedback elements" section is empty (linking error?) |
| Integrating QML Code with Existing Qt UI Code | http://doc-snapshot.qt-project.org/5.0/qml-integration.html | X | Talks about integrating QML 1 with QWidgets and QGraphicsView, should maybe talk about QML 2? |
| QML Concepts and Syntax | http://doc-snapshot.qt-project.org/5.0/qml-intro-basic-syntax.html | X | Missing snippets and images |
| Composing User Interfaces with QML | http://doc-snapshot.qt-project.org/5.0/qml-intro-composing-uis.html | X | Missing snippets and images |
| Introduction to Qt Quick | http://doc-snapshot.qt-project.org/5.0/qml-intro.html | X | Talks about QtDeclarative, Symbian and Maemo and has screenshot with Symbian in it |
| QML Application Development Tools | http://doc-snapshot.qt-project.org/5.0/qml-intro-tools.html | X | Talks about Maemo and has screenshot with Symbian in it |
| User Interaction with QML | http://doc-snapshot.qt-project.org/5.0/qml-intro-user-interaction.html | X | Missing snippets |
| Location QML Plugin | http://doc-snapshot.qt-project.org/5.0/qml-location-plugin.html | X | Broken link to "coordinate" type |
| Using QML Positioner and Repeater Items | http://doc-snapshot.qt-project.org/5.0/qml-positioners.html | X | Missing snippets |
| Presenting Data with QML | http://doc-snapshot.qt-project.org/5.0/qml-presenting-data.html | X | Missing snippets, incomplete ("Decorating views" etc sections have no content) |
| QML Right-to-left User Interfaces | http://doc-snapshot.qt-project.org/5.0/qml-righttoleft.html | X | Missing snippets, talks about qmlviewer and not qmlscene |
| QML Tutorial 1 - Basic Types | http://doc-snapshot.qt-project.org/5.0/qml-tutorial1.html | X | Missing snippets |
| QML Tutorial 2 - QML Components | http://doc-snapshot.qt-project.org/5.0/qml-tutorial2.html | X | Missing snippets |
| QML Tutorial 3 - States and Transitions | http://doc-snapshot.qt-project.org/5.0/qml-tutorial3.html | X | Missing snippets |
| QML Tutorial | http://doc-snapshot.qt-project.org/5.0/qml-tutorial.html | X | Wrong link to source code for the tutorial |
| Presenting Data with Views | http://doc-snapshot.qt-project.org/5.0/qml-views.html | X | Missing snippets |
OK pages with actions
| Title | Link | Status | |
|---|---|---|---|
| Positional Audio | http://doc-snapshot.qt-project.org/5.0/audioengineoverview.html | X | Strange orthography, so maybe it should be brushed up, but content is fine. |
| Creating Custom Qt Types | http://doc-snapshot.qt-project.org/5.0/custom-types.html | X | Should probably mention QtQuick |
| Chapter 2: Connecting to C++ Methods and Signals | http://doc-snapshot.qt-project.org/5.0/declarative-tutorials-extending-chapter2-methods.html | X | Contains some iffy code snippets |
| Chapter 3: Adding Property Bindings | http://doc-snapshot.qt-project.org/5.0/declarative-tutorials-extending-chapter3-bindings.html | X | Contains some iffy code snippets |
| Chapter 4: Using Custom Property Types | http://doc-snapshot.qt-project.org/5.0/declarative-tutorials-extending-chapter4-custompropertytypes.html | X | Contains some iffy code snippets |
| Chapter 5: Using List Property Types | http://doc-snapshot.qt-project.org/5.0/declarative-tutorials-extending-chapter5-listproperties.html | X | Contains some iffy code snippets |
| QML Advanced Tutorial 1 - Creating the Game Canvas and Blocks | http://doc-snapshot.qt-project.org/5.0/declarative-tutorials-samegame-samegame1.html | X | Contains some iffy code snippets |
| QML Advanced Tutorial 2 - Populating the Game Canvas | http://doc-snapshot.qt-project.org/5.0/declarative-tutorials-samegame-samegame2.html | X | Contains some iffy code snippets |
| QML Advanced Tutorial 3 - Implementing the Game Logic | http://doc-snapshot.qt-project.org/5.0/declarative-tutorials-samegame-samegame3.html | X | Contains some iffy code snippets |
| QML Advanced Tutorial 4 - Finishing Touches | http://doc-snapshot.qt-project.org/5.0/declarative-tutorials-samegame-samegame4.html | X | Contains some iffy code snippets |
| Deploying an Application on Windows | http://doc-snapshot.qt-project.org/5.0/deployment-windows.html | X | X with some reservations: Does not mention SDK or Qt Creator at all.. Should it? |
| Deploying an Application on X11 Platforms | http://doc-snapshot.qt-project.org/5.0/deployment-x11.html | X | X with some reservations: Does not mention SDK or Qt Creator at all.. Should it? |
| Qt Designer's UI File Format | http://doc-snapshot.qt-project.org/5.0/designer-ui-file-format.html | X | XML-schema missing, but this will probably be picked up by a qdoc error. |
| Using a Designer UI File in Your Application | http://doc-snapshot.qt-project.org/5.0/designer-using-a-ui-file.html | X | Some iffy code snippets |
| Using Custom Widgets with Qt Designer | http://doc-snapshot.qt-project.org/5.0/designer-using-custom-widgets.html | X | |
| Desktop Integration | http://doc-snapshot.qt-project.org/5.0/desktop-integration.html | X | See QTBUG-25524 |
| Macintosh Style Widget Gallery | http://doc-snapshot.qt-project.org/5.0/gallery-macintosh.html | X | Has a table-breaking image, but mostly fine. |
| Installation | http://doc-snapshot.qt-project.org/5.0/installation.html | X | Expand with more platforms? |
| Other Licenses Used in Qt | http://doc-snapshot.qt-project.org/5.0/licenses.html | X | But remove link to killed page |
| Notifications | http://doc-snapshot.qt-project.org/5.0/notifications.html | X | Maybe add JSON DB to the title |
| Object Indexes | http://doc-snapshot.qt-project.org/5.0/object-indexes.html | X | Maybe add JSON DB to the title |
| qlalr - References to External Information | http://doc-snapshot.qt-project.org/5.0/qlalr-external-references.html | X | Missing actually, but that seems to have been the case in 4.x as well |
| qlalr - Writing Grammars | http://doc-snapshot.qt-project.org/5.0/qlalr-files.html | X | Missing actually, but that seems to have been the case in 4.x as well |
| qlalr - Generating Code from Grammar Specifications | http://doc-snapshot.qt-project.org/5.0/qlalr-generating.html | X | Missing actually, but that seems to have been the case in 4.x as well |
| qlalr - qlalr Grammar Specification | http://doc-snapshot.qt-project.org/5.0/qlalr-grammar-specification.html | X | Missing actually, but that seems to have been the case in 4.x as well |
| qlalr - Handling Conflicts | http://doc-snapshot.qt-project.org/5.0/qlalr-handling-conflicts.html | X | Missing actually, but that seems to have been the case in 4.x as well |
| qlalr - Error Handling and Recovery | http://doc-snapshot.qt-project.org/5.0/qlalr-handling-errors.html | X | Missing actually, but that seems to have been the case in 4.x as well |
| qlalr | http://doc-snapshot.qt-project.org/5.0/qlalr.html | X | Missing actually, but that seems to have been the case in 4.x as well |
| QML Basic Elements | http://doc-snapshot.qt-project.org/5.0/qmlbasicelements.html | X | Missing but presumably part of QML 1 |
| QML Signal and Handler Event System | http://doc-snapshot.qt-project.org/5.0/qmlevents.html | X | Missing but presumably part of QML 1 |
| Using QML elements | http://doc-snapshot.qt-project.org/5.0/qmlinuse.html | X | Missing but presumably part of QML 1 |
| Importing Reusable Components | http://doc-snapshot.qt-project.org/5.0/qmlreusablecomponents.html | X | Missing but presumably part of QML 1 |
| Qt Declarative UI Runtime | http://doc-snapshot.qt-project.org/5.0/qmlruntime.html | X | Missing but presumably part of QML 1 |
| QML Syntax | http://doc-snapshot.qt-project.org/5.0/qmlsyntax.html | X | Missing but presumably part of QML 1 |
| QML Viewer | http://doc-snapshot.qt-project.org/5.0/qmlviewer.html | X | Missing but presumably part of QML 1 |
| QtWebKit QML Module | http://doc-snapshot.qt-project.org/5.0/qmlwebkit.html | X | Missing but presumably part of QML 1 |
| Using QML Bindings in C++ Applications | http://doc-snapshot.qt-project.org/5.0/qtbinding.html | X | Missing but probably QML 1 |
| Property Binding | http://doc-snapshot.qt-project.org/5.0/qtqml-syntax-propertybinding.html | X | Fix the ### TODO |
| QML Application Developer Resources | http://doc-snapshot.qt-project.org/5.0/qtquick-applicationdevelopers.html | X | But update list of essential modules (Qt3D is no longer essential) |
| Keyboard Focus in Qt Quick | http://doc-snapshot.qt-project.org/5.0/qtquick-input-focus.html | X | A bit too much QWidget |
| Qt Quick Text Input Handling and Validators | http://doc-snapshot.qt-project.org/5.0/qtquick-input-textinput.html | X | Remove QRegExp reference? QRegularExpression is the new class in 5.0. |
| Use Case - Integrating JavaScript in QML | http://doc-snapshot.qt-project.org/5.0/qtquick-usecase-integratingjs.html | X | Last link in document doesn't work |
| Qt for Windows Requirements | http://doc-snapshot.qt-project.org/5.0/requirements-win.html | X | But rename QML2 to QtQuick2 |
| The Qt Resource System | http://doc-snapshot.qt-project.org/5.0/resources.html | X | Remove reference to obsoleted Qt 3 functionality |
| Scalability | http://doc-snapshot.qt-project.org/5.0/scalability.html | X | But maybe mention desktop as well as devices |
| Signals & Slots | http://doc-snapshot.qt-project.org/5.0/signalsandslots.html | X | A bit too much focus on QWidget? |
| SQL Database Drivers | http://doc-snapshot.qt-project.org/5.0/sql-driver.html | X | Correct qmake usage. See QTBUG-27325, QTBUG-25600 |
| Secure Sockets Layer (SSL) Classes | http://doc-snapshot.qt-project.org/5.0/ssl.html | X | Says "classes below", but there is no class list (this was also the fact in 4.8) |
| Threading Basics | http://doc-snapshot.qt-project.org/5.0/thread-basics.html | X | Change to be less QWidget-focused |
| Thread Support in Qt | http://doc-snapshot.qt-project.org/5.0/threads.html | X | Link back to Threading Basics in Recommended Reading |
| Threads and QObjects | http://doc-snapshot.qt-project.org/5.0/threads-qobject.html | X | Change to be less QWidget-focused |
| Starting Threads with QThread | http://doc-snapshot.qt-project.org/5.0/threads-starting.html | X | Change QApplication to QGuiApplication |
| Timers | http://doc-snapshot.qt-project.org/5.0/timers.html | X | Change to be less QWidget-focused |
| Widgets and Layouts | http://doc-snapshot.qt-project.org/5.0/widgets-and-layouts.html | X | Mention QtQuick |
| Widgets Tutorial | http://doc-snapshot.qt-project.org/5.0/widgets-tutorial.html | X | Mention QtQuick |
For reference
(Maybe move to a separate page?)
The whole list
Listed alphabetically by filename.