From 470d214a5e363fc7035932fe46a5711b2b20c354 Mon Sep 17 00:00:00 2001 From: David Boddie Date: Fri, 18 Sep 2009 16:36:02 +0200 Subject: Doc: Language and style fixes to the XML Patterns documentation. Reviewed-by: Trust Me --- doc/src/snippets/code/doc_src_qtxmlpatterns.qdoc | 78 +----------------------- doc/src/xml-processing/xquery-introduction.qdoc | 40 ++++++------ 2 files changed, 20 insertions(+), 98 deletions(-) diff --git a/doc/src/snippets/code/doc_src_qtxmlpatterns.qdoc b/doc/src/snippets/code/doc_src_qtxmlpatterns.qdoc index 7f4c89b..2d5babb 100644 --- a/doc/src/snippets/code/doc_src_qtxmlpatterns.qdoc +++ b/doc/src/snippets/code/doc_src_qtxmlpatterns.qdoc @@ -248,8 +248,8 @@ declare variable $insertion := "example"; declare default element namespace "http://cookbook/namespace"; let $docURI := 'cookbook.xml' return if(doc-available($docURI)) - then doc($docURI)//recipe/{./node()} - else Failed to load {$docURI} + then doc($docURI)//recipe/{./node()} + else Failed to load {$docURI} //! [40] //! [41] @@ -312,79 +312,5 @@ for $a in doc('doc.txt')//p

f0

