Skip to content
Snippets Groups Projects
Commit f6c6bcca authored by Kavindra Palaraja's avatar Kavindra Palaraja
Browse files

Fixes: Doc - making sure all the pages are linked from one to the other 

Details:  The non-continouous links were reported recently. All fixed now :)
parent aa81df02
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 196 additions and 191 deletions
doc/qtcreator.qdoc
+ 196
− 191
View file @ f6c6bcca
...@@ -52,6 +52,7 @@ ...@@ -52,6 +52,7 @@
\o \l{The Code Editor} \o \l{The Code Editor}
\o \l{Build Settings} \o \l{Build Settings}
\o \l{Qt Version Management} \o \l{Qt Version Management}
\o \l{Creating a Project in Qt Creator}
\o \l{Writing a Simple Program with Qt Creator} \o \l{Writing a Simple Program with Qt Creator}
\o \l{Qt Creator and Version Control Systems} \o \l{Qt Creator and Version Control Systems}
\o \l{Navigating Quickly Around Your Code with Locator} \o \l{Navigating Quickly Around Your Code with Locator}
...@@ -70,7 +71,7 @@ ...@@ -70,7 +71,7 @@
/*! /*!
\contentspage index.html \contentspage index.html
\page creator-quick-tour.html \page creator-quick-tour.html
\nextpage creator-build-settings.html \nextpage creator-code-editor.html
\title A Quick Tour of Qt Creator \title A Quick Tour of Qt Creator
...@@ -293,7 +294,7 @@ ...@@ -293,7 +294,7 @@
\contentspage index.html \contentspage index.html
\previouspage creator-code-editor.html \previouspage creator-code-editor.html
\page creator-build-settings.html \page creator-build-settings.html
\nextpage creator-creating-project.html \nextpage creator-version-management.html
\title Build Settings \title Build Settings
...@@ -392,7 +393,7 @@ ...@@ -392,7 +393,7 @@
/*! /*!
\contentspage index.html \contentspage index.html
\previouspage creator-quick-tour.html \previouspage creator-version-management.html
\page creator-creating-project.html \page creator-creating-project.html
\nextpage creator-writing-program.html \nextpage creator-writing-program.html
...@@ -459,7 +460,7 @@ ...@@ -459,7 +460,7 @@
\contentspage index.html \contentspage index.html
\previouspage creator-creating-project.html \previouspage creator-creating-project.html
\page creator-writing-program.html \page creator-writing-program.html
\nextpage creator-navigation.html \nextpage creator-version-control.html
\title Writing a Simple Program with Qt Creator \title Writing a Simple Program with Qt Creator
...@@ -668,132 +669,8 @@ ...@@ -668,132 +669,8 @@
/*! /*!
\contentspage index.html \contentspage index.html
\previouspage creator-writing-program.html \previouspage creator-writing-program.html
\page creator-navigation.html
\nextpage creator-debugging.html
\title Navigating Quickly Around Your Code with Locator
With Qt Creator, navigating to different locations in your project or on
your disk, e.g., files, classes, methods, etc., is trivial using
\gui Locator -- a smart line edit at the bottom left of Qt Creator's
window.
\image qtcreator-locator.png
Suppose you would like to open your project's \c{main.cpp} file, click on
\gui Locator or use \key{Ctrl+K}, type in the file name and then press
\key Return. The file will be opened in the editor. You can also type
part of a file name and use wildcard characters \c{*} and \c{?} to match
\e{any} number of \e{any} characters. A list of all files matching your
criteria will be displayed.
\gui Locator not only allows you to navigate files on disk but also other
"locations", which are organized with \bold{Filters}. Currently there are
filters for:
\list
\o files anywhere on your hard disk (browsing through the file system),
\o files from a subdirectory structure defined by you,
\o files mentioned in your \c{.pro} files, such as source, header,
resource, and \c{.ui} files,
\o any open document,
\o class and method definitions in your project or anywhere referenced
from your project,
\o help topics, including Qt's documentation, and,
\o a specific line in the document displayed on your editor,
\endlist
Some of these filters require you to activate them by typing an assigned
\e prefix. This prefix is usually a single character followed by
\key{Space}. For example, to jump to the definition of the class
\l{http://doc.trolltech.com/qdatastream.html}{QDataStream}, type:
\key{Ctrl+K} to activate \gui Locator. Then type colon (\key{:}) followed
by \key{Space} and the class name.
Below is a full list of \l{http://doc.trolltech.com/qdatastream.html}
{QDataStream} related output:
\image qtcreator-navigate-popup.png
Filters can be added to provide quick navigation around files in a
subdirectory structure defined by you. This way, you can acccess files you
need, that are not directly mentioned in your project. Click on
\image qtcreator-locator-magnify.png
and choose \gui{Configure...} from the menu displayed.
\image qtcreator-locator-customize.png
This then displays the \gui Preferences dialog (\gui Options on Mac Os X)
for navigation filters. Click \gui Add to create a new filter. In the
\gui{Filter Configuration} dialog below, give your filter a name, select
your preferred directories, set file patterns with a comma separated list,
and specify a prefix string.
\image qtcreator-navigate-customfilter.png
After closing this dialog, \gui Locator will search the directories you
selected for files matching your file patterns, and the information will be
cached. Click \gui Refresh from the menu above to update the cached
information.
The following table lists the filters currently available:
\table
\header
\o Function
\o Key Combination
\o Screenshot
\row
\o Go to a line in the current document
\o Ctrl+K, l, Space, and the line number
\o \image qtcreator-locator-line.png
\row
\o Go to a symbol definition
\o Ctrl+K, :, Space, and the function name
\o \image qtcreator-locator-symbols.png
\row
\o Go to a help topic
\o Ctrl+K, ?, Space, and the topic
\o \image qtcreator-locator-help.png
\row
\o Go to an opened document
\o Ctrl+K, o, Space, and the document name.
\o \image qtcreator-locator-opendocs.png
\row
\o Go to a file in the file system (browse the file system)
\o Ctrl+K, f, Space, and the file name.
\o \image qtcreator-locator-filesystem.png
\row
\o Go to a file in any project currently loaded
\o Ctrl+K, a, Space, and the function name.
\o \image qtcreator-locator-files.png
\row
\o Go to a file in the current project
\o Ctrl+K, p, Space, and the function name.
\o \image qtcreator-locator-current-project.png
\row
\o Go to a class definition
\o Ctrl+K, c, Space, and the class name.
\o \image qtcreator-locator-classes.png
\row
\o Go to a method definition
\o Ctrl+K, m, Space, and the class name.
\o \image qtcreator-locator-methods.png
\endtable
\note By default, if you press \key{Ctrl+K} and do not use a prefix to
specify a filter, three filters will be enabled: \c{o}, \c{l}, and \c{a}.
*/
/*!
\contentspage index.html
\previouspage creator-navigation.html
\page creator-version-control.html \page creator-version-control.html
\nextpage creator-debugging.html \nextpage creator-navigation.html
\title Qt Creator and Version Control Systems \title Qt Creator and Version Control Systems
...@@ -816,7 +693,7 @@ ...@@ -816,7 +693,7 @@
Qt Creator uses the version control system's command line clients to Qt Creator uses the version control system's command line clients to
access your repositories. To set it up, you must ensure that these command access your repositories. To set it up, you must ensure that these command
line clients can be located via the \c{PATH} environment variable. You can line clients can be located via the \c{PATH} environment variable. You can
specify the path to the command line client's executable in the settings specify the path to the command line client's executable in the settings
pages that can be found under \gui{Options...} in the \gui{Tools} menu. pages that can be found under \gui{Options...} in the \gui{Tools} menu.
...@@ -920,6 +797,131 @@ ...@@ -920,6 +797,131 @@
*/ */
/*!
\contentspage index.html
\previouspage creator-version-control.html
\page creator-navigation.html
\nextpage creator-debugging.html
\title Navigating Quickly Around Your Code with Locator
With Qt Creator, navigating to different locations in your project or on
your disk, e.g., files, classes, methods, etc., is trivial using
\gui Locator -- a smart line edit at the bottom left of Qt Creator's
window.
\image qtcreator-locator.png
Suppose you would like to open your project's \c{main.cpp} file, click on
\gui Locator or use \key{Ctrl+K}, type in the file name and then press
\key Return. The file will be opened in the editor. You can also type
part of a file name and use wildcard characters \c{*} and \c{?} to match
\e{any} number of \e{any} characters. A list of all files matching your
criteria will be displayed.
\gui Locator not only allows you to navigate files on disk but also other
"locations", which are organized with \bold{Filters}. Currently there are
filters for:
\list
\o files anywhere on your hard disk (browsing through the file system),
\o files from a subdirectory structure defined by you,
\o files mentioned in your \c{.pro} files, such as source, header,
resource, and \c{.ui} files,
\o any open document,
\o class and method definitions in your project or anywhere referenced
from your project,
\o help topics, including Qt's documentation, and,
\o a specific line in the document displayed on your editor,
\endlist
Some of these filters require you to activate them by typing an assigned
\e prefix. This prefix is usually a single character followed by
\key{Space}. For example, to jump to the definition of the class
\l{http://doc.trolltech.com/qdatastream.html}{QDataStream}, type:
\key{Ctrl+K} to activate \gui Locator. Then type colon (\key{:}) followed
by \key{Space} and the class name.
Below is a full list of \l{http://doc.trolltech.com/qdatastream.html}
{QDataStream} related output:
\image qtcreator-navigate-popup.png
Filters can be added to provide quick navigation around files in a
subdirectory structure defined by you. This way, you can acccess files you
need, that are not directly mentioned in your project. Click on
\image qtcreator-locator-magnify.png
and choose \gui{Configure...} from the menu displayed.
\image qtcreator-locator-customize.png
This then displays the \gui Preferences dialog (\gui Options on Mac Os X)
for navigation filters. Click \gui Add to create a new filter. In the
\gui{Filter Configuration} dialog below, give your filter a name, select
your preferred directories, set file patterns with a comma separated list,
and specify a prefix string.
\image qtcreator-navigate-customfilter.png
After closing this dialog, \gui Locator will search the directories you
selected for files matching your file patterns, and the information will be
cached. Click \gui Refresh from the menu above to update the cached
information.
The following table lists the filters currently available:
\table
\header
\o Function
\o Key Combination
\o Screenshot
\row
\o Go to a line in the current document
\o Ctrl+K, l, Space, and the line number
\o \image qtcreator-locator-line.png
\row
\o Go to a symbol definition
\o Ctrl+K, :, Space, and the function name
\o \image qtcreator-locator-symbols.png
\row
\o Go to a help topic
\o Ctrl+K, ?, Space, and the topic
\o \image qtcreator-locator-help.png
\row
\o Go to an opened document
\o Ctrl+K, o, Space, and the document name.
\o \image qtcreator-locator-opendocs.png
\row
\o Go to a file in the file system (browse the file system)
\o Ctrl+K, f, Space, and the file name.
\o \image qtcreator-locator-filesystem.png
\row
\o Go to a file in any project currently loaded
\o Ctrl+K, a, Space, and the function name.
\o \image qtcreator-locator-files.png
\row
\o Go to a file in the current project
\o Ctrl+K, p, Space, and the function name.
\o \image qtcreator-locator-current-project.png
\row
\o Go to a class definition
\o Ctrl+K, c, Space, and the class name.
\o \image qtcreator-locator-classes.png
\row
\o Go to a method definition
\o Ctrl+K, m, Space, and the class name.
\o \image qtcreator-locator-methods.png
\endtable
\note By default, if you press \key{Ctrl+K} and do not use a prefix to
specify a filter, three filters will be enabled: \c{o}, \c{l}, and \c{a}.
*/
/*! /*!
\contentspage index.html \contentspage index.html
\previouspage creator-navigation.html \previouspage creator-navigation.html
...@@ -1233,7 +1235,7 @@ ...@@ -1233,7 +1235,7 @@
\contentspage index.html \contentspage index.html
\previouspage creator-debugging.html \previouspage creator-debugging.html
\page creator-tips.html \page creator-tips.html
\nextpage creator-glossary.html \nextpage creator-keyboard-shortcuts.html
\title Tips and Tricks \title Tips and Tricks
...@@ -1281,67 +1283,8 @@ ...@@ -1281,67 +1283,8 @@
/*! /*!
\contentspage index.html \contentspage index.html
\previouspage creator-tips.html \previouspage creator-tips.html
\page creator-glossary.html
\nextpage creator-known-issues.html
\title Glossary
\table
\header
\o Term
\o Meaning
\row
\o
\raw HTML
System Qt
\endraw
\target glossary-system-qt
\o The version of Qt installed on your system. This is the Qt
version for the \c qmake command found in your \c PATH.
\row
\o
\raw HTML
Default Qt
\endraw
\target glossary-default-qt
\o The version of Qt configured in \gui{Tools -> Options -> Qt 4
-> Default Qt Version}. This is the Qt version used by your
new projects. It defaults to System Qt.
\row
\o
\raw HTML
Project Qt
\endraw
\target glossary-project-qt
\o The version of Qt configured in \gui{Build&Run -> Build
Settings -> Build Configurations}. This is the Qt version that
is actually used by a particular project. It defaults to
Default Qt.
\row
\o
\raw HTML
Shadow Build
\endraw
\target glossary-shadow-build
\o Shadow building means building a project in a separate
directory, the \e{build directory}. The build directory is
different from the source directory. One of the benefits of
shadow building is that it keeps your source directory clean.
Shadow building is the best practice if you need many build
configurations for a single set of source.
\endtable
*/
/*!
\contentspage index.html
\previouspage creator-glossary.html
\page creator-keyboard-shortcuts.html \page creator-keyboard-shortcuts.html
\nextpage creator-glossary.html
\title Keyboard Shortcuts \title Keyboard Shortcuts
...@@ -1420,7 +1363,68 @@ ...@@ -1420,7 +1363,68 @@
/*! /*!
\contentspage index.html \contentspage index.html
\previouspage creator-keyboard-shortcuts.html \previouspage creator-keyboard-shortcuts.html
\page creator-glossary.html
\nextpage creator-supported-platforms.html
\title Glossary
\table
\header
\o Term
\o Meaning
\row
\o
\raw HTML
System Qt
\endraw
\target glossary-system-qt
\o The version of Qt installed on your system. This is the Qt
version for the \c qmake command found in your \c PATH.
\row
\o
\raw HTML
Default Qt
\endraw
\target glossary-default-qt
\o The version of Qt configured in \gui{Tools -> Options -> Qt 4
-> Default Qt Version}. This is the Qt version used by your
new projects. It defaults to System Qt.
\row
\o
\raw HTML
Project Qt
\endraw
\target glossary-project-qt
\o The version of Qt configured in \gui{Build&Run -> Build
Settings -> Build Configurations}. This is the Qt version that
is actually used by a particular project. It defaults to
Default Qt.
\row
\o
\raw HTML
Shadow Build
\endraw
\target glossary-shadow-build
\o Shadow building means building a project in a separate
directory, the \e{build directory}. The build directory is
different from the source directory. One of the benefits of
shadow building is that it keeps your source directory clean.
Shadow building is the best practice if you need many build
configurations for a single set of source.
\endtable
*/
/*!
\contentspage index.html
\previouspage creator-glossary.html
\page creator-supported-platforms.html \page creator-supported-platforms.html
\nextpage creator-known-issues.html
\title Supported Platforms \title Supported Platforms
...@@ -1442,6 +1446,7 @@ ...@@ -1442,6 +1446,7 @@
\contentspage index.html \contentspage index.html
\previouspage creator-supported-platforms.html \previouspage creator-supported-platforms.html
\page creator-known-issues.html \page creator-known-issues.html
\nextpage creator-acknowledgements.html
\title Known Issues of Version 1.0.0 \title Known Issues of Version 1.0.0
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment