aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDaniel Molkentin <daniel.molkentin@nokia.com>2010-06-15 14:45:14 +0200
committercon <qtc-committer@nokia.com>2010-06-17 12:13:37 +0200
commit7f3e4db6d82d1f409a6be2077ff05c10efcf5443 (patch)
treeec76694235ed3c533a5b35642ff168c8ad4e07c8
parent52709fed0445d0fb14488fa207cb973c29d27680 (diff)
Sync doc style with Qt, introduce online version (make docs_online)
The spacing errors come from Qt, and should be fixed there. Reviewed-By: Oswald Buddenhagen (cherry picked from commit c7db4a09c8c3cb5de203a3f2d9e43d690b67e73a)
-rw-r--r--doc/doc.pri22
-rw-r--r--doc/qt-defines.qdocconf77
-rw-r--r--doc/qt-html-templates.qdocconf38
-rw-r--r--doc/qtcreator-online.qdocconf4
-rw-r--r--doc/qtcreator.qdocconf17
-rw-r--r--doc/templates/images/arrow_down.pngbin0 -> 177 bytes
-rw-r--r--doc/templates/images/header_bg.pngbin0 -> 114 bytes
-rw-r--r--doc/templates/images/page.pngbin0 -> 3102 bytes
-rw-r--r--doc/templates/images/spinner.gifbin0 -> 2037 bytes
-rw-r--r--doc/templates/style/style.css2
10 files changed, 80 insertions, 80 deletions
diff --git a/doc/doc.pri b/doc/doc.pri
index b4c8800f63..c161582f7f 100644
--- a/doc/doc.pri
+++ b/doc/doc.pri
@@ -15,10 +15,20 @@ equals(QMAKE_DIR_SEP, /) { # unix, mingw+msys
QHP_FILE = $$OUT_PWD/doc/html/qtcreator.qhp
QCH_FILE = $$IDE_DOC_PATH/qtcreator.qch
+HELP_DEP_FILES = $$PWD/qtcreator.qdoc \
+ $$PWD/addressbook-sdk.qdoc \
+ $$PWD/qt-defines.qdocconf \
+ $$PWD/qt-html-templates.qdocconf \
+ $$PWD/qtcreator.qdocconf \
+ $$PWD/qtcreator-online.qdocconf
+
html_docs.commands = $$QDOC $$PWD/qtcreator.qdocconf
-html_docs.depends += $$PWD/qtcreator.qdoc $$PWD/qtcreator.qdocconf
+html_docs.depends += $$HELP_DEP_FILES
html_docs.files = $$QHP_FILE
+html_docs_online.commands = $$QDOC $$PWD/qtcreator-online.qdocconf
+html_docs_online.depends += $$HELP_DEP_FILES
+
qch_docs.commands = $$HELPGENERATOR -o \"$$QCH_FILE\" $$QHP_FILE
qch_docs.depends += html_docs
qch_docs.files = $$QCH_FILE
@@ -29,10 +39,10 @@ unix:!macx {
INSTALLS += qch_docs
}
+docs_online.depends = html_docs_online
docs.depends = qch_docs
-QMAKE_EXTRA_TARGETS += html_docs qch_docs docs
+QMAKE_EXTRA_TARGETS += html_docs html_docs_online qch_docs docs docs_online
-OTHER_FILES = $$PWD/qtcreator.qdoc \
- $$PWD/qtcreator.qdocconf
-OTHER_FILES += $$PWD/api/qtcreator-api.qdoc \
- $$PWD/api/qtcreator-api.qdocconf
+OTHER_FILES = $$HELP_DEP_FILES \
+ $$PWD/api/qtcreator-api.qdoc \
+ $$PWD/api/qtcreator-api.qdocconf
diff --git a/doc/qt-defines.qdocconf b/doc/qt-defines.qdocconf
index f3239272c7..67d8e0348c 100644
--- a/doc/qt-defines.qdocconf
+++ b/doc/qt-defines.qdocconf
@@ -20,53 +20,46 @@ codeindent = 1
# See also qhp.Qt.extraFiles
extraimages.HTML = qt-logo \
trolltech-logo \
- api_examples.png \
- bg_ll.png \
- bg_ul_blank.png \
- bullet_gt.png \
- horBar.png \
- qt_ref_doc.png \
- api_lookup.png \
- bg_ll_blank.png \
- bg_ur.png \
- bullet_sq.png \
- bullet_dn.png \
- bullet_up.png \
- page_bg.png \
- qt_tools.png \
- api_topics.png \
- bg_lr.png \
- bg_ur_blank.png \
- content_bg.png \
- print.png \
- sep.png \
- bg_l.png \
- bg_r.png \
- box_bg.png \
- feedbackground.png \
- qt_guide.png \
- sprites-combined.png \
- bg_l_blank.png \
- bg_ul.png \
- breadcrumb.png \
- form_bg.png \
- qt_icon.png \
- header.png \
- qtcreator-screenshots.png \
- taskmenuextension-example.png \
- coloreditorfactoryimage.png \
- dynamiclayouts-example.png \
- stylesheet-coffee-plastique.png
+ api_examples.png \
+ api_lookup.png \
+ arrow_down.png \
+ bg_ll.png \
+ bg_l.png \
+ bg_lr.png \
+ bg_r.png \
+ bg_ul_blank.png \
+ bg_ll_blank.png \
+ bg_l_blank.png \
+ breadcrumb.png \
+ bullet_dn.png \
+ bullet_gt.png \
+ bullet_sq.png \
+ box_bg.png \
+ feedbackground.png \
+ horBar.png \
+ page_bg.png \
+ sprites-combined.png \
+ qtcreator-screenshots.png
# This stuff is used by the new doc format.
scriptdirs = $SRCDIR/templates/scripts
styledirs = $SRCDIR/templates/style
scripts.HTML = functions.js \
+ shBrushCpp.js \
+ shCore.js \
+ shLegacy.js \
+ narrow.js \
+ superfish.js \
jquery.js
-styles.HTML = OfflineStyle.css \
- style.css \
- style_ie6.css \
- style_ie7.css \
- style_ie8.css
+styles.HTML = style.css \
+ shCore.css \
+ shThemeDefault.css \
+ narrow.css \
+ superfish.css \
+ superfish_skin.css \
+ OfflineStyle.css \
+ style_ie6.css \
+ style_ie7.css \
+ style_ie8.css
diff --git a/doc/qt-html-templates.qdocconf b/doc/qt-html-templates.qdocconf
index edc75f1aa2..0f7ec3e94b 100644
--- a/doc/qt-html-templates.qdocconf
+++ b/doc/qt-html-templates.qdocconf
@@ -1,8 +1,8 @@
HTML.stylesheets = style/style.css \
- style/OfflineStyle.css \
- style/style_ie7.css \
- style/style_ie8.css \
- style/style_ie6.css
+ style/OfflineStyle.css \
+ style/style_ie7.css \
+ style/style_ie8.css \
+ style/style_ie6.css
HTML.postheader = " <div class=\"header\" id=\"qtdocheader\">\n" \
" <div class=\"content\"> \n" \
@@ -54,12 +54,12 @@ HTML.postheader = " <div class=\"header\" id=\"qtdocheader\">\n" \
" API Lookup</h2>\n" \
" <div id=\"list001\" class=\"list\">\n" \
" <ul id=\"ul001\" >\n" \
- " <li class=\"defaultLink\"><a href=\"classes.html\">Class index</a></li>\n" \
- " <li class=\"defaultLink\"><a href=\"functions.html\">Function index</a></li>\n" \
- " <li class=\"defaultLink\"><a href=\"modules.html\">Modules</a></li>\n" \
- " <li class=\"defaultLink\"><a href=\"namespaces.html\">Namespaces</a></li>\n" \
- " <li class=\"defaultLink\"><a href=\"qtglobal.html\">Global stuff</a></li>\n" \
- " <li class=\"defaultLink\"><a href=\"qdeclarativeelements.html\">QML elements</a></li>\n" \
+ " <li class=\"defaultLink\"><a href=\"http://doc.qt.nokia.com/latest/classes.html\">Class index</a></li>\n" \
+ " <li class=\"defaultLink\"><a href=\"http://doc.qt.nokia.com/latest/functions.html\">Function index</a></li>\n" \
+ " <li class=\"defaultLink\"><a href=\"http://doc.qt.nokia.com/latest/modules.html\">Modules</a></li>\n" \
+ " <li class=\"defaultLink\"><a href=\"http://doc.qt.nokia.com/latest/namespaces.html\">Namespaces</a></li>\n" \
+ " <li class=\"defaultLink\"><a href=\"http://doc.qt.nokia.com/latest/qtglobal.html\">Global stuff</a></li>\n" \
+ " <li class=\"defaultLink\"><a href=\"http://doc.qt.nokia.com/latest/qdeclarativeelements.html\">QML elements</a></li>\n" \
" </ul> \n" \
" </div>\n" \
" </div>\n" \
@@ -68,10 +68,10 @@ HTML.postheader = " <div class=\"header\" id=\"qtdocheader\">\n" \
" Qt Topics</h2>\n" \
" <div id=\"list002\" class=\"list\">\n" \
" <ul id=\"ul002\" >\n" \
- " <li class=\"defaultLink\"><a href=\"qt-basic-concepts.html\">Basic Qt architecture</a></li>\n" \
- " <li class=\"defaultLink\"><a href=\"declarativeui.html\">Device UI's &amp; Qt Quick</a></li>\n" \
- " <li class=\"defaultLink\"><a href=\"qt-gui-concepts.html\">Desktop UI components</a></li>\n" \
- " <li class=\"defaultLink\"><a href=\"platform-specific.html\">Platform-specific info</a></li>\n" \
+ " <li class=\"defaultLink\"><a href=\"http://doc.qt.nokia.com/latest/qt-basic-concepts.html\">Basic Qt architecture</a></li>\n" \
+ " <li class=\"defaultLink\"><a href=\"http://doc.qt.nokia.com/latest/declarativeui.html\">Device UI's &amp; Qt Quick</a></li>\n" \
+ " <li class=\"defaultLink\"><a href=\"http://doc.qt.nokia.com/latest/qt-gui-concepts.html\">Desktop UI components</a></li>\n" \
+ " <li class=\"defaultLink\"><a href=\"http://doc.qt.nokia.com/latest/platform-specific.html\">Platform-specific info</a></li>\n" \
" </ul> \n" \
" </div>\n" \
" </div>\n" \
@@ -80,11 +80,11 @@ HTML.postheader = " <div class=\"header\" id=\"qtdocheader\">\n" \
" Examples</h2>\n" \
" <div id=\"list003\" class=\"list\">\n" \
" <ul id=\"ul003\">\n" \
- " <li class=\"defaultLink\"><a href=\"all-examples.html\">Examples</a></li>\n" \
- " <li class=\"defaultLink\"><a href=\"tutorials.html\">Tutorials</a></li>\n" \
- " <li class=\"defaultLink\"><a href=\"demos.html\">Demos</a></li>\n" \
- " <li class=\"defaultLink\"><a href=\"qdeclarativeexamples.html\">QML Examples</a></li>\n" \
- " <li class=\"defaultLink\"><a href=\"qdeclarativeexamples.html#Demos\">QML Demos</a></li>\n" \
+ " <li class=\"defaultLink\"><a href=\"http://doc.qt.nokia.com/latest/all-examples.html\">Examples</a></li>\n" \
+ " <li class=\"defaultLink\"><a href=\"http://doc.qt.nokia.com/latest/tutorials.html\">Tutorials</a></li>\n" \
+ " <li class=\"defaultLink\"><a href=\"http://doc.qt.nokia.com/latest/demos.html\">Demos</a></li>\n" \
+ " <li class=\"defaultLink\"><a href=\"http://doc.qt.nokia.com/latest/qdeclarativeexamples.html\">QML Examples</a></li>\n" \
+ " <li class=\"defaultLink\"><a href=\"http://doc.qt.nokia.com/latest/qdeclarativeexamples.html#Demos\">QML Demos</a></li>\n" \
" </ul> \n" \
" </div>\n" \
" </div>\n" \
diff --git a/doc/qtcreator-online.qdocconf b/doc/qtcreator-online.qdocconf
new file mode 100644
index 0000000000..adfa30760b
--- /dev/null
+++ b/doc/qtcreator-online.qdocconf
@@ -0,0 +1,4 @@
+online = true
+# Run qdoc from the directory that contains this file.
+include(qtcreator.qdocconf)
+
diff --git a/doc/qtcreator.qdocconf b/doc/qtcreator.qdocconf
index 02624c66c6..bded10f86a 100644
--- a/doc/qtcreator.qdocconf
+++ b/doc/qtcreator.qdocconf
@@ -38,30 +38,23 @@ qhp.QtCreator.extraFiles = \
scripts/jquery.js \
images/api_examples.png \
images/api_lookup.png \
- images/api_topics.png \
+ images/arrow_down.png \
images/bg_ll.png \
- images/bg_l_blank.png \
images/bg_l.png \
images/bg_lr.png \
images/bg_r.png \
images/bg_ul_blank.png \
- images/bg_ul.png \
- images/bg_ur_blank.png \
- images/bg_ur.png \
+ images/bg_ll_blank.png \
+ images/bg_l_blank.png \
images/breadcrumb.png \
images/bullet_dn.png \
images/bullet_gt.png \
+ images/bullet_sq.png \
+ images/box_bg.png \
images/feedbackground.png \
- images/form_bg.png \
images/horBar.png \
images/page_bg.png \
- images/print.png \
- images/qt_guide.png \
images/qt-logo.png \
- images/qt_ref_doc.png \
- images/qt_tools.png \
- images/sep.png \
- images/header.png \
images/sprites-combined.png
# macros.qdocconf
diff --git a/doc/templates/images/arrow_down.png b/doc/templates/images/arrow_down.png
new file mode 100644
index 0000000000..9d01e97f6a
--- /dev/null
+++ b/doc/templates/images/arrow_down.png
Binary files differ
diff --git a/doc/templates/images/header_bg.png b/doc/templates/images/header_bg.png
new file mode 100644
index 0000000000..a436aa61ef
--- /dev/null
+++ b/doc/templates/images/header_bg.png
Binary files differ
diff --git a/doc/templates/images/page.png b/doc/templates/images/page.png
new file mode 100644
index 0000000000..1db151bd31
--- /dev/null
+++ b/doc/templates/images/page.png
Binary files differ
diff --git a/doc/templates/images/spinner.gif b/doc/templates/images/spinner.gif
new file mode 100644
index 0000000000..1ed786f2ec
--- /dev/null
+++ b/doc/templates/images/spinner.gif
Binary files differ
diff --git a/doc/templates/style/style.css b/doc/templates/style/style.css
index 47fe2e0a04..28d558f847 100644
--- a/doc/templates/style/style.css
+++ b/doc/templates/style/style.css
@@ -678,7 +678,7 @@
padding-left: 3px;
background: transparent url( ../images/sprites-combined.png) no-repeat 0px -58px;
height: 20px;
- width: 47px;
+ width: 110px;
}
.shortCut-topleft-inactive span
{