//! [49] -//! [100] - - - - Quick and Easy Mushroom Soup - - - - - - - - - - - - Cheese on Toast - - - - - Hard-Boiled Eggs - - - -//! [100] - } diff --git a/doc/src/xml-processing/xquery-introduction.qdoc b/doc/src/xml-processing/xquery-introduction.qdoc index 93a33c1..25fa13f 100644 --- a/doc/src/xml-processing/xquery-introduction.qdoc +++ b/doc/src/xml-processing/xquery-introduction.qdoc @@ -40,11 +40,11 @@ ****************************************************************************/ /*! - \page xquery-introduction.html - \title A Short Path to XQuery +\page xquery-introduction.html +\title A Short Path to XQuery - \startpage Using XML Technologies - \target XQuery-introduction +\startpage Using XML Technologies +\target XQuery-introduction XQuery is a language for querying XML data or non-XML data that can be modeled as XML. XQuery is specified by the \l{http://www.w3.org}{W3C}. @@ -119,7 +119,7 @@ following XQuery: \snippet snippets/code/doc_src_qtxmlpatterns.qdoc 18 -The \c{doc()} function loads the file \l{cookbook.xml} and returns the +The \c{doc()} function loads the \c{cookbook.xml} file and returns the document node. The document node then becomes the focus for the next step \c{//recipe}. Here the double slash means select all \c{} elements found below the document node, regardless of where they @@ -535,7 +535,7 @@ methods is presented in the section on \l{Boolean Predicates}. There are many more functions and operators defined for XQuery and XPath. They are all \l{http://www.w3.org/TR/xpath-functions} -{documented here}. +{documented in the specification}. \section2 Positional Predicates @@ -688,12 +688,12 @@ XQueries wherever expressions are allowed. \snippet snippets/code/doc_src_qtxmlpatterns.qdoc 40 -If \c{cookbook.xml} is loaded without error, a \c{} element -(Norweigian word for recipe) is constructed for each \c{} +If \c{cookbook.xml} is loaded without error, a \c{} element +(Norwegian word for recipe) is constructed for each \c{} element in the cookbook, and the child nodes of the \c{} are -copied into the \c{} element. But if the cookbook document +copied into the \c{} element. But if the cookbook document doesn't exist or does not contain well-formed XML, a single -\c{} element is constructed containing an error message. +\c{} element is constructed containing an error message. \section1 Constructing Atomic Values @@ -727,26 +727,23 @@ Sending this XQuery through xmlpatterns produces: \snippet snippets/code/doc_src_qtxmlpatterns.qdoc 40 -If \c{cookbook.xml} is loaded without error, a \c{} element +If \c{cookbook.xml} is loaded without error, a \c{} element (Norweigian word for recipe) is constructed for each \c{} element in the cookbook, and the child nodes of the \c{} are -copied into the \c{} element. But if the cookbook document +copied into the \c{} element. But if the cookbook document doesn't exist or does not contain well-formed XML, a single -\c{} element is constructed containing an error message. +\c{} element is constructed containing an error message. \section1 Running The Cookbook Examples -Most of the XQuery examples in this document refer to the cookbook -written in XML shown below. Save it as \c{cookbook.xml}. In the same -directory, save one of the cookbook XQuery examples in a \c{.xq} file -(e.g. \c{file.xq}). Run the XQuery using Qt's command line utility: +Most of the XQuery examples in this document refer to the +\c{cookbook.xml} example file from the \l{Recipes Example}. +Copy the \c{cookbook.xml} to your current directory, save one of the +cookbook XQuery examples in a \c{.xq} file (e.g., \c{file.xq}), and +run the XQuery using Qt's command line utility: \snippet snippets/code/doc_src_qtxmlpatterns.qdoc 6 -\section2 cookbook.xml - -\snippet snippets/code/doc_src_qtxmlpatterns.qdoc 100 - \section1 Further Reading There is much more to the XQuery language than we have presented in @@ -1019,5 +1016,4 @@ you want to use \c{true} and \c{false}. The other way is to invoke the boolean constructor: \quotefile snippets/patternist/xsBooleanTrue.xq - */ -- cgit v0.12 From d5a7729a12223512e2d66b3fe4f82234ea9c6d97 Mon Sep 17 00:00:00 2001 From: David Boddie Date: Fri, 18 Sep 2009 16:37:14 +0200 Subject: Doc: Prevented the inclusion of a license header in the documentation. Reviewed-by: Trust Me --- doc/src/snippets/widgets-tutorial/template.cpp | 2 ++ doc/src/tutorials/widgets-tutorial.qdoc | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/src/snippets/widgets-tutorial/template.cpp b/doc/src/snippets/widgets-tutorial/template.cpp index 19902cc..2ced971 100644 --- a/doc/src/snippets/widgets-tutorial/template.cpp +++ b/doc/src/snippets/widgets-tutorial/template.cpp @@ -39,6 +39,7 @@ ** ****************************************************************************/ +//! [main.cpp body] #include // Include header files for application components. @@ -53,3 +54,4 @@ int main(int argc, char *argv[]) return app.exec(); } +//! [main.cpp body] diff --git a/doc/src/tutorials/widgets-tutorial.qdoc b/doc/src/tutorials/widgets-tutorial.qdoc index 31e2ba3..1d3ebfe 100644 --- a/doc/src/tutorials/widgets-tutorial.qdoc +++ b/doc/src/tutorials/widgets-tutorial.qdoc @@ -80,7 +80,7 @@ A typical \c main() function, written in \c{main.cpp}, looks like this: - \quotefile doc/src/snippets/widgets-tutorial/template.cpp + \snippet doc/src/snippets/widgets-tutorial/template.cpp main.cpp body We first construct a QApplication object which is configured using any arguments passed in from the command line. After any widgets have been -- cgit v0.12 From 73ec939c8098b5996c6a775101bad2dc20f32556 Mon Sep 17 00:00:00 2001 From: David Boddie Date: Fri, 18 Sep 2009 16:39:00 +0200 Subject: Doc: First update of the documentation about learning Qt. Reviewed-by: Trust Me --- doc/src/external-resources.qdoc | 10 ++++++ doc/src/getting-started/how-to-learn-qt.qdoc | 52 +++++++++++++++++----------- doc/src/qt-webpages.qdoc | 2 +- 3 files changed, 42 insertions(+), 22 deletions(-) diff --git a/doc/src/external-resources.qdoc b/doc/src/external-resources.qdoc index cc5a24f..ad6731b 100644 --- a/doc/src/external-resources.qdoc +++ b/doc/src/external-resources.qdoc @@ -357,3 +357,13 @@ \externalpage http://developers.sun.com/sunstudio/downloads/patches/index.jsp \title Sun Studio Patches */ + +/*! + \externalpage http://www.qtcentre.org + \title Qt Centre +*/ + +/*! + \externalpage http://www.kde.org + \title KDE +*/ diff --git a/doc/src/getting-started/how-to-learn-qt.qdoc b/doc/src/getting-started/how-to-learn-qt.qdoc index 5a83975..9df6f1f 100644 --- a/doc/src/getting-started/how-to-learn-qt.qdoc +++ b/doc/src/getting-started/how-to-learn-qt.qdoc @@ -43,22 +43,14 @@ \page how-to-learn-qt.html \title How to Learn Qt \brief Links to guides and resources for learning Qt. - \nextpage Tutorials + \section1 Getting Started + We assume that you already know C++ and will be using it for Qt development. See the \l{Qt website} for more information about using other programming languages with Qt. - The best way to learn Qt is to read the official Qt book, - \l{http://www.amazon.com/gp/product/0132354160/ref=ase_trolltech/}{C++ - GUI Programming with Qt 4, Second Edition} (ISBN 0-13-235416-0). This book - provides comprehensive coverage of Qt programming all the way - from "Hello Qt" to advanced features such as multithreading, 2D and - 3D graphics, networking, item view classes, and XML. (The first edition, - which is based on Qt 4.1, is available - \l{http://www.qtrac.eu/C++-GUI-Programming-with-Qt-4-1st-ed.zip}{online}.) - If you want to program purely in C++, designing your interfaces in code without the aid of any design tools, take a look at the \l{Tutorials}. These are designed to get you into Qt programming, @@ -73,6 +65,12 @@ overviews to deepen your understanding of Qt: \l{Qt Object Model} and \l{Signals and Slots}. + \beginfloatleft + \inlineimage qtdemo-small.png + \endfloat + + \section1 Getting an Overview + At this point, we recommend looking at the \l{All Overviews and HOWTOs}{overviews} and reading those that are relevant to your projects. You may also find it useful to browse the @@ -80,18 +78,14 @@ common with your projects. You can also read Qt's source code since this is supplied. - \table 50% - \header - \o {2,1} Getting an Overview - \row - \o \inlineimage qtdemo-small.png - \o If you run the \l{Examples and Demos Launcher}, you'll see many of Qt's widgets in action. The \l{Qt Widget Gallery} also provides overviews of selected Qt widgets in each of the styles used on various supported platforms. - \endtable + \clearfloat + + \section1 Books and Learning Materials Qt comes with extensive documentation, with hypertext cross-references throughout, so you can easily click your way to @@ -103,16 +97,32 @@ this tool is supplied with Qt and provides access to the entire Qt API, and it provides a full text search facility. - There are also a growing number of books about Qt programming; see - \l{Books about Qt Programming} for a complete list of Qt books, + There are also a growing number of books about Qt programming. + We recommend the official Qt book, + \l{http://www.amazon.com/gp/product/0132354160/ref=ase_trolltech/}{C++ + GUI Programming with Qt 4, Second Edition} (ISBN 0-13-235416-0). This book + provides comprehensive coverage of Qt programming all the way + from "Hello Qt" to advanced features such as multithreading, 2D and + 3D graphics, networking, item view classes, and XML. (The first edition, + which is based on Qt 4.1, is available + \l{http://www.qtrac.eu/C++-GUI-Programming-with-Qt-4-1st-ed.zip}{online}.) + + See \l{Books about Qt Programming} for a complete list of Qt books, including translations to various languages. Another valuable source of example code and explanations of Qt - features is the archive of articles from \l {http://qt.nokia.com/doc/qq} - {Qt Quarterly}, a quarterly newsletter for users of Qt. + features is the archive of articles from \l{Qt Quarterly}, a quarterly newsletter for users of Qt. For documentation on specific Qt modules and other guides, refer to \l{All Overviews and HOWTOs}. + \section1 Further Reading + + Qt has an active and helpful user community who communicate using + the \l{Qt Mailing Lists}{qt-interest} mailing list, the \l{Qt Centre} + Web site, and a number of other community Web sites and Weblogs. + In addition, many Qt developers are active members of the + \l{KDE}{KDE community}. + Good luck, and have fun! */ diff --git a/doc/src/qt-webpages.qdoc b/doc/src/qt-webpages.qdoc index 68658ae..e02cd19 100644 --- a/doc/src/qt-webpages.qdoc +++ b/doc/src/qt-webpages.qdoc @@ -180,7 +180,7 @@ */ /*! - \externalpage http://qt.nokia.com/lists + \externalpage http://lists.trolltech.com \title Qt Mailing Lists */ -- cgit v0.12 From 4aaec357acd92046103836e760af941de5c53c93 Mon Sep 17 00:00:00 2001 From: David Boddie Date: Fri, 18 Sep 2009 16:48:21 +0200 Subject: Doc: Added missing qdoc macros. Reviewed-by: Trust Me --- tools/qdoc3/test/macros.qdocconf | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/tools/qdoc3/test/macros.qdocconf b/tools/qdoc3/test/macros.qdocconf index f7dcdc0..dbb8ab8 100644 --- a/tools/qdoc3/test/macros.qdocconf +++ b/tools/qdoc3/test/macros.qdocconf @@ -28,3 +28,8 @@ macro.begincomment = "\\c{/*}" macro.endcomment = "\\c{*/}" macro.uuml.HTML = "ü" macro.mdash.HTML = "—" + +macro.beginfloatleft.HTML = "
" +macro.beginfloatright.HTML = "
" +macro.endfloat.HTML = "
" +macro.clearfloat.HTML = "
" -- cgit v0.12