diff options
| author | toma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da> | 2009-11-25 17:56:58 +0000 |
|---|---|---|
| committer | toma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da> | 2009-11-25 17:56:58 +0000 |
| commit | 114a878c64ce6f8223cfd22d76a20eb16d177e5e (patch) | |
| tree | acaf47eb0fa12142d3896416a69e74cbf5a72242 /doc/kdevelop | |
| download | tdevelop-114a878c64ce6f8223cfd22d76a20eb16d177e5e.tar.gz tdevelop-114a878c64ce6f8223cfd22d76a20eb16d177e5e.zip | |
Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.
BUG:215923
git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdevelop@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'doc/kdevelop')
125 files changed, 13724 insertions, 0 deletions
diff --git a/doc/kdevelop/Makefile.am b/doc/kdevelop/Makefile.am new file mode 100644 index 00000000..41691557 --- /dev/null +++ b/doc/kdevelop/Makefile.am @@ -0,0 +1,3 @@ +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kdevelop/SF-general.png b/doc/kdevelop/SF-general.png Binary files differnew file mode 100644 index 00000000..0824c835 --- /dev/null +++ b/doc/kdevelop/SF-general.png diff --git a/doc/kdevelop/SF-indent.png b/doc/kdevelop/SF-indent.png Binary files differnew file mode 100644 index 00000000..d84cd469 --- /dev/null +++ b/doc/kdevelop/SF-indent.png diff --git a/doc/kdevelop/SF-other.png b/doc/kdevelop/SF-other.png Binary files differnew file mode 100644 index 00000000..750f112b --- /dev/null +++ b/doc/kdevelop/SF-other.png diff --git a/doc/kdevelop/adv-build-management.docbook b/doc/kdevelop/adv-build-management.docbook new file mode 100644 index 00000000..e589a007 --- /dev/null +++ b/doc/kdevelop/adv-build-management.docbook @@ -0,0 +1,128 @@ +<chapter id="adv-build-management"> +<title>Advanced Build Management</title> +<indexterm zone="adv-build-management"><primary>&automake;</primary></indexterm> + +<sect1 id="buildconfigurations"> +<title>Multiple Build Configurations</title> +<indexterm zone="buildconfigurations"><primary>build configurations</primary><secondary>multiple</secondary></indexterm> + +<para> +(... to be written ...) +</para> + +</sect1> <!-- buildconfigurations --> + +<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> + +<sect1 id="crosscompiling"> +<title>Cross-Compiling</title> +<indexterm zone="crosscompiling"><primary>cross compiling</primary></indexterm> +<indexterm zone="crosscompiling"><primary>compiling</primary><secondary>cross</secondary></indexterm> +<indexterm zone="crosscompiling"><primary><option>--host</option></primary></indexterm> + +<para> +When you have suitable cross compilers available, you can cross compile your +programs for processors and operating systems different from the system where +&kdevelop; and the compiler is running. The &GNU; compiler collection &gcc; can +be configured and compiled as a cross compiler if you compile it yourself. +Consult the <ulink url="info://gcc/Cross-Compiler">GCC info pages</ulink> for +more information. Some &Linux; distributions also provide binary packages. +</para> + +<para> +An <application>automake</application> based package can easily be +cross-compiled by specifying the <option>--host</option> option to the +configure script and setting the <envar>CC</envar> and <envar>CXX</envar> +environment variables to the respective cross compiler binaries. Often you +want to switch between a the cross-compiled version of your application and +one compiled for your development system. For this, it is advantageous to +use &kdevelop; capability of creating multiple build configurations, as +explained in <xref linkend="buildconfigurations"/>. Once you have created a +new build configuration for cross-compiling in the +<menuchoice><guimenu>Project</guimenu><guimenuitem>Project +Options...</guimenuitem></menuchoice> dialog, add the option +</para> + +<screen><option>--host=</option><replaceable>platform</replaceable></screen> + +<para> +to the configure options. The <replaceable>platform</replaceable> name +is a tuple of the form +</para> + +<programlisting>cpu-vendor-os</programlisting> +<para>or</para> +<programlisting>cpu-vendor-kernel-os</programlisting> + +<para> +For many combinations, you can use a short form, for instance +<wordasword>i386-linux</wordasword> or <wordasword>arm-elf</wordasword>. +</para> + +</sect1> <!-- crosscompiling --> + +<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> + +<sect1 id="qtembedded"> +<title>Qt/Embedded</title> +<indexterm zone="qtembedded"><primary>embedded</primary><secondary>Qt</secondary></indexterm> +<indexterm zone="qtembedded"><primary>Qt/Embedded</primary></indexterm> +<indexterm zone="qtembedded"><primary>Qtopia</primary></indexterm> +<indexterm zone="qtembedded"><primary>framebuffer</primary></indexterm> + +<para> +&qte; is a version of the &Qt; library that does not use the X window +system, but draws directly to the framebuffer on &Linux; systems. It is +therefore interesting for embedded systems which have tight restrictions +on the memory usage of the whole system. Its &API; is fully compatible with +the one of the X11 version. +</para> + +<para> +Developing an application for &qte; with &kdevelop; is not very different +from developing a program for the X11 version of &Qt;. In fact, you can use the +same codebase for both versions. If you use the autoproject project +management, you switch to the embedded version by passing the argument +<option>--enable-embedded</option> to the configure script. You can set +this in the <menuchoice><guimenu>Project</guimenu> +<guimenuitem>Project Options...</guimenuitem></menuchoice> dialog under +<guilabel>Configure Options</guilabel>. With the option +<option>--with-qt-dir=DIR</option> you set the directory in which &qte; +is installed. +</para> + +<para> +After configuring and compiling your application with these options, it will +link with the <filename>libqpe.so</filename> library. This version of your +application will not normally run when you use X11. In order to test it, +run it under the control of the program <application>qvfb</application> +(&Qt; Virtual Frame Buffer). This is done by starting +<application>qvfb</application> and then starting your application with +</para> + +<screen><command>app <option>-qws</option> <option>-display QVFb:0</option></command></screen> + +<para> +Naturally, when you have a working version of your application, you +will want to use it on the target processor. For this, it will probably +be convenient to create multiple build configurations, as explained above, +so that you can quickly switch between the version running on your development +system and the version running on the target system. +</para> + +<para> +Applications for &qte; normally run as single applications on the +device they are designed for. Trolltech also supports Qtopia, which is a +collection of applications for PIM, web browsing and various other areas that +work together in a consistent manner. It is the standard environment for +instance on the Sharp Zaurus. You can write applications that integrate into +this environment by using the Qtopia SDK. This implies making your application +class a subclass of <classname>QPEApplication</classname> and linking to the +library <filename>libqpe.so</filename>. If you develop your application with +the autoproject project management, you have to add +<option>--enable-qtopia</option> to the configure options. +</para> + +</sect1> <!-- qtembedded --> + +</chapter> <!-- adv-build-management --> diff --git a/doc/kdevelop/app-changelog.docbook b/doc/kdevelop/app-changelog.docbook new file mode 100644 index 00000000..50e8f4ee --- /dev/null +++ b/doc/kdevelop/app-changelog.docbook @@ -0,0 +1,69 @@ +<appendix id="app-changelog"> +<title>Changes</title> +<sect1 id="changes"> +<title>Changes to This Document</title> + +<itemizedlist> + <listitem> + <para>2003-01-03 Bernd Gehrmann, Caleb Tennis + <itemizedlist> + <listitem> + <para>initial manual layout</para> + </listitem> + <listitem> + <para>many chapter contents sketched</para> + </listitem> + </itemizedlist> + </para> + </listitem> + + + <listitem> + <para>2004-08-01 Bernd Pol, Ian Wadham + <itemizedlist> + <listitem> + <para>manual slightly reorganized</para> + </listitem> + <listitem> + <para>some missing chapters written</para> + </listitem> + </itemizedlist> + </para> + </listitem> + + <listitem> + <para>2005-05-02 Volker Paul — Many changes, including: + <itemizedlist> + <listitem> + <para>split into one file per chapter/appendix</para> + </listitem> + <listitem> + <para>added command reference sorted by menu (descriptions not yet complete)</para> + </listitem> + <listitem> + <para>AppWizard tutorial in getting-started.docbook</para> + </listitem> + <listitem> + <para>reorganized chapters, guided by Konqueror manual</para> + </listitem> + <listitem> + <para>moved installation, Unix development, <quote>In a Nutshell</quote> to the appendix</para> + </listitem> + <listitem> + <para>rewrote plugin appendix, incl. plugin list generator listplugins.sh</para> + </listitem> + </itemizedlist> + </para> + <para>Still far from complete, but a small step forward.</para> + </listitem> + + <listitem> + <para>2006-05-20 Bernd Pol — Filling in some more <quote>to be written</quote> holes:</para> + </listitem> + +</itemizedlist> + +</sect1> <!-- changes --> +</appendix> <!-- app-changelog --> + +<!-- ====================================================================== --> diff --git a/doc/kdevelop/app-files.docbook b/doc/kdevelop/app-files.docbook new file mode 100644 index 00000000..210e1469 --- /dev/null +++ b/doc/kdevelop/app-files.docbook @@ -0,0 +1,425 @@ +<appendix id="app-files"> +<!-- LWatts (2005-04-30): A lot of this might be better as variable lists, --> +<!-- but it's not that big a deal. Something to be done only when there's --> +<!-- a lot of textual changes needed here (e.g., maybe never ) --> + +<appendixinfo> + <authorgroup> + <author><firstname>Bernd</firstname><surname>Pol</surname></author> + <!-- ROLES_OF_TRANSLATORS --> + </authorgroup> +</appendixinfo> + +<title>Configuration Files Used by &kdevelop;</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: +</para> +<simplelist> + <member> + <link linkend="app-files-default">&kdevelop; Default Configuration</link> — files set up when &kdevelop; 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. + </member> +</simplelist> + +<sect1 id="app-files-default"> +<title>&kdevelop; 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>). +</para> + +<sect2 id="app-files-default-config"> +<title>Default &kdevelop; Configuration</title> + +<para> +There is only one &kdevelop; specific default configuration file in the <filename class="directory">$<envar>KDEDIR</envar>/share/config/</filename> directory: +</para> +<variablelist> + <varlistentry> + <term><filename>kdeveloprc</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. + </para></listitem> + </varlistentry> +</variablelist> + +</sect2> <!-- app-files-default-config --> + +<sect2 id="app-files-default-apps"> +<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. +</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: +<simplelist> + <member><link linkend="app-files-default-apps-stdalone">Stand-alone Applications</link></member> + <member><link linkend="app-files-default-apps-task">Task Specific Parts</link></member> + <member><link linkend="app-files-default-apps-project">Project Generation Parts</link></member> + <member><link linkend="app-files-default-apps-lang">Language Specific Parts</link></member> +</simplelist> +</para> + +<itemizedlist> + <listitem id="app-files-default-apps-stdalone"><itemizedlist> + <title>Stand-alone Applications</title> + <listitem> + <para><filename class="directory">kdevelop/</filename> — contains files to configure the &kdevelop; &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>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>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> + </itemizedlist></listitem> + + <listitem><itemizedlist id="app-files-default-apps-task"> + <title>Task Specific Parts</title> + <listitem id="app-files-default-abbrev"> + <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> — contains keyword definition files used by the <guilabel>Expand Text</guilabel> command.</para></listitem> + <listitem><para><filename class="directory">templates/</filename> — contains 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> + </listitem> + <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">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> + <listitem><para><filename>*.png</filename> — project preview images used by the &appwizard;.</para></listitem> + <listitem><para><filename>*.tar.gz</filename> — tarballs containing the source files to be included in a new generated project directory.</para></listitem> + </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">kdevclassview/</filename> — contains files used by the <guilabel>Class View</guilabel> project plugin:</para> + <itemizedlist> + <listitem><para><filename class="directory">pics/</filename> — contains the icons used in the <guilabel>Classes</guilabel> classview tree.</para></listitem> + <listitem><para><filename>kdevclassview.tc</filename> — provides the <guimenuitem>Class Inheritance Diagram</guimenuitem> entry in the <guimenu>Projects</guimenu> menu as well as the classes navigation combo box in the <guilabel>Browser Toolbar</guilabel>.</para></listitem> + </itemizedlist> + </listitem> + <listitem><para><filename class="directory">kdevcloser/</filename> — provides the <guimenu>Windows</guimenu> menu close entries.</para></listitem> + <listitem><para><filename class="directory">kdevctags/</filename> — provides the <guimenuitem>CTags</guimenuitem> entry in the <guimenu>Tools</guimenu> menu for the <guilabel>CTags Frontend</guilabel> project plugin.</para></listitem> + <listitem><para><filename class="directory">kdevcvsservice/</filename> — provides the icon used by the <guilabel>CvsService</guilabel> tab and a short shell script used to add a new entry to the &cvs; repository, both used by the <guilabel>CVS Integration</guilabel> project plugin.</para></listitem> + <listitem><para><filename class="directory">kdevdebugger/</filename> — provides the <guimenu>Debug</guimenu> menu entries for the <guilabel>Debugger Frontend</guilabel> project plugin.</para></listitem> + <listitem><para><filename class="directory">kdevdiff/</filename> — provides the <guimenuitem>Difference Viewer</guimenuitem> entry in the <guimenu>Tools</guimenu> menu.</para></listitem> + <listitem><para><filename class="directory">kdevdistpart/</filename> — provides the <guimenuitem>Distribution & Publishing</guimenuitem> entry in the <guimenu>Project</guimenu> menu for the <guilabel>Final Packaging Support</guilabel> project plugin.</para></listitem> + <listitem id="app-files-default-kdevdoc"> + <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>kdevpart_documentation.rc</filename> — provides the search related entries in the <guimenu>Help</guimenu> menu.</para></listitem> + </itemizedlist> + </listitem> + <listitem><para><filename class="directory">kdevdoxygen/</filename> — provides the menu entries for the <guilabel>Doxygen Support</guilabel> project plugin.</para></listitem> + <listitem id="app-files-default-filecreate"> + <para><filename class="directory">kdevfilecreate/</filename> — contains files used by the <guilabel>New File Wizard:</guilabel> + <itemizedlist> + <listitem><para><filename class="directory">file-templates/</filename> — provides the initial text contents to be put into the new source file of a given type.</para></listitem> + <listitem><para><filename>kdevpart_filecreate.rc</filename> — provides the <guimenuitem>New</guimenuitem> entry in the <guimenu>File</guimenu> menu.</para></listitem> + <listitem><para><filename>template-info.xml</filename> — contains descriptions of the available file types to be displayed in the <guilabel>New File</guilabel> tool view.</para></listitem> + </itemizedlist> + </para></listitem> + <listitem><para><filename class="directory">kdevfilter/</filename> — provides the <guimenuitem>Execute Command...</guimenuitem> and <guimenuitem>Filter Selection Through Command...</guimenuitem> entries in the <guimenu>Tools</guimenu> menu used by the <guilabel>Shell Filtering and Insertion</guilabel> plugin.</para></listitem> + <listitem><para><filename class="directory">kdevfullscreen/</filename> — provides the <guimenuitem>Full Screen Mode</guimenuitem> entry in the <guimenu>View</guimenu> menu and the according tool bar icon.</para></listitem> + <listitem><para><filename class="directory">kdevgrepview/</filename> — provides the <guimenuitem>Find in Files...</guimenuitem>entry in the <guimenu>Edit</guimenu> menu used by the <guilabel>Grep Frontend</guilabel> plugin.</para></listitem> + <listitem><para><filename class="directory">kdevhistory/</filename> — provides the <guimenuitem>Back</guimenuitem> and <guimenuitem>Forward</guimenuitem> entries in the <guimenu>View</guimenu> menu.</para></listitem> + <listitem><para><filename class="directory">kdevjavadebugger/</filename> — provides a <guimenu>Java Debug</guimenu> menu in order to debug a &Java; application.</para></listitem> + <listitem><para><filename class="directory">kdevoutputviews/</filename> — provides the <guimenuitem>Next Error</guimenuitem> and <guimenuitem>Previous Error</guimenuitem> entries in the <guimenu>View</guimenu> menu.</para></listitem> + <listitem><para><filename class="directory">kdevpartexplorer/</filename> — provides the <guimenuitem>Part Explorer</guimenuitem> entry in the <guimenu>Tools</guimenu> menu used by the <guilabel>Part Explorer Tool</guilabel> plugin.</para></listitem> + <listitem><para><filename class="directory">kdevquickopen/</filename> — provides the <guimenuitem>Quick Open File..</guimenuitem> entry in the <guimenu>File</guimenu> menu and the <guimenuitem>Quick Open Class...</guimenuitem> and <guimenuitem>Quick Open Method</guimenuitem> entries in the <guimenu>Tools</guimenu> menu used by the <guilabel>Quick Open</guilabel> project plugin.</para></listitem> + <listitem><para><filename class="directory">kdevregexptest/</filename> — provides the <guimenuitem>Debug Regular Expression...</guimenuitem> entry in the <guimenu>Tools</guimenu> menu used by the <guilabel>Regular Expression Tester</guilabel> plugin.</para></listitem> + <listitem><para><filename class="directory">kdevreplace/</filename> — provides the <guimenuitem>Find-Select-Replace...</guimenuitem> entry in the <guimenu>Edit</guimenu> menu used by the <guilabel>Replace Part</guilabel> plugin.</para></listitem> + <listitem id="app-files-default-tips"><para><filename class="directory">kdevtipofday/</filename> — provides the <guimenuitem>Tip of the Day</guimenuitem> entry in the <guimenu>Help</guimenu> menu as well as a HTML-File containing the available tips.</para></listitem> + <listitem><para><filename class="directory">kdevtools/</filename> — controls various menu entries ceated by <guimenu>Tools Menu</guimenu> and <guilabel>External Tools Menu</guilabel> settings provided by the <guilabel>Tools Menu Addition</guilabel> plugin.</para></listitem> + <listitem><para><filename class="directory">kdevvalgrind/</filename> — provides the <guimenuitem>Valgrind Memory Leak Check</guimenuitem> and <guimenuitem>Profile with KCachegrind</guimenuitem> entries in the <guimenu>Debug</guimenu> menu used by the <guilabel>Valgrind Frontend</guilabel> plugin.</para></listitem> + </itemizedlist></listitem> + + <listitem><itemizedlist id="app-files-default-apps-project"> + <title>Project Generation Parts</title> + <listitem><para><filename class="directory">kdevadaproject/</filename> — provides entries for the <guimenu>Build</guimenu> menu and according tool bar icons to build an Ada application.</para></listitem> + <listitem><para><filename class="directory">kdevantproject/</filename> — provides entries for the <guimenu>Build</guimenu> menu when the Ant project generator is used.</para></listitem> + <listitem><para><filename class="directory">kdevautoproject/</filename> — provides entries for the <guimenu>Build</guimenu> menu and according tool bar icons when working with the &GNU; Tools based &automake; project generator. Additionally provides the <guimenuitem>Add Translation</guimenuitem> and <guimenuitem>Build Configuration</guimenuitem> entries to the <guimenu>Project</guimenu> menu.</para></listitem> + <listitem><para><filename class="directory">kdevcustomproject/</filename> — provides entries for the <guimenu>Build</guimenu> menu and according tool bar icons when the project is based on custom Makefils.</para></listitem> + <listitem><para><filename class="directory">kdevgenericproject/</filename> — contains menu definitions for an experimental generic project generator. Currently (version 3.1.0) unused.</para></listitem> + <listitem><para><filename class="directory">kdevhaskellproject/</filename> — provides entries for the <guimenu>Build</guimenu> menu and according tool bar icons to build a Haskell application.</para></listitem> + <listitem><para><filename class="directory">kdevpascalproject/</filename> — provides entries for the <guimenu>Build</guimenu> menu and according tool bar icons to build a Pascal application.</para></listitem> + <listitem><para><filename class="directory">kdevtrollproject/</filename> — provides entries for the <guimenu>Build</guimenu> menu and according tool bar icons to build an application using the &Qt; QMake project manager.</para></listitem> + </itemizedlist></listitem> + + <listitem><itemizedlist id="app-files-default-apps-lang"> + <title>Language Specific Parts</title> + <listitem><para><filename class="directory">kdevadasupport/</filename> — provides entries in the <guimenu>Tools</guimenu> menu and according tool bar icons needed to develop Ada applications.</para></listitem> + <listitem><para><filename class="directory">kdevbashsupport/</filename> — provides entries in the <guimenu>Build</guimenu> menu and according tool bar icons needed to develop Bash scripts.</para></listitem> + <listitem id="app-files-default-apps-lang-cpp"> + <para><filename class="directory">kdevcppsupport/</filename> — contains files used by the &appwizard; to build C++ applications:</para> + <itemizedlist> + <listitem><para><filename class="directory">newclass/</filename> — contains header and source templates from which the &appwizard; builds the according source files.</para></listitem> + <listitem><para><filename class="directory">subclassing/</filename> — contains templates which the &appwizard; uses to set up initial class declarations/definitions in the source files.</para></listitem> + <listitem><para><filename class="directory">templates</filename> — contains templates from which the &appwizard; sets up the default header and source template files to be used by the &nfwizard;. </para></listitem> + <listitem><para><filename>configuration</filename> — dummy template to add macros.</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></listitem> + </itemizedlist> + </listitem> + <listitem><para><filename class="directory">kdevfortransupport/</filename> — provides entries in the <guimenu>Build</guimenu> menu needed to develop Fortran applications.</para></listitem> + <listitem><para><filename class="directory">kdevhaskellsupport/</filename> — provides entries in the <guimenu>Build</guimenu> menu and according tool bar icons needed to develop Haskell applications.</para></listitem> + <listitem><para><filename class="directory">kdevjavasupport/</filename> — contains the UI definition needed to develop &Java; applications.</para></listitem> + <listitem><para><filename class="directory">kdevpascalsupport/</filename> — contains the UI definition needed to develop Pascal applications.</para></listitem> + <listitem><para><filename class="directory">kdevperlsupport/</filename> — provides <guimenu>Project</guimenu> and <guimenu>Help</guimenu> menu entries needed to develop Perl scripts.</para></listitem> + <listitem><para><filename class="directory">kdevphpsupport/</filename> — contains UI and PHP function definition files needed to develop PHP scripts.</para></listitem> + <listitem><para><filename class="directory">kdevpythonsupport/</filename> — provides <guimenu>Build</guimenu> and <guimenu>Help</guimenu> menu entries and according tool bar icons needed to develop Python scripts.</para></listitem> + <listitem><para><filename class="directory">kdevrubysupport/</filename> — provides <guimenu>Build</guimenu> menu entries and according tool bar icons needed to develop Ruby scripts.</para></listitem> + <listitem><para><filename class="directory">kdevscriptproject/</filename> — provides th UI definitions needed to develop custom projects. Currently (version 3.1.0) unused.</para></listitem> + <listitem><para><filename class="directory">kdevsqlsupport/</filename> — provides th UI definitions needed to develop SQL projects. Currently (version 3.1.0) unused.</para></listitem> + </itemizedlist></listitem> + +</itemizedlist> + +</sect2> <!-- app-files-default-apps --> + +</sect1> <!-- app-files-default --> + +<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> + +<sect1 id="app-files-user"> +<title>User Oriented Configuration</title> + +<para> +All information about user defined settings is kept in two subdirectories of <filename class="directory">$<envar>KDEHOME</envar></filename>, namely: +<simplelist> + <member><link linkend="app-files-user-apps">Application Specific Configuration</link> in the <filename class="directory">$<envar>KDEHOME</envar>/share/apps/</filename> directory, and</member> + <member><link linkend="app-files-user-config">Resource Configuration File</link> in the <filename class="directory">$<envar>KDEHOME</envar>/share/config/</filename> directory.</member> +</simplelist> +</para> + +<sect2 id="app-files-user-apps"> +<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. +</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. +</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. +</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">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> + </listitem> + <listitem> + <para><filename class="directory">kdevappwizard/</filename> — only provides the <guimenuitem>New Project...</guimenuitem> and <guimenuitem>Import Existing Project...</guimenuitem> entries in the <guimenu>Projects</guimenu> menu. The &appwizard; will use the <link linkend="app-files-default-appwizard">default configuration settings</link> for its actual works.</para> + </listitem> + <listitem> + <para><filename class="directory">kdevastyle/</filename> — provides the actual <guimenuitem>Reformat Source</guimenuitem> entry in the <guimenu>Edit</guimenu> menu.</para> + </listitem> + <listitem> + <para><filename class="directory">kdevautoproject/</filename> — provides the actual entries in the <guimenu>Build</guimenu> menu and the <guilabel>Build Toolbar (KDevelop)</guilabel> toolbar.</para> + </listitem> + <listitem> + <para><filename class="directory">kdevclassview/</filename> — provides the <guimenuitem>Class Inheritance Diagram</guimenuitem> entry in the <guimenu>Project</guimenu> menu and the class browser combo box in the <guilabel>Browser Toolbar</guilabel> by the <guilabel>Class View</guilabel> project plugin.</para> + </listitem> + <listitem> + <para><filename class="directory">kdevcloser/</filename> — provides the <guimenuitem>Close Selected Windows...</guimenuitem> entry in the <guimenu>Windows</guimenu> menu.</para> + </listitem> + <listitem> + <para><filename class="directory">kdevcppsupport/</filename> — holds the acual configuration used by the &appwizard; to build C++ applications. The &appwizard; however uses its main bulk of configuration information directly from the <link linkend="app-files-default-apps-lang-cpp">default configuration directory</link>. See there for more detail.</para> + <itemizedlist> + <listitem> + <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> + </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> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para><filename class="directory">kdevctags/</filename> — provides the <guimenuitem>CTags</guimenuitem> entry in the <guimenu>Tools</guimenu> menu for the <guilabel>CTags Frontend</guilabel> project plugin.</para> + </listitem> + <listitem> + <para><filename class="directory">kdevdebugger/</filename> — provides the <guimenu>Debug</guimenu> menu entries for the <guilabel>Debugger Frontend</guilabel> project plugin.</para> + </listitem> + <listitem> + <para><filename class="directory">kdevdiff/</filename> — provides the <guimenuitem>Difference Viewer</guimenuitem> entry in the <guimenu>Tools</guimenu> menu.</para> + </listitem> + <listitem> + <para><filename class="directory">kdevdocumentation/</filename> — contains the actual files used by the <guilabel>Documentation</guilabel> plugin in addition to the <link linkend="app-files-default-kdevdoc"> default configuration files</link>. See there for more detail.</para> + <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> + </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> + </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> + </listitem> + <listitem> + <para><filename>kdevpart_documentation.rc</filename> — provides the search related entries in the <guimenu>Help</guimenu> menu.</para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <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> + <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> + </itemizedlist> + </listitem> + <listitem> + <para><filename class="directory">kdevfilecreate/</filename> — contains files used by the <guilabel>New File Wizard:</guilabel></para> + <itemizedlist> + <listitem><para><filename class="directory">file-templates/</filename> — provides the actually used text contents to be put into the new source file of a given type. More file templates are found in the <link linkend="app-files-default-filecreate">default configuration files</link> directory.</para></listitem> + <listitem><para><filename>kdevpart_filecreate.rc</filename> — provides the <guimenuitem>New</guimenuitem> entry in the <guimenu>File</guimenu> menu.</para></listitem> + <listitem><para><filename>template-info.xml</filename> — contains descriptions of the available file types to be displayed in the <guilabel>New File</guilabel> tool view.</para></listitem> + </itemizedlist> + </listitem> + <listitem> + <para><filename class="directory">kdevfilter/</filename> — provides the <guimenuitem>Execute Command...</guimenuitem> and <guimenuitem>Filter Selection Through Command...</guimenuitem> entries in the <guimenu>Tools</guimenu> menu used by the <guilabel>Shell Filtering and Insertion</guilabel> plugin.</para> + </listitem> + <listitem> + <para><filename class="directory">kdevfullscreen/</filename> — provides the <guimenuitem>Full Screen Mode</guimenuitem> entry in the <guimenu>View</guimenu> menu and the according tool bar icon.</para> + </listitem> + <listitem> + <para><filename class="directory">kdevgrepview/</filename> — provides the <guimenuitem>Find in Files...</guimenuitem>entry in the <guimenu>Edit</guimenu> menu used by the <guilabel>Grep Frontend</guilabel> plugin.</para> + </listitem> + <listitem> + <para><filename class="directory">kdevoutputviews/</filename> — provides the <guimenuitem>Next Error</guimenuitem> and <guimenuitem>Previous Error</guimenuitem> entries in the <guimenu>View</guimenu> menu.</para> + </listitem> + <listitem> + <para><filename class="directory">kdevpartexplorer/</filename> — provides the <guimenuitem>Part Explorer</guimenuitem> entry in the <guimenu>Tools</guimenu> menu used by the <guilabel>Part Explorer Tool</guilabel> plugin.</para> + </listitem> + <listitem> + <para><filename class="directory">kdevquickopen/</filename> — provides the <guimenuitem>Quick Open File..</guimenuitem> entry in the <guimenu>File</guimenu> menu and the <guimenuitem>Quick Open Class...</guimenuitem> and <guimenuitem>Quick Open Method</guimenuitem> entries in the <guimenu>Tools</guimenu> menu used by the <guilabel>Quick Open</guilabel> project plugin.</para> + </listitem> + <listitem> + <para><filename class="directory">kdevregexptest/</filename> — provides the <guimenuitem>Debug Regular Expression...</guimenuitem> entry in the <guimenu>Tools</guimenu> menu used by the <guilabel>Regular Expression Tester</guilabel> plugin.</para> + </listitem> + <listitem> + <para><filename class="directory">kdevreplace/</filename> — provides the <guimenuitem>Find-Select-Replace...</guimenuitem> entry in the <guimenu>Edit</guimenu> menu used by the <guilabel>Replace Part</guilabel> plugin.</para> + </listitem> + <listitem> + <para><filename class="directory">kdevtipofday/</filename> —provides the <guimenuitem>Tip of the Day</guimenuitem> entry in the <guimenu>Help</guimenu> menu. The HTML-File containing the available tips is provided as a <link linkend="app-files-default-tips">default configuration file</link> only.</para> + </listitem> + <listitem> + <para><filename class="directory">kdevtools/</filename> — controls various menu entries ceated by <guimenu>Tools Menu</guimenu> and <guilabel>External Tools Menu</guilabel> settings provided by the <guilabel>Tools Menu Addition</guilabel> plugin.</para> + </listitem> + <listitem> + <para><filename class="directory">kdevvalgrind/</filename> — provides the <guimenuitem>Valgrind Memory Leak Check</guimenuitem> and <guimenuitem>Profile with KCachegrind</guimenuitem> entries in the <guimenu>Debug</guimenu> menu used by the <guilabel>Valgrind Frontend</guilabel> plugin.</para> + </listitem> +</itemizedlist> + +</sect2> <!-- app-files-user-apps --> + +<sect2 id="app-files-user-config"> +<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: +<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> +</simplelist> +</para> + +<itemizedlist id="app-files-user-config-kdev"> +<title>Configuration Files Used by &kdevelop;</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> + </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>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>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> + <listitem><para><filename>kdevgrepviewrc</filename> — holds actual settings the <guilabel>Grep Frontend</guilabel> plugin uses.</para></listitem> + <listitem><para><filename>kdevsnippetrc</filename> — holds actual settings the <guilabel>Code Snippets</guilabel> plugin uses.</para></listitem> + <listitem><para><filename>kdevtoolsrc</filename> — holds actual settings the <guilabel>Tools Menu Addition</guilabel> plugin uses.</para></listitem> +</itemizedlist> + +<itemizedlist id="app-files-user-config-doc"> +<title>Configuration Files Used by the Documentation Plugin</title> + <listitem><para><filename>docchmpluginrc</filename> — holds information about the actual &Microsoft; CHM help files as defined on the <guilabel>CHM Documentation Collection</guilabel> configuration page.</para></listitem> + <listitem><para><filename>doccustompluginrc</filename> — holds information about any custom documentation file defined on the <guilabel>Custom Documentation Collection</guilabel> configuration page.</para></listitem> + <listitem><para><filename>docdevhelppluginrc</filename> — holds information about the actual GNOME 2 DevHelp documentation files as defined on the <guilabel>Devhelp Documentation Collection</guilabel> configuration page.</para></listitem> + <listitem><para><filename>docdoxygenpluginrc</filename> — holds information about the actual Doxygen generated API documentations as defined on the <guilabel>Doxygen Documentation Collection</guilabel> configuration page.</para></listitem> + <listitem><para><filename>dockdevtocpluginrc</filename> — holds information about the actual KDevelopTOC structured documentation files as defined on the <guilabel>KDevelopTOC Documentation Collection</guilabel> configuration page.</para></listitem> + <listitem><para><filename>docqtpluginrc</filename> — holds information about the QT documentation files actually included on the <guilabel> Documentation Collection</guilabel>Qt configuration page.</para></listitem> +</itemizedlist> + +</sect2> <!-- app-files-user-config --> + +</sect1> <!-- app-files-user --> + +<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> + +<sect1 id="app-files-project"> +<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: +</para> +<simplelist> + <member><filename><project-name>.kdevelop</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> +Both are &XML; coded files. They can be viewed and (cautiously) altered using any text editor. +</para> + +<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> + +<note><para> +There can be additional Persistant Code Store files be set up on the <guilabel>Code Completion</guilabel> tab of the <guilabel>C++ Specific</guilabel> project configuration page. Information about these additional <filename>.pcs</filename> is kept globally in the <filename class="directory">$<envar>KDEHOME</envar>/share/apps/kdevcppsupport/pcs/</filename> directory. +</para></note> +</sect2> + +</sect1> <!-- app-files-project --> + +</appendix> <!-- app-files --> diff --git a/doc/kdevelop/app-menu.docbook b/doc/kdevelop/app-menu.docbook new file mode 100644 index 00000000..954b65f2 --- /dev/null +++ b/doc/kdevelop/app-menu.docbook @@ -0,0 +1,61 @@ +<appendix id="app-menus"> + +<appendixinfo> + <authorgroup> + <author><firstname>Bernd</firstname><surname>Pol</surname></author> + <!-- ROLES_OF_TRANSLATORS --> + </authorgroup> +</appendixinfo> + +<title>Menus and Toolbars Overview</title> + +<para> +(... to be written ...) +</para> + +<sect1 id="app-menus-menu"> +<title>Menus</title> + +<para> +(... to be written ...) +</para> + +<sect2 id="app-menus-menu-common"> +<title>Commonly Available Menus</title> + +<para> +(... to be written ...) +</para> + +</sect2> <!-- app-menus-menu-common --> + +<sect2 id="app-menus-menu-project"> +<title>Project Specific Menus</title> + +<para> +(... to be written ...) +</para> + +</sect2> <!-- app-menus-menu-project --> + +<sect2 id="app-menus-menu-specific"> +<title>Plugin Tools Specific Menus</title> + +<para> +(... to be written ...) +</para> + +</sect2> <!-- app-menus-menu-specific --> + +</sect1> <!-- app-menus-menu --> + +<sect1 id="app-menus-tool"> +<title>Toolbars</title> + +<para> +(... to be written ...) +</para> + +</sect1> <!-- app-menus-tool --> + +</appendix> <!-- app-menus --> diff --git a/doc/kdevelop/app-misc-info.docbook b/doc/kdevelop/app-misc-info.docbook new file mode 100644 index 00000000..308be579 --- /dev/null +++ b/doc/kdevelop/app-misc-info.docbook @@ -0,0 +1,24 @@ +<appendix id="app-misc-info"> +<title>Further Information</title> +<sect1 id="gettinginformation"> +<title>Getting Information</title> +<para> +(... to be written ...) +</para> +</sect1> <!-- gettinginformation --> + +<sect1 id="app-reporting-bugs"> +<title>Reporting Bugs</title> +<para> +(... to be written ...) +</para> +</sect1> <!-- app-reporting-bugs --> + +<sect1 id="app-licensing"> +<title>Licensing</title> +&underFDL; +&underGPL; +</sect1> <!-- app-licensing --> +</appendix> <!-- app-misc-info --> + +<!-- ====================================================================== --> diff --git a/doc/kdevelop/app-uimodes-examples.docbook b/doc/kdevelop/app-uimodes-examples.docbook new file mode 100644 index 00000000..24b93c61 --- /dev/null +++ b/doc/kdevelop/app-uimodes-examples.docbook @@ -0,0 +1,125 @@ +<appendix id="app-uimodes-examples"> +<title>&kdevelop; User Interface Mode Examples</title> + +<sect1 id="ideal-desc"> +<title>IDEAl Mode</title> + +<para> +Click <link linkend="uimodes-survey">here</link> to return to the modes overview. +</para> + +<screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="kdevelop-ideal-mode.png" format="PNG"/> + </imageobject> + <textobject><phrase>Screenshot</phrase></textobject> + <caption><para>&kdevelop; IDEAl mode</para></caption> + </mediaobject> +</screenshot> + +<para> +Click <link linkend="uimodes-survey">here</link> to return to the modes overview. +</para> + +<screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="kdevelop-ideal-mode-0.png" format="PNG"/> + </imageobject> + <textobject><phrase>Screenshot</phrase></textobject> + <caption><para>&kdevelop; IDEAl mode, closed tabs</para></caption> + </mediaobject> +</screenshot> + +<para> +This example screenshot demonstrates one of the main virtues of IDEAl mode. There is a maximum workspace available. Yet any tool view is readily available by clicking on the according tab. +</para> +<para> +You will most probably need some time to get accustomed to the icons in the tab bar. If you got lost, just position the mouse over a tab and wait a few seconds. A short tool tip description will pop up. In this screenshot the <quote>Automake Manager</quote> tool tip is shown as an example. It describes the lower tab in the right tab bar. +</para> + +<para> +Click <link linkend="uimodes-survey">here</link> to return to the modes overview. +</para> + +</sect1> <!-- ideal-desc --> + +<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> + +<sect1 id="mdi-desc"> +<title>Child Frame Windows Mode</title> + +<para> +Click <link linkend="uimodes-survey">here</link> to return to the modes overview. +</para> + +<screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="kdevelop-mdi-mode.png" format="PNG"/> + </imageobject> + <textobject><phrase>Screenshot</phrase></textobject> + <caption><para>&kdevelop; child frame windows mode</para></caption> + </mediaobject> +</screenshot> + +<para> +Click <link linkend="uimodes-survey">here</link> to return to the modes overview. +</para> + +</sect1> <!-- mdi-desc --> + +<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> + +<sect1 id="tabbed-desc"> +<title>Tabbed Pages Mode</title> + +<para> +Click <link linkend="uimodes-survey">here</link> to return to the modes overview. +</para> + +<screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="kdevelop-tabbed-mode.png" format="PNG"/> + </imageobject> + <textobject><phrase>Screenshot</phrase></textobject> + <caption><para>&kdevelop; tabbed pages mode</para></caption> + </mediaobject> +</screenshot> + +<para> +Click <link linkend="uimodes-survey">here</link> to return to the modes overview. +</para> + +</sect1> <!-- tabbed-desc --> + +<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> + +<sect1 id="toplevel-desc"> +<title>Toplevel Windows Mode</title> + +<para> +Click <link linkend="uimodes-survey">here</link> to return to the modes overview. +</para> + +<screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="kdevelop-toplevel-mode.png" format="PNG"/> + </imageobject> + <textobject><phrase>Screenshot</phrase></textobject> + <caption><para>&kdevelop; toplevel windows mode</para></caption> + </mediaobject> +</screenshot> + +<para> +Click <link linkend="uimodes-survey">here</link> to return to the modes overview. +</para> + +</sect1> <!-- toplevel-desc --> + +</appendix> <!-- app-uimodes-examples --> + +<!-- ====================================================================== --> diff --git a/doc/kdevelop/applicationwizard.docbook b/doc/kdevelop/applicationwizard.docbook new file mode 100644 index 00000000..ee732a78 --- /dev/null +++ b/doc/kdevelop/applicationwizard.docbook @@ -0,0 +1,820 @@ +<chapter id="applicationwizard"> + +<chapterinfo> + <authorgroup> + <author><firstname>Bernd</firstname><surname>Pol</surname></author> + <!-- ROLES_OF_TRANSLATORS --> + </authorgroup> +</chapterinfo> + +<title>Getting Started — the &appwizard;</title> +<!-- FIXME (bp, 2006-06-18) This is a misnomer. It should be something like --> +<!-- Working With Projects --> +<!-- featuring the application manager as part of the New Projects section. --> + +<indexterm zone="applicationwizard"> + <primary>&appwizard;</primary></indexterm> + +<para> +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. +</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. +</para> + +<sect1 id="new-projects"> +<title>New Projects</title> + +<!-- TODO (bp, 2006-06-18) This whole section must be completely rewritten. --> +<!-- There is no need for a tutorial habit anymore. --> + +<indexterm zone="new-projects"> + <primary>project</primary> + <secondary>new</secondary></indexterm> + +<para> +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>. +</para> +<para> +Only a short series of steps is necessary to start a new programming project, using the &appwizard;: +</para> +<orderedlist> + <listitem><para> + <link linkend="new-projects-start-type">Select the programming language</link> you want to use and the type of the application you want to build from a set of predefined templates. + </para></listitem> + <listitem><para> + <link linkend="new-projects-start-general">Supply some general information</link> as application name, directory where the application shall be built, &etc; + </para></listitem> + <listitem><para> + Decide whether you want to use a <link linkend="new-projects-start-cvs">version control system</link>, like ⪚ CVS, and supply the necessary data if needed. + </para></listitem> + <listitem><para> + Set up some templates for <link linkend="new-projects-start-templates">initial header and source files</link> (if applicable). + </para></listitem> + <listitem><para> + Finally tell &appwizard; to <link linkend="new-projects-start-build">set up all initial stuff</link>, directory structure, starting header/source file templates, and management tools, like ⪚ an initial make skeleton, &etc; + </para></listitem> +</orderedlist> +<para> +Voilà—that's all. &appwizard; will have provided you with a primary functional set of programming files, where you can readily start working. +</para> +<para> +Let's look at all this in more detail now ... +</para> + +<sect2 id="new-projects-start"> +<title>Initial Steps</title> + +<indexterm zone="new-projects-start"> + <primary>dialog</primary> + <secondary>create new project</secondary></indexterm> +<indexterm zone="new-projects-start"> + <primary>project</primary> + <secondary>create new project</secondary> + <tertiary>dialog</tertiary></indexterm> +<indexterm zone="new-projects-start"> + <primary>project</primary> + <secondary>templates</secondary></indexterm> +<indexterm zone="new-projects-start"> + <primary>templates</primary> + <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: +</para> + +<screenshot id="screenshot-newprojectwizard"> + <mediaobject> + <imageobject> + <imagedata fileref="create-new-project.png" format="PNG"/> + </imageobject> + <caption><para> + Initial dialog to set up a new project + </para></caption> + </mediaobject> +</screenshot> + +<para> +As you see, this dialog is divided into an upper and a lower part. In the upper part you can decide on the programming language and application type, the lower part holds some general information. +</para> + +<sect3 id="new-projects-start-type"> +<title>Select Programming Language and Application Type</title> + +<indexterm zone="new-projects-start-type"> + <primary>project</primary> + <secondary>application type</secondary></indexterm> +<indexterm zone="new-projects-start-type"> + <primary>project</primary> + <secondary>programming language</secondary></indexterm> +<indexterm zone="new-projects-start-type"> + <primary>project</primary> + <secondary>language</secondary></indexterm> +<indexterm zone="new-projects-start-type"> + <primary>language</primary></indexterm> +<indexterm zone="new-projects-start-type"> + <primary>programming language</primary></indexterm> +<indexterm zone="new-projects-start-type"> + <primary>application</primary> + <secondary>type</secondary></indexterm> + +<para> +The left hand side of the upper part in this dialog is where you do the selection work. When it shows up, you'll find there a list of folders each labeled with a programming language, as there are: +</para> + +<itemizedlist> + <listitem><para> + Ada + <indexterm> + <primary>Ada</primary> + <secondary>new project</secondary></indexterm> + </para></listitem> + <listitem><para> + C + <indexterm> + <primary>C</primary> + <secondary>new project</secondary></indexterm> + </para></listitem> + <listitem><para> + C++ + <indexterm> + <primary>C++</primary> + <secondary>new project</secondary></indexterm> + </para></listitem> + <listitem><para> + Database (SQL Projects) + <indexterm> + <primary>SQL</primary> + <secondary>new project</secondary></indexterm> + <indexterm> + <primary>Database</primary> + <secondary>new project</secondary></indexterm> + </para></listitem> + <listitem><para> + Fortran + <indexterm> + <primary>Fortran</primary> + <secondary>new project</secondary></indexterm> + </para></listitem> + <listitem><para> + Haskell + <indexterm> + <primary>Haskell</primary> + <secondary>new project</secondary></indexterm> + </para></listitem> + <listitem><para> + Java + <indexterm> + <primary>Java</primary> + <secondary>new project</secondary></indexterm> + </para></listitem> + <listitem><para> + PHP + <indexterm> + <primary>PHP</primary> + <secondary>new project</secondary></indexterm> + </para></listitem> + <listitem><para> + Pascal + <indexterm> + <primary>Pascal</primary> + <secondary>new project</secondary></indexterm> + </para></listitem> + <listitem><para> + Perl + <indexterm> + <primary>Perl</primary> + <secondary>new project</secondary></indexterm> + </para></listitem> + <listitem><para> + Python + <indexterm> + <primary>Python</primary> + <secondary>new project</secondary></indexterm> + </para></listitem> + <listitem><para> + Ruby + <indexterm> + <primary>Ruby</primary> + <secondary>new project</secondary></indexterm> + </para></listitem> + <listitem><para> + Shell (Scripts for the Bash Shell) + <indexterm> + <primary>Bash</primary> + <secondary>new project</secondary></indexterm> + <indexterm> + <primary>shell</primary> + <secondary>new project</secondary></indexterm> + </para></listitem> +</itemizedlist> + +<para> +To be precise, these folders do not contain real programming tools actually. They do lead to pre-defined <emphasis>templates</emphasis> you can use as a starting point for development in that language. To get an idea of what is provided, just open the folders one after the other. There will be a series of subfolders on some, one or more simple entries only on others. The subfolders you see organize the available templates according to some tasks, the simple entries name the templates you may select. +</para> +<para> +We cannot go into detail here on which tasks each template provides, but it's easy to find out. Whenever you select a template entry some information is displayed in the fields to the right. In the lower field you will find a <emphasis>short description</emphasis> on what the template is supposed to do. In the field above that a picture will be shown, if available, about the outcome of the application this template produces if you compile and run it unmodified. Usually this is a <emphasis>screenshot</emphasis> of the main window the application will display. +</para> +<para> +Select the template which best fits your application's goals as a starting point. Then enter the general properties information in the lower field as shown in the next chapter. +</para> + +<formalpara> +<title>Selecting a Project Management System</title> +<para> +Each template is bound to a specific <link linkend="makesystems">Project Management System</link>. Currently there is no direct means to freely select such a Project Management System. You have to find a template which suits your needs or alter your project accordingly after creation. +</para> +</formalpara> + +</sect3> <!-- new-projects-start-type --> + +<sect3 id="new-projects-start-general"> +<title>Provide General Information</title> + +<indexterm zone="new-projects-start-general"> + <primary>project</primary> + <secondary>properties</secondary></indexterm> +<indexterm zone="new-projects-start-general"> + <primary>properties</primary></indexterm> +<indexterm zone="new-projects-start-general"> + <primary>application</primary> + <secondary>name</secondary></indexterm> +<indexterm zone="new-projects-start-general"> + <primary>name</primary> + <secondary>application</secondary></indexterm> +<indexterm zone="new-projects-start-general"> + <primary>project</primary> + <secondary>directory</secondary></indexterm> +<indexterm zone="new-projects-start-general"> + <primary>directory</primary> + <secondary>project</secondary></indexterm> +<indexterm zone="new-projects-start-general"> + <primary>path</primary> + <secondary>new project</secondary></indexterm> +<indexterm zone="new-projects-start-general"> + <primary>project</primary> + <secondary>author</secondary></indexterm> +<indexterm zone="new-projects-start-general"> + <primary>project</primary> + <secondary>email</secondary></indexterm> +<indexterm zone="new-projects-start-general"> + <primary>author</primary></indexterm> +<indexterm zone="new-projects-start-general"> + <primary>email</primary></indexterm> +<indexterm zone="new-projects-start-general"> + <primary>project</primary> + <secondary>main.cpp</secondary></indexterm> +<indexterm zone="new-projects-start-general"> + <primary>main.cpp</primary></indexterm> +<indexterm zone="new-projects-start-general"> + <primary>project</primary> + <secondary>license</secondary></indexterm> +<indexterm zone="new-projects-start-general"> + <primary>license</primary></indexterm> + +<para> +The lower part of the <guilabel>Create New Project</guilabel> dialog <guilabel>General</guilabel> page is a framed field labeled <guilabel>Properties</guilabel>. You must provide some general information about your project here so that the &appwizard; knows how to build the initial structure. +</para> +<formalpara> +<title>Application Name</title> +<para> +Your application needs a name of course. Enter this in the uppermost <guilabel>Properties</guilabel> field, called <guilabel>Application Name</guilabel>. We use <quote>MyApp</quote> as an example. +</para> +</formalpara> +<para> +When you do so, you will notice that the &appwizard; refuses to accept special characters of any kind. The only characters accepted are: +<itemizedlist> + <listitem><para>upper and lower case characters</para></listitem> + <listitem><para>numbers</para></listitem> + <listitem><para>the underline character</para></listitem> +</itemizedlist> +</para> +<para> +One prominent cause of this restriction is that the &appwizard; will use this application name as the <emphasis>basis of some class names</emphasis> it will construct when it sets up an initial project. Thus the name of the application must stick to the rules of the programming language you use. +</para> +<formalpara> +<title>The Project Directory</title> +<para> +The other prominent cause of this restriction you can see at the bottom line of the <guilabel>Properties</guilabel> area. It is labeled <guilabel>Final location</guilabel> and shows the directory where the &appwizard; will create the application. +</para> +</formalpara> +<para> +As you type the application name you will notice that the &appwizard; repeats your input at the end of the <guilabel>Final location</guilabel> line, using lower case only characters. +</para> +<para> +Thus you must select the name of your new application with care. If you end up with an already used directory the &appwizard; will not allow you to continue to the next step, keeping the <guibutton>Next ></guibutton> button deactivated (grayed). Yet, it will <emphasis>warn</emphasis> you in this case by appending <quote>(dir/file already exist)</quote> to the <guilabel>Final location</guilabel> line. +</para> + +<formalpara> +<title>The Starting Path</title> +<para> +There are two ways to select another path for your new application. One is to select another name. Yet, this is not always feasible (you might ⪚ set up for another version of an already existing application). As an alternative you may select another path to the application directory. +</para> +</formalpara> +<para> +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. +</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. +</para> +<!--TODO add tab description Project Options --> +<note><para> +Take care that the path you enter in the <guilabel>Location</guilabel> field already exists. Otherwise you will not be able to continue to the next step. The &appwizard; will <emphasis>warn</emphasis> you about non-existing paths by appending <quote>(invalid)</quote> to the <guilabel>Final location</guilabel> line. +</para></note> + +<screenshot id="screenshot-createnewprojectoptions"> + <mediaobject> + <imageobject> + <imagedata fileref="createnewprojectoptions.png" format="PNG"/> + </imageobject> + <caption><para> + Set new project up for CVS + </para></caption> + </mediaobject> +</screenshot> + +<formalpara> +<title>Personal Information</title> +<para> +The fields following this are not so critical. Just supply your name (&ie; the name of the person who is responsible for the application) in the <guilabel>Author</guilabel> field, and a valid e-mail address in the <guilabel>Email</guilabel> field, so that users can give you feedback on the application. +</para> +</formalpara> + +<note> +<orderedlist> + <listitem><para> + The &appwizard; fills these fields with some default values, taken from + the Email presets in the &kcontrolcenter;. If these defaults in the <guilabel>Create New Project</guilabel> <guilabel>Author</guilabel> and <guilabel>Email</guilabel> fields do not suit, you may want to have a look at your mail configuration in the &kcontrolcenter;. + </para></listitem> + <listitem><para> + The &appwizard; will integrate this information into the starting program templates if applicable. In &kde; C++ programs for instance you will find it near the beginning of the <filename>main.cpp</filename> source file. + </para></listitem> + <listitem><para> + Of all fields, the <guilabel>Email</guilabel> is <emphasis>optional</emphasis>, reflecting the fact that not every developer may have access to the internet. You may keep this field empty if you wish and proceed nevertheless. + </para></listitem> +</orderedlist> +</note> + +<formalpara> +<title>Version and License Info</title> +<para> +Finally enter a starting version number for your new application in the <guilabel>Version</guilabel> field, and select the license under which you want your application be put from the <guilabel>License</guilabel> tab. +</para> +</formalpara> + +<para> +If you select an application type for which the &appwizard; provides common source template texts (⪚ C/C++), you may view the license notification text on the third page of this <guilabel>Create New Project</guilabel> dialog (see the <link linkend="new-projects-start-templates">Supply header/source templates</link> chapter below). +</para> +<para> +If you selected <quote>Custom</quote> from the <guilabel>License</guilabel> tab you must provide a license text on your own. +</para> + +<note><para> +Both version and license information will as well be integrated into the starting templates in a suiting format the application type you selected does provide. +</para></note> + +<para> +Once you have correctly entered all this information stuff, press the <guibutton>Next ></guibutton> button to proceed as shown in the following chapters. +</para> +</sect3> <!-- new-projects-start-general --> + +</sect2> <!-- new-projects-start --> + +<sect2 id="new-projects-start-cvs"> +<title>Supply Version System Information</title> + +<indexterm zone="new-projects-start-cvs"> + <primary>CVS</primary> + <secondary>new project</secondary></indexterm> +<indexterm zone="new-projects-start-cvs"> + <primary>project</primary> + <secondary>CVS</secondary></indexterm> +<indexterm zone="new-projects-start-cvs"> + <primary>database</primary> + <secondary>CVS</secondary></indexterm> +<indexterm zone="new-projects-start-cvs"> + <primary>version</primary> + <secondary>database</secondary></indexterm> +<indexterm zone="new-projects-start-cvs"> + <primary>version</primary> + <secondary>CVS</secondary></indexterm> + +<para> +In a second step the &appwizard; will lead you to the <guilabel>Version Control System</guilabel> page where you can decide which version control system you want to use. +</para> + +<note><para> +This discussion concentrates on the needs for project creation only. For more information on &CVS; see the <link linkend="cvs">Using &CVS;</link> chapter below. +</para></note> + +<formalpara> +<title>No Version Control System Wanted</title> +<para> +Initially there is <quote>None</quote> selected in the <guilabel>Version control system</guilabel> tab, and the page will be empty otherwise. If you don't want to use a version control system, just click the <guibutton>Next ></guibutton> button and go on. +</para> +</formalpara> + +<formalpara> +<title>Using &CVS;</title> +<para> +Otherwise you must reselect the version control system you want to use from the <guilabel>Version control system</guilabel> tab. We use <quote>&cvs;</quote> for our example. If you select this, the &appwizard; will redisplay the page, now showing a series of fields you must fill in. +</para> +</formalpara> + +<screenshot id="screenshot-newproject-cvs"> + <mediaobject> + <imageobject> + <imagedata fileref="create-new-project-cvs.png" format="PNG"/> + </imageobject> + <caption><para> + Set new project up for CVS + </para></caption> + </mediaobject> +</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. +</para> + +<indexterm zone="new-projects-start-cvs-root"> + <primary>CVS</primary> + <secondary>root</secondary></indexterm> +<indexterm zone="new-projects-start-cvs-root"> + <primary>root</primary> + <secondary>CVS</secondary></indexterm> +<indexterm zone="new-projects-start-cvs-root"> + <primary>CVS</primary> + <secondary>local</secondary></indexterm> +<indexterm zone="new-projects-start-cvs-root"> + <primary>CVS</primary> + <secondary>remote</secondary></indexterm> +<indexterm zone="new-projects-start-cvs-root"> + <primary>local CVS</primary></indexterm> +<indexterm zone="new-projects-start-cvs-root"> + <primary>:local:</primary></indexterm> +<indexterm zone="new-projects-start-cvs-root"> + <primary>CVS</primary> + <secondary>:local:</secondary></indexterm> + +<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. +</para> +</formalpara> + +<para> +<emphasis>Local &CVS; root.</emphasis> There are two basic possibilities. Either you want to use a <emphasis>local</emphasis> &CVS; database or you use a database which is held on a <emphasis>remote server</emphasis>. If you develop for your own, you may want use the &CVS; database as some sort of a backup system on your own computer. Usually this is set up in your home directory root and given the name <filename>cvsroot</filename>. This may look as follows: +</para> +<para><userinput><filename class="directory">/home/devel/cvsroot</filename></userinput> (where <filename>devel</filename> simply denotes the <quote>developing</quote> user, just for example) +</para> + +<note><para> +In fact, this is a short form. Exactly, the local &CVS; root should be addressed using the <computeroutput>:local:</computeroutput> prefix. The short form is only allowed in cases where the filename starts with a slash (<computeroutput>/</computeroutput>). The full name for our example local &CVS; root would exactly look like: <filename class="directory">:local:/home/devel/cvsroot</filename> +</para></note> + +<para> +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. +</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. +</para></note> + +<para> +<emphasis>Remote &CVS; root.</emphasis> There are occasions where the &CVS; database is to be kept on a remote server, especially when several developers work at the same project. Then you must enter the &CVS; root &URL; of this server in the <guilabel>CVS root</guilabel> field. For example, if you want access to the &kde; &CVS; server: +</para> +<para> +<userinput><filename class="directory">:pserver:<replaceable>mylogin</replaceable>@cvs.kde.org:/home/kde</filename></userinput> (where <replaceable>mylogin</replaceable> denotes the login name set up in your &kde; &CVS; account) +</para> + +<indexterm zone="new-projects-start-cvs-remote"> + <primary>remote CVS</primary></indexterm> +<indexterm zone="new-projects-start-cvs-remote"> + <primary>:pserver:</primary></indexterm> +<indexterm zone="new-projects-start-cvs-remote"> + <primary>:ext:</primary></indexterm> +<indexterm zone="new-projects-start-cvs-remote"> + <primary>CVS</primary> + <secondary>:local:</secondary></indexterm> +<indexterm zone="new-projects-start-cvs-remote"> + <primary>CVS</primary> + <secondary>:pserver:</secondary></indexterm> +<indexterm zone="new-projects-start-cvs-remote"> + <primary>CVS</primary> + <secondary>:ext:</secondary></indexterm> + +<formalpara id="new-projects-start-cvs-remote"> +<title>Remote &CVS; Server Types</title> +<para> +Basically there are two widely used remote &CVS; server types, the +<emphasis>pserver</emphasis> which uses a password-secured non-encrypted +protocol, and the <emphasis>ext</emphasis> server which uses an rsh or ssh +encrypted data transfer. They are distinguished by the &URL; prefix they use: +</para> +</formalpara> +<para> +<filename>:pserver:</filename> +</para> +<para> +for the <quote>password protected server</quote> non-encrypted type, and +</para> +<para> +<filename>:ext:</filename> +</para> +<para> +for an rsh or ssh encrypted server type. For example +</para> +<para> +<userinput><filename class="directory">:ext:<replaceable>mylogin</replaceable>@cvs.cervisia.sourceforge.net:/cvsroot/cervisia</filename></userinput> +</para> +<para> +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. +</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. +</para></note> + +<indexterm zone="new-projects-start-cvs-repository"> + <primary>CVS</primary> + <secondary>repository</secondary></indexterm> +<indexterm zone="new-projects-start-cvs-repository"> + <primary>repository</primary> + <secondary>CVS</secondary></indexterm> + +<formalpara id="new-projects-start-cvs-repository"> +<title>The &CVS; Repository</title> +<para> +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>. +</para> +</formalpara> +<para> +In principle you can use any name for the &CVS; repository of your project files as long as it adheres to the specifications of naming a file. Yet, most developers simply use the name of the application itself. &CVS; will build a directory with this name in the &CVS; root, hence it is more easily found if you keep the application name for it. +</para> +<para> +Just enter the repository name you want to use in the <guilabel>CVS repository</guilabel> field of the <guilabel>Create New Project</guilabel> <guilabel>Version Control System</guilabel> page. In our example this is: <userinput>MyApp</userinput> +</para> + +<warning><para> +<emphasis>Take care not to use a repository which already exists!</emphasis> The &CVS; system does not warn about duplicate files but will shovel everything in which does not produce a formal conflict. You will mess up everything! +</para></warning> + +<formalpara> +<title>The Remaining Fields</title> +<para> +There is not much work left to do. &appwizard; has already set up the remaining fields for you. In detail: +</para> +</formalpara> +<para> +The <guilabel>Vendor</guilabel> field is used for compatibility reasons only. You can stick to the <quote>vendor</quote> default the &appwizard; puts in here. +</para> +<para> +The <guilabel>Message</guilabel> field allows you to comment the initial &CVS; contents. Use any text you like or just stick to the <quote>new project</quote> default the &appwizard; did put in. +</para> +<para> +The <guilabel>Release tag</guilabel> holds the name which tags the initial state of your project. Such a <emphasis>tag</emphasis> names a certain point within the &CVS; repository by which you can later access this state of your development. (See more in the <link linkend="cvs">Using &CVS;</link> chapter.) +</para> +<para> +The &appwizard; has put a default <quote>start</quote> tag in here which is a worthy proposal. Just stick to it. +</para> + +<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: +</para> + +<screen><computeroutput> +* cd '/home/devel/test' && cvs -d '/home/devel/mycvsroot' \ + import -m 'new project' '' 'vendor' 'start' &&\ + sh /opt/kde3/share/apps/kdevcvs/buildcvs.sh . '' \ + '/home/devel/mycvsroot' +* cvs [import aborted]: /home/devel/mycvsroot/CVSROOT: No such file or + directory +* *** Exited with status: 1 *** +</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. +</para> +</note> + +<para> +After you have entered all &CVS; related information, click the <guibutton>Next ></guibutton> to go on. +</para> + +<note><para> +If you want to correct an error on the previous <guilabel>Create New Project</guilabel> page, just press the <guibutton>< Back</guibutton> button. The &appwizard; will remember your settings on the current page, so you can easily proceed when you come back. +</para></note> + +</sect2> <!-- new-projects-start-cvs --> + +<sect2 id="new-projects-start-templates"> +<title>Supply Header/Source Templates</title> + +<para> +The next step brings you to a series of pages where you can set up common information you want to include in your source and header files, if the task at hand allows. +</para> +<para> +Both header and source templates are provided for C and C++ applications, each on its own page. For other languages there may be source templates only. And in some cases you will even find this template page empty. +</para> +<para> +If the page is used, &appwizard; will fill in some common header comment which for a C++ based application might look like: +</para> + +<screen><computeroutput><literal> +/*************************************************************************** + * Copyright (C) 2003 by Your Name * + * you@you.com * + * * + * This program is free software; you can redistribute it and/or modify * + * it under the terms of the GNU General Public License as published by * + * the Free Software Foundation; either version 2 of the License, or * + * (at your option) any later version. * + * * + * This program is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * + * GNU General Public License for more details. * + * * + * You should have received a copy of the GNU General Public License * + * along with this program; if not, write to the * + * Free Software Foundation, Inc., * + * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + ***************************************************************************/ +</literal></computeroutput></screen> + +<para> +Other templates will provide similar information in a format according to the definitions of the programming language you want to use. +</para> +<para> +As you might have noticed, the applications manager did readily fill in some information you provided on the first <guilabel>General</guilabel> page of the <guilabel>Create New Project</guilabel> dialog, namely the contents of the <guilabel>Author</guilabel> and <guilabel>Email</guilabel> fields. Also proper license information will have been inserted according to your selection in the <guilabel>License</guilabel> tab. +</para> + +<sect3 id="new-projects-start-templates-edit"> +<title>How to Edit the Templates</title> + +<indexterm zone="new-projects-start-templates-edit"> + <primary>templates</primary> + <secondary>project</secondary> + <tertiary>edit</tertiary></indexterm> +<indexterm zone="new-projects-start-templates-edit"> + <primary>project</primary> + <secondary>templates</secondary> + <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. +</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. +</para> + +<variablelist> +<varlistentry> +<term>Include &doxygen; File Information</term> +<listitem> +<para> +If, for example, you want the &doxygen;-built &API; documentation to display some further information about the file's contents in its filenames list, you may include the following lines in the source file template: +</para> +<screen><computeroutput> +/** + * \file $MODULE$.cpp + * \brief (put some short descripion here). + **/ +</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: +</para> +<screen><computeroutput> +/** + * \file asimpletest.cpp + * \brief (put some short descripion here). + **/ +</computeroutput></screen> +<para> +You will still have to provide the short description after the <quote>\brief</quote> keyword, but part of the job is automatically done for you. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>The License Text File</term> +<listitem> +<para> +As another example you could include an explicit hint to the license text you want to use into the template. Use the <varname>$LICENSEFILE$</varname> variable for this and add for example this line: +</para> + +<screen><computeroutput> +// See $LICENSEFILE$ for the full license text. +</computeroutput></screen> +<para> +The &appwizard; will replace the <varname>$LICENSEFILE$</varname> with the name of the file where the full license text is to be found, namely: +</para> +<screen><computeroutput> +// See COPYING for the full license text. +</computeroutput></screen> +<para> +for the <acronym>GPL</acronym> license, or +</para> +<screen><computeroutput> +// See LICENSE.BSD for the full license text. +</computeroutput></screen> +<para> +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. +</para> +</listitem> +</varlistentry> +</variablelist> + +<note><para> +The templates you define here will come in effect only after the &appwizard; has created the new project. You will find this information on top of the files you created yourself in the development process. When creating the initial files the &appwizard; will use some predefined standard templates. You will have to manually adapt those initial files to your needs. +</para></note> + +</sect3> <!-- new-projects-start-templates-edit --> +</sect2> <!-- new-projects-start-templates --> + +<sect2 id="new-projects-start-build"> +<title>Build the Initial Project Files</title> + +<indexterm zone="new-projects-start-build"> + <primary>project</primary> + <secondary>new</secondary> + <tertiary>build</tertiary></indexterm> +<indexterm zone="new-projects-start-build"> + <primary>project</primary> + <secondary>initial build</secondary></indexterm> + +<para> +Almost everything is done now. On the last templates page the <guibutton>Next ></guibutton> button will have changed to read <guibutton>Finish</guibutton> now. +</para> +<para> +<emphasis>Think twice before you click on it!</emphasis> You still have the option to revise everything by repeatedly using the <guibutton>< Back</guibutton> button. As the &appwizard; remembers all information you did input so far, it may be advisable for you to take the time and look back once again. In case you use local &CVS;, do not forget to double-check the <emphasis>&CVS; repository</emphasis> name (there should be no subdirectory with that name in the &CVS; root directory already—if it does, try another repository name). +</para> +<para> +If ever you don't want the new project be built, abort the <guilabel>Create New Project</guilabel> dialog by the <guibutton>Cancel</guibutton> button. Otherwise click <guibutton>Finish</guibutton> and watch in the <guilabel>Messages</guilabel> window how the &appwizard; initiates the project. +</para> +<para> +If you want to use a versioning system (&CVS;) there will be two runs actually. &appwizard; will first build the project directories and files and then call up the &CVS; program which restarts the <guilabel>Messages</guilabel> window with its own contents. If any error occurs in either of these runs, the process will stop showing you an according error message in the window. +</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;.) +</para></note> + +<para> +Do not forget to initially check what the &appwizard; has provided. For example you may want to change the initial heading informations according to your own templates. Usually you will find these in a <filename class="directory">templates</filename> subdirectory in your project directory. Some simple copy operations will mostly suffice. +</para> +<para> +Then it is advisable that you <emphasis>compile the initial project</emphasis> before you attempt to change any code. In most cases this initial compilation should be possible. Thus you can make up whether the project really was set up according to your needs. If it was not, simply remove the project directory (in your local &CVS; root as well if you use one) and start over again. +</para> + +<warning id="defaultbuild-warning"> <!-- ### remove this when "default" works again --> + + <indexterm zone="defaultbuild-warning"> + <primary>default build configuration</primary> + <secondary>warning</secondary></indexterm> + <indexterm zone="defaultbuild-warning"> + <primary>build configurations</primary> + <secondary>default build warning</secondary></indexterm> + <indexterm zone="defaultbuild-warning"> + <primary>warning</primary> + <secondary>default build configuration</secondary></indexterm> + + <para> + Before you compile your new project the first time, have a look at <menuchoice><guimenu>Project</guimenu> <guimenuitem>Build Configuration</guimenuitem></menuchoice>. If there are three selections displayed: <guimenuitem>default</guimenuitem>, <guimenuitem>optimized</guimenuitem>, and <guimenuitem>debug</guimenuitem>, with <guimenuitem>debug</guimenuitem> selected, by all means stick to this, or use <guimenuitem>optimized</guimenuitem> instead. + </para> + <para> + Due to some limitations in the current autoconf/automake setup you should <emphasis>by no means</emphasis> build in the <guimenuitem>default</guimenuitem> configuration. This will corrupt some internal directory settings, thus making <command>configure</command> complain when you try to use it in the <guimenuitem>optimized</guimenuitem>, or <guimenuitem>debug</guimenuitem> build configuration afterwards. + </para> + <para> + (This applies to these multiselection capabilities only. If the application type you selected provides a <guimenuitem>default</guimenuitem> build configuration only, you should of course use this one.) + </para> +</warning> + +</sect2> <!-- new-projects-start-build --> + +</sect1> <!-- new-projects --> + +<sect1 id="projects-configure"> +<title>Configuring Projects</title> + +<para>(... to be written ...)</para> + +</sect1> + +</chapter> <!-- applicationwizard --> diff --git a/doc/kdevelop/automake-file-popup.png b/doc/kdevelop/automake-file-popup.png Binary files differnew file mode 100644 index 00000000..e40f7108 --- /dev/null +++ b/doc/kdevelop/automake-file-popup.png diff --git a/doc/kdevelop/automake-manager.png b/doc/kdevelop/automake-manager.png Binary files differnew file mode 100644 index 00000000..5e3a9907 --- /dev/null +++ b/doc/kdevelop/automake-manager.png diff --git a/doc/kdevelop/automake-subproject-popup.png b/doc/kdevelop/automake-subproject-popup.png Binary files differnew file mode 100644 index 00000000..e795be9b --- /dev/null +++ b/doc/kdevelop/automake-subproject-popup.png diff --git a/doc/kdevelop/automake-target-popup.png b/doc/kdevelop/automake-target-popup.png Binary files differnew file mode 100644 index 00000000..a561e4cc --- /dev/null +++ b/doc/kdevelop/automake-target-popup.png diff --git a/doc/kdevelop/automakemanager.png b/doc/kdevelop/automakemanager.png Binary files differnew file mode 100644 index 00000000..89891748 --- /dev/null +++ b/doc/kdevelop/automakemanager.png diff --git a/doc/kdevelop/build-commands.png b/doc/kdevelop/build-commands.png Binary files differnew file mode 100644 index 00000000..a6ed86e9 --- /dev/null +++ b/doc/kdevelop/build-commands.png diff --git a/doc/kdevelop/build-configurations.png b/doc/kdevelop/build-configurations.png Binary files differnew file mode 100644 index 00000000..6194255e --- /dev/null +++ b/doc/kdevelop/build-configurations.png diff --git a/doc/kdevelop/build-menu-automake.png b/doc/kdevelop/build-menu-automake.png Binary files differnew file mode 100644 index 00000000..e468bb78 --- /dev/null +++ b/doc/kdevelop/build-menu-automake.png diff --git a/doc/kdevelop/build-menu.png b/doc/kdevelop/build-menu.png Binary files differnew file mode 100644 index 00000000..20353cb5 --- /dev/null +++ b/doc/kdevelop/build-menu.png diff --git a/doc/kdevelop/class-browsers.docbook b/doc/kdevelop/class-browsers.docbook new file mode 100644 index 00000000..7c251ee1 --- /dev/null +++ b/doc/kdevelop/class-browsers.docbook @@ -0,0 +1,90 @@ +<chapter id="class-browsers"> +<title>The Class Browsers</title> +<indexterm zone="class-browsers"><primary>class browser</primary></indexterm> + +<para> +When working on a project in an object-oriented language, your emphasis when +working on a project is not on the source files and their names, but on the +classes and their relationships. In order to help you navigating in the space +of defined classes and symbols, &kdevelop; includes various class browsers +that visualize the class structure in different ways. +</para> + +<sect1 id="classview"> +<title>Class View</title> + +<para> +This view is shown on the left side of the main window and contains a linear +list of all classes, variables and functions in your project. It is designed +as a tree view. If you open a class node by clicking on it, a list with all +methods and attributes of the respective class is shown. +</para> + +<figure id="screenshot-classview" float="1"> +<title>A Screenshot of the Class View</title> +<mediaobject> +<imageobject><imagedata fileref="classview.png"/></imageobject> +</mediaobject> +</figure> + +<para> +The class view works in two different modes. By default, all symbols are +grouped into <quote>Classes</quote>, <quote>Structs</quote>, +<quote>Functions</quote>, <quote>Variables</quote> and +<quote>Namespaces</quote>. In the context menu of the view, you can choose +<guimenuitem>List by Namespaces</guimenuitem>. In this mode, the namespace +hierarchy is shown and the symbols grouped into the respective namespace +where they are defined. This may be more useful in projects which make heavy +use of (nested) namespaces. It is less useful in projects without +namespaces. +</para> + +<para> +You can also change the way in which class names are displayed. Normally, the +names of the classes are shown, without the namespace in which they are defined. +This means, you cannot immediately distinguish classes with the same name in +different namespaces. If you rest for a while with the mouse over an item, the +full scoped name is shown as a tooltip though. You can decide to always +display the fully scoped class name by choosing +<guimenuitem>Full Identifier scopes</guimenuitem> from the context menu. +</para> + +<para> +Clicking on a class or method in the class view brings you to its definition. +You can also jump to the declaration of a method by choosing +<guimenuitem>Go to declaration</guimenuitem> from the context menu. In the +context menu for classes are also the items +<guimenuitem>Add method...</guimenuitem> and +<guimenuitem>Add attribute...</guimenuitem>. This opens dialogs where you can +generate new method and variable declaration in the respective class, together +with an empty implementation. +</para> + +</sect1> <!-- classview --> + +<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> + +<sect1 id="classtools"> +<title>Class Tools</title> + +<para> +The class tool dialog is activated by right clicking on a class in the class +view and choosing <guimenuitem>Class tool...</guimenuitem>. +</para> + +</sect1> <!-- classtools --> + +<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> + +<sect1 id="classhierarchy"> +<title>Class Hierarchy</title> + +<para> +(... to be written ...) +</para> + +</sect1> <!-- classhierarchy --> + +</chapter> <!-- class-browsers --> + +<!-- ====================================================================== --> diff --git a/doc/kdevelop/classview.png b/doc/kdevelop/classview.png Binary files differnew file mode 100644 index 00000000..34e3707d --- /dev/null +++ b/doc/kdevelop/classview.png diff --git a/doc/kdevelop/commands.docbook b/doc/kdevelop/commands.docbook new file mode 100644 index 00000000..31fff849 --- /dev/null +++ b/doc/kdevelop/commands.docbook @@ -0,0 +1,1989 @@ +<chapter id="commands"> + +<!-- TODO +- CAUTION: Check everything against actual KDevelp behaviour. Do not rely on tool tips etc. +- Summarize menu entries, like in getting-started. +- Complete descriptions, e.g. from What's This. +- Link to more detailed description, e.g. in plugin chapter. +--> + +<chapterinfo> + <authorgroup> + <author><firstname>Volker</firstname> <surname>Paul</surname></author> + <!-- TRANS:ROLES_OF_TRANSLATORS --> + </authorgroup> + + <date>2005-04-03</date> +</chapterinfo> + +<title>Command Reference</title> + +<note><para> + The shortcut key combinations shown in this chapter are the default ones. They can be changed. +</para></note> + + + +<sect1 id="menubar"> +<title>The Menubar</title> <para>Note that some menu entries only appear when +they are applicable. Especially, some entries are linked to +<link linkend="plugin-tools">plugin</link> +functionality which is only available when the plugin is enabled.</para> + + + + + + +<!-- ======================= F I L E ============================= --> + +<sect2 id="menu-file"> +<title>The <guimenu>File</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>New</guimenuitem> +</menuchoice></term> +<listitem><para>Create a new file. +The user is prompted to select the directory (default: the current project's +source directory) and enter a file name. The file type can be selected from a list. +Also, the user can choose whether the file is to be added to the project. +Then the Automake Manager asks which target to add the new file to. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Open</guimenuitem> +</menuchoice></term> +<listitem><para>Open an existing file in a simple dialog +box.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Open Recent</guimenuitem> +</menuchoice></term> +<listitem><para>Displays a submenu showing the files recently opened. +Selecting one of these will make KDevelop open that file. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Alt;&Ctrl;<keycap>O</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Quick Open</guimenuitem> +</menuchoice></term> +<listitem><para>Presents a list of files in the current project's +source directory. The user can select from this list +or type a filename. That file is then opened. +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Save</guimenuitem> +</menuchoice></term> +<listitem><para>Saves the current file.</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Save As...</guimenuitem> +</menuchoice></term> +<listitem><para>Uses the +<guilabel>Save As...</guilabel> dialog box to let you save a copy +under a new name.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Save All</guimenuitem> +</menuchoice></term> +<listitem><para>Saves all open files.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycap>F5</keycap></shortcut> +<guimenu>File</guimenu> +<guimenuitem>Reload</guimenuitem> +</menuchoice></term> +<listitem><para>Reloads current file to show changes +made by different programs. +(Note that such changes are normally detected automatically +and the user is prompted whether the file is to be reloaded.) +.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Revert all</guimenuitem> +</menuchoice></term> +<listitem><para> +Reverts all changes in opened files. +Prompts to save changes so the +reversion can be canceled for each +modified file. +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Print...</guimenuitem> +</menuchoice></term> +<listitem><para>Print.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Export</guimenuitem> +</menuchoice></term> +<listitem><para> +Export +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>F4</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Close</guimenuitem> +</menuchoice></term> +<listitem><para> +Closes current file. +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Close All</guimenuitem> +</menuchoice></term> +<listitem><para> +Closes all open files. +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Close All Others</guimenuitem> +</menuchoice></term> +<listitem><para> +Closes all files except the current one. +Very useful if you opened a lot of files and you want +to concentrate on the current one. +Without this, you would have to close them all +and re-open the current one. +</para> +<para>Note there is a similar command in the Window menu. +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Quit</guimenuitem> +</menuchoice></term> +<listitem><para>Close KDevelop.</para></listitem> +</varlistentry> + +</variablelist> + +</sect2> + + + +<!-- ======================= E D I T ============================= --> + + +<sect2 id="menu-edit"> +<title>The <guimenu>Edit</guimenu> Menu</title> + + +<variablelist> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Undo</guimenuitem> +</menuchoice></term> +<listitem><para> +Undo +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Redo</guimenuitem> +</menuchoice></term> +<listitem><para> +Redo +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>X</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Cut</guimenuitem> +</menuchoice></term> +<listitem><para> +Cut +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Copy</guimenuitem> +</menuchoice></term> +<listitem><para> +Copy +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>V</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Paste</guimenuitem> +</menuchoice></term> +<listitem><para> +Paste +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>A</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Select All</guimenuitem> +</menuchoice></term> +<listitem><para> +Select All +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;&Shift;<keycap>A</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Deselect</guimenuitem> +</menuchoice></term> +<listitem><para> +Deselect +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;&Shift;<keycap>B</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Block Selection Mode</guimenuitem> +</menuchoice></term> +<listitem><para> +Block Selection Mode +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul"><keycap>Insert</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Overwrite Mode</guimenuitem> +</menuchoice></term> +<listitem><para> +Overwrite Mode +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>F</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Find</guimenuitem> +</menuchoice></term> +<listitem><para> +Find +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul"><keycap>F3</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Find Next</guimenuitem> +</menuchoice></term> +<listitem><para> +Find Next +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Shift;<keycap>F3</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Find Previous</guimenuitem> +</menuchoice></term> +<listitem><para> +Find Previous +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>R</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Replace</guimenuitem> +</menuchoice></term> +<listitem><para> +Replace +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>G</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Go to Line</guimenuitem> +</menuchoice></term> +<listitem><para> +Go to Line +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Alt;&Ctrl;<keycap>F</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Find in Files</guimenuitem> +</menuchoice></term> +<listitem><para> +Find in Files +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Shift;<keycap>R</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Find-Select-Replace</guimenuitem> +</menuchoice></term> +<listitem><para> +Find-Select-Replace +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Edit</guimenu> +<guimenuitem>Reformat Source</guimenuitem> +</menuchoice></term> +<listitem><para> +Reformat Source +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>J</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Expand Text</guimenuitem> +</menuchoice></term> +<listitem><para> +Expand Text +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>L</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Expand Abbreviation</guimenuitem> +</menuchoice></term> +<listitem><para> +Expand Abbreviation +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>Space</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Complete Text</guimenuitem> +</menuchoice></term> +<listitem><para> +Complete Text +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul"><keycap>F2</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Make Member</guimenuitem> +</menuchoice></term> +<listitem><para> +Make Member +</para></listitem> +</varlistentry> + + +</variablelist> + +</sect2> + + + +<!-- ======================= V I E W ============================= --> + + +<sect2 id="menu-view"> + +<title>The <guimenu>View</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<guimenu>View</guimenu> +<guimenuitem>Back</guimenuitem> +</menuchoice></term> +<listitem><para> +Back +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>View</guimenu> +<guimenuitem>Forward</guimenuitem> +</menuchoice></term> +<listitem><para> +Forward +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>/</keycap></keycombo> +</shortcut> +<guimenu>View</guimenu> +<guimenuitem>Switch to...</guimenuitem> +</menuchoice></term> +<listitem><para> +Switch to... +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Alt;<keycap>C</keycap></keycombo> +</shortcut> +<guimenu>View</guimenu> +<guimenuitem>Raise Editor</guimenuitem> +</menuchoice></term> +<listitem><para> +Raise Editor +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul"><keycap>F4</keycap></keycombo> +</shortcut> +<guimenu>View</guimenu> +<guimenuitem>Next Error</guimenuitem> +</menuchoice></term> +<listitem><para> +Next Error +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Shift;<keycap>F4</keycap></keycombo> +</shortcut> +<guimenu>View</guimenu> +<guimenuitem>Previous Error</guimenuitem> +</menuchoice></term> +<listitem><para> +Previous Error +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Shift;<keycap>F</keycap></keycombo> +</shortcut> +<guimenu>View</guimenu> +<guimenuitem>Full Screen Mode</guimenuitem> +</menuchoice></term> +<listitem><para> +Full Screen Mode +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>F12</keycap></keycombo> +</shortcut> +<guimenu>View</guimenu> +<guimenuitem>Switch Header/Implementation</guimenuitem> +</menuchoice></term> +<listitem><para> +Switch Header/Implementation +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>View</guimenu> +<guimenuitem>Tool Views</guimenuitem> +</menuchoice></term> +<listitem><para> +Tool Views +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>View</guimenu> +<guimenuitem>Tool Docks</guimenuitem> +</menuchoice></term> +<listitem><para> +Tool Docks +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul"><keycap>F7</keycap></keycombo> +</shortcut> +<guimenu>View</guimenu> +<guimenuitem>Switch to Command Line</guimenuitem> +</menuchoice></term> +<listitem><para> +Switch to Command Line +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>View</guimenu> +<guimenuitem>Schema</guimenuitem> +</menuchoice></term> +<listitem><para> +Schema +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul"><keycap>F10</keycap></keycombo> +</shortcut> +<guimenu>View</guimenu> +<guimenuitem>Dynamic Word Wrap</guimenuitem> +</menuchoice></term> +<listitem><para> +Dynamic Word Wrap +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>View</guimenu> +<guimenuitem>Dynamic Word Wrap Indicators</guimenuitem> +</menuchoice></term> +<listitem><para> +Dynamic Word Wrap Indicators +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>View</guimenu> +<guimenuitem>Show/Hide Static Word Wrap Marker</guimenuitem> +</menuchoice></term> +<listitem><para> +Show/Hide Static Word Wrap Marker +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul"><keycap>F6</keycap></keycombo> +</shortcut> +<guimenu>View</guimenu> +<guimenuitem>Show/Hide Icon Border</guimenuitem> +</menuchoice></term> +<listitem><para> +Show/Hide Icon Border +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul"><keycap>F11</keycap></keycombo> +</shortcut> +<guimenu>View</guimenu> +<guimenuitem>Show/Hide Line Numbers</guimenuitem> +</menuchoice></term> +<listitem><para> +Show/Hide Line Numbers +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>View</guimenu> +<guimenuitem>Show/Hide Scrollbar Marks</guimenuitem> +</menuchoice></term> +<listitem><para> +Show/Hide Scrollbar Marks +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul"><keycap>F9</keycap></keycombo> +</shortcut> +<guimenu>View</guimenu> +<guimenuitem>Show/Hide Folding Marks</guimenuitem> +</menuchoice></term> +<listitem><para> +Show/Hide Folding Marks +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>View</guimenu> +<guimenuitem>Code Folding</guimenuitem> +</menuchoice></term> +<listitem><para> +Code Folding +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>View</guimenu> +<guimenuitem>Set Encoding</guimenuitem> +</menuchoice></term> +<listitem><para> +Set Encoding +</para></listitem> +</varlistentry> + + + +</variablelist> + +</sect2> + + + + +<!-- ======================= P R O J E C T ============================= --> + + +<sect2 id="menu-project"> +<title>The <guimenu>Project</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term><menuchoice> +<guimenu>Project</guimenu> +<guimenuitem>New Project...</guimenuitem> +</menuchoice></term> +<listitem><para> +New Project... +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Project</guimenu> +<guimenuitem>Open Project...</guimenuitem> +</menuchoice></term> +<listitem><para> +Open Project... +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Project</guimenu> +<guimenuitem>Open Recent Project</guimenuitem> +</menuchoice></term> +<listitem><para> +Open Recent Project +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Project</guimenu> +<guimenuitem>Active Language</guimenuitem> +</menuchoice></term> +<listitem><para> +Active Language +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Project</guimenu> +<guimenuitem>Import Existing Project...</guimenuitem> +</menuchoice></term> +<listitem><para> +Import Existing Project... +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Project</guimenu> +<guimenuitem>New Class...</guimenuitem> +</menuchoice></term> +<listitem><para> +New Class... +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Project</guimenu> +<guimenuitem>Class Inheritance Diagram</guimenuitem> +</menuchoice></term> +<listitem><para> +Class Inheritance Diagram +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Project</guimenu> +<guimenuitem>Add Translation...</guimenuitem> +</menuchoice></term> +<listitem><para> +Add Translation... +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Project</guimenu> +<guimenuitem>Build Configuration</guimenuitem> +</menuchoice></term> +<listitem><para> +Build Configuration +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Project</guimenu> +<guimenuitem>Distribution & Publishing</guimenuitem> +</menuchoice></term> +<listitem><para> +Distribution & Publishing +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Project</guimenu> +<guimenuitem>Project Options...</guimenuitem> +</menuchoice></term> +<listitem><para> +Project Options... +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Project</guimenu> +<guimenuitem>Close Project</guimenuitem> +</menuchoice></term> +<listitem><para> +Close Project +</para></listitem> +</varlistentry> + + + + +</variablelist> + +</sect2> + + +<!-- ======================= B U I L D ============================= --> + + +<sect2 id="menu-build"> +<title>The <guimenu>Project</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul"><keycap>F8</keycap></keycombo> +</shortcut> +<guimenu>Build</guimenu> +<guimenuitem>Build Project</guimenuitem> +</menuchoice></term> +<listitem><para> +Build Project +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul"><keycap>F7</keycap></keycombo> +</shortcut> +<guimenu>Build</guimenu> +<guimenuitem>Build Active Target</guimenuitem> +</menuchoice></term> +<listitem><para> +Build Active Target +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Build</guimenu> +<guimenuitem>Compile File</guimenuitem> +</menuchoice></term> +<listitem><para> +Compile File +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Build</guimenu> +<guimenuitem>Run Configure</guimenuitem> +</menuchoice></term> +<listitem><para> +Run Configure +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Build</guimenu> +<guimenuitem>Run automake & friends</guimenuitem> +</menuchoice></term> +<listitem><para> +Run automake & friends +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Build</guimenu> +<guimenuitem>Install</guimenuitem> +</menuchoice></term> +<listitem><para> +Install +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Build</guimenu> +<guimenuitem>Install (as root user)</guimenuitem> +</menuchoice></term> +<listitem><para> +Install (as root user) +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Build</guimenu> +<guimenuitem>Clean project</guimenuitem> +</menuchoice></term> +<listitem><para> +Clean project +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Build</guimenu> +<guimenuitem>Distclean</guimenuitem> +</menuchoice></term> +<listitem><para> +Distclean +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Shift;<keycap>F9</keycap></keycombo> +</shortcut> +<guimenu>Build</guimenu> +<guimenuitem>Make Messages & Merge</guimenuitem> +</menuchoice></term> +<listitem><para> +Make Messages & Merge +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Build</guimenu> +<guimenuitem>Execute Program</guimenuitem> +</menuchoice></term> +<listitem><para> +Execute Program +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Build</guimenu> +<guimenuitem>Build API Documentation</guimenuitem> +</menuchoice></term> +<listitem><para> +Build API Documentation +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Build</guimenu> +<guimenuitem>Clean API Documentation</guimenuitem> +</menuchoice></term> +<listitem><para> +Clean API Documentation +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul"><keycap>Escape</keycap></keycombo> +</shortcut> +<guimenu>Build</guimenu> +<guimenuitem>Stop</guimenuitem> +</menuchoice></term> +<listitem><para> +Stop +</para></listitem> +</varlistentry> + + + + +</variablelist> + +</sect2> + + + +<!-- ======================= D E B U G ============================= --> + + +<sect2 id="menu-debug"> +<title>The <guimenu>Project</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term><menuchoice> +<guimenu>Debug</guimenu> +<guimenuitem>Start</guimenuitem> +</menuchoice></term> +<listitem><para> +Start +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Debug</guimenu> +<guimenuitem>Stop</guimenuitem> +</menuchoice></term> +<listitem><para> +Stop +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Debug</guimenu> +<guimenuitem>Interrupt</guimenuitem> +</menuchoice></term> +<listitem><para> +Interrupt +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Debug</guimenu> +<guimenuitem>Run to Cursor</guimenuitem> +</menuchoice></term> +<listitem><para> +Run to Cursor +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Debug</guimenu> +<guimenuitem>Step Over</guimenuitem> +</menuchoice></term> +<listitem><para> +Step Over +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Debug</guimenu> +<guimenuitem>Step over Instruction</guimenuitem> +</menuchoice></term> +<listitem><para> +Step over Instruction +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Debug</guimenu> +<guimenuitem>Step Into</guimenuitem> +</menuchoice></term> +<listitem><para> +Step Into +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Debug</guimenu> +<guimenuitem>Step into Instruction</guimenuitem> +</menuchoice></term> +<listitem><para> +Step into Instruction +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Debug</guimenu> +<guimenuitem>Step Out</guimenuitem> +</menuchoice></term> +<listitem><para> +Step Out +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Debug</guimenu> +<guimenuitem>Toggle Breakpoint</guimenuitem> +</menuchoice></term> +<listitem><para> +Toggle Breakpoint +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Debug</guimenu> +<guimenuitem>Viewers</guimenuitem> +</menuchoice></term> +<listitem><para> +Viewers +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Debug</guimenu> +<guimenuitem>Examine Core File...</guimenuitem> +</menuchoice></term> +<listitem><para> +Examine Core File... +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Debug</guimenu> +<guimenuitem>Attach to Process</guimenuitem> +</menuchoice></term> +<listitem><para> +Attach to Process +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Debug</guimenu> +<guimenuitem>Valgrind Memory Leak Check</guimenuitem> +</menuchoice></term> +<listitem><para> +Valgrind Memory Leak Check +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Debug</guimenu> +<guimenuitem>Profile with KCachegrind</guimenuitem> +</menuchoice></term> +<listitem><para> +Profile with KCachegrind +</para></listitem> +</varlistentry> + + + + +</variablelist> + +</sect2> + + + + + +<!-- ======================= B O O K M A R K S ============================= --> + + + +<sect2 id="menu-bookmarks"> +<title>The <guimenu>Bookmarks</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>B</keycap></keycombo> +</shortcut> +<guimenu>Bookmarks</guimenu> +<guimenuitem>Set Bookmark</guimenuitem> +</menuchoice></term> +<listitem><para>Add current selection to your +bookmarks.</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Bookmarks</guimenu> +<guimenuitem>Clear All Bookmarks</guimenuitem> +</menuchoice></term> +<listitem><para>Clear All Bookmarks.</para></listitem> +</varlistentry> +</variablelist> + +</sect2> + + + + +<!-- ======================= W I N D O W ============================= --> + + +<sect2 id="menu-window"> +<title>The <guimenu>Window</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Alt;<keycap>W</keycap></keycombo></shortcut> +<guimenu>Window</guimenu> +<guimenuitem>Close Selected Windows...</guimenuitem> +</menuchoice></term> +<listitem><para>Close Selected Windows...</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>F4</keycap></keycombo></shortcut> +<guimenu>Window</guimenu> +<guimenuitem>Close</guimenuitem> +</menuchoice></term> +<listitem><para>Close</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Window</guimenu> +<guimenuitem>Close All</guimenuitem> +</menuchoice></term> +<listitem><para>Close All</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Window</guimenu> +<guimenuitem>Close All Others</guimenuitem> +</menuchoice></term> +<listitem><para>Close All Others</para></listitem> +</varlistentry> + + +</variablelist> + +</sect2> + + + + + + +<!-- ======================= T O O L S ============================= --> + + +<sect2 id="menu-tools"> +<title>The <guimenu>Tools</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Read Only Mode</guimenuitem> +</menuchoice></term> +<listitem><para> +Read Only Mode +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Filetype Mode</guimenuitem> +</menuchoice></term> +<listitem><para> +Filetype Mode +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Highlight Mode</guimenuitem> +</menuchoice></term> +<listitem><para> +Highlight Mode +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>End of Line</guimenuitem> +</menuchoice></term> +<listitem><para> +End of Line +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Spelling</guimenuitem> +</menuchoice></term> +<listitem><para> +Spelling +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>I</keycap></keycombo> +</shortcut> +<guimenu>Tools</guimenu> +<guimenuitem>Indent</guimenuitem> +</menuchoice></term> +<listitem><para> +Indent +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;&Shift;<keycap>I</keycap></keycombo> +</shortcut> +<guimenu>Tools</guimenu> +<guimenuitem>unindent</guimenuitem> +</menuchoice></term> +<listitem><para> +unindent +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Clean Indentation</guimenuitem> +</menuchoice></term> +<listitem><para> +Clean Indentation +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>Tab</keycap></keycombo> +</shortcut> +<guimenu>Tools</guimenu> +<guimenuitem>Align</guimenuitem> +</menuchoice></term> +<listitem><para> +Align +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>D</keycap></keycombo> +</shortcut> +<guimenu>Tools</guimenu> +<guimenuitem>Comment</guimenuitem> +</menuchoice></term> +<listitem><para> +Comment +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;&Shift;<keycap>D</keycap></keycombo> +</shortcut> +<guimenu>Tools</guimenu> +<guimenuitem>Uncomment</guimenuitem> +</menuchoice></term> +<listitem><para> +Uncomment +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>U</keycap></keycombo> +</shortcut> +<guimenu>Tools</guimenu> +<guimenuitem>Uppercase</guimenuitem> +</menuchoice></term> +<listitem><para> +Uppercase +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;&Shift;<keycap>U</keycap></keycombo> +</shortcut> +<guimenu>Tools</guimenu> +<guimenuitem>Lowercase</guimenuitem> +</menuchoice></term> +<listitem><para> +Lowercase +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Alt;&Ctrl;<keycap>U</keycap></keycombo> +</shortcut> +<guimenu>Tools</guimenu> +<guimenuitem>Capitalize</guimenuitem> +</menuchoice></term> +<listitem><para> +Capitalize +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>J</keycap></keycombo> +</shortcut> +<guimenu>Tools</guimenu> +<guimenuitem>Join Lines</guimenuitem> +</menuchoice></term> +<listitem><para> +Join Lines +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Word Wrap Document</guimenuitem> +</menuchoice></term> +<listitem><para> +Word Wrap Document +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Difference Viewer...</guimenuitem> +</menuchoice></term> +<listitem><para> +Difference Viewer... +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Execute Command...</guimenuitem> +</menuchoice></term> +<listitem><para> +Execute Command... +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Filter Selection Through Command...</guimenuitem> +</menuchoice></term> +<listitem><para> +Filters selection through external command using +<link linkend="KDevFilter">the Filter plugin</link>. +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Debug Regular Expression...</guimenuitem> +</menuchoice></term> +<listitem><para> +Debug Regular Expression... +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Part Explorer</guimenuitem> +</menuchoice></term> +<listitem><para> +Part Explorer +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Alt;&Ctrl;<keycap>C</keycap></keycombo> +</shortcut> +<guimenu>Tools</guimenu> +<guimenuitem>Quick Open Class...</guimenuitem> +</menuchoice></term> +<listitem><para> +Quick Open Class... +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Alt;&Ctrl;<keycap>M</keycap></keycombo> +</shortcut> +<guimenu>Tools</guimenu> +<guimenuitem>Quick Open Method...</guimenuitem> +</menuchoice></term> +<listitem><para> +Quick Open Method... +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Alt;&Ctrl;<keycap>P</keycap></keycombo> +</shortcut> +<guimenu>Tools</guimenu> +<guimenuitem>Preview Doxygen Output</guimenuitem> +</menuchoice></term> +<listitem><para> +Preview Doxygen Output +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;&Shift;<keycap>S</keycap></keycombo> +</shortcut> +<guimenu>Tools</guimenu> +<guimenuitem>Document Current Function</guimenuitem> +</menuchoice></term> +<listitem><para> +Document Current Function +</para></listitem> +</varlistentry> + + + +</variablelist> + +</sect2> + + + + +<!-- ======================= S E T T I N G S ============================= --> + + +<sect2 id="menu-settings"> +<title>The <guimenu>Settings</guimenu> Menu</title> + + +<variablelist> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>M</keycap></keycombo></shortcut> +<guimenu>Settings</guimenu> +<guimenuitem>Show/Hide Menubar</guimenuitem> +</menuchoice></term> +<listitem><para>Show/Hide the menubar.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Toolbars</guimenuitem> +</menuchoice></term> +<listitem><para>Opens a sub menu where you can choose to show or hide +the various Toolbars.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Show Statusbar</guimenuitem> +</menuchoice></term> +<listitem><para>Show the Statusbar.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Shortcuts...</guimenuitem> +</menuchoice></term> +<listitem><para> +Configure Shortcuts... +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Toolbar...</guimenuitem> +</menuchoice></term> +<listitem><para> +Configure Toolbar... +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Notifications...</guimenuitem> +</menuchoice></term> +<listitem><para> +Configure Notifications... +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Editor...</guimenuitem> +</menuchoice></term> +<listitem><para> +Configure Editor... +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure KDevelop...</guimenuitem> +</menuchoice></term> +<listitem><para> +Configure KDevelop... +</para></listitem> +</varlistentry> + + + + +</variablelist> + +</sect2> + + +<!-- ======================= H E L P ============================= --> + + +<sect2 id="menu-help"> +<title>The <guimenu>Help</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term><menuchoice> +<guimenu>Help</guimenu> +<guimenuitem>KDevelop Handbook</guimenuitem> +</menuchoice></term> +<listitem><para>View this document.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo + action="simul">&Shift;<keycap>F1</keycap></keycombo></shortcut> +<guimenu>Help</guimenu> +<guimenuitem>What's This?</guimenuitem> +</menuchoice></term> +<listitem><para>Draws a question mark (?) beside the mouse +pointer, clicking on a window item such as the +<guiicon>Stop</guiicon> button will then display a brief explanation. +<!-- See +<link linkend="bubble">Tooltips and What's This?</link>.--> +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Help</guimenu> +<guimenuitem>Tip of the Day</guimenuitem> +</menuchoice></term> +<listitem><para> +Tip of the Day +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Alt;&Ctrl;<keycap>I</keycap></keycombo> +</shortcut> +<guimenu>Help</guimenu> +<guimenuitem>Look in Documentation Index...</guimenuitem> +</menuchoice></term> +<listitem><para> +Look in Documentation Index... +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Alt;&Ctrl;<keycap>S</keycap></keycombo> +</shortcut> +<guimenu>Help</guimenu> +<guimenuitem>Search in Documentation...</guimenuitem> +</menuchoice></term> +<listitem><para> +Search in Documentation... +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Help</guimenu> +<guimenuitem>Man Page...</guimenuitem> +</menuchoice></term> +<listitem><para> +Man Page... +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Help</guimenu> +<guimenuitem>Info Page...</guimenuitem> +</menuchoice></term> +<listitem><para> +Info Page... +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Help</guimenu> +<guimenuitem>Report Bug...</guimenuitem> +</menuchoice></term> +<listitem><para>Report bug.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Help</guimenu> +<guimenuitem>About KDevelop...</guimenuitem> +</menuchoice></term> +<listitem><para>Display some brief information about +KDevelop's version number, authors and license agreement.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Help</guimenu> +<guimenuitem>About KDE...</guimenuitem> +</menuchoice></term> +<listitem><para>Show some information about the version of &kde; that +you are running.</para></listitem> +</varlistentry> + +</variablelist> + +</sect2> + + + +</sect1> + + + + +</chapter> diff --git a/doc/kdevelop/configure-adddialog-baselibs.png b/doc/kdevelop/configure-adddialog-baselibs.png Binary files differnew file mode 100644 index 00000000..6d97097c --- /dev/null +++ b/doc/kdevelop/configure-adddialog-baselibs.png diff --git a/doc/kdevelop/configure-adddialog-qt.png b/doc/kdevelop/configure-adddialog-qt.png Binary files differnew file mode 100644 index 00000000..3138d416 --- /dev/null +++ b/doc/kdevelop/configure-adddialog-qt.png diff --git a/doc/kdevelop/configure-adddialog.png b/doc/kdevelop/configure-adddialog.png Binary files differnew file mode 100644 index 00000000..6ebd62d5 --- /dev/null +++ b/doc/kdevelop/configure-adddialog.png diff --git a/doc/kdevelop/configure-doctree-DevHelp.png b/doc/kdevelop/configure-doctree-DevHelp.png Binary files differnew file mode 100644 index 00000000..0cf26aeb --- /dev/null +++ b/doc/kdevelop/configure-doctree-DevHelp.png diff --git a/doc/kdevelop/configure-doctree-TOC.png b/doc/kdevelop/configure-doctree-TOC.png Binary files differnew file mode 100644 index 00000000..cec94cd6 --- /dev/null +++ b/doc/kdevelop/configure-doctree-TOC.png diff --git a/doc/kdevelop/configure-doctree-bookmark.png b/doc/kdevelop/configure-doctree-bookmark.png Binary files differnew file mode 100644 index 00000000..152ee605 --- /dev/null +++ b/doc/kdevelop/configure-doctree-bookmark.png diff --git a/doc/kdevelop/configure-doctree-general.png b/doc/kdevelop/configure-doctree-general.png Binary files differnew file mode 100644 index 00000000..abf8be8c --- /dev/null +++ b/doc/kdevelop/configure-doctree-general.png diff --git a/doc/kdevelop/configure-doctree-textsearch.png b/doc/kdevelop/configure-doctree-textsearch.png Binary files differnew file mode 100644 index 00000000..680f5137 --- /dev/null +++ b/doc/kdevelop/configure-doctree-textsearch.png diff --git a/doc/kdevelop/configure-docu-chm.png b/doc/kdevelop/configure-docu-chm.png Binary files differnew file mode 100644 index 00000000..6456580a --- /dev/null +++ b/doc/kdevelop/configure-docu-chm.png diff --git a/doc/kdevelop/configure-docu-custom.png b/doc/kdevelop/configure-docu-custom.png Binary files differnew file mode 100644 index 00000000..25e3bb6d --- /dev/null +++ b/doc/kdevelop/configure-docu-custom.png diff --git a/doc/kdevelop/configure-docu-devhelp.png b/doc/kdevelop/configure-docu-devhelp.png Binary files differnew file mode 100644 index 00000000..b7db6634 --- /dev/null +++ b/doc/kdevelop/configure-docu-devhelp.png diff --git a/doc/kdevelop/configure-docu-dox.png b/doc/kdevelop/configure-docu-dox.png Binary files differnew file mode 100644 index 00000000..916e32b8 --- /dev/null +++ b/doc/kdevelop/configure-docu-dox.png diff --git a/doc/kdevelop/configure-docu-edit.png b/doc/kdevelop/configure-docu-edit.png Binary files differnew file mode 100644 index 00000000..bc904327 --- /dev/null +++ b/doc/kdevelop/configure-docu-edit.png diff --git a/doc/kdevelop/configure-docu-general.png b/doc/kdevelop/configure-docu-general.png Binary files differnew file mode 100644 index 00000000..0feaef99 --- /dev/null +++ b/doc/kdevelop/configure-docu-general.png diff --git a/doc/kdevelop/configure-docu-indexgen.png b/doc/kdevelop/configure-docu-indexgen.png Binary files differnew file mode 100644 index 00000000..4315b6c3 --- /dev/null +++ b/doc/kdevelop/configure-docu-indexgen.png diff --git a/doc/kdevelop/configure-docu-toc.png b/doc/kdevelop/configure-docu-toc.png Binary files differnew file mode 100644 index 00000000..5f5bfb65 --- /dev/null +++ b/doc/kdevelop/configure-docu-toc.png diff --git a/doc/kdevelop/configure-editor.png b/doc/kdevelop/configure-editor.png Binary files differnew file mode 100644 index 00000000..2e4b80fa --- /dev/null +++ b/doc/kdevelop/configure-editor.png diff --git a/doc/kdevelop/configure-file-selector.png b/doc/kdevelop/configure-file-selector.png Binary files differnew file mode 100644 index 00000000..7ddcb044 --- /dev/null +++ b/doc/kdevelop/configure-file-selector.png diff --git a/doc/kdevelop/configure-file-templates.png b/doc/kdevelop/configure-file-templates.png Binary files differnew file mode 100644 index 00000000..b49fbc77 --- /dev/null +++ b/doc/kdevelop/configure-file-templates.png diff --git a/doc/kdevelop/configure-general.png b/doc/kdevelop/configure-general.png Binary files differnew file mode 100644 index 00000000..b8c7268c --- /dev/null +++ b/doc/kdevelop/configure-general.png diff --git a/doc/kdevelop/configure-project-buildconfig.png b/doc/kdevelop/configure-project-buildconfig.png Binary files differnew file mode 100644 index 00000000..a0236cd8 --- /dev/null +++ b/doc/kdevelop/configure-project-buildconfig.png diff --git a/doc/kdevelop/configure-project-configure.png b/doc/kdevelop/configure-project-configure.png Binary files differnew file mode 100644 index 00000000..c918a48b --- /dev/null +++ b/doc/kdevelop/configure-project-configure.png diff --git a/doc/kdevelop/configure-project-cpp.png b/doc/kdevelop/configure-project-cpp.png Binary files differnew file mode 100644 index 00000000..7d29091c --- /dev/null +++ b/doc/kdevelop/configure-project-cpp.png diff --git a/doc/kdevelop/configure-project-cppoptions.png b/doc/kdevelop/configure-project-cppoptions.png Binary files differnew file mode 100644 index 00000000..2f51ec88 --- /dev/null +++ b/doc/kdevelop/configure-project-cppoptions.png diff --git a/doc/kdevelop/configure-project-doc.png b/doc/kdevelop/configure-project-doc.png Binary files differnew file mode 100644 index 00000000..05b29e6d --- /dev/null +++ b/doc/kdevelop/configure-project-doc.png diff --git a/doc/kdevelop/configure-project-make.png b/doc/kdevelop/configure-project-make.png Binary files differnew file mode 100644 index 00000000..17b5f426 --- /dev/null +++ b/doc/kdevelop/configure-project-make.png diff --git a/doc/kdevelop/configure-project-run.png b/doc/kdevelop/configure-project-run.png Binary files differnew file mode 100644 index 00000000..6bbef8c6 --- /dev/null +++ b/doc/kdevelop/configure-project-run.png diff --git a/doc/kdevelop/configure-select.png b/doc/kdevelop/configure-select.png Binary files differnew file mode 100644 index 00000000..1c272a65 --- /dev/null +++ b/doc/kdevelop/configure-select.png diff --git a/doc/kdevelop/configure-snippets.png b/doc/kdevelop/configure-snippets.png Binary files differnew file mode 100644 index 00000000..64a2ca00 --- /dev/null +++ b/doc/kdevelop/configure-snippets.png diff --git a/doc/kdevelop/create-new-project-cvs.png b/doc/kdevelop/create-new-project-cvs.png Binary files differnew file mode 100644 index 00000000..a4955ae5 --- /dev/null +++ b/doc/kdevelop/create-new-project-cvs.png diff --git a/doc/kdevelop/create-new-project.png b/doc/kdevelop/create-new-project.png Binary files differnew file mode 100644 index 00000000..140d5ebb --- /dev/null +++ b/doc/kdevelop/create-new-project.png diff --git a/doc/kdevelop/createnewproject.png b/doc/kdevelop/createnewproject.png Binary files differnew file mode 100644 index 00000000..965a14d1 --- /dev/null +++ b/doc/kdevelop/createnewproject.png diff --git a/doc/kdevelop/createnewprojectoptions.png b/doc/kdevelop/createnewprojectoptions.png Binary files differnew file mode 100644 index 00000000..1d515bc3 --- /dev/null +++ b/doc/kdevelop/createnewprojectoptions.png diff --git a/doc/kdevelop/credits.docbook b/doc/kdevelop/credits.docbook new file mode 100644 index 00000000..77712cc4 --- /dev/null +++ b/doc/kdevelop/credits.docbook @@ -0,0 +1,24 @@ +<chapter id="credits"> +<title>Credits</title> + +<sect1 id="credits-contributions"> +<title>Contributions</title> + +<para> +<itemizedlist> + <listitem><para> + 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>. + </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>). + </para></listitem> +</itemizedlist> +</para> + +</sect1> <!-- credits-contributions --> + +<!--CREDITS_FOR_TRANSLATORS--> + +</chapter> <!-- credits --> + +<!-- ====================================================================== --> diff --git a/doc/kdevelop/cvs.docbook b/doc/kdevelop/cvs.docbook new file mode 100644 index 00000000..ccdce4e6 --- /dev/null +++ b/doc/kdevelop/cvs.docbook @@ -0,0 +1,139 @@ +<chapter id="cvs"> +<title>Using &CVS;</title> +<indexterm zone="cvs"><primary>CVS</primary></indexterm> +<indexterm zone="cvs"><primary>revision control</primary></indexterm> + +<sect1 id="cvs-basics"> +<title>&CVS; Basics</title> + +<para> +&CVS; is the revision control system which many open source projects - +including &kde; — are using. It stores all sources codes in a central place, +called the <emphasis>repository</emphasis>. From the repository, developers +can check out a current version of the project or snapshots of it at arbitrary +points of time. In contrast to some other revision control systems, it is not +necessary to <emphasis>lock</emphasis> files one wants to work on. So +development can be highly parallelized. +</para> + +<para> +Whenever a developer has finished a task, he <emphasis>commits</emphasis> his +code (accompanied by a log message). &CVS; takes the job to merge the changes +made by several developers. It can of course happen that developers work on +the same piece of code, resulting in a conflicting set of changes (in practice +this occurs seldom, and is often a sign of a lack of communication). In this +case &CVS; rejects a commit; only after all conflicts are resolved, a file can +be committed. +</para> + +<para> +So far, this has been a description of the basic features of &CVS; one usually +has to cope with. But &CVS; can provide a lot more: One can maintain several +branches of a project (⪚ &kde; 1.1.2 and &kde; 2 were branches in &kde;'s +development tree), merge changes from one branch to another, ask for +differences between revisions, the revision history of files &etc; +</para> + +<para> +&CVS; is implemented as a client-server system. As a user, all communication +with the repository goes through the command line program &cvs;. A higher +level user interface is available through frontends like &cervisia; (<ulink +url="http://cervisia.sf.net"/>) or <application>TkCVS</application> (<ulink +url="http://tkcvs.sf.net"/>). In &kdevelop;, only a small part of the &cvs; +functionality which is important for your daily work can be used directly. +</para> + +<para> +Basic knowledge of &CVS; usage is assumed. In particular, you should know +how to checkout a given project from the repository. We recommend the +book <quote>Open Source Development With &CVS;</quote> by Karl Fogel which is freely +distributed (except for the non-technical chapters). See +<ulink url="http://cvsbook.red-bean.com/cvsbook.html"/>. +</para> + +</sect1> <!-- cvs-basics --> + +<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> + +<sect1 id="cvs-commands"> +<title>&CVS; Commands in &kdevelop;</title> + +<para> +In the file views, the following context menu items are available: +</para> + +<variablelist> +<varlistentry> +<term>Add to Repository</term> +<listitem> +<para>Prepares the marked file for addition to the repository. The file +is transferred to the repository when you commit it (or the containing +directory) the next time. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Remove from Repository</term> +<listitem> +<para> +Prepares a file for removal from the repository. This also deletes +the file on the local file system, so use this feature with care! +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Update</term> +<listitem> +<para> +Runs <command>cvs update</command> to merge any changes from other +users into your working directory. When you use this menu item over +a directory, the update normally happens recursively, except if you +have disabled this in the configuration file <filename>.cvsrc</filename>. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Commit</term> +<listitem> +<para> +Runs <command>cvs commit</command> to upload any locally made changes +to the repository. Note that you should update before doing this. +Otherwise, when another user has committed his own changes before, +&CVS; may give you an error message. +</para> +</listitem> +</varlistentry> +</variablelist> + +<para> +All these commands are invoked as subprocesses by &kdevelop; without any +further command line options or environment variables. This may be a +problem when the connection with the &CVS; server goes through a +&ssh; connection and requires that you enter your password each time +you commit or update. This is for instance necessary when your project is +hosted on <filename>sourceforge.net</filename>. Workarounds for this +problem are described on the &CVS;/SSH FAQ which you can find in the +SourceForge documentation. +</para> + +</sect1> <!-- cvs-basics --> + +<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> + +<sect1 id="cvs-behind"> +<title>Behind the Scenes</title> + +<sect2 id="cvs-behind-workdir"> +<title>What &CVS; Records in the Working Directory</title> + +<para> +(... to be written ...) +</para> +</sect2> <!-- cvs-behind-workdir --> + +</sect1> <!-- cvs-behind --> + +</chapter> <!-- cvs --> diff --git a/doc/kdevelop/debugger.docbook b/doc/kdevelop/debugger.docbook new file mode 100644 index 00000000..a06f2c83 --- /dev/null +++ b/doc/kdevelop/debugger.docbook @@ -0,0 +1,242 @@ +<chapter id="debugger"> +<title>The Debugger Interface</title> +<indexterm zone="debugger"><primary>debugger</primary></indexterm> + +<para> +For C and C++, &kdevelop; contains an internal debugger that is directly +integrated with the editor. Technically, it is implemented as a frontend +that uses the portable &GNU; debugger <application>gdb</application> through +a pipe. The debugger can be started in several ways: +</para> + +<itemizedlist> +<listitem> +<para> +With <menuchoice><guimenu>Debug</guimenu><guimenuitem>Start</guimenuitem></menuchoice>, +the main program of your project is loaded into the debugger. +</para> +</listitem> + +<listitem> +<para> +Using <menuchoice><guimenu>Debug</guimenu> +<guimenuitem>Start (other)</guimenuitem> +<guimenuitem>Examine core file</guimenuitem></menuchoice> you load a core file +into memory, which is generated by the operating system kernel when the +program has crashed (The generation of core files may be switched off on your +system, see <application>ulimit(1)</application>). This is useful for a +post-mortem analysis of a program. +</para> +</listitem> + +<listitem> +<para> +With <menuchoice><guimenu>Debug</guimenu> +<guimenuitem>Start (other)</guimenuitem> +<guimenuitem>Attach to process</guimenuitem></menuchoice> you invoke the +debugger on an already running program. You will be shown a +process list where you can select the process which the debugger +should take over. +</para> +</listitem> + +<listitem> +<para> +Note that debugging is only possible if your project has been compiled with +debugging information enabled. It can be activated in the +<guibutton>Compiler options</guibutton> dialog. When this option is switched +on, the compiler generates additional data which allows the debugger to +associate file names and line numbers with addresses in the executable. +</para> +</listitem> +</itemizedlist> + +<para> +The debugger frontend offers several views <quote>into</quote> the process: +</para> + +<para>If you try to debug a project without debugging information, you get +the message <computeroutput>No source...</computeroutput> in the status +bar.If you try to set a breakpoint, it is shown as <computeroutput>Pending +(add)</computeroutput> in the breakpoint window (see below). +</para> + +<variablelist> +<varlistentry> +<term>Variables</term> +<listitem> +<indexterm zone="debugger"><primary>watch variables</primary></indexterm> +<para> +This window lists the values of all local variables at the current execution +point of the program. It covers the variables in the complete call stack, +&ie; the function where the process was interrupted, the function that called +this function, and so on up to <function>main()</function> function. +</para> + +<para> +Another branch in the variables contains watch variables. You can configure +yourself which variables are shown here. Both local and global variables can +be watched. You can add variables either by clicking on the +<guibutton>Add</guibutton> button or pressing <keycap>Return</keycap> while +the <guilabel>Watch</guilabel> item is selected. They can be removed again +via the context menu. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Frame Stack</term> +<listitem> +<indexterm zone="debugger"><primary>frame stack</primary></indexterm> +<para> +(... to be written ...) +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Breakpoints</term> +<listitem> +<indexterm zone="debugger"><primary>breakpoints</primary></indexterm> +<para> +This window allows you to see and manipulate the breakpoints. Remember that +&kdevelop; uses <application>GDB</application>, so to fully understand the +&kdevelop; debugging features, you should know a little bit about the <ulink +url="http://www.gnu.org/software/gdb">GDB</ulink>. +</para> + +<para>If you want to look at the source code, breakpoints are defined in +<filename>kdevelop/languages/cpp/debugger/breakpoint.h</filename>. +</para> + +<para>At the left edge, the window has buttons to:</para> + +<itemizedlist> +<listitem><para>Add an empty breakpoint</para></listitem> +<listitem><para>Edit the selected breakpoint</para></listitem> + <listitem><para>Delete the selected breakpoint</para></listitem> +<listitem><para>Remove all breakpoints</para></listitem> +</itemizedlist> + +<para>The main part of the window is a table with 7 columns. Each line in +the table is a breakpoint. The columns are:</para> + +<orderedlist> +<listitem><para>Selection checkbox</para></listitem> +<listitem><para>Type: one of: Invalid, File:Line, Watchpoint, Address, Function</para></listitem> +<listitem><para>Status. Values are:</para> +<itemizedlist> + <listitem><para>Active</para></listitem> + <listitem><para>Disabled: Each breakpoint may be <quote>enabled</quote> or + <quote>disabled</quote>; if disabled, it has no effect on your program until + you enable it again.</para></listitem> + <listitem><para>Pending (add): a breakpoint is marked like this if no + debugging information is available. From GDB Info page: + <blockquote><para>If a specified breakpoint location cannot be found, it may be due to + the fact that the location is in a shared library that is yet to be + loaded. In such a case, you may want GDB to create a special + breakpoint (known as a <quote>pending breakpoint</quote>) that attempts to resolve + itself in the future when an appropriate shared library gets loaded.</para> + </blockquote> + </para></listitem> +</itemizedlist> +</listitem> +<listitem><para>Pending (clear)</para></listitem> +<listitem><para>Pending (modify)</para></listitem> +<listitem><para>Location in the format filename:linenumber</para></listitem> +<listitem><para>Condition</para></listitem> +<listitem><para>Ignore Count: If this is a number <varname>COUNT</varname> +greater than zero, the next <varname>COUNT</varname> times the breakpoint is +reached, your program's execution does not stop; other than to decrement the +ignore count, <application>gdb</application> takes no action.</para></listitem> +<listitem><para>Hits: counts how many times a breakopint has been hit.</para></listitem> +</orderedlist> + + +</listitem> +</varlistentry> + +<varlistentry> +<term>Disassemble</term> +<listitem> +<indexterm zone="debugger"><primary>disassemble</primary></indexterm> +<para>(... to be written ...)</para> + +</listitem> +</varlistentry> +</variablelist> + + +<sect1 id="settingbreakpoints"> +<title>Setting Breakpoints</title> + +<para> +(... to be written ...) +</para> + +</sect1> <!-- settingbreakpoints --> + +<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> + +<sect1 id ="debuggeroptions"> +<title>Options</title> + +<variablelist> +<varlistentry> +<term>Display Mangled Names</term> +<listitem> +<indexterm zone="debugger"><primary>name mangling</primary></indexterm> +<indexterm zone="debugger"><primary>mangling</primary><secondary>name</secondary></indexterm> + +<para> +In C++, function names in the executable are <quote>mangled</quote>, &ie; +the function names include information about the argument types. This is +necessary in order to support overloading of functions. The mangling +algorithm is not standardized and differs even between different versions of +the &GNU; C++ compiler. +</para> + +<para> +In the disassembling window, normally unmangled names are displayed, so +function signatures appear in the similar way as in the source code, so +they are easily readable. Alternatively, you can decide to see mangled names. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Try Setting Breakpoints on Lib Load</term> +<listitem> +<indexterm zone="debugger"><primary>lazy breakpoints</primary></indexterm> +<indexterm zone="debugger"><primary>breakpoints</primary><secondary>lazy</secondary></indexterm> + +<para> +The debugger backend <application>gdb</application> does not allow to set +breakpoints within code that is not currently loaded. In a highly modular +application, where often code is only loaded on demand as a plugin (using +the libc function <function>dlopen(3)</function>), this can be inconvenient. +Therefore, &kdevelop; rolls its own support for breakpoints in shared +libraries. If you set this option, it allows you to set breakpoints in +libraries which are not loaded. Then, whenever <application>gdb</application> +notifies that a library is loaded, &kdevelop; tries to set the pending +breakpoints. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Enable Floating Toolbar</term> +<listitem> +<indexterm zone="debugger"><primary>debugger toolbar</primary></indexterm> +<indexterm zone="debugger"><primary>toolbar</primary><secondary>debugger</secondary></indexterm> + +<para> +(... to be written ...) +</para> +</listitem> +</varlistentry> +</variablelist> + +</sect1> <!-- debuggeroptions --> + +</chapter> <!-- debugger --> diff --git a/doc/kdevelop/doctree-add-bookmark.png b/doc/kdevelop/doctree-add-bookmark.png Binary files differnew file mode 100644 index 00000000..090c93f9 --- /dev/null +++ b/doc/kdevelop/doctree-add-bookmark.png diff --git a/doc/kdevelop/doctree-reduced.png b/doc/kdevelop/doctree-reduced.png Binary files differnew file mode 100644 index 00000000..30c22e79 --- /dev/null +++ b/doc/kdevelop/doctree-reduced.png diff --git a/doc/kdevelop/doctree.png b/doc/kdevelop/doctree.png Binary files differnew file mode 100644 index 00000000..26264828 --- /dev/null +++ b/doc/kdevelop/doctree.png diff --git a/doc/kdevelop/doctreeview.png b/doc/kdevelop/doctreeview.png Binary files differnew file mode 100644 index 00000000..64031238 --- /dev/null +++ b/doc/kdevelop/doctreeview.png diff --git a/doc/kdevelop/documentation.docbook b/doc/kdevelop/documentation.docbook new file mode 100644 index 00000000..eed065b0 --- /dev/null +++ b/doc/kdevelop/documentation.docbook @@ -0,0 +1,57 @@ +<chapter id="documentation"> +<title>Documentation</title> + +<para> +Documention unfortunately belongs to the most-overlooked programming +issues. Yet, once properly set up and maintained internal and external +documentation provides most valuable help. +</para> + +<para> +Documentation has multiple facets. There is +<itemizedlist> + <listitem><para> + <emphasis>project internal documentation</emphasis>, mainly consisting of + <itemizedlist> + <listitem><para> + <emphasis>comments</emphasis> in header/source files + </para></listitem> + <listitem><para> + <emphasis>internal &API; documentation</emphasis> of your project + generated from the program file by special tools, ⪚ &doxygen; + </para></listitem> + </itemizedlist> + </para></listitem> + <listitem><para> + <emphasis>project external documentation</emphasis>, comprising among others + <itemizedlist> + <listitem><para> + <emphasis>external &API; documentation</emphasis> of ⪚ common system libraries (&kde;, &Qt;, &etc;) + </para></listitem> + <listitem><para> + any other documentation (programming language manuals, general system information, how-to articles and the like) + </para></listitem> + </itemizedlist> + </para></listitem> +</itemizedlist> +</para> +<para> +All this documentation should be easily maintainable and ready at hand whenever you need it. &kdevelop; has provisions for just this. +</para> + +<!-- ### doc browser, notes on internal documentation, how to profit from Doxygen --> + +<sect1 id="docbrowser"> +<title>The Documentation Browser</title> + + +<figure id="screenshot-doctreeview" float="1"> +<title>A Screenshot of the Documentation Tree</title> +<mediaobject> +<imageobject><imagedata fileref="doctreeview.png"/></imageobject> +</mediaobject> +</figure> + +</sect1> <!-- docbrowser --> + +</chapter> <!-- documentation --> diff --git a/doc/kdevelop/documents-contents.png b/doc/kdevelop/documents-contents.png Binary files differnew file mode 100644 index 00000000..9adb1699 --- /dev/null +++ b/doc/kdevelop/documents-contents.png diff --git a/doc/kdevelop/documents-search.png b/doc/kdevelop/documents-search.png Binary files differnew file mode 100644 index 00000000..f1e23048 --- /dev/null +++ b/doc/kdevelop/documents-search.png diff --git a/doc/kdevelop/edit-doctree-TOC-entry.png b/doc/kdevelop/edit-doctree-TOC-entry.png Binary files differnew file mode 100644 index 00000000..f0d56685 --- /dev/null +++ b/doc/kdevelop/edit-doctree-TOC-entry.png diff --git a/doc/kdevelop/editing.docbook b/doc/kdevelop/editing.docbook new file mode 100644 index 00000000..54074bdb --- /dev/null +++ b/doc/kdevelop/editing.docbook @@ -0,0 +1,401 @@ +<chapter id="editing"> +<title>Editing Tools</title> + +<sect1 id="editing-snippets"> +<title>Code Snippets</title> + +<itemizedlist> + <title>Features (preliminary overview)</title> + <listitem><para> + SnippetPart adds a tool-view which by default docks to the right + </para></listitem> + <listitem><para> + Adding, editing and removing of snippets is available via a popup-menu + </para></listitem> + <listitem><para> + Double-clicking a snippet form the list inserts it into to the active view at the current cursor position + </para></listitem> + <listitem><para> + Tool tips show the content of a snippet + </para></listitem> + <listitem><para> + Snippets are stored in the users home-directory, so every user can have his own snippets + </para></listitem> + <listitem><para> + Snippets can contain variables in the style of $<varname>VARNAME</varname>$. On using the snippet the user is prompted to enter replacement value for the variables + </para></listitem> +</itemizedlist> +</sect1> <!-- editing-snippets --> + +<sect1 id="keyboardmapping"> +<title>Keyboard Mapping</title> +<indexterm zone="keyboardmapping"><primary>keybindings</primary></indexterm> + +<para> +In the following, we will list the default keybindings of the +default editor. You can configure them as you like (how?) +</para> + +<informaltable> +<tgroup cols="2"> +<tbody> + +<row><entry><para><keycap> + Left +</keycap></para></entry> +<entry><para> + Moves one character left +</para></entry></row> + +<row><entry><para><keycap> + Right +</keycap></para></entry> +<entry><para> + Moves one character right +</para></entry></row> + +<row><entry><para><keycombo> +&Ctrl;<keycap> + Left +</keycap></keycombo></para></entry> +<entry><para> + Moves one word left +</para></entry></row> + +<row><entry><para><keycombo> +&Ctrl;<keycap> + Right +</keycap></keycombo></para></entry> +<entry><para> + Moves one word right +</para></entry></row> + +<row><entry><para><keycap> + Up +</keycap></para></entry> +<entry><para> + Moves up one line +</para></entry></row> + +<row><entry><para><keycap> + Down +</keycap></para></entry> +<entry><para> + Moves down one line +</para></entry></row> + +<row><entry><para><keycap> + Page Up +</keycap></para></entry> +<entry><para> + Moves up one page +</para></entry></row> + +<row><entry><para><keycap> + Page Down +</keycap></para></entry> +<entry><para> + Moves down one page +</para></entry></row> + +<row><entry><para><keycombo>&Ctrl;<keycap> + Page Down +</keycap></keycombo></para></entry> +<entry><para> + Moves to the beginning of the file +</para></entry></row> + +<row><entry><para><keycombo>&Ctrl; +<keycap> + Page Down +</keycap></keycombo></para></entry> +<entry><para> + Moves to the end of the file +</para></entry></row> + +<row><entry><para><keycap> + Home +</keycap></para></entry> +<entry><para> + Moves to the beginning of the line +</para></entry></row> + +<row><entry><para><keycap> + End +</keycap></para></entry> +<entry><para> + Moves to the end of the line +</para></entry></row> + +</tbody> +</tgroup> +</informaltable> + +<para> +For all the keys above, the &Shift; key can be pressed additionally, +to mark from the current cursor position to the one afterwards. +</para> + +<informaltable> +<tgroup cols="2"> +<tbody> + +<row><entry><para><keycap> + Backspace +</keycap></para></entry> +<entry><para> + Deletes one character left +</para></entry></row> + +<row><entry><para><keycap> + Delete +</keycap></para></entry> +<entry><para> + Deletes the character under the cursor +</para></entry></row> + +<row><entry><para><keycombo> +&Ctrl; +<keycap> + C +</keycap></keycombo></para></entry> +<entry><para> + Copies the selected text to the clipboard +</para></entry></row> + +<row><entry><para><keycombo>&Ctrl;<keycap> + V +</keycap></keycombo></para></entry> +<entry><para> + Pastes the selected text from the clipboard +</para></entry></row> + +<row><entry><para><keycombo>&Ctrl;<keycap> + X +</keycap></keycombo></para></entry> +<entry><para> + Deletes the selected text and puts it into the clipboard +</para></entry></row> + +<row><entry><para><keycombo>&Ctrl;<keycap> + Z +</keycap></keycombo></para></entry> +<entry><para> + Undo +</para></entry></row> + +<row><entry><para><keycombo>&Shift;&Ctrl;<keycap> + Z +</keycap></keycombo></para></entry> +<entry><para> +Redo +</para></entry></row> + +</tbody> +</tgroup> +</informaltable> + +</sect1> <!-- keyboardmapping --> + +<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> + +<sect1 id="editing-reporter"> +<title>The Problem Reporter</title> + +<para> +(... to be written ...) +</para> +</sect1> <!-- editing-reporter --> + +<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> + +<sect1 id="searchinggrepping"> +<title>Searching and Grepping</title> +<indexterm zone="searchinggrepping"><primary>searching</primary></indexterm> +<indexterm zone="searchinggrepping"><primary>finding</primary></indexterm> + +<sect2 id="searching"> +<title>Searching for Text</title> + +<para> +<keycombo>&Ctrl;<keycap>F</keycap></keycombo>- Find +<keycombo>&Ctrl;<keycap>R</keycap></keycombo>- Replace +</para> + +</sect2> <!-- searching --> + + +<sect2 id="isearch"> +<title>ISearch</title> +<indexterm zone="isearch"><primary>isearch</primary></indexterm> +<indexterm zone="isearch"><primary>incremental search</primary></indexterm> +<indexterm zone="isearch"><primary>search</primary><secondary>incremental</secondary></indexterm> + +<para> +The conventional search with <menuchoice><guimenu>Edit</guimenu> +<guimenuitem>Find</guimenuitem></menuchoice> requires you to specify the full +search term before starting. Most of the time, it is much faster to search +incrementally. If you click into the edit field labeled +<guilabel>ISearch</guilabel> in the toolbar, the search is performed as you +type. You will find that often the desired term is already found after typing +in 3 or 4 letters. +</para> + +</sect2> <!-- isearch --> + + +<sect2 id="grep"> +<title>Grep</title> +<indexterm zone="grep"><primary>search</primary><secondary>in files</secondary></indexterm> + +<para> +Both search mechanisms described above are restricted to searching within one +source file. An additional tool which allows you to search through a (possibly +large) number of files is available through the +<guimenuitem>Search in Files...</guimenuitem> item in the +<guimenu>Edit</guimenu> menu. It is basically a frontend for the +&grep;(1) program. +</para> + +<para> +In the dialog, you can specify which files are searched. There is a number of +wildcard patterns available in a combobox. In this way, you can easily +restrict the find mechanism to header files. Furthermore, you specify a +directory where the search is started. If you check the +<guibutton>Recursive</guibutton> box, the search iterates through all +directories in the hierarchy below this one. +</para> + +<para> +The search term is in general a regular expression following POSIX syntax. +For example, you can use the term <literal>"\<K.*"</literal> if you want to +find all words which begin with the letter K. The following characters +are interpreted in a special way: +</para> + +<informaltable> +<tgroup cols="2"> +<tbody> + +<row><entry> + <literal>.</literal> +</entry><entry> + Matches any character +</entry></row> +<row><entry> + <literal>^</literal> +</entry><entry> +Matches the beginning of a line +</entry></row> +<row><entry> + <literal>$</literal> +</entry><entry> + Matches the end of a line +</entry></row> +<row><entry> + <literal>\<</literal> +</entry><entry> + Matches the beginning of a word +</entry></row> +<row><entry> + <literal>\></literal> +</entry><entry> + Matches the end of a word +</entry></row> +<row><entry> + <literal>?</literal> +</entry><entry> + The preceding item matches less than once +</entry></row> +<row><entry> + <literal>*</literal> +</entry><entry> + The preceding item is matched zero or more times +</entry></row> +<row><entry> + <literal>+</literal> +</entry><entry> + The preceding item is matched once or more times +</entry></row> +<row><entry> + <literal>{n}</literal> +</entry><entry> + The preceding item is matched exactly n times +</entry></row> +<row><entry> + <literal>{n,}</literal> +</entry><entry> + The preceding item is matched n or more times +</entry></row> +<row><entry> + <literal>{,n}</literal> +</entry><entry> + The preceding item matches less than n times +</entry></row> +<row><entry> + <literal>{n,m}</literal> +</entry><entry> + The preceding item matches at least <literal>n</literal> times but less +than <literal>m</literal> times +</entry></row> + +</tbody> +</tgroup> +</informaltable> + +<para> +Backreferences to bracketed subexpressions are also available by the notation +<literal>\n</literal>. +</para> + +<para> +For C++ programmers, as special bonus there are some search templates +available for typical patterns. These allow you to search for example +all calls of member functions of a certain object. +</para> + +<para> +Once you start the search by clicking on the <guibutton>Search</guibutton> +button, it will be performed by an external, asynchronous process. All found +items will appear in the view called <guilabel>Grep</guilabel>. You can then +jump to the found items by clicking on them. Note that grep scans the files +as they stored in the file system. If you have modified versions of them in +your editor, you may get some mismatches in the line number, or some found +items will be invalid. You can avoid this by saving all files beforehand. +</para> + +</sect2> <!-- grep --> + +</sect1> <!-- searchinggrepping --> + +<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> + +<sect1 id="code-completion"> +<title>Code Completion</title> + +<para> +(... to be written ...) +</para> +</sect1> <!-- code-completion --> + +<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> + +<sect1 id="newfiles"> +<title>Creating New Files and Classes</title> + +<para> +(... to be written ...) +</para> + +<sect2 id="newfiles-edittemplates"> +<title>Editing the Templates</title> + +<para> +(... to be written ...) +</para> +</sect2> <!-- newfiles-edittemplates --> + +</sect1> <!-- newfiles --> + +</chapter> <!-- editing --> +<!-- ====================================================================== --> diff --git a/doc/kdevelop/editor-ctags-lookup.png b/doc/kdevelop/editor-ctags-lookup.png Binary files differnew file mode 100644 index 00000000..f07a1348 --- /dev/null +++ b/doc/kdevelop/editor-ctags-lookup.png diff --git a/doc/kdevelop/editor-ctags-menu.png b/doc/kdevelop/editor-ctags-menu.png Binary files differnew file mode 100644 index 00000000..b128b69b --- /dev/null +++ b/doc/kdevelop/editor-ctags-menu.png diff --git a/doc/kdevelop/editor-ctags-regenerate.png b/doc/kdevelop/editor-ctags-regenerate.png Binary files differnew file mode 100644 index 00000000..b29cb352 --- /dev/null +++ b/doc/kdevelop/editor-ctags-regenerate.png diff --git a/doc/kdevelop/editor-find-menu.png b/doc/kdevelop/editor-find-menu.png Binary files differnew file mode 100644 index 00000000..e71c6d00 --- /dev/null +++ b/doc/kdevelop/editor-find-menu.png diff --git a/doc/kdevelop/editor-search-doc.png b/doc/kdevelop/editor-search-doc.png Binary files differnew file mode 100644 index 00000000..ad91da28 --- /dev/null +++ b/doc/kdevelop/editor-search-doc.png diff --git a/doc/kdevelop/editor-switch-header.png b/doc/kdevelop/editor-switch-header.png Binary files differnew file mode 100644 index 00000000..76d95c29 --- /dev/null +++ b/doc/kdevelop/editor-switch-header.png diff --git a/doc/kdevelop/empty-ide.png b/doc/kdevelop/empty-ide.png Binary files differnew file mode 100644 index 00000000..3cf19981 --- /dev/null +++ b/doc/kdevelop/empty-ide.png diff --git a/doc/kdevelop/file-browsers.docbook b/doc/kdevelop/file-browsers.docbook new file mode 100644 index 00000000..f8b37735 --- /dev/null +++ b/doc/kdevelop/file-browsers.docbook @@ -0,0 +1,79 @@ +<chapter id="file-browsers"> +<title>The File Browsers</title> + +<para> +On the left side of the main window, &kdevelop; can display various kinds of +lists and trees for the selection of files: +</para> + +<variablelist> +<varlistentry> +<term>File Tree</term> +<listitem> +<para> +This shows a tree view of the file hierarchy below the project directory. If +you click on a file, it is loaded into the editor. For files which do not +contain text, &kdevelop; starts an application that can handle the respective +MIME type. +</para> + +<para> +The file tree is regularly updated whenever something changes in the file +system. For example, if you create new files or directories (even outside +&kdevelop;), this is immediately reflected in the file list. On &Linux;, +this feature makes use of the FAM library. On other operating systems or over +NFS, the directories shown are polled in small intervals. +</para> + +<para> +The file tree hides files which are usually not interesting, like object +files. In the <guimenuitem>Project options</guimenuitem> under +<guibutton>File views</guibutton>, you can configure (as a comma separated +list of wildcards) which patterns are used to filter out irrelevant files. +</para> + +<para> +Furthermore, you can decide to restrict the file tree to show only files which +belong to the currently loaded project. This can be toggled by clicking with +the right mouse button on the root item of the tree. +</para> + +<figure id="screenshot-filetree" float="1"> +<title>A Screenshot of the File Tree</title> +<mediaobject> +<imageobject><imagedata fileref="filetree.png"/></imageobject> +<textobject><phrase>A Screenshot of the File Tree</phrase></textobject> +</mediaobject> +</figure> + +</listitem> +</varlistentry> +<varlistentry> +<term>File Groups</term> +<listitem> +<para> +This shows the files belonging to the project, grouped by their file name +extension. As in the file tree, you can edit a file by clicking on it +with the &LMB;. +</para> + +<para> +The groups shown in this view can be configured under +<guibutton>File views</guibutton> in the +<guimenuitem>Project options</guimenuitem> dialog. In order to customize the +view to your needs, it is helpful to understand how files are distributed on +the groups. For each file, &kdevelop; goes through all groups from top to +bottom. In each group, it looks whether the file name matches one of the +patterns. If there is a match, the file is shown in this group and the +iteration is aborted. This makes it clear that more general patterns should +be put below more specific ones. For example, an asterisk for the +<guilabel>Other</guilabel> group should be the last pattern. +</para> + +</listitem> +</varlistentry> +</variablelist> + +</chapter> <!-- file-browsers --> + +<!-- ====================================================================== --> diff --git a/doc/kdevelop/file-list-close-selected.png b/doc/kdevelop/file-list-close-selected.png Binary files differnew file mode 100644 index 00000000..18ff8b9b --- /dev/null +++ b/doc/kdevelop/file-list-close-selected.png diff --git a/doc/kdevelop/file-list-session-create.png b/doc/kdevelop/file-list-session-create.png Binary files differnew file mode 100644 index 00000000..a80fa37c --- /dev/null +++ b/doc/kdevelop/file-list-session-create.png diff --git a/doc/kdevelop/file-list-session-default.png b/doc/kdevelop/file-list-session-default.png Binary files differnew file mode 100644 index 00000000..1eaf565c --- /dev/null +++ b/doc/kdevelop/file-list-session-default.png diff --git a/doc/kdevelop/file-selector.png b/doc/kdevelop/file-selector.png Binary files differnew file mode 100644 index 00000000..8a357851 --- /dev/null +++ b/doc/kdevelop/file-selector.png diff --git a/doc/kdevelop/filetree.png b/doc/kdevelop/filetree.png Binary files differnew file mode 100644 index 00000000..1e731402 --- /dev/null +++ b/doc/kdevelop/filetree.png diff --git a/doc/kdevelop/find-in-files.png b/doc/kdevelop/find-in-files.png Binary files differnew file mode 100644 index 00000000..17dae505 --- /dev/null +++ b/doc/kdevelop/find-in-files.png diff --git a/doc/kdevelop/folded-tabs.png b/doc/kdevelop/folded-tabs.png Binary files differnew file mode 100644 index 00000000..1218421f --- /dev/null +++ b/doc/kdevelop/folded-tabs.png diff --git a/doc/kdevelop/getting-started.docbook b/doc/kdevelop/getting-started.docbook new file mode 100644 index 00000000..11a08253 --- /dev/null +++ b/doc/kdevelop/getting-started.docbook @@ -0,0 +1,3221 @@ + +<!-- +Please keep the formatting simple. +Do not indent XML constructs. +Keep lines at 80 characters length maximum. +--> + +<chapter id="getting-started"> + +<chapterinfo> +<authorgroup> +<author><firstname>Bernd</firstname><surname>Pol</surname></author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</chapterinfo> + +<title>Getting Started with &kdevelop; — a Guided Tour</title> + +<para>Now that you have got your new &kdevelop; &IDE;, how are you going to make +good use of it? As this is a complex application, the learning curve may be +somewhat steep, especially if you are not already used to this type of an +Integrated Development Environment.</para> + +<para>We will try to soften this learning curve a bit by stepping through the +makings of a simple KDE C++ application. Thereby we will have a (cursory) look +at:</para> + +<simplelist> +<member><link linkend="gettingstarted-overview">A first look — the user +interface elements of the &kdevelop; &IDE;.</link></member> +<member><link linkend="gettingstarted-configure">Doing some initial +configuration.</link></member> +<member><link linkend="gettingstarted-new">How to create a new project.</link> +</member> +<member><link linkend="gettingstarted-edit">Some tips about dealing with +documents.</link></member> +<member><link linkend="gettingstarted-compile">How to compile the application in +this project.</link></member> +<member><link linkend="gettingstarted-extend">How to add classes and other +detail to your project.</link></member> +<member><link linkend="gettingstarted-debug">What to do to debug the +application.</link></member> +<member><link linkend="gettingstarted-doc">Some basic tools to build program or +user documentation.</link></member> +<member><link linkend="gettingstarted-keys">Last but not least, keyboard +shortcuts</link></member> +</simplelist> + +<para>Before we start, one important concept should be made clear.</para> + +<formalpara> +<title>What to expect?</title> +<para>As said, &kdevelop; is an <emphasis>Integrated Development +Environment</emphasis>. That means in essence that &kdevelop; is no development +tool by itself but rather a graphical front end to easily access a wide range of +development tools, many of which actually would require complex keyboard +commands run from a text console.</para> +</formalpara> + +<para>While &kdevelop; eases many of those programming tasks, much of the +complexity from this bundle of tools still remains which means that in order to +fully understand the &kdevelop; &IDE; you will still need to comprehend these +tools actually running beneath the surface.</para> + +<para>Hence, we cannot teach you how to build software, but rather introduce you +to some of the ways &kdevelop; was designed to ease such a software building +process. If you want to learn more about what an Integrated Development +Environment is meant for, you might want to have a look at the <link +linkend="unixdev">Development on &UNIX;</link> historical overview and there +especially at the <link linkend="unixdev-ide">Integrating Concepts and +Tools</link> chapter.</para> + +<note> +<para>The following discussions apply to the default case, where &kdevelop; +starts up in the <guilabel>Simplified IDEAl Window Mode</guilabel>. If you +already did switch to another user interface mode some items may not be there as +described or will behave slightly different. If in doubt which user interface +mode your &kdevelop; currently uses, check with the +<menuchoice><guimenu>Settings</guimenu> <guimenuitem>Configure +KDevelop...</guimenuitem> <guimenuitem>User Interface</guimenuitem></menuchoice> +dialog.</para> +</note> + +<sect1 id="gettingstarted-overview"> +<title>A Very First Look at &kdevelop;</title> + +<para>This is all about what you will see when you first started &kdevelop;. +You will find preliminary information about:</para> + +<simplelist> +<member><link linkend="gettingstarted-overview-basic">What is there on the +surface?</link></member> +<member><link linkend="gettingstarted-overview-help">How to get some +help.</link></member> +<member><link linkend="gettingstarted-overview-menu">What is in the +menus?</link></member> +<member><link linkend="gettingstarted-overview-tools">What are those tool views +for?</link></member> +</simplelist> + +<sect2 id="gettingstarted-overview-basic"> +<title>On the Surface</title> + +<para>When you start &kdevelop; for the first time you will get a display +similar to this one:</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="empty-ide.png" format="PNG"/> +</imageobject> +<caption> +<para>The &kdevelop; initial layout</para> +<para>(Actually the initial &kdevelop; window will be larger, but the elements +you see are the same.)</para> +</caption> +</mediaobject> +</screenshot> + +<formalpara> +<title>Workspace Area and Tool View Tabs</title> +<para>In this initial case &kdevelop; uses the so-called <link +linkend="uimodes-survey">IDEAl user interface mode</link>. A workspace area of +maximum possible size is surrounded left, bottom, and right by a series of +buttons which act similar to tabs on a tabbed display. If you click on one of +those tabs, a so-called <emphasis>tool view window</emphasis> will open which +allows you to work on a specific task.</para> +</formalpara> + +<formalpara> +<title>Menu and Toolbars</title> +<para>On top there is the usual menubar, followed by several rows of toolbars, +some being initially empty. They will get populated once there is a project open +for actual work.</para> +</formalpara> + +<formalpara> +<title>Status Bar</title> +<para>Finally, there is a status bar on the bottom of the window where short +informations on several tasks will be shown.</para> +</formalpara> +</sect2> + +<sect2 id="gettingstarted-overview-help"> +<title>How to Get Some Help</title> + +<para>Besides the <guimenu>Help</guimenu> menu which offers answers to specific +questions, the status bar and two kinds of tool tips provide some quick +information.</para> + +<formalpara> +<title>What Does This Menu Entry Do?</title> +<para>When you place the mouse cursor on a menu entry, there will usually some +short information be displayed in the status bar. While in most cases this +repeats just the name of the selection, in some cases it will provide additional +information about the purpose of the menu command.</para> +</formalpara> + +<formalpara> +<title>What Is the Name of This Item?</title> +<para>On many items a short function name tool tip will pop up when you place +the cursor on it for a few seconds. This is useful for quick orientation on +toolbar or tool view tabs in IDEAl mode when the &IDE; has been set up to +display icons only on these buttons.</para> +</formalpara> + +<formalpara> +<title>What Does This Item Do?</title> +<para>More information is available through expanded tool tip help for many +items on the &IDE;. Select <menuchoice><guimenu>Help</guimenu> +<guimenuitem>What's This?</guimenuitem></menuchoice> or press +<keycombo><keycap>&Shift;</keycap><keycap>F1</keycap></keycombo>, then with the +question mark cursor select the item you want to know more of. You can as well +open any menu this way and click on a specific menu entry (active as well as +greyed disabled ones) to see if more information is available.</para> +</formalpara> +</sect2> + +<sect2 id="gettingstarted-overview-menu"> +<title>What is in the menus?</title> + +<para>There are ten menus selectable on the menubar. Most of them get fully +populated once a project is open for actual work while others require at least +one document be open in an editor window. In short, they will allow the +following action types.</para> + +<note> +<para>This is only a preliminary overview. For a detailed menu description see +the <link linkend="commands">Command Reference</link>.</para> +</note> + +<variablelist> +<varlistentry> +<term><guimenu>File</guimenu></term> +<listitem> +<formalpara> +<title>Usual Actions</title> +<para>This is pretty standard. It allows to create, open, save, print, and close +document files as well as quitting the &kdevelop; application as usual.</para> +</formalpara> + +<formalpara> +<title>Revert All</title> +<para>This allows to revert all recent, yet unsaved changes by reloading the +file from the disk. This works on any file you edit, not only on those which are +part of a project.</para> +</formalpara> +</listitem> +</varlistentry> + +<varlistentry> +<term><guimenu>Edit</guimenu></term> +<listitem> +<para>This menu is useful only if a document is opened.</para> + +<formalpara> +<title>Usual Actions</title> +<para>It provides the usual undo/redo and cut/copy/paste actions. +Furthermore it allows to select text blocks in various ways.</para> +</formalpara> + +<formalpara> +<title>Search and Replace</title> +<para>There are two very powerful search facility available, +<menuchoice><guimenu>Edit</guimenu> <guimenuitem>Find in +Files...</guimenuitem></menuchoice>, and <menuchoice><guimenu>Edit</guimenu> +<guimenuitem>Find-Select-Replace...</guimenuitem></menuchoice>. These allow, in +addition to the usual search and replace actions limited to the the current +document, to conduct global search or search-and-replace actions in one single +turn.</para> +</formalpara> + +<formalpara> +<title>Advanced Text Edit</title> +<para>There are provisions to reformat the current document and to automatically +complete partially typed texts in various ways.</para> +</formalpara> +</listitem> +</varlistentry> + +<varlistentry> +<term><guimenu>View</guimenu></term> +<listitem> +<para>Like the <guimenu>Edit</guimenu> menu, this menu is useful only if there +is an open project. I this case there will be the following actions available +(amongst others):</para> + +<formalpara> +<title>Navigation History</title> +<para>Switch back and forth through the documents &etc; you visited.</para> +</formalpara> + +<formalpara> +<title>Error Tracking</title> +<para>Navigate to the source lines of the errors encountered in the most recent +compilation/build process.</para> +</formalpara> + +<formalpara> +<title>Editor Related Actions</title> +<para>Some entries in the <guimenu>View</guimenu> menu control the look and view +of the editor you use. In case of the &kate; Part (Embedded Advanced Text +Editor) there will be the following controls available:</para> +</formalpara> + +<itemizedlist> +<listitem> +<para>Control the word wrap behavior in the document window.</para> +</listitem> +<listitem> +<para>Show or hide several border displays in the document windows: line +numbers, icons, and, additionally, bookmark marks in the scroll bar.</para> +</listitem> +<listitem> +<para>Control the display of folded (temporarily hidden) sections in a source +text.</para> +</listitem> +</itemizedlist> +</listitem> +</varlistentry> + +<varlistentry> +<term><guimenu>Project</guimenu></term> +<listitem> +<para>All work of &kdevelop; is based on <emphasis>projects</emphasis> which +basically collect source files, build management files, and other information in +one project directory. In this menu you control which project to use, which +properties it has, and some other managing actions. +In particular:</para> + +<formalpara> +<title>Open a Project</title> +<para>Allows to create new projects, open existing ones, and import projects +from other environments.</para> +</formalpara> + +<formalpara> +<title>Project Options</title> +<para>Allows to define a whole bunch of different project properties.</para> +</formalpara> + +<formalpara> +<title>Classes Management</title> +<para>Add new classes to the project and traverse the inheritance tree of a +class.</para> +</formalpara> + +<formalpara> +<title>Distribute Project</title> +<para>Helps to build distribution packages of the project.</para> +</formalpara> +</listitem> +</varlistentry> + +<varlistentry> +<term><guimenu>Build</guimenu></term> +<listitem> +<para>This menu is all about compiling and documenting the project. Thus it is +of use only when a project is actually open. In this case it provides the +following actions:</para> + +<formalpara> +<title>Compile, Link, Execute</title> +<para>Allows to compile and link the whole project or parts of it as well as run +the application from within the &IDE;.</para> +</formalpara> + +<formalpara> +<title>Prepare Build Operations</title> +<para>This actually depends on the make system you use for this project. In the +case of automake projects it allows to run <filename>Makefile.cvs</filename> and +<filename>configure</filename> on their own. There are also provisions to remove +translated files from the project in various stages of intensity.</para> +</formalpara> + +<formalpara> +<title>Install the Application</title> +<para>Allows to install the application both in local directories as well as in +system directories only accessible to the root user.</para> +</formalpara> + +<formalpara> +<title>API Documentation</title> +<para>Build or remove a doxygen-based API documentation of the project as +defined in the project options.</para> +</formalpara> +</listitem> +</varlistentry> + +<varlistentry> +<term><guimenu>Debug</guimenu></term> +<listitem> +<para>Although this menu will be filled once a project is active, it of course +is useful only if the actual project has been previously compiled with debugging +information (this is basically set up in <menuchoice><guimenu>Project</guimenu> +<guimenuitem>Project Options..</guimenuitem></menuchoice>). There are the +following actions available in this case:</para> + +<formalpara> +<title>Usual Debugger Actions</title> +<para>The first section in the <guimenu>Debug</guimenu> provides a graphical +interface to the GDB &GNU; symbolic debugger. It allows to start and stop your +application in the debugger and step through it in various ways.</para> +</formalpara> + +<formalpara> +<title>Breakpoints</title> +<para>&kdevelop; provides several means to set breakpoints in your application +sources. One is through the use of the <guimenuitem>Toggle +Breakpoint</guimenuitem> menu entry.</para> +</formalpara> + +<formalpara> +<title>Advanced Debugging</title> +<para>Other <guimenu>Debug</guimenu> menu entries allow more sophisticated +program analysis. Use +<keycombo><keycap>&Shift;</keycap><keycap>F1</keycap></keycombo> to get more +information about their purpose.</para> +</formalpara> +</listitem> +</varlistentry> + +<varlistentry> +<term><guimenu>Scripts</guimenu></term> +<listitem> +<para>You can call various scripts from this menu to more easily accomplish +tedious actions on the text in the currently selected editor window. The +available actions depend on the selected script, however. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guimenu>Window</guimenu></term> +<listitem> +<para>This is fairly standard. You may select any open document window as well +as close one or more documents windows in here. You may even select a set of +document windows to be closed in one single turn.</para> + +<para>Depending on the editor plugin you use may there be other menu items as +well. So will the default Kate editor plugin additionally allow to split the +editor window horizontally as well as vertically.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guimenu>Tools</guimenu></term> +<listitem> +<para>&kdevelop; is highly customizable. +You may select a favorite editor for your documents as well as provide external +and plugged-in tools to extend the basic &IDE; capabilities. The +<guimenu>Tools</guimenu> menu reflects most of this setup.</para> + +<formalpara> +<title>Advanced Editing</title> +<para>The upper set of <guimenu>Tools</guimenu> menu entries will be provided by +the editor plugin which is in use. You may select your favorite editor via +<menuchoice><guimenu>Settings</guimenu> <guimenuitem>Configure +KDevelop...</guimenuitem> <guilabel>Editor</guilabel></menuchoice>. Once an +editable document file is selected, the upper part of the +<guimenu>Tools</guimenu> menu will provide advanced editing commands specific to +the editor part in use.</para> +</formalpara> + +<formalpara> +<title>Web Side Handling</title> +<para>In case the active document window contains a HTML page (⪚ displayed +from a <guilabel>Documentation</guilabel> selection), the +<guimenu>Tools</guimenu> will show additional menu entries which provide various +means to handle Web pages.</para> +</formalpara> + +<formalpara> +<title>Other Tools</title> +<para>Usually there will be a bunch of other entries according to the currently +available tools. Use <keycombo><keycap>&Shift;</keycap> +<keycap>F1</keycap></keycombo> to get more information about their +purposes.</para> +</formalpara> +</listitem> +</varlistentry> + +<varlistentry> +<term><guimenu>Settings</guimenu></term> +<listitem> +<para>This menu allows you to show and hide menubar, toolbars and statusbar. +Also, you can configure shortcuts, toolbars, notifications, the editor and +&kdevelop;'s general behavior.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guimenu>Help</guimenu></term> +<listitem> +<para>Here you can open this KDevelop manual, look up terms in various +documentation files, open man pages (the traditional UNIX manual format) and +info pages (the GNU manual format). Furthermore you can report bugs here or get +some info about your current KDevelop version and its authors.</para> +</listitem> +</varlistentry> +</variablelist> +</sect2> + +<sect2 id="gettingstarted-overview-tools"> +<title>What are those tool views for?</title> + +<para>In the IDEAl user interface mode the workspace will be surrounded by three +areas of buttons, so-called <emphasis>tool view tabs</emphasis>. They provide +access to <emphasis>tool view windows</emphasis> which accomplish main tasks +during software development. Each of these three tool view areas serves a +different main purpose.</para> + +<itemizedlist> +<listitem> +<formalpara> +<title>Left Side</title> +<para>Provides access to navigation and selection tools</para> +</formalpara> +</listitem> + +<listitem> +<formalpara> +<title>Bottom</title> +<para>These views display messages produced by various tools.</para> +</formalpara> +</listitem> + +<listitem> +<formalpara> +<title>Right Side</title> +<para>Provides access to documentation and source management tools.</para> +</formalpara> +</listitem> +</itemizedlist> + +<para>The number of tool view tabs shown will change once a project is open for +actual work. More tools to work on that project will be available then. The +actual number of tool views depends on the <link linkend="plugin-tools">Plugin +Tools</link> being currently available to &kdevelop;. You will find more on this +topic in the <link linkend="setup">Configuring KDevelop</link> chapter.</para> + +<para>Currently, with no project open and the default number of plugin tools +loaded, you will find the following tool views. Clicking on a tab will open +respectively close its tool view window.</para> + +<variablelist> +<varlistentry> +<term>Navigation and Selection</term> +<listitem> +<formalpara> +<title>File Selector</title> +<para>Provides a panel to navigate the directory tree and select files for work +just like you do in the &konqueror;. Clicking a file will open it in an +appropriate editor window in the workspace area. A right click in the file +selector area will pop up a navigation and file manipulation menu.</para> +</formalpara> + +<formalpara> +<title>File List</title> +<para>Lists the currently open files. Clicking on a file will usually select its +editor window in the workspace area. Use this to quickly navigate in a large +number of open files. Furthermore this view provides a means to organize the +open files into different <emphasis>sessions</emphasis>. This is particularly +useful in very large and complex projects to help the developer concentrate on +different tasks. Right clicking a file will pop up a file manipulation +menu.</para> +</formalpara> +</listitem> +</varlistentry> + +<varlistentry> +<term>Messages Displays</term> +<listitem> +<formalpara> +<title>Application</title> +<para>Displays the output from an application started from within +&kdevelop;.</para> +</formalpara> + +<formalpara> +<title>Diff</title> +<para>Used to display patch file contents. +Displays the output from the difference viewer tool started from the +<menuchoice><guimenu>Tools</guimenu> <guimenuitem>Difference +Viewer...</guimenuitem></menuchoice> menu.</para> +</formalpara> + +<formalpara> +<title>Messages</title> +<para>Displays messages produced by the build tools called from within +&kdevelop;, usually from the <guimenu>Build</guimenu> menu.</para> +</formalpara> + +<formalpara> +<title>Find in Files</title> +<para>Displays the list of items found by the global search operation started +from the <menuchoice><guimenu>Edit</guimenu> <guimenuitem>Find in +Files...</guimenuitem></menuchoice> menu. Clicking on a line here will +automatically open that file at the specified position in an editor +window.</para> +</formalpara> + +<formalpara> +<title>Replace</title> +<para>Lists the results of the global search-and-replace operation issued from +the <menuchoice><guimenu>Edit</guimenu> +<guimenuitem>Find-Select-Replace...</guimenuitem></menuchoice> menu. In this +view you can decide on every found item whether you really want it be replaced +or not.</para> +</formalpara> +<note> +<para>This global search-and-replace facility is actually available only after a +project has been loaded into &kdevelop;. Otherwise the global replace tool in +the <menuchoice><guimenu>Edit</guimenu> +<guimenuitem>Find-Select-Replace...</guimenuitem> </menuchoice> menu will in +fact be be disabled.</para> +</note> + +<formalpara> +<title>Konsole</title> +<para>Opens a &kde; <application>Konsole</application> like terminal emulator +window where you can use keyboard commands in a traditional &UNIX; command line +interface.</para> +</formalpara> +</listitem> +</varlistentry> + +<varlistentry> +<term>Documentation and Source Manipulation</term> +<listitem> +<formalpara> +<title>Documentation</title> +<para>&kdevelop; provides access to a whole bunch of documentation through this +tool. You may here access document files, usually online from remote locations, +in a structured way. And there are several ways available to directly access +valuable information from &kde; or &Qt; manuals.</para> +</formalpara> + +<para>See the <link linkend="documentation">Documentation</link> and <link +linkend="setup-docu">Configuring the Documentation</link> chapters for more +details.</para> + +<formalpara> +<title>Code Snippets</title> +<para>This tool allows you to permanently store selected texts for later use in +other editing cycles. It is a very flexible tool, as any text snipped stored +here may contain a set of variables which will get their actual values at the +time when you insert such a snippet in some other text.</para> +</formalpara> +<para>More information on this is available in the <link +linkend="editing-snippets">Code Snippets</link> and <link +linkend="setup-snippets">Setting Up the Code Snippets Tool</link> +chapters.</para> +</listitem> +</varlistentry> +</variablelist> +</sect2> +</sect1> + +<sect1 id="gettingstarted-configure"> +<title>A Bit of Configuration</title> + +<para>Before we actually start a first example project, we should tailor the +&kdevelop; behavior to our needs. Although most of the default settings will be +appropriate for now, there are a few places which better should be +adjusted.</para> + +<note> +<para>If you want to know more about &kdevelop; configuration, have a look at +the <link linkend="setup">Configuring KDevelop</link> chapter.</para> +</note> + +<sect2 id="gettingstarted-configure-general"> +<title>Some General Settings</title> + +<para>To configure &kdevelop;, click the +<menuchoice><guimenu>Settings</guimenu></menuchoice> menu and select +<menuchoice><guimenuitem>Configure KDevelop...</guimenuitem></menuchoice>. The +<guilabel>Configure KDevelop</guilabel> dialog will pop up, showing the +following <guilabel>General</guilabel> settings page to the right.</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="configure-general.png" format="PNG"/> +</imageobject> +<caption> +<para>The &kdevelop; general configuration dialog</para> +</caption> +</mediaobject> +</screenshot> + +<para>Most of the defaults will be o.k. +But you will probably want to change two of those settings.</para> + +<formalpara> +<title>Default projects directory</title> +<para>At first start of &kdevelop; this will most likely be preset to your home +directory. Most people however prefer a dedicated projects directory for +software development. Change the text box to your preferred parent development +directory. You may select it from the directory tree if you press the +<guilabel>Open file dialog</guilabel> button labeled with a folder icon to the +right of it.</para> +</formalpara> + +<para>In our examples we will assume a (somewhat artificial) user called +<filename class="directory">devel</filename>. +Thus always replace this <quote>devel</quote> by your user name. Our devel user +will utilize the <filename class="directory">/home/devel/projects</filename> +parent directory for actual development. Again, replace <filename +class="directory">projects</filename> with your development directory name. +</para> + +<para>&kdevelop; will by default set up an own subdirectory below this parent +for every new project you create. So will ⪚ all files of a project named +<quote>Hello</quote> in our case be located in the <filename +class="directory">/home/devel/projects/hello</filename> directory.</para> + +<para>You may of course temporarily override these directory settings if you +need to. See the <link linkend="applicationwizard">&appwizard;</link> chapter +for more info on this.</para> + +<formalpara> +<title>Compiler output</title> +<para>Whenever &kdevelop; compiles some source, it will display the messages of +the <application>make</application>, etc. build tools in the +<guilabel>Messages</guilabel> window in the lower part of the workspace area. +Usually these messages will be overwhelmingly wordy. To keep a better overview +of what happens, &kdevelop; has some means of shortening those messages built +in.</para> +</formalpara> + +<para>Depending on the &kdevelop; version you use, the <guilabel>Compiler +output</guilabel> selection may be preset to <quote>Long</quote>, which will +cause all message contents be fully shown. You may probably want to change this +to the far more convenient <quote>Very Short</quote> setting. Just select this +from the drop down box.</para> + +<caution> +<para>Be aware that only <emphasis>most basic</emphasis> information will be +shown in the <guilabel>Messages</guilabel> window this way. In case of errors +during ⪚ a build run you will most likely want to see more, if not all, of +the message texts. They are not lost, however. Just right click into the +<guilabel>Messages</guilabel> window and select ⪚ <quote>Full Compiler +Output</quote> from the popup menu.</para> +</caution> +</sect2> + +<sect2 id="gettingstarted-configure-search"> +<title>Initializing Documentation Search Indexes</title> + +<para>There is another, not so obvious, item which preferably should be +initialized before you start actual development work. This is because you will +want to perform documentation search regularly during development. &kdevelop; +requires some search indexes be created before such search operations can be +performed. So let's initialize them before we attempt our first steps +toward actual &kdevelop; work.</para> + +<para>Open the <guilabel>Documentation</guilabel> tool view at the right side of +the &kdevelop; main window. There open the <guilabel>Search</guilabel> dialog +page.</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="documents-search.png" format="PNG"/> +</imageobject> +<caption><para>Where to generate the search indexes.</para></caption> +</mediaobject> +</screenshot> + +<para>Now press the <guibutton>Update Config</guibutton> button to make sure the +basic search tools are properly set up. A dialog should pop up, telling +<quote>Configuration file updated</quote>. Click <guibutton>OK</guibutton> to +make it disappear.</para> + +<para>This done, &kdevelop; will be ready to parse the documentation it knows of +and build some useful search indexes from it. Press the <guibutton>Update +Index</guibutton> button to the right. Now the <guilabel>Generating Search +Index</guilabel> dialog will pop up showing the progress of the index build +operations.</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="configure-docu-indexgen.png" format="PNG"/> +</imageobject> +<caption><para>&kdevelop; is generating documentation search +indexes.</para></caption> +</mediaobject> +</screenshot> + +<para>This will take some time depending on the size of documentation and the +speed of your machine. But finally the <guibutton>Cancel</guibutton> will make +place to <guibutton>OK</guibutton>. Just press this button to proceed.</para> + +<note> +<itemizedlist> +<listitem> +<para>This usually should work out of the box. In some cases the +<application>htdig</application> application &kdevelop; uses to perform its full +text searches might not be properly set up. Refer to the <link +linkend="setup-docu-textsearch">Setting Up Text Search Indexes</link> chapter +for more help in this case.</para> +</listitem> +<listitem> +<para>To be able to look up &kde; and &Qt; specific API documentation, it is +mandatory that the <emphasis>KDELibs Apidocs</emphasis> were present when +&kdevelop; was installed. If you experience problems building the indexes or +perform the <link linkend="gettingstarted-edit-defs">identifier lookup +examples</link> later in this chapter, make sure that this documentation exists +and is accessible to &kdevelop;. See <link linkend="kdevelop-install">Installing +KDevelop</link> fore more detail.</para> +</listitem> +</itemizedlist> +</note> +</sect2> +</sect1> + + +<sect1 id="gettingstarted-new"> +<title>Starting a New Project</title> + +<para>Almost any application will consist of dozens, hundreds, even thousands of +files which need kept structured and maintainable. To accomplish this, +&kdevelop; organizes software development tasks in +<emphasis>projects</emphasis>. Thus the first practical step to develop software +in &kdevelop; usually is to create a new project.</para> + +<para>Fortunately this is fairly easily accomplished. &kdevelop; provides the +so-called &appwizard; tool for this. (See the <link +linkend="applicationwizard">Getting Started — the &appwizard;</link> +chapter for more.)</para> + +<para>We will now start a simple &kde; application project to illustrate how +easily this is accomplished and which files and tools &kdevelop; will have +provided. Thereby we will have a short look at:</para> + +<simplelist> +<member><link linkend="gettingstarted-new-setup">How to create a new project +with the help of the &appwizard;.</link></member> +<member><link linkend="gettingstarted-new-files">Which files the &appwizard; +initially did set up.</link></member> +<member><link linkend="gettingstarted-new-toolviews">What about the additional +tool view shown with the project?</link></member> +</simplelist> + +<sect2 id="gettingstarted-new-setup"> +<title>How to Create a New Project</title> + +<para>Let us create a rather simple <quote>Hello World</quote> &kde; project. +Just follow these steps.</para> + +<procedure> +<step> +<para>To start the &appwizard; click the <menuchoice><guimenu>Project</guimenu> +<guimenuitem>New Project...</guimenuitem></menuchoice> menu.</para> +</step> + +<step> +<para>The <guilabel>Create New Project</guilabel> dialog will pop up. In the +upper left <guilabel>All Projects</guilabel> window there will be a number of +programming languages listed.</para> + +<substeps> +<step> +<para>We want to build a &kde; C++ application as usual, thus click on the +<guilabel>+</guilabel> label left of the <guilabel>C++</guilabel> label to open +this branch.</para> +</step> + +<step> +<para>A series of possible application targets will be displayed. We will build +a &kde; application, thus open the next sub-branch via the +<guilabel>+</guilabel> label next to <guilabel>KDE</guilabel></para> +</step> + +<step> +<para>Now you will be offered a series of possible <emphasis>project +templates</emphasis>. Navigate down to the end of this branch and click +<guilabel>Simple KDE Application</guilabel>.</para> + +<para>A preview and short description of the application this project template +will produce pops up in the two windows to the right.</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="tutorial-new-project.png" format="PNG"/> +</imageobject> +<caption> +<para>Selecting a <quote>Hello World</quote> project template</para> +</caption> +</mediaobject></screenshot> +</step> + +<step> +<para>Our application will need a name. Find the <guilabel>Properties</guilabel> +area on the dialog bottom and enter a suitable name into the +<guilabel>Application name</guilabel> input field.</para> + +<para>We use <quote>Hello</quote> in our example, but you can use whatever you +like, provided the name consists of letters, number digits, and underlines only. +You will find that the &appwizard; rejects any other character.</para> +</step> + +<step> +<para>Make sure the <guilabel>Location</guilabel> text box below the input field +shows the name of your top project directory as set up in the <link +linkend="gettingstarted-configure">A Bit of Configuration</link> chapter above. +If it does not do so, enter a suitable directory name or select one from the +directory list provided by the folder labeled button to the right.</para> + +<para>If all went well, the <guilabel>Final location</guilabel> line at the +bottom will show the directory path your new project will use. In case there was +an <quote>(invalid)</quote> suffix appended, try another name for your project +and/or make sure the top project directory in the <guilabel>Location</guilabel> +text box really exists and is writable.</para> +</step> + +<step> +<para>Once everything is right, the <guibutton>Next</guibutton> button in the +bottom row of the dialog will be enabled. Click it to proceed.</para> +</step> +</substeps> +</step> + +<step> +<para>This will lead you to the <guilabel>Project Options</guilabel> dialog +page. Make sure the <guilabel>Author</guilabel> and <guilabel>Email</guilabel> +text boxes are properly filled in. Usually they will default to your general +&kde; user settings as given in the <guilabel>Password & User +Account</guilabel> dialog of the &kde; Control Center. If not, change them to +some settings you prefer for your application.</para> + +<screenshot id="gettingstarted-new-setup-options"> +<mediaobject> +<imageobject> +<imagedata fileref="tutorial-hello-options.png" format="PNG"/> +</imageobject> +<caption> +<para>Provide your name and (optionally) email address.</para> +</caption> +</mediaobject> +</screenshot> + +<note> +<para>You must provide an <guilabel>Author</guilabel> name at least. This is +mandatory for the application files setup.</para> +</note> + +<para>If all is right, the <guibutton>Next</guibutton> button will be enabled. +Click it to further proceed.</para> +</step> + +<step> +<para>The following <guilabel>Version Control System</guilabel>, +<guilabel>Template for .h Files</guilabel>, and <guilabel>Template for .cpp +Files</guilabel> dialog pages are not of interest for now. Skip them by clicking +the <guibutton>Next</guibutton> buttons and, finally, the +<guibutton>Finish</guibutton> button.</para> +</step> +</procedure> + +<para>That was all! +The &appwizard; will take over and construct a series of initial files in the +<guilabel>Final location</guilabel> directory you provided in step 2c +above.</para> + +<para>Once this file creation phase is finished, &kdevelop; will open an editor +window for the <emphasis>application main window</emphasis> implementation file +(which is <filename>hello.cpp</filename> in our example), so you can readily +proceed.</para> +</sect2> + +<sect2 id="gettingstarted-new-files"> +<title>Initial Project Files</title> + +<para>Even if our sample Hello project is fairly simple, the &appwizard; did +create a whole bunch of source and project management files. You will most +easily list them if you open the <guilabel>File Tree</guilabel> tool view on the +bottom left. This will open a file list similar to the one below.</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="tutorial-hello-new.png" format="PNG"/> +</imageobject> +<caption> +<para>Initial files in our <quote>Hello World</quote> project</para> +</caption> +</mediaobject> +</screenshot> + +<para>To demonstrate the main bunch of files the &appwizard; produced, we did +open most of the directory branches in the left-hand <guilabel>File +Tree</guilabel> tool view window. Just click the branch names in the tree to see +for yourself.</para> + +<para>Additionally, just for demonstration, we did as well open most of the +branches the <guilabel>Automake Manager</guilabel> tool view window to the right +where some of the project sources are listed, too.</para> + +<sect3 id="gettingstarted-new-files-copyright"> +<title>Copyright Issues</title> + +<para>All &GNU; conformant applications must be copyrighted. There are two +levels which require copyright notices, <emphasis>individual source +files</emphasis> and <emphasis>run-time application level</emphasis>. The +&appwizard; did already put appropriate copyright and licensing information into +the project files.</para> + +<formalpara> +<title>Source File Level Copyrights</title> +<para>Do you remember the <link linkend="gettingstarted-new-setup-options"> +<guilabel>Project Options</guilabel></link> dialog page in the new project +setup? You had to provide your (the developer's) name and optionally an +email address there. Now refer to the top of the <guilabel>hello.cpp</guilabel> +editor window currently displayed in the workspace area. The &appwizard; did +enter these statements on top of the licensing header of every source file it +created.</para> +</formalpara> + +<programlisting> +/*************************************************************************** + * Copyright (C) 2006 by Joe User * + * joe@user.com * + * * + * This program is free software; you can redistribute it and/or modify * +</programlisting> + +<para>You will find exactly the same text headers in every source file you will +create inside &kdevelop; (provided you use the proper built in tools for file +creation). &kdevelop; remembers these settings in some template files you may +find in the <filename class="directory">templates</filename> directory.</para> + +<formalpara> +<title>Application Run-Time Copyrights</title> +<para>Once your &kde; application runs, the user may display some +<guilabel>About</guilabel> data, usually from the <guimenu>Help</guimenu> menu. +The &appwizard; did also take care of this. If you have a look at the +<filename>main.cpp</filename> file, you will find an entry similar to the one +below.</para> +</formalpara> + +<programlisting> +int main(int argc, char **argv) +{ + KAboutData about("hello", I18N_NOOP("Hello"), version, description, + KAboutData::License_GPL, "(C) 2006 Joe User", 0, 0, + "joe@user.com"); + about.addAuthor( "Joe User", 0, "joe@user.com" ); +</programlisting> + +<para>This will put the main developer's name (<quote>Joe User</quote> in +our case) and email address into the <guilabel>About</guilabel> copyright page +in the display and list this name and address on the +<guilabel>Authors</guilabel> page there as well.</para> + +<important> +<para>Whenever you make substantial changes to an existing project, be sure to +enter your name and email address to the copyright notices on every file you +changed and to the run-time copyright display as well. Don't be shy, you +help the open source society considerably if you do so.</para> +</important> +</sect3> + +<sect3 id="gettingstarted-new-files-source"> +<title>Initial Source Files</title> + +<para>The &appwizard; did put the source files into the <filename +class="directory">src</filename> sub-directory of the project's directory. +You will find the <filename>main.cpp</filename>, <filename>hello.h</filename>, +and <filename>hello.cpp</filename> files there as you may have possibly +expected.</para> + +<para>There are some additional files you usually will find in a typical &kde; +application, namely</para> + +<itemizedlist> +<listitem> +<para><filename>hello.desktop</filename> contains some meta data used by +&kdevelop; to maintain and start the application.</para> +</listitem> + +<listitem> +<para><filename>hi16-app-hello.png</filename>, and +<filename>hi32-app-hello.png</filename> contain some initial default icons, +&kdevelop; will use for application display.</para> +</listitem> + +<listitem> +<para>Finally, <filename>helloui.rc</filename> contains a description of the +application's user interface, currently the menus the application will +provide.</para> +</listitem> +</itemizedlist> +</sect3> + +<sect3 id="gettingstarted-new-files-doc"> +<title>Initial Application Documentation</title> + +<para>In the <filename class="directory">doc/en</filename> subdirectory of the +project you will find the <filename>index.docbook</filename> file. This is a +default template from where you can start to write a suitable user +documentation.</para> +</sect3> + +<sect3 id="gettingstarted-new-files-project"> +<title>Project and Auxiliary Files</title> + +<para>You will have noted that the files we introduced so far are listed in +boldface in the <guilabel>File Tree</guilabel> tool view while most of the other +files are not. This depicts the substantially different tasks these files are +used for. The contents of those bold listed files directly influence the +application. Source files will produce the code to be run, others will provide +necessary data or documentation. These files must be maintained and orderly +processed in the build stages by the project, hence they are called +<emphasis>project files</emphasis>.</para> + +<para>If you have a look at the lower <guilabel>Automake Manager</guilabel> +window to the right of the workspace area you will find all project files listed +as well. The &automanag; tool uses this knowledge to take care of the build +control as we shortly will see.</para> + +<para>The other, non-bold listed files are of more auxiliary nature. They belong +to several distinctive classes as follows:</para> + +<itemizedlist> +<listitem> +<formalpara> +<title>Project Build Control</title> +<para>These files control the compile, install, documentation building, &etc; +processes. If the project utilizes the &GNU; +<application>autotools</application> machinery as our example does, you will +find a <filename>Makefile.am</filename> file in each project directory. These +are kind of basic make core files which contain build control commands and will +be processed in conjunction with various <filename>configure</filename> files +during the build stages. Such a build produces a final +<filename>Makefile</filename> in every directory. And from these in turn the +<application>make</application> utility will finally build the binaries of the +application.</para> +</formalpara> + +<para>Those <filename>Makefile.am</filename> files need to be maintained +throughout the development process. Luckily, &kdevelop; relieves you of most of +this burden by the &automanag; tool, which basically is a graphical front end to +maintain <filename>Makefile.am</filename> contents.</para> + +<para>Other project build control files currently listed are +<filename>configure.in.in</filename> and <filename>subdirs</filename> in the +project root directory. They will be processed by some of the files in the +<filename class="directory">admin</filename> &kde; specific administration +directory to produce more <filename>configure</filename> and +<filename>Makefile</filename> type files and finally the application's +binaries.</para> +</listitem> + +<listitem> +<formalpara> +<title>&kdevelop; Control Files</title> +<para>&kdevelop; needs some control and administration data on its own. These +are located in the project root directory, in our example +<filename>hello.kdevelop</filename>, <filename>hello.kdevelop.pcs</filename>, +and <filename>hello.kdevses</filename>.</para> +</formalpara> + +<para>Of particular importance in each project is the +<filename>xxx.kdevelop</filename> (where <quote>xxx</quote> denotes the project +name) file. It is the main <emphasis>KDevelop 3 Project File</emphasis> and +needed if you later want load this project into the &IDE;.</para> + +<warning> +<para>Never do manually modify, rename, or even delete any of these &kdevelop; +control files! The &IDE; will most likely not function properly on your project +afterwards.</para> +</warning> +</listitem> + +<listitem> +<formalpara> +<title>GNU Project Description Files</title> +<para>Some files in the project root directory are mandatory in any &GNU; +conformant application. These are: <filename>AUTHORS</filename>, +<filename>ChangeLog</filename>, <filename>INSTALL</filename>, +<filename>COPYING</filename> (which contains the GNU GENERAL PUBLIC LICENSE), +<filename>INSTALL</filename>, <filename>NEWS</filename>, +<filename>README</filename>, and <filename>TODO</filename>.</para> +</formalpara> +</listitem> + +<listitem> +<formalpara> +<title>Other Files</title> +<para>A few more files, not mentioned yet, are:</para> +</formalpara> + +<itemizedlist> +<listitem> +<para><filename>Doxyfile</filename> controls the creation of the project +specific &API; internal programming interface documentation.</para> +</listitem> + +<listitem> +<para>The <filename class="directory">templates</filename> directory containes +file templates the &IDE; uses as stubs to create new source files. +You may at any time edit these templates. The new contents will be reflected in +the next source files you create of the related types.</para> + +<para>You may ⪚ want to realign the right hand stars in the copyright lines +the &appwizard; inserted into the <filename>cpp</filename> and +<filename>h</filename> template files, so the source files created from them +will look less awkward.</para> +</listitem> + +<listitem> +<para>The <filename class="directory">po</filename> directory will be used for +localization purposes. It is essentially part of the project files (contains a +<filename>Makefile.am</filename>) but will mainly be used in translation +processing. Not of main interest to the application developer, however.</para> +</listitem> + +<listitem> +<para>Finally, the <filename class="directory">admin</filename> directory is +specially needed in &kde; oriented applications. It provides a whole bunch of +files necessary to maintain the application's sources and binaries so they +will integrate properly into the &kde; environment.</para> +</listitem> +</itemizedlist> + +</listitem> +</itemizedlist> +</sect3> +</sect2> + +<sect2 id="gettingstarted-new-toolviews"> +<title>Additional Tool Views</title> + +<para>As you will have noticed, as soon as the &appwizard; had the new project +ready, several additional tool views were provided. These make sense during +project development only and, in short, provide the following +functionality.</para> + +<note> +<para>The tool views actually visible depend on the plugins currently loaded +into &kdevelop;. There are ways to control this. See the <link +linkend="setup-plugins">Plugin Tools</link> chapter for instructions.</para> +</note> + +<sect3 id="gettingstarted-new-toolviews-left"> +<title>Navigation and Selection Tools (left side)</title> + +<itemizedlist> +<listitem> +<formalpara> +<title>Bookmarks</title> +<para>You can mark any text file line in order to quickly return to this +position from everywhere. &kdevelop; will remember all those +<emphasis>bookmarks</emphasis>, even if you close the editor window afterwards. +The <guilabel>Bookmarks</guilabel> tool view lists all those bookmarks by file +name and line number. You need only click such an entry to open the editor +window accordingly and position the cursor on that line.</para> +</formalpara> +</listitem> + +<listitem> +<formalpara> +<title>Classes</title> +<para>Lists classes, methods, &etc; known in the project. Clicking the entry +opens the appropriate header or source file in an editor window and positions +the cursor at the respective declaration or definition.</para> +</formalpara> +</listitem> + +<listitem> +<formalpara> +<title>File Groups</title> +<para>Sorts the files in the projects into various utility groups, &ie; Sources, +User Interface, Icons, Translations, and Others. Clicking an entry opens that +file in an editor window.</para> +</formalpara> +</listitem> + +<listitem> +<formalpara> +<title>Variables</title> +<para>This is used by the debugger tool to display, evaluate, and watch +variables during debug runs.</para> +</formalpara> +</listitem> +</itemizedlist> +</sect3> + +<sect3 id="gettingstarted-new-toolviews-bottom"> +<title>Messages (bottom)</title> + +<itemizedlist> +<listitem> +<formalpara> +<title>Valgrind</title> +<para><application>Valgrind</application> is a run-time program analyzer. This +tool view lists the results of such an analyze run. It is used ⪚ to find +memory leaks.</para> +</formalpara> +</listitem> + +<listitem> +<formalpara> +<title>Security Problems</title> +<para>There is a <guilabel>Security Checker</guilabel> plugin tool for +&kdevelop;. It analyzes the currently edited source file for several common +security problems which may occur in the application and notifies the user in +this tool view window.</para> +</formalpara> +</listitem> + +<listitem> +<formalpara> +<title>Breakpoints</title> +<para>This tool view allows to explicitly set, clear, and manage debug +breakpoints in the application source files. It is used in conjunction with the +debugger.</para> +</formalpara> +</listitem> + +<listitem> +<formalpara> +<title>CTags</title> +<para>Allows to create a database of identifier indexes using the popular +<application>CTags</application> application. This tags database may then be +used from out this tool view window to look up any needed identifier in the +project sources. Clicking a thus found item line will open an editor window and +position the cursor on the appropriate identifier there.</para> +</formalpara> +</listitem> + +<listitem> +<formalpara> +<title>Problems</title> +<para>&kdevelop; keeps track of common programming problems in the currently +edited source file and notifies the user in this tool view window.</para> +</formalpara> +</listitem> +</itemizedlist> +</sect3> + +<sect3 id="gettingstarted-new-toolviews-right"> +<title>Source Management (right side)</title> + +<itemizedlist> +<listitem> +<formalpara> +<title>Automake Manager</title> +<para>The &automanag; tool is basically a graphical front end to maintain the +contents of the <filename>Makefile.am</filename> files located in each project +directory. This tool view uses two windows to control its work. The upper window +mirrors part of the project subdirectories, namely those which explicitly +contain <emphasis>project files</emphasis>. Each subdirectory of this kind must +contain a <filename>Makefile.am</filename> file and is termed a +<emphasis>subproject</emphasis> in the &automanag; context.</para> +</formalpara> + +<para>Clicking a subproject entry opens a suitable display of the project files +in this subproject in the lower window. The files listed there will be grouped +according to their <filename>Makefile.am</filename> functionality in this +subproject.</para> + +<para>The &automanag; is a very powerful tool to manage the project and its +subprojects as well as the roles project files play in building the application. +We will have a short look at a few major details <link +linkend="gettingstarted-extend-automake">below</link>. See the <link +linkend="project-management">Building and Project Management</link> chapter for +a more extensive description.</para> +</listitem> +</itemizedlist> +</sect3> +</sect2> +</sect1> + + +<sect1 id="gettingstarted-edit"> +<title>Some Tips About Dealing With Documents</title> + +<para>In our example project the &appwizard; did leave the +<filename>hello.cpp</filename> file open in an editor window, so you can +immediately start working. Now, we may well assume your are knowledgeable about +using an editor, so we do not need talk much about this here. But there are some +handy &kdevelop; specifics about dealing with such tabbed editor windows and the +documents you are working on. We will have a short look at some of them, +namely:</para> + +<simplelist> +<member><link linkend="gettingstarted-edit-headers">How to easily switch between +header and implementation files.</link></member> +<member><link linkend="gettingstarted-edit-defs">How to quickly access +declarations and definitions.</link></member> +<member><link linkend="gettingstarted-edit-arrange">How to arrange editor +windows to your current needs.</link></member> +<member><link linkend="gettingstarted-edit-problems">How to keep an eye on +common problems.</link></member> +</simplelist> + +<sect2 id="gettingstarted-edit-headers"> +<title>Switching Between Header and Implementation Files</title> + +<para>&kdevelop; provides a quick and easy way to switch from a given +implementation (<filename>.cpp</filename>) file to the corresponding header +(<filename>.h</filename>) file and vice versa. Just right click into the editor +window you want to switch. A menu similar to the following will pop up.</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="editor-switch-header.png" format="PNG"/> +</imageobject> +<caption><para>How to switch between implementation and header +files.</para></caption> +</mediaobject> +</screenshot> + +<para>Find the <guimenuitem>Switch header/implementation</guimenuitem> entry and +select it. &kdevelop; will look up the corresponding header or implementation +file and open it in another editor window. In our example, if you did right +click into the <filename>hello.cpp</filename> source, the +<filename>hello.h</filename> file will be displayed and the cursor positioned +there.</para> + +<para>There is even more. If you do right click inside the text of a class +implementation, &kdevelop; will position the cursor on the corresponding +declaration line in the header file. And vice versa, right clicking on a +declaration line will bring you to the corresponding class +implementation.</para> + +<para>If the editor window with the file to be switched to already exists, +&kdevelop; will of course activate this one and reposition the cursor there if +necessary.</para> +</sect2> + +<sect2 id="gettingstarted-edit-defs"> +<title>How to Access Declarations and Definitions</title> + +<para>But what if you are working on a source file and want to look up the +declaration or definition of an identifier you just found there? Well, this is +equally easily accomplished. Basically all you need to do is to right click on +the identifier in question.</para> + +<para>There are two different cases to consider, however, namely:</para> +<simplelist> +<member><link linkend="gettingstarted-edit-defs-external">Accessing externally +defined identifiers</link>, and</member> +<member><link linkend="gettingstarted-edit-defs-project">dealing with project +internal text items</link>.</member> +</simplelist> + +<sect3 id="gettingstarted-edit-defs-external"> +<title>External Declarations and Definitions</title> + +<para>In a most common case you want to look up an identifier which was defined +externally to your project. In &kde; projects such identifiers are most likely +documented in various &kde; or &Qt; libraries. If &kde; and &kdevelop; were +properly installed, &kdevelop; will be able to access such so-called API +documentation and be able to search it for identifiers of this kind.</para> + +<para>Let us look at an example. In the <filename>hello.cpp</filename> editor +window find the following lines.</para> + +<programlisting> +Hello::Hello() + : KMainWindow( 0, "Hello" ) +{ +</programlisting> + +<para>Right click on <classname>KMainWindow</classname>. +A menu will pop up. There select the <guimenuitem>Search in Documentation: +KMainWindow</guimenuitem> entry and release the mouse button. Now the +<guilabel>Documentation</guilabel> tool view will open, showing the +<classname>KMainWindow</classname> entry as search item on the +<guilabel>Search</guilabel> sub-page. And a short while after another editor +window will open in the workspace area, showing the KDE API Reference page of +the <classname>KMainWindow</classname> class.</para> + +<para>This all will look like the following. (We deliberately opened the +<guilabel>Documentation</guilabel>, <guilabel>Search</guilabel> page already to +illustrate the result of the menu selection.)</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="editor-search-doc.png" format="PNG"/> +</imageobject> +<caption><para>How to look up an externally documented +identifier.</para></caption> +</mediaobject> +</screenshot> + +<para>You might as well select <guimenuitem>Find Documentation: +KMainWindow</guimenuitem>. In this case the <guilabel>Finder</guilabel> sub-page +of the <guilabel>Documentation</guilabel> tool view will show up, usually +providing a selection of pages containing the search term. (In our example this +will probably be the <classname>KMainWindow</classname> and +<classname>KMainWindowInterface</classname> classes. Select the one you are +interested in and the corresponding documentation will be displayed in an editor +window.</para> + +<note> +<para>If this did not work, then there is probably no documents index yet. Did +you initialize the indexes as shown <link +linkend="gettingstarted-configure-search">above</link>? If not, please do so, +then come back here and try again.</para> +</note> +</sect3> + +<sect3 id="gettingstarted-edit-defs-project"> +<title>Project Internal Declarations and Definitions</title> + +<para>Such search facilities in external documentation have their limitations, +however. Of course one cannot look up an identifier externally if it is only +defined and used inside the current project. But there is help. &kdevelop; can +use indexes built by the <application>CTags</application> application to search +the sources in your project.</para> + +<para>Before we can use this on our Hello example project, we must however first +generate a suitable index. This is done by the <guilabel>CTags</guilabel> tool +view at the bottom of the workspace area.</para> + +<para>When you click the <guibutton>CTags</guibutton> tab, a dialog window will +open where you will find the following key in the lower right corner.</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="editor-ctags-regenerate.png" format="PNG"/> +</imageobject> +<caption><para>Build a CTags index with the <guibutton>Regenerate</guibutton> +key.</para></caption> +</mediaobject> +</screenshot> + +<para>Press the <guibutton>Regenerate</guibutton> button and wait a few seconds. +Then the <guilabel>No CTags Database Found</guilabel> will be replaced by the +current date. Now you are ready to perform some identifier look ups in your +project source.</para> + +<tip> +<para>The date next to the <guilabel>Regenerate</guilabel> button is there to +remind you of possibly too old indexes. Whenever you are obviously not able to +look up some identifier in your project, consider regenerating the index. On +large projects this might take considerable time, but you should make it a habit +to regenerate the index regularly after extensive source file changes.</para> +</tip> + +<para>To look up an identifier in your project sources there are several +possibilities.</para> + +<itemizedlist> +<listitem> +<formalpara> +<title>Use the CTags tool view</title> +<para>This is easy. +Just start typing the identifier name you are interested in into the +<guilabel>Lookup</guilabel> input field in the bottom left. &kdevelop; will try +to complete the word you have typed so far and show all occurrences of those +identifiers which start with this character sequence.</para> +</formalpara> + +<para>If for example you want to know wherever the <quote>Hello</quote> +identifier was used in our example project, type an "H" into the +<guilabel>Lookup</guilabel> input field. &kdevelop; will immediately start +working and present you a result like this:</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="editor-ctags-lookup.png" format="PNG"/> +</imageobject> +<caption><para>How to look up an identifier in the <guilabel>CTags</guilabel> +tool view.</para></caption> +</mediaobject> +</screenshot> + +<para>If you click one of the listed entries, &kdevelop; will open an editor +window with this file and position the cursor on the appropriate place.</para> +</listitem> + +<listitem> +<formalpara> +<title>Use a context menu in a source file</title> +<para>This is handy while you are working on a certain source file. +Assume you are studying the <filename>main.cpp</filename> file of our Hello +example project. There you find the following line</para> +</formalpara> +<programlisting> + Hello *mainWin = 0; +</programlisting> +<para>and wonder whatever the <quote>Hello</quote> was used for in the program. +To find out, simply right click on this Hello identifier. A menu will pop up in +response to this right mouse click, featuring the following lines near the +bottom.</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="editor-ctags-menu.png" format="PNG"/> +</imageobject> +<caption><para>Getting <application>CTags</application> information on a project +internal identifier.</para></caption> +</mediaobject> +</screenshot> + +<para>Click what you are interested in, say <guilabel>CTags - Go to Definition: +Hello</guilabel>, and &kdevelop; will immediately open the +<filename>hello.cpp</filename> editor window and position the cursor right in +front of this class definition:</para> +<programlisting> +Hello::Hello() + : KMainWindow( 0, "Hello" ) +{ +</programlisting> +</listitem> + +<listitem> +<formalpara> +<title>Do a global search</title> +<para>This is especially useful if you want to look up arbitrary text in your +project source. There are two possibilities to start a global search from within +&kdevelop;.</para> +</formalpara> +<itemizedlist> +<listitem> +<para>Start a global search from the <menuchoice><guimenu>Edit</guimenu> +<guimenuitem>Find in Files...</guimenuitem></menuchoice> menu. +Or</para> +</listitem> +<listitem> +<para>Directly make use of the context menu with a right mouse click in the +editor window.</para> +</listitem> +</itemizedlist> + +<para>We will illustrate the second possibility on our Hello example project. +The outcome of the menu call will essentially be the same. Let us assume you are +studying the <filename>hello.cpp</filename> source file and have the cursor +positioned on the first Hello occurrence there. Now you wonder, where this one +word <quote>Hello</quote> was used in the project source and how many +occurrences there are. This is a typical case where to use &kdevelop;'s +global search facilities.</para> + +<para>Now, still keeping the cursor somewhere on this <quote>Hello</quote> in +the source text, click the right mouse button. The now well known context menu +will pop up, where you should select the <guilabel>Grep: Hello</guilabel> +line.</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="editor-find-menu.png" format="PNG"/> +</imageobject> +<caption><para>Initiating a global search from within an editor +window.</para></caption> +</mediaobject> +</screenshot> + +<para>This will pop up the following <guilabel>Find in Files</guilabel> dialog +(exactly the same as if you did use the <menuchoice><guimenu>Edit</guimenu> +<guimenuitem>Find in Files...</guimenuitem></menuchoice> menu).</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="find-in-files.png" format="PNG"/> +</imageobject> +<caption><para>A versatile graphical front end to perform global searches in the +project.</para></caption> +</mediaobject> +</screenshot> + +<para>As you see, this is a very versatile tool to initiate +<application>find</application>-and-<application>grep</application> searches +throughout your project. We won't delve further into details here, but you +may want to experiment with this facility on your own. For the moment, there +should be our <quote>Hello</quote> be preselected in the +<guilabel>Pattern</guilabel> field. If it is not, just type it in, then press +the <guibutton>Search</guibutton> button at the bottom right.</para> + +<para>Now the <guilabel>Find in Files</guilabel> tool view will open at the +bottom, showing you file names and lines of all literal occurrences of +<quote>Hello</quote> in our example project. As usual, if you click an entry, +&kdevelop; will get you to exactly that position in an editor window in the +workspace area.</para> + +<para>There are two lines of special interest in the tool view window.</para> +<itemizedlist> +<listitem> +<para>Right on top you will find the command sequences &kdevelop; did actually +use to perform the search. This will be useful to more precisely control the +search outcome.</para> +</listitem> + +<listitem> +<para>On bottom the number of occurrences found in these search run will be +listed. In our example this should read <quote>*** 11 matches found +***</quote>.</para> +</listitem> +</itemizedlist> + +<para>&kdevelop; will remember these search results throughout the currently +running session. If you initiate another global search, its results will display +in another tabbed window in the <guilabel>Find in Files</guilabel> tool view +window.</para> +</listitem> +</itemizedlist> +</sect3> +</sect2> + +<sect2 id="gettingstarted-edit-arrange"> +<title>Arranging Editor Windows</title> + +<para>When your work with large complex projects you will often end up with +quite a lot of tabbed editor windows residing on the tab bar. This makes +specific facilities to clean up, order, and group all those editor tabs +necessary. &kdevelop; provides several means for this. We will have a short look +at some of them.</para> +<simplelist> +<member><link linkend="gettingstarted-edit-arrange-clean">How to remove unneeded +tabs.</link></member> +<member><link linkend="gettingstarted-edit-arrange-tabs">How to rearrange the +tabs.</link></member> +<member><link linkend="gettingstarted-edit-arrange-split">How to view several +files simultaneously in the workspace area.</link></member> +<member><link +linkend="gettingstarted-edit-arrange-sourceheader">How to edit +C++ source and header files simultaneously</link></member> +<member><link linkend="gettingstarted-edit-arrange-group">How to group source +files into development sessions.</link></member> +</simplelist> + +<sect3 id="gettingstarted-edit-arrange-clean"> +<title>Cleaning up the Tabs Row</title> + +<para>If the vast amount of editor window tabs becomes badly arranged at all, +you usually may want to close all those tabs you really do not need any more. +&kdevelop; provides several facilities to do so, the usual way of bulk closing +open editor windows and a more specific approach where you can expressly command +which ones to close and which to keep open.</para> + +<formalpara> +<title>Closing Several Tabs At Once</title> +<para>This is kind of a bulk approach to close unnecessarily open tabs which you +may find in other &kde; applications as well. You can use the +<guimenu>Window</guimenu> menu or right click on a tab to either</para> +</formalpara> +<itemizedlist> +<listitem> +<para>close the currently selected editor window,</para> +</listitem> +<listitem> +<para>close all other open editor windows, or</para> +</listitem> +<listitem> +<para>close all editor windows at once (available from the +<guimenu>Window</guimenu> menu only).</para> +</listitem> +</itemizedlist> + +<formalpara> +<title>Closing Selected Sets of Tabs</title> +<para>The step-by-step approach of closing individual editor window tabs can +become awkward if there are a great number of tabs from which you want to still +keep several open. Instead of searching and closing one editor window tab after +another &kdevelop; provides a means to select the candidates from a list and +close those, and only those, with one single mouse click.</para> +</formalpara> + +<para>Let us illustrate this on a simple example. +In our Hello example project let us assume there were several files open for +edit: <filename>hello.cpp</filename>, <filename>hello.h</filename>, +<filename>helloui.rc</filename>, <filename>hello.desktop</filename>, and +<filename>main.cpp</filename>. Now you want to close all of them except +<filename>hello.cpp</filename> and <filename>hello.h</filename>. The easiest way +to do so is with the <guilabel>File List</guilabel> tool view. Because this list +of open files is alphabetically ordered you can more easily find the ones you +want to be closed. Proceed as follows:</para> + +<procedure> +<step> +<para>Open <guilabel>File List</guilabel> and, with the <keycap>Ctrl</keycap> +key held down, click the files you want to be closed in the list.</para> +</step> +<step> +<para>Then, keeping the mouse pointer on a file name in the list, click the +right mouse button.</para> +</step> +<step> +<para>From the <guimenu>File List</guimenu> popup menu select <guimenuitem>Close +Selected</guimenuitem>.</para> +</step> +</procedure> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="file-list-close-selected.png" format="PNG"/> +</imageobject> +<caption><para>How to close selected editor windows in one +step.</para></caption> +</mediaobject> +</screenshot> +<para>That was all. +&kdevelop; will have closed all editor windows at your wish, and you are ready +to proceed with a clean tab bar again.</para> +</sect3> + +<sect3 id="gettingstarted-edit-arrange-tabs"> +<title>How to Rearrange Edit Window Tabs</title> + +<para>Even if you have only the really necessary editor windows open you may +still want to have their tabs arranged in some logical way. &kdevelop; provides +some common means to do so, in short:</para> + +<formalpara> +<title>Basic Setup — Where to Position New Tabs</title> + +<para>By default, when you open a new editor window, its tab will be inserted to +the right of the editor window tab currently in use. This can be changed so that +the new tab will open to the far right on the tab bar.</para> +</formalpara> +<para>You must change a basic user interface setting in &kdevelop; to enable +this behavior.</para> +<procedure> +<step> +<para>Select <menuchoice><guimenu>Settings</guimenu> <guimenuitem>Configure +KDevelop...</guimenuitem></menuchoice></para> +</step> +<step> +<para>In the left hand icon bar on the dialog popup click the <guilabel>User +Interface</guilabel> icon. The <guilabel>User Interface</guilabel> dialog page +will be now shown.</para> +</step> +<step> +<para>In the left bottom corner there find the section labeled <guilabel>Tabbed +Browsing</guilabel>. Remove the check mark on the <guilabel>Open new tab after +current tab</guilabel> line.</para> +</step> +<step> +<para>Close &kdevelop; and restart it again. Now the new editor window tabs will +open at the far right end of the current tabs row.</para> +</step> +</procedure> + +<para>Unfortunately, this setting cannot be changed on the fly during a +development session. You must make up your mind which behavior you prefer in the +long run and then stick to it, at least until the next start of +&kdevelop;.</para> + +<formalpara> +<title>How to Rearrange the Tabs</title> +<para>As development tasks do vary over time, the need to rearrange the tabbed +editor windows will more or less often arise. This is easily accomplished in +&kdevelop;.</para> +</formalpara> +<para> +Just click the tab you want to move with the middle mouse button and move the +mouse a short distance. The cursor will change to a crossed-arrow pattern. You +can now drag this tab, holding the middle mouse button down, until it did skip +into the place where you want it to be.</para> +</sect3> + +<sect3 id="gettingstarted-edit-arrange-split"> +<title>Viewing Several Files Simultaneously</title> + +<para>At first sight there is always at most one single editor window open to +work on a source file. Although you may fast switch the tabbed windows, there +are times where you want have several files open at once, ⪚ for reference +purposes or to keep complex tasks under better control. To accomplish this, +&kdevelop; provides a way to split the workspace area into different, +simultaneously visible sections which each can hold their own series of tabbed +windows.</para> + +<para>There are two split commands which you can reach either through the +<guimenu>Window</guimenu> menu or by right clicking either into a tabbed window +or on the window tab itself. We will illustrate this splitting behavior again +with our Hello example project.</para> + +<para>Assume there are two source files open on the tab bar, +<filename>hello.cpp</filename> and <filename>hello.h</filename>. Now, while +working on the <filename>hello.cpp</filename> source, you often need to refer to +the declarations in the <filename>hello.h</filename> headers file, so you want +to keep both files open simultaneously.</para> + +<para>To get this done, right click on the tab of, say, +<filename>hello.h</filename>. The following menu will then pop up.</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="split-workspace.png" format="PNG"/> +</imageobject> +<caption><para>How to split the current workspace area into two +parts.</para></caption> +</mediaobject> +</screenshot> + +<para>Select the <guimenuitem>Split Horizontal</guimenuitem> entry. This will +split the current workspace area in the middle and move the tabbed editor window +holding the <filename>hello.h</filename> file into the lower part.</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="split-windows.png"/> +</imageobject> +<caption><para>The workspace has been split horizontally.</para></caption> +</mediaobject> +</screenshot> + +<para>Note the dotted separator line between both windows. You can grab it with +the mouse and adjust the heights of the editor windows according to your +needs.</para> + +<para>There are a few points to note.</para> +<itemizedlist> +<listitem> +<para>The split workspace areas are fully functional at their own. This means, +new tabbed windows will open in the workspace which contains the currently +active editor window. And you can split any sub-area again to your wish, thus +keeping as much windows open simultaneously as you need.</para> +</listitem> + +<listitem> +<para>Any split will move the currently active editor window into the new +workspace sub-area, either downward or to the right. The other tabbed windows +all remain where they were. You cannot directly move tabbed windows between +split areas, instead you need to explicitly close the window in one workspace +area and reopen it in another to regroup.</para> +</listitem> + +<listitem> +<para>Also, there is no direct way to close a split area again. +It closes automatically, once the last tabbed window in it was closed.</para> +</listitem> +</itemizedlist> +</sect3> + +<sect3 id="gettingstarted-edit-arrange-sourceheader"> +<title>Edit C++ Source and Header Files Simultaneously</title> + +<para>There is a neat application of the above mentioned workspace split +feature built into &kdevelop;. It allows to automatically keep a +<filename>.cpp</filename> source and its accompanying +<filename>.h</filename> header file side by side open in the workspace area. +And, optionally, it allows to work on both files synchronously, such that if +you select a declaration in the header file &kdevelop; will navigate to the +respective definition in the source file and vice versa.</para> + +<para>This feature is however deactivated by default. If you want to use it in +your project you need to activate it.</para> + +<para>Select <menuchoice><guibutton>Project</guibutton> +<guimenuitem>Project Options</guimenuitem></menuchoice>. The +<guilabel>Project Options</guilabel> dialog will pop up. In the left hand icon +bar there select <guiicon>C++ Support</guiicon> and subsequently the +<guilabel>Navigation</guilabel> tab on the dialog page which will display on +the right side.</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="split-source-header.png" format="PNG"/> +</imageobject> +<caption><para>Have C++ source and header files be displayed side by +side.</para></caption> +</mediaobject> +</screenshot> + +<para>Now check the <guilabel>Enable split of Header/Source files</guilabel> +box. This will enable <guilabel>Automatic Synchronize</guilabel> +and <guilabel>Vertical</guilabel> by default. Keep these settings for now and +press <guibutton>OK</guibutton>.</para> + +<para>To illustrate this feature, now close in our example Hello project +both the <filename>hello.cpp</filename> and <filename>hello.h</filename> editor +windows, if necessary. Then select <filename>hello.cpp</filename> again from the +<filename class="directory">src</filename> subdirectory of the project. The +editor window will open as usual. But if you now open the +<filename>hello.h</filename> belonging to it, &kdevelop; will automatically +split the workspace and open this header file editor window just beneath the +<filename>hello.cpp</filename> window.</para> + +<para>There is even more, as we mentioned already. In the +<filename>hello.cpp</filename> editor find ⪚ this constructor definition +line:</para> +<programlisting> +Hello::Hello() +</programlisting> +<para>and put the cursor there. Then look at the <filename>hello.h</filename> +window below and note how &kdevelop; did navigate to the corresponding default +constructor declaration line.</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="split-source-header-navigate.png" format="PNG"/> +</imageobject> +<caption><para>&kdevelop; automatically navigated to the constructor +declaration.</para></caption> +</mediaobject> +</screenshot> + +<para>This works vice versa as well. Whenever you put the cursor somewhere into +a construct in one editor window, &kdevelop; will navigate to the corresponding +construct in the other.</para> +</sect3> + +<sect3 id="gettingstarted-edit-arrange-group"> +<title>Grouping Source Files Into Development Sessions</title> + +<para>When your project grows larger, and the development tasks become more and +more complex and force you to often switch between different, even distinct sets +of files, it is about time to organize your development work into distinct +sessions. The <guilabel>File List</guilabel> tool view of &kdevelop; allows you +do to just this.</para> + +<para>On top of the <guilabel>File List</guilabel> tool view window there is a +tool bar where you can create, save, select, and remove such sessions. Or +alternatively use the <menuchoice><guimenu>View</guimenu> <guimenuitem>View +Sessions</guimenuitem></menuchoice> sub-menu.</para> + +<para>We will illustrate this facility again with our Hello example project. +Assume you want to always open the <filename>hello.cpp</filename>, +<filename>hello.h</filename>, and <filename>main.cpp</filename> files all in one +step, no matter what development task you just did perform in the project. To +accomplish this, you first need to create a new development session named, say, +<quote>sources</quote>.</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="file-list-session-create.png" format="PNG"/> +</imageobject> +<caption><para>Use development sessions to remember groups of +files.</para></caption> +</mediaobject> +</screenshot> + +<para>This is a multiple step approach as follows.</para> +<procedure> +<step> +<para>Create a new session</para> +<substeps> +<step> +<para>Click the <guiicon>New Session</guiicon> icon top left in the +<guilabel>File List</guilabel> tool view window.</para> +</step> +<step> +<para>A dialog will pop up. In the <guilabel>Enter the name of the +session</guilabel> input field give your new session a name, ⪚ +<quote>sources</quote>.</para> +</step> +<step> +<para>Close the dialog with <guibutton>OK</guibutton>. The new session will now +be listed in the drop down box on the toolbar.</para> +</step> +</substeps> +</step> +<step> +<para>This new session will initially be empty. You must populate it with the +files you want to be kept there.</para> +<substeps> +<step> +<para>Open all files you want to be grouped in this development session. In our +example we decided to keep <filename>hello.cpp</filename>, +<filename>hello.h</filename>, and <filename>main.cpp</filename> there as +planned.</para> +</step> +<step> +<para>Once your file list is complete, click the <guiicon>Save Session</guiicon> +icon in the toolbar. Do not skip this step, &kdevelop; will forget the file list +otherwise.</para> +</step> +</substeps> +</step> +</procedure> + +<para>That was it. Whenever you select the <guilabel>sources</guilabel> session +from the <guilabel>Open Session</guilabel> drop down box, &kdevelop; will close +all currently open editor windows and open the remembered ones +(<filename>hello.cpp</filename>, <filename>hello.h</filename>, and +<filename>main.cpp</filename> in our example) instead.</para> + +<para>You can define as many sessions as you wish in the context of your +project. If you want to change the session's contents, just update the +remembered file list with a <guiicon>Save Session</guiicon> click. And if you +want get rid of a session, select it in the drop down box, then click the +<guiicon>Delete Session</guiicon> icon in the toolbar right.</para> + +<para>There is even more. You can force &kdevelop; to open a given session by +default when it loads the project. Just select the session in the drop down box +on the <menuchoice><guimenu>Projects</guimenu> <guimenuitem>Project +Options</guimenuitem> <guimenuitem>File List</guimenuitem></menuchoice> project +options configuration page.</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="file-list-session-default.png" format="PNG"/> +</imageobject> +<caption><para>Let &kdevelop; open a specific session when the project is +loaded.</para></caption> +</mediaobject> +</screenshot> +</sect3> +</sect2> + +<sect2 id="gettingstarted-edit-problems"> +<title>Keeping an Eye on Common Problems</title> + +<para>When you open an editor window containing a source file, &kdevelop; will +parse its contents. This allows the built in <emphasis>problem +reporter</emphasis> to scan the source text for some common errors it knows of. +And it can alert the user of different places which have been marked for special +treatment.</para> + +<para>Let us illustrate this facility with our Hello example project.</para> + +<itemizedlist> +<listitem> +<para>Open an editor window with the <filename>main.cpp</filename> source +file.</para> +</listitem> + +<listitem> +<para>Make sure it still contains the following line somewhere towards the +end:</para> +<programlisting> + /// @todo do something with the command line args here +</programlisting> +<para>This was inserted by the &appwizard; when you created the Hello project in +the <link linkend="gettingstarted-new">Starting a New Project</link> chapter +above.</para> +</listitem> + +<listitem> +<para>Now open the <guilabel>Problems</guilabel> tool view in the bottom tabs +row. If all went right, it will currently report this todo:</para> +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="problem-report-todo.png"/> +</imageobject> +<caption><para>&kdevelop; is alerting a source code line containing a todo +mark.</para></caption> +</mediaobject> +</screenshot> +</listitem> +</itemizedlist> + +<para>The format of the <computeroutput>/// @todo</computeroutput> command is +for special treatment by the <application>Doxygen</application> code documenter, +which we will look at briefly in the <link +linkend="gettingstarted-doc">Documentation</link> section below. It is not +mandatory that you use this format, the more common +<computeroutput>TODO</computeroutput> and <computeroutput>FIXME</computeroutput> +comment marks will be recognized as well.</para> + +<para>If you ⪚ insert the following <computeroutput>TODO</computeroutput> and +<computeroutput>FIXME</computeroutput> comment lines in our +<filename>hello.cpp</filename> example file</para> +<programlisting> +Hello::Hello() + : KMainWindow( 0, "Hello" ) +{ + // set the shell's ui resource file + // TODO check the user interface + setXMLFile("helloui.rc"); + + // FIXME change to a better suited greeting + new QLabel( "Hello World", this, "hello label" ); +} +</programlisting> +<para>you will find them listed in the <guilabel>Problems</guilabel> tool view +as well:</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="problem-report-marks.png" format="PNG"/> +</imageobject> +<caption><para>The problem reporter listing lines which require attention in the +currently edited file.</para></caption> +</mediaobject> +</screenshot> + +<para>Note the other tabs in the <guilabel>Problem</guilabel> reporter tool view +window, especially <guilabel>Fixme</guilabel>, and <guilabel>Todo</guilabel>. If +you open them, you will find all <computeroutput>FIXME</computeroutput> and +<computeroutput>TODO</computeroutput> marked lines, &kdevelop; has found so far +in this session. For example the <computeroutput>TODO</computeroutput> alerts +will currently look thus:</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="problem-report-all-todos.png" format="PNG"/> +</imageobject> +<caption><para>The problem reporter has collected the +<computeroutput>TODO</computeroutput> alerts.</para></caption> +</mediaobject> +</screenshot> + +<para>The <guilabel>Errors</guilabel> tab will however not list every coding +error you make. This is the job of other tools in ⪚ the build process. But +you will find here alerts of some common programming mistakes which would likely +go unnoticed otherwise and probably be catched with difficulties during complex +debugging session.</para> + +<para>You will find the &kdevelop; problem reporter facility a very valuable +tool, so check the <guilabel>Problems</guilabel> tool view regularly in the +development process.</para> +</sect2> +</sect1> + +<sect1 id="gettingstarted-compile"> +<title>How to Compile a Project</title> + +<para>Compiling a project in &kdevelop; requires several setup steps and then +building the application. All these are available through the +<guimenu>Build</guimenu> menu.</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="build-menu.png" format="PNG"/> +</imageobject> +<caption><para>Building a project requires several steps.</para></caption> +</mediaobject> +</screenshot> + +<para>We are interested for now in the upper section only of this menu. The +entries there are sorted in order of their importance. Thus the most often +needed command is on top, the <guimenuitem>Build Project</guimenuitem> entry, +which will cause all of the project be initialized, compiled and linked as +needed. Other entries are there to compile selected project portions or a single +file only, to perform several initialization sequences, or to install the +completed application binaries.</para> + +<para>For now we will concentrate on several facilities which &kdevelop; +provides for project setup, initializing, building, and running an application. +In general, this includes:</para> + +<simplelist> +<member><link linkend="gettingstarted-compile-basic">Looking briefly at the +basic build cycle.</link></member> +<member><link linkend="gettingstarted-compile-setup">Looking at some basic +means to configure a project.</link></member> +</simplelist> + +<sect2 id="gettingstarted-compile-basic"> +<title>The Basic Build Cycle</title> + +<para>Once you created a new project you usually want to check if everything +went right so far. This implies a first build and test run of the application, +which we will do now. In order to initially compile a project there are several +steps to perform, which we will briefly look at.</para> +<simplelist> +<member><link linkend="gettingstarted-compile-basic-init">How to initialize the +project for a first build.</link></member> +<member><link linkend="gettingstarted-compile-basic-config">How to do the +initial configuration.</link></member> +<member><link linkend="gettingstarted-compile-basic-build">How to build the +project.</link></member> +<member><link linkend="gettingstarted-compile-basic-run">How to run the +application from within &kdevelop;.</link></member> +</simplelist> + +<note> +<para>This discussion implies that your project is based on the &GNU; autotools, +which enabled the &automanag; tool in &kdevelop; as our example Hello project +does. If you created another type project, ⪚ for the &Qt; based +<application>QMake</application> project manager, there will be other facilities +available in the menus or perhaps even none of them. You will have to consult +the respective vendor documentation on project management and application +building in these cases.</para> +</note> + +<sect3 id="gettingstarted-compile-basic-init"> +<title>Initialize the Project for the Build</title> + +<para>When the &appwizard; created our Hello example project, it left it in a +sort of raw, <quote>virgin</quote> state. The &GNU; autotools chain dictates +several initialization steps to be performed before the application could be +actually compiled and linked. If you try to build a project in such a raw state, +⪚ by selecting the <menuchoice><guimenu>Build</guimenu> <guimenuitem>Build +Project</guimenuitem></menuchoice> menu or pressing the <keycap>F8</keycap> +function key, you will get the following warning.</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="raw-project-warning.png" format="PNG"/> +</imageobject> +<caption><para>Trying to build a raw automake based project.</para></caption> +</mediaobject> +</screenshot> + +<para>You may press the <guibutton>Run Them</guibutton> button in which case +&kdevelop; will try to automatically run all required setup steps prior to +compiling and linking the application. But we will look at those initial steps +in sequence, so cancel the dialog by pressing <guibutton>Do Not run</guibutton>. +</para> + +<para>As mentioned already, compiling and linking the application is done +through the <guimenu>Build</guimenu> menu. Call it up and select +<guimenuitem>Run automake and friends</guimenuitem>.</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="build-menu-automake.png" format="PNG"/> +</imageobject> +<caption><para>Initiating a basic initialization run.</para></caption> +</mediaobject> +</screenshot> + +<para> +&kdevelop; will now open the <guilabel>Messages</guilabel> tool view window at +the bottom and list a series of messages produced by several make tools. If +everything went right, the final line will read +<quote><computeroutput>*** Success ***</computeroutput></quote>.</para> + +<para>If you scroll back to the top, you will find the command line, &kdevelop; +issued to call up the tools beneath the surface:</para> + +<programlisting> +cd '/home/devel/projects/hello' && \ +WANT_AUTOCONF_2_5="1" WANT_AUTOMAKE_1_6="1" gmake -f Makefile.cvs +</programlisting> + +<para>This basically tells that &kdevelop; first switched to the root directory +of our example project. Then it set up a dedicated environment, advising the +make system of the <application>autoconf</application> and +<application>automake</application> tool revisions used for this initialization. +And finally it instructed the make tool (&GNU; <application>gmake</application> +in this case) to process the <filename>Makefile.cvs</filename> make file.</para> + +<para>This make file was automatically set up when you created the Hello +project. It contains all the commands necessary to properly initialize the +project so the resulting application will run under &kde;. Especially this will +create the <filename>configure</filename> skript file necessary to perform the +next setup step.</para> +</sect3> + +<sect3 id="gettingstarted-compile-basic-config"> +<title>Initial Hello Configuration</title> + +<para>Configuring means to tailor the build process to the hardware and software +peculiarities of your system. This is a basic requirement in build processes +based on the &GNU; autotools scheme as you probably will know.</para> + +<para>You can command a configure sequence once the basic automake +initialization has been successfully finished because only after this +initial run the necessary <filename>configure</filename> files will be +available. This done, select the <menuchoice><guimenu>Build</guimenu> +<guimenuitem>Run Configure</guimenuitem></menuchoice> menu entry to initiate a +configuration sequence.</para> + +<para>&kdevelop; opened the <guilabel>Messages</guilabel> tool view +window again if necessary and listed the messages of the configure run therein. +If all went right, the final messages will be <quote><computeroutput>Good - your +configure finished. Start make now</computeroutput></quote> (which was issued by +configure) followed by the &kdevelop; <quote><computeroutput>*** Success +***</computeroutput></quote> message.</para> + +<para id="gettingstarted-compile-basic-config-cmd">On top of the +<guilabel>Messages</guilabel> window you will again find +the command line, &kdevelop; used to initiate this configuration run:</para> + +<programlisting> +mkdir '/home/devel/projects/hello/debug' && \ +cd '/home/devel/projects/hello/debug' && \ +CXXFLAGS="-O0 -g3" "/home/devel/projects/hello/configure" --enable-debug=full +</programlisting> + +<para>You can tell several interesting details from these commands.</para> + +<informaltable frame="none"> +<tgroup cols="2"><tbody><row> +<entry> +<mediaobject> +<imageobject> +<imagedata fileref="tutorial-debug-tree.png"/> +</imageobject> +</mediaobject> +</entry> +<entry> +<itemizedlist> +<listitem> +<para>First, &kdevelop; uses a dedicated subdirectory in the project directory +tree for the build process. This <filename class="directory">debug</filename> +build directory (shown to the left) mirrors the basic project structure and +contains some set of build related files, such as several +<filename>configure</filename> based files and additionally a +<filename>Makefile</filename> in each subdirectory.</para> +</listitem> +<listitem> +<para>In the <link linkend="gettingstarted-compile-setup">Configuring the +Project</link> +section shortly below we will have a brief look at the motivations why +&kdevelop; uses separate build directories in cases like this one. For the +moment it is enough to know that &kdevelop; created this <filename +class="directory">debug</filename> directory — if necessary — prior +to the configure call and that the <filename>configure</filename> script did +build the sub structure and all the <filename>Makefiles</filename> in +there.</para> +</listitem> +<listitem> +<para>Next, from within the <filename class="directory">debug</filename> build +directory, &kdevelop; called the <filename>configure</filename> script in the +root directory of our project using a dedicated environment, where the +<computeroutput>CXXFLAGS="-O0 -g3"</computeroutput> flags will later signal the +&gcc; compiler that it should not optimize the resulting binaries and include +full debugging information with them.</para> +</listitem> +<listitem> +<para>Finally the <filename>configure</filename> script was called with the +<computeroutput>--enable-debug=full</computeroutput> option which instructs it +to create each <filename>Makefile</filename> so that later compilation and +linking will have all necessary debugging information be built in and +usable.</para> +</listitem> +</itemizedlist> +</entry> +</row></tbody></tgroup> +</informaltable> + +<para>All these settings are configurable on a per project basis. You will learn +more about this in the <link linkend="project-management">Project +Management</link> chapter.</para> +</sect3> + +<sect3 id="gettingstarted-compile-basic-build"> +<title>Build the Project</title> + +<para>Once you got this far you will be ready to actually build, &ie; +compile and link the application. Looking at the <guimenu>Build</guimenu> menu, +there are three such compile options from which to select.</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="build-commands.png" format="PNG"/> +</imageobject> +<caption><para>&kdevelop; commands to build binaries.</para></caption> +</mediaobject> +</screenshot> + +<para>Going from bottom to top, there are:</para> +<itemizedlist> +<listitem> +<para><guimenuitem>Compile File</guimenuitem> — This will compile the +source file in the currently open editor window. Mostly used for quick error +checks.</para> +</listitem> +<listitem> +<para><guimenuitem>Build Active Target</guimenuitem> — This is mainly used +in conjunction with the <link linkend="gettingstarted-extend-automake">Automake +Manager</link> which we will briefly look at below.</para> +</listitem> +<listitem> +<para><guimenuitem>Build Project</guimenuitem> — Now this is what we +currently are interested in. It will iterate over the whole project, compiling +and linking all files as necessary.</para> +</listitem> +</itemizedlist> + +<para>It might be interesting to watch what happens to the +<filename class="directory">Debug</filename> directory created in the former +<filename>configure</filename> run. So best keep it open with all +subdirectories unfolded just as shown above. Then select +<menuchoice><guimenu>Build</guimenu> <guimenuitem>Build +Project</guimenuitem></menuchoice> (or press the <keycap>F8</keycap> key) to +initiate the build sequence. As before, the <guilabel>Messages</guilabel> tool +view window will open at the bottom and list the outcome of this build run. And +additionally some files will appear on the <filename +class="directory">Debug</filename> subtree.</para> + +<para id="gettingstarted-compile-basic-build-cmd">There are not many source +files in our Hello example project, so the <guilabel>Messages</guilabel> window +will contain only a few lines. On top of them again find the command line +&kdevelop; issued to the underlying shell.</para> + +<programlisting> +cd '/home/devel/projects/hello/debug' && \ +WANT_AUTOCONF_2_5="1" WANT_AUTOMAKE_1_6="1" gmake -k +</programlisting> + +<para>Not very surprisingly, &kdevelop; switched to the <filename +class="directory">Debug</filename> subtree root in order to run the +<filename>Makefile</filename> located there. A dedicated sub-environment was +set up again as before in the <link +linkend="gettingstarted-compile-basic-init">Initialization step</link> in which +then the <application>gmake</application> tool was called.</para> + +<para>Note the <computeroutput>-k</computeroutput> option in the +<application>gmake</application> call. It forces the build process to continue +up to its very end, even if errors will occur. This makes sense as &kdevelop; +will list all error messages in the <guilabel>Messages</guilabel> window. If +there are any, use the virtues of an &IDE;: Just click on the error message in +the <guilabel>Messages</guilabel> window and &kdevelop; will take you to +exactly the position where the error occurred in the source file.</para> + +<para>And what did happen inside the <filename +class="directory">Debug</filename> subtree? Not very much. A few files showed up +on the <filename class="directory">doc/en</filename> and <filename +class="directory">src</filename> branches, most notably the +<filename>hello</filename> file in <filename +class="directory">/home/devel/projects/hello/debug/src/</filename>. This, +finally, is the application binary we were looking for. All what is left +to do in our initial project check is to run this +<filename>hello</filename>.</para> +</sect3> + +<sect3 id="gettingstarted-compile-basic-run"> +<title>Run the Application</title> + +<para>There are no extra steps involved to run this new Hello +application. Either select <menuchoice><guimenu>Build</guimenu> +<guimenuitem>Execute Program</guimenuitem></menuchoice> or press +<keycombo><keycap>Shift</keycap> <keycap>F9</keycap></keycombo> or use the +<guibutton>Execute program</guibutton> button on the <guilabel>Build +Toolbar</guilabel> shown below.</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="run-button.png"/> +</imageobject> +<caption><para>Running an application form the <guilabel>Build +Toolbar</guilabel>.</para> +</caption> +</mediaobject> +</screenshot> + +<para>That was all. &kdevelop; will now start the new application in +the dedicated console window which opens as <guilabel>Application</guilabel> +tool view on the bottom. There the command &kdevelop; issued to execute the +program will be shown in the top line:</para> + +<programlisting> +./hello +</programlisting> + +<para>showing that the &IDE; has a notion about where the executable it +shall run resides. This notion can be widely configured. See more about +this in the <link linkend="project-management">Project +Management</link> chapter.</para> + +<para>The <computeroutput>./hello</computeroutput> line will most likely +be followed by a warning message. Ignore this for now. It does not keep +our <application>Hello</application> form running.</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="hello-world-app.png" format="PNG"/> +</imageobject> +<caption> +<para>Our initial <application>Hello</application> application.</para> +</caption> +</mediaobject> +</screenshot> + +<para>Close the <application>Hello</application> application window as +usual. If no errors occurred, &kdevelop; will report this as +<quote><computeroutput>*** Exited normally ***</computeroutput></quote> +in the <guilabel>Application</guilabel> tool view window.</para> +</sect3> +</sect2> + +<sect2 id="gettingstarted-compile-setup"> +<title>Configuring the Project</title> + +<para>In &kdevelop; there are numerous ways how you can manage your project. +This behavior is configurable on a per-project basis and mostly of interest to +the advanced developer. Yet there are a few project specific settings you +should know of right from the beginning. +</para> + +<simplelist> +<member><link linkend="gettingstarted-compile-setup-build">Of what use are build +configurations?</link></member> + +<member><link linkend="gettingstarted-compile-setup-config">Where to the define +the behavior of the <filename>configure</filename> script.</link></member> + +<member><link linkend="gettingstarted-compile-setup-make">Some considerations +how <application>make</application> should run.</link></member> + +<member><link linkend="gettingstarted-compile-setup-run">Where should the +executable be and how should it be called?</link></member> +</simplelist> + +<sect3 id="gettingstarted-compile-setup-build"> +<title>Build Configurations</title> + +<para>When we did a first run of the <filename>configure</filename> script in +the <link linkend="gettingstarted-compile-basic-config">Initial Hello +Configuration</link> section above, we noted that &kdevelop; had set up a +dedicated <filename class="directory">debug</filename> subdirectory for this +purpose. In this section we will briefly consider some consequences of +this feature.</para> + +<para>First of all, &kdevelop; does not necessarily use dedicated build +directories apart from the source. The preparations to automatically use +dedicated build configurations is done through templates the &appwizard; uses +when creating a new project.</para> + +<para>To find out which build configurations currently are available, have a +look at the <menuchoice><guimenu>Project</guimenu> <guisubmenu>Build +Configuration</guisubmenu></menuchoice> menu.</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="build-configurations.png" format="PNG"/> +</imageobject> +<caption><para>There are various build configurations available +for this project.</para></caption> +</mediaobject> +</screenshot> + +<para>In this case, like our Hello example project, there are three different +build configurations available. In other cases, there may — initially +— be only one such build configuration, namely +<guimenuitem>default</guimenuitem>.</para> + +<para>The currently used build configuration has a check mark left to it. In +order to switch to another build configuration simply select its menu +entry.</para> + +<para>Now let us have a brief look at what these build configurations +provide.</para> + +<variablelist id="gettingstarted-compile-setup-build-configs"> +<varlistentry> +<term><guimenuitem>debug</guimenuitem></term> +<listitem> +<para>You should use this as the standard build configuration during the +development process. The build occurs separately from the source directories in +the dedicated <filename class="directory">debug</filename> subdirectory, &ie; +all object, auxiliary, and executable files will be put in the subdirectories +there instead of their counterparts in the project root. The +<filename>configure</filename> script will be given the +<computeroutput>--enable-debug=full</computeroutput> option and the +<computeroutput>CXXFLAGS="-O0 -g3"</computeroutput> will signal the &gcc; +compiler to not optimize the code and to insert extensive debug information +into the resulting binaries.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>optimized</guimenuitem></term> +<listitem> +<para>This is used to build a final C++ application. The build occurs +separately from the source directories in the dedicated <filename +class="directory">optimized</filename> subdirectory. No specific arguments to +the <filename>configure</filename> script will be preset, yet the +<computeroutput>CXXFLAGS="-O2 -g0"</computeroutput> will signal the &gcc; +compiler to optimize the code and to not insert debug information into the +resulting binaries.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>default</guimenuitem></term> +<listitem> +<para>The term <quote>default</quote> denotes the standard setup when you build +an application from the console using ⪚ the &GNU; +<application>configure</application> and +<application>make</application>/<application>gmake</application> command line +oriented build tools. Other than <guimenuitem>debug</guimenuitem> or +<guimenuitem>optimize</guimenuitem> no dedicated build directory will be used. +The application will by default be built in the sources directories instead. +There are no special configuration switches predefined. Building and running the +application will use the default settings of the underlying tools (e.g. &gcc;, +etc.).</para> + +<warning> +<para>Think twice before you decide to use the +<guimenuitem>default</guimenuitem> build environment!</para> + +<para>It cannot be used in parallel to the dedicated +<guimenuitem>debug</guimenuitem> or <guimenuitem>optimized</guimenuitem> ones. +<emphasis>Any build operation using <guimenuitem>default</guimenuitem> will +render both of the other build environments unusable.</emphasis> This is caused +by some peculiarities of the <filename>Makefile</filename> construction process +using the +<application>automake</application>/<application>autoconf</application> +machinery, which cannot be easily overcome.</para> +</warning> +</listitem> +</varlistentry> +</variablelist> + +<para>Now, why does one one want to use different build configurations at all, +when they even appear to be not compatible to each other? The answer is — +it simplifies edit-compile-debug cycles. The extra debug instructions +inserted into the binaries as well as all those subtle structure changes to +the program code made during optimizations will effect the run time behavior of +the resulting application. So in many cases, when the logical structure of some +routine appears to be correct, you may want to test whether it still behaves +correctly under more practical conditions.</para> + +<para>This is where the build configurations of &kdevelop; step in. Because +the built object and executable files in each dedicated build directory and the +build commands are kept separately from each other only source changes need +to be handled when you switch between these build configurations.</para> + +<para>Thus instead of cleaning up and recompile everything from scratch with +alternate options, you need only switch from the +<guimenuitem>debug</guimenuitem> to the <guimenuitem>optimize</guimenuitem> +build configuration, have the source changes compiled in and then retest the +application under these circumstances. If anything inappropriate shows up, +simply switch back to <guimenuitem>debug</guimenuitem> and immediately continue +your work there.</para> + +<para>A final note — many build configuration settings are configurable. +You can even define your own build configurations if your development process +requires some. We will briefly look at these possibilities in the next +section.</para> +</sect3> + +<sect3 id="gettingstarted-compile-setup-config"> +<title>Project Configure Options</title> + +<para>Configuring the application properly is vital in the &GNU; +autotools building chain. This is usually guided by option definitions to the +<filename>configure</filename> script and/or specific flags settings in the +environment prior to running <filename>configure</filename> as ⪚ the +<computeroutput>CXXFLAGS</computeroutput> in our previous discussions.</para> + +<para>You may set most of the configuring options for a given project from +within &kdevelop; &GUI;. Select +<menuchoice><guimenu>Project</guimenu> +<guimenuitem>Project Options</guimenuitem></menuchoice> and then from the +icon bar on the left of the dialog the <guiicon>Configure Options</guiicon> +icon. The <guilabel>Configure Options</guilabel> dialog featuring several tabbed +windows will display on the right handed side.</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="configure-project-configure.png" format="PNG"/> +</imageobject> +<caption><para>Most configure options can be defined here.</para></caption> +</mediaobject> +</screenshot> + +<para>As you see, there are quite a lot of options you can set up in this +dialog. For now we will briefly look at only a few of them with regard to our +Hello example project. For detailed instructions see the <link +linkend="projects-configure">Configuring Projects</link> chapter. If you +want to know more about the meaning of the various flags which can be +set, look up <command>info make</command> from the console (or +<command>info:make</command> from within &konqueror;) and there the +<menuchoice><guimenu>Implicit Rules</guimenu> +<guimenuitem>Implicit Variables</guimenuitem></menuchoice> section.</para> + +<para>There are several tabbed dialog setup windows from which the first +one, <guilabel>General</guilabel>, refers to commonly used settings, +while the others are rather compiler specific. In all cases, however, will the +actual contents of those dialogs be governed by the given build +configuration.</para> + +<para>You select the build configuration whose configuration settings +have to be defined from the <guilabel>Configuration</guilabel> combo box +on top of the <guilabel>Configure Options</guilabel> dialog.</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="configure-project-buildconfig.png" format="PNG"/> +</imageobject> +<caption><para>Select the build configuration whose settings to +define.</para></caption> +</mediaobject> +</screenshot> + +<para>Now select another build configuration from this combo box and note how +the contents of ⪚ the <guilabel>Configure arguments</guilabel> and +<guilabel>Build directory</guilabel> text boxes change according to the +settings we mentioned in the <link +linkend="gettingstarted-compile-setup-build-configs"> build +configurations list</link> above.</para> + +<sect4 id="gettingstarted-compile-setup-config-general"> +<title>General Configuration Settings</title> + +<para>On the <guilabel>General</guilabel> dialog page, these +configuration options can be defined:</para> + +<itemizedlist> +<listitem> +<formalpara> +<title>Configure arguments</title> +<para>These are the options &kdevelop; assigns to the +<filename>configure</filename> script call in the build process. See the +<link linkend="gettingstarted-compile-basic-config-cmd">example</link> in +the <quote>Initial Hello Configuration</quote> section above.</para> +</formalpara> +</listitem> + +<listitem> +<formalpara> +<title>Build directory</title> +<para>This is the subdirectory in the current project root, where &kdevelop; +will put all files created in the build process. Ideally, this should +correspond to the name of the build configuration in use, but you are +free to use any name you like, provided it is different from any other +build configuration directory.</para> +</formalpara> +</listitem> + +<listitem> +<formalpara> +<title>Top source directory</title> +<para>You won't need this one often. It defaults to the project root +directory and needs only be redefined if your project sources are located +in another place.</para> +</formalpara> +</listitem> + +<listitem> +<formalpara> +<title>C/C++ preprocessor flags (CPPFLAGS)</title> +<para>Put specific instructions for the preprocessor here. &kdevelop; will +use this to set up a temporary environment before it calls the actual +build tool. Again, see the <link +linkend="gettingstarted-compile-basic-config-cmd">example</link> in +the <quote>Initial Hello Configuration</quote> section above how this is +done.</para> +</formalpara> +</listitem> + +<listitem> +<formalpara> +<title>Linker flags (LDFLAGS)</title> +<para>This is extra information for the <application>ld</application> linker +tool where it should look for additional libraries. It is used to build the +temporary build environment as well.</para> +</formalpara> +</listitem> + +<listitem> +<formalpara> +<title>Environment Variables</title> +<para>Here you may define additional variables to be set up in the +temporal build environment, &kdevelop; will set up before calling the +respective build tool. Again, you must define these environment variables for +every build configuration where they are to be used.</para> +</formalpara> +</listitem> +</itemizedlist> +</sect4> + +<sect4 id="gettingstarted-compile-setup-config-spec"> +<title>Compiler Specific Settings</title> + +<para>The other tabs on the <guilabel>Configure Options</guilabel> dialog +page are for compiler specific settings. They are similarly structured, +so it suffices to have a brief look at the <guilabel>C++</guilabel> page.</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="configure-project-cpp.png" format="PNG"/> +</imageobject> +<caption><para>Select the compiler and its working environment &kdevelop; shall +use here.</para></caption> +</mediaobject> +</screenshot> + +<para>This is what you can set up from here:</para> + +<itemizedlist> +<listitem> +<formalpara> +<title>C++ compiler</title> +<para>Select the C++ compiler &kdevelop; should regularly use from this +combo box. It however lists only those compilers &kdevelop; really knows +of.</para> +</formalpara> +</listitem> + +<listitem> +<formalpara> +<title>Compiler command (CXX)</title> +<para>Only for experts. This is only needed if the C++ compiler is not standard. +Put the name by which it is called here.</para> +</formalpara> +</listitem> + +<listitem> +<formalpara> +<title>Compiler flags (CXXFLAGS)</title> +<para>Here you can enter any extra option &kdevelop; shall pass (via the +<filename>Makefile</filename>) to the compiler. Some option values will be +preset according to the build configuration selected in the +<guilabel>Configuration</guilabel> combo box.</para> +</formalpara> + +<para>Note, that many common compiler options can be selected from a +dialog which will pop up when you press the <guibutton>...</guibutton> button to +the right of the text box.</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="configure-project-cppoptions.png" format="PNG"/> +</imageobject> +<caption><para>Use this dialog to define the &GNU; C++ compiler +behavior.</para></caption> +</mediaobject> +</screenshot> + +<para>We deliberately selected the <guilabel>Optimization</guilabel> tab +here. Note how the <guilabel>No Optimization</guilabel> option has been +preselected (according to the <computeroutput>-O0</computeroutput> +option preset in the <computeroutput>debug</computeroutput> build +configuration).</para> + +<para>Unfortunately you cannot currently select all options from this +dialog. The <computeroutput>-g3</computeroutput> option ⪚ used by the +<computeroutput>debug</computeroutput> build +configuration would have to be altered manually if ever needed.</para> +</listitem> +</itemizedlist> +</sect4> +</sect3> + +<sect3 id="gettingstarted-compile-setup-make"> +<title>How Make Should Build the Program</title> + +<para>You can as well configure the way &kdevelop; will call the +<application>make</application> tool in the project build. Select +<menuchoice><guimenu>Project</guimenu> +<guimenuitem>Project Options</guimenuitem></menuchoice> and then the +<guiicon>Make Options</guiicon> icon from the left dialog window side. The +<guilabel>Make Options</guilabel> dialog page will then be displayed to +the right.</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="configure-project-make.png" format="PNG"/> +</imageobject> +<caption><para>Define how &kdevelop; will call the +<application>make</application> tool.</para></caption> +</mediaobject> +</screenshot> + +<para>There is not much to do here for now. The only setting of interest in +most cases will be the <guilabel>Abort on first error</guilabel> switch. +You will find it deactivated in most projects. This corresponds to the +<computeroutput>-k</computeroutput> option in the +<application>gmake</application> call we found in the <link +linkend="gettingstarted-compile-basic-build-cmd">initial build</link> of +our example Hello project.</para> + +<para>This makes sense in an &IDE; like &kdevelop; which will protocol any +error message during the build. After the build process you may easily +navigate to any error message in the <guilabel>Messages</guilabel> tool +window. Use <menuchoice><guimenu>View</guimenu> +<guimenuitem>Next Error</guimenuitem></menuchoice> and +<menuchoice><guimenu>View</guimenu> <guimenuitem>Previous +Error</guimenuitem></menuchoice> or respectively the <keycap>F4</keycap> and +<keycombo><keycap>Shift</keycap> <keycap>F4</keycap></keycombo> keys for this. +&kdevelop; will automatically activate the editor window of the source file in +question and put the cursor on the error line.</para> + +<para>If on the other hand you rather want the build be stopped on whenever an +error occurs, check the <guilabel>Abort on first error</guilabel> option +in this dialog. &kdevelop; will then call <application>gmake</application> +without the <computeroutput>-k</computeroutput> option.</para> +</sect3> + +<sect3 id="gettingstarted-compile-setup-run"> +<title>How to Run the Executable</title> + +<para>Once the build is complete, you can easily run the application from within +&kdevelop;. Use either <menuchoice><guimenu>Build</guimenu> +<guimenuitem>Execute Program</guimenuitem></menuchoice>, the +<keycombo><keycap>Shift</keycap> <keycap>F9</keycap></keycombo> keys, or the +<guibutton>Execute program</guibutton> button in the <guilabel>Build +Toolbar</guilabel> of &kdevelop;.</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="run-button.png" format="PNG"/> +</imageobject> +<caption><para>Run the program from here.</para></caption> +</mediaobject> +</screenshot> + +<para>But where is the executable located which should be run? How does +one have &kdevelop; append options to the call? Or, how can I have the +application executed in a terminal by its own to test its console interactive +behavior?</para> + +<para>All this can be solved by configuring some project oriented run options in +&kdevelop;. Select <menuchoice><guimenu>Project</guimenu> +<guimenuitem>Project Options</guimenuitem></menuchoice> and then the +<guiicon>Run Options</guiicon> icon from the icon bar on the left dialog window +side. The <guilabel>Run Options</guilabel> dialog page will display to the +right.</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="configure-project-run.png" format="PNG"/> +</imageobject> +<caption><para>Define where and how your program shall be run.</para></caption> +</mediaobject> +</screenshot> + +<para>Now, there is quite a lot which can be set up from this dialog. +Basically there are four groups of configuration items.</para> + +<itemizedlist> +<listitem> +<formalpara> +<title>Directory</title> +<para>This tells &kdevelop; where it basically shall assume the +executable to be called. There are three possibilities you can select +from.</para> +</formalpara> + +<para>Note however that only root directories are defined here. +&kdevelop; usually looks for the executable in some subdirectory +given in the next configuration group.</para> + +<itemizedlist> +<listitem> +<para>Run from the directory, where the executable was build the last +time. This is the default. You can keep this for now.</para> +</listitem> + +<listitem> +<para>Run from the build directory according to the currently selected +<link linkend="gettingstarted-compile-setup-build">build configuration</link>. +The name of this directory was set up on the <link +linkend="gettingstarted-compile-setup-config-general">General +Configuration</link> dialog page.</para> + +<para>This is the root where &kdevelop; will find the executable. It +changes automatically with the selection you made in +<menuchoice><guimenu>Project</guimenu> +<guisubmenu>Build Configurations</guisubmenu></menuchoice> menu. Try it.</para> + +<para>Other than always running the most recently built executable according to +the setting above, this allows you to switch the program to be executed by +simply selecting another build configuration from the <guimenu>Project</guimenu> +menu.</para> +</listitem> + +<listitem> +<para>Run the executable found in a fixed custom directory. Again +this is the root only from where the actual executable is to be +found.</para> + +<para>Use this if you ⪚ want to run the actually installed program instead of +the version located in the project directories.</para> +</listitem> +</itemizedlist> +</listitem> + +<listitem> +<formalpara> +<title>Program</title> +<para>This tells &kdevelop; the relative position and name of the +program it shall actually call. This is relative to the root directory +defined in the configuration group above. Furthermore you can define any +argument &kdevelop; will pass to the program when it is actually called.</para> +</formalpara> + +<note> +<para>If leave the <guilabel>Main program</guilabel> text box empty, the +<emphasis>active target</emphasis> settings of the &automanag; will be used. +Although this is an expert setting, inadvertently leaving this input +field blank is a common cause of problems. Check this setting if &kdevelop; +appears not to call the executable you wanted.</para> +</note> +</listitem> + +<listitem> +<formalpara> +<title>Environment Variables</title> +<para>&kdevelop; will set up a dedicated shell environment to run the +program in. Define any extra environment variable in this configuration +group.</para> +</formalpara> +</listitem> + +<listitem> +<formalpara> +<title>Miscellaneous</title> +<para>Two more check boxes are located at the bottom of this dialog page.</para> +</formalpara> + +<itemizedlist> +<listitem> +<para><guilabel>Automatically compile before execution</guilabel> comes +in handy most of time. &kdevelop; will check the project for changes and +perform necessary configure and build steps for you any time you command +it to run the program.</para> + +<para>Uncheck this in case you want to run the program version prior to the +last change.</para> +</listitem> + +<listitem> +<para><guilabel>Start in external terminal</guilabel> is interesting if +you want to test the input/output behavior of non-&GUI; programs in a console +terminal. This is unchecked by default, so &kdevelop; does start the program in +a window of its own without console terminal I/O capabilities.</para> +</listitem> +</itemizedlist> +</listitem> +</itemizedlist> +</sect3> +</sect2> +</sect1> + +<sect1 id="gettingstarted-extend"> +<title>How to Extend a Project — the &automanag;</title> + +<para>(- to be written -)</para> + +<sect2 id="gettingstarted-extend-automake"> +<title>A Short Look at the Automake Machinery</title> + +<para>(- to be written -)</para> +</sect2> + +<sect2 id="gettingstarted-extend-pics"> +<title>How to Place Icons in a Separate Directory</title> + +<para>(- to be written -)</para> +</sect2> + +<sect2 id="gettingstarted-extend-class"> +<title>How to Add New Classes</title> + +<para>(- to be written -)</para> + +<caution><para> +Be careful when you select your class file names. It is extremely difficult to +change them later.</para></caution> +</sect2> + +<sect2 id="gettingstarted-extend-subproject"> +<title>What is in a Subproject?</title> + +<para>(- to be written -)</para> + +<sect3 id="gettingstarted-extend-subproject-active"> +<title>Concentrate on Your Work — the Active Target</title> + +<para>(- to be written -)</para> +</sect3> +</sect2> + +<sect2 id="gettingstarted-extend-restructure"> +<title>Some Steps to Restructure a Project</title> + +<para>(- to be written -)</para> +</sect2> +</sect1> + + +<sect1 id="gettingstarted-debug"> +<title>How to Debug</title> + +<para>(- to be written -)</para> +</sect1> + + +<sect1 id="gettingstarted-doc"> +<title>A Note on Your Project Documentation</title> + +<para>The &kde; project uses <ulink +url="http://www.docbook.org/tdg5/en/html/docbook.html">docbook</ulink> for +generating your project handbook (&ie; the user manual). The user manual is +available through your application menubar by choosing +<menuchoice><guimenu>Help</guimenu> +<guimenuitem><replaceable>YourApplication</replaceable> +Handbook</guimenuitem></menuchoice > when your &kde; GUI application is running. +After building your project, the user manual is displayed in &kde; +&khelpcenter;. It should explain to the user how your application works, what +are the main features and how to configure it. It should also explain the +advanced features if any. +</para> +<para>All &kde; based templates in &kdevelop; have a doc subdir which contains +a <filename>index.docbook</filename> template in the en folder to get you +started in writing the user manual. You should edit this +<filename>index.docbook</filename> in &kdevelop; and start changing personal +details such as name, email, &etc;. Look at the comments in this file and try +following these indications to start your application documentation. Rebuild +your project to see the changes in &khelpcenter;.</para> +<note><para>You need to install your project using +<menuchoice><guimenu>Build</guimenu> +<guimenuitem>Install</guimenuitem></menuchoice > or <guimenuitem>Install (as +root user)</guimenuitem> in &kdevelop; to see the user manual in +&khelpcenter;.</para></note> +<para>You can find more about the docbook syntax on <ulink +url="http://l10n.kde.org/docs/markup/index.html">the &kde; documentation +website</ulink>.</para> +</sect1> + +<sect1 id="gettingstarted-keys"> +<title>Last But Not Least, Keyboard Shortcuts</title> + +<para>(- to be written -)</para> +</sect1> + +<sect1 id="gettingstarted-whereto"> +<title>Where to go from here</title> + +<para>(- to be written -)</para> + +<sect2 id="gettingstarted-whereto-faq"> +<title>Frequently Encountered Problems</title> + +<simplelist> +<member>The nutshell chapter</member> +<member>FAQ pages</member> +<member>Forum</member> +<member>Mailing lists</member> +</simplelist> +</sect2> + +<sect2 id="gettingstarted-whereto-projects"> +<title>Working With Projects</title> + +<para>(- to be written -)</para> + +<sect3 id="gettingstarted-whereto-projects-open"> +<title>Using Existing &kdevelop; Projects</title> + +<para>(- to be written -)</para> +</sect3> + +<sect3 id="gettingstarted-whereto-projects-import"> +<title>Importing External Projects</title> + +<para>(- to be written -)</para> +</sect3> +</sect2> +</sect1> + +</chapter> diff --git a/doc/kdevelop/hello-world-app.png b/doc/kdevelop/hello-world-app.png Binary files differnew file mode 100644 index 00000000..6f2ab007 --- /dev/null +++ b/doc/kdevelop/hello-world-app.png diff --git a/doc/kdevelop/importdirectory.png b/doc/kdevelop/importdirectory.png Binary files differnew file mode 100644 index 00000000..3d0372ad --- /dev/null +++ b/doc/kdevelop/importdirectory.png diff --git a/doc/kdevelop/index.docbook b/doc/kdevelop/index.docbook new file mode 100644 index 00000000..993400c0 --- /dev/null +++ b/doc/kdevelop/index.docbook @@ -0,0 +1,372 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ +<!-- <!ENTITY kdevelop "<application>KDevelop</application>"> --> + <!ENTITY kdevelop "KDevelop"> + <!ENTITY kdevrelease "3.3.91"> + + <!-- abbreviations used in the body text --> + <!ENTITY apache "<application>Apache</application>"> + <!ENTITY API "<acronym>API</acronym>"> + <!ENTITY appwizard "Application Wizard"> + <!ENTITY autoconf "<command>autoconf</command>"> + <!ENTITY automake "<command>automake</command>"> + <!ENTITY automanag "Automake Manager"> + <!ENTITY ctags "<command>ctags</command>"> + <!ENTITY CVS "<application>CVS</application>"> + <!ENTITY cvs "CVS"> + <!ENTITY doxygen "<application>Doxygen</application>"> + <!ENTITY doxywizard "<application>doxywizard</application>"> + <!ENTITY egrep "<command>egrep</command>"> + <!ENTITY grep "<command>grep</command>"> + <!ENTITY HTML "<acronym>HTML</acronym>"> + <!ENTITY IDE "<acronym>IDE</acronym>"> + <!ENTITY libtool "<command>libtool</command>"> + <!ENTITY nfwizard "New File Wizard"> + <!ENTITY python "<application>Python</application>"> + <!ENTITY perl "<application>Perl</application>"> + <!ENTITY php "<application>PHP</application>"> + <!ENTITY promanag "Project Manager"> + <!ENTITY qte "<application>Qt/embedded</application>"> + <!ENTITY ssh "<application>ssh</application>"> + + <!-- chapters in separate docbook files --> + <!ENTITY survey-manual SYSTEM "survey-manual.docbook"> + <!ENTITY getting-started SYSTEM "getting-started.docbook"> + <!ENTITY kdevelop-survey SYSTEM "kdevelop-survey.docbook"> + <!ENTITY setup SYSTEM "setup.docbook"> + <!ENTITY applicationwizard SYSTEM "applicationwizard.docbook"> + <!ENTITY editing SYSTEM "editing.docbook"> + <!ENTITY file-browsers SYSTEM "file-browsers.docbook"> + <!ENTITY class-browsers SYSTEM "class-browsers.docbook"> + <!ENTITY documentation SYSTEM "documentation.docbook"> + <!ENTITY project-management SYSTEM "project-management.docbook"> + <!ENTITY adv-build-management SYSTEM "adv-build-management.docbook"> + <!ENTITY debugger SYSTEM "debugger.docbook"> + <!ENTITY cvs-chapter SYSTEM "cvs.docbook"> + <!ENTITY external-progs SYSTEM "external-progs.docbook"> + <!ENTITY scripts SYSTEM "scripts.docbook"> + <!ENTITY credits SYSTEM "credits.docbook"> + <!ENTITY kdevelop-scripting SYSTEM "kdevelop-scripting.docbook"> + + <!-- appendices in separate docbook files --> + <!ENTITY kdevelop-install SYSTEM "kdevelop-install.docbook"> + <!ENTITY nutshell SYSTEM "nutshell.docbook"> + <!ENTITY unixdev SYSTEM "unixdev.docbook"> + <!ENTITY app-menu SYSTEM "app-menu.docbook"> + <!ENTITY app-shortcuts SYSTEM "app-shortcuts.docbook"> + <!ENTITY app-files SYSTEM "app-files.docbook"> + <!ENTITY plugin-tools SYSTEM "plugin-tools.docbook"> + <!ENTITY app-uimodes-examples SYSTEM "app-uimodes-examples.docbook"> + <!ENTITY commands SYSTEM "commands.docbook"> + <!ENTITY app-misc-info SYSTEM "app-misc-info.docbook"> + <!ENTITY app-changelog SYSTEM "app-changelog.docbook"> + <!ENTITY app-bibliography SYSTEM "app-bibliography.docbook"> + + <!-- book related entities --> + <!ENTITY kappname "&kdevelop;"> + <!ENTITY % addindex "INCLUDE"> + <!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<!-- +NOTE: +Entries which require special treatment are marked with comments starting with '###'. They should be visited on a regular basis. +--> + +<book lang="&language;"> + +<bookinfo> + <title>&kdevelop; User Manual</title> + + <date>2006-06-19</date> + <releaseinfo>&kdevrelease;</releaseinfo> + + <authorgroup> + <author> + <firstname>Bernd</firstname> + <surname>Gehrmann</surname> + <affiliation> + <address><email>bernd@kdevelop.org</email></address> + </affiliation> + </author> + + <author> + <firstname>Caleb</firstname> + <surname>Tennis</surname> + <affiliation> + <address><email>caleb@aei-tech.com</email></address> + </affiliation> + </author> + + <author> + <firstname>Bernd</firstname> + <surname>Pol</surname> + <affiliation> + <address><email>bernd.pol@online.de</email></address> + </affiliation> + </author> + + <author> + <firstname>Volker</firstname> + <surname>Paul</surname> + <affiliation> + <address><email>volker.paul@tiscali.de</email></address> + </affiliation> + </author> + </authorgroup> + + <copyright> + <year>2002</year> + <holder>Bernd Gehrmann</holder> + </copyright> + <copyright> + <year>2002</year> + <holder>Caleb Tennis</holder> + </copyright> + <copyright> + <year>2004</year> + <holder>Bernd Pol</holder> + </copyright> + <copyright> + <year>2005</year> + <holder>Volker Paul</holder> + </copyright> + + <!-- TRANS:ROLES_OF_TRANSLATORS --> + + <legalnotice>&FDLNotice;</legalnotice> + + <abstract> + <para>&kdevelop; is an Integrated Development Environment to be used for a wide variety of programming tasks.</para> + </abstract> + + <keywordset> + <keyword>KDE</keyword> + <keyword>KDevelop</keyword> + <keyword>IDE</keyword> + <keyword>development</keyword> + <keyword>programming</keyword> + </keywordset> + +</bookinfo> + +<!-- ====================================================================== --> + +&survey-manual; +&getting-started; <!-- "Getting Started" --> +&kdevelop-survey; <!-- "Overview of &kdevelop; Features" --> +&setup; <!-- "Configuring &kdevelop;" --> +&applicationwizard; <!-- "Getting Started — the &appwizard;" --> +&editing; +&file-browsers; +&class-browsers; +&documentation; +&project-management; +&adv-build-management; +&debugger; +&cvs-chapter; +<!--&kdevelop-scripting;--> <!-- "Scripting &kdevelop;" --> +&credits; + +<!-- ====================================================================== --> +<!-- External Appendices --> + +&kdevelop-install; <!-- "Installing &kdevelop;" --> +&nutshell; +&unixdev; <!-- "Development on &UNIX;" --> +<!-- +&app-menu; +&app-shortcuts; +--> +&app-files; +&plugin-tools; +&app-uimodes-examples; +&commands; +&app-misc-info; +&app-changelog; + +<!-- ====================================================================== --> +<!-- ### Questionable, probably not IDE-specific enough. Check later again. +<chapter id="python"> +<title>Python</title> + +<para>... +</para> + +</chapter> --> <!-- python --> + +<!-- ====================================================================== --> +<!-- ### Questionable, probably not IDE-specific enough. Check later again. +<chapter id="php"> +<title>PHP</title> + +<para>... +</para> +</chapter> --> <!-- php --> + +<!-- ====================================================================== --> + +<!-- Note (bp, 2003-09-04): <bibliography> should remain the last appendix --> +<!-- section because of a (meinproc???) bug which sends the Next selection --> +<!-- in circles back to it. --> +<!-- (LWatts: 2005-04-30) This is probably due to a missing id= somewhere, --> +<!-- so I've added a couple in hopes it goes away. --> + +<appendix id="app-bibliography"> +<title>Bibliography</title> + +<para>(... to be written ...)</para> + +<bibliography id="bibliography"> + +<biblioentry> +<title><ulink url="info://make/Top">GNU Make Manual</ulink></title> +<authorgroup> +<author><firstname>Richard M.</firstname><surname>Stallman</surname></author> +<author><firstname>Roland</firstname><surname>McGrath</surname></author> +</authorgroup> +</biblioentry> + +<biblioentry> +<title><ulink url="info://automake/Top">GNU Automake</ulink></title> +<authorgroup> +<author><firstname>David</firstname><surname>MacKenzie</surname></author> +<author><firstname>Tom</firstname><surname>Tromey</surname></author> +</authorgroup> +</biblioentry> + +<biblioentry> +<title><ulink url="info://autoconf/Top">GNU Autoconf</ulink></title> +<authorgroup> +<author><firstname>David</firstname><surname>MacKenzie</surname></author> +<author><firstname>Ben</firstname><surname>Elliston</surname></author> +</authorgroup> +</biblioentry> + +<biblioentry> +<title><ulink url="info://gcc/Top">Using the GNU Compiler Collection</ulink></title> +<author><firstname>Richard M.</firstname><surname>Stallman</surname></author> +</biblioentry> + +<biblioentry> +<title><ulink url="info://libtool/Top">GNU Libtool</ulink></title> +<authorgroup> +<author><firstname>Gordon</firstname><surname>Matzigkeit</surname></author> +<author><firstname>Alexandre</firstname><surname>Oliva</surname></author> +<author><firstname>Thomas</firstname><surname>Tanner</surname></author> +<author><firstname>Gary V.</firstname><surname>Vaughan</surname></author> +</authorgroup> +</biblioentry> + +<biblioentry> +<title>GNU Autoconf, Automake, and Libtool</title> +<edition>1st edition</edition> +<pubdate>October 2000</pubdate> +<authorgroup> +<author><firstname>Gary V.</firstname><surname>Vaughan</surname></author> +<author><firstname>Ben</firstname><surname>Elliston</surname></author> +<author><firstname>Tom</firstname><surname>Tromey</surname></author> +<author><firstname>Ian Lance</firstname><surname>Taylor</surname></author> +</authorgroup> +<publisher><publishername>New Riders Publishing</publishername></publisher> +<isbn>ISBN 1578701902</isbn> +</biblioentry> + + +<biblioentry> +<title>Advanced Programming in the &UNIX; Environment</title> +<edition>1st edition</edition> +<pubdate>June 1992</pubdate> +<author><firstname>W. Richard</firstname><surname>Stevens</surname></author> +<publisher><publishername>Addison-Wesley Pub Co</publishername></publisher> +<isbn>ISBN 0201563177</isbn> +</biblioentry> + +<biblioentry> +<title>Thinking in C++, Volume 1: Introduction to Standard C++</title> +<edition>2nd Edition</edition> +<pubdate>April 15, 2000</pubdate> +<author><firstname>Bruce</firstname><surname>Eckel</surname></author> +<publisher><publishername>Prentice Hall</publishername></publisher> +<isbn>ISBN 0139798099</isbn> +</biblioentry> + +<biblioentry> +<title>Open Source Development with CVS</title> +<edition>2nd Edition</edition> +<pubdate>October 12, 2001</pubdate> +<authorgroup> +<author><firstname>Karl</firstname><surname>Fogel</surname></author> +<author><firstname>Moshe</firstname><surname>Bar</surname></author> +</authorgroup> +<publisher><publishername>The Coriolis Group</publishername></publisher> +<isbn>ISBN 158880173X</isbn> +</biblioentry> + +<biblioentry> +<title>Programming PHP</title> +<edition>1st edition</edition> +<pubdate>March 2002</pubdate> +<authorgroup> +<author><firstname>Rasmus</firstname><surname>Lerdorf</surname></author> +<author><firstname>Kevin</firstname><surname>Tatroe</surname></author> +</authorgroup> +<publisher><publishername>O'Reilly & Associates</publishername></publisher> +<isbn>ISBN 1565926102</isbn> +</biblioentry> + +<biblioentry> +<title>Programming Python</title> +<edition>2nd Edition</edition> +<pubdate>March 2001</pubdate> +<author><firstname>Mark</firstname><surname>Lutz</surname></author> +<publisher><publishername>O'Reilly & Associates</publishername></publisher> +<isbn>ISBN 0596000855</isbn> +</biblioentry> + +<biblioentry> +<title>Gui Programming With Python : Using the Qt Toolkit</title> +<edition>Bk&Cd-r edition</edition> +<pubdate>January 2002</pubdate> +<author><firstname>Boudewijn</firstname><surname>Rempt</surname></author> +<publisher><publishername>Opendocs Llc</publishername></publisher> +<isbn>ISBN 0970033044</isbn> +</biblioentry> + +<biblioentry> +<title>Programming Perl</title> +<subtitle>The Camel book</subtitle> +<edition>3rd Edition</edition> +<pubdate>July 2000</pubdate> +<authorgroup> +<author><firstname>Larry</firstname><surname>Wall</surname></author> +<author><firstname>Tom</firstname><surname>Christiansen</surname></author> +<author><firstname>Jon</firstname><surname>Orwant</surname></author> +</authorgroup> +<publisher><publishername>O'Reilly & Associates</publishername></publisher> +<isbn>ISBN 0596000278</isbn> +</biblioentry> + +<biblioentry> +<title>Learning Perl</title> +<subtitle>The Lama book</subtitle> +<edition>3rd Edition</edition> +<pubdate>July 15, 2001</pubdate> +<authorgroup> +<author><firstname>Randal L.</firstname><surname>Schwartz</surname></author> +<author><firstname>Tom</firstname><surname>Phoenix</surname></author> +</authorgroup> +<publisher><publishername>O'Reilly & Associates</publishername></publisher> +<isbn>ISBN 0596001320</isbn> +</biblioentry> + +</bibliography> +<!-- --> + +</appendix> <!-- app-bibliography --> + +<!-- ====================================================================== --> + +&documentation.index; + +</book> diff --git a/doc/kdevelop/kdcop_browsing.png b/doc/kdevelop/kdcop_browsing.png Binary files differnew file mode 100644 index 00000000..26dbaaf1 --- /dev/null +++ b/doc/kdevelop/kdcop_browsing.png diff --git a/doc/kdevelop/kdevdesigner.png b/doc/kdevelop/kdevdesigner.png Binary files differnew file mode 100644 index 00000000..4fa74c68 --- /dev/null +++ b/doc/kdevelop/kdevdesigner.png diff --git a/doc/kdevelop/kdevelop-ideal-mode-0.png b/doc/kdevelop/kdevelop-ideal-mode-0.png Binary files differnew file mode 100644 index 00000000..ea2d7c50 --- /dev/null +++ b/doc/kdevelop/kdevelop-ideal-mode-0.png diff --git a/doc/kdevelop/kdevelop-ideal-mode.png b/doc/kdevelop/kdevelop-ideal-mode.png Binary files differnew file mode 100644 index 00000000..00e73804 --- /dev/null +++ b/doc/kdevelop/kdevelop-ideal-mode.png diff --git a/doc/kdevelop/kdevelop-install.docbook b/doc/kdevelop/kdevelop-install.docbook new file mode 100644 index 00000000..1ff5982c --- /dev/null +++ b/doc/kdevelop/kdevelop-install.docbook @@ -0,0 +1,754 @@ +<appendix id="kdevelop-install"> + +<appendixinfo> + <authorgroup> + <author><firstname>Bernd</firstname><surname>Pol</surname></author> + <author><firstname>Anne-Marie</firstname><surname>Mahfouf</surname></author> + <!-- ROLES_OF_TRANSLATORS --> + </authorgroup> +</appendixinfo> + +<title>Installing &kdevelop;</title> + +<indexterm zone="kdevelop-install"> + <primary>installation</primary></indexterm> + +<para> +In this chapter we will discuss the steps necessary to compile and install the &kdevelop; 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. + </para></listitem> + <listitem><para> + <link linkend="requirements">&kdevelop; 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. + </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. + </para></listitem> +</itemizedlist> +</para> + +<sect1 id="kdevelop-install-howto"> +<title>How to Obtain &kdevelop;</title> + +<indexterm zone="kdevelop-install-howto"> + <primary>obtain &kdevelop;</primary></indexterm> +<indexterm zone="kdevelop-install-howto"> + <primary>&kdevelop;</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. +</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>. +</para> + +<sect2 id="howto-svn"> +<title>Get Daily &kdevelop; 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> + +<sect3 id="howto-svn-co"> +<title>Initial svn Checkout</title> + +<indexterm zone="howto-svn-co"> + <primary>checkout</primary></indexterm> +<indexterm zone="howto-svn-co"> + <primary>&kdevelop;</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. +</para> + +<note><para> +We assume you want to put your &kdevelop; copy into the <filename class="directory">kde3src</filename> subdirectory of your home directory (<filename class="directory">~</filename>). +</para></note> + +<informalexample><simplelist> + <member> + # Create the destination directory, if necessary: + </member> + <member> + <prompt>~> </prompt> + <userinput>mkdir kde3src</userinput> + </member> + <member> + <prompt>~> </prompt> + <userinput>cd kde3src</userinput> + </member> + <member> + <prompt>~/kde3src> </prompt> + <userinput>svn co svn://anonsvn.kde.org/home/kde/branches/KDE/3.5/kdevelop</userinput> + </member> + <member> + <prompt>~/kde3src> </prompt> + <userinput>cd kdevelop</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. +</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. +</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. +</para> + +</sect3> <!-- howto-svn-co --> + +<sect3 id="howto-svn-up"> +<title>Keeping Your svn Copy up to Date</title> + +<indexterm zone="howto-svn-up"> + <primary>update</primary></indexterm> +<indexterm zone="howto-svn-up"> + <primary>&kdevelop;</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">kde3src</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>). +</para> + +<informalexample><simplelist> + <member> + <prompt>~> </prompt> + <userinput>cd kde3src</userinput> + </member> + <member> + <prompt>~/kde3src> </prompt> + <userinput>cd kdevelop</userinput> + </member> + <member> + <prompt>~/kde3src> </prompt> + <userinput>svn up</userinput> + </member> +</simplelist></informalexample> + +<note><para> +Keep an eye on the messages svn produces during the update sequence. The exact steps in the compilation sequence depend on this. +</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. +</para> +</sect3> <!-- howto-svn-up --> + +</sect2> <!-- howto-svn --> + +</sect1> <!-- howto --> + +<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> + +<sect1 id="requirements"> +<title>&kdevelop; Requirements</title> + +<indexterm zone="requirements"> + <primary>requirements</primary></indexterm> +<indexterm zone="requirements"> + <primary>&kdevelop;</primary> + <secondary>requirements</secondary></indexterm> +<indexterm zone="requirements"> + <primary>GNU</primary> + <secondary>requirements</secondary></indexterm> + +<para> +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. +</para> + +<itemizedlist> +<title>Required:</title> + <listitem> + <para> + <application>gcc/g++</application> ≥ 2.95.3 (or compatible) + <indexterm> + <primary>gcc</primary> + <secondary>requirements</secondary></indexterm> + <indexterm> + <primary>g++</primary> + <secondary>requirements</secondary></indexterm> + </para> + <para> + Available from <ulink url="gcc.gnu.org">gcc.gnu.org</ulink> + </para> + </listitem> + <listitem> + <para> + <application>&GNU; make</application> (or compatible) + <indexterm> + <primary>make</primary> + <secondary>requirements</secondary></indexterm> + </para> + <para> + Available from <ulink url="www.gnu.org/software/make">www.gnu.org/software/make</ulink> + </para> + </listitem> + <listitem> + <para> + &perl; 5.004 (or higher) + <indexterm> + <primary>Perl</primary> + <secondary>requirements</secondary></indexterm> + </para> + <para> + Available from <ulink url="www.perl.com">www.perl.com</ulink> + </para> + </listitem> + <listitem> + <para> + <application>autoconf</application> ≥ 2.52 (or higher) + <indexterm> + <primary>autoconf</primary> + <secondary>requirements</secondary></indexterm> + </para> + <para> + Available from <ulink url="www.gnu.org/software/autoconf">www.gnu.org/software/autoconf</ulink> + </para> + </listitem> + <listitem> + <para> + <application>automake</application> ≥ 1.6 (or higher) + <indexterm> + <primary>automake</primary> + <secondary>requirements</secondary></indexterm> + </para> + <para> + Available from <ulink url="www.gnu.org/software/automake">www.gnu.org/software/automake</ulink> + </para> + </listitem> + <listitem> + <para> + <application>flex</application> 2.5.4 (or higher) + <indexterm> + <primary>flex</primary> + <secondary>requirements</secondary></indexterm> + </para> + <para> + Available from <ulink url="www.gnu.org/software/flex">www.gnu.org/software/flex</ulink> + </para> + </listitem> + <listitem> + <para> + &Qt; ≥ 3.3.0 (or higher) + <indexterm> + <primary>Qt</primary> + <secondary>requirements</secondary></indexterm> + </para> + <para> + Available from <ulink url="www.trolltech.com/products/qt">www.trolltech.com/products/qt</ulink> + </para> + </listitem> + <listitem> + <para> + <application>KDE</application> ≥ 3.4.0 (or higher) + <indexterm> + <primary>KDE</primary> + <secondary>requirements</secondary></indexterm> + </para> + <para> + Available from <ulink url="www.kde.org">www.kde.org</ulink> + </para> + </listitem> +</itemizedlist> + +<itemizedlist> +<title>Optional:</title> + <listitem><para> + The <emphasis><application>ctags</application></emphasis> source navigation tool, from <ulink url="http://ctags.sourceforge.net">http://ctags.sourceforge.net</ulink>, which enables you fast access to declarations and definitions by a few simple clicks on a name in the editor. + <indexterm><primary>ctags</primary></indexterm> + </para></listitem> + <listitem><para> + <emphasis><application>dot</application></emphasis>, a graphics language compiler, from <ulink url="http://www.graphviz.org">http:/www.graphviz.org</ulink>. This + <!-- ### temporarily disabled until the graphical class browser works again + allows you to navigate in a graphical view of your classes' dependencies. Likewise the <application>dot</application> //--> + tool is needed in conjunction with &doxygen; below if you want to have class relationships graphically displayed (which is highly recommended). + <indexterm><primary>dot</primary></indexterm> + </para></listitem> + <listitem><para> + The <emphasis>&doxygen;</emphasis> documentation tool, from <ulink url="http://www.doxygen.org">http://www.doxygen.org</ulink> if you want to generate concise and powerful API documentation from your projects. + <indexterm><primary>doxygen</primary></indexterm> + </para></listitem> + <listitem><para> + <emphasis><application>valgrind</application></emphasis> from <ulink url="http://developer.kde.org/~sewardj/">http://developer.kde.org/~sewardj/</ulink> helps you to find memory management problems in your applications. + <indexterm><primary>valgrind</primary></indexterm> + </para></listitem> + <listitem><para> + <emphasis><application>svn</application></emphasis> from <ulink url="http://subversion.tigris.org/">http://subversion.tigris.org/</ulink> if you want to use the svn versioning system. + <indexterm> + <primary>svn</primary> + <secondary>requirements</secondary></indexterm> + </para></listitem> + <listitem><para> + Any other compiler and/or tool in case you want to develop for another language/platform than C++/&kde; or use some special facility. + </para></listitem> +</itemizedlist> + +<note> +<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 + <indexterm> + <primary>autoconf</primary> + <secondary>circumvent version need</secondary></indexterm> + <indexterm> + <primary>automake</primary> + <secondary>circumvent version need</secondary></indexterm> + <indexterm> + <primary>version need</primary> + <secondary>circumvent for autoconf/automake</secondary></indexterm> + </para> + <informalexample><simplelist> + <member><prompt>(your-kdevelop-directory)> </prompt> + <userinput>ln -s $KDEDIR/share/apps/kdelibs/admin admin</userinput></member> + </simplelist></informalexample> + <para> + at the console. This causes &kdevelop; 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. + </para> + </listitem> +</orderedlist> +</note> + +</sect1> <!-- requirements --> + +<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> + +<sect1 id="compile-and-install"> +<title>&kdevelop; Compilation and Installation</title> + +<indexterm zone="compile-and-install"> + <primary>&kdevelop;</primary> + <secondary>compilation</secondary></indexterm> +<indexterm zone="compile-and-install"> + <primary>&kdevelop;</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. +</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;. + </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. + </para></listitem> +</itemizedlist> + +<sect2 id="compile-and-install-preliminaries"> +<title>Preliminary Steps</title> + +<indexterm zone="compile-and-install-preliminaries"> + <primary>preliminaries</primary> + <secondary>&kdevelop; installation</secondary></indexterm> +<indexterm zone="compile-and-install-preliminaries"> + <primary>KDEDIR</primary></indexterm> +<indexterm zone="compile-and-install-preliminaries"> + <primary>QTDIR</primary></indexterm> +<indexterm zone="compile-and-install-preliminaries"> + <primary>LD_LIBRARY_PATH</primary></indexterm> +<indexterm zone="compile-and-install-preliminaries"> + <primary>LIBRARY_PATH</primary></indexterm> +<indexterm zone="compile-and-install-preliminaries"> + <primary>PATH</primary></indexterm> + +<para> +Before entering the compile sequence you must make sure all libraries and tools are available to the make system. To accomplish this some environment variables need to be properly set. The actual steps to be performed depend on the console shell you use. +</para> + +<note><para> +To avoid typing in all the statements that set the necessary environment variables every time you want to compile, you should put them into your <filename>.bashrc</filename> or <filename>.cshrc</filename> file. This way the environment variables will be properly set every time you start the shell. +</para></note> + +<sect3 id="compile-and-install-preliminaries-bash"> +<title>Setting the Environment for the bash Shell</title> + +<para> +If you use the bash shell add the following lines: +</para> + +<informalexample><simplelist> + <member><userinput>export KDEDIR=</userinput>(path to your KDE installation)</member> + <member><userinput>export QTDIR=</userinput>(path to your Qt library)</member> + <member><userinput>export LD_LIBRARY_PATH=$QTDIR/lib:$KDEDIR/lib:$LD_LIBRARY_PATH</userinput></member> + <member><userinput>export LIBRARY_PATH=$QTDIR/lib:$KDEDIR/lib:$LIBRARY_PATH</userinput></member> + <member><userinput>export PATH=$QTDIR/bin:$KDEDIR/bin:$PATH</userinput></member> +</simplelist></informalexample> +<para></para> + +</sect3> <!-- compile-and-install-preliminaries-bash --> + +<sect3 id="compile-and-install-preliminaries-tcsh"> +<title>Setting the Environment for the tcsh Shell</title> + +<para> +If you use the tcsh shell add the following lines: +</para> +<para> +<informalexample><simplelist> + <member><userinput>setenv KDEDIR </userinput>(path to your KDE installation)</member> + <member><userinput>setenv QTDIR </userinput>(path to your Qt library)</member> + <member><userinput>setenv LD_LIBRARY_PATH=$QTDIR/lib:$KDEDIR/lib:$LD_LIBRARY_PATH</userinput></member> + <member><userinput>setenv LIBRARY_PATH $QTDIR/lib:$KDEDIR/lib:$LIBRARY_PATH</userinput></member> + <member><userinput>setenv PATH $QTDIR/bin:$KDEDIR/bin:$PATH</userinput></member> +</simplelist></informalexample> +</para> + +</sect3> <!-- compile-and-install-preliminaries-tcs --> + +</sect2> <!-- compile-and-install-preliminaries --> + +<sect2 id="compile-and-install-make"> +<title>Compile &kdevelop;</title> + +<indexterm zone="compile-and-install-make"> + <primary>make</primary> + <secondary>&kdevelop; installation</secondary></indexterm> +<indexterm zone="compile-and-install-make"> + <primary>compiling</primary> + <secondary>&kdevelop;</secondary></indexterm> + +<note><para> +In the following discussion we assume that you have put your &kdevelop; sources in the <filename class="directory">~/kde3src/kdevelop</filename> directory. +</para></note> + +<sect3 id="compile-and-install-make-svn"> +<title>Special svn Compilation Considerations</title> + +<para> +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. +</para> + +<variablelist> +<varlistentry> +<term id="compile-and-install-make-svn-co">After a svn Checkout</term> +<listitem> +<para> +You must <emphasis>initialize the make system</emphasis> after a fresh checkout. The same is true every time you need to start over from scratch. Type: +</para> + +<informalexample><simplelist><member> + <prompt>~/kde3src/kdevelop> </prompt> + <userinput>make -f admin/Makefile.common svn-clean</userinput> +</member></simplelist></informalexample> +<para> +and then <emphasis>all of the following steps</emphasis>. +</para> +<note><para> +You might need access to the svn repository for the clean-up if any corrupted or missing files must be reconstructed. +</para></note> +<important><para> +The <command>svn-clean</command> command will <emphasis>remove every file</emphasis> not in svn from the directory! Make sure to back up any valuable information before you issue this clean-up command. +</para></important> +</listitem> +</varlistentry> + +<varlistentry> +<term id="compile-and-install-make-svn-up">After a svn Update</term> +<listitem> +<para> +The next step depends on the output of the svn update sequence. If you got something like (there may be a U or a P marker in the leftmost column, both denoting the file has been changed): +</para> + +<screen> +U /some_directory_path/Makefile.am +</screen> +<para> +or if you just did a full checkout, you must enter: +</para> +<informalexample><simplelist><member> + <prompt>~/kde3src/kdevelop> </prompt> + <userinput>make -f Makefile.svn</userinput> +</member></simplelist></informalexample> +<para> +before you proceed with <emphasis>all of the following steps</emphasis>. +</para> +</listitem> +</varlistentry> +</variablelist> +</sect3> <!-- compile-and-install-make-svn --> + +<sect3 id="compile-and-install-make-basic"> +<title>Basic <command>make</command> Command Sequence</title> + +<para> +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. +</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. +</para></note> + +<variablelist> +<varlistentry> +<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: +</para> + +<informalexample><simplelist><member> + <prompt>~/kde3src/kdevelop> </prompt> + <userinput>./configure --enable-debug=full --prefix=</userinput>(where-your-kde3-is) +</member></simplelist></informalexample> +</listitem> +</varlistentry> + +<varlistentry> +<term>A Release-Compiled Version</term> +<listitem> +<para>If you only want to use &kdevelop; as-is a (smaller and faster +running) release version suffices. <command>configure</command> defaults to +this.</para> + +<informalexample><simplelist><member> + <prompt>~/kde3src/kdevelop> </prompt> + <userinput>./configure --prefix=</userinput>(where-your-kde3-is) +</member></simplelist></informalexample> + +<note> +<para> +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: +</para> +<informalexample><simplelist> + <member><prompt>~/kde3src/kdevelop> </prompt> + <userinput>./configure --</userinput>(options-as-above) <userinput>\</userinput></member> <member><userinput>--with-kdelibsdoxy-dir=$KDEDIR/share/doc/HTML/en/kdelibs-apidocs</userinput></member> +</simplelist></informalexample> +</note> +</listitem> +</varlistentry> + +<varlistentry> +<term>Make and Install &kdevelop;</term> +<listitem> +<para> +<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>~/kde3src/kdevelop> </prompt> + <userinput>make</userinput> +</member></simplelist></informalexample> +<para> +suffices. If necessary, now gain root user rights using the command +</para> +<informalexample><simplelist><member> + <prompt>~/kde3src/kdevelop> </prompt> + <userinput>su</userinput> +</member></simplelist></informalexample> +<para> +and entering the root password. Then install the application: +</para> +<informalexample><simplelist><member> + <prompt>~/kde3src/kdevelop> </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. +</para> + +<note> + <para> + In fact there usually will have been three &kdevelop;-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> + </itemizedlist> +</note> +</listitem> +</varlistentry> +</variablelist> + + +</sect3> <!-- compile-and-install-make-basic --> +</sect2> <!-- compile-and-install-make --> + + +<sect2 id="compile-and-install-options"> +<title>Some Notes on <command>configure</command> Options</title> + +<sect3 id="compile-and-install-options-dir"> +<title>Non-default Installation Directory</title> + +<indexterm zone="compile-and-install-options-dir"> + <primary>&kdevelop;</primary> + <secondary>installation</secondary> + <tertiary>non-default directory</tertiary></indexterm> +<indexterm zone="compile-and-install-options-dir"> + <primary>non-default directory</primary></indexterm> +<indexterm zone="compile-and-install-options-dir"> + <primary>KDEDIRS</primary></indexterm> +<indexterm zone="compile-and-install-options-dir"> + <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: +</para> +<informalexample><simplelist><member> + <prompt>~/kde3src/kdevelop> </prompt> + <userinput>./configure --prefix=</userinput>(where-your-kde3-is) +</member></simplelist></informalexample> +<para> +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.) +</para> +<para> +Call up a shell and have the following commands executed before you start &kdevelop; at the shell prompt. +</para> + +<note><para> + <emphasis>Take care to use the plural:</emphasis> It is <quote><envar>KDEDIRS</envar></quote>, not just <quote><envar>KDEDIR</envar></quote>) +</para></note> + +<informalexample><simplelist> + <member> + <prompt>~> </prompt> + <userinput>export KDEDIRS=/usr/local/kde:/opt/kde3</userinput> + </member> + <member> + <prompt>~> </prompt> + <userinput>kbuildsycoca</userinput> + </member> + <member> + (Now start &kdevelop;:) + </member> + <member> + <prompt>~> </prompt> + <userinput>kdevelop</userinput> + </member> +</simplelist></informalexample> + +<note><simplelist> + <member>The <envar>KDEDIRS</envar> environment variable must be set to the <emphasis>list of active &kde; directories</emphasis> in your system. We use</member> + <member><filename class="directory">/usr/local/kde</filename>:<filename class="directory">/opt/kde3</filename></member> + <member>as an example only.</member> + <member>The <filename class="directory">/usr/local/kde</filename> directory may for instance contain an incomplete &kde; version you compiled for debug purposes, and the <filename class="directory">/opt/kde3</filename> directory may in addition contain the standard &kde; version from your distribution that is used for everyday work.</member> +</simplelist></note> + +<para> +In a tcsh shell you must set the environment variables using: +</para> +<informalexample><simplelist><member> + <prompt>~> </prompt> + <userinput>setenv KDEDIRS /usr/local/kde:/opt/kde3</userinput> +</member></simplelist></informalexample> +<para> +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. +</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.) +</para> + +<note><para> +The <command>kbuildsycoca</command> command does not run from within the root. You must call it from a non-root user. (But is <emphasis>not a very good idea</emphasis> after all to do software development from within the root!) +</para></note> +</sect3> <!-- compile-and-install-options-dir --> + +<!-- ### put a sect3 with other configuration options here --> + +</sect2> <!-- compile-and-install-options --> + +</sect1> <!-- compile-and-install --> + +<sect1 id="make-api"> +<title>How to Obtain a &kdevelop; API Documentation</title> + +<indexterm zone="make-api"> + <primary>API</primary> + <secondary>&kdevelop;</secondary></indexterm> +<indexterm zone="make-api"> + <primary>&kdevelop;</primary> + <secondary>API</secondary></indexterm> +<indexterm zone="make-api"> + <primary>compiling</primary> + <secondary>&kdevelop;</secondary> + <tertiary>API</tertiary></indexterm> +<indexterm zone="make-api"> + <primary>configure</primary> + <secondary>&kdevelop; 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. +</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: +</para> + +<informalexample><simplelist> + <member> + <prompt>~/kde3src/kdevelop> </prompt> + <userinput>./configure --</userinput>(options-as-usual)<userinput> \</userinput> + </member> + <member> + <userinput>--with-kdelibsdoxy-dir=$KDEDIR/share/doc/HTML/en/kdelibs-apidocs</userinput> + </member> +</simplelist></informalexample> + +<para> +(<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 +</para> +<informalexample><simplelist><member> + <prompt>~/kde3src/kdevelop> </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 +</para> + +<informalexample><simplelist><member> + <prompt>~/kde3src/kdevelop> </prompt> + <userinput>su</userinput> +</member></simplelist></informalexample> + +<para> +and entering the root password. Then install the API files: +</para> + +<informalexample><simplelist><member> + <prompt>~/kde3src/kdevelop> </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. +</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. +</para></note> + +</sect1> <!-- make-api --> + +</appendix> <!-- kdevelop-install --> diff --git a/doc/kdevelop/kdevelop-mdi-mode.png b/doc/kdevelop/kdevelop-mdi-mode.png Binary files differnew file mode 100644 index 00000000..51ed019a --- /dev/null +++ b/doc/kdevelop/kdevelop-mdi-mode.png diff --git a/doc/kdevelop/kdevelop-scripting.docbook b/doc/kdevelop/kdevelop-scripting.docbook new file mode 100644 index 00000000..d9e59bb5 --- /dev/null +++ b/doc/kdevelop/kdevelop-scripting.docbook @@ -0,0 +1,56 @@ +<chapter id="kdevelop-scripting"> + +<chapterinfo> + <authorgroup> + <author><firstname>Ian</firstname><surname>Geiser</surname></author> + <!-- ROLES_OF_TRANSLATORS --> + </authorgroup> +</chapterinfo> + +<title>Using Scripts in KDevelop</title> + +<sect1 id="running-scripts"> +<title>Running Scripts</title> +<para> + 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. +</para> +</sect1> + +<sect1 id="adding-scripts"> +<title>Adding Scripts</title> +<para> + Once you have added KScript support to your host application adding the scripts is just as easy. The scripts are comprised of two parts, a desktop file that contains meta-data about the script and the script itself. This approach was used because of security and simplicity. The desktop file provides meta-information for menus and script type. This keeps the host application from having to inspect for load each script. An example of this file is shown below: +</para> +<para> + The above example demonstrates the main parts that KScript will look for. The first item the "Name" is the name that will appear to the user in the host application and the "Comment" will be usually provided as a tool tip. The "Type" is the most important. This is used to select the proper script engine to run the script. Currently the ones available to KDE are "ShellScript/bash" and "JavaScript/kjs" +The next step is to create the actual script. For the above example the Type of script that is used is "ShellScript/bash". The shellscript script engine provides a few things for the developer. The first element is the DCOP ID of the host application. This is passed to the script as the first argument. This means from anywhere in the script the value of "$1" will return the host's DCOP ID. An example shell script is shown below: +</para> + +<para>This script is quite simple and just executes a command and sets the text of the first document to the output of "ls -l"</para> + +<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> + <mediaobject> + <imageobject><imagedata fileref="kdcop_browsing.png"/></imageobject> + </mediaobject> +</figure> + +<para>The KDCOP tool allows script developers to browse and debug the current interfaces of the host application. KDCOP also provides a neat feature of allowing users to select a method and drag the current code to their text editor. This simplifies use for people who are not savvy to the DCOP methods of the host language. Currently KDCOP supports KJSEmbed, Python, and UNIX Shell method for accessing DCOP.</para> + +<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> + <mediaobject> + <imageobject><imagedata fileref="script_location.png"/></imageobject> + </mediaobject> +</figure> + +<para>The script desktop file, and its associated script should be in the same directory. For script developers it is also recommended that all other script resources such as UI files, or data files should also reside in the script directory. In the above example the script will appear under the Tools->KDE Scripts menu. One important thing for script developers to note is that they should not perform operations that could block for a long time, or go into an eventloop. This is because the current version of the script interface is geared for automated tasks that run until completion. This is being addressed and extended for KDE 4. +</para> + +</sect1> + + +</chapter> diff --git a/doc/kdevelop/kdevelop-survey.docbook b/doc/kdevelop/kdevelop-survey.docbook new file mode 100644 index 00000000..9fe32d2d --- /dev/null +++ b/doc/kdevelop/kdevelop-survey.docbook @@ -0,0 +1,489 @@ +<chapter id="kdevelop-survey"> + +<chapterinfo> + <authorgroup> + <author><firstname>Bernd</firstname><surname>Pol</surname></author> + <!-- ROLES_OF_TRANSLATORS --> + </authorgroup> +</chapterinfo> + +<title>Overview of &kdevelop; Features</title> + +<indexterm zone="kdevelop-survey"> + <primary>&kdevelop;</primary> + <secondary>survey</secondary></indexterm> +<indexterm zone="kdevelop-survey"> + <primary>overall view</primary></indexterm> +<indexterm zone="kdevelop-survey"> + <primary>survey</primary></indexterm> + +<para> +&kdevelop; integrates a lot of tools, scripts, and templates in a common user interface. Basically it consists of + +<itemizedlist> + <listitem><para> + several <link linkend="uimodes-survey">user interface modes</link> from which you can select the look and feel of the workspace, + </para></listitem> + <listitem><para> + an <link linkend="applicationwizard">&appwizard;</link> which aids you in setting up a new project, + </para></listitem> + <listitem><para> + several <link linkend="makesystems">project management systems</link> which aid in building and managing your project, + </para></listitem> + <listitem><para> + some <link linkend="editing">editing tools</link> to easily work on your program texts + </para></listitem> + <listitem><para> + various <link linkend="file-browsers">file browsers</link> providing you different views on your file system, + </para></listitem> + <listitem><para> + 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 + </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. + </para></listitem> + <listitem><para> + a set of other diagnosis, documentation, and optimization helper tools. + </para></listitem> +</itemizedlist> +</para> + +<note> + <para> + In fact there are three &kdevelop;-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> + </itemizedlist> +</note> + + +<sect1 id="uimodes-survey"> +<title>Available User Interface Modes</title> + +<indexterm zone="uimodes-survey"> + <primary>&kdevelop;</primary> + <secondary>user interface modes</secondary></indexterm> +<indexterm zone="uimodes-survey"> + <primary>user interface</primary> + <secondary>&kdevelop; modes</secondary></indexterm> +<indexterm zone="uimodes-survey"> + <primary>UI modes</primary></indexterm> +<indexterm zone="uimodes-survey"> + <primary>Child Frame Windows</primary></indexterm> +<indexterm zone="uimodes-survey"> + <primary>Tabbed Pages</primary></indexterm> +<indexterm zone="uimodes-survey"> + <primary>Toplevel Windows</primary></indexterm> +<indexterm zone="uimodes-survey"> + <primary>IDEAl</primary></indexterm> + +<para> +&kdevelop; offers developers four separate user interface modes (click on the mode name to view an example): +<itemizedlist> + <listitem><para><link linkend="ideal-desc">IDEAl</link></para> + <para> + This is a novel user interface approach optimizing both work space and intuitive handling of the tools. + </para> + <itemizedlist> + <listitem><para> + All tool views are docked in a tabbar fashion around the mainframe area. They are grouped left, bottom, and right according to the services provided. + </para></listitem> + <listitem><para> + Editor and browser views will be stacked in a big sized tabbed window inmidst the mainframe area. + </para></listitem> + </itemizedlist> + </listitem> + + <listitem> + <para><link linkend="mdi-desc">Child Frame Windows</link></para> + <itemizedlist> + <listitem><para>All tool views are initially docked to the mainframe.</para></listitem> + <listitem><para>Editor and browser views will live like toplevel windows within a view area of the mainframe.</para></listitem> + </itemizedlist> + </listitem> + + <listitem> + <para><link linkend="tabbed-desc">Tabbed Pages</link></para> + <itemizedlist> + <listitem><para> + All tool views are initially docked to the mainframe. + </para></listitem> + <listitem><para> + Editor and browser views will be stacked in a tabbed window. + </para></listitem> + </itemizedlist> + </listitem> + + <listitem> + <para><link linkend="toplevel-desc">Toplevel Windows</link></para> + <itemizedlist> + <listitem><para> + All editor, browser, and tool views will be toplevel windows directly on the desktop. + </para></listitem> + <listitem><para> + The main widget only contains the menu, toolbars, and statusbar. + </para></listitem> + </itemizedlist> + </listitem> + +</itemizedlist> +</para> + +<sect2 id="uimodes-switch"> +<title>How to Switch User Interface Modes</title> + +<indexterm zone="uimodes-switch"> + <primary>user interface</primary> + <secondary>switch modes</secondary></indexterm> +<indexterm zone="uimodes-switch"> + <primary>switch UI modes</primary></indexterm> + +<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 settings page shown below. +</para> + +<screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="select-user-interface.png" format="PNG"/> + </imageobject> + <caption><para> + Select a user interface mode + </para></caption> + </mediaobject> +</screenshot> + +<para> +(Older &kdevelop; versions provide the top mode selection section only.) +</para> + +<para> +In the <guilabel>Major User-Interface Mode</guilabel> section select the radio button of the user interface mode you want to work in. +</para> +<para> +Dependent on the user interface mode you selected, other configuration sections will become available where you can taylor more details of the look and feel to your preferences. See the <link linkend="setup-ui">Selecting the User Interface</link> chapter for more detail. +</para> + +<note><para> +Do not forget to restart &kdevelop; in order to let your selections take effect. +</para></note> + +</sect2> <!-- uimodes-switch --> + +<sect2 id="maximize-workspace"> +<title>How to Maximize the Work Space Area</title> + +<indexterm zone="maximize-workspace"> + <primary>&kdevelop;</primary> + <secondary>work space</secondary></indexterm> +<indexterm zone="maximize-workspace"> + <primary>&kdevelop;</primary> + <secondary>maximize work space</secondary></indexterm> +<indexterm zone="maximize-workspace"> + <primary>user interface</primary> + <secondary>work space</secondary></indexterm> +<indexterm zone="maximize-workspace"> + <primary>user interface</primary> + <secondary>menubar</secondary></indexterm> +<indexterm zone="maximize-workspace"> + <primary>user interface</primary> + <secondary>full screen mode</secondary></indexterm> +<indexterm zone="maximize-workspace"> + <primary>full screen mode</primary></indexterm> +<indexterm zone="maximize-workspace"> + <primary>menubar</primary> + <secondary>hide/unhide</secondary></indexterm> +<indexterm zone="maximize-workspace"> + <primary>hide menubar</primary></indexterm> +<indexterm zone="maximize-workspace"> + <primary>unhide menubar</primary></indexterm> + +<para> +To maximize space, there is a full-screen window mode available which expands the mainframe area to the screen borders. Additional space can be reclaimed by hiding the menubar. And you can of course hide any toolbar as usual in <application>KDE</application> applications. +</para> + +<variablelist> +<varlistentry> +<term>Full Screen Mode</term> +<listitem> +<para> +To switch to or from full screen mode select <menuchoice> +<guimenu>View</guimenu> <guimenuitem>Full-Screen Mode</guimenuitem> +</menuchoice> from the menus or press +<keycombo>&Ctrl;&Shift;<keycap>F</keycap> </keycombo>. There is also a +<guiicon>Full-Screen Mode</guiicon> icon in the <guilabel>Browse +Toolbar</guilabel> available.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Hide/Unhide the Menubar</term> +<listitem> +<para> +To <emphasis>hide</emphasis> the menubar select <menuchoice> <guimenu>Settings</guimenu> <guimenuitem>Show Menubar</guimenuitem> </menuchoice> from the menus or press <keycombo>&Ctrl;<keycap>M</keycap> </keycombo>. You may also include a <guiicon>Show Menubar</guiicon> icon in a suiting toolbar, ⪚ the <guilabel>Browse Toolbar</guilabel> for that purpose. To <emphasis>unhide</emphasis> the menubar you must press <keycombo> &Ctrl;<keycap>M</keycap> </keycombo> or use the <guiicon>Show Menubar</guiicon> icon if available. +</para> +</listitem> +</varlistentry> +</variablelist> + +</sect2> <!-- maximize-workspace --> + +</sect1> <!-- uimodes-survey --> + +<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> + +<sect1 id="ui-elements"> +<title>Elements of the User Interface</title> + +<para> +(... to be written ...) +</para> + +<sect2 id="ui-elements-workarea"> +<title>The Workarea</title> + +<para> +(... to be written ...) +</para> +</sect2> <!-- ui-elements-workarea --> + +<sect2 id="ui-elements-titlebar"> +<title>The &kdevelop; Titlebar</title> + +<para> +(... to be written ...) +</para> +</sect2> <!-- ui-elements-titlebar --> + +<sect2 id="ui-elements-statusbar"> +<title>The &kdevelop; Statusbar</title> + +<para> +(... to be written ...) +</para> +</sect2> <!-- ui-elements-statusbar --> + +<sect2 id="ui-elements-menubar"> +<title>The menubar</title> + +<para> +(... to be written ...) +</para> +</sect2> <!-- ui-elements-menubar --> + +<sect2 id="ui-elements-toolbars"> +<title>The Toolbars</title> + +<para> +(... to be written ...) +</para> +</sect2> <!-- ui-elements-toolbars --> + +<sect2 id="ui-elements-treetoolviews"> +<title>The Tree Tool Views</title> + +<para> +(... to be written ...) +</para> +</sect2> <!-- ui-elements-treetoolviews --> + +<sect2 id="ui-elements-outputtoolviews"> +<title>The Output Tool Views</title> + +<para> +(... to be written ...) +</para> +</sect2> <!-- ui-elements-outputtoolviews --> + +</sect1> <!-- ui-elements --> + +<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> + +<sect1 id="makesystems"> +<title>Project Management Systems</title> + +<indexterm zone="makesystems"> + <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. + +<itemizedlist> + <listitem><para> + <link linkend="automake-project">Automake projects</link> use the &GNU; standard development tools. + </para></listitem> + <listitem><para> + <link linkend="qmake-project">QMake projects</link> use the trolltech QMake project manager. + </para></listitem> + <listitem><para> + <link linkend="ant-project">ANT projects</link> use the Apache ANT project manager for &Java; development. + </para></listitem> + <listitem><para> + <link linkend="custom-project">Custom projects</link> require you to maintain your own <filename>Makefiles</filename>. + </para></listitem> +</itemizedlist> +</para> + +<sect2 id="automake-project"> +<title>Automake Projects</title> + +<indexterm zone="automake-project"> + <primary>projects</primary> + <secondary>automake</secondary></indexterm> +<indexterm zone="automake-project"> + <primary>automake</primary> + <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 +<itemizedlist> + <listitem><para> + a better way of <filename>Makefile</filename> generation and + </para></listitem> + <listitem><para> + a good and safe way for fast adaption towards different systems by autoconf-generated <filename>configure</filename> scripts. + </para></listitem> +</itemizedlist> +</para> +</sect2> <!-- automake-project --> + +<sect2 id="qmake-project"> +<title>QMake Projects</title> + +<indexterm zone="qmake-project"> + <primary>projects</primary> + <secondary>qmake</secondary></indexterm> +<indexterm zone="qmake-project"> + <primary>qmake</primary> + <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;. +</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. +</para> +</sect2> <!-- qmake-project --> + +<sect2 id="cmake-project"> +<title>CMake Projects</title> + +<indexterm zone="cmake-project"> + <primary>projects</primary> + <secondary>cmake</secondary></indexterm> +<indexterm zone="cmake-project"> + <primary>cmake</primary> + <secondary>projects</secondary></indexterm> + +<para> +CMake will be the &kde; build system for &kde; 4 and &kdevelop; 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 +<menuchoice><guimenu>Project</guimenu> +<guimenuitem>New Project...</guimenuitem> +<guimenuitem>C or C++</guimenuitem> +<guimenuitem>CMake based projects</guimenuitem> +<guimenuitem>A shared library template or Hello world program</guimenuitem> +</menuchoice>. +</para> +</sect2> <!-- cmake-project --> + +<sect2 id="ant-project"> +<title>ANT Projects (&Java; Projects)</title> + +<indexterm zone="ant-project"> + <primary>projects</primary> + <secondary>ant</secondary></indexterm> +<indexterm zone="ant-project"> + <primary>ant</primary> + <secondary>projects</secondary></indexterm> +<indexterm zone="ant-project"> + <primary>projects</primary> + <secondary>Java</secondary></indexterm> +<indexterm zone="ant-project"> + <primary>Java</primary> + <secondary>projects</secondary></indexterm> +<indexterm zone="ant-project"> + <primary>development</primary> + <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> +<guimenuitem>New Project...</guimenuitem> +<guimenuitem>Java</guimenuitem> +<guimenuitem>Ant Project</guimenuitem> +<guimenuitem>Application</guimenuitem></menuchoice>. +</para> +<para> +For more information see <ulink url="http://ant.apache.org/">The Apache Ant Project</ulink> home page. +</para> +</sect2> <!-- ant-project --> + +<sect2 id="custom-project"> +<title>Custom Projects</title> + +<indexterm zone="custom-project"> + <primary>projects</primary> + <secondary>custom</secondary></indexterm> +<indexterm zone="custom-project"> + <primary>custom projects</primary></indexterm> +<indexterm zone="custom-project"> + <primary>Makefile</primary> + <secondary>custom projects</secondary></indexterm> + +<para> +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. +</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. +</para> +</sect2> <!-- custom-project --> + +<sect2 id="makesystems-distribution"> +<title>How to Distribute Your Application</title> + +<indexterm zone="makesystems-distribution"> + <primary>distribution</primary></indexterm> +<indexterm zone="makesystems-distribution"> + <primary>application</primary> + <secondary>distribution</secondary></indexterm> +<indexterm zone="makesystems-distribution"> + <primary>binary packages</primary></indexterm> + +<para> +The distribution of your applications does not require the end-user to have anything different installed other than +<itemizedlist> + <listitem><para>an appropriate compiler,</para></listitem> + <listitem><para>a linker, and</para></listitem> + <listitem><para>the appropriate development libraries,</para></listitem> +</itemizedlist> +</para> +<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. +</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. +</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. +</para> +<para> +Especially on multi language applications, <emphasis>translators</emphasis> won't actually work with the source code, except in cases that require correction for enabling translation support. +</para> + +</sect2> <!-- makesystems-distribution --> + +</sect1> <!-- makesystems --> + +</chapter> <!-- kdevelop-survey --> diff --git a/doc/kdevelop/kdevelop-tabbed-mode.png b/doc/kdevelop/kdevelop-tabbed-mode.png Binary files differnew file mode 100644 index 00000000..faa7a97f --- /dev/null +++ b/doc/kdevelop/kdevelop-tabbed-mode.png diff --git a/doc/kdevelop/kdevelop-toplevel-mode.png b/doc/kdevelop/kdevelop-toplevel-mode.png Binary files differnew file mode 100644 index 00000000..c2fb812b --- /dev/null +++ b/doc/kdevelop/kdevelop-toplevel-mode.png diff --git a/doc/kdevelop/listplugins.sh b/doc/kdevelop/listplugins.sh new file mode 100755 index 00000000..e21b3a15 --- /dev/null +++ b/doc/kdevelop/listplugins.sh @@ -0,0 +1,43 @@ + +# kdevdir must be set to the KDevelop project directory. +kdevdir=/home/volker/data/prj/kdevelop/kdevelop/ +# The plugins are in the parts/ subdirectory. + +pushd $kdevdir/parts >/dev/null +oldscope=nix +echo "<para>The following plugin list is generated by a small script" +echo "written by Volker Paul. All plugins have a .desktop file" +echo "where information such as name and comments are written." +echo "If in the following these comments are not very useful," +echo "it is because the plugin authors made them this way.</para>" +echo "<para>The plugins are grouped by scope (Core, Global, Project).</para>" + +for defscope in Core Global Project; do + if [ $defscope != $oldscope ]; then + oldscope=$defscope + echo +# echo "<sect1><title>Scope: $defscope</title>" + echo "<para>Scope: $defscope</para>" + echo "<itemizedlist>" + fi + for dir in `ls`; do + if [ ! -d $dir ]; then continue; fi + dfile=$dir/*.desktop + # echo $dfile | wc -w + if [ `echo $dfile | wc -w` -gt 1 ]; then continue; fi + if [ ! -f $dfile ]; then continue; fi + scope=`cat $dfile | grep "X-KDevelop-Scope=" | cut -d= -f2-` + if [ $scope != $defscope ]; then continue; fi + comment=`cat $dfile | grep "Comment=" | cut -d= -f2-` + name=`cat $dfile | egrep "^Name=" | cut -d= -f2- | tr " " _` + genericname=`cat $dfile | grep "GenericName=" | cut -d= -f2-` + echo "<listitem><formalpara id=\"$name\">" + echo "<title>$genericname</title>" + echo "<para>$comment</para></formalpara></listitem>" + done + echo "</itemizedlist>" +# echo "</sect1>" +done +popd >/dev/null +echo "<para>So far the generated plugin list.</para>" +echo diff --git a/doc/kdevelop/loading-progress-bar.png b/doc/kdevelop/loading-progress-bar.png Binary files differnew file mode 100644 index 00000000..f786721d --- /dev/null +++ b/doc/kdevelop/loading-progress-bar.png diff --git a/doc/kdevelop/nutshell.docbook b/doc/kdevelop/nutshell.docbook new file mode 100644 index 00000000..1c5395dd --- /dev/null +++ b/doc/kdevelop/nutshell.docbook @@ -0,0 +1,242 @@ +<appendix id="nutshell"> +<title>In a Nutshell — Tips and Tricks</title> + +<!-- Traditionally, most of this stuff will have been put into a FAQ section. It is more useful, however, to put it at the very start of a manual, as this is the place the (inexperienced) user first looks for. + +I disagree. What is useful for a quick start, should go in "Getting started". +Troubleshooting hints go in the appendix or a FAQ. Volker Paul. + +This chapter is meant to provide short hints and tips together with (mandatory) navigation links. +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;. +</para> +<para> +If you want more information on a topic, just follow the link in the title starting that advice. +</para> +<para> +Information on these topics is availabe: +</para> +<simplelist> + <member><link linkend="nutshellitem-look-and-feel">Look and Feel</link></member> + <member><link linkend="nutshellitem-projects">Projects</link></member> + <member><link linkend="nutshellitem-compilation">Compilation</link></member> + <member><link linkend="nutshellitem-automake">&automanag;</link></member> + <member><link linkend="nutshellitem-compilemake">Compile/Make Problems</link></member> + <member><link linkend="nutshellitem-others">Other Topics</link></member> +</simplelist> + +<variablelist id="nutshellitem-look-and-feel"> +<title>Look and Feel</title> + +<varlistentry> +<term id="nutshell-ideal-tabs"><link linkend="setup-ui-toolview">Force +smaller tool view tabs in IDEAl Mode</link></term> +<listitem> +<para>By default &kdevelop; starts with large text-based tool tip tabs +around the work area. You may change this look to ⪚ save space in the +&kdevelop; configuration dialog (<menuchoice><guimenu>Settings</guimenu> +<guimenuitem>Configure KDevelop...</guimenuitem> <guimenuitem>User +Interface</guimenuitem></menuchoice>).</para> +<para>If you use an older &kdevelop; 3 version, this configuration dialog +may not be available. To change the toolview tabs display manually, place a +<option>MDIStyle</option> entry under the +<option>[UI]</option> tag in your +<filename>$KDEHOME/share/config/kdeveloprc</filename> configuration file as +follows:</para> + +<simplelist> +<member><option>MDIStyle=0</option>: icons only</member> +<member><option>MDIStyle=1</option>: text only (default)</member> +<!--<member><computeroutput>MDIStyle=2</computeroutput>: icons only on smaller tabs (not very useful)</member>--> +<member><option>MDIStyle=3</option>: icons and text</member> +</simplelist> +</listitem> +</varlistentry> + +<varlistentry> <!-- ### remove this entry when the bug is repaired --> +<term id="nutshell-weird-style">Weird colored characters and/or display +style</term> +<listitem> +<para>If you notice random colored letters everywhere (&ie; on tabs, on tool +bars, etc.) and the &kdevelop; window seemingly uses a wrong display style, +this may help:</para> + +<itemizedlist> +<listitem><para>In your +<filename>$<envar>KDEHOME</envar>/share/config/kdeveloprc</filename> +configuration file find the line containing +<quote><computeroutput>Style=Checked</computeroutput></quote> and remove +it. Then restart &kdevelop;. +</para> +</listitem> +</itemizedlist> +<para>(This behaviour does sometimes occur after you left clicked a .ui file +in one of the file navigators and &kdevelop; did load +<application>KUIViewer</application> to show the &GUI; which was produced +from this file.)</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="nutshell-full-screen"><link linkend="maximize-workspace">Full +screen mode</link></term> +<listitem> +<para>Select <menuchoice><guimenu>View</guimenu><guimenuitem>Full-Screen +Mode</guimenuitem></menuchoice> from the menus or press +<keycombo>&Ctrl;&Shift;<keycap>F</keycap></keycombo>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="nutshell-hide-menu"><link linkend="maximize-workspace">Hide/Unhide +the menubar</link></term> +<listitem> +<para>To hide the menubar select +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Show +Menubar</guimenuitem></menuchoice> from the menus or press +<keycombo>&Ctrl;<keycap>M</keycap></keycombo>. To redisplay the menubar only +<keycombo>&Ctrl;<keycap>M</keycap> </keycombo> is available.</para> +</listitem> +</varlistentry> +</variablelist> + +<variablelist> +<title id="nutshellitem-projects">Projects</title> +<varlistentry> +<term><link linkend="new-projects">Create New Project</link></term> +<listitem> +<para><menuchoice><guimenu>Project</guimenu><guimenuitem>New +Project...</guimenuitem></menuchoice> will start the <link +linkend="applicationwizard">&appwizard;</link>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="nutshell-new-custom-project">Create a custom project</term> +<listitem> +<para>There is no direct way to create a custom project (&ie; a project +which does use its own makefiles). Use +<menuchoice><guimenu>Project</guimenu> <guimenuitem>Import Existing +Project</guimenuitem></menuchoice> instead. Remember to set the appropriate +<guilabel>Project Type</guilabel>, labeled by an additional <quote>(Custom +Makefiles)</quote>, in the dialog.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="nutshell-project-options">Use project options early</term> +<listitem> +<para>Whenever you start a new project do not forget to set the +<menuchoice><guimenu>Project</guimenu> <guimenuitem>Project +Options...</guimenuitem></menuchoice> to your needs.</para> +</listitem> +</varlistentry> +</variablelist> + +<variablelist id="nutshellitem-compilation"> +<title>Compilation</title> +<varlistentry> +<term id="nutshell-compilemsg-detail"><link +linkend="setup-main-compile">Missing detail in compilation +messages</link></term> +<listitem> +<para>If during compilations you notice some valuable information is missing +in the <guilabel>Messages Output View</guilabel> window, it may be that the +level of message detail is set too low. &RMB; click in the window and select +another detail level from the context menu.<!-- they are programmers, so --> +<!-- they should know what a context menu is. (Re: But they keep on asking --> +<!-- just about this one all the time!! bp) --> +</para> +</listitem> +</varlistentry> +</variablelist> + +<variablelist id="nutshellitem-automake"> +<title><link linkend="automake-manager">&automanag;</link></title> + +<varlistentry> +<term>Create new files in a project</term> +<listitem> +<para>Select the sub-project in the upper half of the &automanag;, then +&RMB; click in the lower half on the groups title you want to have the files +added and select <guimenuitem>Create New File...</guimenuitem>.</para> +</listitem> +</varlistentry> + +<varlistentry id="nutshell-add-project-file"> +<term>Add existing files to a project</term> +<listitem> +<para>Select the sub-project in the upper half of the &automanag;, then +&RMB; click in the lower half on the groups title you want to have the files +added and select <guimenuitem>Add Existing Files...</guimenuitem>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Remove a file from a project</term> +<listitem> +<para>Select the sub-project in the upper half of the &automanag;, then in +the lower half open the groups list you want to have the file removed from, +&RMB; click on the file in this list and select +<guimenuitem>Remove</guimenuitem>.</para> +</listitem> +</varlistentry> +</variablelist> + +<variablelist id="nutshellitem-compilemake"> +<title>Compile/Make Problems</title> +<varlistentry> +<term id="nutshell-builddirproblems"><link +linkend="defaultbuild-warning">Project does not build again after switching +to/from default target</link></term> +<listitem> +<para>There is a problem with the &automake;/&autoconf; machinery. If +<menuchoice> <guimenu>Project</guimenu> <guimenuitem>Build +Configuration</guimenuitem></menuchoice> provides to select from three build +directories: <guimenuitem>default</guimenuitem>, +<guimenuitem>optimized</guimenuitem>, and <guimenuitem>debug</guimenuitem>, +by all means stick to <emphasis>either</emphasis> the default +<emphasis>or</emphasis> the debug/optimized targets.</para> +<itemizedlist> +<listitem> +<para>Once you configured your project with default it will no longer build +with debug or optimzed.</para> +</listitem> +<listitem> +<para>Once you configured your project with debug or optimzed it will no +longer build with default.</para> +</listitem> +</itemizedlist> +</listitem> +</varlistentry> + +<varlistentry> +<term id="nutshell-autoconf-problem"><quote>Wrong +<command>autoconf</command> version</quote> &etc; Error</term> +<listitem> +<para>There are several error messages concerning too old versions of +<application>autoconf</application> &etc; prohibiting +<command>configure</command> to work properly. Run +<command>autoreconf</command> in the directory tree where the +<filename>configure.in</filename> files in question are. This command will +try to update the information in the &GNU; Build System files. See +<command>man autoreconf</command> for more information.</para> +</listitem> +</varlistentry> +</variablelist> + +<variablelist id="nutshellitem-others"> +<title>Other Topics</title> +<varlistentry> +<term id="nutshell-others-files"><link linkend="app-files">Configuration +Files used by &kdevelop;</link></term> +<listitem> +<para>Usually you should not need to care, but this is very useful to know +in case something went wrong with your setup.</para> +</listitem> +</varlistentry> +</variablelist> + +</appendix> <!-- nutshell --> diff --git a/doc/kdevelop/open-project.png b/doc/kdevelop/open-project.png Binary files differnew file mode 100644 index 00000000..c7b1ee20 --- /dev/null +++ b/doc/kdevelop/open-project.png diff --git a/doc/kdevelop/open-recent-project.png b/doc/kdevelop/open-recent-project.png Binary files differnew file mode 100644 index 00000000..20a1adc6 --- /dev/null +++ b/doc/kdevelop/open-recent-project.png diff --git a/doc/kdevelop/plugin-tools.docbook b/doc/kdevelop/plugin-tools.docbook new file mode 100644 index 00000000..1c07cb7a --- /dev/null +++ b/doc/kdevelop/plugin-tools.docbook @@ -0,0 +1,433 @@ +<appendix id="plugin-tools"> +<title>Plugin Tools</title> + +<indexterm zone="plugin-tools"> + <primary>plugins</primary></indexterm> + +<para> +&kdevelop; contains a large number of little tools that help you to perform +certain task. Most of them are realized as plugins. That means, if you do not +need a plugin, you can disable it.</para> +<para>That also means, if you are looking for a functionality that should be there +and isn't, then maybe it's implemented in a plugin and that plugin is disabled. +For example, in the file menu there is a Quick Open feature, but only if +it's enabled in the Project - Project Options dialog. +</para> + +<para>Technically, plugins are based on the KDevPlugin class defined in +lib/interfaces/kdevplugin.h. The following is taken from a comment from there.</para> + +<para> +KDevPlugin is the base class for all KDevelop plugins. +A plugin is a component which is loaded into KDevelop shell at startup or by request. +A plugin has a scope that can be either: +<itemizedlist> +<listitem><simpara>Core</simpara></listitem> +<listitem><simpara>Global</simpara></listitem> +<listitem><simpara>Project</simpara></listitem> +</itemizedlist> +</para> + +<para>Core plugins are global plugins which offer some important "core" functionality and thus +are not selectable by user in plugin configuration pages.</para> + +<para>Global plugins are plugins which require only shell to be loaded and do not operate on +KDevProject interface and/or do not use project wide information. +For example, the uimode plugin allows a developer to select which user interface they wish to use. +</para> + +<para>Project plugins require a project to be loaded and are usually loaded/unloaded along with the project. +If a plugin operates on project-related information then it is a project plugin. +The Automake Manager, for example, only needs to be active when an Automake based project is currently loaded. +</para> + +<para>As stated above, core plugins cannot be disabled. Global plugins can be +enabled/disabled in <menuchoice><guimenu>Settings</guimenu> +<guimenuitem>Configure KDevelop...</guimenuitem></menuchoice> +under <guibutton>Plugins</guibutton>. +Project plugins can be +enabled/disabled in <menuchoice><guimenu>Project</guimenu> +<guimenuitem>Project Options...</guimenuitem></menuchoice> +under <guibutton>Plugins</guibutton>. +Active plugins can have many effects on KDevelop. +Depending on their function, they may add extra menus, extra menu items, extra tool buttons, etc. +</para> + +<para>Plugins which are disabled do not clutter your menus and are not loaded +into memory. +</para> + + +<para>The following plugin list is generated by a small script +(listplugins.sh) written by Volker Paul. All plugins have a .desktop file +where information such as name and comments are written. +If in the following these comments are not very useful, +it is because the plugin authors made them this way.</para> +<para>The plugins are grouped by scope (Core, Global, Project).</para> + +<para>Scope: Core</para> +<itemizedlist> +<listitem><formalpara id="KDevAppWizard"> +<title>Application Wizard</title> +<para>Application Wizard</para></formalpara></listitem> +<listitem><formalpara id="KDevDiff"> +<title>Difference Viewer</title> +<para>Difference Viewer</para></formalpara></listitem> +<listitem><formalpara id="KDevFileCreate"> +<title>FileCreate</title> +<para>FileCreate</para></formalpara></listitem> +<listitem><formalpara id="KDevFullScreen"> +<title>FullScreen</title> +<para>FullScreen</para></formalpara></listitem> +<listitem><formalpara id="KDevTipOfDay"> +<title>Tip of the Day</title> +<para>Tip of the Day</para></formalpara></listitem> +<listitem><formalpara id="KDevUIChooser"> +<title>User-Interface Selection</title> +<para>Provides a dialog for UI-mode selection.</para></formalpara></listitem> +<listitem><formalpara id="KDevVCSManager"> +<title>VCSManager</title> +<para>Version Control System Manager </para></formalpara></listitem> +</itemizedlist> + +<para>Scope: Global</para> +<itemizedlist> +<listitem><formalpara id="KDevAbbrev"> +<title>Abbreviation Expansion</title> +<para>Provides support for customizable abbreviations - short words which expand into commonly needed code structures.</para></formalpara></listitem> +<listitem><formalpara id="KDevDocumentation"> +<title>Documentation</title> +<para>The Documentation plugin offers browsing and searching in local and online documentation with support for multiple documentation systems.</para></formalpara></listitem> +<listitem><formalpara id="KDevfilelist"> +<title>FileList</title> +<para>Provides a list of all currently open files. (Handy when the tab bar is not quite wide enough.)</para></formalpara></listitem> +<listitem><formalpara id="KDevFileSelector"> +<title>File Selector</title> +<para>Powerful network transparent file browser utility.</para></formalpara></listitem> +<listitem><formalpara> +<title>Shell Filtering and Insertion</title> +<para>Provides a way of manipulating editor text using commandline tools. Appears in the Tools menu.</para></formalpara></listitem> +<listitem><formalpara id="KDevGrepView"> +<title>Grep Frontend</title> +<para>Integrates "find|grep" in KDevelop - allows fast searching of multiple files using patterns or regular expressions.</para></formalpara></listitem> +<listitem><formalpara id="KDevKonsoleView"> +<title>Embedded Konsole</title> +<para>This plugin gives KDevelop an embedded konsole for quick and easy command line access.</para></formalpara></listitem> +<listitem><formalpara id="KDevOpenWith"> +<title>"Open with" Menu Addon</title> +<para>This plugin provides additional "open" alternatives for various context menus in KDevelop.</para></formalpara></listitem> +<listitem><formalpara id="KDevPartExplorer"> +<title>Part Explorer Tool</title> +<para>A Graphical tool for performing KTrader-like queries about registered services</para></formalpara></listitem> +<listitem><formalpara id="KDevRegexpTest"> +<title>Regular Expression Tester</title> +<para>Tool to design and test regular expressions against common regexp syntaxes.</para></formalpara></listitem> +<listitem><formalpara id="KDevReplace"> +<title>Replace Part</title> +<para>This plugin is an interactive projectwide "Search and Replace" tool. Search using string or regexp matching, and select the replacements to be made from a preview before the action is finalized. When loaded it appears in the Edit menu.</para></formalpara></listitem> +<listitem><formalpara id="KDevscripting"> +<title>Scripting</title> +<para>The Scripting plugin offers KScript based scripting of the KDevelop application</para></formalpara></listitem> +<listitem><formalpara id="Code_Snippets"> +<title>Code Snippets</title> +<para>This plugin allows you to store code snippets and add them to your code</para></formalpara></listitem> +<listitem><formalpara id="KDevTextTools"> +<title>Text Structure</title> +<para>Provides a structure overview and navigation for HTML and TEX files</para></formalpara></listitem> +<listitem><formalpara id="KDevTools"> +<title>Tools Menu Addition</title> +<para>This plugin provides an easy way to add external applications to the Tools menu and toolbar.</para></formalpara></listitem> +<listitem><formalpara id="KDevvalgrind"> +<title>Valgrind Frontend</title> +<para>Valgrind is a tool that helps you find memory management problems in programs. http://developer.kde.org/~sewardj/</para></formalpara></listitem> +</itemizedlist> + +<para>Scope: Project</para> +<itemizedlist> +<listitem><formalpara id="KDevannotation"> +<title>annotation Plugin</title> +<para>annotation Description</para></formalpara></listitem> +<listitem><formalpara id="KDevAStyle"> +<title>Source Code Formatter</title> +<para>A plugin for formatting of sourcecode according to a specified set of rules. When loaded it is found in the Tools menu.</para></formalpara></listitem> +<listitem><formalpara id="KDevBookmarks"> +<title>Bookmarks</title> +<para>Plugin that provides navigation and overview of active source bookmarks and persists them between sessions.</para></formalpara></listitem> +<listitem><formalpara id="KDevClassView"> +<title>Class View</title> +<para>This plugin displays a graphical view of all the classes in the project, complete with methods and attributes, and provides a way of direct source navigation.</para></formalpara></listitem> +<listitem><formalpara id="KDevcopyto"> +<title>CopyTo</title> +<para>Simple file uploader plugin. It does a file copy over any KIO supported protocol.</para></formalpara></listitem> +<listitem><formalpara id="KDevCTags2"> +<title>CTags Frontend</title> +<para>CTags is a source navigation tool with support for many languages. When loaded it provides a context menu for finding type declarations/definitions and also a query dialog. http://ctags.sourceforge.net/</para></formalpara></listitem> +<listitem><formalpara id="KDevdistpart"> +<title>Final Packaging Support</title> +<para>Aids in building and publishing the final project. Only RPM package format is supported for now.</para></formalpara></listitem> +<listitem><formalpara id="KDevDoxygen"> +<title>Doxygen Support</title> +<para>The doxygen plugin provides a way to specify and control generation of documentation for a project, based on source code content. You need to have doxygen installed to be able to use this. For more info goto http://www.doxygen.org</para></formalpara></listitem> +<listitem><formalpara id="KDevQuickOpen"> +<title>QuickOpen</title> +<para>Provides an efficient way of finding/opening files, classes and methods in a large project. Appears in the File and Tools menus when loaded.</para></formalpara></listitem> +<listitem><formalpara id="KDevSecurity"> +<title>Security Checker</title> +<para>Code security checker</para></formalpara></listitem> +</itemizedlist> +<para>So far the generated plugin list.</para> + + +<table id="table-project-parts"> +<title>Project Management Plugins in &kdevelop;</title> +<tgroup cols="2"><tbody> +<row> + <entry>antproject</entry> + <entry>ANT Project Manager (&Java; applications)</entry> +</row> +<row> + <entry>autoproject</entry> + <entry>Automake Project Manager</entry> +</row> +<row> + <entry>customproject</entry> + <entry>Custom Project Manager</entry> +</row> +<row> + <entry>trollproject</entry> + <entry>QMake based Project Manager</entry> +</row> +</tbody></tgroup> +</table> +<para>The above plugins are currently (May 2005) empty. Maybe +project management support will be implemented as plugins +in the future.</para> + + +<table> +<title>Language Support Plugins in &kdevelop;</title> +<tgroup cols="2"> +<tbody> +<row><entry>cppsupport</entry><entry>Support for C/C++</entry></row> +<row><entry>fortransupport</entry><entry>Support for Fortran</entry></row> +<row><entry>javasupport</entry><entry>Support for &Java;</entry></row> +<row><entry>perlsupport</entry><entry>Support for Perl</entry></row> +<row><entry>phpsupport</entry><entry>Support for PHP</entry></row> +<row><entry>pythonsupport</entry><entry>Support for Python</entry></row> +</tbody></tgroup> +</table> + + +<para>In the following, some of the plugins will be discussed in detail.</para> + +<itemizedlist> +<listitem> +<formalpara> +<title>The <command>abbrev</command> Plugin</title> +<indexterm zone="plugin-tools"><primary><command>abbrev</command></primary></indexterm> + +<para> +This plugin expands abbreviations into frequently used code snippets. It is +activated by pressing <keycombo><keycap>Ctrl</keycap> +<keycap>Space</keycap></keycombo>. For example, when you enter +<literal>"ife"</literal> into a C++ in the editor and press +<keycombo><keycap>Ctrl</keycap><keycap>Space</keycap></keycombo>, you obtain +an <literal>if-else</literal> code template and save some key strokes. The set +of supported abbreviations depends on the programming language of the edited +file. For example, for PHP you will obviously be interested in other code +templates than for &Java;. +</para> +</formalpara> + +<para> +The set of code templates is configurable. If the plugin is enabled, you can see +which ones are available in the <menuchoice><guimenu>Settings</guimenu> +<guimenuitem>Configure KDevelop...</guimenuitem></menuchoice> +dialog under <guibutton>Abbreviations</guibutton>. +</para> +</listitem> + +<listitem> +<formalpara id="KDevFilter"> +<title>The <command>filter</command> Plugin</title> +<indexterm zone="plugin-tools"><primary><command>filter</command></primary></indexterm> + +<para> +This offers two features. If you select <menuchoice><guimenu>Tools</guimenu> +<guimenuitem>Execute command</guimenuitem></menuchoice>, you can enter a shell +command. The output of this command is inserted into the editor buffer when +you hit the <guibutton>Start</guibutton> button. +</para> +</formalpara> + +<para> +A related feature is available under +<menuchoice><guimenu>Tools</guimenu><guimenuitem>Filter selection through +command...</guimenuitem></menuchoice>. In order to use this, you must +select a text area in the editor. If you now enter a shell command and hit +the <guibutton>Start</guibutton> button, the command is started and the +selection used as the standard input for it. The standard output of the +command is then inserted into the editor, replacing the selection. +</para> + +<para> +For example, if you write documentation, you frequently have to refer +to menu items. To do this correctly for e.g. the Copy command in the +Edit menu, you have to write: +<programlisting><menuchoice><guimenu>Edit</guimenu><guimenuitem>Copy</guimenuitem></menuchoice></programlisting> +This is cumbersome, so you'd rather just write "Edit - Copy" +and let the computer do the tagging. +Here is how you can do it. +You write a little shell script called mef you put e.g. in your home's bin directory: +<programlisting>sed s/"^\(.*\) - \(.*\)\$"/"<menuchoice><guimenu>\1<\/guimenu><guimenuitem>\2<\/guimenuitem><\/menuchoice>"/</programlisting> +Don't forget to make it executable. +That's all. Now, in your documentation .docbook source, you write "Edit - Copy". +You select this text you just wrote, choose +<menuchoice><guimenu>Tools</guimenu><guimenuitem>Filter selection through +command...</guimenuitem></menuchoice> and call ~/bin/mef. +Instantly "Edit - Copy" is replaced by +<programlisting><menuchoice><guimenu>Edit</guimenu><guimenuitem>Copy</guimenuitem></menuchoice></programlisting> +</para> + + +</listitem> + +<listitem> +<formalpara> +<title>The &doxygen; Plugin</title> +<indexterm zone="plugin-tools"><primary>&doxygen;</primary></indexterm> +<indexterm zone="plugin-tools"><primary>documentation tool</primary></indexterm> +<indexterm zone="plugin-tools"><primary>API documentation</primary></indexterm> + +<para> +This one helps you to use the &doxygen; API documentation tool +(<ulink url="http://www.doxygen.org"/>). You can select +<menuchoice><guimenu>Project</guimenu> +<guimenuitem>Run Doxygen</guimenuitem></menuchoice> to generate API +documentation for your current project, based on the configuration given by +the file <filename>Doxyfile</filename> in your project directory. +</para> +</formalpara> + +<para> +Furthermore, you can configure &doxygen; in the +<menuchoice><guimenu>Project</guimenu> +<guimenuitem>Project options...</guimenuitem></menuchoice> dialog. This dialog +is very similar to the &doxywizard; tool. +</para> +</listitem> + +<listitem> +<formalpara> +<title>The &ctags; Plugin</title> +<indexterm zone="plugin-tools"><primary>&ctags;</primary></indexterm> + +<para> +Although the class browser gives you extensive insight into the symbols and +classes of your project, you may also want to use the ctags tool. In particular, +this one supports a lot more language than the class browser. +</para> +</formalpara> + +<para> +You activate this plugin under <menuchoice><guimenu>Tools</guimenu> +<guimenuitem>CTags...</guimenuitem></menuchoice>. When you start it the first +time, you will be asked to generate a search database first. When you accept +this, the &ctags; program will be started and will create a file named +<filename>tags</filename> in your project directory. This is a text file containing +all symbols of your source files. +</para> + +<para> +You can search in the symbol database in two ways: when the +<guilabel>Regular expression match</guilabel> box is checked, the text you +enter will be interpreted as a regular expression (POSIX flavor) and matched +with the existing symbols. For example, the text <literal>.*Widget</literal> +will search for all symbols ending with <literal>Widget</literal>. If the +box is not checked, the search will be verbatim. +</para> + +<para> +When searching, you will get a list of the matched symbols, accompanied with +the line numbers where they are defined. You jump to the respective point by +clicking on the list. +</para> + +<para> +For some languages, &ctags; distinguishes different kinds of symbols. For +example, Python has classes and functions. You can selectively search only +for classes by checking the respecting kinds in the dialog. +</para> + +<para> +The symbol database is normally not updated when your sources change. +Consequently, after a while the line numbers will not be correct anymore +and newly added classes and functions will be missing. Therefore you should +update the <filename>tags</filename> file in regular intervals by pressing +the button <guibutton>Regenerate</guibutton>. +</para> +</listitem> + +<listitem> +<formalpara> +<title>The <command>astyle</command> Plugin</title> +<indexterm zone="plugin-tools"><primary><command>astyle</command></primary></indexterm> +<indexterm zone="plugin-tools"><primary><application>Artistic Style</application></primary></indexterm> +<indexterm zone="plugin-tools"><primary>indentation</primary></indexterm> + +<para> +Astyle is a plugin for formatting of sourcecode according to a specified set of rules. +</para> +</formalpara> +</listitem> + +<listitem> +<formalpara> +<title>The <command>regexptest</command> Plugin</title> +<indexterm zone="plugin-tools"><primary><command>regexptest</command></primary></indexterm> +<indexterm zone="plugin-tools"><primary>debugging</primary><secondary>regular expressions</secondary></indexterm> +<indexterm zone="plugin-tools"><primary>regular expressions</primary><secondary>debugging</secondary></indexterm> + +<para> +Designing with regular expressions can be hard work. Often the first try at an +expression matches too many strings. In particular, when working with a +compiled language, the turnaround times when debugging a regular expression +can be awkward. The regexptest plugin allows you to directly explore the +changes in a regular expression. It is activated by choosing +<menuchoice><guimenu>Tools</guimenu> +<guimenuitem>Debug Regular Expression...</guimenuitem></menuchoice>. +</para> +</formalpara> + +<para> +In the flavor group box, you can choose the flavor of the regular expression +engine used. Currently supported is the flavor defined in the POSIX standard, +which is used by the &grep; program, and the extended POSIX syntax used by the +program &egrep;. +</para> + +<para> +When you enter an expression, you get immediate feedback about any syntax +errors in it. By entering a text under <guilabel>Test string</guilabel>, +you can see whether the expression matches this string. In particular, if +your regular expression includes groups, such as <literal>([a-z])</literal>, +the content of the matched subgroups will be shown in a list box. +</para> +</listitem> + +<!-- +<listitem> +<formalpara> +<title>The <command>konsole</command> Plugin</title> +<indexterm zone="plugin-tools"><primary><command>konsole</command></primary></indexterm> +<indexterm zone="plugin-tools"><primary>terminal</primary><secondary>embedded</secondary></indexterm> +<para></para> +</formalpara> +</listitem> +--> + +</itemizedlist> + +</appendix> <!-- plugin-tools --> + +<!-- ====================================================================== --> diff --git a/doc/kdevelop/problem-report-all-todos.png b/doc/kdevelop/problem-report-all-todos.png Binary files differnew file mode 100644 index 00000000..7b2d1b62 --- /dev/null +++ b/doc/kdevelop/problem-report-all-todos.png diff --git a/doc/kdevelop/problem-report-marks.png b/doc/kdevelop/problem-report-marks.png Binary files differnew file mode 100644 index 00000000..1e01ebdf --- /dev/null +++ b/doc/kdevelop/problem-report-marks.png diff --git a/doc/kdevelop/problem-report-todo.png b/doc/kdevelop/problem-report-todo.png Binary files differnew file mode 100644 index 00000000..56ccbd54 --- /dev/null +++ b/doc/kdevelop/problem-report-todo.png diff --git a/doc/kdevelop/project-advanced.docbook b/doc/kdevelop/project-advanced.docbook new file mode 100644 index 00000000..d597e65e --- /dev/null +++ b/doc/kdevelop/project-advanced.docbook @@ -0,0 +1,83 @@ +<chapter id="projects-advanced"> + +<chapterinfo> + <authorgroup> + <author><firstname>Bernd</firstname><surname>Pol</surname></author> + <!-- ROLES_OF_TRANSLATORS --> + </authorgroup> +</chapterinfo> + +<title>Advanced Project Management</title> + +<sect1 id="oldprojects"> +<title>Loading Projects</title> + +<sect2 id="loading-recent-project"> +<title>Loading a Recently Used Project</title> + +<para> +(... to be written ...) +</para> + +<screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="open-recent-project.png" format="PNG"/> + </imageobject> + <caption><para> + How to open a recent project + </para></caption> + </mediaobject> +</screenshot> + + +</sect2> <!-- loading-recent-project --> + +<sect2 id="loading-project"> +<title>Loading an Existing Project</title> + +<para> +(... to be written ...) +</para> +</sect2> <!-- loading-project --> + +<sect2 id="converting-projects"> +<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>. +</para> + +</sect2> <!-- converting-projects --> + +<sect2 id="importing-projects"> +<title>Importing an Existing Project</title> + +<para> +To import an existing directory in &kdevelop; select <guimenuitem>Import Existing Directory</guimenuitem> +from the <guimenu>Project</guimenu> menu. You should see the Import Directory Wizard, as seen below: +</para> + +<figure id="screenshot-importdirectory" float="1"> +<title>The Import Directory Dialog</title> +<mediaobject> +<imageobject><imagedata fileref="importdirectory.png"/></imageobject> +</mediaobject> +</figure> + +</sect2> <!-- importing-projects --> + +</sect1> <!-- oldprojects --> + +<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> + +<sect1 id="project-options"> +<title>Tailoring the Project — Project Options</title> + +<para> +(... to be written ...) +</para> + +</sect1> <!-- project-options --> + +</chapter> <!-- projects-advanced --> diff --git a/doc/kdevelop/project-management.docbook b/doc/kdevelop/project-management.docbook new file mode 100644 index 00000000..38a3ff8d --- /dev/null +++ b/doc/kdevelop/project-management.docbook @@ -0,0 +1,751 @@ +<chapter id="project-management"> + +<chapterinfo> + <authorgroup> + <author><firstname>Bernd</firstname><surname>Pol</surname></author> + <author><firstname>Ian</firstname><surname>Wadham</surname></author> + <!-- ROLES_OF_TRANSLATORS --> + </authorgroup> +</chapterinfo> + +<title>Building and Project Management</title> + +<para> +This chapter deals only with compiled projects, such as C++, &Java; or +Fortran projects. Projects for scripting languages like Python and +PHP work very differently. +</para> + +<para> +You will find here information on:</para> +<itemizedlist> + <listitem><para> + <link linkend="automake-manager-summary">Summary of &automanag;</link> containing an initial overall view of &automanag;, + </para></listitem> + <listitem><para> + <link linkend="automake-manager-operation">Automake Manager Operation</link> describing the basics of how to work with &automanag;, + </para></listitem> +</itemizedlist> + +<sect1 id="automake-manager-summary"> +<title>Summary of &automanag;</title> + +<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>. +</para> + +<sect2 id="automake-manager-summary-buildsys"> +<title>The Need for an Automated Build System</title> + +<para> +If you have a simple <quote>Hello World</quote> program, written in C, you can compile and link it using &gcc; <parameter>-o hello hello.c</parameter> and execute it using the command <command>./hello</command>, so you do not even need a <filename>Makefile</filename>. +</para> +<para> +If you have a C application with several modules and header files and you are only going to run it on your own machine (&ie; it is an in-house application), you will only need a simple <filename>Makefile</filename>, which is fairly easy to write by hand (use <userinput>info make</userinput> to find out more). +</para> +<para> +The complications begin when: +</para> +<itemizedlist> + <listitem><para> + Your source-code, documentation, graphics, sounds, translations, data files, &etc; are located in more than one directory, + </para></listitem> + <listitem><para> + You have a hierarchy of directories and sub-directories, + </para></listitem> + <listitem><para> + You are using libraries that are not part of the traditional &UNIX; set, such as the &Qt; Object Library or the &kde; Desktop libraries, + </para></listitem> + <listitem><para> + You are using a pre-processor to generate some of your source-code, such as Qt's MOC pre-compiler, + </para></listitem> + <listitem><para> + You aim to distribute your application worldwide, to people who may not have the same &UNIX;/&Linux; system, software and hardware as you, + </para></listitem> + <listitem><para> + You require an automated Install and Uninstall facility, + </para></listitem> + <listitem><para> + You aim to make your application part of the &kde; Desktop set. + </para></listitem> +</itemizedlist> + +<para> +If you have some or all of the above situations, you probably need a <emphasis>build system</emphasis>. In the example above we used &gcc; to compile and build the <quote>Hello World</quote> program, but not all C compilers are called <quote>&gcc;</quote>. So if you distribute your application to someone who is using some other C compiler, your Makefile must somehow use the name of that person's compiler, otherwise your application will fail to compile—and that is just simple example of what can go wrong. +</para> +<para> +A build system will iron out these differences for you. +</para> +<itemizedlist> + <listitem><para> + It will check that the libraries you need are present on each receiving machine, + </para></listitem> + <listitem><para> + will automatically scan all your application directories for files to pre-process, compile or install and + </para></listitem> + <listitem><para> + will install the components of your application in the correct receiving directories, making sure that + </para></listitem> + <listitem><para> + the directories are created in the receiving machine as required. + </para></listitem> +</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): +</para> +<itemizedlist> + <listitem><para> + <link linkend="automake-project">Automake projects</link> which use the &GNU; standard development tools. + </para></listitem> + <listitem><para> + <link linkend="qmake-project">QMake projects</link> which use the trolltech QMake project manager. + </para></listitem> + <listitem><para> + <link linkend="ant-project">ANT projects</link> which use the Apache ANT project manager for &Java; development. + </para></listitem> + <listitem><para> + <link linkend="custom-project">Custom projects</link> which require you to maintain your own <filename>Makefiles</filename>. + </para></listitem> +</itemizedlist> + +<important> +<para> +One of these four alternatives must be chosen when you create a project and <emphasis>the choice is difficult to change later</emphasis>, so you should give it some thought before you start. +</para> +</important> + +</sect2> <!-- automake-manager-summary-buildsys --> + +<sect2 id="automake-references"> +<title>Tutorials on Autoconf/Automake/Libtool</title> +<para> +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>. + </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>. + </para></listitem> + <listitem><para> + And there is the famous <ulink url="http://sources.redhat.com/autobook"><quote>Goat Book</quote></ulink>, titled <quote>Autoconf, Automake, and Libtool</quote>. This is an easily readable, yet concise, introduction in all main aspects of the &GNU; Autotools. + </para></listitem> +</itemizedlist> + +</sect2> <!-- automake-references --> + +<sect2 id="automake-manager-basics"> +<title>What does &automanag; Do?</title> + +<para> +The <link linkend="applicationwizard">&appwizard;</link> will have set up some initial <filename>Makefile.am</filename> files when you created a <guilabel>New Project</guilabel> of a type that uses the &GNU; Build System, such as <menuchoice><guimenuitem>C++</guimenuitem> <guimenuitem>KDE</guimenuitem> <guimenuitem>Application framework</guimenuitem></menuchoice>. During development &automanag; creates any other <filename>Makefile.am</filename> files for projects that use the &GNU; Build System and maintains them all, &appwizard; and &automanag; created alike. +</para> +<para> +There will be one <filename>Makefile.am</filename> file in each directory of your project that contains files to be compiled or installed. It will contain your specifications for compiling, building and installing files and a reference to any subdirectories that also have a <filename>Makefile.am</filename> file and possibly some files to compile, build and install. +</para> + +<note><para> +Your project's directories and source files may be structured to any depth, or you may prefer a flat project-structure with all subdirectories at the top level. +</para></note> + +<para> +The aim of the &GNU; Build System is to produce source-code file structures that can be compiled, built and installed on any &UNIX; or &Linux; system by using the simple commands: +</para> + +<screen> +./configure +make +make install # Usually as "root". +</screen> + +<para>and can be uninstalled by the command <command>make uninstall</command> (usually as root). +</para> + +<para> +How does this work? Well <command>configure</command> is a script that + +<itemizedlist> + <listitem><para> + works out the details of whatever system it is in, such as what compiler and libraries to use and where they are located, and then + </para></listitem> + <listitem><para> + creates recursive <filename>Makefile</filename> files by filling in the substitutions in the corresponding <filename>Makefile.in</filename> files. + </para></listitem> +</itemizedlist> +</para> +<para> +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. +</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. +</para> +<note><para> +The rules are rather different if you distribute via a web-based source-code repository such as &kde; &cvs;. +</para></note> + +</sect2> <!-- automake-manager-basics --> + +<sect2 id="automake-manager-basics-summary"> +<title>Summary of What Automake Manager Does</title> + +<itemizedlist> + <listitem><para> + Generates <filename>Makefile.am</filename> files in subdirectories it knows as <quote>subprojects</quote>. + </para></listitem> + <listitem><para> + Updates <filename>Makefile.am</filename> files as the project structure changes. + </para></listitem> + <listitem><para> + Updates <filename>Makefile.am</filename> files as files are added to or removed from the project. + </para></listitem> + <listitem><para> + Accepts definitions of how the various files are to be built or installed and modifies the <filename>Makefile.am</filename> accordingly. + </para></listitem> + <listitem><para> + Accepts parameters used in building or installing (⪚ library names) and ensures that they are used in the required compilation and build steps. + </para></listitem> +</itemizedlist> + +</sect2> <!-- automake-manager-basics-summary --> + +<sect2 id="automake-file-contents"> +<title>Contents of Automake Files</title> + +<para> +A <filename>Makefile.am</filename> file has lines containing variable-names followed by an equals sign and a list of files or parameter values. The <quote>variables</quote> have two-part names, such as <varname>bin_PROGRAMS</varname>, <varname>myapp_SOURCES</varname> or <varname>kdelnk_DATA</varname>. The second part is called the <emphasis>primary</emphasis> and represents something from which to build or install. The first part is called the <emphasis>prefix</emphasis> and represents: +</para> +<itemizedlist> + <listitem><para> + A <emphasis>directory</emphasis> in which to do installation (⪚ <filename>bin</filename>), + </para></listitem> + <listitem><para> + A <emphasis>qualifier</emphasis> for the primary (⪚ <varname>myapp</varname> for <varname>SOURCES</varname>, indicating that the source files listed after <varname>myapp_SOURCES</varname> go into building <filename>myapp</filename>), + </para></listitem> + <listitem><para> + A special <emphasis>prefix</emphasis> <varname>noinst</varname> (short for <quote>no installation</quote>), usually used to list program header files (<filename>.h</filename>), + </para></listitem> + <listitem><para> + Or the special prefix <varname>EXTRA</varname>, for <emphasis>configuration-dependent</emphasis> stuff. + </para></listitem> +</itemizedlist> + +<para> +For more information on <command>Automake</command> and <filename>Makefile.am</filename> files, look up <userinput>info Automake</userinput>. +</para> +<para> +Basically, &automanag; creates and updates the variable-names and lists of files or parameters. See the following example of a <filename>Makefile.am</filename> for a typical application, called <filename>myapp</filename>. +</para> + +<screen> +## Makefile.am for myapp + +# this is the program that gets installed. it's name is used for all +# of the other Makefile.am variables +bin_PROGRAMS = myapp + +# set the include path for X, qt and KDE +INCLUDES = $(all_includes) + +# the library search path. +myapp_LDFLAGS = $(KDE_RPATH) $(all_libraries) + +# the libraries to link against. +myapp_LDADD = $(LIB_KFILE) $(LIB_KDEPRINT) + +# which sources should be compiled for myapp +myapp_SOURCES = main.cpp myapp.cpp myappview.cpp + +# these are the headers for your project +noinst_HEADERS = myapp.h myappview.h + +# let automoc handle all of the meta source files (moc) +METASOURCES = AUTO + +KDE_ICON = myapp + +# this is where the kdelnk file will go +kdelnkdir = $(kde_appsdir)/Utilities +kdelnk_DATA = myapp.desktop + +# this is where the XML-GUI resource file goes +rcdir = $(kde_datadir)/myapp +rc_DATA = myappui.rc + +AM_CXXFLAGS = -DMY_C++_PREPROCESSOR_OPTION +</screen> + +<para> +As you can see, many of the items on the right hand side are symbols of the form <varname>$(xxx)</varname>. These are <emphasis>environment variables</emphasis> which are defined in the actual &kde; environment and are substituted with real values when <command>./configure</command> generates the final <filename>Makefile</filename> files in the receiving machine. +</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: + +<screen> +./configure --prefix=/where/you/wish +</screen> +will re-direct the entire installation to a directory structure of your choice, by changing the internal variable <varname>$(prefix)</varname> to value <filename class="directory">/where/you/wish</filename>. +</para> + +</sect2> <!-- automake-file-contents --> + +</sect1> <!-- automake-manager-summary --> + +<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> + +<sect1 id="automake-manager-operation"> +<title>Automake Manager Operation</title> + +<para> +In this chapter you will find a basic description of the &automanag; elements and how to use them. This covers: +<itemizedlist> + <listitem><para> + <link linkend="automake-manager-operation-window">The &automanag; Window</link> describes the basic structure of the &automanag; main window. + </para></listitem> + <listitem><para> + <link linkend="automake-manager-operation-survey-window">The Overall View Window</link> describes the elements of the upper subwindow. + </para></listitem> + <listitem><para> + <link linkend="automake-manager-operation-detail-window">The Detail View Window</link> describes the elements of the lower subwindow. + </para></listitem> + <listitem><para> + <link linkend="automake-manager-operation-navigate">Navigating in the &automanag;</link> lists some basic operations you can perform in the &automanag;. + </para></listitem> + <listitem><para> + <link linkend="automake-manager-operation-popups">Popup Menus in the &automanag;</link> describes the windows which will pop up when you select an action in the &automanag;. + </para></listitem> +</itemizedlist> +</para> + +<sect2 id="automake-manager-operation-window"> +<title>The &automanag; Window</title> + +<informaltable frame="none"> +<tgroup cols="2"><tbody><row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="automakemanager.png" format="PNG"/> + </imageobject> + </inlinemediaobject></entry> + <entry valign="top"><itemizedlist> + <listitem><para> + &automanag; runs in a split window. The top part is called the <emphasis>Overall View</emphasis> and the bottom part is called the <emphasis>Detail View</emphasis>. Between them is a narrow bar that can be dragged with the mouse to adjust the sizes of the views. In IDEAl mode you can also drag the side of the split window to change the width. + </para></listitem> + <listitem><para> + 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.) + </para></listitem> + </itemizedlist></entry> +</row></tbody></tgroup> +</informaltable> + +</sect2> <!-- automake-manager-operation-window --> + +<sect2 id="automake-manager-operation-survey-window"> +<title>The Overall View Window</title> + +<para> +The overall view window contains a tree-list of all the directories in your project that contain program files, documentation or data. Each such directory contains a <filename>Makefile.am</filename> file and is known in &automanag; as a <emphasis>subproject</emphasis>. There are three typical subprojects in a &kde;-based project as shown in the above illustration: +</para> + +<itemizedlist> + <listitem><para> + <filename>src</filename> – source-code files for your application, + </para></listitem> + <listitem><para> + <filename>doc</filename> – your user manual or Handbook, + </para></listitem> + <listitem><para> + <filename>po</filename> – extracts of strings in your source-code files that require translation into other human languages (⪚ window titles, menu names, button labels, dialog box text and messages of various kinds). + </para></listitem> +</itemizedlist> + +<para> +Note that the <filename>doc</filename> subproject always has an <filename>en</filename> subproject, which you can see if you click on the <symbol>+</symbol> symbol next to the word <filename>doc</filename>. That is because the base language of all documentation in &kde; is United States English (en). If your application becomes part of &kde;, the &kde; translation teams may translate your documentation from United States English into other languages and the translations will go into other subprojects, such as <filename>de</filename> (German) or <filename>fr</filename> (French). The strings in the <filename>po</filename> subproject may also be translated and stored in other files in <filename>po</filename>, thus allowing your application to be operated by people who do not know English. +</para> + +<note><para> +The <filename>doc</filename> and <filename>po</filename> subprojects serve different purposes. <filename>doc</filename> contains <emphasis>documentation</emphasis> like a user manual, <filename>po</filename> contains translatable text strings of the <emphasis>user interface</emphasis> which is integrated in the source code of this application. +</para></note> + +<para> +The overall view window serves—amongst other things—as a navigation tool. If you select a subproject in the overall view window, the corresponding details will be shown in the detail view window. +</para> + +</sect2> <!-- automake-manager-operation-survey-window --> + +<sect2 id="automake-manager-operation-detail-window"> +<title>The Detail View Window</title> + +<para> +The detail view contains a tree-list of all the files in the subproject currently selected in the overall view as well as the compilation, build and installation rules for this subproject. Thus the two views together can give you access to all the components of your application and all the information on how to compile, build and install it. +</para> + +<sect3> +<title>Targets</title> + +<para>The tree-list in the detail view has two levels. The top level consists of so-called &automanag; <emphasis>targets</emphasis> and the next level contains lists of files that go to make up each target. +</para> + +<para> +This concept of an &automanag; target differs somewhat from what a <filename>Makefile</filename> target usually is. In short:</para> +<itemizedlist> + <listitem><para> + The definition of how a set of files is to be compiled, built or installed is known as a <emphasis>target</emphasis> in &automanag;, but as a <emphasis>variable</emphasis> in <command>Automake</command> itself. + </para></listitem> + <listitem><para> + A <emphasis>target</emphasis> in <command>make</command> is often something quite different, being the parameter of a <command>make</command> command (⪚ <userinput>make install</userinput>, <userinput>make clean</userinput>). + </para> + <para> + However some <filename>Makefile.am</filename> variables do represent an underlying <emphasis>sub-target</emphasis> in <command>make</command>. + </para></listitem> +</itemizedlist> + +</sect3> +</sect2> <!-- automake-manager-operation-detail-window --> + +<sect2 id="automake-manager-operation-navigate"> +<title>Navigating in the &automanag;</title> + +<para> +In both the overall and the detail view you can left-click on the <symbol>+</symbol> or <symbol>-</symbol> next to a subproject or target name to expand or contract the tree view. If you do that with a <emphasis>subproject</emphasis> in the overall view, it shows or hides the subprojects at the next level down (if any). If you do it with a <emphasis>target</emphasis> in the detail view, it shows or hides the list of files that go into that target. +</para> + +<variablelist> +<varlistentry> +<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> +</listitem> +</varlistentry> + +<varlistentry> +<term>Activating the &automanag; Toolbar Buttons</term> +<listitem> +<para> +If you <emphasis>&LMB; click</emphasis> on the name of a subproject in the +overall view or target in the detail view, the name is highlighted and some +toolbar buttons become active in the top part of that view.</para> + +<note> + <para> + It is recommended that you use the <emphasis>right mouse-button and popup menus</emphasis>, rather than the toolbar buttons, because it is then much easier to see and understand what you are doing. + </para> + <para> + Operations on subprojects and targets have far-reaching effects on the structure, compilation, building and installation of your application. + </para> +</note> +</listitem> +</varlistentry> + +<varlistentry> +<term>Selecting Actions/Popup Menus</term> +<listitem> +<para> +If you <emphasis>&RMB; click</emphasis> on the name of a subproject, target or file, a menu pops up and you can then select actions to perform on the subproject, target or file, such as add a target to the subproject, add a file to a target or logically remove the selected file from its target. +</para> +</listitem> +</varlistentry> +</variablelist> + +</sect2> <!-- automake-manager-operation-navigate --> + +<sect2 id="automake-manager-operation-popups"> +<title>Popup Menus in the &automanag;</title> + +<para> +The following sections explain in short terms which operations the menus make available which will pop up on right mouse button clicks in the &automanag; window. They are meant for overall view only. You will find detailed descriptions of most operations in a later chapter. +</para> +<!-- ### add a link to this chapter when ready --> + +<sect3 id="automake-manager-operation-popups-file"> +<title>The Popup Menu for a File</title> + +<para> +When you &RMB; click on a <emphasis>file name</emphasis> in the detail view the following menu will pop up allowing you to select one of several operations to be performed on that file. In the illustration below the <filename>hi-16app-myapp.png</filename> icon file was selected from the <guilabel>Icon data in myapp</guilabel> target of the <guilabel>myapp/src</guilabel> subproject. +</para> + +<informaltable frame="none"> +<tgroup cols="2"><tbody><row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="automake-file-popup.png" format="PNG"/> + </imageobject> + </inlinemediaobject></entry> + <entry valign="bottom"><itemizedlist> + <listitem><para> + The main popup-menu item for a file is to <guimenuitem>Remove</guimenuitem> the file from its target (&ie; it will no longer be used to compile, build or install that target). + </para></listitem> + <listitem><para> + The <guimenuitem>CVS</guimenuitem> item offers a variety of CVS operations on the file. + </para></listitem> + <listitem><para> + The <guimenuitem>Open With</guimenuitem> item allows you to open the file with a variety of editors or with any application at all (⪚ you can open the icon file in our example with <application>KIcon</application>). + </para></listitem> + <listitem><para> + The <guimenuitem>Perforce</guimenuitem> item is used for similar operations as in CVS using the commercial <quote><application>Perforce</application></quote> version control system. + </para></listitem> + </itemizedlist></entry> +</row></tbody></tgroup> +</informaltable> + +</sect3> <!-- automake-manager-operation-popups-file --> + +<sect3 id="automake-manager-operation-popups-target"> +<title>The Popup Menu for a Target</title> + +<para> +When you right-click on a <emphasis>target</emphasis> in the detail view the following menu will pop up allowing you to select one of several operations to be performed on it. In the illustration below the <guilabel>myapp (Program in bin)</guilabel> target of the <guilabel>myapp/src</guilabel> subproject was selected. +</para> + +<informaltable frame="none"> +<tgroup cols="2"><tbody><row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="automake-target-popup.png" format="PNG"/> + </imageobject> + </inlinemediaobject></entry> + <entry valign="bottom"><itemizedlist> + <listitem><para> + The <guimenuitem>Options</guimenuitem> item for a target only applies to source code files. In the corresponding dialog box you can specify linker flags and paths on which to locate libraries and you can give a list of actual libraries to be linked in to your application. + </para></listitem> + <listitem><para> + The <guimenuitem>Create New File</guimenuitem> item brings up a dialog in which you can set the file name and the type of file to be generated (from a drop-down list). + </para></listitem> + <listitem><para> + The <guimenuitem>Add Existing Files</guimenuitem> item brings up a dialog box in which you can add an already existing file to this target. + </para></listitem> + <listitem><para> + The <guimenuitem>Remove</guimenuitem> item for a target allows you to logically remove the target and all its files from the project structure. + </para></listitem> + <listitem><para> + The <guimenuitem>Make Target Active</guimenuitem> item only applies to targets containing source code files. New files will always be added to such an active target. + </para></listitem> + <listitem><para> + The <guimenuitem>Build Target</guimenuitem> item calls all necessary compile and make operations to build the code for this target only. + </para></listitem> + </itemizedlist></entry> +</row></tbody></tgroup> +</informaltable> + +</sect3> <!-- automake-manager-operation-popups-target --> + +<sect3 id="automake-manager-operation-popups-subproject"> +<title>The Popup Menu for a Subproject</title> + +<para> +When you &RMB; click on a <emphasis>subproject</emphasis> in the overall view window the following menu will pop up which allows you to make major changes to the structure of your project and the way it is compiled, built and installed. You can use it to expand or modify the basic project structure that the &appwizard; has created. +</para> + + +<informaltable frame="none"> +<tgroup cols="2"><tbody><row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="automake-subproject-popup.png" format="PNG"/> + </imageobject> + </inlinemediaobject></entry> + <entry valign="bottom"><itemizedlist> + <listitem><para> + The <guimenuitem>Options</guimenuitem> item for a subproject controls the way that the subproject will be compiled, built and installed. The dialog box that pops up has tabs for Compiler, Includes, Prefixes and Build Order. + </para></listitem> + <listitem><para> + The <guimenuitem>Add Subproject</guimenuitem> item creates a new directory and skeleton Makefile.am file. + </para></listitem> + <listitem><para> + The <guimenuitem>Add Target</guimenuitem> item pops up a dialog in which you can set the rules for compiling, building or installing a group of files within your subproject. + </para></listitem> + <listitem><para> + <guimenuitem>Add Service</guimenuitem> (... to be written ...) + </para></listitem> + <listitem><para> + <guimenuitem>Add Application</guimenuitem> (... to be written ...) + </para></listitem> + <listitem><para> + <guimenuitem>Add Existing Subprojects</guimenuitem> (... to be written ...) + </para></listitem> + <listitem><para> + The <guimenuitem>Remove Subproject</guimenuitem> item in the popup menu for a subproject is the proper way to remove a subproject. It will adjust the <filename>Makefile.am</filename> files accordingly. You will also be offered the option to delete all the files (or links) in the corresponding subdirectory. Obviously, this feature should be used with caution. + </para></listitem> + <listitem><para> + The <guimenuitem>Build</guimenuitem> item calls all necessary compile and make operations to build the code for this subproject only. + </para></listitem> + <listitem><para> + <guimenuitem>Force Reedit</guimenuitem> (... to be written ...) + </para></listitem> + <listitem><para> + <guimenuitem>Clean</guimenuitem> (... to be written ...) + </para></listitem> + <listitem><para> + <guimenuitem>Install</guimenuitem> (... to be written ...) + </para></listitem> + <listitem><para> + <guimenuitem>Install (as root user)</guimenuitem> (... to be written ...) + </para></listitem> + </itemizedlist></entry> +</row></tbody></tgroup> +</informaltable> + +</sect3> <!-- automake-manager-operation-popups-subproject --> + +</sect2> <!-- automake-manager-operation-popups --> + +</sect1> <!-- automake-manager-operation --> + +<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> + +<sect1 id="autoproject"> +<title>Automake Projects</title> +<indexterm zone="autoproject"><primary><command>autoproject</command></primary></indexterm> +<indexterm zone="autoproject"><primary>&automake;</primary></indexterm> +<indexterm zone="autoproject"><primary>&autoconf;</primary></indexterm> +<indexterm zone="autoproject"><primary>&libtool;</primary></indexterm> + +<para> +(... to be written ...) +</para> + + +<sect2 id="autoconf"> +<title>Autoconf</title> +<indexterm zone="autoconf"><primary><filename>configure</filename> script</primary></indexterm> +<indexterm zone="autoconf"><primary><filename>config.status</filename> script</primary></indexterm> +<indexterm zone="autoconf"><primary><filename>Makefile.in</filename></primary></indexterm> +<indexterm zone="autoconf"><primary><filename>config.h.in</filename></primary></indexterm> + +<para> +<filename>Makefile.in</filename> into <filename>Makefile</filename> +</para> + +<programlisting> +prefix = @prefix@ +INSTALL = @INSTALL@ +build_triplet = @build@ +CXX = @CXX@ +</programlisting> + +<programlisting> +prefix = /home/bernd/kde3 +INSTALL = /usr/bin/ginstall -c -p +build_triplet = i686-pc-linux-gnu +CXX = g++ +</programlisting> + +<para> +<filename>config.h.in</filename> into <filename>config.h</filename> +</para> + +<programlisting> +/* Define if you have libz */ +#undef HAVE_LIBZ +/* The size of a `int', as computed by sizeof. */ +#undef SIZEOF_INT +</programlisting> + +<programlisting> +/* Define if you have libz */ +#define HAVE_LIBZ 1 +/* The size of a `int', as computed by sizeof. */ +#define SIZEOF_INT 4 +</programlisting> + +</sect2> <!-- autoconf --> + + +<sect2 id="automake"> +<title>Automake</title> + +<para> +(... to be written ...) +</para> + +</sect2> <!--automake --> + + +<sect2 id="automake-manager"> +<title>&kdevelop;'s &automanag;</title> + +<figure id="screenshot-automake-manager" float="1"> +<title>A screenshot of the automake manager</title> +<mediaobject> +<imageobject><imagedata fileref="automake-manager.png"/></imageobject> +</mediaobject> +</figure> + +</sect2> <!-- automake-manager --> + + +<sect2 id="automakelibrary"> +<title>Building and Installing Libraries</title> + +<para> +<itemizedlist> +<listitem><para> + -rpath +</para></listitem> +<listitem><para> + PIC +</para></listitem> +<listitem><para> + static +</para></listitem> +<listitem><para> + plugins: no-undefined +</para></listitem> +</itemizedlist> +</para> + +</sect2> <!-- automakelibrary --> + +</sect1> <!-- autoproject --> + +<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> + +<sect1 id="customproject"> +<title>Custom Makefiles and Build Scripts</title> +<indexterm zone="customproject"><primary><filename>Makefile</filename></primary></indexterm> +<indexterm zone="customproject"><primary><filename>build.xml</filename></primary></indexterm> + +<para> +(... to be written ...) +</para> + +</sect1> <!-- customproject --> + +<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> + +<sect1 id="compileroptions"> +<title>Compiler Options</title> + +<para> +(... to be written ...) +</para> + +</sect1> <!-- compileroptions --> + +<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> + +<sect1 id="makeoptions"> +<title>Make Options</title> + +<para> +(... to be written ...) +</para> + +</sect1> <!-- makeoptions --> + +</chapter> <!-- project-management --> diff --git a/doc/kdevelop/raw-project-warning.png b/doc/kdevelop/raw-project-warning.png Binary files differnew file mode 100644 index 00000000..c9065815 --- /dev/null +++ b/doc/kdevelop/raw-project-warning.png diff --git a/doc/kdevelop/run-button.png b/doc/kdevelop/run-button.png Binary files differnew file mode 100644 index 00000000..51522e90 --- /dev/null +++ b/doc/kdevelop/run-button.png diff --git a/doc/kdevelop/script_location.png b/doc/kdevelop/script_location.png Binary files differnew file mode 100644 index 00000000..e5488024 --- /dev/null +++ b/doc/kdevelop/script_location.png diff --git a/doc/kdevelop/select-user-interface-0.png b/doc/kdevelop/select-user-interface-0.png Binary files differnew file mode 100644 index 00000000..c98faf71 --- /dev/null +++ b/doc/kdevelop/select-user-interface-0.png diff --git a/doc/kdevelop/select-user-interface.png b/doc/kdevelop/select-user-interface.png Binary files differnew file mode 100644 index 00000000..927ad411 --- /dev/null +++ b/doc/kdevelop/select-user-interface.png diff --git a/doc/kdevelop/setup.docbook b/doc/kdevelop/setup.docbook new file mode 100644 index 00000000..e5449a99 --- /dev/null +++ b/doc/kdevelop/setup.docbook @@ -0,0 +1,1990 @@ +<chapter id="setup"> + +<chapterinfo> + <authorgroup> + <author><firstname>Bernd</firstname><surname>Pol</surname></author> + <!-- ROLES_OF_TRANSLATORS --> + </authorgroup> +</chapterinfo> + +<title>Configuring &kdevelop;</title> + +<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. +</para> + +<screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="configure-select.png" format="PNG"/> + </imageobject> +<textobject> +<phrase>Select a configuration item</phrase> +</textobject> + <caption><para> + Select a configuration item + </para></caption> + </mediaobject> +</screenshot> + +<para> +We will discuss these configurations in a different order, split up into the main topics of <link linkend="setup-general">General Configuration</link>, <link linkend="setup-docu">Configuring the Documentation</link>, and <link linkend="setup-advanced">Advanced Configuration</link> which makes for a more intuitive reading. +</para> +<para> +If you want directly look up a certain configuration item use one of the following links. +</para> + +<simplelist> + <member><link linkend="setup-main">General</link></member> + <member><link linkend="setup-ui">User Interface</link></member> + <member><link linkend="setup-templates">File Templates</link></member> +<member><link linkend="setup-editor">Editor</link></member> + <member><link linkend="setup-abbrev">Abbreviations</link></member> + <member><link linkend="setup-scripting">Scripting</link></member> + <member><link linkend="setup-menu-standard">Tools Menu</link></member> + <member><link linkend="setup-menu-external">External Tools</link></member> + <member><link linkend="setup-docu">Documentation</link></member> + <member><link linkend="setup-snippets">Code Snippets</link></member> + <member><link linkend="setup-file-list">File List</link></member> + <member><link linkend="setup-file-selector">File Selector</link></member> + <member><link linkend="setup-cpp-generator">C++ Class generator</link></member> + <member><link linkend="setup-format">Formatting</link></member> + <member><link linkend="setup-cpp-parsing">C++ Parsing</link></member> +</simplelist> + +<sect1 id="setup-general"> +<title>General Configuration</title> + +<para> +General configuration concerns the more common tasks of tailoring &kdevelop; as there are: +</para> +<itemizedlist> + <listitem><para> + <link linkend="setup-main">General Setup</link> + </para></listitem> + <listitem><para> + <link linkend="setup-ui">Selecting the User Interface</link> + </para></listitem> + <listitem> + <itemizedlist> +<title>Source Edit Tasks</title> + <listitem><para> + <link linkend="setup-editor">Selecting an Editor</link> + </para></listitem> + <listitem><para> + <link linkend="setup-format">Selecting a Source Format Style</link> + </para></listitem> + <listitem><para> + <link linkend="setup-snippets">Setting Up the Code Snippets Tool</link> + </para></listitem> + </itemizedlist> + </listitem> + <listitem><para> + <link linkend="setup-file-selector">Configuring the File Selector</link> + </para></listitem> +</itemizedlist> + +<sect2 id="setup-main"> +<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: +</para> + +<variablelist> +<varlistentry> +<term>General project options such as</term> +<listitem> + <itemizedlist> + <listitem><para> + defining a <link linkend="setup-main-projects">default parent directory</link> &kdevelop; 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. + </para></listitem> + </itemizedlist> + </listitem> +</varlistentry> + +<varlistentry> +<term>Selecting a font for the most commonly used output view windows, +namely:</term> +<listitem> + +<itemizedlist> +<listitem> +<para>the <link linkend="setup-main-messages-font">Messages Output +View</link> &kdevelop; uses to communicate ⪚ compilation progresses, +and</para> +</listitem> +<listitem> +<para>the <!--<link linkend="setup-main-applications-font">-->Application Output +View<!--</link>--> which will show error and state information concerning a running +application.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>Some common behaviour concerning the displayed lines in the +<guilabel>Messages Output View</guilabel> window, namely:</term> +<listitem> + <itemizedlist> +<listitem> +<para>whether long lines will <link linkend="setup-main-wrap">wrap + around</link>, and </para> +</listitem> +<listitem> +<para>if <link linkend="setup-main-navigation">directory entry and exit +messages</link> issued by <command>make</command> will be shown.</para> +</listitem> +</itemizedlist> + +<para>The <link linkend="setup-main-compile">level of detail</link> of + messages concerning the compilation process shown in the + <guilabel>Messages Output View</guilabel> window.</para> +</listitem> +</varlistentry> +</variablelist> + +<screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="configure-general.png" format="PNG"/> + </imageobject> + <caption><para> + The general configuration dialog + </para></caption> + </mediaobject> +</screenshot> + +<variablelist> +<varlistentry> +<term id="setup-main-preload"><guilabel>Load last project on +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. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="setup-main-projects"> +<guilabel>Default projects directory:</guilabel></term> +<listitem> +<para> +By default, &kdevelop; uses a common parent directory for all new +projects. Enter the absolute path of this common directory in the box or +select it from your directory structure. &kdevelop; will place the any new +project here as a subdirectory.</para> +<note><para> +You may of course change the directory path of a new project at the time you set it up in the <link linkend="applicationwizard">&appwizard;</link>. +</para></note> +</listitem> +</varlistentry> + +<varlistentry> +<term id="setup-main-messages-font"><guilabel>Window font:</guilabel></term> +<listitem> +<para> +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. +</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. +</para></note> +</listitem> +</varlistentry> + +<varlistentry> +<term id="setup-main-compile"><guilabel>Compiler Output</guilabel></term> +<listitem> +<para> +&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. +</para> +<variablelist> +<varlistentry> +<term><guilabel>Very Short</guilabel></term> +<listitem><para> +Displays only warnings, errors, and the filenames which are compiled. +</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Short</guilabel></term> +<listitem><para> +Suppresses all compiler flags and formats the output to be more readable. +</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Full</guilabel></term> +<listitem><para> +Displays all output messages unmodified. +</para></listitem> +</varlistentry> +</variablelist> + +<tip><para> +There is an alternative way to switch the compiler output detail. Just right click in the <guilabel>Messages Output View</guilabel> window and select the according detail level from the popup menu. +</para></tip> +</listitem> +</varlistentry> + +<varlistentry> +<term id="setup-main-wrap"><guilabel>Line wrapping</guilabel></term> +<listitem> +<para> +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. +</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. +</para></tip> +</listitem> +</varlistentry> + +<varlistentry> +<term id="setup-main-navigation"><guilabel>Directory navigation +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. +</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. +</para></note> +</listitem> +</varlistentry> + +<varlistentry> +<term id="ui-designer-integration"><guilabel>UI Designer Integration</guilabel></term> +<listitem> +<para> +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. +</para> +<itemizedlist> + <listitem><para> + Use &kdevelop;'s embedded designer + </para><para>This uses &kdevelop; own designer embedded within &kdevelop;</para></listitem> + <listitem><para> + Run &kdevelop;'s designer as a separate application + </para><para>The KDevDesigner application will be run separately in its own window.</para> +<screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="kdevdesigner.png" format="PNG"/> + </imageobject> + <caption><para> + KDevDesigner in its own window + </para></caption> + </mediaobject> +</screenshot> +</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> +</itemizedlist> +</listitem> +</varlistentry> + +<varlistentry> +<term id="terminal-emulation"><guilabel>Terminal Emulation</guilabel></term> +<listitem> +<para> +You choose here which terminal you want to be integrated within KDevelop. +</para> +<itemizedlist> + <listitem><para> + Use &kde; setting + </para><para>This uses &kde; setting as set in &kcontrol; in <guilabel>&kde; component</guilabel> <guilabel>Component Chooser</guilabel> tab which sets the default terminal emulator used by all &kde; applications that need a terminal.</para></listitem> + <listitem><para> + Other + </para><para>Choose some other terminal different from the default one.</para> +</listitem> +</itemizedlist> +</listitem> +</varlistentry> + +</variablelist> + +</sect2> <!-- setup-main --> + +<sect2 id="setup-ui"> +<title>Selecting the User Interface</title> + +<indexterm zone="setup-ui"> + <primary>user interface</primary> + <secondary>switch modes</secondary></indexterm> +<indexterm zone="setup-ui"> + <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: +</para> +<itemizedlist> + <listitem><para> + <link linkend="ideal-desc">Simplified IDEAl window mode</link> + </para><para>This is a simplified version of the IDEA user interface. It is designed to be simple and clean. It also does not uses docked toolviews.</para></listitem> + <listitem><para> + <link linkend="ideal-desc">IDEAl window mode</link> + </para><para>This is a clone of the IDEA user interface, similar to the Tabbed pages mode and is default.</para></listitem> + <listitem><para> + <link linkend="mdi-desc">Childframe window mode</link> + </para><para>All tool views are initially docked to the mainframe. +Editor and browser views will live like toplevel windows within a view area of the mainframe. +A typical example of this user interface mode is MS Visual Studio 6.0.</para></listitem> + <listitem><para> + <link linkend="tabbed-desc">Tabbed pages mode</link> + </para><para>All tool views are initially docked to the mainframe. +Editor and browser views will be stacked in a tab window. +A typical example of this user interface mode is KDEStudio, our friend C++-IDE in the world of KDE.</para></listitem> + <listitem><para> + <link linkend="toplevel-desc">Toplevel window mode</link> + </para><para>All editor, browser and tool views will be toplevel windows (directly on desktop). +The main widget contains the menu, toolbars and statusbar only. +A typical example of this user interface mode is Borland Delphi 6.0.</para></listitem> +</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> + +<screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="select-user-interface-0.png" format="PNG"/> + </imageobject> +<textobject><phrase>Select a user interface mode</phrase></textobject> + <caption><para> + Select a user interface mode + </para></caption> + </mediaobject> +</screenshot> + +<para> +Select the radio button of the user interface mode you want to switch to, then click <guibutton>OK</guibutton>. +</para> + +<note><para> +Do not forget to restart &kdevelop; in order to let any of these selections take effect. +</para></note> + +<para> +When you selected either the <guilabel>Simplified IDEAl window mode</guilabel> or the <guilabel>IDEAl window mode</guilabel> or the <guilabel>Tabbed pages mode</guilabel> two more configuration sections will become available: <link linkend="setup-ui-tabs">Use Tabs</link> and <link linkend="setup-ui-hover">Use Close On Hover</link>. These allow to configure under which circumstances tabs will be shown on top of the document windows and whether you may close the document by a click on the tab icon. +</para> + +<para> +In <guilabel>Simplified IDEAl window mode</guilabel> and in <guilabel>IDEAl window mode</guilabel> only yet another configuration section will be available, <link linkend="setup-ui-toolview">Toolview Tab Layout</link> which effectively allows to select between different sizes of the toolview tabs which surround the main working area in this mode. +</para> + +<variablelist> +<varlistentry> +<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. +</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. + </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. + </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. + </para></listitem> +</varlistentry> +</variablelist> +</listitem> +</varlistentry> + +<varlistentry> +<term id="setup-ui-hover">Setting Up to Close a Document by a Click On Its +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. +</para> + +<variablelist> +<varlistentry> + <term><guilabel>No</guilabel></term> + <listitem><para> + This is standard behaviour. No extra functionality is added to the tabs. They may be used only to select document windows on &LMB; clicks. + </para></listitem> +</varlistentry> +<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. + </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. + </para></listitem> +</varlistentry> +</variablelist> +</listitem> +</varlistentry> + +<varlistentry> +<term id="setup-ui-toolview">Configuring the Toolview Tab Layout</term> +<listitem> +<para> +The <guilabel>Toolview Tab Layout</guilabel> configuration section will be available in IDEAl mode only. Use these radio buttons to set up the look of the toolview tabs which surround the main working area in this mode. +</para> + +<variablelist> +<varlistentry> + <term><guilabel>Icons</guilabel></term> + <listitem> + <para> + Each tab will show an icon only. If the associated toolview is displayed, the tab will open and a descriptive text for this toolview be shown. You may want to use this mode if you work on a monitor with limited resolution. + </para> + <para> + The icons are not very descriptive, however. If you want to find out which toolview is assigned to a given tab, point at it with the mouse and wait a second. A short tooltip will then pop up with the toolview name. + </para> + </listitem> +</varlistentry> +<varlistentry> + <term><guilabel>Text</guilabel></term> + <listitem><para> + This is the default toolview tab display mode. Each tab displays the name of its associated toolwiew. + </para></listitem> +</varlistentry> +<varlistentry> + <term><guilabel>Text and Icons</guilabel></term> + <listitem><para> + If the standard text toolview display looks too flat to you and you are working on a high-resolution monitor you may want to select this radio button. It will cause the name of the associated toolview be displayed on each tab plus an icon to the left of it, making the tabs easier to distinguish. See the <link linkend="folded-toolview-tabs">Folded Toolview Tabs</link> illustration below for an example. + </para></listitem> +</varlistentry> +</variablelist> +</listitem> +</varlistentry> + +<varlistentry> +<term>Folded Toolview Tabs</term> +<listitem> +<para> +If you selected the IDEAl mode toolview tabs to display texts (with or without accompanying icons) you need not worry about them being hidden behind some toolview window. If one of the bottom toolview windows occupies more space than is available to display all (vertical) tabs, they will fold around as this illustration shows: +</para> + +<screenshot> + <mediaobject id="folded-toolview-tabs"> + <imageobject> + <imagedata fileref="folded-tabs.png" format="PNG"/> + </imageobject> +<textobject><phrase>Toolview tabs fold to not be hidden behind another view window</phrase></textobject> + <caption><para> + Toolview tabs fold to not be hidden behind another view window + </para></caption> + </mediaobject> +</screenshot> + +<note><para> +The active toolview window must be shown fixed (non-overlap mode), sharing the work area with the other windows, to force such tab folding. Press the small square in the window border to accomplish this as shown in the example. +</para></note> +</listitem> +</varlistentry> +</variablelist> + +</sect2> <!-- setup-ui --> + +<sect2 id="setup-templates"> +<title>File Templates</title> +<!--TODO fill--><para></para> + +<screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="configure-file-templates.png" format="PNG"/> + </imageobject> +<textobject><phrase>Configure File Templates</phrase></textobject> + <caption><para> + Configure File Templates + </para></caption> + </mediaobject> +</screenshot> +</sect2> <!-- setup-templates --> + +<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> + +<screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="configure-editor.png" format="PNG"/> + </imageobject> +<textobject><phrase>Select an editor</phrase></textobject> + <caption><para> + Select an editor + </para></caption> + </mediaobject> +</screenshot> + +<para> +To select a new editor, click on the arrow on the drop down list field. Depending on the editor parts interfaces your &kde; version has compiled in you will be provided with a list of editors you may select from (see the <link linkend="setup-editor-kparts">Important</link> note below for this). Click on the editor of your liking and click <guilabel>OK</guilabel>. Currently there are two possibilities: +</para> + +<variablelist> + <varlistentry> + <term><guilabel>Embedded Advanced Text Editor</guilabel></term> + <listitem><para> + This is the &kde; standard <application>Kate</application> editor part. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Qt Designer Based Text Editor</guilabel></term> + <listitem><para> + This is the editor &Qt; provides in its <application>Designer</application> component. + </para></listitem> + </varlistentry> +</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. +</para> + +<note><para> +Changing the editor will not effect already open files. There are two possibilities to proceed. Either close all open text windows and reopen them one by one. Or simply close the whole project and reopen it again. The windows will then automatically open under the new text editor interface. +</para></note> + +<important id="setup-editor-kparts"><para> +KDevelop lets you use editor interfaces which have registered with &kde; and that provide a KatePart interface. If you miss one one of the selections shown above check your &kde; installation if the corresponding KPart was correctly installed. +</para></important> + +<para>What to do if the file has been changed externally:</para> +<variablelist> + <varlistentry> + <term><guilabel>Do nothing</guilabel></term> + <listitem><para> + The file will be marked as externally changed and the user will be asked to verify any attempt to overwrite it. + </para></listitem> + </varlistentry> + <varlistentry> + <term><guilabel>Alert the user</guilabel></term> + <listitem><para> + A dialog will alert the user that a file has changed and offer the user to reload the file. + </para></listitem> + </varlistentry> + <varlistentry> + <term><guilabel>Automatically reload the file if safe, alert the user if not</guilabel></term> + <listitem><para> + Any files that are not modified in memory are reloaded and an alert is shown for any conflicts. + </para></listitem> + </varlistentry> +</variablelist> +</sect2> <!-- setup-editor --> + +<sect2 id="setup-abbrev"> +<title>Abbreviations for the Word Completion</title> + +<para> +(... to be written ...) +</para> +</sect2> <!-- setup-abbrev --> + +<sect2 id="setup-scripting"> +<title>Scripting</title> + +<para> +(... to be written ...) +</para> +</sect2> <!-- setup-scripting --> + +<sect2 id="setup-menu-standard"> +<title>Adding &kde; Standard Applications to the Tools Menu</title> + +<para> +(... to be written ...) +</para> +</sect2> <!-- setup-menu-standard Tools Menu--> + +<sect2 id="setup-menu-external"> +<title>Adding External Applications to Menus</title> + +<para> +(... to be written ...) +</para> + +<sect3 id="setup-menu-external-tools"> +<title>Adding to the Tools Menu</title> + +<para> +(... to be written ...) +</para> +</sect3> <!-- setup-menu-external-tools --> + +<sect3 id="setup-menu-external-filecontext"> +<title>Adding to the File Context Menu</title> + +<para> +(... to be written ...) +</para> +</sect3> <!-- setup-menu-external-filecontext --> + +<sect3 id="setup-menu-external-dircontext"> +<title>Adding to the Directory Context Menu</title> + +<para> +(... to be written ...) +</para> +</sect3> <!-- setup-menu-external-dircontext --> + +</sect2> <!-- setup-menu-external --> + +<sect2 id="setup-format"> +<title>Selecting a Source Format Style</title> + +<para> +&kdevelop; 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. +</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>. +</para> + +<tip><para> +Any style changes apply to newly entered text only. If you want to change the formatting style of an already existing source text you will have to explicitely use the <menuchoice><guimenu>Edit</guimenu><guimenuitem>Reformat Source</guimenuitem></menuchoice> command. +</para></tip> + +<note><para> +The exact outcome of these style formatting definitions depends on the <link linkend="setup-editor">editor</link> you use. Currently, most settings are tailored to the Kate editor part (the <quote>Embedded Advanced Text Editor</quote>). Some other editors (⪚ the Qt editor) may rely on their own configuration settings. You will have to experiment in this case to find out the exact effects of the style settings provided here. +</para></note> + +<warning><para> +There may be incompatibilities between the configuration style settings provided here and the editor you use up to the extent that in extreme cases it even might destroy your files. Make sure you have a backup of your source files before you try out these settings with an none KDE standard editor. +</para></warning> + +<sect3 id="setup-format-general"> +<title>General Formatting Setup</title> + +<para> +The <guilabel>General</guilabel> tab of the <guilabel>Source Formatter</guilabel> dialog allows you to select one out of five predefined source format styles. +</para> + +<screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="SF-general.png" format="PNG"/> + </imageobject> +<textobject><phrase>Source format style general setup</phrase></textobject> + <caption><para> + Source format style general setup + </para></caption> + </mediaobject> +</screenshot> + +<para> +A formatted source example will be displayed in the field to the right. If none of the predefined styles is to your liking, you may click the top <guilabel>User defined</guilabel> radio button and define your own source formatting style preferences on the other two tabs which will become available then. +</para> + +<note><para> +Currently only the predefined source formatting styles will be demonstrated by an example text. If you decide to define your own style, no example display will be available. You have to experiment on an actual source text to tailor the settings to your liking. +</para></note> + +</sect3> <!-- setup-format-general --> + +<sect3 id="setup-format-indent"> +<title>Indentation Style Setup</title> + +<para> +Proper indentation is the main means to enhance readability of a source text. I you selected the <guilabel>Indentation</guilabel> tab of the <guilabel>Source Formatter</guilabel> dialog you will be presented with a series of indentation formatting choices grouped into three boxes as following. +</para> + +<screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="SF-indent.png" format="PNG"/> + </imageobject> +<textobject><phrase>Source format indentation style setup</phrase></textobject> + <caption><para> + Source format indentation style setup + </para></caption> + </mediaobject> +</screenshot> + +<variablelist> +<varlistentry> +<term>Default Settings</term> +<listitem> +<para>The preset format choices will cause the source text to resemble the +ANSI formatting style:</para> + +<screen> +namespace foospace +{ + int Foo() + { + if (isBar) + { + bar(); + return 1; + } + else + return 0; + } +} +</screen> +</listitem> +</varlistentry> + +<varlistentry> +<term id="setup-format-indent-filling">Defining Indentation Width and Characters</term> +<listitem> +<para>The radio buttons grouped in the <guilabel>Filling</guilabel> group +define how indents in the source text will be drawn.</para> + +<variablelist> + <varlistentry> + <term><guilabel>Use tabs</guilabel></term> + <listitem> + <para> + This will cause the editor to insert a tab character for each +indentation level. The tab width is predefined in the editor settings (8 or +4 character columns usually). Use <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Editor...</guimenuitem></menuchoice> to redefine it. + </para> + <note><para> + The actual tab width definition procedure depends on the editor you selected in the <link linkend="setup-editor">Selecting an Editor</link> configuration step. You will have to look up the corresponding editor help to find out. + </para></note> + </listitem> + </varlistentry> + <varlistentry> + <term><guilabel>Use spaces</guilabel></term> + <listitem><para> + If you select this radio button, the editor will enter a number of spaces for each indentation level. Change the number from the default 2 to the indentation width you prefer. + </para></listitem> + </varlistentry> +</variablelist> +</listitem> +</varlistentry> + +<varlistentry> +<term>Indented Entities</term> +<listitem> +<para>This defines which of the (C/C++) entities will be formatted with an +extra indent beyond the current indentation level.</para> + +<para>By default only <guilabel>namespaces</guilabel> and +<guilabel>labels</guilabel> will be extra indented. You may want to +experiment with various settings to tailor those extra indents to your +liking.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Continuation</term> +<listitem> +<para> +The settings grouped here apply to those cases where the source formatter automatically wraps around long source lines. It takes two special cases in account, namely that in deeply nested indents there should remain enough room for the source and that conditionals should get extra indent levels on continuation to make them stand out properly. +</para> + +<note><para> +This applies to <emphasis>static word wrap cases</emphasis> only where a fixed maximum line width is used in the source text. If you set up your editor to dynamically wrap around long lines in display only (which is possible in the &kate; editor part) the effects of these settings usually will not show. +</para></note> + +<variablelist> + <varlistentry> + <term><guilabel>Maximum in statement</guilabel></term> + <listitem> + <para> + This setting limits the maximum possible indentation for the continuation lines so that enough space will remain to keep the text readable. No continuation line will ever be indented beyond the number of columns you selected in this field. + </para> + <para> + The default is set to 40 character columns (half a standard 80 column page). You may want to increase this value to account for wider paper (e.g if you use landscape printing for your sources). Or decrease the value accordingly to take larger margin settings of your printouts into account. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><guilabel>Minimum in conditional</guilabel></term> + <listitem> + <para> + Conditionals or source following ⪚ an assignment operator should usually get an extra indent on continuation lines in order to keep the text readable. The amount of this extra indent is defined here. + </para> + <para> + The default is set to <quote>Twice current</quote> which means that continued conditionals will get an extra indent level of the standard indentation size you selected in the <link linkend="setup-format-indent-filling">Filling</link> group. You may change this extra indent to another fixed width (including zero) using the arrows or by entering the value directly. + </para> + </listitem> + </varlistentry> +</variablelist> +</listitem> +</varlistentry> +</variablelist> + +</sect3> <!-- setup-format-indent --> + +<sect3 id="setup-format-other"> +<title>Other Formatting Setup</title> + +<screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="SF-other.png" format="PNG"/> + </imageobject> +<textobject><phrase>Other source format style settings</phrase></textobject> + <caption><para> + Other source format style settings + </para></caption> + </mediaobject> +</screenshot> + +<variablelist> +<varlistentry> +<term>Controlling the position of braces</term> +<listitem> +<para>The radio buttons the (somewhat misnamed) +<guilabel>Brackets</guilabel> group control the position of block delimiting +braces in a (C/C++) source text. There are three possibilities from which +you can select.</para> + +<variablelist> + <varlistentry> + <term><guilabel>Break</guilabel></term> + <listitem> + <para>This inserts a line break before each opening brace. Both delimiting braces of any block will be put at the same indentation level as the block head statement.</para> + +<screen> +namespace foospace +{ + int Foo() + { + if (isBar) + { + bar(); + return 1; + } + else + return 0; + } +} +</screen> + </listitem> + </varlistentry> + <varlistentry> + <term><guilabel>Attach</guilabel></term> + <listitem> + <para> + This will keep the opening brace of a block in line with the block head statement. Closing braces will be on the same indentation level as the block head statement. The <token>else</token> of an <token>if</token> statement will be kept in line with the closing brace of the preceding block. + </para> +<screen> +namespace foospace { + int Foo() { + if (isBar) { + bar(); + return 1; + } else + return 0; + } +} +</screen> + </listitem> + </varlistentry> + <varlistentry> + <term><guilabel>Linux Style</guilabel></term> + <listitem> + <para> + This is a compromise of the above listed styles. Functional block delimiting braces will be put on extra lines. Braces opening a block in a conditional or loop statement will be kept in line. + </para> +<screen> +namespace foospace +{ + int Foo() + { + if (isBar) { + bar(); + return 1; + } else + return 0; + } +} +</screen> + </listitem> + </varlistentry> +</variablelist> +</listitem> +</varlistentry> + +<varlistentry> +<term>Controlling Extra Spaces</term> +<listitem> +<para> +By default &kdevelop; does minimize the use of spaces in source texts. +</para> + + +<screen> +if (isBar(fooArg)==barValue) +</screen> + +<para>You may enhance readability if you force the source formatter to +insert extra spaces in special positions.</para> + +<variablelist> + <varlistentry> + <term><guilabel>Add spaces around parentheses</guilabel></term> + <listitem> + <para>In fact what is meant is to add spaces around the text put in parentheses. This enhances the readabilitiy of function arguments and conditionals.</para> +<screen> +if ( isBar( fooArg )==barValue ) +</screen> + </listitem> + </varlistentry> + <varlistentry> + <term><guilabel>Add spaces around operators</guilabel></term> + <listitem> + <para>This will put spaces around assignment and comparison operators to enhance the readability.</para> +<screen> +if (isBar(fooArg) == barValue) +</screen> + </listitem> + </varlistentry> +</variablelist> +</listitem> +</varlistentry> + +<varlistentry> +<term>Controlling the formatting of one-line constructs</term> +<listitem> +<para>There are a few cases where you don't want the source formatter to +split a long line apart. For C/C++ code this can be controlled here.</para> + +<variablelist> + <varlistentry> + <term><guilabel>Keep one-line statements</guilabel></term> + <listitem><para> + This keeps single line statements together in some situations even if they exceed a fixed maximum line length. + </para></listitem> + </varlistentry> + <varlistentry> + <term><guilabel>Keep one-line blocks</guilabel></term> + <listitem><para> + This keeps single line blocks together in some situations even if they exceed a fixed maximum line length. + </para></listitem> + </varlistentry> +</variablelist> +</listitem> +</varlistentry> +</variablelist> + + +</sect3> <!-- setup-format-other --> + +</sect2> <!-- setup-format --> + +<sect2 id="setup-snippets"> +<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. +</para> + +<screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="configure-snippets.png" format="PNG"/> + </imageobject> +<textobject><phrase>Configuring the code snippets tool</phrase></textobject> + <caption><para> + Configuring the Code Snippets tool + </para></caption> + </mediaobject> +</screenshot> + +<variablelist> +<varlistentry> +<term>Activate Snippet Preview</term> +<listitem> +<para>Mark the <guilabel>Show snippet's text in tooltip</guilabel> checkbox +if you want to view the stored text in a tooltip window whenever you keep +the mouse cursor over the title of that snippet.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Working with Snippet Variables</term> +<listitem> +<para>The <guilabel>Code Snippets</guilabel> tool allows for a variable text +in predefined places any time you insert a snippet into a file. To +accomplish this <guilabel>Code Snippets</guilabel> provides its own +variables' mechanism. You can set up it's behaviour in the +<guilabel>Variables</guilabel> group.</para> + +<variablelist> + <varlistentry> + <term><guilabel>Delimiter</guilabel></term> + <listitem><para> + The <guilabel>Code Snippets</guilabel> tool distinguishes variables in the text by surrounding the variable name with special delimiter symbols. To use your own delimiter symbol, change the predefined <guilabel>$</guilabel> character in the <guilabel>Delimiter</guilabel> field. + </para></listitem> + </varlistentry> + <varlistentry> + <term><guilabel>Input method for variables</guilabel></term> + <listitem><itemizedlist> + <listitem><para> + <guilabel>Single dialog for each variable within a snippet</guilabel> – will in turn pop up a separate dialog for each variable which the tool finds when inserting the selected code snippet. + </para></listitem> + <listitem><para> + <guilabel>One dialog for all variables within a snippet</guilabel> – will pop up a common dialog where the user has to fill in the values of all variables before the snippet will be inserted + </para></listitem> + </itemizedlist></listitem> + </varlistentry> +</variablelist> +</listitem> +</varlistentry> +</variablelist> + +</sect2> <!-- setup-snippets --> + +<sect2 id="setup-file-list"> +<title>File List</title> + +<para> +(... to be written ...) +</para> + +</sect2> <!-- setup-file-list--> + +<sect2 id="setup-file-selector"> +<title>Configuring the File Selector</title> + +<para> +&kdevelop; 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> + +<screenshot id="setup-fileselector-image"> + <mediaobject> + <imageobject> + <imagedata fileref="file-selector.png" format="PNG"/> + </imageobject> +<textobject><phrase>The file selector in IDEAl mode</phrase></textobject> + <caption><para> + The file selector (IDEAl mode) + </para></caption> + </mediaobject> +</screenshot> + +<para>The behaviour of the <guilabel>File Selector</guilabel> can be highly +configured. 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>File Selector</guilabel> in the left hand +tree. This will show the following dialog in the right hand side.</para> + + +<screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="configure-file-selector.png" format="PNG"/> + </imageobject> +<textobject><phrase>Configuring the file selector</phrase></textobject> + <caption><para> + Configuring the file selector + </para></caption> + </mediaobject> +</screenshot> + +<variablelist> +<varlistentry> +<term>Configuring the Toolbar</term> +<listitem> +<para>There is a toolbar on top of the <guilabel>File Selector</guilabel> +which can be configured as usual in the <guilabel>Toolbar</guilabel> +group.</para> + +<procedure id="setup-fileselector-add-action"> + <title>Add an Action to the Toolbar</title> + <step> + <para> + Select an item in the right hand <guilabel>Selected actions</guilabel> list after which the new action should be inserted. + </para> + </step> + <step> + <para> + Select the action to be inserted in the left hand <guilabel>Available actions</guilabel> list. + </para> + </step> + <step> + <para> + Click the right (upper) arrow between both lists. + </para> + <para>The action will be removed from the <guilabel>Available actions</guilabel> list and inserted into the <guilabel>Selected actions</guilabel> list below the selected item. + </para> + </step> +</procedure> + +<procedure> + <title>Remove an Action from the Toolbar</title> + <step> + <para> + Select the item to be removed in the right hand <guilabel>Selected actions</guilabel> list. + </para> + </step> + <step> + <para> + Click the left (lower) arrow between both lists. + </para> + <para>The selected item will be removed from the <guilabel>Selected actions</guilabel> list and put back into the <guilabel>Available actions</guilabel> list. + </para> + </step> +</procedure> + +<procedure> + <title>Reorder the Actions on the Toolbar</title> + <step> + <para> + Select the action to be moved in the right hand <guilabel>Selected actions</guilabel> list. + </para> + </step> + <step> + <para> + Click the up or down arrow to the right of this list. + </para> + <para>The selected item will be moved up or down the <guilabel>Selected actions</guilabel> list. + </para> + </step> +</procedure> +</listitem> +</varlistentry> + +<varlistentry> +<term id="setup-fileselector-autosync">Defining When the Contents Should +Change</term> +<listitem> +<para> +Updating the contents in the <guilabel>File Selector</guilabel> window takes time and resources, esp. when changing to another directory. Therefore <guilabel>File Selector</guilabel> is set up by default in such a way that its contents change only on demand, &ie; when you select another directory or when you explicitely want to refresh its contents. +</para> + +<note><para> +Click the <guilabel>Reload</guilabel> button in the toolbar to update the contents of the <guilabel>File Selector</guilabel>. This toolbar button is not available by default, however. You must <link linkend="setup-fileselector-add-action">insert it there</link> first. +</para></note> + +<para> +You can configure the <guilabel>File Selector</guilabel> to immediately reflect certain changes in your work. The settings in the <guilabel>Auto Synchronization</guilabel> group of the configuration dialog are responsible for this. +</para> + +<variablelist> + <varlistentry> + <term><guilabel>When a document becomes active</guilabel></term> + <listitem><para> + If you select this checkbox, the contents in the <guilabel>File Selector</guilabel> window will be updated whenever you go to another already open document, ⪚ when you click on the tab of the according edit window in IDEAl mode. If necessary the <guilabel>File Selector</guilabel> will switch to the directory this file belongs to and update the display to show the actual contents in there. + </para></listitem> + </varlistentry> + <varlistentry> + <term><guilabel>When a document is opened</guilabel></term> + <listitem><para> + If you select this checkbox, the contents in the <guilabel>File Selector</guilabel> window will be updated whenever a document will be opened, ⪚ by the <menuchoice><guimenu>File</guimenu><guimenuitem>Open</guimenuitem></menuchoice> menu. If necessary the <guilabel>File Selector</guilabel> will switch to the directory this file belongs to and update the display to show the actual contents in there. + </para></listitem> + </varlistentry> + <varlistentry> + <term><guilabel>When the file selector becomes visible</guilabel></term> + <listitem><para> + If you select this checkbox, the contents in the <guilabel>File Selector</guilabel> window will be updated whenever it gets visible again. If necessary it will switch to the directory the actual document belongs to and update the display to show the actual contents in there. + </para></listitem> + </varlistentry> +</variablelist> + +<para> +You may freely combine these settings to tailor the actualization behaviour of the <guilabel>File Selector</guilabel> to your liking. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Controlling the History in the Comboboxes</term> +<listitem> +<para>There are two comboboxes on top and bottom of the <guilabel>File +Selector</guilabel> contents window which control the directory to be +displayed (top combobox) and the filters to be applied to the file display +(bottom combobox). A history of the most recent settings is kept in the +selection field of each combobox. You can configure the number of history +entries as follows.</para> + +<variablelist> + <varlistentry> + <term><guilabel>Remember locations</guilabel></term> + <listitem><para> + Enter here the maximum number of directory selections the upper combobox shall remember. + </para></listitem> + </varlistentry> + <varlistentry> + <term><guilabel>Remember filters</guilabel></term> + <listitem><para> + Enter here the maximum number of filter definitions the lower combobox shall remember. + </para></listitem> + </varlistentry> + +<varlistentry> +<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. +</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. +</para></note> +</listitem> +</varlistentry> + + <varlistentry> + <term><guilabel>Restore location</guilabel></term> + <listitem> + <para> + Remove the checkbox mark here if you don't want the displayed location be remembered between sessions. + </para> + <note><para> + If you selected one of the <link linkend="setup-fileselector-autosync">automatic update</link> settings the displayed location might automatically change regardless what has been remembered from the recent session. + </para></note> + </listitem> + </varlistentry> + <varlistentry> + <term><guilabel>Restore filters</guilabel></term> + <listitem> + <para> + Remove the checkbox mark here if you don't want the filters applied to the display be remembered between sessions. + </para> + </listitem> + </varlistentry> +</variablelist> +</listitem> +</varlistentry> +</variablelist> + +</sect2> <!-- setup-file-selector --> + +<sect2 id="setup-cpp-generator"> +<title>C++ Class Generator</title> + +<para> +(... to be written ...) +</para> + +</sect2> <!-- setup-c++-generator--> + +<sect2 id="setup-formatting"> +<title>Formatting</title> + +<para> +(... to be written ...) +</para> + +</sect2> <!-- setup-formatting--> + +<sect2 id="setup-cpp-parsing"> +<title>C++ Parsing</title> + +<para> +(... to be written ...) +</para> + +</sect2> <!-- setup-c++-parsing--> + +</sect1> <!-- setup-general --> + +<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> + +<sect1 id="setup-docu"> +<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. +</para> + +<screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="documents-contents.png" format="PNG"/> + </imageobject> +<textobject><phrase>The &kdevelop; documentation window in IDEAl mode</phrase></textobject> + <caption><para> + The &kdevelop; 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. +</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. +</para> + +<para> +The thus displayed <link linkend="configure-docu-general">configuration page</link> shows three tabbed configuration dialog pages, namely: +</para> + +<simplelist> + <member><link linkend="setup-docu-general">Documentation Collections</link></member> + <member><link linkend="setup-docu-textsearch">Full Text Search</link></member> + <member><link linkend="setup-docu-other">Other</link></member> +</simplelist> + +<sect2 id="setup-docu-general"> +<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. +</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: +</para> +<simplelist> + <member><link linkend="setup-docu-general-qt">&Qt; Documentation Collection</link></member> + <member><link linkend="setup-docu-general-chm">CHM Documentation Collection</link></member> + <member><link linkend="setup-docu-general-dox">Doxygen Documentation Collection</link></member> + <member><link linkend="setup-docu-general-toc">&kdevelop; TOC Documentation Collection</link></member> + <member><link linkend="setup-docu-general-devhelp">Devhelp Documentation Collection</link></member> + <member><link linkend="setup-docu-general-custom">Custom Documentation Collection</link></member> +</simplelist> + +<para id="configure-docu-general"> +<screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="configure-docu-general.png" format="PNG"/> + </imageobject> +<textobject><phrase>Setting up documentation collections</phrase></textobject> + <caption><para> + Setting up documentation collections + </para></caption> + </mediaobject> +</screenshot> +</para> + +<sect3 id="setup-docu-general-common"> +<title>Common Documentation Setup Structure</title> + +<para> +All configurations pages on the <guilabel>Documentation</guilabel> tab use a common layout. You will find the currently available documentation items of this type listed on the open page to the left and a set of buttons to the right. +</para> + +<variablelist> +<varlistentry> +<term id="setup-docu-buttons">Buttons to Maintain Documentation List Contents</term> +<listitem> +<para> +There are three buttons available to maintain the contents of the documentation setup pages: +</para> + +<variablelist> + <varlistentry> + <term><guibutton>Add</guibutton></term> + <listitem> + <para>Opens a <guilabel>Documentation Catalog Properties</guilabel> dialog as shown below where you can select the source location of the documentation item to be added and name it.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><guibutton>Edit</guibutton></term> + <listitem> + <para>Opens a <guilabel>Documentation Catalog Properties</guilabel> dialog as shown below where you can change the source location of the documentation item previously selected in the list and rename it.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><guibutton>Remove</guibutton></term> + <listitem> + <para>Removes the selected documentation entry from the list.</para> + <note><para> + The entry will be removed from the list only. Actual documentation sources remain untouched. You will have to remove them explicitely by other means. + </para></note> + </listitem> + </varlistentry> +</variablelist> + +<screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="configure-docu-edit.png" format="PNG"/> + </imageobject> + <caption><para> + Add or change a documentation item + </para></caption> + </mediaobject> +</screenshot> + +<para> +The button to the right of the <guilabel>Location</guilabel> field opens a directory dialog whose entries usually will be filtered according to the file type of the selected configuration page. +</para> +<para> +The <guilabel>Title</guilabel> field may not be accessible, depending on the documentation type to be maintained. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="setup-docu-columns">Documentation List Structure</term> +<listitem> +<para> +Every documentation setup page shows the listed documentation items in a table with four columns: +</para> + +<variablelist> + <varlistentry> + <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. + </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. + </para></note> + </listitem> + </varlistentry> + <varlistentry> + <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. + </para> + <note> + <para> + The internal index will be built the first time the user selects the <guilabel>Index</guilabel> page. This will delay the first access noticeably, because the index will be read from disk and then cached. + </para> + <para> + All subsequent indexed searches will however use this chache and thus work significally faster. + </para> + </note> + </listitem> + </varlistentry> + <varlistentry> + <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. + </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. + </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. + </para> + </note> + </listitem> + </varlistentry> + <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. + </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. +</para></note> +</listitem> +</varlistentry> +</variablelist> + +</sect3> <!-- setup-docu-general-common --> + +<sect3 id="setup-docu-general-qt"> +<title>&Qt; Documentation Collections</title> + +<para> +On this configuration page all &Qt; documentation is set up. +</para> + +<screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="configure-docu-general.png" format="PNG"/> + </imageobject> +<textobject><phrase>Setting up the &Qt; documentation collection</phrase></textobject> + <caption><para> + Setting up the &Qt; documentation collection + </para></caption> + </mediaobject> +</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. +</para> + +<para> +If you have a non-standard installation, either there will be no information listed at all or the entries will possibly refer to improper locations (⪚ to another &Qt; installation available in your system). You may adjust the entries using the <link linkend="setup-docu-buttons">buttons</link> to the right of the list field. +</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. +</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. +</para> + +<para> +If you want to have some specific &Qt; documentation included in the search indexes or full text search use the <guilabel>Index</guilabel> and <guilabel>Search</guilabel>check boxes in the <link linkend="setup-docu-columns">setup table</link>. +</para> + +</sect3> <!-- setup-docu-general-qt --> + +<sect3 id="setup-docu-general-chm"> +<title>Setting Up the CHM Documentation Collection</title> + +<para> +On this configuration page you may collect documentation according to the &Microsoft; CHM help file standard. +</para> + +<screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="configure-docu-chm.png" format="PNG"/> + </imageobject> +<textobject><phrase>Setting up &Microsoft; CHM standard documentation files</phrase></textobject> + <caption><para> + Setting up &Microsoft; CHM standard documentation files + </para></caption> + </mediaobject> +</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. +</para> + +<para> +For more information on the format of &Microsoft; <filename>*.chm</filename> files see ⪚ PHP: Documentation - Extended CHM Format at <ulink url="http://de2.php.net/docs-echm.php">http://de2.php.net/docs-echm.php</ulink>. +</para> + +</sect3> <!-- setup-docu-general-chm --> + +<sect3 id="setup-docu-general-dox"> +<title>Documentation Generated by Doxygen</title> + +<para> +On this configuration page all &API; documentation generated by &doxygen; is set up. +</para> + +<screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="configure-docu-dox.png" format="PNG"/> + </imageobject> +<textobject><phrase>Setting up Doxygen generated &API; documentation</phrase></textobject> + <caption><para> + Setting up Doxygen generated &API; documentation + </para></caption> + </mediaobject> +</screenshot> + +<para> +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. +</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. +</para> + +<note><para> +The older &kde; <ulink url="http://sirtaj.net/projects/kdoc/">KDoc</ulink> generated &API; format is not directly supported any more. If you still want to use such documentation, you may add it on the <link linkend="setup-docu-general-custom">Custom Documentation Collection</link> page. +</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: +</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). + </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. + </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. +</para> + +<para> +You may add your own &API; documentation entries (⪚ from your current projects) by using the <link linkend="setup-docu-buttons">buttons</link> to the right. If you want to have them included in the indexed and/or full text search mark the <guilabel>Index</guilabel> or <guilabel>Search</guilabel> check boxes in the <link linkend="setup-docu-columns">setup table</link>. +</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. +</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: + </para> + <screenshot><mediaobject> + <imageobject> + <imagedata fileref="configure-adddialog-baselibs.png" format="PNG"/> + </imageobject> +<textobject><phrase>Adding a &kde; base &API; to the list</phrase></textobject> + <caption><para> + Adding a &kde; Base &API; to the list + </para></caption> + </mediaobject></screenshot> + <para> + (Of course you should replace the <filename class="directory">/home/dev/mykde-system/</filename> directory in the <guilabel>Location</guilabel> field example with the path to your &kde; installation.) + </para> +</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. +</para></note> + +</sect3> <!-- setup-docu-general-dox --> + +<sect3 id="setup-docu-general-toc"> +<title>Handling Structured Documentation (KDevelopTOC Files)</title> + +<para> +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. +</para> + +<screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="configure-docu-toc.png" format="PNG"/> + </imageobject> + <caption><para> + Providing KDevelopTOC structured documentation access + </para></caption> + </mediaobject> +</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>. +</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.) +</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. +</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. +</para></note> + +</sect3> <!-- setup-docu-general-toc --> + +<sect3 id="setup-docu-general-toc-files"> +<title>&kdevelop; 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. +</para> + +<para> +The rationale behind this is not only to locally navigate remote documentation without wasting net access ressources, but to provide the developer with easy, structured access to the documentation he/she needs. Using these tools one can access almost any local or remote documentation in a structured fashion even if the original is laid out flat or structured in another way. All that is needed is access to files and/or parts of files which are displayable by the Konqueror. +</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. +</para> + +<variablelist> +<varlistentry> +<term>Standard Directory of &kdevelop; 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. +</para> +</listitem> +</varlistentry></variablelist> + +<!-- FIXME: Lauri Watts (2005-05-03) This could be marked up a whole lot --> +<!-- more clearly with the sgmltags stuff. Making a note to do that once --> +<!-- this first revision is done. --> + +<variablelist id="toc-file-structure"> + <title>Basic Structure of &kdevelop; TOC Files</title> + <varlistentry> + <term>header</term> + <listitem> + <simplelist> + <member> + <computeroutput><!DOCTYPE kdeveloptoc></computeroutput> + </member> + <member> + <computeroutput><kdeveloptoc></computeroutput> + </member> + <member> + <emphasis>(title)</emphasis> + </member> + <member> + <emphasis>(base address)</emphasis> + </member> + <member> + <emphasis>(content structure)</emphasis> + </member> + <member> + <emphasis>(index structure)</emphasis> + </member> + <member> + <computeroutput></kdeveloptoc></computeroutput> + </member> + </simplelist> + <para> + 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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>title</term> + <listitem> + <simplelist> + <member> + <computeroutput><title></computeroutput> + <emphasis>(some title string)</emphasis> + <computeroutput></title></computeroutput> + </member> + </simplelist> + <para> + This is the title &kdevelop; 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. + </para></note> + </listitem> + </varlistentry> + <varlistentry> + <term>base address</term> + <listitem> + <simplelist> + <member> + <computeroutput><base href="</computeroutput> + <emphasis>(base document &URL;)</emphasis> + <computeroutput>"/></computeroutput> + </member> + </simplelist> + <para> + This &URL; points to the location where all files of this documentation are located. It will be prepended before each section &URL; in the following content structure list. So, if you ⪚ downloaded a documentation from a remote server, all you need to display the files from this new location is to change its <computeroutput><base></computeroutput> &URL;. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>content structure</term> + <listitem> + <simplelist> + <member> + <computeroutput><tocsect1 name="</computeroutput> + <emphasis>(section title)</emphasis> + <computeroutput>" url="</computeroutput> + <emphasis>(section &URL;)</emphasis> + <computeroutput>"></computeroutput> + </member> + <member>...</member> + <member> + <computeroutput><tocsectn name="</computeroutput> + <emphasis>(section title)</emphasis> + <computeroutput>" url="</computeroutput> + <emphasis>(section &URL;)</emphasis> + <computeroutput>"/></computeroutput> + </member> + <member>...</member> + <member> + <computeroutput></tocsect1></computeroutput> + </member> + </simplelist> + <para> + All remaining navigation and access information is stored in a series of nested <computeroutput><tocsecti></computeroutput> ... <computeroutput></tocsecti></computeroutput> pairs. Each <emphasis>i</emphasis> denotes a consecutive nesting level down to number <emphasis>n</emphasis> which will correspond to the finally displayed documentation section. + </para> + <para> + 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;. + </para> + <para> + The <computeroutput><tocsectn/></computeroutput> entry must have an <computeroutput>url=""</computeroutput> attribute whatsoever. + This final nested <computeroutput><tocsectn/></computeroutput> does not come in pairs but will immediately be closed by a <computeroutput>/</computeroutput> before the <computeroutput>></computeroutput> bracket. + </para> + <note><para> + Any address combined of base and section &URL; must point to some displayable text file. Usually this will be an HTML-structured file. It is possible to link to anchor marks within such an HTML file using the standard # notation of the format: <filename>/base-url/section-url#anchor-mark</filename>. + </para></note> + </listitem> + </varlistentry> + <varlistentry> + <term>index structure</term> + <listitem> + <simplelist> + <member> + <computeroutput><index></computeroutput> + </member> + <member> + <computeroutput><entry name="</computeroutput> + <emphasis>(index entry title)</emphasis> + <computeroutput>" url="</computeroutput> + <emphasis>(index section &URL;)</emphasis> + <computeroutput>"/></computeroutput> + </member> + <member> + <computeroutput></index></computeroutput> + </member> + </simplelist> + <para> + Index is a plain list of index entries - pairs of title and &URL;. Index is not mandatory. + </para> + </listitem> + </varlistentry> +</variablelist> +<!-- FIXME: End --> + +</sect3> <!-- setup-docu-general-toc-files --> + +<sect3 id="setup-docu-general-devhelp"> +<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. +</para> +<para> +You can control which DevHelp files should be accessible on the <guilabel>DevHelp Documentation Collection</guilabel> configuration page. +</para> + +<screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="configure-docu-devhelp.png" format="PNG"/> + </imageobject> + <caption><para> + Providing DevHelp documentation + </para></caption> + </mediaobject> +</screenshot> + +<para> +DevHelp files originally were accessible on the <ulink url="http://lidn.sourceforge.net/">LiDN</ulink> website, but this seems to be not maintained for some time now. More recent DevHelp documentation is available at the <ulink url="http://htmlhelp.berlios.de/books/devhelp.php">DevHelp Books Download</ulink> web page. +</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>. +</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. +</para> + +</sect3> <!-- setup-docu-general-devhelp --> + +<sect3 id="setup-docu-general-custom"> +<title>Setting Up Custom Documentation Collections</title> + +<para> +This is for your own purpose. You may add almost any documentation files here, provided they can be displayed by the &konqueror; plugins. +</para> + +<screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="configure-docu-custom.png" format="PNG"/> + </imageobject> + <caption><para> + Providing custom documentation + </para></caption> + </mediaobject> +</screenshot> + +<para> +Usually this collection will be empty at first &kdevelop; 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. +</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>. +</para> + +<note><para> +Custom documention cannot be indexed or searched. Thus the <guilabel>Index</guilabel> and <guilabel>Search</guilabel> check boxes have no effect here as shown above. +</para></note> + +</sect3> <!--- setup-docu-general-custom --> + +</sect2> <!-- setup-docu-general --> + +<sect2 id="setup-docu-textsearch"> +<title>Setting Up Text Search Indexes</title> + +<para> +(... to be written ...) +</para> + +<screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="configure-doctree-textsearch.png" format="PNG"/> + </imageobject> + <caption><para> + Setting up text search indexes + </para></caption> + </mediaobject> +</screenshot> + +</sect2> <!-- setup-docu-textsearch --> + +<sect2 id="setup-docu-other"> +<title>Other Documentation Configuration Settings</title> + +<para> +(... to be written ...) +</para> + +</sect2> <!-- setup-docu-other --> + +</sect1> <!-- setup-docu --> + +<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> + +<sect1 id="setup-advanced"> +<title>Advanced Configuration</title> + +<para> +(... to be written ...) +</para> + +<sect2 id="setup-plugins"> +<title>Plugin Tools</title> + +<para> +(... to be written ...) +</para> +</sect2> <!-- setup-plugins --> + +</sect1> <!-- setup-advanced --> + +</chapter> <!-- setup --> diff --git a/doc/kdevelop/split-source-header-navigate.png b/doc/kdevelop/split-source-header-navigate.png Binary files differnew file mode 100644 index 00000000..f4d72868 --- /dev/null +++ b/doc/kdevelop/split-source-header-navigate.png diff --git a/doc/kdevelop/split-source-header.png b/doc/kdevelop/split-source-header.png Binary files differnew file mode 100644 index 00000000..d57b306b --- /dev/null +++ b/doc/kdevelop/split-source-header.png diff --git a/doc/kdevelop/split-windows.png b/doc/kdevelop/split-windows.png Binary files differnew file mode 100644 index 00000000..3ebb79f5 --- /dev/null +++ b/doc/kdevelop/split-windows.png diff --git a/doc/kdevelop/split-workspace.png b/doc/kdevelop/split-workspace.png Binary files differnew file mode 100644 index 00000000..d497ab49 --- /dev/null +++ b/doc/kdevelop/split-workspace.png diff --git a/doc/kdevelop/survey-manual.docbook b/doc/kdevelop/survey-manual.docbook new file mode 100644 index 00000000..d9611a03 --- /dev/null +++ b/doc/kdevelop/survey-manual.docbook @@ -0,0 +1,228 @@ +<chapter id="survey-manual"> +<title>What This Manual Contains</title> + +<para> +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. +</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> +<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> +<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 +look and feel of this &IDE;.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><link linkend="setup">Configuring &kdevelop;</link></term> +<listitem> +<para>Shows how you can tailor the &IDE; to suit your needs.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><link linkend="applicationwizard">Getting started: the +&appwizard;</link></term> +<listitem> +<para>Describes the basics of how to set up a new project in &kdevelop; +using the built-in &appwizard;.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><link linkend="editing">Editing tools</link></term> +<listitem> +<para>All you need to write your source files: using the editor, searching +for text both locally and project-wide, up to integrating new files and +classes into the project.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><link linkend="file-browsers">The File Browsers</link></term> +<listitem> +<para>Demonstrates various tools to look at the structure of your project +and how to access the files you want to work with.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><link linkend="class-browsers">The Class Browsers</link></term> +<listitem> +<para>Describes one of the most powerful tools of &kdevelop; which lets you +navigate through class dependencies and allows you to easily create and +access the classes and methods you need. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><link linkend="documentation">Documentation</link></term> +<listitem> +<para>Shows how to access the rich built-in documentation &kdevelop; +provides and tells you how to create documentation of your project, concise +and powerful &API; documentation providing you an overall view of all your +project sources as well as docbook-based user documentation.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><link linkend="project-management">Building and Project + Management</link></term> +<listitem> +<para>Deals with the creation and management of your project; describing the +basics of autoconf and automake as well as how to set up custom make files +and how to use compiler or make options to tailor your application to suit +your needs.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><link linkend="adv-build-management">Advanced Build + Management</link></term> +<listitem> +<para>Looks at ways to keep multiple build configurations, to cross-compile +for diverse platforms, or to make an embedded system using the +<application>Qt/embedded</application> library.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><link linkend="debugger">The Debugger Interface</link></term> +<listitem> +<para>Describes how to use the integrated <application>gdb</application> +debugger interface so you can hunt down bugs without leaving +&kdevelop;.</para> +</listitem> +</varlistentry> + +<!-- ### Currently disabled. Probably too specialized programming stuff. Check later again. + <listitem><para> + <link linkend="python">Python</link> — an overview of how to create Python-based applications in &kdevelop;. + </para></listitem> + <listitem><para> + <link linkend="php">PHP</link> — an overview of how to create PHP-based HTML applications in &kdevelop;. + </para></listitem>//--> + +<varlistentry> +<term><link linkend="cvs">Using CVS</link></term> +<listitem> +<para>Tells you how you can maintain your project using the CVS versioning +system; a must, especially if many developers work on the same +project.</para> +</listitem> +</varlistentry> +</variablelist> + +<!-- + <listitem><para> + <link linkend="kdevelop-scripting">Scripting &kdevelop;</link> — describes how to add scripts to automate &kdevelop;. + </para></listitem> + + + <listitem><para> + Some commonly used information has been put into the <emphasis>appendix</emphasis>. Amongst others this consists of: +--> +<para> +Some commonly used information has been put into the <emphasis>appendix</emphasis>. Amongst others this consists of: +</para> + +<variablelist> +<varlistentry> +<term><link linkend="kdevelop-install">Installing &kdevelop;</link></term> +<listitem> +<para>Tells you where to obtain &kdevelop; and how to get it up and +running.</para> +</listitem> +</varlistentry> +</variablelist> + +<variablelist> +<varlistentry> +<term><link linkend="nutshell">In a Nutshell — Tips and +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> +</listitem> +</varlistentry> + +<varlistentry> +<term><link linkend="unixdev">Development on &UNIX;</link></term> +<listitem> +<para>A historical overview of &UNIX; program development, the main tools +necessary and why you need an &IDE;.</para> +</listitem> +</varlistentry> + +<!-- + <listitem><para> + <link linkend="app-menus">Menus and Toolbars Overview</link> — provides you with a short overall view of the menu and toolbar selections available. + </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. + </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 + information. This is particularly useful in case something went wrong with + your setup.</para> +</listitem> +</varlistentry> + +<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. +</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. + </para></listitem> +--> +<varlistentry><term> +<link linkend="app-uimodes-examples">KDevelop User Interface Mode Examples </link> +</term><listitem><para>Shows user interface modes. +</para></listitem></varlistentry> + +<varlistentry><term> +<link linkend="app-misc-info">Further Information </link> </term><listitem><para> +Getting Information, reporting Bugs etc. +</para></listitem></varlistentry> + +<varlistentry><term> +<link linkend="app-changelog">Changelog </link> +</term><listitem><para>Shows the history of this documentation. +</para></listitem></varlistentry> + +<varlistentry><term> +<link linkend="app-bibliography">Bibliography </link> +</term><listitem><para>Bibliography +</para></listitem></varlistentry> + +</variablelist> + <!-- + <listitem><para> + <link linkend="documentation-index">Index </link> — + </para></listitem> +--> + + +</chapter> diff --git a/doc/kdevelop/tutorial-debug-tree.png b/doc/kdevelop/tutorial-debug-tree.png Binary files differnew file mode 100644 index 00000000..23c7f2c6 --- /dev/null +++ b/doc/kdevelop/tutorial-debug-tree.png diff --git a/doc/kdevelop/tutorial-hello-new.png b/doc/kdevelop/tutorial-hello-new.png Binary files differnew file mode 100644 index 00000000..abbb912d --- /dev/null +++ b/doc/kdevelop/tutorial-hello-new.png diff --git a/doc/kdevelop/tutorial-hello-options.png b/doc/kdevelop/tutorial-hello-options.png Binary files differnew file mode 100644 index 00000000..7b9d98cd --- /dev/null +++ b/doc/kdevelop/tutorial-hello-options.png diff --git a/doc/kdevelop/tutorial-new-project.png b/doc/kdevelop/tutorial-new-project.png Binary files differnew file mode 100644 index 00000000..8f3aa78d --- /dev/null +++ b/doc/kdevelop/tutorial-new-project.png diff --git a/doc/kdevelop/unixdev.docbook b/doc/kdevelop/unixdev.docbook new file mode 100644 index 00000000..d7881afb --- /dev/null +++ b/doc/kdevelop/unixdev.docbook @@ -0,0 +1,386 @@ +<appendix id="unixdev"> + +<appendixinfo> + <authorgroup> + <author><firstname>Bernd</firstname><surname>Pol</surname></author> + <!-- ROLES_OF_TRANSLATORS --> + </authorgroup> +</appendixinfo> + +<title>Development on &UNIX;</title> + +<indexterm zone="unixdev"><primary>development</primary></indexterm> +<indexterm zone="unixdev"> + <primary>&UNIX;</primary> + <secondary>development</secondary></indexterm> + +<sect1 id="history"> +<title>Some Historical Remarks</title> + +<indexterm zone="history"><primary>history</primary></indexterm> +<indexterm zone="history"><primary>scripting languages</primary></indexterm> +<indexterm zone="history"> + <primary>&UNIX;</primary> + <secondary>history</secondary></indexterm> +<indexterm zone="history"> + <primary>&UNIX;</primary> + <secondary>pipe</secondary></indexterm> +<indexterm zone="history"> + <primary>&UNIX;</primary> + <secondary>shell</secondary></indexterm> +<indexterm zone="history"> + <primary>shell</primary> + <secondary>&UNIX;</secondary></indexterm> + +<para> +From the beginning, &UNIX; has maintained two very different development paradigms. One is the world of <emphasis>system and application programming languages</emphasis>, where some source code is translated to machine code by a translation program, usually a <emphasis>compiler</emphasis> or an <emphasis>interpreter</emphasis>. The programming language C is an example. &UNIX; was the first operating system kernel to be written in such a high level language instead of tightly machine-oriented assembler which was common before that time. (In fact, the C language once even was invented to write the &UNIX; kernel and associated programs on a DEC PDP-11 computer.) +</para> +<para> +The other paradigm is the world of <emphasis>scripting languages</emphasis>. This world evolved with the invention of the &UNIX; shell which was the user's interface to the operating system—and at the same time a very high level programming language. A shell script is built from a set of small utility programs like ⪚ <command>grep</command>, <command>sed</command>, or <command>find</command>. Each such utility is designed for some tightly defined job. The trick is that any such utility can be connected to another one via a simple transport mechanism, called a <emphasis>pipe</emphasis>, which directs the output of the foregoing utility into the input of the next processed one. This makes for a very powerful and highly flexible programming tool. +</para> +<para> +As time has gone by, both worlds have evolved. While C is still used mainly as a system programming language, C++ as a variant of C enriched by object-oriented and generic extensions has found its place for the development of complex applications in the 1990's. There are numerous other programming languages, even older ones keep their place—FORTRAN77 and Ada ⪚ still have their stronghold in numerical applications. +</para> +</sect1> <!-- history --> + +<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> + +<sect1 id="unixdev-scripting-languages"> +<title>Contemporary Scripting Languages</title> +<para> +In the scripting area, there has been a shift away from the shell, which suffers from portability concerns, to languages which unify all commonly needed functionality in their standard libraries, while still being able to interface to the outside through pipes when necessary. +</para> +<para> +All these scripting languages have in common that they are widely portable between &UNIX; variants, Microsoft &Windows;, &MacOS; or even VMS. Also, they all have implementations that are freely distributable. +</para> + +<sect2 id="unixdev-SL-Perl"> +<title>&perl;</title> + +<indexterm zone="unixdev-SL-Perl"><primary>Perl</primary></indexterm> +<indexterm zone="unixdev-SL-Perl"> + <primary>scripting languages</primary> + <secondary>Perl</secondary></indexterm> + +<para> +<ulink url="http://www.perl.com">&perl;</ulink> has become popular as a text processing and system administration language. In the beginning of the World Wide Web, CGI scripts written in &perl; were a widely used method to create dynamic web pages from databases. Today, this method has been replaced mostly by the <command>mod_perl</command> plugin for the &apache; web server. Among &perl;'s strengths are its built-in support for advanced regular expression matching and its rich archive of freely distributed modules. +</para> +<para> +For more information see the <ulink url="http://cpan.org">Comprehensive Perl Archive Network (<acronym>CPAN</acronym>)</ulink> website. +</para> +</sect2> <!-- unixdev-SL-Perl --> + +<sect2 id="unixdev-SL-Python"> +<title>Python</title> + +<indexterm zone="unixdev-SL-Python"><primary>Python</primary></indexterm> +<indexterm zone="unixdev-SL-Python"> + <primary>scripting languages</primary> + <secondary>Python</secondary></indexterm> + +<para> +<ulink url="http://www.python.org">&python;</ulink> shines by the elegance of its class system and the ease and flexibility with which external libraries can be wrapped in a way that they appear like standard &python; classes and functions. In contrast to &perl;, &python; has a clear and concise embedding &API;, which makes it the language of choice for making C and C++ programs scriptable. +</para> +</sect2> <!-- unixdev-SL-Python --> + +<sect2 id="unixdev-SL-PHP"> +<title>PHP</title> + +<indexterm zone="unixdev-SL-PHP"><primary>PHP</primary></indexterm> +<indexterm zone="unixdev-SL-PHP"> + <primary>scripting languages</primary> + <secondary>PHP</secondary></indexterm> + +<para> +<ulink url="http://www.php.net">&php;</ulink> was invented as a language directly embeddable into &HTML; pages and consequently has its main uses in delivering dynamic content on the web. +</para> +</sect2> <!-- unixdev-SL-PHP --> +</sect1> <!-- unixdev-scripting-languages --> + +<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> +<sect1 id="unixdev-hl-script"> +<title>Higher-level Scripting</title> + +<para> +Higher-level &UNIX; applications usually miss the speed and flexibility of the traditional character-oriented shell scripting mechanisms. This is especially true in the world of graphical user interfaces (&GUI;) such as ⪚ &kde;. +</para> +<para> +There have been attempts to provide similar mechanisms which will work on a higher application level, most notably <link linkend="unixdev-corba">CORBA</link> and, in the &kde; environment, <link linkend="unixdev-dcop">&DCOP;</link>. +</para> + +<sect2 id="unixdev-corba"> +<title>The CORBA Protocol</title> + +<indexterm zone="unixdev-corba"><primary>CORBA</primary></indexterm> +<indexterm zone="unixdev-corba"> + <primary>scripting languages</primary> + <secondary>CORBA</secondary></indexterm> +<indexterm zone="unixdev-corba"> + <primary>communication</primary> + <secondary>CORBA</secondary></indexterm> + +<para> +<ulink url="http://www.omg.org/gettingstarted/corbafaq.htm">CORBA</ulink> (<emphasis>Common Object Request Broker Architecture</emphasis>) is an attempt to let computer applications work together over networks. It was devised by the private, vendor independent <ulink url="http://www.omg.org">OMG</ulink> (Object Management Group) standards comittee. +</para> +<para> +CORBA-based programs use the IIOP standard protocol to communicate. Implementations based on IIOP are available on a wide variety of operating systems, programming languages, and networks and are thus highly portable. +</para> +<para> +The main drawback of CORBA is its rather low speed. While this may be tolerable in networks, it is a real hindrance for inter-application communications in a non-networked environment such as &kde; running on a single computer. +</para> + +</sect2> <!-- unixdev-corba --> + +<sect2 id="unixdev-dcop"> +<title>The &DCOP; Interface</title> + +<indexterm zone="unixdev-dcop"><primary>DCOP</primary></indexterm> +<indexterm zone="unixdev-dcop"> + <primary>scripting languages</primary> + <secondary>DCOP</secondary></indexterm> +<indexterm zone="unixdev-dcop"> + <primary>communication</primary> + <secondary>DCOP</secondary></indexterm> + +<para> +Another evolution on &UNIX;-like scripting is the <ulink url="http://developer.kde.org/documentation/library/kdeqt/dcop.html"><emphasis>DCOP</emphasis></ulink> protocol which was devised for communication between &kde; applications to overcome the limitations of CORBA. +</para> +<para> +&DCOP; stands for <emphasis>Desktop Communication Protocol</emphasis> and is implemented as a simple IPC/RPC mechanism built to operate over sockets. In effect this provides facilities similar to the traditional &UNIX; pipe mechanism. +</para> +<para> +Traditional shell scripting is based on fairly small tool programs which were designed to work on a strictly textual basis. &DCOP; allows elaborate graphical programs to communicate with each other in a quite similar way. This enables ⪚ a &kde; program to send messages to another &kde; program, or receive data from it for its own purposes. +</para> +<para> +There are drawbacks, however. To use &DCOP; a program must be designed to contain a special &DCOP; interface. And the &DCOP; communication process runs somewhat slowly (although a lot faster than CORBA). But it returns much of the power and flexibility of &UNIX; scripting to high-level programs which are based on a graphical user interface. +</para> +<para> +For more information, see the <ulink url="http://developer.kde.org/documentation/library/kdeqt/dcop.html">DCOP: Desktop COmmunications Protocol</ulink> paper or <ulink url="developer.kde.org/documentation/library/cvs-api/dcop/html/index.html">The &DCOP; Desktop Communication Protocol library</ulink> &API; reference of the &kde; dcop library. +</para> +</sect2> <!-- unixdev-dcop --> + +</sect1> <!-- unixdev-hl-script --> + +<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> + +<sect1 id="unixdev-buildsystems"> +<title>Build Systems</title> + +<para> +Except in very simple cases a programming project will consist of a lot of building blocks of source code each put into a separate file for easier maintenance. To make this running one has to effectively translate all this stuff into a few machine language units in a suiting format which allows the operating system to load and execute the program. +</para> +<para> +To accomplish this, the basic tools needed are +<itemizedlist> + <listitem><para> + a <emphasis>text editor</emphasis> to write the source code files, + </para></listitem> + <listitem><para> + a translating program, usually a <emphasis>compiler</emphasis> to turn the source code into object files, + </para></listitem> + <listitem><para> + a <emphasis>librarian</emphasis> which collects object files into libraries to reuse them easily without the need to recompile, + </para></listitem> + <listitem><para> + a <emphasis>linker</emphasis> which binds several object files and libraries together into one executable, + </para></listitem> + <listitem><para> + a <emphasis>make system</emphasis> which provides some means to manage all this stuff and—not to forget + </para></listitem> + <listitem><para> + a <emphasis>debugger</emphasis> to (hopefully) find all errors in the program and possibly some other diagnostic tools to get everything running smoothly. + </para></listitem> +</itemizedlist> +</para> + +<para> +When you have a large project consisting of possibly hundreds of source code files, the process of compiling may become quite laborsome. You do not want to recompile all files each time you have changed only some of them. Instead, you only want to compile those files which are affected by the changes. In general, it is not always easily obvious which of the files have to be recompiled. +</para> +<para> +When you ⪚ change a function prototype in a header file, you need to compile every file which includes this header file. If your project contains many such files you may easily miss one or two of them if you have to do the job manually. Thus some means of automization is necessary. +</para> + +<sect2 id="unixdev-buildsystems-make"> +<title>The Make Process</title> + +<indexterm zone="unixdev-buildsystems-make"> + <primary>make</primary></indexterm> +<indexterm zone="unixdev-buildsystems-make"> + <primary>Makefile</primary></indexterm> +<indexterm zone="unixdev-buildsystems-make"> + <primary>rule</primary></indexterm> +<indexterm zone="unixdev-buildsystems-make"> + <primary>recompilations</primary></indexterm> +<indexterm zone="unixdev-buildsystems-make"> + <primary>target</primary></indexterm> +<indexterm zone="unixdev-buildsystems-make"> + <primary>dependencies</primary></indexterm> +<indexterm zone="unixdev-buildsystems-make"> + <primary>commands</primary></indexterm> + +<para> +A tool which takes care of recompilations is <command>make</command>. It keeps track of all work using a set of <emphasis>rules</emphasis> which describe what to do in case some piece of information (usually a source or object code file) was changed. All rules belonging to a certain project are stored in a so-called <filename>Makefile</filename> which is processed by <command>make</command> any time you want to update your work. +</para> +<para> +Each rule consists of several building blocks, namely +<itemizedlist> + <listitem><para> + a <emphasis>target</emphasis>, &ie; the file to be built + </para></listitem> + <listitem><para> + a set of <emphasis>dependencies</emphasis>, basically the names of those files the target depends on (⪚ the name of a source file, where then the target will be the name of the object file to be built) and + </para></listitem> + <listitem><para> + the <emphasis>commands</emphasis> which are to be executed to <quote>make</quote> the target (&ie; to compile it or to link other object files together to build an executable progam file). + </para></listitem> +</itemizedlist> +</para> +<para> +Basically the <command>make</command> command will read the rules one after another, check each file in the dependency list of a given target and make this target anew if any one of these files has changed, using the commands listed in that rule. +</para> +<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. +</para> +<para> +There are several tutorials available, see the <link linkend="automake-references">references</link> in the Building and project management chapter. +</para> +</sect2> <!-- unixdev-buildsystems-make --> + +</sect1> <!-- unixdev-buildsystems --> + +<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> + +<sect1 id="unixdev-guidevelopment"> +<title>&GUI; Development</title> + +<indexterm zone="unixdev-guidevelopment"> + <primary>GUI</primary></indexterm> +<indexterm zone="unixdev-guidevelopment"> + <primary>graphical user interface</primary></indexterm> +<indexterm zone="unixdev-guidevelopment"> + <primary>user interface</primary> + <secondary>GUI</secondary></indexterm> + +<para> +Application developers become even more encumbered by having not only to create program libraries and logic, but also to provide an easy to use custom built user interface that is both intuitive and functional. Most programmers receive little to no training in &GUI; development, and as a result user interfaces often are poorly designed. +</para> +<para> +During the years some common design principles have evolved. It is strongly advised to adhere to them. This way your user interfaces will retain a common look and feel that the users of your application will gratefully appreciate. +</para> +<para> +For &kde; &GUI; development there is a style guide available. It is found in the <ulink url="http://developer.kde.org/documentation/standards/kde/style/basics/index.html">&kde; User Interface Guidelines</ulink> on the &kde; Developer's Corner page. +</para> +<para> +A short introduction to common &GUI; design principles can be found <ulink url="http://axp16.iie.org.mx/Monitor/v01n03/ar_ihc2.htm">here</ulink>. +</para> + +</sect1> <!-- unixdev-guidevelopment --> + +<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> + +<sect1 id="unixdev-ide"> +<title>Integrating Concepts and Tools – the IDE</title> + +<indexterm zone="unixdev-ide"> + <primary>IDE</primary></indexterm> +<indexterm zone="unixdev-ide"> + <primary>integrated development environment</primary></indexterm> +<indexterm zone="unixdev-ide"> + <primary>development</primary> + <secondary>IDE</secondary></indexterm> +<indexterm zone="unixdev-ide"> + <primary>environment</primary> + <secondary>IDE</secondary></indexterm> + +<para> +There are separate tools available for almost any step in the programming process—planning, editing, managing files and compilation processes, debugging, documentation and the like. But once the projects grow the programming processes will most likely become quite cumbersome. +</para> +<para> +Much repetitive work has to be done when designing, compiling, and debugging a program. A lot of such work can be saved through the use of templates and scripts. And another lot by keeping these tools easily available and able to communicate with each other under a common &GUI;. +</para> +<para> +For example—would it not be convenient if a debugger were able to open the source file in question in an editor and place the cursor directly at the position of that bug just found? +</para> +<para> +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. +</para> + +<sect2 id="unixdev-ide-kdevelop"> +<title>Basic Features of &kdevelop; &kdevrelease;</title> + +<indexterm zone="unixdev-ide-kdevelop"> + <primary>&kdevelop;</primary> + <secondary>features</secondary></indexterm> +<indexterm zone="unixdev-ide-kdevelop"> + <primary>features</primary></indexterm> + +<!-- ### copied from web page, needs to be updated --> + +<itemizedlist> + <listitem> + <para>Manages all <emphasis>development tools</emphasis> needed for C++ programming, such as compiler, linker, debugger and build system.</para> + </listitem> + <listitem> + <para>Provides an <emphasis>&appwizard;</emphasis> which generates complete, ready-to-go sample applications.</para> + </listitem> + <listitem> + <para>Allows the user to select an <emphasis>integrated editor</emphasis> based on the &kde; programmer's editor &kwrite;, Trolltec's <application>QEditor</application>, or others.</para> + </listitem> + <listitem> + <para>A <emphasis>class generator</emphasis>, for creating new classes and integrating them into the current project.</para> + </listitem> + <listitem> + <para><emphasis>File management</emphasis> for sources, headers, documentation &etc; to be included in the project.</para> + </listitem> + <listitem> + <para>Assistance in <emphasis>creating application user manuals</emphasis> written with &kde; tools.</para> + </listitem> + <listitem> + <para>Automatic &HTML; based <emphasis>&API; documentation</emphasis> for a project's classes with cross-references to the used libraries.</para> + </listitem> + <listitem> + <para><emphasis>Internationalization support</emphasis>, allowing translators to add their target language to a project easily, including support for &kbabel;.</para> + </listitem> + <listitem> + <para>Support for managing a project via one of several <emphasis>versioning systems</emphasis> (⪚ &CVS;) by providing an easy-to-use frontend for the most needed functions.</para> + </listitem> + <listitem> + <para>An integrated <emphasis>debugger</emphasis> frontend.</para> + </listitem> + <listitem> + <para>An integrated <emphasis>shell console</emphasis> emulator.</para> + </listitem> + <listitem> + <para><emphasis>Syntax highlighting</emphasis> in source texts.</para> + </listitem> + <listitem> + <para>An <emphasis>auto-code completion</emphasis> facility for class variables, class methods, function arguments and more.</para> + </listitem> + <listitem> + <para><emphasis>Templates for creating various projects</emphasis> (&kcontrol; modules, &kicker; (panel) applets, KIOSlaves, &konqueror; plugins and desktop styles).</para> + </listitem> + <listitem> + <para>Four <emphasis>navigation tree views</emphasis> for easily switching between source files, header files, classes and documentation, obviating the need for an external file manager.</para> + </listitem> + <listitem> + <para><emphasis>Cross-compiling support</emphasis>, with the ability to specify different compilers, compiler flags, target architecture, &etc;</para> + </listitem> + <listitem> + <para>Support for <emphasis>Qt/Embedded projects</emphasis> (such as the Zaurus and iPAQ).</para> + </listitem> + <listitem> + <para><emphasis>Inclusion of any other program</emphasis> you need for development by adding it to the <guimenuitem>Tools</guimenuitem> menu according to your individual needs.</para> + </listitem> +</itemizedlist> + +</sect2> <!-- unixdev-ide-kdevelop --> + +</sect1> <!-- unixdev-ide --> + +</appendix> <!-- unixdev --> + diff --git a/doc/kdevelop/wrong-project-location.png b/doc/kdevelop/wrong-project-location.png Binary files differnew file mode 100644 index 00000000..cb9c45a2 --- /dev/null +++ b/doc/kdevelop/wrong-project-location.png |
