Commit 76b59d03 authored by Leena Miettinen's avatar Leena Miettinen

Doc: move misc howto topics to a separate folder

Change-Id: I586e3abfbfd578157fc41e3e82fa174494dfdfe9
Reviewed-on: http://codereview.qt-project.org/5609Reviewed-by: default avatarQt Sanity Bot <qt_sanity_bot@ovi.com>
Reviewed-by: default avatarEike Ziller <eike.ziller@nokia.com>
Reviewed-by: default avatarCasper van Donderen <casper.vandonderen@nokia.com>
parent c2430dd6
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.nokia.com)
**
**
** GNU Free Documentation License
**
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
** If you have questions regarding the use of this file, please contact
** Nokia at info@qt.nokia.com.
**
****************************************************************************/
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\contentspage index.html
\previouspage creator-task-lists.html
\page creator-cli.html
\nextpage creator-keyboard-shortcuts.html
\title Using Command Line Options
You can start \QC and specify some options from the command line.
For example, you can open a file to any line.
To specify command line options, enter the following command in the \QC
installation or build directory:
\c {qtcreator [option] [filename[:line_number]]}
\note You can use either a colon (:) or a plus sign (+) as a separator
between the filename and line number. You can also use a space between the
separator and the line number.
For example:
\list
\o \c {C:\qtcreator\bin>qtcreator -help}
\o \c {C:\qtcreator\bin>qtcreator C:\TextFinder\textfinder.cpp:100}
\o \c {C:\qtcreator\bin>qtcreator C:\TextFinder\textfinder.cpp +100}
\endlist
The following table summarizes the available options:
\table
\header
\o Option
\o Description
\row
\o -help
\o Display help on command line options.
\row
\o -version
\o Display \QC version.
\row
\o -client
\o Attempt to connect to an already running instance of \QC.
\row
\o -noload <plugin>
\o Do not load the specified plugin.
\row
\o -profile
\o Output plugin start up and shut down profiling data.
\row
\o -settingspath <path>
\o Override the default path where user settings are stored.
\row
\o -color <color>
\o Core plugin: override the selected UI color.
\row
\o -disable-cdb
\o Debugger plugin: disable the Microsoft Console Debugger (CDB)
engine. For more information, see \l{Debugging}.
\row
\o -disable-gdb
\o Debugger plugin: disable the GNU Symbolic Debugger (GDB) engine.
\row
\o -disable-sdb
\o Debugger plugin: disable the Qt Script debugger engine.
\row
\o -debug <PID-or-corefile>
\o Debugger plugin: attach to process ID or core file.
\row
\o -wincrashevent <event-handle>
\o Debugger plugin: Attach to crashed processes by using the specified
event handle.
\row
\o -customwizard-verbose
\o ProjectExplorer plugin: display additional information when loading
custom wizards. For more information about custom wizards, see
\l{Adding New Custom Wizards}
\row
\o -lastsession
\o ProjectExplorer plugin: load the last session when \QC starts.
Open the projects and files that were open when you last exited \QC.
For more information about managing sessions, see \l{Managing Sessions}.
\endtable
*/
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.nokia.com)
**
**
** GNU Free Documentation License
**
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
** If you have questions regarding the use of this file, please contact
** Nokia at info@qt.nokia.com.
**
****************************************************************************/
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\contentspage index.html
\previouspage adding-plugins.html
\page creator-editor-external.html
\nextpage creator-maemo-emulator.html
\title Using External Tools
You can use external tools directly from \QC. Qt Linguist,
QML Viewer, the
default text editor for your system, and the \c sort tool are preconfigured
for use. You can change their default configurations and configure new
tools.
\section1 Using Qt Linguist
You can use the Qt Linguist release manager tools, lupdate and lrelease,
directly from \QC. The lupdate tool is used to synchronize source
code and translations. The lrelease tool is used to create run-time
translation files for use by the released application.
To synchronize ts files from a translator with the application code,
select \gui {Tools > External > Text > Linguist > Update Translations
(lupdate)}.
To generate from the ts files qm translation files that can be used by an
application, select \gui {Tools > External > Text > Linguist > Release
Translations (lrelease)}.
By default, the project .pro file is passed to the tools as an argument. To
specify other command line arguments for the tools, select \gui {Tools >
External > Configure}.
For more information about Qt Linguist, see
\l{http://doc.qt.nokia.com/4.7/linguist-manual.html}{Qt Linguist Manual}.
\section1 Using QML Viewer
You can preview the current QML document in the QML Viewer. The QML Viewer
invokes the QML runtime to load QML documents and also includes additional
features useful for the development of QML-based applications.
To preview the currently active QML file, select \gui {Tools > External >
Qt Quick > Preview (qmlviewer)}.
\section1 Using External Text Editors
You can open files for editing in the default text editor for your system:
Notepad on Windows and vi on Linux and Mac OS.
To open the file you are currently viewing in an external editor, select
\gui {Tools > External > Text > Notepad} or \gui vi, depending on your
system.
\QC looks for the editor path in the PATH environment variable
of your operating system.
\section1 Sorting Text Alphabetically
To sort selected text alphabetically, select \gui {Tools > External > Text
> Sort Selection}. The \c sort tool takes the selected text as input and
returns it in alphabetic order. By default, the output replaces the
original selection in the code editor.
To change the default configuration, select \gui {Tools > External >
Configure}.
\section1 Configuring External Tools
You can change the configuration of preconfigured tools and configure
additional tools in \QC \gui Options.
You can use \QC variables in the fields that you can select from
lists of available \QC variables.
\image qtcreator-external-tools.png "External Tools options"
To configure external tools:
\list 1
\o Select \gui {Tools > External > Configure}.
\o Select \gui {Add > Add Tool}
to add a new tool. You can also select \gui {Add Category} to add a
new category.
\o In the \gui Executable field, specify the executable to run. If the
executable is found in your system PATH variable, do not specify
the path to it.
\o In the \gui Arguments field, specify optional arguments for running
the executable.
\o In the \gui {Working directory} field, specify the path to the
working directory.
\o In the \gui {Output pane}, select how to handle output from the
tool. You can ignore the output, view it in the \gui {General
Messages} output pane, or replace the selected text with the
output in the code editor.
\o In the \gui {Error output pane}, select how to handle error messages
from the tool.
\o In the \gui Input field, specify text that is passed as standard
input to the tool.
\endlist
The category and tool are added to the \gui {Tools > External} menu.
If you change the configuration of preconfigured tools, you can later
revert the changes by selecting the \gui Revert button.
The tool configurations that you add and modify are stored in XML format in
the user configuration folder. For example,
\c {~/config/Nokia/qtcreator/externaltools}
on Linux and Mac OS and
\c {C:\Users\username\AppData\Roaming\Nokia\qtcreator\externaltools}
in Windows. To share a configuration with other users, copy an XML
configuration file to the folder.
*/
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.nokia.com)
**
**
** GNU Free Documentation License
**
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
** If you have questions regarding the use of this file, please contact
** Nokia at info@qt.nokia.com.
**
****************************************************************************/
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\contentspage index.html
\previouspage creator-remote-compiler.html
\page creator-help.html
\nextpage creator-advanced.html
\title Getting Help
\QC comes fully integrated with Qt documentation and examples using the Qt
Help plugin.
\list
\o To view documentation, switch to \gui Help mode.
\o To obtain context sensitive help, move the text cursor to a Qt class
or function and press \key F1. The documentation is displayed in a
pane next to the code editor, or, if there is not enough vertical
space, in the fullscreen \gui Help mode.
\o To select and configure how the documentation is displayed in the
\gui Help mode, select \gui Tools > \gui Options > \gui Help.
\endlist
The following image displays the \gui Search pane in the \gui Help mode.
\image qtcreator-help-search.png
The following image displays the context sensitive help in the \gui Edit
mode.
\image qtcreator-context-sensitive-help.png
\section1 Finding Information in Qt Documentation
\QC, \QSDK and other Qt deliverables contain documentation
as .qch files. All the documentation is accessible in the \gui Help mode.
To find information in the documentation, select:
\list
\o \gui Bookmarks to view a list of pages on which you have added
bookmarks.
\o \gui Contents to see all the documentation installed on the
development PC and to browse the documentation contents.
\o \gui Index to find information based on a list of keywords in all
the installed documents.
\o \gui {Open Pages} to view a list of currently open documentation
pages.
\o \gui Search to search from all the installed documents.
\endlist
\section2 Adding Bookmarks to Help Pages
You can add bookmarks to useful help pages to easily find them later
in the \gui Bookmarks view. You can either use the page title as the
bookmark or change it to any text. You can organize the bookmarks in
folders in the view.
\image qtcreator-help-add-bookmark-dlg.png "Add Bookmark dialog"
To add a bookmark to an open help page:
\list 1
\o Click the
\inlineimage qtcreator-help-add-bookmark.png
(\gui {Add Bookmark}) button on the toolbar.
\o In the \gui {Add Bookmark} dialog, click \gui OK to save the
page title as a bookmark in the \gui Bookmarks folder.
\endlist
To import and export bookmarks, select \gui {Tools > Options > Help >
General Settings > Import} or \gui Export.
\section1 Adding External Documentation
You can display external documentation in the \gui Help mode.
To augment or replace the documentation that ships with \QC and Qt:
\list 1
\o Create a .qch file from your documentation.
For information on how to prepare your documentation and create a
.qch file, see
\l{http://doc.qt.nokia.com/4.7/qthelp-framework.html}
{The Qt Help Framework}.
\o To add the .qch file to \QC, select \gui Tools > \gui Options >
\gui Help > \gui Documentation > \gui Add.
\endlist
\section1 Detaching the Help Window
By default, context-sensitive help is opened in a window next to the
code editor when you press \key F1. If there is not enough vertical
space, the help opens in the full-screen help mode.
You can specify that the help always opens in full-screen mode or
is detached to an external window. Select \gui {Tools > Options > Help >
General Settings} and specify settings for displaying context-sensitive help
in the \gui {On context help} field. To detach the help window, select
\gui {Always Show Help in External Window}.
You can select the help page to open upon startup in the \gui {Home Page}
field.
\section1 Using Documentation Filters
You can filter the documents displayed in the \gui Help mode to find
relevant information faster. Select from a list of filters in the
\gui {Filtered by} field. The contents of the \gui Index and \gui Contents
pane in the sidebar change accordingly.
\image qtcreator-help-filters.png "Help filters"
You can modify the filters to include external documentation, for example,
or you can define your own filters. To construct filters, you can use the
filter attributes that are specified in the documentation. Each document
contains at least one filter attribute. If several documents contain the
same filter attribute, such as \c tools, you can use that attribute to
include all those documents.
To add filters:
\list 1
\o Select \gui {Tools > Options > Help > Filters > Add}.
\o Enter a name for the filter and press \gui {OK}.
\o In \gui Attributes, select the documents that you want to include
in the filter.
\image qtcreator-help-filter-attributes.png "Help filter attributes"
\o Click \gui OK.
\o In the \gui Help mode, select the filter in the \gui {Filtered by}
field to see the filtered documentation in the sidebar.
\endlist
To modify filters, select a filter in \gui Filters, select the attributes,
and then click \gui Apply.
To remove filters, select them in \gui Filters, and click \gui Remove.
*/
This diff is collapsed.
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.nokia.com)
**
**
** GNU Free Documentation License
**
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
** If you have questions regarding the use of this file, please contact
** Nokia at info@qt.nokia.com.
**
****************************************************************************/
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\contentspage index.html
\previouspage creator-developing-symbian.html
\page creator-project-managing-sessions.html
\nextpage creator-coding.html
\title Managing Sessions
When you exit \QC, a snapshot of your current workspace is stored as a
\e session. To restore the session automatically when you start \QC,
select \gui {File > Session Manager > Restore last session on startup}.
A session is an arbitrary collection of:
\list
\o Open projects with their dependencies (including SUBDIRS projects)
\o Open editors
\o Breakpoints and expressions
\o Bookmarks
\endlist
A session is personal, that is, not meant to be shared. It is not supposed
to reflect the project structure. It contains personal data, such as
bookmarks and breakpoints that are usually not of interest to other
developers working on the same projects.
For example, if you work on a project and need to switch to another project
for a while, you can save your workspace as a session. This makes it easier
to return to working on the first project later.
To create a new session or remove existing sessions, select \gui File >
\gui{Session Manager}.
\image qtcreator-session-manager.png
To switch between sessions, choose \gui {File > Session Manager}. If you do
not create or select a session, \QC always uses the default session, which
was created the last time you exited \QC.
When you launch \QC, a list of existing sessions is displayed on the
\gui{Welcome screen}.
\image qtcreator-welcome-session.png
*/
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.nokia.com)
**
**
** GNU Free Documentation License
**
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
** If you have questions regarding the use of this file, please contact
** Nokia at info@qt.nokia.com.
**
****************************************************************************/
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\contentspage index.html
\previouspage creator-mime-types.html
\page creator-task-lists.html
\nextpage creator-cli.html
\title Showing Task List Files in the Build Issues Pane
Code scanning and analysis tools create report files in ASCII format.
Usually, the report files consist of lines that contain a file name, a line
number, and an error message. A similar format is used for stack traces
obtained from crash reports. Traditionally, you would fix the errors by
manually navigating to them and correcting them, which is tedious.
\QC makes this very easy by providing a way to load these files into
the \gui{Build Issues} pane. You can navigate to the corresponding source
code by clicking the error message. But first you must convert the files to
the \l{Task List File Format} by using conversion scripts that based on
standard text processing tools of the operating system.
In addition, you can generate task list files from code. For an example of a
script that checks new lines of code and matches them against regular
expressions to generate a task list, see \c{scripts\mytasks.pl} in the \QC
repository.
To open task list files, choose \gui{File} > \gui{Open}.
\section1 Task List File Format
The filename extension must be .tasks for \QC to recognize a file as a
task list file.
Each line in a task list file is treated as a tab-separated list of strings
with \c{\t}, \c{\n}, and \c{\\} used as escape characters. The strings are
used to create one task per line. The lines can have one of the following
formats:
\list
\o \c description
\o \c{type\tdescription}
\o \c{file\ttype\tdescription}
\o \c{file\tline\ttype\tdescription}
\endlist
The task type can have one of the following values:
\list
\o A string starting with \c err, which displays the error icon in the
beginning of the line
\o A string starting with \c warn, which displays the warning icon
\o Any other value, which sets the task type to Unknown and does not
display an icon
\endlist
The values are not case sensitive.
Lines starting with the hash mark character (#) in the first column are
ignored.
*/
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.nokia.com)
**
**
** GNU Free Documentation License
**
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
** If you have questions regarding the use of this file, please contact
** Nokia at info@qt.nokia.com.
**