summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorkh1 <karsten.heimrich@digia.com>2013-02-11 11:50:35 +0100
committerKarsten Heimrich <karsten.heimrich@digia.com>2013-02-11 16:38:14 +0100
commit7ae6081e9c457b13efaedee81d63894fdb66c12e (patch)
treef42d8078b9b4c09c5b24095b95f23eb0fb3d0840 /doc
parentc0c10581e83b2ca547eb8791cc52d9c517952d72 (diff)
Update docs. (Qt4, Qt5 support and digia naming).
Change-Id: I08ab41846b7c954ee9ef1ae5c907a35864165e18 Reviewed-by: Kai Koehne <kai.koehne@digia.com> Reviewed-by: Niels Weber <niels.weber@digia.com> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/config/compat.qdocconf4
-rw-r--r--doc/config/installerfw-project.qdocconf12
-rw-r--r--doc/config/macros.qdocconf10
-rw-r--r--doc/config/qt-html-default-styles.qdocconf60
-rw-r--r--doc/config/qt-html-online-styles.qdocconf96
-rw-r--r--doc/config/qt-html-templates-online.qdocconf14
-rw-r--r--doc/config/qt-html-templates.qdocconf4
-rw-r--r--doc/doc.pri18
-rw-r--r--doc/images/arrow.pngbin0 -> 1071 bytes
-rw-r--r--doc/templates/images/qt-logo.pngbin0 -> 1471 bytes
-rw-r--r--doc/templates/scripts/functions.js6
-rw-r--r--doc/templates/style/narrow.css2
-rw-r--r--doc/templates/style/offline.css5
13 files changed, 147 insertions, 84 deletions
diff --git a/doc/config/compat.qdocconf b/doc/config/compat.qdocconf
index 5745ed93b..fe793de6b 100644
--- a/doc/config/compat.qdocconf
+++ b/doc/config/compat.qdocconf
@@ -1,8 +1,8 @@
alias.i = e
-alias.include = input
+macro.li = "\\o"
macro.0 = "\\\\0"
-macro.b = "\\\\b"
+macro.b = "\\bold"
macro.n = "\\\\n"
macro.r = "\\\\r"
macro.i = "\\o"
diff --git a/doc/config/installerfw-project.qdocconf b/doc/config/installerfw-project.qdocconf
index 40f8469d9..841414df1 100644
--- a/doc/config/installerfw-project.qdocconf
+++ b/doc/config/installerfw-project.qdocconf
@@ -1,11 +1,11 @@
-project = "Qt Installer Framework Manual"
+project = "Qt Installer Framework"
description = "Qt Installer Framework Manual"
headerdirs =
sourcedirs = $SRCDIR
imagedirs = $SRCDIR/images $SRCDIR/templates/images
outputdir = $OUTDIR
-exampledirs = $SRCDIR
+exampledirs = $SRCDIR $SRCDIR/examples
indexes = qt.index
include(compat.qdocconf)
@@ -16,13 +16,13 @@ include(qt-defines.qdocconf)
sources.fileextensions = "*.qdoc"
qhp.projects = InstallerFramework
-qhp.InstallerFramework.file = installerfw.qhp
-qhp.InstallerFramework.namespace = com.nokia.qt.installerfw.121
+qhp.InstallerFramework.file = ifw.qhp
+qhp.InstallerFramework.namespace = org.qt-project.ifw.121
qhp.InstallerFramework.virtualFolder = doc
qhp.InstallerFramework.indexTitle = Qt Installer Framework Manual
-qhp.InstallerFramework.filterAttributes = installerfw 121
+qhp.InstallerFramework.filterAttributes = ifw
qhp.InstallerFramework.customFilters.InstallerFramework.name = Installer Framework
-qhp.InstallerFramework.customFilters.InstallerFramework.filterAttributes = installerfw
+qhp.InstallerFramework.customFilters.InstallerFramework.filterAttributes = ifw
qhp.InstallerFramework.indexRoot =
qhp.InstallerFramework.subprojects = manual
diff --git a/doc/config/macros.qdocconf b/doc/config/macros.qdocconf
index 568191eec..19960ea50 100644
--- a/doc/config/macros.qdocconf
+++ b/doc/config/macros.qdocconf
@@ -2,17 +2,17 @@ macro.aacute.HTML = "&aacute;"
macro.Aring.HTML = "&Aring;"
macro.aring.HTML = "&aring;"
macro.Auml.HTML = "&Auml;"
-macro.author = "\\bold{Author:}"
+macro.author = "\\b{Author:}"
macro.br.HTML = "<br />"
macro.BR.HTML = "<br />"
macro.copyright.HTML = "&copy;"
macro.eacute.HTML = "&eacute;"
-macro.gui = "\\bold"
+macro.gui = "\\b"
macro.hr.HTML = "<hr />"
macro.iacute.HTML = "&iacute;"
-macro.key = "\\bold"
-macro.menu = "\\bold"
-macro.note = "\\bold{Note:}"
+macro.key = "\\b"
+macro.menu = "\\b"
+macro.note = "\\b{Note:}"
macro.oslash.HTML = "&oslash;"
macro.ouml.HTML = "&ouml;"
macro.QA = "Qt Assistant"
diff --git a/doc/config/qt-html-default-styles.qdocconf b/doc/config/qt-html-default-styles.qdocconf
index 382d7fe30..1530c158a 100644
--- a/doc/config/qt-html-default-styles.qdocconf
+++ b/doc/config/qt-html-default-styles.qdocconf
@@ -2,32 +2,52 @@
# specified relative to the template directory and will be copied into
# subdirectories of the output directory.
-HTML.templatedir = $SRCDIR/templates
+HTML.templatedir = $SRCDIR/config
-HTML.stylesheets = style/offline.css
+HTML.stylesheets = ../templates/style/offline.css
HTML.scripts =
# Files not referenced in any qdoc file (last four needed by qtdemo)
# See also qhp.Qt.extraFiles
-extraimages.HTML = qt-logo.png \
- arrow_down.png \
- breadcrumb.png \
- bullet_gt.png \
- bullet_dn.png \
- bullet_sq.png \
- bullet_up.png \
- horBar.png \
- sprites-combined.png \
- bgrContent.png \
- blu_dot.png \
- btn_next.png \
- btn_prev.png \
- ico_note.png \
- ico_note_attention.png \
- ico_out.png \
- arrow_bc.png \
- home.png
+# for Qt 4:
+extraimages.HTML = ../templates/images/qt-logo.png \
+ ../templates/images/arrow_down.png \
+ ../templates/images/breadcrumb.png \
+ ../templates/images/bullet_gt.png \
+ ../templates/images/bullet_dn.png \
+ ../templates/images/bullet_sq.png \
+ ../templates/images/bullet_up.png \
+ ../templates/images/horBar.png \
+ ../templates/images/sprites-combined.png \
+ ../templates/images/bgrContent.png \
+ ../templates/images/blu_dot.png \
+ ../templates/images/btn_next.png \
+ ../templates/images/btn_prev.png \
+ ../templates/images/ico_note.png \
+ ../templates/images/ico_note_attention.png \
+ ../templates/images/ico_out.png \
+ ../templates/images/arrow_bc.png \
+ ../templates/images/home.png
+# for Qt 5
+HTML.extraimages = ../templates/images/qt-logo.png \
+ ../templates/images/arrow_down.png \
+ ../templates/images/breadcrumb.png \
+ ../templates/images/bullet_gt.png \
+ ../templates/images/bullet_dn.png \
+ ../templates/images/bullet_sq.png \
+ ../templates/images/bullet_up.png \
+ ../templates/images/horBar.png \
+ ../templates/images/sprites-combined.png \
+ ../templates/images/bgrContent.png \
+ ../templates/images/blu_dot.png \
+ ../templates/images/btn_next.png \
+ ../templates/images/btn_prev.png \
+ ../templates/images/ico_note.png \
+ ../templates/images/ico_note_attention.png \
+ ../templates/images/ico_out.png \
+ ../templates/images/arrow_bc.png \
+ ../templates/images/home.png
# Include the style sheets and scripts used.
diff --git a/doc/config/qt-html-online-styles.qdocconf b/doc/config/qt-html-online-styles.qdocconf
index a02f10731..56b05dd30 100644
--- a/doc/config/qt-html-online-styles.qdocconf
+++ b/doc/config/qt-html-online-styles.qdocconf
@@ -2,46 +2,76 @@
# specified relative to the template directory and will be copied into
# subdirectories of the output directory.
-HTML.templatedir = $SRCDIR/templates
+HTML.templatedir = $SRCDIR/config
-HTML.stylesheets = style/narrow.css \
- style/style.css \
- style/style_ie6.css \
- style/style_ie7.css \
- style/style_ie8.css \
- style/superfish.css
+HTML.stylesheets = ../templates/style/narrow.css \
+ ../templates/style/style.css \
+ ../templates/style/style_ie6.css \
+ ../templates/style/style_ie7.css \
+ ../templates/style/style_ie8.css \
+ ../templates/style/superfish.css
# Adding jquery and functions - providing online tools and search features
-HTML.scripts = scripts/functions.js \
- scripts/narrow.js \
- scripts/superfish.js \
- scripts/jquery.js
+HTML.scripts = ../templates/scripts/functions.js \
+ ../templates/scripts/narrow.js \
+ ../templates/scripts/superfish.js \
+ ../templates/scripts/jquery.js
# Files not referenced in any qdoc file.
# See also qhp.Qt.extraFiles
-extraimages.HTML = qt-logo.png \
- bg_l.png \
- bg_l_blank.png \
- bg_ll_blank.png \
- bg_ul_blank.png \
- btn_next_green.png \
- btn_prev_green.png \
- header_bg.png \
- bg_r.png \
- box_bg.png \
- breadcrumb.png \
- bullet_gt.png \
- bullet_dn.png \
- bullet_sq.png \
- bullet_up.png \
- arrow_down.png \
- feedbackground.png \
- horBar.png \
- page.png \
- page_bg.png \
- sprites-combined.png \
- spinner.gif
+# for Qt 4
+extraimages.HTML = ../templates/images/qt-logo.png \
+ ../templates/images/bg_l.png \
+ ../templates/images/bg_l_blank.png \
+ ../templates/images/bg_ll_blank.png \
+ ../templates/images/bg_ul_blank.png \
+ ../templates/images/btn_next_green.png \
+ ../templates/images/btn_prev_green.png \
+ ../templates/images/header_bg.png \
+ ../templates/images/bg_r.png \
+ ../templates/images/box_bg.png \
+ ../templates/images/breadcrumb.png \
+ ../templates/images/btn_next_green.png \
+ ../templates/images/btn_prev_green.png \
+ ../templates/images/bullet_gt.png \
+ ../templates/images/bullet_dn.png \
+ ../templates/images/bullet_sq.png \
+ ../templates/images/bullet_up.png \
+ ../templates/images/arrow_down.png \
+ ../templates/images/feedbackground.png \
+ ../templates/images/horBar.png \
+ ../templates/images/page.png \
+ ../templates/images/page_bg.png \
+ ../templates/images/sprites-combined.png \
+ ../templates/images/spinner.gif \
+ ../templates/images/qtcreator-screenshots.png
+# for Qt 5
+HTML.extraimages = ../templates/images/qt-logo.png \
+ ../templates/images/bg_l.png \
+ ../templates/images/bg_l_blank.png \
+ ../templates/images/bg_ll_blank.png \
+ ../templates/images/bg_ul_blank.png \
+ ../templates/images/btn_next_green.png \
+ ../templates/images/btn_prev_green.png \
+ ../templates/images/header_bg.png \
+ ../templates/images/bg_r.png \
+ ../templates/images/box_bg.png \
+ ../templates/images/breadcrumb.png \
+ ../templates/images/btn_next_green.png \
+ ../templates/images/btn_prev_green.png \
+ ../templates/images/bullet_gt.png \
+ ../templates/images/bullet_dn.png \
+ ../templates/images/bullet_sq.png \
+ ../templates/images/bullet_up.png \
+ ../templates/images/arrow_down.png \
+ ../templates/images/feedbackground.png \
+ ../templates/images/horBar.png \
+ ../templates/images/page.png \
+ ../templates/images/page_bg.png \
+ ../templates/images/sprites-combined.png \
+ ../templates/images/spinner.gif \
+ ../templates/images/qtcreator-screenshots.png
# Include the style sheets and scripts used.
diff --git a/doc/config/qt-html-templates-online.qdocconf b/doc/config/qt-html-templates-online.qdocconf
index 68dd2bea5..edea2655d 100644
--- a/doc/config/qt-html-templates-online.qdocconf
+++ b/doc/config/qt-html-templates-online.qdocconf
@@ -9,12 +9,11 @@ HTML.postheader = \
" <div id=\"narrowsearch\"></div>\n" \
" <div id=\"nav-topright\">\n" \
" <ul>\n" \
- " <li class=\"nav-topright-home\"><a href=\"http://qt.nokia.com/\">Qt HOME</a></li>\n" \
- " <li class=\"nav-topright-dev\"><a href=\"http://qt-project.org/\">DEV</a></li>\n" \
- " <li class=\"nav-topright-labs\"><a href=\"http://labs.qt.nokia.com/blogs/\">LABS</a></li>\n" \
+ " <li class=\"nav-topright-home\"><a href=\"http://qt.digia.com/\">Qt HOME</a></li>\n" \
+ " <li class=\"nav-topright-dev\"><a href=\"http://wiki.qt-project.org/\">DEV</a></li>\n" \
" <li class=\"nav-topright-doc nav-topright-doc-active\"><a href=\"http://qt-project.org/doc/\">\n" \
" DOC</a></li>\n" \
- " <li class=\"nav-topright-blog\"><a href=\"http://blog.qt.nokia.com/\">BLOG</a></li>\n" \
+ " <li class=\"nav-topright-blog\"><a href=\"http://blog.qt.digia.com/\">BLOG</a></li>\n" \
" </ul>\n" \
" </div>\n" \
" <div id=\"shortCut\">\n" \
@@ -103,7 +102,8 @@ HTML.footer = \
" <span></span>\n" \
" </div>\n" \
" </div> \n" \
- "<div class=\"footer\">\n" \
+ " <div class=\"footer\">\n" \
+ " <p>\n" \
" <p>\n" \
" <acronym title=\"Copyright\">&copy;</acronym> 2013 Digia Plc and/or its\n" \
" subsidiaries. Documentation contributions included herein are the copyrights of\n" \
@@ -122,8 +122,8 @@ HTML.footer = \
" in Finland and/or other countries worldwide. All other trademarks are property\n" \
" of their respective owners. <a title=\"Privacy Policy\"\n" \
" href=\"http://en.gitorious.org/privacy_policy/\">Privacy Policy</a></p>\n" \
- "</div>\n" \
- "\n" \
+ " </div>\n" \
+ "\n" \
" <script src=\"scripts/functions.js\" type=\"text/javascript\"></script>\n" \
" <script type=\"text/javascript\">\n" \
" var _gaq = _gaq || [];\n" \
diff --git a/doc/config/qt-html-templates.qdocconf b/doc/config/qt-html-templates.qdocconf
index 53215b761..2110b688c 100644
--- a/doc/config/qt-html-templates.qdocconf
+++ b/doc/config/qt-html-templates.qdocconf
@@ -45,7 +45,7 @@ HTML.footer = \
# Files not referenced in any qdoc file.
# See also extraimages.HTML
-qhp.QtCreator.extraFiles = index.html \
+qhp.InstallerFramework.extraFiles = index.html \
images/arrow_down.png \
images/breadcrumb.png \
images/bullet_gt.png \
@@ -62,5 +62,5 @@ qhp.QtCreator.extraFiles = index.html \
images/ico_note_attention.png \
images/ico_out.png \
images/home.png \
- images/arrow.png \
+ images/arrow_bc.png \
style/offline.css
diff --git a/doc/doc.pri b/doc/doc.pri
index 974013761..03bd125aa 100644
--- a/doc/doc.pri
+++ b/doc/doc.pri
@@ -1,20 +1,28 @@
# Adapted from doc/doc.pri in Qt Creator.
-QDOC_BIN = $$[QT_INSTALL_BINS]/qdoc3
+greaterThan(QT_MAJOR_VERSION, 4) {
+ QDOC_BIN = $$[QT_INSTALL_BINS]/qdoc
+} else {
+ QDOC_BIN = $$[QT_INSTALL_BINS]/qdoc3
+}
win32:QDOC_BIN = $$replace(QDOC_BIN, "/", "\\")
unix {
- QDOC = SRCDIR=$$PWD OUTDIR=$$OUT_PWD/doc/html QT_MOBILITY_SOURCE_PATH=$$QT_MOBILITY_SOURCE_PATH $$QDOC_BIN
+ QDOC = SRCDIR=$$PWD OUTDIR=$$OUT_PWD/doc/html $$QDOC_BIN
HELPGENERATOR = $$[QT_INSTALL_BINS]/qhelpgenerator
} else {
- QDOC = set SRCDIR=$$PWD&& set OUTDIR=$$OUT_PWD/doc/html&& set QT_MOBILITY_SOURCE_PATH=$$QT_MOBILITY_SOURCE_PATH&& $$QDOC_BIN
+ QDOC = set SRCDIR=$$PWD&& set OUTDIR=$$OUT_PWD/doc/html&& $$QDOC_BIN
# Always run qhelpgenerator inside its own cmd; this is a workaround for
# an unusual bug which causes qhelpgenerator.exe to do nothing
HELPGENERATOR = cmd /C $$replace($$list($$[QT_INSTALL_BINS]/qhelpgenerator.exe), "/", "\\")
}
-QHP_FILE = $$OUT_PWD/doc/html/installerfw.qhp
-QCH_FILE = $$OUT_PWD/doc/installerfw.qch
+greaterThan(QT_MAJOR_VERSION, 4) {
+ HELPGENERATOR = $$HELPGENERATOR -platform minimal
+}
+
+QHP_FILE = $$OUT_PWD/doc/html/ifw.qhp
+QCH_FILE = $$OUT_PWD/doc/ifw.qch
HELP_DEP_FILES = $$PWD/installerfw.qdoc \
$$PWD/scripting.qdoc \
diff --git a/doc/images/arrow.png b/doc/images/arrow.png
new file mode 100644
index 000000000..f2a83a574
--- /dev/null
+++ b/doc/images/arrow.png
Binary files differ
diff --git a/doc/templates/images/qt-logo.png b/doc/templates/images/qt-logo.png
new file mode 100644
index 000000000..3e2e480b3
--- /dev/null
+++ b/doc/templates/images/qt-logo.png
Binary files differ
diff --git a/doc/templates/scripts/functions.js b/doc/templates/scripts/functions.js
index 32cc901fe..a5c22d449 100644
--- a/doc/templates/scripts/functions.js
+++ b/doc/templates/scripts/functions.js
@@ -51,9 +51,9 @@ $('.feedback').click(function() {
var lookupCount = 0;
var articleCount = 0;
var exampleCount = 0;
-var qturl = ""; // change from "http://doc.qt.nokia.com/4.6/" to 0 so we can have relative links
+var qturl = ""; // change from "http://doc.qt.digia.com/4.6/" to 0 so we can have relative links
-function processNokiaData(response){
+function processData(response){
var propertyTags = response.getElementsByTagName('page');
for (var i=0; i< propertyTags.length; i++) {
@@ -180,7 +180,7 @@ else
$('.searching').remove();
$('#pageType').removeClass('loading');
$('.list ul').prepend('<li class="menuAlert searching">Searching...</li>');
- processNokiaData(response);
+ processData(response);
}
});
diff --git a/doc/templates/style/narrow.css b/doc/templates/style/narrow.css
index de5b0a09f..c78260275 100644
--- a/doc/templates/style/narrow.css
+++ b/doc/templates/style/narrow.css
@@ -187,7 +187,7 @@
}
.narrow #narrowsearch {
- background: url("http://doc.qt.nokia.com/prototype/html/images/sprites-combined.png") no-repeat scroll -6px -348px transparent;
+ background: url("http://doc.qt.digia.com/prototype/html/images/sprites-combined.png") no-repeat scroll -6px -348px transparent;
height: 21px;
padding: 2px 0 0 5px;
width: 167px;
diff --git a/doc/templates/style/offline.css b/doc/templates/style/offline.css
index c59c1ff80..ce2d67db7 100644
--- a/doc/templates/style/offline.css
+++ b/doc/templates/style/offline.css
@@ -487,6 +487,11 @@ border-top: 1px solid #999;
padding-top:11px;
}
+.footer a[href*="http://"], a[href*="ftp://"],a[href*="https://"]{
+background-size: 13px 11px;
+padding-left: 16px;
+}
+
.footerNavi{
width:auto;
text-align:right;