@ -3,7 +3,7 @@ Autoprojectpart is a projectmanager for Automake based projects.
Loads and maintains Makefile.am files.
\authors <a href="mailto:bernd AT kdevelop.org">Bernd Gehrmann</a>
\authors <a href="mailto:bernd AT tdevelop.org">Bernd Gehrmann</a>
\maintainer <a href="mailto:victor_roeder AT gmx.de">Victor Röder</a>
\maintainer <a href="mailto:a.lucas AT tu-bs.de">Amilcar do Carmo Lucas</a>
@ -15,9 +15,9 @@ reconfigure subprojects**.
\feature Unsupported automake features will be left unchanged
(hopefully), no major testing has been run yet (at least not by myself).
\bug bugs in <a href="http://bugs.kde.org/buglist.cgi?product=kdevelop&component=autoproject&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=Bug+Number"> autoproject component at Bugzilla database</a>
\bug bugs in <a href="http://bugs.kde.org/buglist.cgi?product=tdevelop&component=autoproject&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=Bug+Number"> autoproject component at Bugzilla database</a>
\bug Lower Automake Manager view does not update it's view when adding a subproject (and targets, etc to the new subproject)
\bug If removing the Active Target, update the .kdevelop file, too!
\bug If removing the Active Target, update the .tdevelop file, too!
\note
@ -34,6 +34,6 @@ with this configuration the "Automake Manager" doesn't insert the menuentry "exe
and doesn't show the "Run Options" in the project configuration.<br>
Now you can implement this features with your own special plugin.
For an example please look at the projects generated for GBA using the VisualBoy Advance Plugin.
This plugin starts a GBA binary with an emulator. -- <a href="mailto:smeier AT kdevelop.org">Sandy Meier</a>
This plugin starts a GBA binary with an emulator. -- <a href="mailto:smeier AT tdevelop.org">Sandy Meier</a>
@ -5,7 +5,7 @@ over several lines. You can even use some html commands in these lines like:
<code>This is code</code>, html links <a href="http://somelocation">link text</a>,
and images.
\authors <a href="mailto:bernd AT kdevelop.org">Bernd Gehrmann</a>
\authors <a href="mailto:bernd AT tdevelop.org">Bernd Gehrmann</a>
\unmaintained This part is currently un-maintained
@ -14,7 +14,7 @@ and images.
...
\feature Describe the last feature
\bug bugs in <a href="http://bugs.kde.org/buglist.cgi?product=kdevelop&component=customproject&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=Bug+Number">customproject component at Bugzilla database</a>
\bug bugs in <a href="http://bugs.kde.org/buglist.cgi?product=tdevelop&component=customproject&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=Bug+Number">customproject component at Bugzilla database</a>
\bug Describe a the 1st bug that you know of, but probably hasn't been reported yet.
..
\bug Describe a the nth bug that you know of, but probably hasn't been reported yet.
action->setWhatsThis(i18n("<b>Re-Populate Project</b><p>Re-Populates the project, searching through the project directory and adding all files that match one of the wildcards set in the custom manager options of the project filelist."));
@ -8,7 +8,7 @@ It will regenerate a projects .pro files dynamically as you add,remove or
reconfigure (sub)projects. Unsupported qmake features will be left unchanged
(hopefully) no major testing has been run yet.
\authors <a href="mailto:bernd AT kdevelop.org">Bernd Gehrmann</a>
\authors <a href="mailto:bernd AT tdevelop.org">Bernd Gehrmann</a>
\authors <a href="mailto:thasart AT gmx.de">Thomas Hasart</a>
\maintainer <a href="mailto:jsgaarde AT tdcspace.dk">Jakob Simon-Gaarde </a>
@ -21,12 +21,12 @@ remove or reconfigure (sub)projects.
\feature Unsupported qmake features will be left unchanged (hopefully)
no major testing has been run yet.
\bug bugs in <a href="http://bugs.kde.org/buglist.cgi?product=kdevelop&component=trollproject&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=Bug+Number">trollproject component at Bugzilla database</a>
\bug bugs in <a href="http://bugs.kde.org/buglist.cgi?product=tdevelop&component=trollproject&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=Bug+Number">trollproject component at Bugzilla database</a>
action->setWhatsThis(i18n("<b>Execute program</b><p>Executes the currently selected subproject if it is an application or the program specified in project settings, <b>Run Options</b> tab."));
KMessageBox::error(this,i18n("Could not delete Function Scope.\nThis is an internal error, please write a bug report to bugs.kde.org and include the output of kdevelop when run from a shell."),i18n("Function Scope Deletion failed"));
KMessageBox::error(this,i18n("Could not delete Function Scope.\nThis is an internal error, please write a bug report to bugs.kde.org and include the output of tdevelop when run from a shell."),i18n("Function Scope Deletion failed"));
KMessageBox::error(this,i18n("Could not delete Include Scope.\nThis is an internal error, please write a bug report to bugs.kde.org and include the output of kdevelop when run from a shell."),i18n("Include Scope Deletion failed"));
KMessageBox::error(this,i18n("Could not delete Include Scope.\nThis is an internal error, please write a bug report to bugs.kde.org and include the output of tdevelop when run from a shell."),i18n("Include Scope Deletion failed"));
KMessageBox::error(this,i18n("Could not delete Scope.\nThis is an internal error, please write a bug report to bugs.kde.org and include the output of kdevelop when run from a shell."),i18n("Scope Deletion failed"));
KMessageBox::error(this,i18n("Could not delete Scope.\nThis is an internal error, please write a bug report to bugs.kde.org and include the output of tdevelop when run from a shell."),i18n("Scope Deletion failed"));
dnl AC_CHECK_FILE([$qt_includes/qassistantclient.h], [],[AC_MSG_ERROR([The qassistantclient.h header from Qt3 is needed to build kdevelop, on some systems this header is in a separate package called qt3-apps-dev])])
dnl AC_CHECK_FILE([$qt_includes/qassistantclient.h], [],[AC_MSG_ERROR([The qassistantclient.h header from Qt3 is needed to build tdevelop, on some systems this header is in a separate package called qt3-apps-dev])])
- All project wide setings should go into .kdevelop and
- Fix the mess of .tdevelop and .kdevses file.
- All project wide setings should go into .tdevelop and
- all session (and personal) options should go into .kdevses file
.
This way the .kdevelop file can be shared in teams of developers.
This way the .tdevelop file can be shared in teams of developers.
\section KDevelop2compat KDevelop 2 compatibility
(These are things that must be accomplished before we can say that KDevelop 3
>= kdevelop 2.x UI-wise and functionality-wise!)
>= tdevelop 2.x UI-wise and functionality-wise!)
- general UI issues:
- toplevel UI mode broken concerning to the accels
@ -29,7 +29,7 @@
- implement "Make User Manual"
- use kdoc to update Qt/KDE docs
.
- Solve the regression bugs. These are the <a href= "http://bugs.kde.org/buglist.cgi?product=kdevelop&bug_status=UNCONFIRMED&bug_status=NEW&priority=HI">ones
- Solve the regression bugs. These are the <a href= "http://bugs.kde.org/buglist.cgi?product=tdevelop&bug_status=UNCONFIRMED&bug_status=NEW&priority=HI">ones
<title>Configuration Files Used by &kdevelop;</title>
<title>Configuration Files Used by &tdevelop;</title>
<para>
&kdevelop; uses a series of configuration files which are distributed amongst several directories. There are two main groups of configuration files to distinguish:
&tdevelop; uses a series of configuration files which are distributed amongst several directories. There are two main groups of configuration files to distinguish:
</para>
<simplelist>
<member>
<link linkend="app-files-default">&kdevelop; Default Configuration</link> — files set up when &kdevelop; was installed.
<link linkend="app-files-default">&tdevelop; Default Configuration</link> — files set up when &tdevelop; was installed.
</member>
<member>
<link linkend="app-files-user">User Oriented Configuration</link> — files which contain user modifications of the defaults as well as settings made by the &kdevelop; application itself and its plugins.
<link linkend="app-files-user">User Oriented Configuration</link> — files which contain user modifications of the defaults as well as settings made by the &tdevelop; application itself and its plugins.
</member>
</simplelist>
<sect1 id="app-files-default">
<title>&kdevelop; Default Configuration</title>
<title>&tdevelop; Default Configuration</title>
<para>
On installation, &kdevelop; writes some default information files for setup and configuration purposes into subdirectories of the <filename class="directory">$<envar>KDEDIR</envar></filename> installation directory (usually something like <filename class="directory">/opt/kde</filename>, <filename class="directory">/usr/local/kde</filename>, or some other user-defined installation directory, see <link linkend="kdevelop-install">Installing &kdevelop;</link>).
On installation, &tdevelop; writes some default information files for setup and configuration purposes into subdirectories of the <filename class="directory">$<envar>KDEDIR</envar></filename> installation directory (usually something like <filename class="directory">/opt/kde</filename>, <filename class="directory">/usr/local/kde</filename>, or some other user-defined installation directory, see <link linkend="tdevelop-install">Installing &tdevelop;</link>).
</para>
<sect2 id="app-files-default-config">
<title>Default &kdevelop; Configuration</title>
<title>Default &tdevelop; Configuration</title>
<para>
There is only one &kdevelop; specific default configuration file in the <filename class="directory">$<envar>KDEDIR</envar>/share/config/</filename> directory:
There is only one &tdevelop; specific default configuration file in the <filename class="directory">$<envar>KDEDIR</envar>/share/config/</filename> directory:
</para>
<variablelist>
<varlistentry>
<term><filename>kdeveloprc</filename></term>
<term><filename>tdeveloprc</filename></term>
<listitem><para>
This file contains the basic settings &kdevelop; needs to start. It will be copied to the user's <filename class="directory">$<envar>KDEHOME</envar>/share/config</filename> directory when &kdevelop; does not find a <filename>kdeveloprc</filename> file there on startup.
This file contains the basic settings &tdevelop; needs to start. It will be copied to the user's <filename class="directory">$<envar>KDEHOME</envar>/share/config</filename> directory when &tdevelop; does not find a <filename>tdeveloprc</filename> file there on startup.
</para></listitem>
</varlistentry>
</variablelist>
@ -52,11 +52,11 @@ There is only one &kdevelop; specific default configuration file in the <filenam
<title>Application Specific Defaults</title>
<para>
Most &kdevelop; features are provided by KParts. These are basically applications specially designed to run in the &kdevelop; framework (see the overview in the <link linkend="plugin-tools">Plugin Tools</link> appendix). Each KPart application has its own set of configuration files whose defaults will be stored in several subdirectories of the <filename class="directory">$<envar>KDEDIR</envar>/share/apps/</filename> installation directory.
Most &tdevelop; features are provided by KParts. These are basically applications specially designed to run in the &tdevelop; framework (see the overview in the <link linkend="plugin-tools">Plugin Tools</link> appendix). Each KPart application has its own set of configuration files whose defaults will be stored in several subdirectories of the <filename class="directory">$<envar>KDEDIR</envar>/share/apps/</filename> installation directory.
</para>
<para>
There are quite a lot of default configuration subdirectories in <filename class="directory">$<envar>KDEDIR</envar>/share/apps/</filename> whose names all start with a <filename>kdev</filename> sequence. Most of them are for &kdevelop; internal use only. They might be deliberately grouped for readability as:
There are quite a lot of default configuration subdirectories in <filename class="directory">$<envar>KDEDIR</envar>/share/apps/</filename> whose names all start with a <filename>kdev</filename> sequence. Most of them are for &tdevelop; internal use only. They might be deliberately grouped for readability as:
<para><filename class="directory">kdevelop/</filename> — contains files to configure the &kdevelop; &IDE;:</para>
<para><filename class="directory">tdevelop/</filename> — contains files to configure the &tdevelop; &IDE;:</para>
<itemizedlist>
<listitem><para><filename class="directory">licenses/</filename> — contains various licenses texts.</para></listitem>
<listitem><para><filename class="directory">pics/</filename> — contains the picture files used for the &kdevelop;, &kdevelop; Assistant, and &kdevelop; Designer splash screens.</para></listitem>
<listitem><para><filename class="directory">profiles/</filename> — contains default plugin profile settings. (Currently there is only a <filename>tiny</filename> profile provided which defines a minimum set of active &kdevelop; plugins.)</para></listitem>
<listitem><para><filename class="directory">pics/</filename> — contains the picture files used for the &tdevelop;, &tdevelop; Assistant, and &tdevelop; Designer splash screens.</para></listitem>
<listitem><para><filename class="directory">profiles/</filename> — contains default plugin profile settings. (Currently there is only a <filename>tiny</filename> profile provided which defines a minimum set of active &tdevelop; plugins.)</para></listitem>
<listitem><para><filename>eventsrc</filename> — holds a lot of <quote>Process successful</quote> localization strings.</para></listitem>
<listitem><para><filename>kdevelopui.rc</filename> — provides the basic menu and tool bar entries &kdevelop; uses.</para></listitem>
<listitem><para><filename>tdevelopui.rc</filename> — provides the basic menu and tool bar entries &tdevelop; uses.</para></listitem>
<listitem><para><filename>kdevhtml_partui.rc</filename> — provides a <guimenuitem>Print...</guimenuitem> entry in the <guimenu>File</guimenu> menu, a <guimenuitem>Copy</guimenuitem> entry in the <guimenu>Edit</guimenu> menu, and <guilabel>Back</guilabel> and <guilabel>Forward</guilabel> arrows in the <guilabel>Browser Toolbar</guilabel> in case a &HTML; file is browsed from the <guilabel>Documentation</guilabel> plugin.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para><filename class="directory">kdevassistant/</filename> — provides the menu and tool bars of the stand-alone &kdevelop; Assistant documentation browser.</para></listitem>
<listitem><para><filename class="directory">kdevdesigner/</filename> and <filename class="directory">kdevdesignerpart/</filename> — provide menu bar and tool bars of the stand-alone &kdevelop; user interface designer.</para></listitem>
<listitem><para><filename class="directory">kdevassistant/</filename> — provides the menu and tool bars of the stand-alone &tdevelop; Assistant documentation browser.</para></listitem>
<listitem><para><filename class="directory">kdevdesigner/</filename> and <filename class="directory">kdevdesignerpart/</filename> — provide menu bar and tool bars of the stand-alone &tdevelop; user interface designer.</para></listitem>
@ -96,7 +96,7 @@ There are quite a lot of default configuration subdirectories in <filename class
<listitem id="app-files-default-appwizard">
<para><filename class="directory">kdevappwizard/</filename> — contains files used by the &appwizard; part:</para>
<itemizedlist>
<listitem><para><filename class="directory">importfiles/</filename> — contains <filename>.kdevelop</filename> project files which control the initialization of a new project.</para></listitem>
<listitem><para><filename class="directory">importfiles/</filename> — contains <filename>.tdevelop</filename> project files which control the initialization of a new project.</para></listitem>
<listitem><para><filename class="directory">imports/</filename> — contains templates to set up project specific <filename>.desktop</filename> files.</para></listitem>
<listitem><para><filename class="directory">template-common/</filename> — contains various files commonly included in the project source directories.</para></listitem>
<listitem><para><filename class="directory">templates/</filename> — contains configuration files which describe the information to be included in a given project source directory.</para></listitem>
@ -105,7 +105,7 @@ There are quite a lot of default configuration subdirectories in <filename class
</itemizedlist>
</listitem>
<listitem><para><filename class="directory">kdevastyle/</filename> — provides the <guimenuitem>Reformat Source</guimenuitem> entry in the <guimenu>Edit</guimenu> menu.</para></listitem>
<listitem><para><filename class="directory">kdevautoproject/</filename> — provides most of the entries in the <guimenu>Build</guimenu> menu and the <guilabel>Build Toolbar (&kdevelop;)</guilabel> toolbar.</para></listitem>
<listitem><para><filename class="directory">kdevautoproject/</filename> — provides most of the entries in the <guimenu>Build</guimenu> menu and the <guilabel>Build Toolbar (&tdevelop;)</guilabel> toolbar.</para></listitem>
<listitem>
<para><filename class="directory">kdevclassview/</filename> — contains files used by the <guilabel>Class View</guilabel> project plugin:</para>
<itemizedlist>
@ -123,7 +123,7 @@ There are quite a lot of default configuration subdirectories in <filename class
<para><filename class="directory">kdevdocumentation/</filename> — contains files used by the <guilabel>Documentation</guilabel> plugin:</para>
<itemizedlist>
<listitem><para><filename class="directory">en/</filename> and <filename class="directory">pics/</filename> — contain files used by the <application>htdig</application> search tool.</para></listitem>
<listitem><para><filename class="directory">tocs/</filename> — contain the default &kdevelop; documentation content description files (see the description in <link linkend="toc-file-structure">Basic Structure of &kdevelop; TOC Files</link>).</para></listitem>
<listitem><para><filename class="directory">tocs/</filename> — contain the default &tdevelop; documentation content description files (see the description in <link linkend="toc-file-structure">Basic Structure of &tdevelop; TOC Files</link>).</para></listitem>
<listitem><para><filename>kdevpart_documentation.rc</filename> — provides the search related entries in the <guimenu>Help</guimenu> menu.</para></listitem>
</itemizedlist>
</listitem>
@ -212,20 +212,20 @@ All information about user defined settings is kept in two subdirectories of <fi
<title>Application Specific Configuration</title>
<para>
Any user changes to the <link linkend="app-files-default">&kdevelop; Default Configuration</link> settings as well as user specific settings which are not kept in any of the <link linkend="app-files-user-config">Resource Configuration Files</link> are found in <filename>kdev...</filename> subdirectories of the <filename class="directory">$<envar>KDEHOME</envar>/share/apps/</filename> directory.
Any user changes to the <link linkend="app-files-default">&tdevelop; Default Configuration</link> settings as well as user specific settings which are not kept in any of the <link linkend="app-files-user-config">Resource Configuration Files</link> are found in <filename>kdev...</filename> subdirectories of the <filename class="directory">$<envar>KDEHOME</envar>/share/apps/</filename> directory.
</para>
<para>
Most of these configuration files are however used by various &kdevelop; plugins in order to provide some specific menu and/or toolbar entries. Thus they are of interest only in case something went really wrong with the user interface.
Most of these configuration files are however used by various &tdevelop; plugins in order to provide some specific menu and/or toolbar entries. Thus they are of interest only in case something went really wrong with the user interface.
</para>
<note><para>
In case the contents of these directories mirror those of the Default Configuration settings, &kdevelop; will have copied them from <filename class="directory">$<envar>KDEDIR</envar>/apps/</filename> into the <filename class="directory">$<envar>KDEHOME</envar>/apps/</filename> directory on its initial start. Any subsequent changes will be made to these copies only. The Default Configuration settings remain unchanged in any case.
In case the contents of these directories mirror those of the Default Configuration settings, &tdevelop; will have copied them from <filename class="directory">$<envar>KDEDIR</envar>/apps/</filename> into the <filename class="directory">$<envar>KDEHOME</envar>/apps/</filename> directory on its initial start. Any subsequent changes will be made to these copies only. The Default Configuration settings remain unchanged in any case.
</para></note>
<itemizedlist>
<listitem>
<para><filename class="directory">kdevabbrev/</filename> — contains files used by the <guilabel>Abbreviation Expansion</guilabel> plugin:</para>
<itemizedlist>
<listitem><para><filename class="directory">sources/</filename> — currently empty; &kdevelop; uses the <link linkend="app-files-default-abbrev">default keyword definition</link> files for <guilabel>Expand Text</guilabel> commands.</para></listitem>
<listitem><para><filename class="directory">sources/</filename> — currently empty; &tdevelop; uses the <link linkend="app-files-default-abbrev">default keyword definition</link> files for <guilabel>Expand Text</guilabel> commands.</para></listitem>
<listitem><para><filename class="directory">templates/</filename> — contains the user modified template definition files used by the <guilabel>Expand Abbreviation</guilabel> command.</para></listitem>
<listitem><para><filename>kdevabbrev.rc</filename> — provides the <guimenuitem>Expand Text</guimenuitem> and <guimenuitem>Expand Abbreviation</guimenuitem> entries in the <guimenu>Edit</guimenu> menu.</para></listitem>
</itemizedlist>
@ -252,7 +252,7 @@ In case the contents of these directories mirror those of the Default Configurat
<para><filename class="directory">newclass/</filename> — contains the actual header and source templates from which the &appwizard; builds the according source files.</para>
</listitem>
<listitem>
<para><filename class="directory">pcs/</filename> — contains database files &kdevelop; uses build the actual Persistent Code Store (<filename>.pcs</filename>) file of a &kde; C++ project.</para>
<para><filename class="directory">pcs/</filename> — contains database files &tdevelop; uses build the actual Persistent Code Store (<filename>.pcs</filename>) file of a &kde; C++ project.</para>
</listitem>
<listitem>
<para><filename>kdevcppsupport.rc</filename> — provides the <guimenuitem>Complete Text</guimenuitem> and <guimenuitem>Make Member</guimenuitem> entries fo the <guimenu>Edit</guimenu> menu, the <guimenuitem>Switch Header/Implementation</guimenuitem> entry for the <guimenu>View</guimenu> menu, and the <guimenuitem>New Class</guimenuitem> entry for the <guimenu>Project</guimenu> menu as well as a <guiicon>New Class</guiicon> icon for the <guilabel>Browser Toolbar</guilabel>.</para>
@ -273,10 +273,10 @@ In case the contents of these directories mirror those of the Default Configurat
<para>The directories in <filename class="directory">kdevdocumentation/</filename> mainly hold actual bookkeeping information. The actually set up documentation files are kept in <link linkend="app-files-user-config-doc"> <quote><filename>doc...pluginrc</filename></quote> files</link> in the <filename class="directory">$<envar>KDEHOME</envar>/share/config/</filename> directory.</para>
<itemizedlist>
<listitem>
<para><filename class="directory">bookmarks/</filename> — maintains the entries in the <guilabel>Bookmarks</guilabel> tab of the &kdevelop; <guilabel>Documentation</guilabel> plugin.</para>
<para><filename class="directory">bookmarks/</filename> — maintains the entries in the <guilabel>Bookmarks</guilabel> tab of the &tdevelop; <guilabel>Documentation</guilabel> plugin.</para>
</listitem>
<listitem>
<para><filename class="directory">index/</filename> — holds various cache files &kdevelop; uses to speed up indexed documentation searches in the <guilabel>Index</guilabel> tab of the <guilabel>Documentation</guilabel> plugin.</para>
<para><filename class="directory">index/</filename> — holds various cache files &tdevelop; uses to speed up indexed documentation searches in the <guilabel>Index</guilabel> tab of the <guilabel>Documentation</guilabel> plugin.</para>
</listitem>
<listitem>
<para><filename class="directory">search/</filename> — contains files used by the <application>htdig</application> search tool which serves search calls from the <guilabel>Search</guilabel> tab of the <guilabel>Documentation</guilabel> plugin.</para>
@ -290,10 +290,10 @@ In case the contents of these directories mirror those of the Default Configurat
<para><filename class="directory">kdevdoxygen/</filename> — provides the menu entries for the <guilabel>Doxygen Support</guilabel> project plugin.</para>
</listitem>
<listitem>
<para><filename class="directory">kdevelop/</filename> — contains some actual settings &kdevelop; uses for its basic setup:</para>
<para><filename class="directory">tdevelop/</filename> — contains some actual settings &tdevelop; uses for its basic setup:</para>
<itemizedlist>
<listitem><para><filename class="directory">profiles/</filename> — provides actual plugin profile setting. (Initially there is only a <filename>FullIDE</filename> profile which defines a full set of initially active &kdevelop; plugins.)</para></listitem>
<listitem><para><filename>kdevelopui.rc</filename> — provides the basic menu and tool bar entries &kdevelop; uses.</para></listitem>
<listitem><para><filename class="directory">profiles/</filename> — provides actual plugin profile setting. (Initially there is only a <filename>FullIDE</filename> profile which defines a full set of initially active &tdevelop; plugins.)</para></listitem>
<listitem><para><filename>tdevelopui.rc</filename> — provides the basic menu and tool bar entries &tdevelop; uses.</para></listitem>
</itemizedlist>
</listitem>
<listitem>
@ -345,32 +345,32 @@ In case the contents of these directories mirror those of the Default Configurat
<title>Resource Configuration Files</title>
<para>
There are two groups of &kdevelop; configuration files in the <filename class="directory">$<envar>KDEHOME</envar>/share/config/</filename> directory, distiguished by their surrounding character sequences:
There are two groups of &tdevelop; configuration files in the <filename class="directory">$<envar>KDEHOME</envar>/share/config/</filename> directory, distiguished by their surrounding character sequences:
<simplelist>
<member><quote><filename>doc...pluginrc</filename></quote> denotes <link linkend="app-files-user-config-doc">files used by the documentation plugin.</link></member>
<member><quote><filename>kdev...rc</filename></quote> denotes configuration <link linkend="app-files-user-config-kdev">files used by &kdevelop;</link> itself and its available plugins.</member>
<member><quote><filename>kdev...rc</filename></quote> denotes configuration <link linkend="app-files-user-config-kdev">files used by &tdevelop;</link> itself and its available plugins.</member>
</simplelist>
</para>
<itemizedlist id="app-files-user-config-kdev">
<title>Configuration Files Used by &kdevelop;</title>
<title>Configuration Files Used by &tdevelop;</title>
<listitem>
<para><filename>kdevabbrevrc</filename> — holds the current state of the <guilabel>Abbreviations</guilabel> configuration provided by the <guilabel>Abbreviation Expansion</guilabel> plugin.</para>
<note><para>This only records whether the abbreviations will be used or not. The actual definitions of new abbreviations will go into the <filename>$<envar>KDEHOME</envar>/share/apps/kdevabbrev/templates/templates</filename> file.</para></note>
</listitem>
<listitem>
<para><filename>kdevassistantrc</filename> — holds some configuration states specific of the stand-alone &kdevelop; Assistant documentation browser.</para>
<note><para>Most common configuration settings are shared with the &kdevelop; IDE <filename>kdeveloprc</filename> file.</para></note>
<para><filename>kdevassistantrc</filename> — holds some configuration states specific of the stand-alone &tdevelop; Assistant documentation browser.</para>
<note><para>Most common configuration settings are shared with the &tdevelop; IDE <filename>tdeveloprc</filename> file.</para></note>
</listitem>
<listitem><para><filename>kdevassistantuimode4rc</filename> — holds the current MDI configuration states (dock positions &etc;) of the stand-alone &kdevelop; Assistant documentation browser.</para></listitem>
<listitem><para><filename>kdevassistantuimode4rc</filename> — holds the current MDI configuration states (dock positions &etc;) of the stand-alone &tdevelop; Assistant documentation browser.</para></listitem>
<listitem>
<para><filename>kdevclassviewrc</filename> — holds the <guilabel>View Mode</guilabel> setting of the <guilabel>Classes</guilabel> class browser tab provided by the <guilabel>Class View</guilabel> project plugin.</para>
<note><para>This is a global setting, although the <guilabel>Class View</guilabel> plugin may be disabled on a per project basis. Any change in this setting will be globally updated whenever the current project is closed and thus affect all subsequently loaded projects.</para></note>
</listitem>
<listitem><para><filename>kdevcppsupportrc</filename> — holds some settings used to set up CPP source files. In particular you will find the settings made on the <guilabel>C++ Class Generator</guilabel> configuration dialog in here.</para></listitem>
<listitem><para><filename>kdevdocumentationrc</filename> — holds actual settings the <guilabel>Documentation</guilabel> plugin uses.</para></listitem>
<listitem><para><filename>kdeveloprc</filename> — holds the global settings the &kdevelop; IDE and the &kdevelop; Assistant stand-alone documentation browser will use.</para></listitem>
<listitem><para><filename>kdevelopuimode4rc</filename> — holds the current MDI configuration states (dock positions &etc;) of the &kdevelop; IDE.</para></listitem>
<listitem><para><filename>tdeveloprc</filename> — holds the global settings the &tdevelop; IDE and the &tdevelop; Assistant stand-alone documentation browser will use.</para></listitem>
<listitem><para><filename>tdevelopuimode4rc</filename> — holds the current MDI configuration states (dock positions &etc;) of the &tdevelop; IDE.</para></listitem>
<listitem><para><filename>kdevfileselectorrc</filename> — holds actual settings the <guilabel>File Selector</guilabel> plugin uses.</para></listitem>
<listitem><para><filename>kdevfileviewrc</filename> — holds the actual filename color settings the <guilabel>CVS Integration (Cervisia)</guilabel> project plugin uses for display.</para></listitem>
<listitem><para><filename>kdevfilterrc</filename> — holds actual settings the <guilabel>Shell Filtering and Insertion</guilabel> plugin uses.</para></listitem>
@ -399,10 +399,10 @@ There are two groups of &kdevelop; configuration files in the <filename class="d
<title>Project Dependent Configuration</title>
<para>
Most project dependend configuration is kept in the <filename><project-name>.kdevelop</filename> and <filename><project-name>.kdevses</filename> &kdevelop; project configuration files rather than in separate files as the other, more global, configuration settings. In short, those files are meant for:
Most project dependend configuration is kept in the <filename><project-name>.tdevelop</filename> and <filename><project-name>.kdevses</filename> &tdevelop; project configuration files rather than in separate files as the other, more global, configuration settings. In short, those files are meant for:
</para>
<simplelist>
<member><filename><project-name>.kdevelop</filename> — global project configuration information.</member>
<member><filename><project-name>.tdevelop</filename> — global project configuration information.</member>
<member><filename><project-name>.kdevses</filename> — configuration information needed to restore the specific behaviours of the running session.</member>
</simplelist>
<para>
@ -412,7 +412,7 @@ Both are &XML; coded files. They can be viewed and (cautiously) altered using an
<sect2>
<title>Persistent Code Store Files</title>
<para>There is a third project dependend configuration file, the <filename><project-name>.kdevelop.pcs</filename> Persistant Code Store. This is a binary coded file holding an internal parser cache for the most part in order to speed up the loading sequence of the project. Additionally, this Persistant Code Store keeps information use by the <guilabel>Code Completion</guilabel> facility of &kdevelop;.
<para>There is a third project dependend configuration file, the <filename><project-name>.tdevelop.pcs</filename> Persistant Code Store. This is a binary coded file holding an internal parser cache for the most part in order to speed up the loading sequence of the project. Additionally, this Persistant Code Store keeps information use by the <guilabel>Code Completion</guilabel> facility of &tdevelop;.
In &kdevelop; software development work is organized in <emphasis>projects</emphasis>. Such a project keeps everything together which belongs to a complete programming task: source files, additional data files, any actually needed management facilities as the make system as well as access to all components and any additional tools needed to get the application up and running.
In &tdevelop; software development work is organized in <emphasis>projects</emphasis>. Such a project keeps everything together which belongs to a complete programming task: source files, additional data files, any actually needed management facilities as the make system as well as access to all components and any additional tools needed to get the application up and running.
</para>
<para>
Organizing all development work in projects allows you to easily switch between the global tasks at hand. This is quite handy if you ⪚ work on several applications at the same time as is often the case. Tell &kdevelop; to open the project you want to work at and you may proceed in the environment just where you left.
Organizing all development work in projects allows you to easily switch between the global tasks at hand. This is quite handy if you ⪚ work on several applications at the same time as is often the case. Tell &tdevelop; to open the project you want to work at and you may proceed in the environment just where you left.
</para>
<sect1 id="new-projects">
@ -36,7 +36,7 @@ Organizing all development work in projects allows you to easily switch between
Whenever you want to initiate a new programming project quite a lot of formal setup procedures need to be done. An initial directory structure has to be set up, initial header and source files must be provided, the make system has to be initialized, &etc;
</para>
<para>
&kdevelop; provides an easy way to initiate a new programming project—the <emphasis>&appwizard;</emphasis>. You will find the &appwizard; at menu entry <menuchoice><guimenu>Project</guimenu> <guimenuitem>New Project</guimenuitem></menuchoice>.
&tdevelop; provides an easy way to initiate a new programming project—the <emphasis>&appwizard;</emphasis>. You will find the &appwizard; at menu entry <menuchoice><guimenu>Project</guimenu> <guimenuitem>New Project</guimenuitem></menuchoice>.
</para>
<para>
Only a short series of steps is necessary to start a new programming project, using the &appwizard;:
@ -83,7 +83,7 @@ Let's look at all this in more detail now ...
<secondary>project</secondary></indexterm>
<para>
To create a new project in &kdevelop;, select <guimenuitem>New Project</guimenuitem> from the <guimenu>Project</guimenu> menu. The <guilabel>Create New Project</guilabel> dialog will pop up showing an initial <guilabel>General</guilabel> page:
To create a new project in &tdevelop;, select <guimenuitem>New Project</guimenuitem> from the <guimenu>Project</guimenu> menu. The <guilabel>Create New Project</guilabel> dialog will pop up showing an initial <guilabel>General</guilabel> page:
</para>
<screenshot id="screenshot-newprojectwizard">
@ -318,7 +318,7 @@ There are two ways to select another path for your new application. One is to se
This is done in the second row input field of the <guilabel>Properties</guilabel>, named <guilabel>Location</guilabel>. What you enter here is the <emphasis>starting path</emphasis> of the new application development directory. The &appwizard; appends the application name to this path when it initializes the new project. The result is shown in the <guilabel>Final location</guilabel> line to give you better control on what is going on.
</para>
<para>
&appwizard; will copy an <emphasis>initial value</emphasis> to the <guilabel>Location</guilabel> field on start-up. This is taken from what you have chosen in the <guilabel>Default projects directory</guilabel> field during the <link linkend="setup-general">general configuration steps</link>. In our case we have &kdevelop; set up to use <filename class="directory">/home/devel/projects/</filename> as initial path for new projects.
&appwizard; will copy an <emphasis>initial value</emphasis> to the <guilabel>Location</guilabel> field on start-up. This is taken from what you have chosen in the <guilabel>Default projects directory</guilabel> field during the <link linkend="setup-general">general configuration steps</link>. In our case we have &tdevelop; set up to use <filename class="directory">/home/devel/projects/</filename> as initial path for new projects.
</para>
<para>
Alter the <guilabel>Location</guilabel> field contents so that the application development directory shown in the <guilabel>Final location</guilabel> line will be unique.
@ -439,7 +439,7 @@ Otherwise you must reselect the version control system you want to use from the
</screenshot>
<para>
A version control system such as &CVS; (which means <quote>Concurrent Versions System</quote>) stores copies of selected project files in some sort of a database. If you use &CVS; you can amongst others upload (<quote>commit</quote>) those files or load them back into your project directory (<quote>checkout</quote>, or <quote>update</quote>). The special thing about this is that the files in the versioning database are stored in a structured way which allows you to always revert to an earlier development state if you need so. And &CVS; allows multiple designers to fairly easily collaborate on a big project (such as &kdevelop;) without disturbing each others work.
A version control system such as &CVS; (which means <quote>Concurrent Versions System</quote>) stores copies of selected project files in some sort of a database. If you use &CVS; you can amongst others upload (<quote>commit</quote>) those files or load them back into your project directory (<quote>checkout</quote>, or <quote>update</quote>). The special thing about this is that the files in the versioning database are stored in a structured way which allows you to always revert to an earlier development state if you need so. And &CVS; allows multiple designers to fairly easily collaborate on a big project (such as &tdevelop;) without disturbing each others work.
</para>
<indexterm zone="new-projects-start-cvs-root">
@ -465,7 +465,7 @@ A version control system such as &CVS; (which means <quote>Concurrent Versions S
<formalpara id="new-projects-start-cvs-root">
<title>&CVS; Root</title>
<para>
&CVS; needs to <emphasis>manage</emphasis> the versioning database it keeps from your project files. To accomplish this it keeps some special database information in an own directory, called the <emphasis>&CVS; root</emphasis>. The first step on setting up &CVS; for your new project thus is to tell &kdevelop; where this root is located.
&CVS; needs to <emphasis>manage</emphasis> the versioning database it keeps from your project files. To accomplish this it keeps some special database information in an own directory, called the <emphasis>&CVS; root</emphasis>. The first step on setting up &CVS; for your new project thus is to tell &tdevelop; where this root is located.
</para>
</formalpara>
@ -483,10 +483,10 @@ In fact, this is a short form. Exactly, the local &CVS; root should be addressed
Enter the name of the &CVS; root directory your system has been set up for in the <guilabel>CVS root</guilabel> field. In principle you can select any name, even use multiple &CVS; databases, but it is advisable that you stick to the &CVS; root once set up.
</para>
<para>
<emphasis>Initialize a new &CVS; root.</emphasis> If there does not exist a &CVS; root yet, &kdevelop; can command the &CVS; system to create one for you in the given directory. Just check the <guilabel>Init root</guilabel> checkbox below the <guilabel>CVS root</guilabel> field.
<emphasis>Initialize a new &CVS; root.</emphasis> If there does not exist a &CVS; root yet, &tdevelop; can command the &CVS; system to create one for you in the given directory. Just check the <guilabel>Init root</guilabel> checkbox below the <guilabel>CVS root</guilabel> field.
</para>
<note><para>
As said, &kdevelop; only <emphasis>commands</emphasis> the &CVS; system to initialize a new &CVS; root. It does nothing by itself to this directory. Fortunately &CVS; is clever enough to check whether the &CVS; root directory already exists. Hence it does no harm if you should have inadvertently checked <guilabel>Init root</guilabel> on an already existing &CVS; root directory.
As said, &tdevelop; only <emphasis>commands</emphasis> the &CVS; system to initialize a new &CVS; root. It does nothing by itself to this directory. Fortunately &CVS; is clever enough to check whether the &CVS; root directory already exists. Hence it does no harm if you should have inadvertently checked <guilabel>Init root</guilabel> on an already existing &CVS; root directory.
</para></note>
<para>
@ -540,11 +540,11 @@ for an rsh or ssh encrypted server type. For example
accesses the &CVS; root of the widely used <application>Cervisia</application> &CVS; management tool on the SourceForge server.
</para>
<para>
If you want to use an rsh or ssh encrypted server for &CVS; access you must tell &kdevelop; the encryption protocol to be used. Just enter <userinput>rsh</userinput> or <userinput>ssh</userinput> in the <guilabel>CVS_RSH</guilabel> field of the <guilabel>Create New Project</guilabel> <guilabel>Version Control System</guilabel> page.
If you want to use an rsh or ssh encrypted server for &CVS; access you must tell &tdevelop; the encryption protocol to be used. Just enter <userinput>rsh</userinput> or <userinput>ssh</userinput> in the <guilabel>CVS_RSH</guilabel> field of the <guilabel>Create New Project</guilabel> <guilabel>Version Control System</guilabel> page.
</para>
<note><para>
There is a caveat if you use an encrypted server for &CVS; from within &kdevelop;. See the <link linkend="cvs">Using &CVS;</link> chapter for details.
There is a caveat if you use an encrypted server for &CVS; from within &tdevelop;. See the <link linkend="cvs">Using &CVS;</link> chapter for details.
So far you have told &kdevelop; where the &CVS; root resides which manages the versioning database and how to access it. Now you need to tell &kdevelop; under which name you want &CVS; save your project files in that database. Such a place your project files will be held in &CVS; is called a <emphasis>repository</emphasis>.
So far you have told &tdevelop; where the &CVS; root resides which manages the versioning database and how to access it. Now you need to tell &tdevelop; under which name you want &CVS; save your project files in that database. Such a place your project files will be held in &CVS; is called a <emphasis>repository</emphasis>.
</para>
</formalpara>
<para>
@ -592,7 +592,7 @@ The &appwizard; has put a default <quote>start</quote> tag in here which is a wo
<note>
<para>
When any information of all these is wrong &kdevelop; usually will not know about until project construction time. It is the &CVS; system which will figure out those errors when it tries to build the repository. Hence you must keep an eye to the <guilabel>Messages</guilabel> window of &kdevelop; when the project is created in the final setup step. If anything was in error with &CVS; you will in most cases see an error message like this:
When any information of all these is wrong &tdevelop; usually will not know about until project construction time. It is the &CVS; system which will figure out those errors when it tries to build the repository. Hence you must keep an eye to the <guilabel>Messages</guilabel> window of &tdevelop; when the project is created in the final setup step. If anything was in error with &CVS; you will in most cases see an error message like this:
</para>
<screen><computeroutput>
@ -606,7 +606,7 @@ When any information of all these is wrong &kdevelop; usually will not know abou
</computeroutput></screen>
<para>
If this happens you will have to either manually set up &CVS; (&kdevelop; should have successfully initialized your project files at this time) or delete the project directory and start over again with <guimenuitem>New Project</guimenuitem> from the <guimenu>Project</guimenu> menu.
If this happens you will have to either manually set up &CVS; (&tdevelop; should have successfully initialized your project files at this time) or delete the project directory and start over again with <guimenuitem>New Project</guimenuitem> from the <guimenu>Project</guimenu> menu.
</para>
</note>
@ -675,10 +675,10 @@ As you might have noticed, the applications manager did readily fill in some inf
<tertiary>edit</tertiary></indexterm>
<para>
The templates you set up in the <guilabel>Create New Project</guilabel> dialog will later be processed whenever you command &kdevelop; to set up a new source and/or header file. The information you provided here will be included at top as a documentation header, before the code parts begin.
The templates you set up in the <guilabel>Create New Project</guilabel> dialog will later be processed whenever you command &tdevelop; to set up a new source and/or header file. The information you provided here will be included at top as a documentation header, before the code parts begin.
</para>
<para>
You are not restricted to plain text however. &kdevelop; knows of several variables which allow you to include actual information in the file. The &appwizard; did in fact use some such variables to insert the <guilabel>Author</guilabel>, <guilabel>Email</guilabel>, and <guilabel>License</guilabel> informations into the initial template text.
You are not restricted to plain text however. &tdevelop; knows of several variables which allow you to include actual information in the file. The &appwizard; did in fact use some such variables to insert the <guilabel>Author</guilabel>, <guilabel>Email</guilabel>, and <guilabel>License</guilabel> informations into the initial template text.
</para>
<variablelist>
@ -695,7 +695,7 @@ If, for example, you want the &doxygen;-built &API; documentation to display som
**/
</computeroutput></screen>
<para>
Whenever you create a new source file, &kdevelop; will replace the <varname>$MODULE$</varname> variable by the name body of the newly created file. For example, if you created a new C++ class named <classname>ASimpleTest</classname> you will see the following lines in the <filename>asimpletest.cpp</filename> file:
Whenever you create a new source file, &tdevelop; will replace the <varname>$MODULE$</varname> variable by the name body of the newly created file. For example, if you created a new C++ class named <classname>ASimpleTest</classname> you will see the following lines in the <filename>asimpletest.cpp</filename> file:
</para>
<screen><computeroutput>
/**
@ -735,7 +735,7 @@ for the <acronym>GPL</acronym> license, or
if you decided to put your application under the <acronym>BSD</acronym> license.
</para>
<para>
Thee are of course more variables &kdevelop; knows of. See the <link linkend="newfiles-edittemplates">Editing the templates</link> section in the <link linkend="editing">Editing tools</link> chapter for what is possible.
Thee are of course more variables &tdevelop; knows of. See the <link linkend="newfiles-edittemplates">Editing the templates</link> section in the <link linkend="editing">Editing tools</link> chapter for what is possible.
</para>
</listitem>
</varlistentry>
@ -773,7 +773,7 @@ If you want to use a versioning system (&CVS;) there will be two runs actually.
</para>
<note><para>
In many cases when your new project has been set up this way, &kdevelop; will automatically load the source file(s) of one or more basically important modules so you can readily start work. (Which source modules will be displayed—if any at all—however depends on the template initially selected in the &appwizard;.)
In many cases when your new project has been set up this way, &tdevelop; will automatically load the source file(s) of one or more basically important modules so you can readily start work. (Which source modules will be displayed—if any at all—however depends on the template initially selected in the &appwizard;.)
The initial contents of this manual were witten by Bernd Gehrmann <email>bernd@kdevelop.org</email> and Caleb Tennis <email>caleb@aei-tech.com</email>.
The initial contents of this manual were witten by Bernd Gehrmann <email>bernd@tdevelop.org</email> and Caleb Tennis <email>caleb@aei-tech.com</email>.
</para></listitem>
<listitem><para>
The <link linkend="automake-manager-summary">Summary of &automanag;</link> and <link linkend="automake-manager-operation">Automake Manager Operation</link> chapters were written by Ian Wadham, <email>ianw@netspace.net.au</email>).
In this chapter we will discuss the steps necessary to compile and install the &kdevelop; IDE:
In this chapter we will discuss the steps necessary to compile and install the &tdevelop; IDE:
<itemizedlist>
<listitem><para>
<link linkend="kdevelop-install-howto">How to obtain &kdevelop;</link> mainly concentrates on downloading the most recent &kdevelop; sources from svn.
<link linkend="tdevelop-install-howto">How to obtain &tdevelop;</link> mainly concentrates on downloading the most recent &tdevelop; sources from svn.
</para></listitem>
<listitem><para>
<link linkend="requirements">&kdevelop; requirements</link> lists the programs and libraries which you need installed to successfully compile the IDE.
<link linkend="requirements">&tdevelop; requirements</link> lists the programs and libraries which you need installed to successfully compile the IDE.
</para></listitem>
<listitem><para>
<link linkend="compile-and-install">&kdevelop; compilation and installation</link> leads you through all the steps of compilation and installation of the application.
<link linkend="compile-and-install">&tdevelop; compilation and installation</link> leads you through all the steps of compilation and installation of the application.
</para></listitem>
<listitem><para>
<link linkend="make-api">How to obtain a &kdevelop; &API; documentation</link> tells what an API is and how you get such a useful tool for navigating the &kdevelop; sources.
<link linkend="make-api">How to obtain a &tdevelop; &API; documentation</link> tells what an API is and how you get such a useful tool for navigating the &tdevelop; sources.
</para></listitem>
</itemizedlist>
</para>
<sect1 id="kdevelop-install-howto">
<title>How to Obtain &kdevelop;</title>
<sect1 id="tdevelop-install-howto">
<title>How to Obtain &tdevelop;</title>
<indexterm zone="kdevelop-install-howto">
<primary>obtain &kdevelop;</primary></indexterm>
<indexterm zone="kdevelop-install-howto">
<primary>&kdevelop;</primary>
<indexterm zone="tdevelop-install-howto">
<primary>obtain &tdevelop;</primary></indexterm>
<indexterm zone="tdevelop-install-howto">
<primary>&tdevelop;</primary>
<secondary>obtain</secondary></indexterm>
<para>
&kdevelop; is available in binary form from many different &Linux; distributions such as <!--&SuSE;, &RedHat;//--> SuSE, RedHat and others. These binaries are packed in some convenient format, mostly RPM, for easy installation. To install, follow the standard instructions given in your distribution.
&tdevelop; is available in binary form from many different &Linux; distributions such as <!--&SuSE;, &RedHat;//--> SuSE, RedHat and others. These binaries are packed in some convenient format, mostly RPM, for easy installation. To install, follow the standard instructions given in your distribution.
</para>
<para>
You may as well obtain the &kdevelop; sources, compile and install them by yourself. These sources can be found via the project home page at <ulink url="http://www.kdevelop.org"> http://www.kdevelop.org</ulink> or via the <ulink url="http://download.kde.org">&kde; ftp site</ulink>.
You may as well obtain the &tdevelop; sources, compile and install them by yourself. These sources can be found via the project home page at <ulink url="http://www.tdevelop.org"> http://www.tdevelop.org</ulink> or via the <ulink url="http://download.kde.org">&kde; ftp site</ulink>.
</para>
<sect2 id="howto-svn">
<title>Get Daily &kdevelop; Snapshots from svn</title>
<title>Get Daily &tdevelop; Snapshots from svn</title>
<indexterm zone="howto-svn">
<primary>svn</primary></indexterm>
<para>If you want to be in front of current development, anonymous svn repository snapshots are available.</para>
<para>The module name is <emphasis>kdevelop</emphasis> at <filename class="directory">svn co svn://anonsvn.kde.org/home/kde/branches/KDE/3.5/kdevelop</filename>.
<para>The module name is <emphasis>tdevelop</emphasis> at <filename class="directory">svn co svn://anonsvn.kde.org/home/kde/branches/KDE/3.5/tdevelop</filename>.
</para>
<sect3 id="howto-svn-co">
@ -64,16 +64,16 @@ You may as well obtain the &kdevelop; sources, compile and install them by yours
<indexterm zone="howto-svn-co">
<primary>checkout</primary></indexterm>
<indexterm zone="howto-svn-co">
<primary>&kdevelop;</primary>
<primary>&tdevelop;</primary>
<secondary>svn</secondary>
<tertiary>checkout</tertiary></indexterm>
<para>
To obtain an initial version of &kdevelop; you must download it from anonymous svn. For this so-called <emphasis>checkout</emphasis> operation follow these steps.
To obtain an initial version of &tdevelop; you must download it from anonymous svn. For this so-called <emphasis>checkout</emphasis> operation follow these steps.
</para>
<note><para>
We assume you want to put your &kdevelop; copy into the <filename class="directory">trinitysrc</filename> subdirectory of your home directory (<filename class="directory">~</filename>).
We assume you want to put your &tdevelop; copy into the <filename class="directory">trinitysrc</filename> subdirectory of your home directory (<filename class="directory">~</filename>).
</para></note>
<informalexample><simplelist>
@ -90,24 +90,24 @@ We assume you want to put your &kdevelop; copy into the <filename class="directo
</member>
<member>
<prompt>~/trinitysrc> </prompt>
<userinput>svn co svn://anonsvn.kde.org/home/kde/branches/KDE/3.5/kdevelop</userinput>
<userinput>svn co svn://anonsvn.kde.org/home/kde/branches/KDE/3.5/tdevelop</userinput>
</member>
<member>
<prompt>~/trinitysrc> </prompt>
<userinput>cd kdevelop</userinput>
<userinput>cd tdevelop</userinput>
</member>
</simplelist></informalexample>
<note><para>
Once you have successfully checked out your &kdevelop; version, you may keep up with the changes using the update procedure shown in the next section.
Once you have successfully checked out your &tdevelop; version, you may keep up with the changes using the update procedure shown in the next section.
</para></note>
<important><para>
Keep the server load low. <emphasis>Please do not checkout every time you want to keep your &kdevelop; up to date!</emphasis> Use svn update for this purpose.
Keep the server load low. <emphasis>Please do not checkout every time you want to keep your &tdevelop; up to date!</emphasis> Use svn update for this purpose.
</para></important>
<para>
Now you may compile your &kdevelop; version as shown in the <link linkend="compile-and-install">&kdevelop; Compilation and Installation</link> section.
Now you may compile your &tdevelop; version as shown in the <link linkend="compile-and-install">&tdevelop; Compilation and Installation</link> section.
</para>
</sect3> <!-- howto-svn-co -->
@ -118,12 +118,12 @@ Now you may compile your &kdevelop; version as shown in the <link linkend="compi
<indexterm zone="howto-svn-up">
<primary>update</primary></indexterm>
<indexterm zone="howto-svn-up">
<primary>&kdevelop;</primary>
<primary>&tdevelop;</primary>
<secondary>svn</secondary>
<tertiary>update</tertiary></indexterm>
<para>
After you checked out (and successfully compiled) &kdevelop; from svn as shown above, you'll want to keep it up to date in order to get all the patches. Follow these steps. (We again assume you have put your &kdevelop; copy into the <filename class="directory">trinitysrc</filename> directory.)
After you checked out (and successfully compiled) &tdevelop; from svn as shown above, you'll want to keep it up to date in order to get all the patches. Follow these steps. (We again assume you have put your &tdevelop; copy into the <filename class="directory">trinitysrc</filename> directory.)
</para>
<para>
Note the <command>up</command> (= <emphasis>update</emphasis>) command instead of the <command>co</command> (which stands for <emphasis>checkout</emphasis>).
@ -136,7 +136,7 @@ Note the <command>up</command> (= <emphasis>update</emphasis>) command instead o
</member>
<member>
<prompt>~/trinitysrc> </prompt>
<userinput>cd kdevelop</userinput>
<userinput>cd tdevelop</userinput>
</member>
<member>
<prompt>~/trinitysrc> </prompt>
@ -149,7 +149,7 @@ Keep an eye on the messages svn produces during the update sequence. The exact s
</para></note>
<para>
Now you can compile a new &kdevelop; version as shown in the <link linkend="compile-and-install-make-svn">Special svn compilation considerations</link> chapter.
Now you can compile a new &tdevelop; version as shown in the <link linkend="compile-and-install-make-svn">Special svn compilation considerations</link> chapter.
</para>
</sect3> <!-- howto-svn-up -->
@ -160,19 +160,19 @@ Now you can compile a new &kdevelop; version as shown in the <link linkend="comp
In order to successfully compile and use &kdevelop;, you need the following programs and libraries. They are available on most platforms as distribution packages and thereby can be installed easily.
In order to successfully compile and use &tdevelop;, you need the following programs and libraries. They are available on most platforms as distribution packages and thereby can be installed easily.
</para>
<itemizedlist>
@ -306,7 +306,7 @@ In order to successfully compile and use &kdevelop;, you need the following prog
<orderedlist>
<listitem>
<para>
You can, to a certain extent, circumvent the need for &autoconf; ≥ 2.52 and &automake; ≥ 1.6. Just remove the <filename class="directory">admin</filename> directory in your &kdevelop; installation directory and type
You can, to a certain extent, circumvent the need for &autoconf; ≥ 2.52 and &automake; ≥ 1.6. Just remove the <filename class="directory">admin</filename> directory in your &tdevelop; installation directory and type
<indexterm>
<primary>autoconf</primary>
<secondary>circumvent version need</secondary></indexterm>
@ -318,16 +318,16 @@ In order to successfully compile and use &kdevelop;, you need the following prog
<secondary>circumvent for autoconf/automake</secondary></indexterm>
at the console. This causes &kdevelop; to use the standard settings in the &kde; <filename class="directory">admin</filename> directory instead.
at the console. This causes &tdevelop; to use the standard settings in the &kde; <filename class="directory">admin</filename> directory instead.
</para>
</listitem>
<listitem>
<para>
Be careful <emphasis>not to mix &Qt; versions</emphasis>. Always link &kdevelop; to the same &Qt; version your &kde; library was compiled. Otherwise you will most likely experience <emphasis>very strange</emphasis> behaviours.
Be careful <emphasis>not to mix &Qt; versions</emphasis>. Always link &tdevelop; to the same &Qt; version your &kde; library was compiled. Otherwise you will most likely experience <emphasis>very strange</emphasis> behaviours.
</para>
</listitem>
</orderedlist>
@ -338,27 +338,27 @@ In order to successfully compile and use &kdevelop;, you need the following prog
<title>&kdevelop; Compilation and Installation</title>
<title>&tdevelop; Compilation and Installation</title>
<indexterm zone="compile-and-install">
<primary>&kdevelop;</primary>
<primary>&tdevelop;</primary>
<secondary>compilation</secondary></indexterm>
<indexterm zone="compile-and-install">
<primary>&kdevelop;</primary>
<primary>&tdevelop;</primary>
<secondary>installation</secondary></indexterm>
<para>
Once all requirements are met, you are ready to compile and install &kdevelop;. This appendix will discuss the necessary steps to do so.
Once all requirements are met, you are ready to compile and install &tdevelop;. This appendix will discuss the necessary steps to do so.
</para>
<itemizedlist>
<listitem><para>
<link linkend="compile-and-install-preliminaries">Preliminary Steps</link> tells you about setting up a proper environment.
</para></listitem>
<listitem><para>
<link linkend="compile-and-install-make">Compile &kdevelop;</link> deals with obtaining the &kdevelop; sources from svn, how to prepare them for the installation process, and finally shows the steps necessary to compile and install &kdevelop;.
<link linkend="compile-and-install-make">Compile &tdevelop;</link> deals with obtaining the &tdevelop; sources from svn, how to prepare them for the installation process, and finally shows the steps necessary to compile and install &tdevelop;.
</para></listitem>
<listitem><para>
<link linkend="compile-and-install-options">Some Notes on configure Options</link> tells you how to run &kdevelop; if it has been installed in a location other than the &kde; directory.
<link linkend="compile-and-install-options">Some Notes on configure Options</link> tells you how to run &tdevelop; if it has been installed in a location other than the &kde; directory.
</para></listitem>
</itemizedlist>
@ -367,7 +367,7 @@ Once all requirements are met, you are ready to compile and install &kdevelop;.
In the following discussion we assume that you have put your &kdevelop; sources in the <filename class="directory">~/trinitysrc/kdevelop</filename> directory.
In the following discussion we assume that you have put your &tdevelop; sources in the <filename class="directory">~/trinitysrc/tdevelop</filename> directory.
In case you use a &kdevelop; snapshot from svn the initial compilation steps depend on whether you just did a complete checkout or only updated the source.
In case you use a &tdevelop; snapshot from svn the initial compilation steps depend on whether you just did a complete checkout or only updated the source.
</para>
<variablelist>
@ -455,7 +455,7 @@ You must <emphasis>initialize the make system</emphasis> after a fresh checkout.
Once the basic make system is set up you must decide which type of the &kdevelop; system you want to use. This is done in the following configure step which builds the actual <filename>Makefile</filename>s the <command>make</command> command will use.
Once the basic make system is set up you must decide which type of the &tdevelop; system you want to use. This is done in the following configure step which builds the actual <filename>Makefile</filename>s the <command>make</command> command will use.
</para>
<note><para>
You may drop the <option>--prefix</option> option in the following <command>configure</command> command lines if you want &kdevelop; be installed in the default &kde; directory. See the <link linkend="compile-and-install-options">Some notes on configure options</link> chapter for this.
You may drop the <option>--prefix</option> option in the following <command>configure</command> command lines if you want &tdevelop; be installed in the default &kde; directory. See the <link linkend="compile-and-install-options">Some notes on configure options</link> chapter for this.
</para></note>
<variablelist>
@ -511,11 +511,11 @@ You may drop the <option>--prefix</option> option in the following <command>conf
<term>A Debug-Compiled Version</term>
<listitem>
<para>
If you want to keep track of what your &kdevelop; application does at run-time you may build a debug-compiled version. Just command <command>configure</command> to do so:
If you want to keep track of what your &tdevelop; application does at run-time you may build a debug-compiled version. Just command <command>configure</command> to do so:
If you want to build your own <link linkend="make-api">API documentation</link> for &kdevelop; you must include yet another option in the <command>configure</command> command:
If you want to build your own <link linkend="make-api">API documentation</link> for &tdevelop; you must include yet another option in the <command>configure</command> command:
<command>configure</command> will check the system and build some <filename>Makefile</filename>s according to what it found. The <command>make</command> command will use the main <filename>Makefile</filename> by default. Thus
</para>
<informalexample><simplelist><member>
<prompt>~/trinitysrc/kdevelop> </prompt>
<prompt>~/trinitysrc/tdevelop> </prompt>
<userinput>make</userinput>
</member></simplelist></informalexample>
<para>
suffices. If necessary, now gain root user rights using the command
</para>
<informalexample><simplelist><member>
<prompt>~/trinitysrc/kdevelop> </prompt>
<prompt>~/trinitysrc/tdevelop> </prompt>
<userinput>su</userinput>
</member></simplelist></informalexample>
<para>
and entering the root password. Then install the application:
</para>
<informalexample><simplelist><member>
<prompt>~/trinitysrc/kdevelop> </prompt>
<prompt>~/trinitysrc/tdevelop> </prompt>
<userinput>make install</userinput>
</member></simplelist></informalexample>
<para>
That's all. If you installed &kdevelop; in the default &kde; directory you may now run the IDE. Otherwise some additional steps will be necessary as shown in the <link linkend="compile-and-install-options-dir">Non-default installation directory</link> section below.
That's all. If you installed &tdevelop; in the default &kde; directory you may now run the IDE. Otherwise some additional steps will be necessary as shown in the <link linkend="compile-and-install-options-dir">Non-default installation directory</link> section below.
</para>
<note>
<para>
In fact there usually will have been three &kdevelop;-based applications installed:
In fact there usually will have been three &tdevelop;-based applications installed:
</para>
<itemizedlist>
<listitem><para>The &kdevelop; IDE — this is the place where you will usually work.</para></listitem>
<listitem><para>The stand-alone &kdevelop; Assistant documentation browser — isolates all the powerful documentation facilities of the &kdevelop; IDE in a separate tool. This comes in handy when you want to look up some programming documentation but do not want to start the full IDE.</para></listitem>
<listitem><para>The &kdevelop; Designer — enhances the &Qt; User Interface Designer by &kde; specific elements and integrates nicely in the &kdevelop; IDE.</para></listitem>
<listitem><para>The &tdevelop; IDE — this is the place where you will usually work.</para></listitem>
<listitem><para>The stand-alone &tdevelop; Assistant documentation browser — isolates all the powerful documentation facilities of the &tdevelop; IDE in a separate tool. This comes in handy when you want to look up some programming documentation but do not want to start the full IDE.</para></listitem>
<listitem><para>The &tdevelop; Designer — enhances the &Qt; User Interface Designer by &kde; specific elements and integrates nicely in the &tdevelop; IDE.</para></listitem>
</itemizedlist>
</note>
</listitem>
@ -600,7 +600,7 @@ That's all. If you installed &kdevelop; in the default &kde; directory you may n
@ -611,17 +611,17 @@ That's all. If you installed &kdevelop; in the default &kde; directory you may n
<primary>kbuildsycoca</primary></indexterm>
<para>
By default <command>configure</command> prepares the IDE to be installed in the default &kde; directory. This is necessary because &kdevelop; assumes direct access to some tools and parts which reside there. If want to use your own installation directory, you must tell <command>configure</command> this by the <option>--prefix</option> option:
By default <command>configure</command> prepares the IDE to be installed in the default &kde; directory. This is necessary because &tdevelop; assumes direct access to some tools and parts which reside there. If want to use your own installation directory, you must tell <command>configure</command> this by the <option>--prefix</option> option:
There is a caveat if you do so. You must provide a means for &kdevelop; to access the needed tools and parts in the &kde; directory when running. (You can still use the IDE without doing so, but with very restrained capabilities.)
There is a caveat if you do so. You must provide a means for &tdevelop; to access the needed tools and parts in the &kde; directory when running. (You can still use the IDE without doing so, but with very restrained capabilities.)
</para>
<para>
Call up a shell and have the following commands executed before you start &kdevelop; at the shell prompt.
Call up a shell and have the following commands executed before you start &tdevelop; at the shell prompt.
</para>
<note><para>
@ -638,11 +638,11 @@ Call up a shell and have the following commands executed before you start &kdeve
<userinput>kbuildsycoca</userinput>
</member>
<member>
(Now start &kdevelop;:)
(Now start &tdevelop;:)
</member>
<member>
<prompt>~> </prompt>
<userinput>kdevelop</userinput>
<userinput>tdevelop</userinput>
</member>
</simplelist></informalexample>
@ -661,7 +661,7 @@ In a tcsh shell you must set the environment variables using:
The <command>kbuildsycoca</command> command (<quote>build system control cache</quote>) looks around for libraries and caches their location and version, so that &kdevelop; can find them. The caveat is that it takes noticeable time—and it has to be run any time you call up the shell to start &kdevelop; from a non-default directory. You may want to put the above commands into a shell script to reduce the typing effort.
The <command>kbuildsycoca</command> command (<quote>build system control cache</quote>) looks around for libraries and caches their location and version, so that &tdevelop; can find them. The caveat is that it takes noticeable time—and it has to be run any time you call up the shell to start &tdevelop; from a non-default directory. You may want to put the above commands into a shell script to reduce the typing effort.
</para>
<para>
(You could as well put the lines in your <filename>.bashrc</filename> or <filename>.cshrc</filename> file, but this is not advisable as <command>kbuildsycoca</command> will then be run any time you call up the shell.)
@ -679,56 +679,56 @@ The <command>kbuildsycoca</command> command does not run from within the root. Y
</sect1> <!-- compile-and-install -->
<sect1 id="make-api">
<title>How to Obtain a &kdevelop; API Documentation</title>
<title>How to Obtain a &tdevelop; API Documentation</title>
<indexterm zone="make-api">
<primary>API</primary>
<secondary>&kdevelop;</secondary></indexterm>
<secondary>&tdevelop;</secondary></indexterm>
<indexterm zone="make-api">
<primary>&kdevelop;</primary>
<primary>&tdevelop;</primary>
<secondary>API</secondary></indexterm>
<indexterm zone="make-api">
<primary>compiling</primary>
<secondary>&kdevelop;</secondary>
<secondary>&tdevelop;</secondary>
<tertiary>API</tertiary></indexterm>
<indexterm zone="make-api">
<primary>configure</primary>
<secondary>&kdevelop; API</secondary></indexterm>
<secondary>&tdevelop; API</secondary></indexterm>
<para>
API is the short form of <quote>Application Program Interface</quote>. Actually such an API cotains a series of descriptions (&ie; calling conventions) by which an application program can access the operating system and other services. In our context, however, a broader definition was adopted. The API of a &kde; or &Qt; application is an abstract of the classes and methods interfaces, a synopsis to be used like a dictionary to navigate the sources.
</para>
<para>
There is a version of the most current API available at the <ulink url="http://www.kdevelop.org/HEAD/doc/api/html/index.html">KDevelop-Home website</ulink>. It will be automatically updated every 24 hours so you can keep up.
There is a version of the most current API available at the <ulink url="http://www.tdevelop.org/HEAD/doc/api/html/index.html">KDevelop-Home website</ulink>. It will be automatically updated every 24 hours so you can keep up.
</para>
<para>
Alas, this version is best used read-only over the internet. If you do not always have internet access you may as well build your own API documentation from the &kdevelop; sources. To do so, you must tell the automake system where to find the KDELIBS API in your system. This is accomplished by the special option <option>--with-kdelibsdoxy-dir</option> in the <command>configure</command> command when you prepare to compile the &kdevelop; sources:
Alas, this version is best used read-only over the internet. If you do not always have internet access you may as well build your own API documentation from the &tdevelop; sources. To do so, you must tell the automake system where to find the KDELIBS API in your system. This is accomplished by the special option <option>--with-tdelibsdoxy-dir</option> in the <command>configure</command> command when you prepare to compile the &tdevelop; sources:
(<command>make</command> will replace the global <varname>$KDEDIR</varname> variable with the actual &kde; directory setting recorded therein.) Then issue a <command>make</command> command <link linkend="compile-and-install-make-basic">as usual</link>. After the &kdevelop; IDE has been built you have the option to build the API as well. For this you must issue
(<command>make</command> will replace the global <varname>$KDEDIR</varname> variable with the actual &kde; directory setting recorded therein.) Then issue a <command>make</command> command <link linkend="compile-and-install-make-basic">as usual</link>. After the &tdevelop; IDE has been built you have the option to build the API as well. For this you must issue
</para>
<informalexample><simplelist><member>
<prompt>~/trinitysrc/kdevelop> </prompt>
<prompt>~/trinitysrc/tdevelop> </prompt>
<userinput>make apidocs</userinput>
</member></simplelist></informalexample>
<para>
This will build a <filename>Doxyfile</filename> in your &kdevelop; base directory which in turn will be processed by the <application>Doxygen</application> application to build quite a lot of <filename>.html</filename> API files. When this rather lengthy API building process (may last more than an hour on a slow system) finally comes to an end, you must install the API just like you have to install the &kdevelop; IDE itself. If necessary obtain superuser rights by
This will build a <filename>Doxyfile</filename> in your &tdevelop; base directory which in turn will be processed by the <application>Doxygen</application> application to build quite a lot of <filename>.html</filename> API files. When this rather lengthy API building process (may last more than an hour on a slow system) finally comes to an end, you must install the API just like you have to install the &tdevelop; IDE itself. If necessary obtain superuser rights by
</para>
<informalexample><simplelist><member>
<prompt>~/trinitysrc/kdevelop> </prompt>
<prompt>~/trinitysrc/tdevelop> </prompt>
<userinput>su</userinput>
</member></simplelist></informalexample>
@ -737,18 +737,18 @@ and entering the root password. Then install the API files:
</para>
<informalexample><simplelist><member>
<prompt>~/trinitysrc/kdevelop> </prompt>
<prompt>~/trinitysrc/tdevelop> </prompt>
<userinput>make install-apidox</userinput>
</member></simplelist></informalexample>
<para>
Once this is done, <command>make</command> will inform you about the directory where you can finally look at the API documentation's contents. Note this address, you can use it from &konqueror; as well as from inside &kdevelop;, in case you have set up the &kdevelop; sources themselves as a project to work on.
Once this is done, <command>make</command> will inform you about the directory where you can finally look at the API documentation's contents. Note this address, you can use it from &konqueror; as well as from inside &tdevelop;, in case you have set up the &tdevelop; sources themselves as a project to work on.
</para>
<note><para>
You will most probably see a lot of warning and/or error messages during the API build run by <application>Doxygen</application>. It is best to ignore them, they are of interest to the &kdevelop; developers only. If the API generation ever comes to a successful end, the <filename>.html</filename> API files will be usable.
You will most probably see a lot of warning and/or error messages during the API build run by <application>Doxygen</application>. It is best to ignore them, they are of interest to the &tdevelop; developers only. If the API generation ever comes to a successful end, the <filename>.html</filename> API files will be usable.
To access a script that is available to &kdevelop; use the <menuchoice><guimenu>Tools</guimenu><guimenuitem>Scripts</guimenuitem></menuchoice> menu. If there there is no such menu item then there are no installed scripts available to KDevelop.
To access a script that is available to &tdevelop; use the <menuchoice><guimenu>Tools</guimenu><guimenuitem>Scripts</guimenuitem></menuchoice> menu. If there there is no such menu item then there are no installed scripts available to KDevelop.
</para>
</sect1>
@ -30,7 +30,7 @@ The next step is to create the actual script. For the above example the Type of
<para>One of the most useful tools in developing scripts for applications is the KDCOP application.</para>
<figure id="screenshot-kdcop" float="1">
<title>KDCOP Browsing DCOP Interfaces in &kdevelop;</title>
<title>KDCOP Browsing DCOP Interfaces in &tdevelop;</title>
@ -41,7 +41,7 @@ The next step is to create the actual script. For the above example the Type of
<para>Once the script is complete it is ready to be installed. Application developers should document the location that will be scanned for scripts. In the case of the above example for Kate the scripts are located in "$KDEDIRS/share/apps/kate/scripts".</para>
<figure id="screenshot-scripts" float="1">
<title>&kdevelop; Scripts on the Filesystem</title>
<title>&tdevelop; Scripts on the Filesystem</title>
&kdevelop; integrates a lot of tools, scripts, and templates in a common user interface. Basically it consists of
&tdevelop; integrates a lot of tools, scripts, and templates in a common user interface. Basically it consists of
<itemizedlist>
<listitem><para>
@ -40,7 +40,7 @@
various <link linkend="class-browsers">class browsers</link> to aid you in maintaining the classes and their relationships of your object-oriented programming project,
</para></listitem>
<listitem><para>
a <link linkend="debugger">debugger interface</link> to find and remove program errors from within &kdevelop;, and
a <link linkend="debugger">debugger interface</link> to find and remove program errors from within &tdevelop;, and
</para></listitem>
<listitem><para>
several <link linkend="plugin-tools">plugin tools</link>, extensible modules which can be loaded at runtime and on demand. This allows you to only turn on those features you really need.
@ -53,12 +53,12 @@
<note>
<para>
In fact there are three &kdevelop;-based applications:
In fact there are three &tdevelop;-based applications:
</para>
<itemizedlist>
<listitem><para>The &kdevelop; IDE — this is the place where you will usually work.</para></listitem>
<listitem><para>The stand-alone &kdevelop; Assistant documentation browser — isolates all the powerful documentation facilities of the &kdevelop; IDE in a separate tool. This comes in handy when you want to look up some programming documentation but do not want to start the full IDE.</para></listitem>
<listitem><para>The &kdevelop; Designer — enhances the &Qt; User Interface Designer by &kde; specific elements and integrates nicely in the &kdevelop; IDE.</para></listitem>
<listitem><para>The &tdevelop; IDE — this is the place where you will usually work.</para></listitem>
<listitem><para>The stand-alone &tdevelop; Assistant documentation browser — isolates all the powerful documentation facilities of the &tdevelop; IDE in a separate tool. This comes in handy when you want to look up some programming documentation but do not want to start the full IDE.</para></listitem>
<listitem><para>The &tdevelop; Designer — enhances the &Qt; User Interface Designer by &kde; specific elements and integrates nicely in the &tdevelop; IDE.</para></listitem>
@ -160,7 +160,7 @@ To switch the user interface mode select <menuchoice> <guimenu>Settings</guimenu
</screenshot>
<para>
(Older &kdevelop; versions provide the top mode selection section only.)
(Older &tdevelop; versions provide the top mode selection section only.)
</para>
<para>
@ -171,7 +171,7 @@ Dependent on the user interface mode you selected, other configuration sections
</para>
<note><para>
Do not forget to restart &kdevelop; in order to let your selections take effect.
Do not forget to restart &tdevelop; in order to let your selections take effect.
</para></note>
</sect2> <!-- uimodes-switch -->
@ -180,10 +180,10 @@ Do not forget to restart &kdevelop; in order to let your selections take effect.
<title>How to Maximize the Work Space Area</title>
<indexterm zone="maximize-workspace">
<primary>&kdevelop;</primary>
<primary>&tdevelop;</primary>
<secondary>work space</secondary></indexterm>
<indexterm zone="maximize-workspace">
<primary>&kdevelop;</primary>
<primary>&tdevelop;</primary>
<secondary>maximize work space</secondary></indexterm>
<indexterm zone="maximize-workspace">
<primary>user interface</primary>
@ -254,7 +254,7 @@ To <emphasis>hide</emphasis> the menubar select <menuchoice> <guimenu>Settings</
</sect2> <!-- ui-elements-workarea -->
<sect2 id="ui-elements-titlebar">
<title>The &kdevelop; Titlebar</title>
<title>The &tdevelop; Titlebar</title>
<para>
(... to be written ...)
@ -262,7 +262,7 @@ To <emphasis>hide</emphasis> the menubar select <menuchoice> <guimenu>Settings</
</sect2> <!-- ui-elements-titlebar -->
<sect2 id="ui-elements-statusbar">
<title>The &kdevelop; Statusbar</title>
<title>The &tdevelop; Statusbar</title>
<para>
(... to be written ...)
@ -312,7 +312,7 @@ To <emphasis>hide</emphasis> the menubar select <menuchoice> <guimenu>Settings</
<primary>project management</primary></indexterm>
<para>
Globally, a project will rely on some form of project management system. &kdevelop; offers four <emphasis>project management systems</emphasis> the programmer can select from when creating a new project.
Globally, a project will rely on some form of project management system. &tdevelop; offers four <emphasis>project management systems</emphasis> the programmer can select from when creating a new project.
<itemizedlist>
<listitem><para>
@ -341,7 +341,7 @@ Globally, a project will rely on some form of project management system. &kdeve
<secondary>projects</secondary></indexterm>
<para>
Projects created with &kdevelop;'s &automanag; make it very easy for developers to use the &GNU; standard development tools. They provide
Projects created with &tdevelop;'s &automanag; make it very easy for developers to use the &GNU; standard development tools. They provide
<itemizedlist>
<listitem><para>
a better way of <filename>Makefile</filename> generation and
@ -364,7 +364,7 @@ Projects created with &kdevelop;'s &automanag; make it very easy for developers
<secondary>projects</secondary></indexterm>
<para>
For developers who enjoy the flexibility and feel of &Qt;'s qmake system, &kdevelop; offers the ability to handle qmake based projects (.pro files) within the &GUI;.
For developers who enjoy the flexibility and feel of &Qt;'s qmake system, &tdevelop; offers the ability to handle qmake based projects (.pro files) within the &GUI;.
</para>
<para>
For more information on the QMake project manager see the <quote>qmake User Guide</quote> which should be included in your distribution or have a look at the <ulink url="http://doc.trolltech.com/">TROLLTECH Documentation</ulink> home page where you may find the QMake documentation of your <quote>Qt C++ GUI Application Development Toolkit</quote> version.
@ -382,12 +382,12 @@ For more information on the QMake project manager see the <quote>qmake User Guid
<secondary>projects</secondary></indexterm>
<para>
CMake will be the &kde; build system for &kde; 4 and &kdevelop; already
CMake will be the &kde; build system for &kde; 4 and &tdevelop; already
provides you some CMake based templates in C and C++. You only need the cmake
program in your $<envar>PATH</envar> to build them.
</para>
<para>
To set up a new C or C++ project in &kdevelop; select
To set up a new C or C++ project in &tdevelop; select
<menuchoice><guimenu>Project</guimenu>
<guimenuitem>New Project...</guimenuitem>
<guimenuitem>C or C++</guimenuitem>
@ -417,7 +417,7 @@ To set up a new C or C++ project in &kdevelop; select
<secondary>Java</secondary></indexterm>
<para>
&Java; developers may want to use the Apache ANT project manager for their projects. To set up a new Ant project in &kdevelop; select <menuchoice><guimenu>Project</guimenu>
&Java; developers may want to use the Apache ANT project manager for their projects. To set up a new Ant project in &tdevelop; select <menuchoice><guimenu>Project</guimenu>
<guimenuitem>New Project...</guimenuitem>
<guimenuitem>Java</guimenuitem>
<guimenuitem>Ant Project</guimenuitem>
@ -441,7 +441,7 @@ For more information see <ulink url="http://ant.apache.org/">The Apache Ant Proj
If you prefer to maintain your own <filename>Makefiles</filename> for your project you may use the custom project option of &kdevelop;. This may be feasible in unusually structured projects or if you want to retain full control over the <command>make</command> process.
If you prefer to maintain your own <filename>Makefiles</filename> for your project you may use the custom project option of &tdevelop;. This may be feasible in unusually structured projects or if you want to retain full control over the <command>make</command> process.
</para>
<para>
Yet, if you do not <emphasis>really need</emphasis> the extra flexibility and control of the custom project manager you should consider &automanag; or one of the other project managers, because they considerably ease the program building and distribution processes.
@ -470,10 +470,10 @@ The distribution of your applications does not require the end-user to have anyt
<para>
which at least for C++ applications is most often the case. But you can as well distribute <emphasis>binary packages</emphasis> of your application.
<!-- ### more detail on binary construction needed somewhere -->
In either way, the end-user of your product does not need &kdevelop; installed.
In either way, the end-user of your product does not need &tdevelop; installed.
</para>
<para>
For giving away your sources, we advise to include the <emphasis>project file</emphasis> of &kdevelop; as well. This makes it very easy for other developers—if they use &kdevelop;—to work with your sources.
For giving away your sources, we advise to include the <emphasis>project file</emphasis> of &tdevelop; as well. This makes it very easy for other developers—if they use &tdevelop;—to work with your sources.
</para>
<para>
For projects where <emphasis>several developers</emphasis>, maybe working on different places, are involved, this should be the case anyway. So you can ensure consistency of the <filename>Makefiles</filename> to not run into trouble.
@ -486,4 +486,4 @@ Especially on multi language applications, <emphasis>translators</emphasis> won'
@ -10,7 +10,7 @@ This chapter is meant to provide short hints and tips together with (mandatory)
There should be an additional FAQ section near the end nevertheless which contains more general stuff not directly related to navigating the manual. -->
<para>
The information in this chapter is meant as a quick reference for a head start or if you (momentarily) forgot about some basic concept. There are also short hints on how to solve some common problems when working with &kdevelop;.
The information in this chapter is meant as a quick reference for a head start or if you (momentarily) forgot about some basic concept. There are also short hints on how to solve some common problems when working with &tdevelop;.
</para>
<para>
If you want more information on a topic, just follow the link in the title starting that advice.
@ -34,16 +34,16 @@ Information on these topics is availabe:
<title>Converting Old KDevelop Project Files</title>
<para>
&kdevelop; allows you to open old KDevelop 2.x project files and convert them to &kdevelop; files. To do so go to <guimenuitem>Open Project...</guimenuitem> and select <guilabel>KDevelop 2 project files</guilabel> in the <guilabel>Filter:</guilabel>. Then select project file you want to open. The project gets converted to &kdevelop; and saved as a <guilabel>&kdevelop; project file</guilabel>.
&tdevelop; allows you to open old KDevelop 2.x project files and convert them to &tdevelop; files. To do so go to <guimenuitem>Open Project...</guimenuitem> and select <guilabel>KDevelop 2 project files</guilabel> in the <guilabel>Filter:</guilabel>. Then select project file you want to open. The project gets converted to &tdevelop; and saved as a <guilabel>&tdevelop; project file</guilabel>.
</para>
</sect2> <!-- converting-projects -->
@ -54,7 +54,7 @@
<title>Importing an Existing Project</title>
<para>
To import an existing directory in &kdevelop; select <guimenuitem>Import Existing Directory</guimenuitem>
To import an existing directory in &tdevelop; select <guimenuitem>Import Existing Directory</guimenuitem>
from the <guimenu>Project</guimenu> menu. You should see the Import Directory Wizard, as seen below:
@ -34,7 +34,7 @@ You will find here information on:</para>
In the <link linkend="unixdev-buildsystems">Build systems</link> chapter we have given a rough overview of the build systems commonly in use on &UNIX; systems. In the following sections we will look at this in more detail.
</para>
<para>
There is some confusion about how to name such things. &GNU; calls them <quote>build systems</quote> when it describes Automake, Autoconf and Libtool. QMake calls itself <quote>a tool to write Makefiles for different compilers and platforms</quote>. In &kde; often the term <quote>project management systems</quote> is used. We will use this term in a broader sense to describe the built-in environments in &kdevelop; which are used to organize and build your projects. In the context of this section, however, we will mostly talk about <quote>automated build systems</quote>.
There is some confusion about how to name such things. &GNU; calls them <quote>build systems</quote> when it describes Automake, Autoconf and Libtool. QMake calls itself <quote>a tool to write Makefiles for different compilers and platforms</quote>. In &kde; often the term <quote>project management systems</quote> is used. We will use this term in a broader sense to describe the built-in environments in &tdevelop; which are used to organize and build your projects. In the context of this section, however, we will mostly talk about <quote>automated build systems</quote>.
</para>
<sect2 id="automake-manager-summary-buildsys">
@ -95,7 +95,7 @@ A build system will iron out these differences for you.
</itemizedlist>
<para>
In brief, a build system offers safe and secure methods for your application to be compiled and installed correctly on any receiving machine. As we have shown before in the <link linkend="makesystems">Project Management Systems</link> survey, &kdevelop; offers three automated build systems and the option of creating your own Makefile, in short (click on the project names to get more information):
In brief, a build system offers safe and secure methods for your application to be compiled and installed correctly on any receiving machine. As we have shown before in the <link linkend="makesystems">Project Management Systems</link> survey, &tdevelop; offers three automated build systems and the option of creating your own Makefile, in short (click on the project names to get more information):
</para>
<itemizedlist>
<listitem><para>
@ -126,7 +126,7 @@ One of these four alternatives must be chosen when you create a project and <emp
There are several tutorials available on the &GNU; Build System (<command>Autoconf</command>, <command>Automake</command> and <command>Libtool</command>) of which the &automanag; makes use.
</para>
<itemizedlist>
<listitem><para>A short <ulink url="http://www.kdevelop.org/index.html?filename=tutorial_autoconf.html">autoconf tutorial</ulink> written by Christopher W. Curtis available on the &kdevelop; home page. It concentrates on some basic steps to modify a <filename>Makefile</filename>.
<listitem><para>A short <ulink url="http://www.tdevelop.org/index.html?filename=tutorial_autoconf.html">autoconf tutorial</ulink> written by Christopher W. Curtis available on the &tdevelop; home page. It concentrates on some basic steps to modify a <filename>Makefile</filename>.
</para></listitem>
<listitem><para>
A more detailed tutorial can be found in a greater set of tutorials on <ulink url="http://www.amath.washington.edu/~lf/tutorials/autoconf/toolsmanual_toc.html"><quote>Developing software with GNU</quote></ulink>.
@ -181,14 +181,14 @@ How does this work? Well <command>configure</command> is a script that
The <filename>Makefile.in</filename> are <quote>input</quote> files—templates which provide basic information for the <filename>Makefile</filename>s to be produced from them by filling in some system dependent information. They are generated by the <command>Automake</command> utility from the <filename>Makefile.am</filename> files.
</para>
<para>
The process of going from <filename>Makefile.am</filename> (<filename>.am</filename> denotes <quote>Automake</quote> template files) to <filename>Makefile</filename> files is handled automatically by the &kdevelop; &promanag;, using the <command>Autoconf</command> utility, <command>M4</command> macros and other arcana we need not go into here.
The process of going from <filename>Makefile.am</filename> (<filename>.am</filename> denotes <quote>Automake</quote> template files) to <filename>Makefile</filename> files is handled automatically by the &tdevelop; &promanag;, using the <command>Autoconf</command> utility, <command>M4</command> macros and other arcana we need not go into here.
</para>
<para>
So when <command>make</command> runs, it automatically picks up the correct pieces from the current environment, such as compilers and libraries. Similarly, <command>make install</command> puts your application components, such as executables, documentation and data files in the correct places for that environment.
</para>
<para>
If you distribute your application as a <quote>tarball</quote> (a single compressed file that &kdevelop; can create for you), it will include the <filename>Makefile.in</filename> files and the <filename>configure</filename> script file, so the recipient can compile, build and install your application without having <command>Automake</command>, <command>Autoconf</command> or &kdevelop; on their machine. The <filename>Makefile.am</filename> files are also included, just in case the receiver needs to do any source-code modifications.
If you distribute your application as a <quote>tarball</quote> (a single compressed file that &tdevelop; can create for you), it will include the <filename>Makefile.in</filename> files and the <filename>configure</filename> script file, so the recipient can compile, build and install your application without having <command>Automake</command>, <command>Autoconf</command> or &tdevelop; on their machine. The <filename>Makefile.am</filename> files are also included, just in case the receiver needs to do any source-code modifications.
</para>
<note><para>
The rules are rather different if you distribute via a web-based source-code repository such as &kde; &cvs;.
@ -290,7 +290,7 @@ As you can see, many of the items on the right hand side are symbols of the form
</para>
<para>
Also, sometime after you have started with &kdevelop;, it is a good idea to run the command <command>./configure --help</command>, which will show you the range of things you can change at build and installation time, such as for a test environment. In particular, the command:
Also, sometime after you have started with &tdevelop;, it is a good idea to run the command <command>./configure --help</command>, which will show you the range of things you can change at build and installation time, such as for a test environment. In particular, the command:
<screen>
./configure --prefix=/where/you/wish
@ -346,7 +346,7 @@ In this chapter you will find a basic description of the &automanag; elements an
On top of each view there is a <emphasis>toolbar</emphasis>, the buttons in which will become activated when an element in this view is selected. This provides one way you can access the actions provided for that view element. The other are context menus which pop up on right mouse button click as will be discussed below.
</para></listitem>
<listitem><para>
In IDEAl mode there are two additional small buttons in the &automanag; window titlebar left hand side – a triangular shaped right arrow, and a dot button. The arrow button is used to <emphasis>close the window</emphasis>. The dot button on the other hand will <emphasis>keep the window open</emphasis> even if another &kdevelop; window has been selected. (Otherwise the &automanag; window will automatically close whenever another window gets the input focus.)
In IDEAl mode there are two additional small buttons in the &automanag; window titlebar left hand side – a triangular shaped right arrow, and a dot button. The arrow button is used to <emphasis>close the window</emphasis>. The dot button on the other hand will <emphasis>keep the window open</emphasis> even if another &tdevelop; window has been selected. (Otherwise the &automanag; window will automatically close whenever another window gets the input focus.)
</para></listitem>
</itemizedlist></entry>
</row></tbody></tgroup>
@ -429,7 +429,7 @@ In both the overall and the detail view you can left-click on the <symbol>+</sym
<term>Opening a file for Edit</term>
<listitem>
<para>If you <emphasis>&LMB; click</emphasis> on a file name in the detail
view, the corresponding file opens up in &kdevelop;'s editing window.</para>
view, the corresponding file opens up in &tdevelop;'s editing window.</para>
&kdevelop; is a very powerful and flexible IDE which offers many ways to tailor it to your needs. To start configuration select <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &kdevelop;...</guimenuitem></menuchoice>. This will cause the configuration dialog to pop up consisting of a selection window to the left and the configuration dialog on the right hand side whose contents will vary upon the configuration item you did select.
&tdevelop; is a very powerful and flexible IDE which offers many ways to tailor it to your needs. To start configuration select <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &tdevelop;...</guimenuitem></menuchoice>. This will cause the configuration dialog to pop up consisting of a selection window to the left and the configuration dialog on the right hand side whose contents will vary upon the configuration item you did select.
</para>
<screenshot>
@ -56,7 +56,7 @@ If you want directly look up a certain configuration item use one of the followi
<title>General Configuration</title>
<para>
General configuration concerns the more common tasks of tailoring &kdevelop; as there are:
General configuration concerns the more common tasks of tailoring &tdevelop; as there are:
</para>
<itemizedlist>
<listitem><para>
@ -88,7 +88,7 @@ General configuration concerns the more common tasks of tailoring &kdevelop; as
<title>General Setup</title>
<para>
The <guilabel>General</guilabel> configuration dialog allows you to define some basic &kdevelop; behaviour which seldom will change in everyday work. This concerns:
The <guilabel>General</guilabel> configuration dialog allows you to define some basic &tdevelop; behaviour which seldom will change in everyday work. This concerns:
</para>
<variablelist>
@ -97,10 +97,10 @@ The <guilabel>General</guilabel> configuration dialog allows you to define some
<listitem>
<itemizedlist>
<listitem><para>
defining a <link linkend="setup-main-projects">default parent directory</link> &kdevelop; shall use for new projects.
defining a <link linkend="setup-main-projects">default parent directory</link> &tdevelop; shall use for new projects.
</para></listitem>
<listitem><para>
deciding whether you want &kdevelop; to <link linkend="setup-main-preload">automatically load</link> the project you last worked on.
deciding whether you want &tdevelop; to <link linkend="setup-main-preload">automatically load</link> the project you last worked on.
View</link> &kdevelop; uses to communicate ⪚ compilation progresses,
View</link> &tdevelop; uses to communicate ⪚ compilation progresses,
and</para>
</listitem>
<listitem>
@ -166,7 +166,7 @@ messages</link> issued by <command>make</command> will be shown.</para>
startup</guilabel></term>
<listitem>
<para>
Mark this checkbox if you want to continue to work with the last project you worked on. This will cause &kdevelop; to automatically load this project on start-up. It will usually be shown in the state you left work so you can readily proceed.
Mark this checkbox if you want to continue to work with the last project you worked on. This will cause &tdevelop; to automatically load this project on start-up. It will usually be shown in the state you left work so you can readily proceed.
</para>
</listitem>
</varlistentry>
@ -176,9 +176,9 @@ Mark this checkbox if you want to continue to work with the last project you wor
The <guilabel>Application Output View</guilabel> window is used to display error and state information from applications which are run from inside &kdevelop;. These are informations the applications usually sends to the console when run stand-alone. So you do not need to leave the IDE when testing the application you currently work on.
The <guilabel>Application Output View</guilabel> window is used to display error and state information from applications which are run from inside &tdevelop;. These are informations the applications usually sends to the console when run stand-alone. So you do not need to leave the IDE when testing the application you currently work on.
</para>
<para>
To select a font suitable for the <guilabel>Messages Output View</guilabel> window click the <guilabel>Window Font</guilabel> button showing the currently selected font (it says <quote>Luxi Sans</quote> in the above illustration). The &kde; standard <guilabel>Select Font</guilabel> dialog will pop up from which you may select the font to be used.
</para>
<note><para>
On first start-up, &kdevelop; initializes this font setting to the standard font for which your &kde; user has been configured. <emphasis>This setting is fixed</emphasis>, so if you alter <menuchoice><guimenuitem>Preferences</guimenuitem><guimenuitem>Appearances & Themes</guimenuitem><guimenuitem>Fonts</guimenuitem></menuchoice> in the <guilabel>Control Center</guilabel>, this will not effect this &kdevelop; font selection. You will have to explicitely reselect the <guilabel>Messages Output View</guilabel> window font.
On first start-up, &tdevelop; initializes this font setting to the standard font for which your &kde; user has been configured. <emphasis>This setting is fixed</emphasis>, so if you alter <menuchoice><guimenuitem>Preferences</guimenuitem><guimenuitem>Appearances & Themes</guimenuitem><guimenuitem>Fonts</guimenuitem></menuchoice> in the <guilabel>Control Center</guilabel>, this will not effect this &tdevelop; font selection. You will have to explicitely reselect the <guilabel>Messages Output View</guilabel> window font.
</para></note>
</listitem>
</varlistentry>
@ -205,7 +205,7 @@ On first start-up, &kdevelop; initializes this font setting to the standard font
&kdevelop; preprocesses the messages the <guilabel>Messages Output View</guilabel> window receives during the build processes in order to filter superfluous information. You can control the level of detail &kdevelop; will display using the dropdown box in this field.
&tdevelop; preprocesses the messages the <guilabel>Messages Output View</guilabel> window receives during the build processes in order to filter superfluous information. You can control the level of detail &tdevelop; will display using the dropdown box in this field.
</para>
<variablelist>
<varlistentry>
@ -238,7 +238,7 @@ There is an alternative way to switch the compiler output detail. Just right cli
By default, &kdevelop; will wrap long lines around in the <guilabel>Messages Output View</guilabel> window so that valuable information will not be easily overlooked. In some cases this will clutter long message lists. Remove the checkbox mark if you do not want the lines wrap around.
By default, &tdevelop; will wrap long lines around in the <guilabel>Messages Output View</guilabel> window so that valuable information will not be easily overlooked. In some cases this will clutter long message lists. Remove the checkbox mark if you do not want the lines wrap around.
</para>
<tip><para>
There is an alternative way to switch the line wrapping. Just &RMB; click in the <guilabel>Messages Output View</guilabel> window and mark/unmark the <guimenuitem>Line Wrapping</guimenuitem> entry in the menu which will pop up.
@ -251,7 +251,7 @@ There is an alternative way to switch the line wrapping. Just &RMB; click in the
messages</guilabel></term>
<listitem>
<para>
The <command>make</command> tool usually will display messages like <quote>Entering directory</quote>, or <quote>Leaving directory</quote> when it switches the directories it currently works in. As this clutters the messages list in the <guilabel>Messages Output View</guilabel> window, &kdevelop; suppresses those messages by default. Mark the checkbox if you want to protocol which directories <command>make</command> worked in.
The <command>make</command> tool usually will display messages like <quote>Entering directory</quote>, or <quote>Leaving directory</quote> when it switches the directories it currently works in. As this clutters the messages list in the <guilabel>Messages Output View</guilabel> window, &tdevelop; suppresses those messages by default. Mark the checkbox if you want to protocol which directories <command>make</command> worked in.
</para>
<note><para>
Changes in this setting effect the processing of new messages only. Old directory navigation messages will be kept visible when you switch this feature off.
@ -263,14 +263,14 @@ Changes in this setting effect the processing of new messages only. Old director
This let you choose the way you want <filename>.ui</filename> files to be displayed in &kdevelop;. &kdevelop; comes with its own UI designer called KDeveDesigner that can either be embedded or be run as a separate program. Qt Designer can also be used to edit <filename>.ui</filename> files.
This let you choose the way you want <filename>.ui</filename> files to be displayed in &tdevelop;. &tdevelop; comes with its own UI designer called KDeveDesigner that can either be embedded or be run as a separate program. Qt Designer can also be used to edit <filename>.ui</filename> files.
</para>
<itemizedlist>
<listitem><para>
Use &kdevelop;'s embedded designer
</para><para>This uses &kdevelop; own designer embedded within &kdevelop;</para></listitem>
Use &tdevelop;'s embedded designer
</para><para>This uses &tdevelop; own designer embedded within &tdevelop;</para></listitem>
<listitem><para>
Run &kdevelop;'s designer as a separate application
Run &tdevelop;'s designer as a separate application
</para><para>The KDevDesigner application will be run separately in its own window.</para>
<screenshot>
<mediaobject>
@ -285,7 +285,7 @@ This let you choose the way you want <filename>.ui</filename> files to be displa
</listitem>
<listitem><para>
Run Qt Designer
</para><para>Qt Designer from your Qt installation will be started externally whenever you click on a <filename>.ui</filename> file in &kdevelop;.</para></listitem>
</para><para>Qt Designer from your Qt installation will be started externally whenever you click on a <filename>.ui</filename> file in &tdevelop;.</para></listitem>
</itemizedlist>
</listitem>
</varlistentry>
@ -322,7 +322,7 @@ You choose here which terminal you want to be integrated within KDevelop.
<primary>switch UI modes</primary></indexterm>
<para>
As already said in the <link linkend="uimodes-survey">Available User Interface Modes</link> chapter there are five different ways the &kdevelop; work area may be set up, namely:
As already said in the <link linkend="uimodes-survey">Available User Interface Modes</link> chapter there are five different ways the &tdevelop; work area may be set up, namely:
</para>
<itemizedlist>
<listitem><para>
@ -349,7 +349,7 @@ A typical example of this user interface mode is Borland Delphi 6.0.</para></lis
</itemizedlist>
<para>
To switch the user interface mode select <menuchoice> <guimenu>Settings</guimenu> <guimenuitem>Configure &kdevelop;...</guimenuitem> </menuchoice> from the menus. The <guilabel>Customize KDevelop</guilabel> dialog will pop up, where you have to select <guilabel>User Interface</guilabel> in the left hand tree. This will display the following settings dialog to the right.</para>
To switch the user interface mode select <menuchoice> <guimenu>Settings</guimenu> <guimenuitem>Configure &tdevelop;...</guimenuitem> </menuchoice> from the menus. The <guilabel>Customize KDevelop</guilabel> dialog will pop up, where you have to select <guilabel>User Interface</guilabel> in the left hand tree. This will display the following settings dialog to the right.</para>
<screenshot>
<mediaobject>
@ -368,7 +368,7 @@ Select the radio button of the user interface mode you want to switch to, then c
</para>
<note><para>
Do not forget to restart &kdevelop; in order to let any of these selections take effect.
Do not forget to restart &tdevelop; in order to let any of these selections take effect.
</para></note>
<para>
@ -384,26 +384,26 @@ In <guilabel>Simplified IDEAl window mode</guilabel> and in <guilabel>IDEAl wind
<term id="setup-ui-tabs">Configuring the Documents Tab Bar Display</term>
<listitem>
<para>
In the IDEAl and tabbed pages modes there will be named tabs on top of the document windows by default, so you can easily select different documents with a &LMB; click. If you prefer to provide more space for the document windows in the &kdevelop; main work area, you may change to another behaviour in the <guilabel>Use Tabs</guilabel> configuration section.
In the IDEAl and tabbed pages modes there will be named tabs on top of the document windows by default, so you can easily select different documents with a &LMB; click. If you prefer to provide more space for the document windows in the &tdevelop; main work area, you may change to another behaviour in the <guilabel>Use Tabs</guilabel> configuration section.
</para>
<variablelist>
<varlistentry>
<term><guilabel>Always</guilabel></term>
<listitem><para>
This is the default — show a tab comprising an icon and the document name on top of any document window in the &kdevelop; main area display.
This is the default — show a tab comprising an icon and the document name on top of any document window in the &tdevelop; main area display.
</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>When more than one</guilabel></term>
<listitem><para>
Do not show a tab when only one document is displayed. If there is more than one document, however, &kdevelop; will display an according tab bar as in the <guilabel>Always</guilabel> selection above. You may want to select this mode if you work on a single document most of the time as this provides more vertical space.
Do not show a tab when only one document is displayed. If there is more than one document, however, &tdevelop; will display an according tab bar as in the <guilabel>Always</guilabel> selection above. You may want to select this mode if you work on a single document most of the time as this provides more vertical space.
</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Never</guilabel></term>
<listitem><para>
Never show any document selection tab. You may prefer this mode if you seldom use the mouse to switch between documents. It provides more vertical space for all document windows. To select another the document window or to close any, use the &kdevelop; <guimenu>Window</guimenu> menu.
Never show any document selection tab. You may prefer this mode if you seldom use the mouse to switch between documents. It provides more vertical space for all document windows. To select another the document window or to close any, use the &tdevelop; <guimenu>Window</guimenu> menu.
</para></listitem>
</varlistentry>
</variablelist>
@ -415,7 +415,7 @@ In the IDEAl and tabbed pages modes there will be named tabs on top of the docum
Tab</term>
<listitem>
<para>
When you configured &kdevelop; to display the documents tab bar, either always or when more than one document is displayed in the main work area, you may add more functionality to the tabs beyond their document selection capability. Use the <guilabel>Use Close On Hover</guilabel> coniguration section for this.
When you configured &tdevelop; to display the documents tab bar, either always or when more than one document is displayed in the main work area, you may add more functionality to the tabs beyond their document selection capability. Use the <guilabel>Use Close On Hover</guilabel> coniguration section for this.
</para>
<variablelist>
@ -428,13 +428,13 @@ When you configured &kdevelop; to display the documents tab bar, either always o
<varlistentry>
<term><guilabel>Yes</guilabel></term>
<listitem><para>
When you selected this radio button, &kdevelop; will allow to close a document window by a &LMB; click. Use the mouse to point at the small icon on the on the left tab border. It will change to a close symbol. Now click with the &LMB; on this changed symbol and &kdevelop; will close the according document window.
When you selected this radio button, &tdevelop; will allow to close a document window by a &LMB; click. Use the mouse to point at the small icon on the on the left tab border. It will change to a close symbol. Now click with the &LMB; on this changed symbol and &tdevelop; will close the according document window.
</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Yes, Delayed</guilabel></term>
<listitem><para>
After selecting this radio button, &kdevelop; will allow to close a document window as shown in the <guilabel>Yes</guilabel> case above. The icon will not change instantly, however, but there will be a short delay before the close icon shows up.
After selecting this radio button, &tdevelop; will allow to close a document window as shown in the <guilabel>Yes</guilabel> case above. The icon will not change instantly, however, but there will be a short delay before the close icon shows up.
</para></listitem>
</varlistentry>
</variablelist>
@ -524,7 +524,7 @@ The active toolview window must be shown fixed (non-overlap mode), sharing the w
<sect2 id="setup-editor">
<title>Selecting an Editor</title>
<para>&kdevelop; allows you to select your favorite text editor tool. Mark the <guilabel>Editor</guilabel> entry in the left hand side selections tree of the <guilabel>Configure KDevelop</guilabel> window. The following dialog will be displayed to the right.
<para>&tdevelop; allows you to select your favorite text editor tool. Mark the <guilabel>Editor</guilabel> entry in the left hand side selections tree of the <guilabel>Configure KDevelop</guilabel> window. The following dialog will be displayed to the right.
</para>
<screenshot>
@ -560,7 +560,7 @@ To select a new editor, click on the arrow on the drop down list field. Dependin
</variablelist>
<para>
These editor interfaces are fully integrated in the &kdevelop; IDE concept. Particularly the possibility to jump to the offending source code line by just clicking on an error message in the <guilabel>Messages Output View</guilabel> window has been provided.
These editor interfaces are fully integrated in the &tdevelop; IDE concept. Particularly the possibility to jump to the offending source code line by just clicking on an error message in the <guilabel>Messages Output View</guilabel> window has been provided.
</para>
<note><para>
@ -655,15 +655,15 @@ KDevelop lets you use editor interfaces which have registered with &kde; and tha
<title>Selecting a Source Format Style</title>
<para>
&kdevelop; automatically formats a source text in a predefined style. This style is highly configurable.
&tdevelop; automatically formats a source text in a predefined style. This style is highly configurable.
</para>
<note><para>
The reformat source feature is currently available for C, C++, and &Java; only. Especially you cannot use it for scripting languages like ⪚ PHP. This is because &kdevelop; uses the <ulink url="http://astyle.sourceforge.net/">astyle</ulink> application to implement this feature.
The reformat source feature is currently available for C, C++, and &Java; only. Especially you cannot use it for scripting languages like ⪚ PHP. This is because &tdevelop; uses the <ulink url="http://astyle.sourceforge.net/">astyle</ulink> application to implement this feature.
</para></note>
<para>
To set up a specific format style, select <menuchoice> <guimenu>Settings</guimenu> <guimenuitem>Configure &kdevelop;..</guimenuitem> </menuchoice> from the menubar. The <guilabel>Customize KDevelop</guilabel> dialog will pop up, where you have to select <guilabel>Source Formatter</guilabel> in the left hand tree. This will display a series of three settings dialog tabs to the right, namely a <link linkend="setup-format-general">General Formatting Setup</link>, a <link linkend="setup-format-indent">Indentation Style Setup</link>, and a <link linkend="setup-format-other">Other Formatting Setup</link>.
To set up a specific format style, select <menuchoice> <guimenu>Settings</guimenu> <guimenuitem>Configure &tdevelop;..</guimenuitem> </menuchoice> from the menubar. The <guilabel>Customize KDevelop</guilabel> dialog will pop up, where you have to select <guilabel>Source Formatter</guilabel> in the left hand tree. This will display a series of three settings dialog tabs to the right, namely a <link linkend="setup-format-general">General Formatting Setup</link>, a <link linkend="setup-format-indent">Indentation Style Setup</link>, and a <link linkend="setup-format-other">Other Formatting Setup</link>.
</para>
<tip><para>
@ -930,7 +930,7 @@ namespace foospace
<term>Controlling Extra Spaces</term>
<listitem>
<para>
By default &kdevelop; does minimize the use of spaces in source texts.
By default &tdevelop; does minimize the use of spaces in source texts.
</para>
@ -997,7 +997,7 @@ split a long line apart. For C/C++ code this can be controlled here.</para>
<title>Setting Up the Code Snippets Tool</title>
<para>
When editing in &kdevelop; you can store often used parts of code as <link linkend="editing-snippets">Code Snippets</link>. To configure the capabilities of the code snippets part select <menuchoice> <guimenu>Settings</guimenu> <guimenuitem>Configure &kdevelop;..</guimenuitem> </menuchoice> from the menubar. The <guilabel>Customize KDevelop</guilabel> dialog will pop up, where you have to select <guilabel>Code Snippets</guilabel> in the left hand tree. This will show the following dialog in the right hand side.
When editing in &tdevelop; you can store often used parts of code as <link linkend="editing-snippets">Code Snippets</link>. To configure the capabilities of the code snippets part select <menuchoice> <guimenu>Settings</guimenu> <guimenuitem>Configure &tdevelop;..</guimenuitem> </menuchoice> from the menubar. The <guilabel>Customize KDevelop</guilabel> dialog will pop up, where you have to select <guilabel>Code Snippets</guilabel> in the left hand tree. This will show the following dialog in the right hand side.
</para>
<screenshot>
@ -1069,7 +1069,7 @@ variables' mechanism. You can set up it's behaviour in the
<title>Configuring the File Selector</title>
<para>
&kdevelop; provides a <guilabel>File Selector</guilabel> plugin which, when
&tdevelop; provides a <guilabel>File Selector</guilabel> plugin which, when
loaded at start-up, allows to navigate to any file or directory in the
system.
</para>
@ -1088,7 +1088,7 @@ system.
<para>The behaviour of the <guilabel>File Selector</guilabel> can be highly
<guimenuitem>Configure &kdevelop;..</guimenuitem> </menuchoice> from the
<guimenuitem>Configure &tdevelop;..</guimenuitem> </menuchoice> from the
menubar. The <guilabel>Customize KDevelop</guilabel> dialog will pop up,
where you have to select <guilabel>File Selector</guilabel> in the left hand
tree. This will show the following dialog in the right hand side.</para>
@ -1240,11 +1240,11 @@ entries as follows.</para>
<term>Controlling What Should be Remembered Between Sessions</term>
<listitem>
<para>
By default the <guilabel>File Selector</guilabel> is set up so that it shows the display of the most recent session again at the next &kdevelop; start-up. You may change this behaviour in the <guilabel>Session</guilabel> configuration group.
By default the <guilabel>File Selector</guilabel> is set up so that it shows the display of the most recent session again at the next &tdevelop; start-up. You may change this behaviour in the <guilabel>Session</guilabel> configuration group.
</para>
<note><para>
If &kdevelop; was automatically restarted by the &kde; session manager the changes in these settings will have no effect. In this case location and filter settings of the most recent &kde; session will always be restored.
If &tdevelop; was automatically restarted by the &kde; session manager the changes in these settings will have no effect. In this case location and filter settings of the most recent &kde; session will always be restored.
</para></note>
</listitem>
</varlistentry>
@ -1310,7 +1310,7 @@ If &kdevelop; was automatically restarted by the &kde; session manager the chang
<title>Configuring the Documentation</title>
<para>
&kdevelop; contains a very powerful documentation facility which provides access to several kinds of extensive documentation. In ⪚ IDEAl mode you find a <guilabel>Documentation</guilabel> tab at the right border of the work area.
&tdevelop; contains a very powerful documentation facility which provides access to several kinds of extensive documentation. In ⪚ IDEAl mode you find a <guilabel>Documentation</guilabel> tab at the right border of the work area.
</para>
<screenshot>
@ -1318,19 +1318,19 @@ If &kdevelop; was automatically restarted by the &kde; session manager the chang
<textobject><phrase>The &kdevelop; documentation window in IDEAl mode</phrase></textobject>
<textobject><phrase>The &tdevelop; documentation window in IDEAl mode</phrase></textobject>
<caption><para>
The &kdevelop; documentation window (IDEAl mode)
The &tdevelop; documentation window (IDEAl mode)
</para></caption>
</mediaobject>
</screenshot>
<note><para>
&kdevelop; must have loaded the <guilabel>Documentation</guilabel> plugin in order to view the documentation tree. See the <link linkend="setup-plugins">Plugin Tools</link> section for more info.
&tdevelop; must have loaded the <guilabel>Documentation</guilabel> plugin in order to view the documentation tree. See the <link linkend="setup-plugins">Plugin Tools</link> section for more info.
</para></note>
<para>
You may set up contents and behaviour of the various parts of this documentation window if you select <menuchoice> <guimenu>Settings</guimenu> <guimenuitem>Configure &kdevelop;..</guimenuitem> </menuchoice> from the menubar. The <guilabel>Customize KDevelop</guilabel> dialog will pop up, where you have to select <guilabel>Documentation</guilabel> in the left hand window.
You may set up contents and behaviour of the various parts of this documentation window if you select <menuchoice> <guimenu>Settings</guimenu> <guimenuitem>Configure &tdevelop;..</guimenuitem> </menuchoice> from the menubar. The <guilabel>Customize KDevelop</guilabel> dialog will pop up, where you have to select <guilabel>Documentation</guilabel> in the left hand window.
</para>
<para>
@ -1347,7 +1347,7 @@ The thus displayed <link linkend="configure-docu-general">configuration page</li
<title>Setting Up Documentation Collections</title>
<para>
The documentation configuration settings have been divided into a series of documentation collections, each providing access to documentation files of some unique format and content type. These setups control which documentation items will be listed on the <guilabel>Contents</guilabel> page of the &kdevelop; <guilabel>Documentation</guilabel> facility, and how the user may access documentation details by indexed and full text searches.
The documentation configuration settings have been divided into a series of documentation collections, each providing access to documentation files of some unique format and content type. These setups control which documentation items will be listed on the <guilabel>Contents</guilabel> page of the &tdevelop; <guilabel>Documentation</guilabel> facility, and how the user may access documentation details by indexed and full text searches.
</para>
<para>
The <guilabel>Documentation</guilabel> tab provides a series of configuration pages which are ordered vertically like a stack of index cards. One page at a time will open after a click on its index card title:
@ -1356,7 +1356,7 @@ The <guilabel>Documentation</guilabel> tab provides a series of configuration pa
@ -1445,7 +1445,7 @@ Every documentation setup page shows the listed documentation items in a table w
<term><guilabel>TOC</guilabel></term>
<listitem>
<para>
If this check box is marked, this documentation item will show up on the <guilabel>Contents</guilabel> page of the &kdevelop; <guilabel>Documentation</guilabel> facility.
If this check box is marked, this documentation item will show up on the <guilabel>Contents</guilabel> page of the &tdevelop; <guilabel>Documentation</guilabel> facility.
</para>
<note><para>
Unchecking the <guilabel>TOC</guilabel> check box will in turn disable the <guilabel>Index</guilabel> and <guilabel>Search</guilabel> check boxes (see below). Thus you cannot have documentation collection items indexed but not shown in the contents.
@ -1456,7 +1456,7 @@ Every documentation setup page shows the listed documentation items in a table w
<term><guilabel>Index</guilabel></term>
<listitem>
<para>
If this check box is marked, an internal index will be built of this documentation item. This provides fast access to the documentation by the use of the <guilabel>Index</guilabel> and (optionally) <guilabel>Finder</guilabel> pages of the &kdevelop; <guilabel>Documentation</guilabel> facility.
If this check box is marked, an internal index will be built of this documentation item. This provides fast access to the documentation by the use of the <guilabel>Index</guilabel> and (optionally) <guilabel>Finder</guilabel> pages of the &tdevelop; <guilabel>Documentation</guilabel> facility.
</para>
<note>
<para>
@ -1472,14 +1472,14 @@ Every documentation setup page shows the listed documentation items in a table w
<term><guilabel>Search</guilabel></term>
<listitem>
<para>
If this check box is marked, the contents of this documentation item will be included in the full text search path of the <guilabel>Search</guilabel> page of the &kdevelop; <guilabel>Documentation</guilabel> facility.
If this check box is marked, the contents of this documentation item will be included in the full text search path of the <guilabel>Search</guilabel> page of the &tdevelop; <guilabel>Documentation</guilabel> facility.
</para>
<note>
<para>
&kdevelop; utilizes the htdig application collection to perform full text searches. This search is done over an internal index, the htdig machinery has to build before it can be used.
&tdevelop; utilizes the htdig application collection to perform full text searches. This search is done over an internal index, the htdig machinery has to build before it can be used.
</para>
<para>
Any change of the <guilabel>Search</guilabel> check box marks will thus effect the search runs only after you rebuilt the index on the <guilabel>Search</guilabel> page of the &kdevelop; <guilabel>Documentation</guilabel> facility.
Any change of the <guilabel>Search</guilabel> check box marks will thus effect the search runs only after you rebuilt the index on the <guilabel>Search</guilabel> page of the &tdevelop; <guilabel>Documentation</guilabel> facility.
</para>
</note>
</listitem>
@ -1487,13 +1487,13 @@ Every documentation setup page shows the listed documentation items in a table w
<varlistentry>
<term><guilabel>Title</guilabel></term>
<listitem><para>
This is the name of the Documentation item as it will be shown on the <guilabel>Contents</guilabel> page of the &kdevelop; <guilabel>Documentation</guilabel> facility.
This is the name of the Documentation item as it will be shown on the <guilabel>Contents</guilabel> page of the &tdevelop; <guilabel>Documentation</guilabel> facility.
</para></listitem>
</varlistentry>
</variablelist>
<note><para>
Former &kdevelop; versions allowed to select the documentation items to be displayed on a per-project basis. This is not available any more.
Former &tdevelop; versions allowed to select the documentation items to be displayed on a per-project basis. This is not available any more.
</para></note>
</listitem>
</varlistentry>
@ -1521,7 +1521,7 @@ On this configuration page all &Qt; documentation is set up.
</screenshot>
<para>
Normally &kdevelop; will fill this in on its first start-up. It looks for standard <filename>*.xml</filename>, or <filename>*.dcf</filename> documentation files in the &Qt; installation directory. The table to the left lists the files &kdevelop; found by their standard titles.
Normally &tdevelop; will fill this in on its first start-up. It looks for standard <filename>*.xml</filename>, or <filename>*.dcf</filename> documentation files in the &Qt; installation directory. The table to the left lists the files &tdevelop; found by their standard titles.
</para>
<para>
@ -1529,11 +1529,11 @@ If you have a non-standard installation, either there will be no information lis
</para>
<note><para>
&kdevelop; will use the titles already provided by the installed &Qt; documentation. Hence the <guilabel>Title</guilabel> field in the <guilabel>Documentation Catalog Properties</guilabel> dialog is inaccessible.
&tdevelop; will use the titles already provided by the installed &Qt; documentation. Hence the <guilabel>Title</guilabel> field in the <guilabel>Documentation Catalog Properties</guilabel> dialog is inaccessible.
</para></note>
<para>
By default, not all &Qt; documentation will be shown on the <guilabel>Contents</guilabel> page of the &kdevelop; <guilabel>Documentation</guilabel> facility. Use the <guilabel>TOC</guilabel> check box in the <link linkend="setup-docu-columns">setup table</link> to select the documentation to be shown.
By default, not all &Qt; documentation will be shown on the <guilabel>Contents</guilabel> page of the &tdevelop; <guilabel>Documentation</guilabel> facility. Use the <guilabel>TOC</guilabel> check box in the <link linkend="setup-docu-columns">setup table</link> to select the documentation to be shown.
</para>
<para>
@ -1562,7 +1562,7 @@ On this configuration page you may collect documentation according to the &Micro
</screenshot>
<para>
By default, this configuration page will be empty (as shown above). You may add new entries using the <link linkend="setup-docu-buttons">buttons</link> to the right of the list field. &kdevelop; will filter <filename>*.chm</filename> files in the directory dialog associated to the <guibutton>Add</guibutton> and <guibutton>Edit</guibutton> buttons.
By default, this configuration page will be empty (as shown above). You may add new entries using the <link linkend="setup-docu-buttons">buttons</link> to the right of the list field. &tdevelop; will filter <filename>*.chm</filename> files in the directory dialog associated to the <guibutton>Add</guibutton> and <guibutton>Edit</guibutton> buttons.
</para>
<para>
@ -1594,13 +1594,13 @@ On this configuration page all &API; documentation generated by &doxygen; is set
In short, such an &API; documents the interface to certain library functions. The &API; documentation on this page should be produced by the externally provided <ulink url="http://www.stack.nl/~dimitri/doxygen/">&doxygen;</ulink> tool.
</para>
<para>
&doxygen; generated &API; documentationconsists of a series of <filename>html</filename> files, starting with <filename>index.html</filename>. Additionally there may exist <filename>tag</filename> files which contain information to link to already existing &API; documentations. Thus &kdevelop; will look for <filename>index.html</filename> and <filename>*.tag</filename> files when seaching for &doxygen; generated &API; documentation.
&doxygen; generated &API; documentationconsists of a series of <filename>html</filename> files, starting with <filename>index.html</filename>. Additionally there may exist <filename>tag</filename> files which contain information to link to already existing &API; documentations. Thus &tdevelop; will look for <filename>index.html</filename> and <filename>*.tag</filename> files when seaching for &doxygen; generated &API; documentation.
</para>
<para>
There are some structural constraints assumed when searching for &doxygen; generated &API; documentation. The directory in which the <filename>index.html</filename> file resides should contain subdirectories with separate documentation collections. Each of these subdirectories is assumed to contain a <filename>.tag</filename> file and a <filename class="directory">html/</filename> subdirectory.
</para>
<para>
You may have a look at <filename class="directory">$<envar>KDEDIR</envar>/share/doc/HTML/en/kdelibs-apidocs</filename> for an example of such a &doxygen; &API; documentation layout.
You may have a look at <filename class="directory">$<envar>KDEDIR</envar>/share/doc/HTML/en/tdelibs-apidocs</filename> for an example of such a &doxygen; &API; documentation layout.
</para>
<note><para>
@ -1608,25 +1608,25 @@ The older &kde; <ulink url="http://sirtaj.net/projects/kdoc/">KDoc</ulink> gener
</para></note>
<para>
&kdevelop; will have filled in a link to the current &kde; Libraries &API;, provided it found one. There are several ways for &kdevelop; to find out:
&tdevelop; will have filled in a link to the current &kde; Libraries &API;, provided it found one. There are several ways for &tdevelop; to find out:
</para>
<itemizedlist>
<listitem><para>
Either you provided the <command>configure</command> command with the
<option>--with-kdelibsdoxy-dir</option> option when you compiled
&kdevelop; (see the <link linkend="make-api">How to Obtain a &kdevelop; &API; Documentation</link> chapter).
<option>--with-tdelibsdoxy-dir</option> option when you compiled
&tdevelop; (see the <link linkend="make-api">How to Obtain a &tdevelop; &API; Documentation</link> chapter).
</para></listitem>
<listitem><para>
Or the <command>configure</command> command did automatically find a &doxygen; generated &kde; Libraries &API; in one of several standard locations it knows of.
</para></listitem>
<listitem><para>
Or as a last resort the <filename class="directory">$<envar>KDEDIR</envar>/share/doc/HTML/en/kdelibs-apidocs/</filename> was found at the first &kdevelop; startup.
Or as a last resort the <filename class="directory">$<envar>KDEDIR</envar>/share/doc/HTML/en/tdelibs-apidocs/</filename> was found at the first &tdevelop; startup.
</para></listitem>
</itemizedlist>
<para>
If &kdevelop; did not find a valid &doxygen; generated &kde; Libraries &API; at its first start-up the <guilabel>Doxygen Documentation Collection</guilabel> list will be empty.
If &tdevelop; did not find a valid &doxygen; generated &kde; Libraries &API; at its first start-up the <guilabel>Doxygen Documentation Collection</guilabel> list will be empty.
</para>
<para>
@ -1634,12 +1634,12 @@ You may add your own &API; documentation entries (⪚ from your current project
</para>
<note><para>
&kdevelop; uses the title information from the <filename>index.html</filename>. Hence the <guilabel>Title</guilabel> field in the <guilabel>Documentation Catalog Properties</guilabel> dialog is inaccessible.
&tdevelop; uses the title information from the <filename>index.html</filename>. Hence the <guilabel>Title</guilabel> field in the <guilabel>Documentation Catalog Properties</guilabel> dialog is inaccessible.
</para></note>
<tip>
<para>
The &kde; system provides more &API; documentation than the &kde; Libraries &API; only. You will need additional interfaces information if you want to ⪚ include the &kate; part into you programs. For this &kate; part &API; for example you should compile and install the &kde; Base Libraries &API; from the <ulink url="http://developer.kde.org/source/index.html">sources</ulink> (using the <command>make apidox</command> and <command>make install</command> commands on the <filename class="directory">kdebase</filename> sources) and then add an entry to the <guilabel>Doxygen Documentation Collection</guilabel> list like this:
The &kde; system provides more &API; documentation than the &kde; Libraries &API; only. You will need additional interfaces information if you want to ⪚ include the &kate; part into you programs. For this &kate; part &API; for example you should compile and install the &kde; Base Libraries &API; from the <ulink url="http://developer.kde.org/source/index.html">sources</ulink> (using the <command>make apidox</command> and <command>make install</command> commands on the <filename class="directory">tdebase</filename> sources) and then add an entry to the <guilabel>Doxygen Documentation Collection</guilabel> list like this:
</para>
<screenshot><mediaobject>
<imageobject>
@ -1656,7 +1656,7 @@ You may add your own &API; documentation entries (⪚ from your current project
</tip>
<note><para>
You must put the &API; of your current project into this <guilabel>Doxygen Documentation Collection</guilabel> as well. Former &kdevelop; versions did put it into the documentation tree on a per-project basis. This is not provided any more.
You must put the &API; of your current project into this <guilabel>Doxygen Documentation Collection</guilabel> as well. Former &tdevelop; versions did put it into the documentation tree on a per-project basis. This is not provided any more.
</para></note>
</sect3> <!-- setup-docu-general-dox -->
@ -1665,7 +1665,7 @@ You must put the &API; of your current project into this <guilabel>Doxygen Docum
The main bulk of the &kdevelop; documentation facility provides immediate access to structured documentation, local as well as remote ones. You can configure this on the <guilabel>KDevelopTOC Documentation Collection</guilabel> page.
The main bulk of the &tdevelop; documentation facility provides immediate access to structured documentation, local as well as remote ones. You can configure this on the <guilabel>KDevelopTOC Documentation Collection</guilabel> page.
</para>
<screenshot>
@ -1680,31 +1680,31 @@ The main bulk of the &kdevelop; documentation facility provides immediate access
</screenshot>
<para>
&kdevelop; comes with a bunch of predefined KDevelopTOC files which are automatically entered in the table at installation time. To keep the display manageable only the most often used will initially be marked for display. If you want to see another documentation, mark the <guilabel>TOC</guilabel> check box in the <link linkend="setup-docu-columns">setup table</link>.
&tdevelop; comes with a bunch of predefined KDevelopTOC files which are automatically entered in the table at installation time. To keep the display manageable only the most often used will initially be marked for display. If you want to see another documentation, mark the <guilabel>TOC</guilabel> check box in the <link linkend="setup-docu-columns">setup table</link>.
</para>
<para>
KDevelopTOC files cannot be indexed to perform a full text search because they usually point to a remote location. On the other hand, such a <filename>.toc</filename> file can have an index manually defined, using the <computeroutput><index></computeroutput> tag. Thus the <guilabel>Index</guilabel> check box will be enabled ony when &kdevelop; finds an <computeroutput><index></computeroutput> tag in the <filename>.toc</filename> file. (For more detail see the description below in the <link linkend="setup-docu-general-toc-files">&kdevelop; TOC Files</link> section.)
KDevelopTOC files cannot be indexed to perform a full text search because they usually point to a remote location. On the other hand, such a <filename>.toc</filename> file can have an index manually defined, using the <computeroutput><index></computeroutput> tag. Thus the <guilabel>Index</guilabel> check box will be enabled ony when &tdevelop; finds an <computeroutput><index></computeroutput> tag in the <filename>.toc</filename> file. (For more detail see the description below in the <link linkend="setup-docu-general-toc-files">&tdevelop; TOC Files</link> section.)
</para>
<para>
The <guilabel>Search</guilabel> check box in the <link linkend="setup-docu-columns">setup table</link> will alway be disabled.
</para>
<para>
You may add new entries using the <link linkend="setup-docu-buttons">buttons</link> to the right of the list field. &kdevelop; will filter <filename>*.toc</filename> files in the directory dialog associated to the <guibutton>Add</guibutton> and <guibutton>Edit</guibutton> buttons.
You may add new entries using the <link linkend="setup-docu-buttons">buttons</link> to the right of the list field. &tdevelop; will filter <filename>*.toc</filename> files in the directory dialog associated to the <guibutton>Add</guibutton> and <guibutton>Edit</guibutton> buttons.
</para>
<note><para>
Other than former &kdevelop; versions will the <guibutton>Remove</guibutton> button not change the <filename>*.toc</filename> files on disk, so the remove operation is safe now.
Other than former &tdevelop; versions will the <guibutton>Remove</guibutton> button not change the <filename>*.toc</filename> files on disk, so the remove operation is safe now.
</para></note>
</sect3> <!-- setup-docu-general-toc -->
<sect3 id="setup-docu-general-toc-files">
<title>&kdevelop; TOC Files</title>
<title>&tdevelop; TOC Files</title>
<para>
There is a special feature associated with this. To illustrate, follow these steps: In the documentation tree find an entry shortly below the &Qt;/&kde; documentation (⪚ <quote>KDE2 Development Book (kde.org)</quote>). Click on the plus sign next to it. A tree will open where you can quickly navigate to subsequent chapters nested several levels deep, all offline. But if you finally select one of the chapters, &kdevelop; will in many cases try to access a <emphasis>remote</emphasis> documentation file.
There is a special feature associated with this. To illustrate, follow these steps: In the documentation tree find an entry shortly below the &Qt;/&kde; documentation (⪚ <quote>KDE2 Development Book (kde.org)</quote>). Click on the plus sign next to it. A tree will open where you can quickly navigate to subsequent chapters nested several levels deep, all offline. But if you finally select one of the chapters, &tdevelop; will in many cases try to access a <emphasis>remote</emphasis> documentation file.
</para>
<para>
@ -1712,15 +1712,15 @@ The rationale behind this is not only to locally navigate remote documentation w
</para>
<para>
Such structured access is made possible through the use of special <quote>table of content</quote> files, which are denoted by <filename>.toc</filename> filename extensions. Any such &kdevelop; TOC file contains an &XML; structured description of the document to be accessed.
Such structured access is made possible through the use of special <quote>table of content</quote> files, which are denoted by <filename>.toc</filename> filename extensions. Any such &tdevelop; TOC file contains an &XML; structured description of the document to be accessed.
</para>
<variablelist>
<varlistentry>
<term>Standard Directory of &kdevelop; TOC Files</term>
<term>Standard Directory of &tdevelop; TOC Files</term>
<listitem>
<para>
When &kdevelop; was installed usually a series of predefined <filename>.toc</filename> files has been put into the <filename class="directory">$KDEDIR/share/apps/kdevdocumentation/tocs</filename> directory. These are fairly simple, structured text files. You may look at them using a text editor or other text display facility.
When &tdevelop; was installed usually a series of predefined <filename>.toc</filename> files has been put into the <filename class="directory">$KDEDIR/share/apps/kdevdocumentation/tocs</filename> directory. These are fairly simple, structured text files. You may look at them using a text editor or other text display facility.
</para>
</listitem>
</varlistentry></variablelist>
@ -1730,16 +1730,16 @@ When &kdevelop; was installed usually a series of predefined <filename>.toc</fil
<!-- this first revision is done. -->
<variablelist id="toc-file-structure">
<title>Basic Structure of &kdevelop; TOC Files</title>
<title>Basic Structure of &tdevelop; TOC Files</title>
This &XML; structure will be parsed by the &kdevelop; <guilabel>Documentation</guilabel> plugin to set up the documentation tree contents and to guide the user in navigating the documentation. It contains all information necessary to display titles and access the documentation file contents.
This &XML; structure will be parsed by the &tdevelop; <guilabel>Documentation</guilabel> plugin to set up the documentation tree contents and to guide the user in navigating the documentation. It contains all information necessary to display titles and access the documentation file contents.
</para>
</listitem>
</varlistentry>
@ -1773,7 +1773,7 @@ When &kdevelop; was installed usually a series of predefined <filename>.toc</fil
</member>
</simplelist>
<para>
This is the title &kdevelop; will display at the basic levels in the documentation tree.
This is the title &tdevelop; will display at the basic levels in the documentation tree.
</para>
<note><para>
This displayed title cannot be changed by the user. If you want another text be displayed, you must manually change the <computeroutput><title></computeroutput> entry in the <filename>.toc</filename> file.
@ -1826,7 +1826,7 @@ When &kdevelop; was installed usually a series of predefined <filename>.toc</fil
Any <computeroutput><tocsecti></computeroutput> entry must have a <computeroutput>name="xxx"</computeroutput> attribute associated with it (the "xxx" denotes the actual title string). This name will be displayed as level title in the documentation tree. It should correspond to an actual documentation section.
</para>
<para>
There may be an <computeroutput>url=""</computeroutput> attribute associated with any <emphasis>i</emphasis> nesting level. When the user clicks on a section title in the documentation tree &kdevelop; will try to access the file at the location pointed to by the combined base and section &URL;.
There may be an <computeroutput>url=""</computeroutput> attribute associated with any <emphasis>i</emphasis> nesting level. When the user clicks on a section title in the documentation tree &tdevelop; will try to access the file at the location pointed to by the combined base and section &URL;.
</para>
<para>
The <computeroutput><tocsectn/></computeroutput> entry must have an <computeroutput>url=""</computeroutput> attribute whatsoever.
@ -1869,7 +1869,7 @@ When &kdevelop; was installed usually a series of predefined <filename>.toc</fil
<title>DevHelp Documentation</title>
<para>
DevHelp documentation is another means of structured documentation access. It uses structured table of content files denoted by a <filename>.devhelp</filename> extension similar to <link linkend="setup-docu-general-toc-files">&kdevelop; TOC files</link> to access documentation for the GNOME 2 desktop.
DevHelp documentation is another means of structured documentation access. It uses structured table of content files denoted by a <filename>.devhelp</filename> extension similar to <link linkend="setup-docu-general-toc-files">&tdevelop; TOC files</link> to access documentation for the GNOME 2 desktop.
</para>
<para>
You can control which DevHelp files should be accessible on the <guilabel>DevHelp Documentation Collection</guilabel> configuration page.
@ -1891,11 +1891,11 @@ DevHelp files originally were accessible on the <ulink url="http://lidn.sourcefo
</para>
<para>
When &kdevelop; is installed it will attempt to find all <filename>.devhelp</filename> files in some standard places in the system, ⪚ in the subdirectories of <filename class="directory">/opt/gnome/share/</filename>. Initially these files will not be marked for display. If you want to see another documentation, mark the <guilabel>TOC</guilabel> check box in the <link linkend="setup-docu-columns">setup table</link>.
When &tdevelop; is installed it will attempt to find all <filename>.devhelp</filename> files in some standard places in the system, ⪚ in the subdirectories of <filename class="directory">/opt/gnome/share/</filename>. Initially these files will not be marked for display. If you want to see another documentation, mark the <guilabel>TOC</guilabel> check box in the <link linkend="setup-docu-columns">setup table</link>.
</para>
<para>
You may add new entries using the <link linkend="setup-docu-buttons">buttons</link> to the right of the list field. &kdevelop; will filter <filename>*.toc</filename> files in the directory dialog associated to the <guibutton>Add</guibutton> and <guibutton>Edit</guibutton> buttons.
You may add new entries using the <link linkend="setup-docu-buttons">buttons</link> to the right of the list field. &tdevelop; will filter <filename>*.toc</filename> files in the directory dialog associated to the <guibutton>Add</guibutton> and <guibutton>Edit</guibutton> buttons.
</para>
</sect3> <!-- setup-docu-general-devhelp -->
@ -1919,14 +1919,14 @@ This is for your own purpose. You may add almost any documentation files here, p
</screenshot>
<para>
Usually this collection will be empty at first &kdevelop; startup. We have filled in a deliberate item to show the entry structure.
Usually this collection will be empty at first &tdevelop; startup. We have filled in a deliberate item to show the entry structure.
</para>
<para>
Handling is straightforward here. Use the <link linkend="setup-docu-buttons">buttons</link> to the right of the list field to add, edit or remove the document items. &kdevelop; will not filter anything in the directory dialog associated to the <guibutton>Add</guibutton> and <guibutton>Edit</guibutton> buttons.
Handling is straightforward here. Use the <link linkend="setup-docu-buttons">buttons</link> to the right of the list field to add, edit or remove the document items. &tdevelop; will not filter anything in the directory dialog associated to the <guibutton>Add</guibutton> and <guibutton>Edit</guibutton> buttons.
</para>
<para>
You will have to explicitely select the items for display in the &kdevelop; documentation facility. Mark the <guilabel>TOC</guilabel> check box of the entry in the <link linkend="setup-docu-columns">setup table</link>.
You will have to explicitely select the items for display in the &tdevelop; documentation facility. Mark the <guilabel>TOC</guilabel> check box of the entry in the <link linkend="setup-docu-columns">setup table</link>.
This user manual is intended to describe the contents and use of the &kdevelop; &kdevrelease; Integrated Development Environment (IDE) from a user's point of view. It is not a programming manual, nor does it describe the development process in detail. Its only aim is to guide you in the handling of the IDE.
This user manual is intended to describe the contents and use of the &tdevelop; &kdevrelease; Integrated Development Environment (IDE) from a user's point of view. It is not a programming manual, nor does it describe the development process in detail. Its only aim is to guide you in the handling of the IDE.
</para>
<para>
Here you will find information on the following topics:
</para>
<variablelist>
<varlistentry>
<term><link linkend="getting-started">Getting Started with &kdevelop; — a Guided Tour</link> </term>
<term><link linkend="getting-started">Getting Started with &tdevelop; — a Guided Tour</link> </term>
<listitem>
<para>Gives you a quick start on the use of this &IDE;, introducing the basic steps of how to work on a project.</para></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="kdevelop-survey">Overview of the Features of
&kdevelop;</link></term>
<term><link linkend="tdevelop-survey">Overview of the Features of
&tdevelop;</link></term>
<listitem>
<para>Extends the guided tour in the previous chapter, giving an overall
view of what is built-in within &kdevelop; and gets you acquainted with the
view of what is built-in within &tdevelop; and gets you acquainted with the
<para>Tells you where to obtain &kdevelop; and how to get it up and
<para>Tells you where to obtain &tdevelop; and how to get it up and
running.</para>
</listitem>
</varlistentry>
@ -155,7 +155,7 @@ Tricks</link></term>
<listitem>
<para>A quick reference to commonly used commands and actions. And a short
guide to solve common problems when working with
&kdevelop;.</para>
&tdevelop;.</para>
</listitem>
</varlistentry>
@ -173,14 +173,14 @@ necessary and why you need an &IDE;.</para>
</para></listitem>
<listitem><para>
<link linkend="app-shortcuts">Shortcut Keys</link> — the keys you can use to work with &kdevelop; without resorting to the mouse.
<link linkend="app-shortcuts">Shortcut Keys</link> — the keys you can use to work with &tdevelop; without resorting to the mouse.
</para></listitem>
-->
<varlistentry>
<term><link linkend="app-files">Configuration Files Used by
&kdevelop;</link></term>
<listitem><para>Lists the files &kdevelop; uses to save its internal
&tdevelop;</link></term>
<listitem><para>Lists the files &tdevelop; uses to save its internal
information. This is particularly useful in case something went wrong with
your setup.</para>
</listitem>
@ -189,12 +189,12 @@ necessary and why you need an &IDE;.</para>
<varlistentry><term>
<link linkend="plugin-tools">Plugin Tools</link>
</term><listitem><para>Lists the pluggable tools you can use to taylor the capabilities of
&kdevelop; to your needs.
&tdevelop; to your needs.
</para></listitem></varlistentry>
<!--
<listitem><para>
<link linkend="plugin-tools">Plugin tools</link> — provides you with an overview of the parts which make up &kdevelop; and how you can tailor it to suit your needs by only loading the parts that are necessary, both IDE and project-wide.
<link linkend="plugin-tools">Plugin tools</link> — provides you with an overview of the parts which make up &tdevelop; and how you can tailor it to suit your needs by only loading the parts that are necessary, both IDE and project-wide.
@ -241,7 +241,7 @@ Basically the <command>make</command> command will read the rules one after anot
<para>
There are several additional possibilities to control such a make process, and a <filename>Makefile</filename> can thus grow very complex. We cannot go into the details here. However, we recommend that you make yourself accustomed to the syntax of <command>make</command>. Even if you do not normally use it directly, an understanding of the fundamentals of the build system can be useful. See the <ulink url="info://make/Top"> <quote>GNU Make Manual</quote></ulink> for more information. </para>
<para>
For more &kdevelop; specific detail see the <link linkend="project-management">Building and Project Management</link> chapter of this manual.
For more &tdevelop; specific detail see the <link linkend="project-management">Building and Project Management</link> chapter of this manual.
</para>
<para>
There are several tutorials available, see the <link linkend="automake-references">references</link> in the Building and project management chapter.
@ -307,16 +307,16 @@ For example—would it not be convenient if a debugger were able to open the
To more easily accomplish such a scheme, <emphasis>Integrated Development Environments</emphasis> (&IDE;s) were devised. Such an &IDE; integrates all templates, tools, and scripts which are commonly needed in the development process into one single environment.
</para>
<para>
For the &kde; platform &kdevelop; is such an &IDE;. It provides a wide range of tools which ease program development and maintenance, even for different programming languages and across platforms.
For the &kde; platform &tdevelop; is such an &IDE;. It provides a wide range of tools which ease program development and maintenance, even for different programming languages and across platforms.
</para>
<sect2 id="unixdev-ide-kdevelop">
<title>Basic Features of &kdevelop; &kdevrelease;</title>
<sect2 id="unixdev-ide-tdevelop">
<title>Basic Features of &tdevelop; &kdevrelease;</title>
<indexterm zone="unixdev-ide-kdevelop">
<primary>&kdevelop;</primary>
<indexterm zone="unixdev-ide-tdevelop">
<primary>&tdevelop;</primary>
<secondary>features</secondary></indexterm>
<indexterm zone="unixdev-ide-kdevelop">
<indexterm zone="unixdev-ide-tdevelop">
<primary>features</primary></indexterm>
<!-- ### copied from web page, needs to be updated -->
@ -378,7 +378,7 @@ For the &kde; platform &kdevelop; is such an &IDE;. It provides a wide range of
@ -22,18 +22,18 @@ This document is targeted at all those that want to build their own IDE or impro
If you are instead looking for a user manual, just go to the help menu of your KDevelop and select KDevelop handbook.
This documentation contains the KDevelop Platform online class reference for the current
development version of KDevelop. Additionally, you
can subscribe or read the <a href="http://www.kdevelop.org/index.html?filename=mailinglist.html">mailing list</a> for any additions and/or
can subscribe or read the <a href="http://www.tdevelop.org/index.html?filename=mailinglist.html">mailing list</a> for any additions and/or
modifications to the Platform %API.
An on-line, updated every 24H, html version of this documentation can be found at: http://www.kdevelop.org/HEAD/doc/platform/html/index.html
An on-line, updated every 24H, html version of this documentation can be found at: http://www.tdevelop.org/HEAD/doc/platform/html/index.html
You can also download a local browseable copy form http://www.kdevelop.org/HEAD/doc/platform/kdevplatformdoc.tar.bz2 . It gets updated every single day too.
You can also download a local browseable copy form http://www.tdevelop.org/HEAD/doc/platform/kdevplatformdoc.tar.bz2 . It gets updated every single day too.
More information about the KDevelop Platform architecture in form of tutorials, Wikis, HOWTOs,
and FAQs can be found at
the <a href="http://www.kdevelop.org">KDevelop website</a>.
the <a href="http://www.tdevelop.org">KDevelop website</a>.
Quick overviews of the architecture can also be found in the issues of <a href="http://www.kdevelop.org/doc/tehcnotes">
Quick overviews of the architecture can also be found in the issues of <a href="http://www.tdevelop.org/doc/tehcnotes">
KDevelop Technotes</a>.
\section platformapi Platform Libraries API
@ -122,7 +122,7 @@ KDevelop Technotes</a>.
Here is a priority ordered list:
-# fix the dispersed fixme
-# <a href="http://bugs.kde.org/buglist.cgi?product=kdevelop&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=bugs.bug_id">reported bugs in bugzilla database</a>
-# <a href="http://bugs.kde.org/buglist.cgi?product=tdevelop&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=bugs.bug_id">reported bugs in bugzilla database</a>
KAboutData::License_GPL,"KDevDesigner Copyright: (C) 2004-2005 Alexander Dymo\nTQt Designer Copyright: (C) 2000-2005 Trolltech AS All Rights Reserved",0,0);
@ -8,9 +8,9 @@ then you can play with KDevPCSImporter the code of the dialog is in languages/cp
and of course lib/interfaces/kdevpcsimporter.*
and if you want play with the c++ parser go to lib/cppparser/, the best is to start to read driver.*
\authors <a href="mailto:roberto AT kdevelop.org">Roberto Raggi</a>
\authors <a href="mailto:roberto AT tdevelop.org">Roberto Raggi</a>
\maintainer <a href="mailto:roberto AT kdevelop.org">Roberto Raggi</a>
\maintainer <a href="mailto:roberto AT tdevelop.org">Roberto Raggi</a>
\feature supports C/C++ language
\feature can do code completion
@ -18,7 +18,7 @@ and if you want play with the c++ parser go to lib/cppparser/, the best is to st
\feature code highlight
\feature Consult \ref LangSupporttqStatus for a up to date features/status of this programming language support part.
\bug bugs in <a href="http://bugs.kde.org/buglist.cgi?product=kdevelop&component=cppsupport&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=Bug+Number">cppsupport component at Bugzilla database</a>
\bug bugs in <a href="http://bugs.kde.org/buglist.cgi?product=tdevelop&component=cppsupport&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=Bug+Number">cppsupport component at Bugzilla database</a>
\faq <b>How can I have documentation on functions when using codecompletion ?</b>
-# Create the xml-output with <a href="http://www.doxygen.org">Doxygen</a> of the files you want to add to the classstore
Timothy Pearson
13 years ago