On installation, &tdevelop; writes some default information files for setup and configuration purposes into subdirectories of the <filename class="directory">$<envar>KDEDIR</envar></filename> installation directory (usually something like <filename class="directory">/opt/kde</filename>, <filename class="directory">/usr/local/kde</filename>, or some other user-defined installation directory, see <link linkend="tdevelop-install">Installing &tdevelop;</link>).
On installation, &tdevelop; writes some default information files for setup and configuration purposes into subdirectories of the <filename class="directory">$<envar>TDEDIR</envar></filename> installation directory (usually something like <filename class="directory">/opt/kde</filename>, <filename class="directory">/usr/local/kde</filename>, or some other user-defined installation directory, see <link linkend="tdevelop-install">Installing &tdevelop;</link>).
</para>
<sect2 id="app-files-default-config">
<title>Default &tdevelop; Configuration</title>
<para>
There is only one &tdevelop; specific default configuration file in the <filename class="directory">$<envar>KDEDIR</envar>/share/config/</filename> directory:
There is only one &tdevelop; specific default configuration file in the <filename class="directory">$<envar>TDEDIR</envar>/share/config/</filename> directory:
</para>
<variablelist>
<varlistentry>
<term><filename>tdeveloprc</filename></term>
<listitem><para>
This file contains the basic settings &tdevelop; needs to start. It will be copied to the user's <filename class="directory">$<envar>KDEHOME</envar>/share/config</filename> directory when &tdevelop; does not find a <filename>tdeveloprc</filename> file there on startup.
This file contains the basic settings &tdevelop; needs to start. It will be copied to the user's <filename class="directory">$<envar>TDEHOME</envar>/share/config</filename> directory when &tdevelop; does not find a <filename>tdeveloprc</filename> file there on startup.
</para></listitem>
</varlistentry>
</variablelist>
@ -52,11 +52,11 @@ There is only one &tdevelop; specific default configuration file in the <filenam
<title>Application Specific Defaults</title>
<para>
Most &tdevelop; features are provided by KParts. These are basically applications specially designed to run in the &tdevelop; framework (see the overview in the <link linkend="plugin-tools">Plugin Tools</link> appendix). Each KPart application has its own set of configuration files whose defaults will be stored in several subdirectories of the <filename class="directory">$<envar>KDEDIR</envar>/share/apps/</filename> installation directory.
Most &tdevelop; features are provided by KParts. These are basically applications specially designed to run in the &tdevelop; framework (see the overview in the <link linkend="plugin-tools">Plugin Tools</link> appendix). Each KPart application has its own set of configuration files whose defaults will be stored in several subdirectories of the <filename class="directory">$<envar>TDEDIR</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 &tdevelop; internal use only. They might be deliberately grouped for readability as:
There are quite a lot of default configuration subdirectories in <filename class="directory">$<envar>TDEDIR</envar>/share/apps/</filename> whose names all start with a <filename>kdev</filename> sequence. Most of them are for &tdevelop; internal use only. They might be deliberately grouped for readability as:
<member><link linkend="app-files-default-apps-task">Task Specific Parts</link></member>
@ -201,10 +201,10 @@ There are quite a lot of default configuration subdirectories in <filename class
<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:
All information about user defined settings is kept in two subdirectories of <filename class="directory">$<envar>TDEHOME</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>
<member><link linkend="app-files-user-apps">Application Specific Configuration</link> in the <filename class="directory">$<envar>TDEHOME</envar>/share/apps/</filename> directory, and</member>
<member><link linkend="app-files-user-config">Resource Configuration File</link> in the <filename class="directory">$<envar>TDEHOME</envar>/share/config/</filename> directory.</member>
</simplelist>
</para>
@ -212,13 +212,13 @@ All information about user defined settings is kept in two subdirectories of <fi
<title>Application Specific Configuration</title>
<para>
Any user changes to the <link linkend="app-files-default">&tdevelop; Default Configuration</link> settings as well as user specific settings which are not kept in any of the <link linkend="app-files-user-config">Resource Configuration Files</link> are found in <filename>kdev...</filename> subdirectories of the <filename class="directory">$<envar>KDEHOME</envar>/share/apps/</filename> directory.
Any user changes to the <link linkend="app-files-default">&tdevelop; Default Configuration</link> settings as well as user specific settings which are not kept in any of the <link linkend="app-files-user-config">Resource Configuration Files</link> are found in <filename>kdev...</filename> subdirectories of the <filename class="directory">$<envar>TDEHOME</envar>/share/apps/</filename> directory.
</para>
<para>
Most of these configuration files are however used by various &tdevelop; plugins in order to provide some specific menu and/or toolbar entries. Thus they are of interest only in case something went really wrong with the user interface.
</para>
<note><para>
In case the contents of these directories mirror those of the Default Configuration settings, &tdevelop; will have copied them from <filename class="directory">$<envar>KDEDIR</envar>/apps/</filename> into the <filename class="directory">$<envar>KDEHOME</envar>/apps/</filename> directory on its initial start. Any subsequent changes will be made to these copies only. The Default Configuration settings remain unchanged in any case.
In case the contents of these directories mirror those of the Default Configuration settings, &tdevelop; will have copied them from <filename class="directory">$<envar>TDEDIR</envar>/apps/</filename> into the <filename class="directory">$<envar>TDEHOME</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>
@ -270,7 +270,7 @@ In case the contents of these directories mirror those of the Default Configurat
</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>
<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>TDEHOME</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 &tdevelop; <guilabel>Documentation</guilabel> plugin.</para>
@ -345,7 +345,7 @@ In case the contents of these directories mirror those of the Default Configurat
<title>Resource Configuration Files</title>
<para>
There are two groups of &tdevelop; configuration files in the <filename class="directory">$<envar>KDEHOME</envar>/share/config/</filename> directory, distiguished by their surrounding character sequences:
There are two groups of &tdevelop; configuration files in the <filename class="directory">$<envar>TDEHOME</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 &tdevelop;</link> itself and its available plugins.</member>
@ -356,7 +356,7 @@ There are two groups of &tdevelop; configuration files in the <filename class="d
<title>Configuration Files Used by &tdevelop;</title>
<listitem>
<para><filename>kdevabbrevrc</filename> — holds the current state of the <guilabel>Abbreviations</guilabel> configuration provided by the <guilabel>Abbreviation Expansion</guilabel> plugin.</para>
<note><para>This only records whether the abbreviations will be used or not. The actual definitions of new abbreviations will go into the <filename>$<envar>KDEHOME</envar>/share/apps/kdevabbrev/templates/templates</filename> file.</para></note>
<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>TDEHOME</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 &tdevelop; Assistant documentation browser.</para>
@ -416,7 +416,7 @@ Both are &XML; coded files. They can be viewed and (cautiously) altered using an
</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.
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>TDEHOME</envar>/share/apps/kdevcppsupport/pcs/</filename> directory.
@ -1600,7 +1600,7 @@ In short, such an &API; documents the interface to certain library functions. Th
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/tdelibs-apidocs</filename> for an example of such a &doxygen; &API; documentation layout.
You may have a look at <filename class="directory">$<envar>TDEDIR</envar>/share/doc/HTML/en/tdelibs-apidocs</filename> for an example of such a &doxygen; &API; documentation layout.
</para>
<note><para>
@ -1621,7 +1621,7 @@ The older &kde; <ulink url="http://sirtaj.net/projects/kdoc/">KDoc</ulink> gener
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/tdelibs-apidocs/</filename> was found at the first &tdevelop; startup.
Or as a last resort the <filename class="directory">$<envar>TDEDIR</envar>/share/doc/HTML/en/tdelibs-apidocs/</filename> was found at the first &tdevelop; startup.
</para></listitem>
</itemizedlist>
@ -1720,7 +1720,7 @@ Such structured access is made possible through the use of special <quote>table
<term>Standard Directory of &tdevelop; TOC Files</term>
<listitem>
<para>
When &tdevelop; was installed usually a series of predefined <filename>.toc</filename> files has been put into the <filename class="directory">$KDEDIR/share/apps/kdevdocumentation/tocs</filename> directory. These are fairly simple, structured text files. You may look at them using a text editor or other text display facility.
When &tdevelop; was installed usually a series of predefined <filename>.toc</filename> files has been put into the <filename class="directory">$TDEDIR/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.
@ -647,7 +647,7 @@ Call up a shell and have the following commands executed before you start &tdeve
</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>The <envar>TDEDIRS</envar> environment variable must be set to the <emphasis>list of active &kde; directories</emphasis> in your system. We use</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/trinity</filename> directory may in addition contain the standard &kde; version from your distribution that is used for everyday work.</member>
@ -658,7 +658,7 @@ In a tcsh shell you must set the environment variables using:
The <command>kbuildsycoca</command> command (<quote>build system control cache</quote>) looks around for libraries and caches their location and version, so that &tdevelop; can find them. The caveat is that it takes noticeable time—and it has to be run any time you call up the shell to start &tdevelop; from a non-default directory. You may want to put the above commands into a shell script to reduce the typing effort.
@ -711,12 +711,12 @@ Alas, this version is best used read-only over the internet. If you do not alway
(<command>make</command> will replace the global <varname>$KDEDIR</varname> variable with the actual &kde; directory setting recorded therein.) Then issue a <command>make</command> command <link linkend="compile-and-install-make-basic">as usual</link>. After the &tdevelop; IDE has been built you have the option to build the API as well. For this you must issue
(<command>make</command> will replace the global <varname>$TDEDIR</varname> variable with the actual &kde; directory setting recorded therein.) Then issue a <command>make</command> command <link linkend="compile-and-install-make-basic">as usual</link>. After the &tdevelop; IDE has been built you have the option to build the API as well. For this you must issue
@ -38,7 +38,7 @@ The next step is to create the actual script. For the above example the Type of
<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>
<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 "$TDEDIRS/share/apps/kate/scripts".</para>
<figure id="screenshot-scripts" float="1">
<title>&tdevelop; Scripts on the Filesystem</title>
<string><b>NOTE</b> These are directories to search in that are found in your KDE resource directories. So if you add the string "kate/scripts" to the list then KScript will look in "$KDEDIRS/data/kate/scripts" for scripts. This will allow you to get scripts in your home directory as well as system wide ones.</string>
<string><b>NOTE</b> These are directories to search in that are found in your KDE resource directories. So if you add the string "kate/scripts" to the list then KScript will look in "$TDEDIRS/data/kate/scripts" for scripts. This will allow you to get scripts in your home directory as well as system wide ones.</string>
Timothy Pearson
13 years ago