diff options
Diffstat (limited to 'doc')
40 files changed, 631 insertions, 631 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 2c7c6128..06f6c7cb 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,2 +1,2 @@ -SUBDIRS = kdevelop std extras kde_app_devel +SUBDIRS = tdevelop std extras kde_app_devel diff --git a/doc/api/FutureTasks.dox b/doc/api/FutureTasks.dox index fbed119a..5e2b8268 100644 --- a/doc/api/FutureTasks.dox +++ b/doc/api/FutureTasks.dox @@ -99,7 +99,7 @@ - cd's when selecting a file, but doesn't when selecting a dir, desired: a menu option to "cd" to that directory - QEditor - - Replace editors/qeditor/koReplace.* and editors/qeditor/koFind.* with kdelibs/kutils/kreplace.* and kdelibs/kutils/kfind.* + - Replace editors/qeditor/koReplace.* and editors/qeditor/koFind.* with tdelibs/kutils/kreplace.* and tdelibs/kutils/kfind.* \section extensiontodo Extensions / New Functionality: diff --git a/doc/api/HighPriTasks.dox b/doc/api/HighPriTasks.dox index 21116342..062b3b06 100644 --- a/doc/api/HighPriTasks.dox +++ b/doc/api/HighPriTasks.dox @@ -5,16 +5,16 @@ \section fixMajBugs Fixing major/annoying bugs - - Fix the mess of .kdevelop and .kdevses file. - - All project wide setings should go into .kdevelop and + - Fix the mess of .tdevelop and .kdevses file. + - All project wide setings should go into .tdevelop and - all session (and personal) options should go into .kdevses file . - This way the .kdevelop file can be shared in teams of developers. + This way the .tdevelop file can be shared in teams of developers. \section KDevelop2compat KDevelop 2 compatibility (These are things that must be accomplished before we can say that KDevelop 3 ->= kdevelop 2.x UI-wise and functionality-wise!) +>= tdevelop 2.x UI-wise and functionality-wise!) - general UI issues: - toplevel UI mode broken concerning to the accels @@ -29,7 +29,7 @@ - implement "Make User Manual" - use kdoc to update Qt/KDE docs . - - Solve the regression bugs. These are the <a href= "http://bugs.kde.org/buglist.cgi?product=kdevelop&bug_status=UNCONFIRMED&bug_status=NEW&priority=HI">ones + - Solve the regression bugs. These are the <a href= "http://bugs.kde.org/buglist.cgi?product=tdevelop&bug_status=UNCONFIRMED&bug_status=NEW&priority=HI">ones marked with priority "HI" in the bug database</a> diff --git a/doc/api/HowToAddApplicationTemplates.dox b/doc/api/HowToAddApplicationTemplates.dox index 7eec80c7..b948c934 100644 --- a/doc/api/HowToAddApplicationTemplates.dox +++ b/doc/api/HowToAddApplicationTemplates.dox @@ -6,7 +6,7 @@ Project templates provide the developer with a basic application framework. This is necessary for rapid application development (RAD) and makes it even possible for an inexperienced 3rd party developer to create standard conforming -applications like kedit as well as plugins for example for kdevelop or noatun.\n\n +applications like kedit as well as plugins for example for tdevelop or noatun.\n\n \ref templates_1\n - \ref templates_1_1 - \ref templates_1_2 @@ -36,7 +36,7 @@ Create a directory <code>template-khello</code> with the files - template-khello/app.cpp - template-khello/app.h - template-khello/app.desktop - - template-khello/app.kdevelop + - template-khello/app.tdevelop - template-khello/appui.rc - template-khello/khello - template-khello/main.cpp @@ -64,7 +64,7 @@ wizard will replace: - \%{YEAR} ........ by the year . </pre></code> -All this can be found in <code>$KDEDIR/share/apps/kdevappwizard/template-common/kdevelop.pm</code>. +All this can be found in <code>$KDEDIR/share/apps/kdevappwizard/template-common/tdevelop.pm</code>. \subsubsection templates_1_2a I.2.1. The Source Files The files <code>template-khello/app.cpp, template-khello/app.h</code> and @@ -117,7 +117,7 @@ This file will be copied to the <code>$PROJECTDIR/src/</code>. The following script is used to install the template and replaces all variables by the corresponding value. The result is a hopefully working -kdevelop project! +tdevelop project! \verbinclude khello/script <br> \note There are several application templates which use some identical @@ -155,7 +155,7 @@ if [ ! -e "${newdir}/template-common" ]; then ln -s "${kde_prefix}/share/apps/kd # install now cp -R --target-directory "$newdir" template-khello # the file template-khello/khello must go to the "templates" directory that -# kdevelop knows that it exists +# tdevelop knows that it exists mv "$newdir/template-khello/khello" "$newdir/templates/" echo "done" \endcode @@ -164,9 +164,9 @@ echo "done" \section templates_3 III. How To Add The Template To KDevelop CVS HEAD -This section is for kdevelop developers only. Most probably you don't have to read this!.\n -Move the directory <code>"template-khello"</code> to <code>kdevelop/languages/cpp/app_templates/</code> -and then add the following files in <code>kdevelop/languages/cpp/app_templates/template-khello/</code> +This section is for tdevelop developers only. Most probably you don't have to read this!.\n +Move the directory <code>"template-khello"</code> to <code>tdevelop/languages/cpp/app_templates/</code> +and then add the following files in <code>tdevelop/languages/cpp/app_templates/template-khello/</code> (in this example the language is c++ if you use other language replace cpp with the language name): - <code>".kdev_ignore"</code> is an empty file. It prevents KDevelop's C++-parser from parsing the C++ template files. This is necessary because the template files are just code templates and not real code (yet). @@ -179,9 +179,9 @@ script.local - <code>"Makefile.am"</code> looks like this: \verbinclude khello/Makefile.am . -Finally add <code>"template-khello"</code> to "SUBDIRS = " in <code>kdevelop/languages/cpp/app_templates/Makefile.am</code>.\n +Finally add <code>"template-khello"</code> to "SUBDIRS = " in <code>tdevelop/languages/cpp/app_templates/Makefile.am</code>.\n \attention Please test your template whether it installs and behaves correctly! -Test, test and test again! It works? Well - now talk to the kdevelop guys so +Test, test and test again! It works? Well - now talk to the tdevelop guys so that they know what's going on and probably you may commit. ;) \section templates_4 IV. Changes to the template system (VERY IMPORTANT) @@ -192,14 +192,14 @@ information from the script file will need to be moved into the ini file. The example is as follows: \code install( -"${src}/template-chello/app.kdevelop","${dest}/${APPNAMELC}.kdevelop" ); +"${src}/template-chello/app.tdevelop","${dest}/${APPNAMELC}.tdevelop" ); \endcode becomes \code [PROJECT] Type=install -Source=%{src}/template-chello/app.kdevelop -Dest=%{dest}/%{APPNAMELC}.kdevelop +Source=%{src}/template-chello/app.tdevelop +Dest=%{dest}/%{APPNAMELC}.tdevelop \endcode Things like <code>installIncAdmin();</code> and <code>installGNU();</code> now involve unpacking diff --git a/doc/api/HowToAddPlugins.dox b/doc/api/HowToAddPlugins.dox index 6171d9aa..3ab31af9 100644 --- a/doc/api/HowToAddPlugins.dox +++ b/doc/api/HowToAddPlugins.dox @@ -119,11 +119,11 @@ developers (e.g. via version control application CVS). So some user preferences very individual, and some may be valid for all of the team - project-wide so to speak. That's why the KDevelop architecture makes a difference here and supports two files -which will be stored in the project root directory. They are the project file (*.kdevelop) +which will be stored in the project root directory. They are the project file (*.tdevelop) and the session (*.kdevses) file. The later is for individual settings, not to be thought to be shared. -\subsection domProject Project file (*.kdevelop) +\subsection domProject Project file (*.tdevelop) For your convenience, you don't have to use the quite complex DOM API. Strings can very easily be read from and written to this document using the @@ -195,7 +195,7 @@ void GDBBreakpointWidget::savePartialProjectSession(QDomElement* el) </pre></code> Note that the .kdevses is related to a project. User settings equal for all projects don't -belong to here. You save them to ~/.kde/share/config/kdeveloprc via class KConfig of the +belong to here. You save them to ~/.kde/share/config/tdeveloprc via class KConfig of the tdecore library. Document your part in the way described at \ref howToDocument (doc/api/HowToDocument.dox file). diff --git a/doc/api/HowToAddProgrammingLanguages.dox b/doc/api/HowToAddProgrammingLanguages.dox index 5cfa3643..504a397e 100644 --- a/doc/api/HowToAddProgrammingLanguages.dox +++ b/doc/api/HowToAddProgrammingLanguages.dox @@ -42,7 +42,7 @@ Take a look at \ref LangSupportStatus (doc/api/LangSupportStatus.dox file) to se \section sectionLanguageSupport Language Support -Any language support should be written as a kdevelop part and implement +Any language support should be written as a tdevelop part and implement KDevLanguageSupport interface (<code>lib/interfaces/kdevlanguagesupport.h</code>). Implementing methods: @@ -137,7 +137,7 @@ and look at <code>languages/ruby/app_templates/rubyhello</code>, <code>languages \subsubsection sectionApplicationImportTemplates Application import templates KDevelop has the ability to <b>create a new project from existing projects or source code</b>. -It scans for project files ('*.kdevelop, *.kdevprj, *.studio, *.pro) and if +It scans for project files ('*.tdevelop, *.kdevprj, *.studio, *.pro) and if - it finds a project it extracts the necessary information - it does not find project files it scans for source files (*.cpp, *.java, *.pl, *.py, ...) . diff --git a/doc/api/HowToDocument.dox b/doc/api/HowToDocument.dox index d606a8bf..f767fc5b 100644 --- a/doc/api/HowToDocument.dox +++ b/doc/api/HowToDocument.dox @@ -8,7 +8,7 @@ You should add a README and a README.dox file to your part (KDevPlugin). On the README file put this text: \verbatim Please read the on-line, automaticaly updated KDevelop API documentation at: -http://www.kdevelop.org +http://www.tdevelop.org or read the README.dox file. \endverbatim diff --git a/doc/api/Mainpage.dox b/doc/api/Mainpage.dox index 9d4b6d4c..48640827 100644 --- a/doc/api/Mainpage.dox +++ b/doc/api/Mainpage.dox @@ -13,14 +13,14 @@ This document is targeted at all those that want to add or improve KDevelop's so If you are instead looking for a user manual, just go to the help menu of your KDevelop and select KDevelop handbook. This documentation contains the KDevelop online class reference for the current development version of KDevelop. Additionally, you -can subscribe or read the <a href="http://www.kdevelop.org/index.html?filename=mailinglist.html">mailing list</a> for any additions and/or +can subscribe or read the <a href="http://www.tdevelop.org/index.html?filename=mailinglist.html">mailing list</a> for any additions and/or modifications to the %API. -An on-line, updated every 24H, html version of this documentation can be found at: http://www.kdevelop.org/HEAD/doc/api/html/index.html +An on-line, updated every 24H, html version of this documentation can be found at: http://www.tdevelop.org/HEAD/doc/api/html/index.html More information about the KDevelop architecture in form of tutorials, HOWTOs, and FAQs can be found at -the <a href="http://www.kdevelop.org">KDevelop website</a>. +the <a href="http://www.tdevelop.org">KDevelop website</a>. \section status Current Status @@ -45,7 +45,7 @@ Additionally you may also want to find out \ref howToDocument (doc/api/HowToDocu Here is a priority ordered list: -# \ref HighPriTasks (doc/api/HighPriTasks.dox file) -# fix the dispersed \ref fixme - -# <a href="http://bugs.kde.org/buglist.cgi?product=kdevelop&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=bugs.bug_id">reported bugs in bugzilla database</a> + -# <a href="http://bugs.kde.org/buglist.cgi?product=tdevelop&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=bugs.bug_id">reported bugs in bugzilla database</a> -# fix the bugs in the \ref bug -# fix the dispersed \ref todo all over the code. . diff --git a/doc/extras/opengl.toc b/doc/extras/opengl.toc index efe104ff..cc420a7d 100644 --- a/doc/extras/opengl.toc +++ b/doc/extras/opengl.toc @@ -1,5 +1,5 @@ -<!DOCTYPE kdeveloptoc> -<kdeveloptoc> +<!DOCTYPE tdeveloptoc> +<tdeveloptoc> <title>OpenGL</title> <tocsect1 name="GL Functions"> <tocsect2 name="glAccum" url="man:glAccum"/> @@ -264,4 +264,4 @@ <tocsect2 name="glXWaitGL" url="man:glXWaitGL"/> <tocsect2 name="glXWaitX" url="man:glXWaitX"/> </tocsect1> -</kdeveloptoc> +</tdeveloptoc> diff --git a/doc/extras/sdl.toc b/doc/extras/sdl.toc index 947dd09a..01b7e7d7 100644 --- a/doc/extras/sdl.toc +++ b/doc/extras/sdl.toc @@ -1,5 +1,5 @@ -<!DOCTYPE kdeveloptoc> -<kdeveloptoc> +<!DOCTYPE tdeveloptoc> +<tdeveloptoc> <title>SDL</title> <base href="http://sdldoc.csn.ul.ie"/> <tocsect1 name="I. SDL Guide" url="guide.php"> @@ -216,4 +216,4 @@ <tocsect2 name="3-11. Interpreting Key Event Information" url="guideinputkeyboard.php#AEN351" /> <tocsect2 name="3-12. Proper Game Movement" url="guideinputkeyboard.php#AEN363" /> </tocsect1> -</kdeveloptoc> +</tdeveloptoc> diff --git a/doc/extras/w3c/w3c-dom-level2-html.toc b/doc/extras/w3c/w3c-dom-level2-html.toc index f3540ff1..e41c5172 100644 --- a/doc/extras/w3c/w3c-dom-level2-html.toc +++ b/doc/extras/w3c/w3c-dom-level2-html.toc @@ -1,5 +1,5 @@ -<!DOCTYPE kdeveloptoc> -<kdeveloptoc> +<!DOCTYPE tdeveloptoc> +<tdeveloptoc> <title>Document Object Model (DOM) Level 2 HTML Specification</title> <base href="http://www.w3.org/TR/DOM-Level-2-HTML" /> <tocsect1 name="1. Document Object Model HTML" url="html.html"> @@ -66,5 +66,5 @@ <tocsect2 name="W3C Software Copyright Notice and License" url="copyright-notice.html#Copyright-notice-software"> </tocsect2> </tocsect1> -</kdeveloptoc> +</tdeveloptoc> diff --git a/doc/extras/w3c/w3c-svg.toc b/doc/extras/w3c/w3c-svg.toc index a53e34fc..c7ef3f3d 100644 --- a/doc/extras/w3c/w3c-svg.toc +++ b/doc/extras/w3c/w3c-svg.toc @@ -1,5 +1,5 @@ -<!DOCTYPE kdeveloptoc> -<kdeveloptoc> +<!DOCTYPE tdeveloptoc> +<tdeveloptoc> <title>Scalable Vector Graphics (SVG) 1.1 Specification</title> <base href="http://www.w3.org/TR/SVG11" url="index.html"/> @@ -1442,5 +1442,5 @@ </tocsect2> </tocsect1> -</kdeveloptoc> +</tdeveloptoc> diff --git a/doc/extras/w3c/w3c-uaag10.toc b/doc/extras/w3c/w3c-uaag10.toc index 08f90cc9..b0b581f7 100644 --- a/doc/extras/w3c/w3c-uaag10.toc +++ b/doc/extras/w3c/w3c-uaag10.toc @@ -1,5 +1,5 @@ -<!DOCTYPE kdeveloptoc> -<kdeveloptoc> +<!DOCTYPE tdeveloptoc> +<tdeveloptoc> <title>User Agent Accessibility Guidelines 1.0</title> <base href="http://www.w3.org/TR/UAAG10" url="cover.html"/> <tocsect1 name="Abstract" url="cover.html#abstract"> @@ -66,4 +66,4 @@ </tocsect1> <tocsect1 name="6. Acknowledgments" url="acks.html#Acknowledgments"> </tocsect1> -</kdeveloptoc> +</tdeveloptoc> diff --git a/doc/kde_app_devel/index.docbook b/doc/kde_app_devel/index.docbook index 0ebf7e71..3cc34883 100644 --- a/doc/kde_app_devel/index.docbook +++ b/doc/kde_app_devel/index.docbook @@ -1,7 +1,7 @@ <?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 kappname "&kdevelop;"> + <!ENTITY tdevelop "<application>KDevelop</application>"> + <!ENTITY kappname "&tdevelop;"> <!ENTITY % addindex "INCLUDE"> <!ENTITY % English "INCLUDE" > <!-- change language only here --> ]> @@ -9,7 +9,7 @@ <book lang="&language;"> <bookinfo> -<title>The &kdevelop; Programming Handbook</title> +<title>The &tdevelop; Programming Handbook</title> <date>2002-12-05</date> <releaseinfo>2.0</releaseinfo> @@ -42,7 +42,7 @@ <abstract> <para>The User Guide to C++ Application Design for the K Desktop Environment (KDE) with -the &kdevelop; IDE</para> +the &tdevelop; IDE</para> </abstract> <keywordset> @@ -76,7 +76,7 @@ C++ is available through various sources either in printed form at your local bo found on the Internet. Knowledge about the design of Graphical User Interfaces is not required, as this handbook tries to cover the application design for KDE programs, which also includes an introduction into the Qt toolkit as well as the KDE libraries and the design of User Interfaces. Also, you should have made -yourself comfortable with &kdevelop; by reading The User Manual to &kdevelop;, which contains a descriptive +yourself comfortable with &tdevelop; by reading The User Manual to &tdevelop;, which contains a descriptive review of the functionality provided by the IDE. </para> </sect1> @@ -106,8 +106,8 @@ online-manuals. <para> We'll take a look at the Qt and KDE libraries, showing basic concepts and why things are the way they are. Also, we will discuss how to create the tutorial applications provided with the Qt toolkit by using -kdevelop;, so beginners can already see first results with a few steps, and thereby will learn how to make -use of some of &kdevelop;'s best features. +tdevelop;, so beginners can already see first results with a few steps, and thereby will learn how to make +use of some of &tdevelop;'s best features. </para> </sect2> @@ -135,7 +135,7 @@ You will learn how to: Additional information about Qt/KDE programming is available by various sources: <itemizedlist> <listitem><para>Programming with Qt by Matthias Kalle Dalheimer</para></listitem> -<listitem><para><ulink url="www.kdevelop.org">The User Manual to KDevelop, provided with the KDevelop IDE</ulink></para></listitem> +<listitem><para><ulink url="www.tdevelop.org">The User Manual to KDevelop, provided with the KDevelop IDE</ulink></para></listitem> <listitem><para><ulink url="doc.trolltech.com">The Online Reference to the Qt library</ulink></para></listitem> <listitem><para><ulink url="developer.kde.org">The KDE Developer web site</ulink></para></listitem> </itemizedlist> @@ -147,7 +147,7 @@ Unix Systems as well as about the C and C++ programming language. </para> <para> For obtaining help about the KDevelop IDE, you should send requests to our mailinglist at -<email>kdevelop@kdevelop.org</email>. Mind that the KDevelop team is dedicated to provide the means to enable you to +<email>tdevelop@tdevelop.org</email>. Mind that the KDevelop team is dedicated to provide the means to enable you to program applications and therefore is not intended as a technical support team in cases where the applications you're developing don't work due to implementation errors or misconfigurations of your operating system. By this, we ask all users to take advantage of the mailinglist in any case you're running @@ -259,7 +259,7 @@ an integer value to the overlaying Operating System signaling that the applicati <title>The Reference Documentation for Qt</title> <para> Now, let's have a quick look at the reference documentation of the Qt library. To do this, start -&kdevelop; and select "Qt" from the tree in the Documentation tab. The documentation browser opens +&tdevelop; and select "Qt" from the tree in the Documentation tab. The documentation browser opens and shows you the start page of the Qt reference. This will be your first place to get information about Qt, it's classes and the available functions they provide. Also, the above program is the first that is included in the tutorials section. To get to the classes we want to have a look at, @@ -595,7 +595,7 @@ include path and the linker to link in the tdecore library with -ltdecore. <para> As you now know what at least the <function>main()</function> function provides generally and how an application gets visible and allows user and object interaction, we'll go on with the next chapter, -where our first application is made with &kdevelop;. There you can also test everything which was +where our first application is made with &tdevelop;. There you can also test everything which was mentioned before and see the effects. </para> <para> @@ -617,7 +617,7 @@ also covers a complete description about the invocation of the <classname>QAppli <sect1 id="c3s1"> <title>The Application Wizard</title> <para> -&kdevelop;'s Application Wizard is intended to let you start working on new project with &kdevelop;. Therefore +&tdevelop;'s Application Wizard is intended to let you start working on new project with &tdevelop;. Therefore all of your projects are first created by the wizard, and then you can start building them and extend what is already provided by the source skeleton. You can choose from several project types according to your project goals: <itemizedlist> @@ -648,7 +648,7 @@ may not have as many options available. <sect2 id="c3s2s1"> <title>Starting the Application Wizard and the First Page</title> <para> -To start with your KDE application, open &kdevelop;. From the Project menu, selection New Project. The +To start with your KDE application, open &tdevelop;. From the Project menu, selection New Project. The Application Wizard starts, and you'll see the selection tree on the first page containing available project types that can be created. Choose the C++ subtree, then KDE, then Application Framework. </para> @@ -673,7 +673,7 @@ and select Next. <title>Header and Source Templates</title> <para> The next two pages show example headers that will go at the top of each of the header and source files that -you create using &kdevelop;. For now, just leave these as the default, and select Next, then Finish. If the +you create using &tdevelop;. For now, just leave these as the default, and select Next, then Finish. If the Finish button is not activated, you haven't set all of the options correct. Use the Back button to return to earlier menus and correct any mistakes. </para> @@ -682,7 +682,7 @@ to earlier menus and correct any mistakes. <title>Finishing Up</title> <para> Upon completion, the Application Wizard should close and the messages window should popup displaying -information about the tasks that &kdevelop; is currently doing. At the end of all of the tasks, you +information about the tasks that &tdevelop; is currently doing. At the end of all of the tasks, you should see **** Success *****. This means the application framework was successfully loaded. </para> </sect2> @@ -696,7 +696,7 @@ of how the application framework looks. This won't only help us get started, bu what in later steps. </para> <para> -This chapter makes the assumption that you understand the basic navigation of &kdevelop;. Consult the +This chapter makes the assumption that you understand the basic navigation of &tdevelop;. Consult the KDevelop User Manual for information if you need it. </para> <para> @@ -707,7 +707,7 @@ The Automake manager shows the project files as follows: </mediaobject></screenshot> </para> <para> -Before diving into the sources, we'll let &kdevelop; build an run our new application. To do this, select +Before diving into the sources, we'll let &tdevelop; build an run our new application. To do this, select Build Project from the Build menu, or press F8. The output window opens and displays output messages during the compilation phase. <programlisting> @@ -822,7 +822,7 @@ returns to the directory it was started, processes it, then finishes. Our first line of interest is 24. Notice on this line that g++, which is our C++ compiler, gets called by make to compile the first source code file in our project - in this case main.cpp. Many extra command line options are also being used with the g++ compiler; some of which are defaults and some of which can be configured -via &kdevelop;. +via &tdevelop;. </para> <para> Before the next file (kscribble.cpp, line 29) is compiled, the moc (meta object compiler) is first @@ -1023,7 +1023,7 @@ inherits QWidget already. </para> <para> This chapter therefore describes how to use library widgets for creating views of KDE or -Qt applications that are generated with &kdevelop;, then we look at the libraries and what kind of +Qt applications that are generated with &tdevelop;, then we look at the libraries and what kind of views are already offered. </para> </sect1> @@ -1046,7 +1046,7 @@ Change the inheritance of the provided view class to the class of the library wi <para> In either way, it is important to know that if the application framework is currently not linked against the library that contains the widget, the linker will fail. After you decided to use a -certain widget, look for the library to link to; then open "Project"->"Options" from the &kdevelop; +certain widget, look for the library to link to; then open "Project"->"Options" from the &tdevelop; menubar. Switch to the "Linker Options" page and look for the checkmarks indicating the libraries that are currently used. If the library of your view widget is already checked, you can leave the project options untouched and start doing the necessary changes due to your choice. If not, and the @@ -1206,7 +1206,7 @@ KAction</classname>, which provides the keyboard accelerator keys and access to standard keyboard accelerators. </para> <para> -By default, frame applications generated by &kdevelop; only use standard keyboard accelerators +By default, frame applications generated by &tdevelop; only use standard keyboard accelerators such as F1 for accessing online-help, Ctrl+N for New File etc. </para> <para> @@ -1252,7 +1252,7 @@ using the standard help key F1. This context based help system is provided auto <classname>KMainWindow</classname> class, though as the author you must provide the content. </para> <para> -As &kdevelop; also offers all types of help as well as the KDE framework generated by the +As &tdevelop; also offers all types of help as well as the KDE framework generated by the application wizard already contains support for this, this chapter will help you find out where and how to add your help functionality. </para> <para> @@ -1306,7 +1306,7 @@ that the user wants to get help about a certain widget within the working view o It is placed in the toolbar and gets activated once the user hits the button. The cursor changes to an arrow cursor with a question mark like the button itself looks like. The the user can press on a visible widget item and gets a help window. As an exercise, you could try this behavior with the -<guibutton>What's this...?</guibutton> button within &kdevelop;. +<guibutton>What's this...?</guibutton> button within &tdevelop;. </para> <para> To add the What's This...? help to one of your widgets, use the static method @@ -1321,7 +1321,7 @@ To add the What's This...? help to one of your widgets, use the static method <title>Introduction</title> <para> Due to the fact that projects often lack a complete set of user documentation, -all &kdevelop; projects contain a pre-build handbook that can be easily adapted; +all &tdevelop; projects contain a pre-build handbook that can be easily adapted; therefore fulfiling another goal of KDE: providing enough online-help to support users that are not familiar with an application. This chapter therefore introduces you on how to extend the provided documentation template and what you have to do to make it available to the user. @@ -1341,10 +1341,10 @@ The format for editing this file is explained on <para> Another important part of the documentation is including a descriptive help for your class interfaces. This will allow you and other programmers to use your classes by reading the HTML class documentation -that can be created with KDoc. &kdevelop; supports the use of KDoc completely by creating the +that can be created with KDoc. &tdevelop; supports the use of KDoc completely by creating the KDE-library documentation, also your application frameworks are already documented. To work yourself into the provided code, it would be a good start to read the included documentation online. -The following describes what to do to get the API documentation, where &kdevelop; helps you add it +The following describes what to do to get the API documentation, where &tdevelop; helps you add it and what kind of special tags KDoc provides. </para> </sect1> diff --git a/doc/kdearch/index.docbook b/doc/kdearch/index.docbook index a17aaa87..fff7cd57 100644 --- a/doc/kdearch/index.docbook +++ b/doc/kdearch/index.docbook @@ -16,7 +16,7 @@ <author> <firstname>Bernd</firstname> <surname>Gehrmann</surname> -<affiliation><address><email>bernd@kdevelop.org</email></address></affiliation> +<affiliation><address><email>bernd@tdevelop.org</email></address></affiliation> </author> </authorgroup> @@ -1451,7 +1451,7 @@ in this screenshot: <para> The XML file begins with a document type declaration. The DTD for kpartgui can -be found in the kdelibs sources in <filename>tdeui/kpartgui.dtd</filename>. The +be found in the tdelibs sources in <filename>tdeui/kpartgui.dtd</filename>. The outermost element of the file contains the instance name of the application as attribute. It can also contain a version number in the form "version=2". This is useful when you release new versions of an application with a changed menu @@ -1480,7 +1480,7 @@ declared as follows: <para> In KDE's automake framework, such titles are automatically extracted and put -into the application's <ulink url="kde-i18n-howto.html"><literal>.po</literal></ulink> +into the application's <ulink url="tde-i18n-howto.html"><literal>.po</literal></ulink> file , so it is considered by translators. Note that you have to write the accelerator marker "&" in the form XML compliant form "&amp;". </para> @@ -1503,7 +1503,7 @@ actions are created by the class When you create such actions in your application (such as in the C++ example above), they will automatically be inserted in a prescribed position, and possibly with an icon and a shortcut key. You can look up these locations in -the file <filename>tdeui/ui_standards.rc</filename> in the kdelibs sources. +the file <filename>tdeui/ui_standards.rc</filename> in the tdelibs sources. </para> </simplesect> @@ -1913,12 +1913,12 @@ snippet: </para> <programlisting> -kde_servicetypesdir_DATA = kdeveloppart.desktop +kde_servicetypesdir_DATA = tdeveloppart.desktop EXTRA_DIST = $(kde_servicetypesdir_DATA) </programlisting> <para> -The definition <filename>kdeveloppart.desktop</filename> of a +The definition <filename>tdeveloppart.desktop</filename> of a <application>KDevelop</application> part looks as follows: </para> @@ -2920,7 +2920,7 @@ cache, you can use: <programlisting> void FooClass::reloadPage() { - KURL url("http://www.kdevelop.org/index.html"); + KURL url("http://www.tdevelop.org/index.html"); KIO::TransferJob *job = KIO::get(url, true, false); job->addMetaData("cache", "reload"); ... @@ -3119,7 +3119,7 @@ extern "C" { int kdemain(int argc, char **argv); } int kdemain(int argc, char **argv) { - KLocale::setMainCatalogue("kdelibs"); + KLocale::setMainCatalogue("tdelibs"); KInstance instance("kio_ftp"); (void) KGlobal::locale(); diff --git a/doc/kdevelop/adv-build-management.docbook b/doc/kdevelop/adv-build-management.docbook index e589a007..02dd987e 100644 --- a/doc/kdevelop/adv-build-management.docbook +++ b/doc/kdevelop/adv-build-management.docbook @@ -23,7 +23,7 @@ <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 +&tdevelop; 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. @@ -36,7 +36,7 @@ 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 +use &tdevelop; 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 @@ -79,7 +79,7 @@ the one of the X11 version. </para> <para> -Developing an application for &qte; with &kdevelop; is not very different +Developing an application for &qte; with &tdevelop; 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 diff --git a/doc/kdevelop/app-files.docbook b/doc/kdevelop/app-files.docbook index 210e1469..f79b81c1 100644 --- a/doc/kdevelop/app-files.docbook +++ b/doc/kdevelop/app-files.docbook @@ -10,38 +10,38 @@ </authorgroup> </appendixinfo> -<title>Configuration Files Used by &kdevelop;</title> +<title>Configuration Files Used by &tdevelop;</title> <para> -&kdevelop; uses a series of configuration files which are distributed amongst several directories. There are two main groups of configuration files to distinguish: +&tdevelop; uses a series of configuration files which are distributed amongst several directories. There are two main groups of configuration files to distinguish: </para> <simplelist> <member> - <link linkend="app-files-default">&kdevelop; Default Configuration</link> — files set up when &kdevelop; was installed. + <link linkend="app-files-default">&tdevelop; Default Configuration</link> — files set up when &tdevelop; was installed. </member> <member> - <link linkend="app-files-user">User Oriented Configuration</link> — files which contain user modifications of the defaults as well as settings made by the &kdevelop; application itself and its plugins. + <link linkend="app-files-user">User Oriented Configuration</link> — files which contain user modifications of the defaults as well as settings made by the &tdevelop; application itself and its plugins. </member> </simplelist> <sect1 id="app-files-default"> -<title>&kdevelop; Default Configuration</title> +<title>&tdevelop; Default Configuration</title> <para> -On installation, &kdevelop; writes some default information files for setup and configuration purposes into subdirectories of the <filename class="directory">$<envar>KDEDIR</envar></filename> installation directory (usually something like <filename class="directory">/opt/kde</filename>, <filename class="directory">/usr/local/kde</filename>, or some other user-defined installation directory, see <link linkend="kdevelop-install">Installing &kdevelop;</link>). +On installation, &tdevelop; writes some default information files for setup and configuration purposes into subdirectories of the <filename class="directory">$<envar>KDEDIR</envar></filename> installation directory (usually something like <filename class="directory">/opt/kde</filename>, <filename class="directory">/usr/local/kde</filename>, or some other user-defined installation directory, see <link linkend="tdevelop-install">Installing &tdevelop;</link>). </para> <sect2 id="app-files-default-config"> -<title>Default &kdevelop; Configuration</title> +<title>Default &tdevelop; Configuration</title> <para> -There is only one &kdevelop; specific default configuration file in the <filename class="directory">$<envar>KDEDIR</envar>/share/config/</filename> directory: +There is only one &tdevelop; specific default configuration file in the <filename class="directory">$<envar>KDEDIR</envar>/share/config/</filename> directory: </para> <variablelist> <varlistentry> - <term><filename>kdeveloprc</filename></term> + <term><filename>tdeveloprc</filename></term> <listitem><para> - This file contains the basic settings &kdevelop; needs to start. It will be copied to the user's <filename class="directory">$<envar>KDEHOME</envar>/share/config</filename> directory when &kdevelop; does not find a <filename>kdeveloprc</filename> file there on startup. + This file contains the basic settings &tdevelop; needs to start. It will be copied to the user's <filename class="directory">$<envar>KDEHOME</envar>/share/config</filename> directory when &tdevelop; does not find a <filename>tdeveloprc</filename> file there on startup. </para></listitem> </varlistentry> </variablelist> @@ -52,11 +52,11 @@ There is only one &kdevelop; specific default configuration file in the <filenam <title>Application Specific Defaults</title> <para> -Most &kdevelop; features are provided by KParts. These are basically applications specially designed to run in the &kdevelop; framework (see the overview in the <link linkend="plugin-tools">Plugin Tools</link> appendix). Each KPart application has its own set of configuration files whose defaults will be stored in several subdirectories of the <filename class="directory">$<envar>KDEDIR</envar>/share/apps/</filename> installation directory. +Most &tdevelop; features are provided by KParts. These are basically applications specially designed to run in the &tdevelop; framework (see the overview in the <link linkend="plugin-tools">Plugin Tools</link> appendix). Each KPart application has its own set of configuration files whose defaults will be stored in several subdirectories of the <filename class="directory">$<envar>KDEDIR</envar>/share/apps/</filename> installation directory. </para> <para> -There are quite a lot of default configuration subdirectories in <filename class="directory">$<envar>KDEDIR</envar>/share/apps/</filename> whose names all start with a <filename>kdev</filename> sequence. Most of them are for &kdevelop; internal use only. They might be deliberately grouped for readability as: +There are quite a lot of default configuration subdirectories in <filename class="directory">$<envar>KDEDIR</envar>/share/apps/</filename> whose names all start with a <filename>kdev</filename> sequence. Most of them are for &tdevelop; internal use only. They might be deliberately grouped for readability as: <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> @@ -69,18 +69,18 @@ There are quite a lot of default configuration subdirectories in <filename class <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> + <para><filename class="directory">tdevelop/</filename> — contains files to configure the &tdevelop; &IDE;:</para> <itemizedlist> <listitem><para><filename class="directory">licenses/</filename> — contains various licenses texts.</para></listitem> - <listitem><para><filename class="directory">pics/</filename> — contains the picture files used for the &kdevelop;, &kdevelop; Assistant, and &kdevelop; Designer splash screens.</para></listitem> - <listitem><para><filename class="directory">profiles/</filename> — contains default plugin profile settings. (Currently there is only a <filename>tiny</filename> profile provided which defines a minimum set of active &kdevelop; plugins.)</para></listitem> + <listitem><para><filename class="directory">pics/</filename> — contains the picture files used for the &tdevelop;, &tdevelop; Assistant, and &tdevelop; Designer splash screens.</para></listitem> + <listitem><para><filename class="directory">profiles/</filename> — contains default plugin profile settings. (Currently there is only a <filename>tiny</filename> profile provided which defines a minimum set of active &tdevelop; plugins.)</para></listitem> <listitem><para><filename>eventsrc</filename> — holds a lot of <quote>Process successful</quote> localization strings.</para></listitem> - <listitem><para><filename>kdevelopui.rc</filename> — provides the basic menu and tool bar entries &kdevelop; uses.</para></listitem> + <listitem><para><filename>tdevelopui.rc</filename> — provides the basic menu and tool bar entries &tdevelop; uses.</para></listitem> <listitem><para><filename>kdevhtml_partui.rc</filename> — provides a <guimenuitem>Print...</guimenuitem> entry in the <guimenu>File</guimenu> menu, a <guimenuitem>Copy</guimenuitem> entry in the <guimenu>Edit</guimenu> menu, and <guilabel>Back</guilabel> and <guilabel>Forward</guilabel> arrows in the <guilabel>Browser Toolbar</guilabel> in case a &HTML; file is browsed from the <guilabel>Documentation</guilabel> plugin.</para></listitem> </itemizedlist> </listitem> - <listitem><para><filename class="directory">kdevassistant/</filename> — provides the menu and tool bars of the stand-alone &kdevelop; Assistant documentation browser.</para></listitem> - <listitem><para><filename class="directory">kdevdesigner/</filename> and <filename class="directory">kdevdesignerpart/</filename> — provide menu bar and tool bars of the stand-alone &kdevelop; user interface designer.</para></listitem> + <listitem><para><filename class="directory">kdevassistant/</filename> — provides the menu and tool bars of the stand-alone &tdevelop; Assistant documentation browser.</para></listitem> + <listitem><para><filename class="directory">kdevdesigner/</filename> and <filename class="directory">kdevdesignerpart/</filename> — provide menu bar and tool bars of the stand-alone &tdevelop; user interface designer.</para></listitem> </itemizedlist></listitem> <listitem><itemizedlist id="app-files-default-apps-task"> @@ -96,7 +96,7 @@ There are quite a lot of default configuration subdirectories in <filename class <listitem id="app-files-default-appwizard"> <para><filename class="directory">kdevappwizard/</filename> — contains files used by the &appwizard; part:</para> <itemizedlist> - <listitem><para><filename class="directory">importfiles/</filename> — contains <filename>.kdevelop</filename> project files which control the initialization of a new project.</para></listitem> + <listitem><para><filename class="directory">importfiles/</filename> — contains <filename>.tdevelop</filename> project files which control the initialization of a new project.</para></listitem> <listitem><para><filename class="directory">imports/</filename> — contains templates to set up project specific <filename>.desktop</filename> files.</para></listitem> <listitem><para><filename class="directory">template-common/</filename> — contains various files commonly included in the project source directories.</para></listitem> <listitem><para><filename class="directory">templates/</filename> — contains configuration files which describe the information to be included in a given project source directory.</para></listitem> @@ -105,7 +105,7 @@ There are quite a lot of default configuration subdirectories in <filename class </itemizedlist> </listitem> <listitem><para><filename class="directory">kdevastyle/</filename> — provides the <guimenuitem>Reformat Source</guimenuitem> entry in the <guimenu>Edit</guimenu> menu.</para></listitem> - <listitem><para><filename class="directory">kdevautoproject/</filename> — provides most of the entries in the <guimenu>Build</guimenu> menu and the <guilabel>Build Toolbar (&kdevelop;)</guilabel> toolbar.</para></listitem> + <listitem><para><filename class="directory">kdevautoproject/</filename> — provides most of the entries in the <guimenu>Build</guimenu> menu and the <guilabel>Build Toolbar (&tdevelop;)</guilabel> toolbar.</para></listitem> <listitem> <para><filename class="directory">kdevclassview/</filename> — contains files used by the <guilabel>Class View</guilabel> project plugin:</para> <itemizedlist> @@ -123,7 +123,7 @@ There are quite a lot of default configuration subdirectories in <filename class <para><filename class="directory">kdevdocumentation/</filename> — contains files used by the <guilabel>Documentation</guilabel> plugin:</para> <itemizedlist> <listitem><para><filename class="directory">en/</filename> and <filename class="directory">pics/</filename> — contain files used by the <application>htdig</application> search tool.</para></listitem> - <listitem><para><filename class="directory">tocs/</filename> — contain the default &kdevelop; documentation content description files (see the description in <link linkend="toc-file-structure">Basic Structure of &kdevelop; TOC Files</link>).</para></listitem> + <listitem><para><filename class="directory">tocs/</filename> — contain the default &tdevelop; documentation content description files (see the description in <link linkend="toc-file-structure">Basic Structure of &tdevelop; TOC Files</link>).</para></listitem> <listitem><para><filename>kdevpart_documentation.rc</filename> — provides the search related entries in the <guimenu>Help</guimenu> menu.</para></listitem> </itemizedlist> </listitem> @@ -212,20 +212,20 @@ All information about user defined settings is kept in two subdirectories of <fi <title>Application Specific Configuration</title> <para> -Any user changes to the <link linkend="app-files-default">&kdevelop; Default Configuration</link> settings as well as user specific settings which are not kept in any of the <link linkend="app-files-user-config">Resource Configuration Files</link> are found in <filename>kdev...</filename> subdirectories of the <filename class="directory">$<envar>KDEHOME</envar>/share/apps/</filename> directory. +Any user changes to the <link linkend="app-files-default">&tdevelop; Default Configuration</link> settings as well as user specific settings which are not kept in any of the <link linkend="app-files-user-config">Resource Configuration Files</link> are found in <filename>kdev...</filename> subdirectories of the <filename class="directory">$<envar>KDEHOME</envar>/share/apps/</filename> directory. </para> <para> -Most of these configuration files are however used by various &kdevelop; plugins in order to provide some specific menu and/or toolbar entries. Thus they are of interest only in case something went really wrong with the user interface. +Most of these configuration files are however used by various &tdevelop; plugins in order to provide some specific menu and/or toolbar entries. Thus they are of interest only in case something went really wrong with the user interface. </para> <note><para> -In case the contents of these directories mirror those of the Default Configuration settings, &kdevelop; will have copied them from <filename class="directory">$<envar>KDEDIR</envar>/apps/</filename> into the <filename class="directory">$<envar>KDEHOME</envar>/apps/</filename> directory on its initial start. Any subsequent changes will be made to these copies only. The Default Configuration settings remain unchanged in any case. +In case the contents of these directories mirror those of the Default Configuration settings, &tdevelop; will have copied them from <filename class="directory">$<envar>KDEDIR</envar>/apps/</filename> into the <filename class="directory">$<envar>KDEHOME</envar>/apps/</filename> directory on its initial start. Any subsequent changes will be made to these copies only. The Default Configuration settings remain unchanged in any case. </para></note> <itemizedlist> <listitem> <para><filename class="directory">kdevabbrev/</filename> — contains files used by the <guilabel>Abbreviation Expansion</guilabel> plugin:</para> <itemizedlist> - <listitem><para><filename class="directory">sources/</filename> — currently empty; &kdevelop; uses the <link linkend="app-files-default-abbrev">default keyword definition</link> files for <guilabel>Expand Text</guilabel> commands.</para></listitem> + <listitem><para><filename class="directory">sources/</filename> — currently empty; &tdevelop; uses the <link linkend="app-files-default-abbrev">default keyword definition</link> files for <guilabel>Expand Text</guilabel> commands.</para></listitem> <listitem><para><filename class="directory">templates/</filename> — contains the user modified template definition files used by the <guilabel>Expand Abbreviation</guilabel> command.</para></listitem> <listitem><para><filename>kdevabbrev.rc</filename> — provides the <guimenuitem>Expand Text</guimenuitem> and <guimenuitem>Expand Abbreviation</guimenuitem> entries in the <guimenu>Edit</guimenu> menu.</para></listitem> </itemizedlist> @@ -252,7 +252,7 @@ In case the contents of these directories mirror those of the Default Configurat <para><filename class="directory">newclass/</filename> — contains the actual header and source templates from which the &appwizard; builds the according source files.</para> </listitem> <listitem> - <para><filename class="directory">pcs/</filename> — contains database files &kdevelop; uses build the actual Persistent Code Store (<filename>.pcs</filename>) file of a &kde; C++ project.</para> + <para><filename class="directory">pcs/</filename> — contains database files &tdevelop; uses build the actual Persistent Code Store (<filename>.pcs</filename>) file of a &kde; C++ project.</para> </listitem> <listitem> <para><filename>kdevcppsupport.rc</filename> — provides the <guimenuitem>Complete Text</guimenuitem> and <guimenuitem>Make Member</guimenuitem> entries fo the <guimenu>Edit</guimenu> menu, the <guimenuitem>Switch Header/Implementation</guimenuitem> entry for the <guimenu>View</guimenu> menu, and the <guimenuitem>New Class</guimenuitem> entry for the <guimenu>Project</guimenu> menu as well as a <guiicon>New Class</guiicon> icon for the <guilabel>Browser Toolbar</guilabel>.</para> @@ -273,10 +273,10 @@ In case the contents of these directories mirror those of the Default Configurat <para>The directories in <filename class="directory">kdevdocumentation/</filename> mainly hold actual bookkeeping information. The actually set up documentation files are kept in <link linkend="app-files-user-config-doc"> <quote><filename>doc...pluginrc</filename></quote> files</link> in the <filename class="directory">$<envar>KDEHOME</envar>/share/config/</filename> directory.</para> <itemizedlist> <listitem> - <para><filename class="directory">bookmarks/</filename> — maintains the entries in the <guilabel>Bookmarks</guilabel> tab of the &kdevelop; <guilabel>Documentation</guilabel> plugin.</para> + <para><filename class="directory">bookmarks/</filename> — maintains the entries in the <guilabel>Bookmarks</guilabel> tab of the &tdevelop; <guilabel>Documentation</guilabel> plugin.</para> </listitem> <listitem> - <para><filename class="directory">index/</filename> — holds various cache files &kdevelop; uses to speed up indexed documentation searches in the <guilabel>Index</guilabel> tab of the <guilabel>Documentation</guilabel> plugin.</para> + <para><filename class="directory">index/</filename> — holds various cache files &tdevelop; uses to speed up indexed documentation searches in the <guilabel>Index</guilabel> tab of the <guilabel>Documentation</guilabel> plugin.</para> </listitem> <listitem> <para><filename class="directory">search/</filename> — contains files used by the <application>htdig</application> search tool which serves search calls from the <guilabel>Search</guilabel> tab of the <guilabel>Documentation</guilabel> plugin.</para> @@ -290,10 +290,10 @@ In case the contents of these directories mirror those of the Default Configurat <para><filename class="directory">kdevdoxygen/</filename> — provides the menu entries for the <guilabel>Doxygen Support</guilabel> project plugin.</para> </listitem> <listitem> - <para><filename class="directory">kdevelop/</filename> — contains some actual settings &kdevelop; uses for its basic setup:</para> + <para><filename class="directory">tdevelop/</filename> — contains some actual settings &tdevelop; uses for its basic setup:</para> <itemizedlist> - <listitem><para><filename class="directory">profiles/</filename> — provides actual plugin profile setting. (Initially there is only a <filename>FullIDE</filename> profile which defines a full set of initially active &kdevelop; plugins.)</para></listitem> - <listitem><para><filename>kdevelopui.rc</filename> — provides the basic menu and tool bar entries &kdevelop; uses.</para></listitem> + <listitem><para><filename class="directory">profiles/</filename> — provides actual plugin profile setting. (Initially there is only a <filename>FullIDE</filename> profile which defines a full set of initially active &tdevelop; plugins.)</para></listitem> + <listitem><para><filename>tdevelopui.rc</filename> — provides the basic menu and tool bar entries &tdevelop; uses.</para></listitem> </itemizedlist> </listitem> <listitem> @@ -345,32 +345,32 @@ In case the contents of these directories mirror those of the Default Configurat <title>Resource Configuration Files</title> <para> -There are two groups of &kdevelop; configuration files in the <filename class="directory">$<envar>KDEHOME</envar>/share/config/</filename> directory, distiguished by their surrounding character sequences: +There are two groups of &tdevelop; configuration files in the <filename class="directory">$<envar>KDEHOME</envar>/share/config/</filename> directory, distiguished by their surrounding character sequences: <simplelist> <member><quote><filename>doc...pluginrc</filename></quote> denotes <link linkend="app-files-user-config-doc">files used by the documentation plugin.</link></member> - <member><quote><filename>kdev...rc</filename></quote> denotes configuration <link linkend="app-files-user-config-kdev">files used by &kdevelop;</link> itself and its available plugins.</member> + <member><quote><filename>kdev...rc</filename></quote> denotes configuration <link linkend="app-files-user-config-kdev">files used by &tdevelop;</link> itself and its available plugins.</member> </simplelist> </para> <itemizedlist id="app-files-user-config-kdev"> -<title>Configuration Files Used by &kdevelop;</title> +<title>Configuration Files Used by &tdevelop;</title> <listitem> <para><filename>kdevabbrevrc</filename> — holds the current state of the <guilabel>Abbreviations</guilabel> configuration provided by the <guilabel>Abbreviation Expansion</guilabel> plugin.</para> <note><para>This only records whether the abbreviations will be used or not. The actual definitions of new abbreviations will go into the <filename>$<envar>KDEHOME</envar>/share/apps/kdevabbrev/templates/templates</filename> file.</para></note> </listitem> <listitem> - <para><filename>kdevassistantrc</filename> — holds some configuration states specific of the stand-alone &kdevelop; Assistant documentation browser.</para> - <note><para>Most common configuration settings are shared with the &kdevelop; IDE <filename>kdeveloprc</filename> file.</para></note> + <para><filename>kdevassistantrc</filename> — holds some configuration states specific of the stand-alone &tdevelop; Assistant documentation browser.</para> + <note><para>Most common configuration settings are shared with the &tdevelop; IDE <filename>tdeveloprc</filename> file.</para></note> </listitem> - <listitem><para><filename>kdevassistantuimode4rc</filename> — holds the current MDI configuration states (dock positions &etc;) of the stand-alone &kdevelop; Assistant documentation browser.</para></listitem> + <listitem><para><filename>kdevassistantuimode4rc</filename> — holds the current MDI configuration states (dock positions &etc;) of the stand-alone &tdevelop; Assistant documentation browser.</para></listitem> <listitem> <para><filename>kdevclassviewrc</filename> — holds the <guilabel>View Mode</guilabel> setting of the <guilabel>Classes</guilabel> class browser tab provided by the <guilabel>Class View</guilabel> project plugin.</para> <note><para>This is a global setting, although the <guilabel>Class View</guilabel> plugin may be disabled on a per project basis. Any change in this setting will be globally updated whenever the current project is closed and thus affect all subsequently loaded projects.</para></note> </listitem> <listitem><para><filename>kdevcppsupportrc</filename> — holds some settings used to set up CPP source files. In particular you will find the settings made on the <guilabel>C++ Class Generator</guilabel> configuration dialog in here.</para></listitem> <listitem><para><filename>kdevdocumentationrc</filename> — holds actual settings the <guilabel>Documentation</guilabel> plugin uses.</para></listitem> - <listitem><para><filename>kdeveloprc</filename> — holds the global settings the &kdevelop; IDE and the &kdevelop; Assistant stand-alone documentation browser will use.</para></listitem> - <listitem><para><filename>kdevelopuimode4rc</filename> — holds the current MDI configuration states (dock positions &etc;) of the &kdevelop; IDE.</para></listitem> + <listitem><para><filename>tdeveloprc</filename> — holds the global settings the &tdevelop; IDE and the &tdevelop; Assistant stand-alone documentation browser will use.</para></listitem> + <listitem><para><filename>tdevelopuimode4rc</filename> — holds the current MDI configuration states (dock positions &etc;) of the &tdevelop; IDE.</para></listitem> <listitem><para><filename>kdevfileselectorrc</filename> — holds actual settings the <guilabel>File Selector</guilabel> plugin uses.</para></listitem> <listitem><para><filename>kdevfileviewrc</filename> — holds the actual filename color settings the <guilabel>CVS Integration (Cervisia)</guilabel> project plugin uses for display.</para></listitem> <listitem><para><filename>kdevfilterrc</filename> — holds actual settings the <guilabel>Shell Filtering and Insertion</guilabel> plugin uses.</para></listitem> @@ -399,10 +399,10 @@ There are two groups of &kdevelop; configuration files in the <filename class="d <title>Project Dependent Configuration</title> <para> -Most project dependend configuration is kept in the <filename><project-name>.kdevelop</filename> and <filename><project-name>.kdevses</filename> &kdevelop; project configuration files rather than in separate files as the other, more global, configuration settings. In short, those files are meant for: +Most project dependend configuration is kept in the <filename><project-name>.tdevelop</filename> and <filename><project-name>.kdevses</filename> &tdevelop; project configuration files rather than in separate files as the other, more global, configuration settings. In short, those files are meant for: </para> <simplelist> - <member><filename><project-name>.kdevelop</filename> — global project configuration information.</member> + <member><filename><project-name>.tdevelop</filename> — global project configuration information.</member> <member><filename><project-name>.kdevses</filename> — configuration information needed to restore the specific behaviours of the running session.</member> </simplelist> <para> @@ -412,7 +412,7 @@ Both are &XML; coded files. They can be viewed and (cautiously) altered using an <sect2> <title>Persistent Code Store Files</title> -<para>There is a third project dependend configuration file, the <filename><project-name>.kdevelop.pcs</filename> Persistant Code Store. This is a binary coded file holding an internal parser cache for the most part in order to speed up the loading sequence of the project. Additionally, this Persistant Code Store keeps information use by the <guilabel>Code Completion</guilabel> facility of &kdevelop;. +<para>There is a third project dependend configuration file, the <filename><project-name>.tdevelop.pcs</filename> Persistant Code Store. This is a binary coded file holding an internal parser cache for the most part in order to speed up the loading sequence of the project. Additionally, this Persistant Code Store keeps information use by the <guilabel>Code Completion</guilabel> facility of &tdevelop;. </para> <note><para> diff --git a/doc/kdevelop/app-uimodes-examples.docbook b/doc/kdevelop/app-uimodes-examples.docbook index 24b93c61..d8bbeb7d 100644 --- a/doc/kdevelop/app-uimodes-examples.docbook +++ b/doc/kdevelop/app-uimodes-examples.docbook @@ -1,5 +1,5 @@ <appendix id="app-uimodes-examples"> -<title>&kdevelop; User Interface Mode Examples</title> +<title>&tdevelop; User Interface Mode Examples</title> <sect1 id="ideal-desc"> <title>IDEAl Mode</title> @@ -11,10 +11,10 @@ Click <link linkend="uimodes-survey">here</link> to return to the modes overview <screenshot> <mediaobject> <imageobject> - <imagedata fileref="kdevelop-ideal-mode.png" format="PNG"/> + <imagedata fileref="tdevelop-ideal-mode.png" format="PNG"/> </imageobject> <textobject><phrase>Screenshot</phrase></textobject> - <caption><para>&kdevelop; IDEAl mode</para></caption> + <caption><para>&tdevelop; IDEAl mode</para></caption> </mediaobject> </screenshot> @@ -25,10 +25,10 @@ Click <link linkend="uimodes-survey">here</link> to return to the modes overview <screenshot> <mediaobject> <imageobject> - <imagedata fileref="kdevelop-ideal-mode-0.png" format="PNG"/> + <imagedata fileref="tdevelop-ideal-mode-0.png" format="PNG"/> </imageobject> <textobject><phrase>Screenshot</phrase></textobject> - <caption><para>&kdevelop; IDEAl mode, closed tabs</para></caption> + <caption><para>&tdevelop; IDEAl mode, closed tabs</para></caption> </mediaobject> </screenshot> @@ -57,10 +57,10 @@ Click <link linkend="uimodes-survey">here</link> to return to the modes overview <screenshot> <mediaobject> <imageobject> - <imagedata fileref="kdevelop-mdi-mode.png" format="PNG"/> + <imagedata fileref="tdevelop-mdi-mode.png" format="PNG"/> </imageobject> <textobject><phrase>Screenshot</phrase></textobject> - <caption><para>&kdevelop; child frame windows mode</para></caption> + <caption><para>&tdevelop; child frame windows mode</para></caption> </mediaobject> </screenshot> @@ -82,10 +82,10 @@ Click <link linkend="uimodes-survey">here</link> to return to the modes overview <screenshot> <mediaobject> <imageobject> - <imagedata fileref="kdevelop-tabbed-mode.png" format="PNG"/> + <imagedata fileref="tdevelop-tabbed-mode.png" format="PNG"/> </imageobject> <textobject><phrase>Screenshot</phrase></textobject> - <caption><para>&kdevelop; tabbed pages mode</para></caption> + <caption><para>&tdevelop; tabbed pages mode</para></caption> </mediaobject> </screenshot> @@ -107,10 +107,10 @@ Click <link linkend="uimodes-survey">here</link> to return to the modes overview <screenshot> <mediaobject> <imageobject> - <imagedata fileref="kdevelop-toplevel-mode.png" format="PNG"/> + <imagedata fileref="tdevelop-toplevel-mode.png" format="PNG"/> </imageobject> <textobject><phrase>Screenshot</phrase></textobject> - <caption><para>&kdevelop; toplevel windows mode</para></caption> + <caption><para>&tdevelop; toplevel windows mode</para></caption> </mediaobject> </screenshot> diff --git a/doc/kdevelop/applicationwizard.docbook b/doc/kdevelop/applicationwizard.docbook index 6370cb12..601cc801 100644 --- a/doc/kdevelop/applicationwizard.docbook +++ b/doc/kdevelop/applicationwizard.docbook @@ -16,10 +16,10 @@ <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. +In &tdevelop; software development work is organized in <emphasis>projects</emphasis>. Such a project keeps everything together which belongs to a complete programming task: source files, additional data files, any actually needed management facilities as the make system as well as access to all components and any additional tools needed to get the application up and running. </para> <para> -Organizing all development work in projects allows you to easily switch between the global tasks at hand. This is quite handy if you ⪚ work on several applications at the same time as is often the case. Tell &kdevelop; to open the project you want to work at and you may proceed in the environment just where you left. +Organizing all development work in projects allows you to easily switch between the global tasks at hand. This is quite handy if you ⪚ work on several applications at the same time as is often the case. Tell &tdevelop; to open the project you want to work at and you may proceed in the environment just where you left. </para> <sect1 id="new-projects"> @@ -36,7 +36,7 @@ Organizing all development work in projects allows you to easily switch between Whenever you want to initiate a new programming project quite a lot of formal setup procedures need to be done. An initial directory structure has to be set up, initial header and source files must be provided, the make system has to be initialized, &etc; </para> <para> -&kdevelop; provides an easy way to initiate a new programming project—the <emphasis>&appwizard;</emphasis>. You will find the &appwizard; at menu entry <menuchoice><guimenu>Project</guimenu> <guimenuitem>New Project</guimenuitem></menuchoice>. +&tdevelop; provides an easy way to initiate a new programming project—the <emphasis>&appwizard;</emphasis>. You will find the &appwizard; at menu entry <menuchoice><guimenu>Project</guimenu> <guimenuitem>New Project</guimenuitem></menuchoice>. </para> <para> Only a short series of steps is necessary to start a new programming project, using the &appwizard;: @@ -83,7 +83,7 @@ Let's look at all this in more detail now ... <secondary>project</secondary></indexterm> <para> -To create a new project in &kdevelop;, select <guimenuitem>New Project</guimenuitem> from the <guimenu>Project</guimenu> menu. The <guilabel>Create New Project</guilabel> dialog will pop up showing an initial <guilabel>General</guilabel> page: +To create a new project in &tdevelop;, select <guimenuitem>New Project</guimenuitem> from the <guimenu>Project</guimenu> menu. The <guilabel>Create New Project</guilabel> dialog will pop up showing an initial <guilabel>General</guilabel> page: </para> <screenshot id="screenshot-newprojectwizard"> @@ -318,7 +318,7 @@ There are two ways to select another path for your new application. One is to se This is done in the second row input field of the <guilabel>Properties</guilabel>, named <guilabel>Location</guilabel>. What you enter here is the <emphasis>starting path</emphasis> of the new application development directory. The &appwizard; appends the application name to this path when it initializes the new project. The result is shown in the <guilabel>Final location</guilabel> line to give you better control on what is going on. </para> <para> -&appwizard; will copy an <emphasis>initial value</emphasis> to the <guilabel>Location</guilabel> field on start-up. This is taken from what you have chosen in the <guilabel>Default projects directory</guilabel> field during the <link linkend="setup-general">general configuration steps</link>. In our case we have &kdevelop; set up to use <filename class="directory">/home/devel/projects/</filename> as initial path for new projects. +&appwizard; will copy an <emphasis>initial value</emphasis> to the <guilabel>Location</guilabel> field on start-up. This is taken from what you have chosen in the <guilabel>Default projects directory</guilabel> field during the <link linkend="setup-general">general configuration steps</link>. In our case we have &tdevelop; set up to use <filename class="directory">/home/devel/projects/</filename> as initial path for new projects. </para> <para> Alter the <guilabel>Location</guilabel> field contents so that the application development directory shown in the <guilabel>Final location</guilabel> line will be unique. @@ -439,7 +439,7 @@ Otherwise you must reselect the version control system you want to use from the </screenshot> <para> -A version control system such as &CVS; (which means <quote>Concurrent Versions System</quote>) stores copies of selected project files in some sort of a database. If you use &CVS; you can amongst others upload (<quote>commit</quote>) those files or load them back into your project directory (<quote>checkout</quote>, or <quote>update</quote>). The special thing about this is that the files in the versioning database are stored in a structured way which allows you to always revert to an earlier development state if you need so. And &CVS; allows multiple designers to fairly easily collaborate on a big project (such as &kdevelop;) without disturbing each others work. +A version control system such as &CVS; (which means <quote>Concurrent Versions System</quote>) stores copies of selected project files in some sort of a database. If you use &CVS; you can amongst others upload (<quote>commit</quote>) those files or load them back into your project directory (<quote>checkout</quote>, or <quote>update</quote>). The special thing about this is that the files in the versioning database are stored in a structured way which allows you to always revert to an earlier development state if you need so. And &CVS; allows multiple designers to fairly easily collaborate on a big project (such as &tdevelop;) without disturbing each others work. </para> <indexterm zone="new-projects-start-cvs-root"> @@ -465,7 +465,7 @@ A version control system such as &CVS; (which means <quote>Concurrent Versions S <formalpara id="new-projects-start-cvs-root"> <title>&CVS; Root</title> <para> -&CVS; needs to <emphasis>manage</emphasis> the versioning database it keeps from your project files. To accomplish this it keeps some special database information in an own directory, called the <emphasis>&CVS; root</emphasis>. The first step on setting up &CVS; for your new project thus is to tell &kdevelop; where this root is located. +&CVS; needs to <emphasis>manage</emphasis> the versioning database it keeps from your project files. To accomplish this it keeps some special database information in an own directory, called the <emphasis>&CVS; root</emphasis>. The first step on setting up &CVS; for your new project thus is to tell &tdevelop; where this root is located. </para> </formalpara> @@ -483,10 +483,10 @@ In fact, this is a short form. Exactly, the local &CVS; root should be addressed Enter the name of the &CVS; root directory your system has been set up for in the <guilabel>CVS root</guilabel> field. In principle you can select any name, even use multiple &CVS; databases, but it is advisable that you stick to the &CVS; root once set up. </para> <para> -<emphasis>Initialize a new &CVS; root.</emphasis> If there does not exist a &CVS; root yet, &kdevelop; can command the &CVS; system to create one for you in the given directory. Just check the <guilabel>Init root</guilabel> checkbox below the <guilabel>CVS root</guilabel> field. +<emphasis>Initialize a new &CVS; root.</emphasis> If there does not exist a &CVS; root yet, &tdevelop; can command the &CVS; system to create one for you in the given directory. Just check the <guilabel>Init root</guilabel> checkbox below the <guilabel>CVS root</guilabel> field. </para> <note><para> -As said, &kdevelop; only <emphasis>commands</emphasis> the &CVS; system to initialize a new &CVS; root. It does nothing by itself to this directory. Fortunately &CVS; is clever enough to check whether the &CVS; root directory already exists. Hence it does no harm if you should have inadvertently checked <guilabel>Init root</guilabel> on an already existing &CVS; root directory. +As said, &tdevelop; only <emphasis>commands</emphasis> the &CVS; system to initialize a new &CVS; root. It does nothing by itself to this directory. Fortunately &CVS; is clever enough to check whether the &CVS; root directory already exists. Hence it does no harm if you should have inadvertently checked <guilabel>Init root</guilabel> on an already existing &CVS; root directory. </para></note> <para> @@ -540,11 +540,11 @@ for an rsh or ssh encrypted server type. For example accesses the &CVS; root of the widely used <application>Cervisia</application> &CVS; management tool on the SourceForge server. </para> <para> -If you want to use an rsh or ssh encrypted server for &CVS; access you must tell &kdevelop; the encryption protocol to be used. Just enter <userinput>rsh</userinput> or <userinput>ssh</userinput> in the <guilabel>CVS_RSH</guilabel> field of the <guilabel>Create New Project</guilabel> <guilabel>Version Control System</guilabel> page. +If you want to use an rsh or ssh encrypted server for &CVS; access you must tell &tdevelop; the encryption protocol to be used. Just enter <userinput>rsh</userinput> or <userinput>ssh</userinput> in the <guilabel>CVS_RSH</guilabel> field of the <guilabel>Create New Project</guilabel> <guilabel>Version Control System</guilabel> page. </para> <note><para> -There is a caveat if you use an encrypted server for &CVS; from within &kdevelop;. See the <link linkend="cvs">Using &CVS;</link> chapter for details. +There is a caveat if you use an encrypted server for &CVS; from within &tdevelop;. See the <link linkend="cvs">Using &CVS;</link> chapter for details. </para></note> <indexterm zone="new-projects-start-cvs-repository"> @@ -557,7 +557,7 @@ There is a caveat if you use an encrypted server for &CVS; from within &kdevelop <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>. +So far you have told &tdevelop; where the &CVS; root resides which manages the versioning database and how to access it. Now you need to tell &tdevelop; under which name you want &CVS; save your project files in that database. Such a place your project files will be held in &CVS; is called a <emphasis>repository</emphasis>. </para> </formalpara> <para> @@ -592,7 +592,7 @@ The &appwizard; has put a default <quote>start</quote> tag in here which is a wo <note> <para> -When any information of all these is wrong &kdevelop; usually will not know about until project construction time. It is the &CVS; system which will figure out those errors when it tries to build the repository. Hence you must keep an eye to the <guilabel>Messages</guilabel> window of &kdevelop; when the project is created in the final setup step. If anything was in error with &CVS; you will in most cases see an error message like this: +When any information of all these is wrong &tdevelop; usually will not know about until project construction time. It is the &CVS; system which will figure out those errors when it tries to build the repository. Hence you must keep an eye to the <guilabel>Messages</guilabel> window of &tdevelop; when the project is created in the final setup step. If anything was in error with &CVS; you will in most cases see an error message like this: </para> <screen><computeroutput> @@ -606,7 +606,7 @@ When any information of all these is wrong &kdevelop; usually will not know abou </computeroutput></screen> <para> -If this happens you will have to either manually set up &CVS; (&kdevelop; should have successfully initialized your project files at this time) or delete the project directory and start over again with <guimenuitem>New Project</guimenuitem> from the <guimenu>Project</guimenu> menu. +If this happens you will have to either manually set up &CVS; (&tdevelop; should have successfully initialized your project files at this time) or delete the project directory and start over again with <guimenuitem>New Project</guimenuitem> from the <guimenu>Project</guimenu> menu. </para> </note> @@ -675,10 +675,10 @@ As you might have noticed, the applications manager did readily fill in some inf <tertiary>edit</tertiary></indexterm> <para> -The templates you set up in the <guilabel>Create New Project</guilabel> dialog will later be processed whenever you command &kdevelop; to set up a new source and/or header file. The information you provided here will be included at top as a documentation header, before the code parts begin. +The templates you set up in the <guilabel>Create New Project</guilabel> dialog will later be processed whenever you command &tdevelop; to set up a new source and/or header file. The information you provided here will be included at top as a documentation header, before the code parts begin. </para> <para> -You are not restricted to plain text however. &kdevelop; knows of several variables which allow you to include actual information in the file. The &appwizard; did in fact use some such variables to insert the <guilabel>Author</guilabel>, <guilabel>Email</guilabel>, and <guilabel>License</guilabel> informations into the initial template text. +You are not restricted to plain text however. &tdevelop; knows of several variables which allow you to include actual information in the file. The &appwizard; did in fact use some such variables to insert the <guilabel>Author</guilabel>, <guilabel>Email</guilabel>, and <guilabel>License</guilabel> informations into the initial template text. </para> <variablelist> @@ -695,7 +695,7 @@ If, for example, you want the &doxygen;-built &API; documentation to display som **/ </computeroutput></screen> <para> -Whenever you create a new source file, &kdevelop; will replace the <varname>$MODULE$</varname> variable by the name body of the newly created file. For example, if you created a new C++ class named <classname>ASimpleTest</classname> you will see the following lines in the <filename>asimpletest.cpp</filename> file: +Whenever you create a new source file, &tdevelop; will replace the <varname>$MODULE$</varname> variable by the name body of the newly created file. For example, if you created a new C++ class named <classname>ASimpleTest</classname> you will see the following lines in the <filename>asimpletest.cpp</filename> file: </para> <screen><computeroutput> /** @@ -735,7 +735,7 @@ for the <acronym>GPL</acronym> license, or if you decided to put your application under the <acronym>BSD</acronym> license. </para> <para> -Thee are of course more variables &kdevelop; knows of. See the <link linkend="newfiles-edittemplates">Editing the templates</link> section in the <link linkend="editing">Editing tools</link> chapter for what is possible. +Thee are of course more variables &tdevelop; knows of. See the <link linkend="newfiles-edittemplates">Editing the templates</link> section in the <link linkend="editing">Editing tools</link> chapter for what is possible. </para> </listitem> </varlistentry> @@ -773,7 +773,7 @@ If you want to use a versioning system (&CVS;) there will be two runs actually. </para> <note><para> -In many cases when your new project has been set up this way, &kdevelop; will automatically load the source file(s) of one or more basically important modules so you can readily start work. (Which source modules will be displayed—if any at all—however depends on the template initially selected in the &appwizard;.) +In many cases when your new project has been set up this way, &tdevelop; will automatically load the source file(s) of one or more basically important modules so you can readily start work. (Which source modules will be displayed—if any at all—however depends on the template initially selected in the &appwizard;.) </para></note> <para> diff --git a/doc/kdevelop/class-browsers.docbook b/doc/kdevelop/class-browsers.docbook index 7c251ee1..a0358761 100644 --- a/doc/kdevelop/class-browsers.docbook +++ b/doc/kdevelop/class-browsers.docbook @@ -6,7 +6,7 @@ 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 +of defined classes and symbols, &tdevelop; includes various class browsers that visualize the class structure in different ways. </para> diff --git a/doc/kdevelop/credits.docbook b/doc/kdevelop/credits.docbook index 77712cc4..d47af015 100644 --- a/doc/kdevelop/credits.docbook +++ b/doc/kdevelop/credits.docbook @@ -7,7 +7,7 @@ <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>. + The initial contents of this manual were witten by Bernd Gehrmann <email>bernd@tdevelop.org</email> and Caleb Tennis <email>caleb@aei-tech.com</email>. </para></listitem> <listitem><para> The <link linkend="automake-manager-summary">Summary of &automanag;</link> and <link linkend="automake-manager-operation">Automake Manager Operation</link> chapters were written by Ian Wadham, <email>ianw@netspace.net.au</email>). diff --git a/doc/kdevelop/cvs.docbook b/doc/kdevelop/cvs.docbook index ccdce4e6..116e24f6 100644 --- a/doc/kdevelop/cvs.docbook +++ b/doc/kdevelop/cvs.docbook @@ -39,7 +39,7 @@ differences between revisions, the revision history of files &etc; 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; +url="http://tkcvs.sf.net"/>). In &tdevelop;, only a small part of the &cvs; functionality which is important for your daily work can be used directly. </para> @@ -56,7 +56,7 @@ distributed (except for the non-technical chapters). See <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> <sect1 id="cvs-commands"> -<title>&CVS; Commands in &kdevelop;</title> +<title>&CVS; Commands in &tdevelop;</title> <para> In the file views, the following context menu items are available: @@ -109,7 +109,7 @@ Otherwise, when another user has committed his own changes before, </variablelist> <para> -All these commands are invoked as subprocesses by &kdevelop; without any +All these commands are invoked as subprocesses by &tdevelop; 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 diff --git a/doc/kdevelop/debugger.docbook b/doc/kdevelop/debugger.docbook index a06f2c83..247d26ff 100644 --- a/doc/kdevelop/debugger.docbook +++ b/doc/kdevelop/debugger.docbook @@ -3,7 +3,7 @@ <indexterm zone="debugger"><primary>debugger</primary></indexterm> <para> -For C and C++, &kdevelop; contains an internal debugger that is directly +For C and C++, &tdevelop; 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: @@ -100,13 +100,13 @@ via the context menu. <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 +&tdevelop; uses <application>GDB</application>, so to fully understand the +&tdevelop; 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>. +<filename>tdevelop/languages/cpp/debugger/breakpoint.h</filename>. </para> <para>At the left edge, the window has buttons to:</para> @@ -215,10 +215,10 @@ 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 +Therefore, &tdevelop; 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 +notifies that a library is loaded, &tdevelop; tries to set the pending breakpoints. </para> </listitem> diff --git a/doc/kdevelop/documentation.docbook b/doc/kdevelop/documentation.docbook index eed065b0..2214fed3 100644 --- a/doc/kdevelop/documentation.docbook +++ b/doc/kdevelop/documentation.docbook @@ -36,7 +36,7 @@ Documentation has multiple facets. There is </itemizedlist> </para> <para> -All this documentation should be easily maintainable and ready at hand whenever you need it. &kdevelop; has provisions for just this. +All this documentation should be easily maintainable and ready at hand whenever you need it. &tdevelop; has provisions for just this. </para> <!-- ### doc browser, notes on internal documentation, how to profit from Doxygen --> diff --git a/doc/kdevelop/file-browsers.docbook b/doc/kdevelop/file-browsers.docbook index f8b37735..93a096e5 100644 --- a/doc/kdevelop/file-browsers.docbook +++ b/doc/kdevelop/file-browsers.docbook @@ -2,7 +2,7 @@ <title>The File Browsers</title> <para> -On the left side of the main window, &kdevelop; can display various kinds of +On the left side of the main window, &tdevelop; can display various kinds of lists and trees for the selection of files: </para> @@ -13,14 +13,14 @@ lists and trees for the selection of files: <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 +contain text, &tdevelop; 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;, +&tdevelop;), 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> @@ -62,7 +62,7 @@ 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 +the groups. For each file, &tdevelop; 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 diff --git a/doc/kdevelop/getting-started.docbook b/doc/kdevelop/getting-started.docbook index 11a08253..33bfee94 100644 --- a/doc/kdevelop/getting-started.docbook +++ b/doc/kdevelop/getting-started.docbook @@ -14,9 +14,9 @@ Keep lines at 80 characters length maximum. </authorgroup> </chapterinfo> -<title>Getting Started with &kdevelop; — a Guided Tour</title> +<title>Getting Started with &tdevelop; — a Guided Tour</title> -<para>Now that you have got your new &kdevelop; &IDE;, how are you going to make +<para>Now that you have got your new &tdevelop; &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> @@ -27,7 +27,7 @@ at:</para> <simplelist> <member><link linkend="gettingstarted-overview">A first look — the user -interface elements of the &kdevelop; &IDE;.</link></member> +interface elements of the &tdevelop; &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> @@ -50,20 +50,20 @@ shortcuts</link></member> <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 +<para>As said, &tdevelop; is an <emphasis>Integrated Development +Environment</emphasis>. That means in essence that &tdevelop; 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 +<para>While &tdevelop; 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 +fully understand the &tdevelop; &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 +to some of the ways &tdevelop; 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 @@ -71,20 +71,20 @@ 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; +<para>The following discussions apply to the default case, where &tdevelop; 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 +mode your &tdevelop; 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> +<title>A Very First Look at &tdevelop;</title> -<para>This is all about what you will see when you first started &kdevelop;. +<para>This is all about what you will see when you first started &tdevelop;. You will find preliminary information about:</para> <simplelist> @@ -101,7 +101,7 @@ for?</link></member> <sect2 id="gettingstarted-overview-basic"> <title>On the Surface</title> -<para>When you start &kdevelop; for the first time you will get a display +<para>When you start &tdevelop; for the first time you will get a display similar to this one:</para> <screenshot> @@ -110,8 +110,8 @@ similar to this one:</para> <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 +<para>The &tdevelop; initial layout</para> +<para>(Actually the initial &tdevelop; window will be larger, but the elements you see are the same.)</para> </caption> </mediaobject> @@ -119,7 +119,7 @@ you see are the same.)</para> <formalpara> <title>Workspace Area and Tool View Tabs</title> -<para>In this initial case &kdevelop; uses the so-called <link +<para>In this initial case &tdevelop; 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 @@ -196,7 +196,7 @@ the <link linkend="commands">Command Reference</link>.</para> <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> +document files as well as quitting the &tdevelop; application as usual.</para> </formalpara> <formalpara> @@ -282,7 +282,7 @@ text.</para> <varlistentry> <term><guimenu>Project</guimenu></term> <listitem> -<para>All work of &kdevelop; is based on <emphasis>projects</emphasis> which +<para>All work of &tdevelop; 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. @@ -365,7 +365,7 @@ application in the debugger and step through it in various ways.</para> <formalpara> <title>Breakpoints</title> -<para>&kdevelop; provides several means to set breakpoints in your application +<para>&tdevelop; 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> @@ -406,7 +406,7 @@ editor window horizontally as well as vertically.</para> <varlistentry> <term><guimenu>Tools</guimenu></term> <listitem> -<para>&kdevelop; is highly customizable. +<para>&tdevelop; 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> @@ -445,7 +445,7 @@ purposes.</para> <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> +&tdevelop;'s general behavior.</para> </listitem> </varlistentry> @@ -496,7 +496,7 @@ different main purpose.</para> <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 +Tools</link> being currently available to &tdevelop;. 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 @@ -534,7 +534,7 @@ menu.</para> <formalpara> <title>Application</title> <para>Displays the output from an application started from within -&kdevelop;.</para> +&tdevelop;.</para> </formalpara> <formalpara> @@ -548,7 +548,7 @@ Viewer...</guimenuitem></menuchoice> menu.</para> <formalpara> <title>Messages</title> <para>Displays messages produced by the build tools called from within -&kdevelop;, usually from the <guimenu>Build</guimenu> menu.</para> +&tdevelop;, usually from the <guimenu>Build</guimenu> menu.</para> </formalpara> <formalpara> @@ -570,7 +570,7 @@ 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 +project has been loaded into &tdevelop;. 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> @@ -590,7 +590,7 @@ interface.</para> <listitem> <formalpara> <title>Documentation</title> -<para>&kdevelop; provides access to a whole bunch of documentation through this +<para>&tdevelop; 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> @@ -621,19 +621,19 @@ chapters.</para> <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 +&tdevelop; 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 +<para>If you want to know more about &tdevelop; 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 +<para>To configure &tdevelop;, 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 @@ -645,7 +645,7 @@ following <guilabel>General</guilabel> settings page to the right.</para> <imagedata fileref="configure-general.png" format="PNG"/> </imageobject> <caption> -<para>The &kdevelop; general configuration dialog</para> +<para>The &tdevelop; general configuration dialog</para> </caption> </mediaobject> </screenshot> @@ -655,7 +655,7 @@ 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 +<para>At first start of &tdevelop; 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 @@ -671,7 +671,7 @@ 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 +<para>&tdevelop; 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> @@ -682,15 +682,15 @@ for more info on this.</para> <formalpara> <title>Compiler output</title> -<para>Whenever &kdevelop; compiles some source, it will display the messages of +<para>Whenever &tdevelop; 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 +of what happens, &tdevelop; has some means of shortening those messages built in.</para> </formalpara> -<para>Depending on the &kdevelop; version you use, the <guilabel>Compiler +<para>Depending on the &tdevelop; 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 @@ -711,13 +711,13 @@ Output</quote> from the popup menu.</para> <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; +want to perform documentation search regularly during development. &tdevelop; 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> +toward actual &tdevelop; 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 +the &tdevelop; main window. There open the <guilabel>Search</guilabel> dialog page.</para> <screenshot> @@ -734,7 +734,7 @@ 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 +<para>This done, &tdevelop; 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 @@ -745,7 +745,7 @@ operations.</para> <imageobject> <imagedata fileref="configure-docu-indexgen.png" format="PNG"/> </imageobject> -<caption><para>&kdevelop; is generating documentation search +<caption><para>&tdevelop; is generating documentation search indexes.</para></caption> </mediaobject> </screenshot> @@ -758,7 +758,7 @@ place to <guibutton>OK</guibutton>. Just press this button to proceed.</para> <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 +<application>htdig</application> application &tdevelop; 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> @@ -766,10 +766,10 @@ for more help in this case.</para> <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 +&tdevelop; 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 +and is accessible to &tdevelop;. See <link linkend="tdevelop-install">Installing KDevelop</link> fore more detail.</para> </listitem> </itemizedlist> @@ -783,17 +783,17 @@ KDevelop</link> fore more detail.</para> <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 +&tdevelop; 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> +in &tdevelop; usually is to create a new project.</para> -<para>Fortunately this is fairly easily accomplished. &kdevelop; provides the +<para>Fortunately this is fairly easily accomplished. &tdevelop; 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 +easily this is accomplished and which files and tools &tdevelop; will have provided. Thereby we will have a short look at:</para> <simplelist> @@ -927,7 +927,7 @@ 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 +<para>Once this file creation phase is finished, &tdevelop; 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> @@ -990,8 +990,8 @@ created.</para> </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 +create inside &tdevelop; (provided you use the proper built in tools for file +creation). &tdevelop; remembers these settings in some template files you may find in the <filename class="directory">templates</filename> directory.</para> <formalpara> @@ -1040,13 +1040,13 @@ application, namely</para> <itemizedlist> <listitem> <para><filename>hello.desktop</filename> contains some meta data used by -&kdevelop; to maintain and start the application.</para> +&tdevelop; 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> +&tdevelop; will use for application display.</para> </listitem> <listitem> @@ -1103,7 +1103,7 @@ 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 +throughout the development process. Luckily, &tdevelop; 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> @@ -1118,20 +1118,20 @@ binaries.</para> <listitem> <formalpara> -<title>&kdevelop; Control Files</title> -<para>&kdevelop; needs some control and administration data on its own. These +<title>&tdevelop; Control Files</title> +<para>&tdevelop; 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>, +<filename>hello.tdevelop</filename>, <filename>hello.tdevelop.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 +<filename>xxx.tdevelop</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; +<para>Never do manually modify, rename, or even delete any of these &tdevelop; control files! The &IDE; will most likely not function properly on your project afterwards.</para> </warning> @@ -1203,7 +1203,7 @@ 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 +into &tdevelop;. There are ways to control this. See the <link linkend="setup-plugins">Plugin Tools</link> chapter for instructions.</para> </note> @@ -1215,7 +1215,7 @@ linkend="setup-plugins">Plugin Tools</link> chapter for instructions.</para> <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 +position from everywhere. &tdevelop; 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 @@ -1268,7 +1268,7 @@ memory leaks.</para> <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 +&tdevelop;. 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> @@ -1297,7 +1297,7 @@ position the cursor on the appropriate identifier there.</para> <listitem> <formalpara> <title>Problems</title> -<para>&kdevelop; keeps track of common programming problems in the currently +<para>&tdevelop; keeps track of common programming problems in the currently edited source file and notifies the user in this tool view window.</para> </formalpara> </listitem> @@ -1345,7 +1345,7 @@ a more extensive description.</para> <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 +handy &tdevelop; 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> @@ -1363,7 +1363,7 @@ common problems.</link></member> <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 +<para>&tdevelop; 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> @@ -1379,20 +1379,20 @@ files.</para></caption> </screenshot> <para>Find the <guimenuitem>Switch header/implementation</guimenuitem> entry and -select it. &kdevelop; will look up the corresponding header or implementation +select it. &tdevelop; 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 +implementation, &tdevelop; 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 +&tdevelop; will of course activate this one and reposition the cursor there if necessary.</para> </sect2> @@ -1417,8 +1417,8 @@ internal text items</link>.</member> <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 +documented in various &kde; or &Qt; libraries. If &kde; and &tdevelop; were +properly installed, &tdevelop; 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 @@ -1475,7 +1475,7 @@ then come back here and try again.</para> <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 +defined and used inside the current project. But there is help. &tdevelop; can use indexes built by the <application>CTags</application> application to search the sources in your project.</para> @@ -1518,14 +1518,14 @@ possibilities.</para> <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 +<guilabel>Lookup</guilabel> input field in the bottom left. &tdevelop; 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 +<guilabel>Lookup</guilabel> input field. &tdevelop; will immediately start working and present you a result like this:</para> <screenshot> @@ -1538,7 +1538,7 @@ tool view.</para></caption> </mediaobject> </screenshot> -<para>If you click one of the listed entries, &kdevelop; will open an editor +<para>If you click one of the listed entries, &tdevelop; will open an editor window with this file and position the cursor on the appropriate place.</para> </listitem> @@ -1568,7 +1568,7 @@ internal identifier.</para></caption> </screenshot> <para>Click what you are interested in, say <guilabel>CTags - Go to Definition: -Hello</guilabel>, and &kdevelop; will immediately open the +Hello</guilabel>, and &tdevelop; will immediately open the <filename>hello.cpp</filename> editor window and position the cursor right in front of this class definition:</para> <programlisting> @@ -1583,7 +1583,7 @@ Hello::Hello() <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> +&tdevelop;.</para> </formalpara> <itemizedlist> <listitem> @@ -1602,7 +1602,7 @@ 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 +occurrences there are. This is a typical case where to use &tdevelop;'s global search facilities.</para> <para>Now, still keeping the cursor somewhere on this <quote>Hello</quote> in @@ -1645,13 +1645,13 @@ 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 +&tdevelop; 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 +<para>Right on top you will find the command sequences &tdevelop; did actually use to perform the search. This will be useful to more precisely control the search outcome.</para> </listitem> @@ -1663,7 +1663,7 @@ listed. In our example this should read <quote>*** 11 matches found </listitem> </itemizedlist> -<para>&kdevelop; will remember these search results throughout the currently +<para>&tdevelop; 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> @@ -1678,7 +1678,7 @@ window.</para> <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 +necessary. &tdevelop; 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 @@ -1699,7 +1699,7 @@ files into development sessions.</link></member> <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 +&tdevelop; 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> @@ -1727,7 +1727,7 @@ may find in other &kde; applications as well. You can use the <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 +another &tdevelop; provides a means to select the candidates from a list and close those, and only those, with one single mouse click.</para> </formalpara> @@ -1766,7 +1766,7 @@ step.</para></caption> </mediaobject> </screenshot> <para>That was all. -&kdevelop; will have closed all editor windows at your wish, and you are ready +&tdevelop; will have closed all editor windows at your wish, and you are ready to proceed with a clean tab bar again.</para> </sect3> @@ -1774,7 +1774,7 @@ to proceed with a clean tab bar again.</para> <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 +still want to have their tabs arranged in some logical way. &tdevelop; provides some common means to do so, in short:</para> <formalpara> @@ -1784,7 +1784,7 @@ some common means to do so, in short:</para> 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 +<para>You must change a basic user interface setting in &tdevelop; to enable this behavior.</para> <procedure> <step> @@ -1802,7 +1802,7 @@ 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 +<para>Close &tdevelop; 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> @@ -1810,13 +1810,13 @@ open at the far right end of the current tabs row.</para> <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> +&tdevelop;.</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> +&tdevelop;.</para> </formalpara> <para> Just click the tab you want to move with the middle mouse button and move the @@ -1832,7 +1832,7 @@ into the place where you want it to be.</para> 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, +&tdevelop; provides a way to split the workspace area into different, simultaneously visible sections which each can hold their own series of tabbed windows.</para> @@ -1905,11 +1905,11 @@ It closes automatically, once the last tabbed window in it was closed.</para> <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 +feature built into &tdevelop;. 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 +you select a declaration in the header file &tdevelop; 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 @@ -1942,7 +1942,7 @@ 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 +<filename>hello.h</filename> belonging to it, &tdevelop; will automatically split the workspace and open this header file editor window just beneath the <filename>hello.cpp</filename> window.</para> @@ -1953,7 +1953,7 @@ line:</para> 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 +window below and note how &tdevelop; did navigate to the corresponding default constructor declaration line.</para> <screenshot> @@ -1961,13 +1961,13 @@ constructor declaration line.</para> <imageobject> <imagedata fileref="split-source-header-navigate.png" format="PNG"/> </imageobject> -<caption><para>&kdevelop; automatically navigated to the constructor +<caption><para>&tdevelop; 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 +a construct in one editor window, &tdevelop; will navigate to the corresponding construct in the other.</para> </sect3> @@ -1977,7 +1977,7 @@ construct in the other.</para> <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 +sessions. The <guilabel>File List</guilabel> tool view of &tdevelop; allows you do to just this.</para> <para>On top of the <guilabel>File List</guilabel> tool view window there is a @@ -2034,7 +2034,7 @@ 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 +icon in the toolbar. Do not skip this step, &tdevelop; will forget the file list otherwise.</para> </step> </substeps> @@ -2042,7 +2042,7 @@ otherwise.</para> </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 +from the <guilabel>Open Session</guilabel> drop down box, &tdevelop; 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> @@ -2053,7 +2053,7 @@ 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 +<para>There is even more. You can force &tdevelop; 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 @@ -2064,7 +2064,7 @@ options configuration page.</para> <imageobject> <imagedata fileref="file-list-session-default.png" format="PNG"/> </imageobject> -<caption><para>Let &kdevelop; open a specific session when the project is +<caption><para>Let &tdevelop; open a specific session when the project is loaded.</para></caption> </mediaobject> </screenshot> @@ -2074,7 +2074,7 @@ loaded.</para></caption> <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 +<para>When you open an editor window containing a source file, &tdevelop; 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 @@ -2107,7 +2107,7 @@ row. If all went right, it will currently report this todo:</para> <imageobject> <imagedata fileref="problem-report-todo.png"/> </imageobject> -<caption><para>&kdevelop; is alerting a source code line containing a todo +<caption><para>&tdevelop; is alerting a source code line containing a todo mark.</para></caption> </mediaobject> </screenshot> @@ -2153,7 +2153,7 @@ currently edited file.</para></caption> <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 +<computeroutput>TODO</computeroutput> marked lines, &tdevelop; has found so far in this session. For example the <computeroutput>TODO</computeroutput> alerts will currently look thus:</para> @@ -2173,7 +2173,7 @@ 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 +<para>You will find the &tdevelop; problem reporter facility a very valuable tool, so check the <guilabel>Problems</guilabel> tool view regularly in the development process.</para> </sect2> @@ -2182,7 +2182,7 @@ development process.</para> <sect1 id="gettingstarted-compile"> <title>How to Compile a Project</title> -<para>Compiling a project in &kdevelop; requires several setup steps and then +<para>Compiling a project in &tdevelop; requires several setup steps and then building the application. All these are available through the <guimenu>Build</guimenu> menu.</para> @@ -2203,7 +2203,7 @@ 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; +<para>For now we will concentrate on several facilities which &tdevelop; provides for project setup, initializing, building, and running an application. In general, this includes:</para> @@ -2229,12 +2229,12 @@ 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> +application from within &tdevelop;.</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 +which enabled the &automanag; tool in &tdevelop; 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 @@ -2263,7 +2263,7 @@ function key, you will get the following warning.</para> </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 +&tdevelop; 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> @@ -2282,12 +2282,12 @@ through the <guimenu>Build</guimenu> menu. Call it up and select </screenshot> <para> -&kdevelop; will now open the <guilabel>Messages</guilabel> tool view window at +&tdevelop; 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; +<para>If you scroll back to the top, you will find the command line, &tdevelop; issued to call up the tools beneath the surface:</para> <programlisting> @@ -2295,7 +2295,7 @@ 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 +<para>This basically tells that &tdevelop; 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. @@ -2323,16 +2323,16 @@ 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 +<para>&tdevelop; 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 +configure) followed by the &tdevelop; <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> +the command line, &tdevelop; used to initiate this configuration run:</para> <programlisting> mkdir '/home/devel/projects/hello/debug' && \ @@ -2354,7 +2354,7 @@ CXXFLAGS="-O0 -g3" "/home/devel/projects/hello/configure" --enable-debug=full <entry> <itemizedlist> <listitem> -<para>First, &kdevelop; uses a dedicated subdirectory in the project directory +<para>First, &tdevelop; 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 @@ -2365,8 +2365,8 @@ contains some set of build related files, such as several <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 +&tdevelop; uses separate build directories in cases like this one. For the +moment it is enough to know that &tdevelop; 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 @@ -2374,7 +2374,7 @@ 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 +directory, &tdevelop; 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 @@ -2409,7 +2409,7 @@ there are three such compile options from which to select.</para> <imageobject> <imagedata fileref="build-commands.png" format="PNG"/> </imageobject> -<caption><para>&kdevelop; commands to build binaries.</para></caption> +<caption><para>&tdevelop; commands to build binaries.</para></caption> </mediaobject> </screenshot> @@ -2446,14 +2446,14 @@ 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> +&tdevelop; 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 +<para>Not very surprisingly, &tdevelop; 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 @@ -2462,10 +2462,10 @@ 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; +up to its very end, even if errors will occur. This makes sense as &tdevelop; 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 +the <guilabel>Messages</guilabel> window and &tdevelop; will take you to exactly the position where the error occurred in the source file.</para> <para>And what did happen inside the <filename @@ -2500,9 +2500,9 @@ Toolbar</guilabel>.</para> </mediaobject> </screenshot> -<para>That was all. &kdevelop; will now start the new application in +<para>That was all. &tdevelop; 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 +tool view on the bottom. There the command &tdevelop; issued to execute the program will be shown in the top line:</para> <programlisting> @@ -2530,7 +2530,7 @@ our <application>Hello</application> form running.</para> </screenshot> <para>Close the <application>Hello</application> application window as -usual. If no errors occurred, &kdevelop; will report this as +usual. If no errors occurred, &tdevelop; will report this as <quote><computeroutput>*** Exited normally ***</computeroutput></quote> in the <guilabel>Application</guilabel> tool view window.</para> </sect3> @@ -2539,7 +2539,7 @@ in the <guilabel>Application</guilabel> tool view window.</para> <sect2 id="gettingstarted-compile-setup"> <title>Configuring the Project</title> -<para>In &kdevelop; there are numerous ways how you can manage your project. +<para>In &tdevelop; 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. @@ -2564,12 +2564,12 @@ executable be and how should it be called?</link></member> <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 +Configuration</link> section above, we noted that &tdevelop; 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 +<para>First of all, &tdevelop; 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> @@ -2670,7 +2670,7 @@ 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 +<para>This is where the build configurations of &tdevelop; 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> @@ -2699,7 +2699,7 @@ 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 +within &tdevelop; &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> @@ -2762,7 +2762,7 @@ configuration options can be defined:</para> <listitem> <formalpara> <title>Configure arguments</title> -<para>These are the options &kdevelop; assigns to the +<para>These are the options &tdevelop; 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> @@ -2772,7 +2772,7 @@ the <quote>Initial Hello Configuration</quote> section above.</para> <listitem> <formalpara> <title>Build directory</title> -<para>This is the subdirectory in the current project root, where &kdevelop; +<para>This is the subdirectory in the current project root, where &tdevelop; 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 @@ -2792,7 +2792,7 @@ in another place.</para> <listitem> <formalpara> <title>C/C++ preprocessor flags (CPPFLAGS)</title> -<para>Put specific instructions for the preprocessor here. &kdevelop; will +<para>Put specific instructions for the preprocessor here. &tdevelop; 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 @@ -2814,7 +2814,7 @@ temporary build environment as well.</para> <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 +temporal build environment, &tdevelop; 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> @@ -2834,7 +2834,7 @@ so it suffices to have a brief look at the <guilabel>C++</guilabel> page.</para> <imageobject> <imagedata fileref="configure-project-cpp.png" format="PNG"/> </imageobject> -<caption><para>Select the compiler and its working environment &kdevelop; shall +<caption><para>Select the compiler and its working environment &tdevelop; shall use here.</para></caption> </mediaobject> </screenshot> @@ -2845,8 +2845,8 @@ use here.</para></caption> <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 +<para>Select the C++ compiler &tdevelop; should regularly use from this +combo box. It however lists only those compilers &tdevelop; really knows of.</para> </formalpara> </listitem> @@ -2862,7 +2862,7 @@ Put the name by which it is called here.</para> <listitem> <formalpara> <title>Compiler flags (CXXFLAGS)</title> -<para>Here you can enter any extra option &kdevelop; shall pass (via the +<para>Here you can enter any extra option &tdevelop; 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> @@ -2900,7 +2900,7 @@ configuration would have to be altered manually if ever needed.</para> <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 +<para>You can as well configure the way &tdevelop; will call the <application>make</application> tool in the project build. Select <menuchoice><guimenu>Project</guimenu> <guimenuitem>Project Options</guimenuitem></menuchoice> and then the @@ -2913,7 +2913,7 @@ the right.</para> <imageobject> <imagedata fileref="configure-project-make.png" format="PNG"/> </imageobject> -<caption><para>Define how &kdevelop; will call the +<caption><para>Define how &tdevelop; will call the <application>make</application> tool.</para></caption> </mediaobject> </screenshot> @@ -2926,7 +2926,7 @@ You will find it deactivated in most projects. This corresponds to the 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 +<para>This makes sense in an &IDE; like &tdevelop; 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> @@ -2934,12 +2934,12 @@ window. Use <menuchoice><guimenu>View</guimenu> <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 +&tdevelop; 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> +in this dialog. &tdevelop; will then call <application>gmake</application> without the <computeroutput>-k</computeroutput> option.</para> </sect3> @@ -2947,11 +2947,11 @@ without the <computeroutput>-k</computeroutput> option.</para> <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> +&tdevelop;. 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> +Toolbar</guilabel> of &tdevelop;.</para> <screenshot> <mediaobject> @@ -2963,12 +2963,12 @@ Toolbar</guilabel> of &kdevelop;.</para> </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 +one have &tdevelop; 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> +&tdevelop;. 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 @@ -2990,13 +2990,13 @@ Basically there are four groups of configuration items.</para> <listitem> <formalpara> <title>Directory</title> -<para>This tells &kdevelop; where it basically shall assume the +<para>This tells &tdevelop; 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 +&tdevelop; usually looks for the executable in some subdirectory given in the next configuration group.</para> <itemizedlist> @@ -3012,7 +3012,7 @@ 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 +<para>This is the root where &tdevelop; 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> @@ -3037,17 +3037,17 @@ the version located in the project directories.</para> <listitem> <formalpara> <title>Program</title> -<para>This tells &kdevelop; the relative position and name of the +<para>This tells &tdevelop; 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> +argument &tdevelop; 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; +field blank is a common cause of problems. Check this setting if &tdevelop; appears not to call the executable you wanted.</para> </note> </listitem> @@ -3055,7 +3055,7 @@ appears not to call the executable you wanted.</para> <listitem> <formalpara> <title>Environment Variables</title> -<para>&kdevelop; will set up a dedicated shell environment to run the +<para>&tdevelop; will set up a dedicated shell environment to run the program in. Define any extra environment variable in this configuration group.</para> </formalpara> @@ -3070,7 +3070,7 @@ group.</para> <itemizedlist> <listitem> <para><guilabel>Automatically compile before execution</guilabel> comes -in handy most of time. &kdevelop; will check the project for changes and +in handy most of time. &tdevelop; 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> @@ -3081,7 +3081,7 @@ last change.</para> <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 +terminal. This is unchecked by default, so &tdevelop; does start the program in a window of its own without console terminal I/O capabilities.</para> </listitem> </itemizedlist> @@ -3160,17 +3160,17 @@ After building your project, the user manual is displayed in &kde; 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 +<para>All &kde; based templates in &tdevelop; 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 +<filename>index.docbook</filename> in &tdevelop; 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 +root user)</guimenuitem> in &tdevelop; 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 @@ -3205,7 +3205,7 @@ website</ulink>.</para> <para>(- to be written -)</para> <sect3 id="gettingstarted-whereto-projects-open"> -<title>Using Existing &kdevelop; Projects</title> +<title>Using Existing &tdevelop; Projects</title> <para>(- to be written -)</para> </sect3> diff --git a/doc/kdevelop/index.docbook b/doc/kdevelop/index.docbook index 993400c0..e3d800ec 100644 --- a/doc/kdevelop/index.docbook +++ b/doc/kdevelop/index.docbook @@ -1,7 +1,7 @@ <?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 tdevelop "<application>KDevelop</application>"> --> + <!ENTITY tdevelop "KDevelop"> <!ENTITY kdevrelease "3.3.91"> <!-- abbreviations used in the body text --> @@ -32,7 +32,7 @@ <!-- 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 tdevelop-survey SYSTEM "tdevelop-survey.docbook"> <!ENTITY setup SYSTEM "setup.docbook"> <!ENTITY applicationwizard SYSTEM "applicationwizard.docbook"> <!ENTITY editing SYSTEM "editing.docbook"> @@ -46,10 +46,10 @@ <!ENTITY external-progs SYSTEM "external-progs.docbook"> <!ENTITY scripts SYSTEM "scripts.docbook"> <!ENTITY credits SYSTEM "credits.docbook"> - <!ENTITY kdevelop-scripting SYSTEM "kdevelop-scripting.docbook"> + <!ENTITY tdevelop-scripting SYSTEM "tdevelop-scripting.docbook"> <!-- appendices in separate docbook files --> - <!ENTITY kdevelop-install SYSTEM "kdevelop-install.docbook"> + <!ENTITY tdevelop-install SYSTEM "tdevelop-install.docbook"> <!ENTITY nutshell SYSTEM "nutshell.docbook"> <!ENTITY unixdev SYSTEM "unixdev.docbook"> <!ENTITY app-menu SYSTEM "app-menu.docbook"> @@ -63,7 +63,7 @@ <!ENTITY app-bibliography SYSTEM "app-bibliography.docbook"> <!-- book related entities --> - <!ENTITY kappname "&kdevelop;"> + <!ENTITY kappname "&tdevelop;"> <!ENTITY % addindex "INCLUDE"> <!ENTITY % English "INCLUDE" > <!-- change language only here --> ]> @@ -76,7 +76,7 @@ Entries which require special treatment are marked with comments starting with ' <book lang="&language;"> <bookinfo> - <title>&kdevelop; User Manual</title> + <title>&tdevelop; User Manual</title> <date>2006-06-19</date> <releaseinfo>&kdevrelease;</releaseinfo> @@ -86,7 +86,7 @@ Entries which require special treatment are marked with comments starting with ' <firstname>Bernd</firstname> <surname>Gehrmann</surname> <affiliation> - <address><email>bernd@kdevelop.org</email></address> + <address><email>bernd@tdevelop.org</email></address> </affiliation> </author> @@ -137,7 +137,7 @@ Entries which require special treatment are marked with comments starting with ' <legalnotice>&FDLNotice;</legalnotice> <abstract> - <para>&kdevelop; is an Integrated Development Environment to be used for a wide variety of programming tasks.</para> + <para>&tdevelop; is an Integrated Development Environment to be used for a wide variety of programming tasks.</para> </abstract> <keywordset> @@ -154,8 +154,8 @@ Entries which require special treatment are marked with comments starting with ' &survey-manual; &getting-started; <!-- "Getting Started" --> -&kdevelop-survey; <!-- "Overview of &kdevelop; Features" --> -&setup; <!-- "Configuring &kdevelop;" --> +&tdevelop-survey; <!-- "Overview of &tdevelop; Features" --> +&setup; <!-- "Configuring &tdevelop;" --> &applicationwizard; <!-- "Getting Started — the &appwizard;" --> &editing; &file-browsers; @@ -165,13 +165,13 @@ Entries which require special treatment are marked with comments starting with ' &adv-build-management; &debugger; &cvs-chapter; -<!--&kdevelop-scripting;--> <!-- "Scripting &kdevelop;" --> +<!--&tdevelop-scripting;--> <!-- "Scripting &tdevelop;" --> &credits; <!-- ====================================================================== --> <!-- External Appendices --> -&kdevelop-install; <!-- "Installing &kdevelop;" --> +&tdevelop-install; <!-- "Installing &tdevelop;" --> &nutshell; &unixdev; <!-- "Development on &UNIX;" --> <!-- diff --git a/doc/kdevelop/kdevelop-install.docbook b/doc/kdevelop/kdevelop-install.docbook index 028f5e10..62123433 100644 --- a/doc/kdevelop/kdevelop-install.docbook +++ b/doc/kdevelop/kdevelop-install.docbook @@ -1,4 +1,4 @@ -<appendix id="kdevelop-install"> +<appendix id="tdevelop-install"> <appendixinfo> <authorgroup> @@ -8,54 +8,54 @@ </authorgroup> </appendixinfo> -<title>Installing &kdevelop;</title> +<title>Installing &tdevelop;</title> -<indexterm zone="kdevelop-install"> +<indexterm zone="tdevelop-install"> <primary>installation</primary></indexterm> <para> -In this chapter we will discuss the steps necessary to compile and install the &kdevelop; IDE: +In this chapter we will discuss the steps necessary to compile and install the &tdevelop; IDE: <itemizedlist> <listitem><para> - <link linkend="kdevelop-install-howto">How to obtain &kdevelop;</link> mainly concentrates on downloading the most recent &kdevelop; sources from svn. + <link linkend="tdevelop-install-howto">How to obtain &tdevelop;</link> mainly concentrates on downloading the most recent &tdevelop; sources from svn. </para></listitem> <listitem><para> - <link linkend="requirements">&kdevelop; requirements</link> lists the programs and libraries which you need installed to successfully compile the IDE. + <link linkend="requirements">&tdevelop; requirements</link> lists the programs and libraries which you need installed to successfully compile the IDE. </para></listitem> <listitem><para> - <link linkend="compile-and-install">&kdevelop; compilation and installation</link> leads you through all the steps of compilation and installation of the application. + <link linkend="compile-and-install">&tdevelop; compilation and installation</link> leads you through all the steps of compilation and installation of the application. </para></listitem> <listitem><para> -<link linkend="make-api">How to obtain a &kdevelop; &API; documentation</link> tells what an API is and how you get such a useful tool for navigating the &kdevelop; sources. +<link linkend="make-api">How to obtain a &tdevelop; &API; documentation</link> tells what an API is and how you get such a useful tool for navigating the &tdevelop; sources. </para></listitem> </itemizedlist> </para> -<sect1 id="kdevelop-install-howto"> -<title>How to Obtain &kdevelop;</title> +<sect1 id="tdevelop-install-howto"> +<title>How to Obtain &tdevelop;</title> -<indexterm zone="kdevelop-install-howto"> - <primary>obtain &kdevelop;</primary></indexterm> -<indexterm zone="kdevelop-install-howto"> - <primary>&kdevelop;</primary> +<indexterm zone="tdevelop-install-howto"> + <primary>obtain &tdevelop;</primary></indexterm> +<indexterm zone="tdevelop-install-howto"> + <primary>&tdevelop;</primary> <secondary>obtain</secondary></indexterm> <para> -&kdevelop; is available in binary form from many different &Linux; distributions such as <!--&SuSE;, &RedHat;//--> SuSE, RedHat and others. These binaries are packed in some convenient format, mostly RPM, for easy installation. To install, follow the standard instructions given in your distribution. +&tdevelop; is available in binary form from many different &Linux; distributions such as <!--&SuSE;, &RedHat;//--> SuSE, RedHat and others. These binaries are packed in some convenient format, mostly RPM, for easy installation. To install, follow the standard instructions given in your distribution. </para> <para> -You may as well obtain the &kdevelop; sources, compile and install them by yourself. These sources can be found via the project home page at <ulink url="http://www.kdevelop.org"> http://www.kdevelop.org</ulink> or via the <ulink url="http://download.kde.org">&kde; ftp site</ulink>. +You may as well obtain the &tdevelop; sources, compile and install them by yourself. These sources can be found via the project home page at <ulink url="http://www.tdevelop.org"> http://www.tdevelop.org</ulink> or via the <ulink url="http://download.kde.org">&kde; ftp site</ulink>. </para> <sect2 id="howto-svn"> -<title>Get Daily &kdevelop; Snapshots from svn</title> +<title>Get Daily &tdevelop; Snapshots from svn</title> <indexterm zone="howto-svn"> <primary>svn</primary></indexterm> <para>If you want to be in front of current development, anonymous svn repository snapshots are available.</para> -<para>The module name is <emphasis>kdevelop</emphasis> at <filename class="directory">svn co svn://anonsvn.kde.org/home/kde/branches/KDE/3.5/kdevelop</filename>. +<para>The module name is <emphasis>tdevelop</emphasis> at <filename class="directory">svn co svn://anonsvn.kde.org/home/kde/branches/KDE/3.5/tdevelop</filename>. </para> <sect3 id="howto-svn-co"> @@ -64,16 +64,16 @@ You may as well obtain the &kdevelop; sources, compile and install them by yours <indexterm zone="howto-svn-co"> <primary>checkout</primary></indexterm> <indexterm zone="howto-svn-co"> - <primary>&kdevelop;</primary> + <primary>&tdevelop;</primary> <secondary>svn</secondary> <tertiary>checkout</tertiary></indexterm> <para> -To obtain an initial version of &kdevelop; you must download it from anonymous svn. For this so-called <emphasis>checkout</emphasis> operation follow these steps. +To obtain an initial version of &tdevelop; you must download it from anonymous svn. For this so-called <emphasis>checkout</emphasis> operation follow these steps. </para> <note><para> -We assume you want to put your &kdevelop; copy into the <filename class="directory">trinitysrc</filename> subdirectory of your home directory (<filename class="directory">~</filename>). +We assume you want to put your &tdevelop; copy into the <filename class="directory">trinitysrc</filename> subdirectory of your home directory (<filename class="directory">~</filename>). </para></note> <informalexample><simplelist> @@ -90,24 +90,24 @@ We assume you want to put your &kdevelop; copy into the <filename class="directo </member> <member> <prompt>~/trinitysrc> </prompt> - <userinput>svn co svn://anonsvn.kde.org/home/kde/branches/KDE/3.5/kdevelop</userinput> + <userinput>svn co svn://anonsvn.kde.org/home/kde/branches/KDE/3.5/tdevelop</userinput> </member> <member> <prompt>~/trinitysrc> </prompt> - <userinput>cd kdevelop</userinput> + <userinput>cd tdevelop</userinput> </member> </simplelist></informalexample> <note><para> - Once you have successfully checked out your &kdevelop; version, you may keep up with the changes using the update procedure shown in the next section. + Once you have successfully checked out your &tdevelop; version, you may keep up with the changes using the update procedure shown in the next section. </para></note> <important><para> - Keep the server load low. <emphasis>Please do not checkout every time you want to keep your &kdevelop; up to date!</emphasis> Use svn update for this purpose. + Keep the server load low. <emphasis>Please do not checkout every time you want to keep your &tdevelop; up to date!</emphasis> Use svn update for this purpose. </para></important> <para> -Now you may compile your &kdevelop; version as shown in the <link linkend="compile-and-install">&kdevelop; Compilation and Installation</link> section. +Now you may compile your &tdevelop; version as shown in the <link linkend="compile-and-install">&tdevelop; Compilation and Installation</link> section. </para> </sect3> <!-- howto-svn-co --> @@ -118,12 +118,12 @@ Now you may compile your &kdevelop; version as shown in the <link linkend="compi <indexterm zone="howto-svn-up"> <primary>update</primary></indexterm> <indexterm zone="howto-svn-up"> - <primary>&kdevelop;</primary> + <primary>&tdevelop;</primary> <secondary>svn</secondary> <tertiary>update</tertiary></indexterm> <para> -After you checked out (and successfully compiled) &kdevelop; from svn as shown above, you'll want to keep it up to date in order to get all the patches. Follow these steps. (We again assume you have put your &kdevelop; copy into the <filename class="directory">trinitysrc</filename> directory.) +After you checked out (and successfully compiled) &tdevelop; from svn as shown above, you'll want to keep it up to date in order to get all the patches. Follow these steps. (We again assume you have put your &tdevelop; copy into the <filename class="directory">trinitysrc</filename> directory.) </para> <para> Note the <command>up</command> (= <emphasis>update</emphasis>) command instead of the <command>co</command> (which stands for <emphasis>checkout</emphasis>). @@ -136,7 +136,7 @@ Note the <command>up</command> (= <emphasis>update</emphasis>) command instead o </member> <member> <prompt>~/trinitysrc> </prompt> - <userinput>cd kdevelop</userinput> + <userinput>cd tdevelop</userinput> </member> <member> <prompt>~/trinitysrc> </prompt> @@ -149,7 +149,7 @@ Keep an eye on the messages svn produces during the update sequence. The exact s </para></note> <para> -Now you can compile a new &kdevelop; version as shown in the <link linkend="compile-and-install-make-svn">Special svn compilation considerations</link> chapter. +Now you can compile a new &tdevelop; version as shown in the <link linkend="compile-and-install-make-svn">Special svn compilation considerations</link> chapter. </para> </sect3> <!-- howto-svn-up --> @@ -160,19 +160,19 @@ Now you can compile a new &kdevelop; version as shown in the <link linkend="comp <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> <sect1 id="requirements"> -<title>&kdevelop; Requirements</title> +<title>&tdevelop; Requirements</title> <indexterm zone="requirements"> <primary>requirements</primary></indexterm> <indexterm zone="requirements"> - <primary>&kdevelop;</primary> + <primary>&tdevelop;</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. +In order to successfully compile and use &tdevelop;, you need the following programs and libraries. They are available on most platforms as distribution packages and thereby can be installed easily. </para> <itemizedlist> @@ -306,7 +306,7 @@ In order to successfully compile and use &kdevelop;, you need the following prog <orderedlist> <listitem> <para> - You can, to a certain extent, circumvent the need for &autoconf; ≥ 2.52 and &automake; ≥ 1.6. Just remove the <filename class="directory">admin</filename> directory in your &kdevelop; installation directory and type + You can, to a certain extent, circumvent the need for &autoconf; ≥ 2.52 and &automake; ≥ 1.6. Just remove the <filename class="directory">admin</filename> directory in your &tdevelop; installation directory and type <indexterm> <primary>autoconf</primary> <secondary>circumvent version need</secondary></indexterm> @@ -318,16 +318,16 @@ In order to successfully compile and use &kdevelop;, you need the following prog <secondary>circumvent for autoconf/automake</secondary></indexterm> </para> <informalexample><simplelist> - <member><prompt>(your-kdevelop-directory)> </prompt> - <userinput>ln -s $KDEDIR/share/apps/kdelibs/admin admin</userinput></member> + <member><prompt>(your-tdevelop-directory)> </prompt> + <userinput>ln -s $KDEDIR/share/apps/tdelibs/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. + at the console. This causes &tdevelop; to use the standard settings in the &kde; <filename class="directory">admin</filename> directory instead. </para> </listitem> <listitem> <para> - Be careful <emphasis>not to mix &Qt; versions</emphasis>. Always link &kdevelop; to the same &Qt; version your &kde; library was compiled. Otherwise you will most likely experience <emphasis>very strange</emphasis> behaviours. + Be careful <emphasis>not to mix &Qt; versions</emphasis>. Always link &tdevelop; to the same &Qt; version your &kde; library was compiled. Otherwise you will most likely experience <emphasis>very strange</emphasis> behaviours. </para> </listitem> </orderedlist> @@ -338,27 +338,27 @@ In order to successfully compile and use &kdevelop;, you need the following prog <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> <sect1 id="compile-and-install"> -<title>&kdevelop; Compilation and Installation</title> +<title>&tdevelop; Compilation and Installation</title> <indexterm zone="compile-and-install"> - <primary>&kdevelop;</primary> + <primary>&tdevelop;</primary> <secondary>compilation</secondary></indexterm> <indexterm zone="compile-and-install"> - <primary>&kdevelop;</primary> + <primary>&tdevelop;</primary> <secondary>installation</secondary></indexterm> <para> -Once all requirements are met, you are ready to compile and install &kdevelop;. This appendix will discuss the necessary steps to do so. +Once all requirements are met, you are ready to compile and install &tdevelop;. This appendix will discuss the necessary steps to do so. </para> <itemizedlist> <listitem><para> <link linkend="compile-and-install-preliminaries">Preliminary Steps</link> tells you about setting up a proper environment. </para></listitem> <listitem><para> - <link linkend="compile-and-install-make">Compile &kdevelop;</link> deals with obtaining the &kdevelop; sources from svn, how to prepare them for the installation process, and finally shows the steps necessary to compile and install &kdevelop;. + <link linkend="compile-and-install-make">Compile &tdevelop;</link> deals with obtaining the &tdevelop; sources from svn, how to prepare them for the installation process, and finally shows the steps necessary to compile and install &tdevelop;. </para></listitem> <listitem><para> - <link linkend="compile-and-install-options">Some Notes on configure Options</link> tells you how to run &kdevelop; if it has been installed in a location other than the &kde; directory. + <link linkend="compile-and-install-options">Some Notes on configure Options</link> tells you how to run &tdevelop; if it has been installed in a location other than the &kde; directory. </para></listitem> </itemizedlist> @@ -367,7 +367,7 @@ Once all requirements are met, you are ready to compile and install &kdevelop;. <indexterm zone="compile-and-install-preliminaries"> <primary>preliminaries</primary> - <secondary>&kdevelop; installation</secondary></indexterm> + <secondary>&tdevelop; installation</secondary></indexterm> <indexterm zone="compile-and-install-preliminaries"> <primary>KDEDIR</primary></indexterm> <indexterm zone="compile-and-install-preliminaries"> @@ -426,24 +426,24 @@ If you use the tcsh shell add the following lines: </sect2> <!-- compile-and-install-preliminaries --> <sect2 id="compile-and-install-make"> -<title>Compile &kdevelop;</title> +<title>Compile &tdevelop;</title> <indexterm zone="compile-and-install-make"> <primary>make</primary> - <secondary>&kdevelop; installation</secondary></indexterm> + <secondary>&tdevelop; installation</secondary></indexterm> <indexterm zone="compile-and-install-make"> <primary>compiling</primary> - <secondary>&kdevelop;</secondary></indexterm> + <secondary>&tdevelop;</secondary></indexterm> <note><para> -In the following discussion we assume that you have put your &kdevelop; sources in the <filename class="directory">~/trinitysrc/kdevelop</filename> directory. +In the following discussion we assume that you have put your &tdevelop; sources in the <filename class="directory">~/trinitysrc/tdevelop</filename> directory. </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. +In case you use a &tdevelop; snapshot from svn the initial compilation steps depend on whether you just did a complete checkout or only updated the source. </para> <variablelist> @@ -455,7 +455,7 @@ You must <emphasis>initialize the make system</emphasis> after a fresh checkout. </para> <informalexample><simplelist><member> - <prompt>~/trinitysrc/kdevelop> </prompt> + <prompt>~/trinitysrc/tdevelop> </prompt> <userinput>make -f admin/Makefile.common svn-clean</userinput> </member></simplelist></informalexample> <para> @@ -484,7 +484,7 @@ U /some_directory_path/Makefile.am or if you just did a full checkout, you must enter: </para> <informalexample><simplelist><member> - <prompt>~/trinitysrc/kdevelop> </prompt> + <prompt>~/trinitysrc/tdevelop> </prompt> <userinput>make -f Makefile.svn</userinput> </member></simplelist></informalexample> <para> @@ -499,11 +499,11 @@ before you proceed with <emphasis>all of the following steps</emphasis>. <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. +Once the basic make system is set up you must decide which type of the &tdevelop; system you want to use. This is done in the following configure step which builds the actual <filename>Makefile</filename>s the <command>make</command> command will use. </para> <note><para> -You may drop the <option>--prefix</option> option in the following <command>configure</command> command lines if you want &kdevelop; be installed in the default &kde; directory. See the <link linkend="compile-and-install-options">Some notes on configure options</link> chapter for this. +You may drop the <option>--prefix</option> option in the following <command>configure</command> command lines if you want &tdevelop; be installed in the default &kde; directory. See the <link linkend="compile-and-install-options">Some notes on configure options</link> chapter for this. </para></note> <variablelist> @@ -511,11 +511,11 @@ You may drop the <option>--prefix</option> option in the following <command>conf <term>A Debug-Compiled Version</term> <listitem> <para> -If you want to keep track of what your &kdevelop; application does at run-time you may build a debug-compiled version. Just command <command>configure</command> to do so: +If you want to keep track of what your &tdevelop; application does at run-time you may build a debug-compiled version. Just command <command>configure</command> to do so: </para> <informalexample><simplelist><member> - <prompt>~/trinitysrc/kdevelop> </prompt> + <prompt>~/trinitysrc/tdevelop> </prompt> <userinput>./configure --enable-debug=full --prefix=</userinput>(where-your-trinity-is) </member></simplelist></informalexample> </listitem> @@ -524,64 +524,64 @@ If you want to keep track of what your &kdevelop; application does at run-time y <varlistentry> <term>A Release-Compiled Version</term> <listitem> -<para>If you only want to use &kdevelop; as-is a (smaller and faster +<para>If you only want to use &tdevelop; as-is a (smaller and faster running) release version suffices. <command>configure</command> defaults to this.</para> <informalexample><simplelist><member> - <prompt>~/trinitysrc/kdevelop> </prompt> + <prompt>~/trinitysrc/tdevelop> </prompt> <userinput>./configure --prefix=</userinput>(where-your-trinity-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: +If you want to build your own <link linkend="make-api">API documentation</link> for &tdevelop; you must include yet another option in the <command>configure</command> command: </para> <informalexample><simplelist> - <member><prompt>~/trinitysrc/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> + <member><prompt>~/trinitysrc/tdevelop> </prompt> + <userinput>./configure --</userinput>(options-as-above) <userinput>\</userinput></member> <member><userinput>--with-tdelibsdoxy-dir=$KDEDIR/share/doc/HTML/en/tdelibs-apidocs</userinput></member> </simplelist></informalexample> </note> </listitem> </varlistentry> <varlistentry> -<term>Make and Install &kdevelop;</term> +<term>Make and Install &tdevelop;</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>~/trinitysrc/kdevelop> </prompt> + <prompt>~/trinitysrc/tdevelop> </prompt> <userinput>make</userinput> </member></simplelist></informalexample> <para> suffices. If necessary, now gain root user rights using the command </para> <informalexample><simplelist><member> - <prompt>~/trinitysrc/kdevelop> </prompt> + <prompt>~/trinitysrc/tdevelop> </prompt> <userinput>su</userinput> </member></simplelist></informalexample> <para> and entering the root password. Then install the application: </para> <informalexample><simplelist><member> - <prompt>~/trinitysrc/kdevelop> </prompt> + <prompt>~/trinitysrc/tdevelop> </prompt> <userinput>make install</userinput> </member></simplelist></informalexample> <para> -That's all. If you installed &kdevelop; in the default &kde; directory you may now run the IDE. Otherwise some additional steps will be necessary as shown in the <link linkend="compile-and-install-options-dir">Non-default installation directory</link> section below. +That's all. If you installed &tdevelop; in the default &kde; directory you may now run the IDE. Otherwise some additional steps will be necessary as shown in the <link linkend="compile-and-install-options-dir">Non-default installation directory</link> section below. </para> <note> <para> - In fact there usually will have been three &kdevelop;-based applications installed: + In fact there usually will have been three &tdevelop;-based applications installed: </para> <itemizedlist> - <listitem><para>The &kdevelop; IDE — this is the place where you will usually work.</para></listitem> - <listitem><para>The stand-alone &kdevelop; Assistant documentation browser — isolates all the powerful documentation facilities of the &kdevelop; IDE in a separate tool. This comes in handy when you want to look up some programming documentation but do not want to start the full IDE.</para></listitem> - <listitem><para>The &kdevelop; Designer — enhances the &Qt; User Interface Designer by &kde; specific elements and integrates nicely in the &kdevelop; IDE.</para></listitem> + <listitem><para>The &tdevelop; IDE — this is the place where you will usually work.</para></listitem> + <listitem><para>The stand-alone &tdevelop; Assistant documentation browser — isolates all the powerful documentation facilities of the &tdevelop; IDE in a separate tool. This comes in handy when you want to look up some programming documentation but do not want to start the full IDE.</para></listitem> + <listitem><para>The &tdevelop; Designer — enhances the &Qt; User Interface Designer by &kde; specific elements and integrates nicely in the &tdevelop; IDE.</para></listitem> </itemizedlist> </note> </listitem> @@ -600,7 +600,7 @@ That's all. If you installed &kdevelop; in the default &kde; directory you may n <title>Non-default Installation Directory</title> <indexterm zone="compile-and-install-options-dir"> - <primary>&kdevelop;</primary> + <primary>&tdevelop;</primary> <secondary>installation</secondary> <tertiary>non-default directory</tertiary></indexterm> <indexterm zone="compile-and-install-options-dir"> @@ -611,17 +611,17 @@ That's all. If you installed &kdevelop; in the default &kde; directory you may n <primary>kbuildsycoca</primary></indexterm> <para> -By default <command>configure</command> prepares the IDE to be installed in the default &kde; directory. This is necessary because &kdevelop; assumes direct access to some tools and parts which reside there. If want to use your own installation directory, you must tell <command>configure</command> this by the <option>--prefix</option> option: +By default <command>configure</command> prepares the IDE to be installed in the default &kde; directory. This is necessary because &tdevelop; assumes direct access to some tools and parts which reside there. If want to use your own installation directory, you must tell <command>configure</command> this by the <option>--prefix</option> option: </para> <informalexample><simplelist><member> - <prompt>~/trinitysrc/kdevelop> </prompt> + <prompt>~/trinitysrc/tdevelop> </prompt> <userinput>./configure --prefix=</userinput>(where-your-trinity-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.) +There is a caveat if you do so. You must provide a means for &tdevelop; to access the needed tools and parts in the &kde; directory when running. (You can still use the IDE without doing so, but with very restrained capabilities.) </para> <para> -Call up a shell and have the following commands executed before you start &kdevelop; at the shell prompt. +Call up a shell and have the following commands executed before you start &tdevelop; at the shell prompt. </para> <note><para> @@ -638,11 +638,11 @@ Call up a shell and have the following commands executed before you start &kdeve <userinput>kbuildsycoca</userinput> </member> <member> - (Now start &kdevelop;:) + (Now start &tdevelop;:) </member> <member> <prompt>~> </prompt> - <userinput>kdevelop</userinput> + <userinput>tdevelop</userinput> </member> </simplelist></informalexample> @@ -661,7 +661,7 @@ In a tcsh shell you must set the environment variables using: <userinput>setenv KDEDIRS /usr/local/kde:/opt/trinity</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. +The <command>kbuildsycoca</command> command (<quote>build system control cache</quote>) looks around for libraries and caches their location and version, so that &tdevelop; can find them. The caveat is that it takes noticeable time—and it has to be run any time you call up the shell to start &tdevelop; from a non-default directory. You may want to put the above commands into a shell script to reduce the typing effort. </para> <para> (You could as well put the lines in your <filename>.bashrc</filename> or <filename>.cshrc</filename> file, but this is not advisable as <command>kbuildsycoca</command> will then be run any time you call up the shell.) @@ -679,56 +679,56 @@ The <command>kbuildsycoca</command> command does not run from within the root. Y </sect1> <!-- compile-and-install --> <sect1 id="make-api"> -<title>How to Obtain a &kdevelop; API Documentation</title> +<title>How to Obtain a &tdevelop; API Documentation</title> <indexterm zone="make-api"> <primary>API</primary> - <secondary>&kdevelop;</secondary></indexterm> + <secondary>&tdevelop;</secondary></indexterm> <indexterm zone="make-api"> - <primary>&kdevelop;</primary> + <primary>&tdevelop;</primary> <secondary>API</secondary></indexterm> <indexterm zone="make-api"> <primary>compiling</primary> - <secondary>&kdevelop;</secondary> + <secondary>&tdevelop;</secondary> <tertiary>API</tertiary></indexterm> <indexterm zone="make-api"> <primary>configure</primary> - <secondary>&kdevelop; API</secondary></indexterm> + <secondary>&tdevelop; API</secondary></indexterm> <para> API is the short form of <quote>Application Program Interface</quote>. Actually such an API cotains a series of descriptions (&ie; calling conventions) by which an application program can access the operating system and other services. In our context, however, a broader definition was adopted. The API of a &kde; or &Qt; application is an abstract of the classes and methods interfaces, a synopsis to be used like a dictionary to navigate the sources. </para> <para> -There is a version of the most current API available at the <ulink url="http://www.kdevelop.org/HEAD/doc/api/html/index.html">KDevelop-Home website</ulink>. It will be automatically updated every 24 hours so you can keep up. +There is a version of the most current API available at the <ulink url="http://www.tdevelop.org/HEAD/doc/api/html/index.html">KDevelop-Home website</ulink>. It will be automatically updated every 24 hours so you can keep up. </para> <para> -Alas, this version is best used read-only over the internet. If you do not always have internet access you may as well build your own API documentation from the &kdevelop; sources. To do so, you must tell the automake system where to find the KDELIBS API in your system. This is accomplished by the special option <option>--with-kdelibsdoxy-dir</option> in the <command>configure</command> command when you prepare to compile the &kdevelop; sources: +Alas, this version is best used read-only over the internet. If you do not always have internet access you may as well build your own API documentation from the &tdevelop; sources. To do so, you must tell the automake system where to find the KDELIBS API in your system. This is accomplished by the special option <option>--with-tdelibsdoxy-dir</option> in the <command>configure</command> command when you prepare to compile the &tdevelop; sources: </para> <informalexample><simplelist> <member> - <prompt>~/trinitysrc/kdevelop> </prompt> + <prompt>~/trinitysrc/tdevelop> </prompt> <userinput>./configure --</userinput>(options-as-usual)<userinput> \</userinput> </member> <member> - <userinput>--with-kdelibsdoxy-dir=$KDEDIR/share/doc/HTML/en/kdelibs-apidocs</userinput> + <userinput>--with-tdelibsdoxy-dir=$KDEDIR/share/doc/HTML/en/tdelibs-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 +(<command>make</command> will replace the global <varname>$KDEDIR</varname> variable with the actual &kde; directory setting recorded therein.) Then issue a <command>make</command> command <link linkend="compile-and-install-make-basic">as usual</link>. After the &tdevelop; IDE has been built you have the option to build the API as well. For this you must issue </para> <informalexample><simplelist><member> - <prompt>~/trinitysrc/kdevelop> </prompt> + <prompt>~/trinitysrc/tdevelop> </prompt> <userinput>make apidocs</userinput> </member></simplelist></informalexample> <para> -This will build a <filename>Doxyfile</filename> in your &kdevelop; base directory which in turn will be processed by the <application>Doxygen</application> application to build quite a lot of <filename>.html</filename> API files. When this rather lengthy API building process (may last more than an hour on a slow system) finally comes to an end, you must install the API just like you have to install the &kdevelop; IDE itself. If necessary obtain superuser rights by +This will build a <filename>Doxyfile</filename> in your &tdevelop; base directory which in turn will be processed by the <application>Doxygen</application> application to build quite a lot of <filename>.html</filename> API files. When this rather lengthy API building process (may last more than an hour on a slow system) finally comes to an end, you must install the API just like you have to install the &tdevelop; IDE itself. If necessary obtain superuser rights by </para> <informalexample><simplelist><member> - <prompt>~/trinitysrc/kdevelop> </prompt> + <prompt>~/trinitysrc/tdevelop> </prompt> <userinput>su</userinput> </member></simplelist></informalexample> @@ -737,18 +737,18 @@ and entering the root password. Then install the API files: </para> <informalexample><simplelist><member> - <prompt>~/trinitysrc/kdevelop> </prompt> + <prompt>~/trinitysrc/tdevelop> </prompt> <userinput>make install-apidox</userinput> </member></simplelist></informalexample> <para> -Once this is done, <command>make</command> will inform you about the directory where you can finally look at the API documentation's contents. Note this address, you can use it from &konqueror; as well as from inside &kdevelop;, in case you have set up the &kdevelop; sources themselves as a project to work on. +Once this is done, <command>make</command> will inform you about the directory where you can finally look at the API documentation's contents. Note this address, you can use it from &konqueror; as well as from inside &tdevelop;, in case you have set up the &tdevelop; sources themselves as a project to work on. </para> <note><para> -You will most probably see a lot of warning and/or error messages during the API build run by <application>Doxygen</application>. It is best to ignore them, they are of interest to the &kdevelop; developers only. If the API generation ever comes to a successful end, the <filename>.html</filename> API files will be usable. +You will most probably see a lot of warning and/or error messages during the API build run by <application>Doxygen</application>. It is best to ignore them, they are of interest to the &tdevelop; developers only. If the API generation ever comes to a successful end, the <filename>.html</filename> API files will be usable. </para></note> </sect1> <!-- make-api --> -</appendix> <!-- kdevelop-install --> +</appendix> <!-- tdevelop-install --> diff --git a/doc/kdevelop/kdevelop-scripting.docbook b/doc/kdevelop/kdevelop-scripting.docbook index d9e59bb5..177a0b65 100644 --- a/doc/kdevelop/kdevelop-scripting.docbook +++ b/doc/kdevelop/kdevelop-scripting.docbook @@ -1,4 +1,4 @@ -<chapter id="kdevelop-scripting"> +<chapter id="tdevelop-scripting"> <chapterinfo> <authorgroup> @@ -12,7 +12,7 @@ <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. + To access a script that is available to &tdevelop; use the <menuchoice><guimenu>Tools</guimenu><guimenuitem>Scripts</guimenuitem></menuchoice> menu. If there there is no such menu item then there are no installed scripts available to KDevelop. </para> </sect1> @@ -30,7 +30,7 @@ The next step is to create the actual script. For the above example the Type of <para>One of the most useful tools in developing scripts for applications is the KDCOP application.</para> <figure id="screenshot-kdcop" float="1"> - <title>KDCOP Browsing DCOP Interfaces in &kdevelop;</title> + <title>KDCOP Browsing DCOP Interfaces in &tdevelop;</title> <mediaobject> <imageobject><imagedata fileref="kdcop_browsing.png"/></imageobject> </mediaobject> @@ -41,7 +41,7 @@ The next step is to create the actual script. For the above example the Type of <para>Once the script is complete it is ready to be installed. Application developers should document the location that will be scanned for scripts. In the case of the above example for Kate the scripts are located in "$KDEDIRS/share/apps/kate/scripts".</para> <figure id="screenshot-scripts" float="1"> - <title>&kdevelop; Scripts on the Filesystem</title> + <title>&tdevelop; Scripts on the Filesystem</title> <mediaobject> <imageobject><imagedata fileref="script_location.png"/></imageobject> </mediaobject> diff --git a/doc/kdevelop/kdevelop-survey.docbook b/doc/kdevelop/kdevelop-survey.docbook index 9fe32d2d..0f117958 100644 --- a/doc/kdevelop/kdevelop-survey.docbook +++ b/doc/kdevelop/kdevelop-survey.docbook @@ -1,4 +1,4 @@ -<chapter id="kdevelop-survey"> +<chapter id="tdevelop-survey"> <chapterinfo> <authorgroup> @@ -7,18 +7,18 @@ </authorgroup> </chapterinfo> -<title>Overview of &kdevelop; Features</title> +<title>Overview of &tdevelop; Features</title> -<indexterm zone="kdevelop-survey"> - <primary>&kdevelop;</primary> +<indexterm zone="tdevelop-survey"> + <primary>&tdevelop;</primary> <secondary>survey</secondary></indexterm> -<indexterm zone="kdevelop-survey"> +<indexterm zone="tdevelop-survey"> <primary>overall view</primary></indexterm> -<indexterm zone="kdevelop-survey"> +<indexterm zone="tdevelop-survey"> <primary>survey</primary></indexterm> <para> -&kdevelop; integrates a lot of tools, scripts, and templates in a common user interface. Basically it consists of +&tdevelop; integrates a lot of tools, scripts, and templates in a common user interface. Basically it consists of <itemizedlist> <listitem><para> @@ -40,7 +40,7 @@ various <link linkend="class-browsers">class browsers</link> to aid you in maintaining the classes and their relationships of your object-oriented programming project, </para></listitem> <listitem><para> - a <link linkend="debugger">debugger interface</link> to find and remove program errors from within &kdevelop;, and + a <link linkend="debugger">debugger interface</link> to find and remove program errors from within &tdevelop;, and </para></listitem> <listitem><para> several <link linkend="plugin-tools">plugin tools</link>, extensible modules which can be loaded at runtime and on demand. This allows you to only turn on those features you really need. @@ -53,12 +53,12 @@ <note> <para> - In fact there are three &kdevelop;-based applications: + In fact there are three &tdevelop;-based applications: </para> <itemizedlist> - <listitem><para>The &kdevelop; IDE — this is the place where you will usually work.</para></listitem> - <listitem><para>The stand-alone &kdevelop; Assistant documentation browser — isolates all the powerful documentation facilities of the &kdevelop; IDE in a separate tool. This comes in handy when you want to look up some programming documentation but do not want to start the full IDE.</para></listitem> - <listitem><para>The &kdevelop; Designer — enhances the &Qt; User Interface Designer by &kde; specific elements and integrates nicely in the &kdevelop; IDE.</para></listitem> + <listitem><para>The &tdevelop; IDE — this is the place where you will usually work.</para></listitem> + <listitem><para>The stand-alone &tdevelop; Assistant documentation browser — isolates all the powerful documentation facilities of the &tdevelop; IDE in a separate tool. This comes in handy when you want to look up some programming documentation but do not want to start the full IDE.</para></listitem> + <listitem><para>The &tdevelop; Designer — enhances the &Qt; User Interface Designer by &kde; specific elements and integrates nicely in the &tdevelop; IDE.</para></listitem> </itemizedlist> </note> @@ -67,11 +67,11 @@ <title>Available User Interface Modes</title> <indexterm zone="uimodes-survey"> - <primary>&kdevelop;</primary> + <primary>&tdevelop;</primary> <secondary>user interface modes</secondary></indexterm> <indexterm zone="uimodes-survey"> <primary>user interface</primary> - <secondary>&kdevelop; modes</secondary></indexterm> + <secondary>&tdevelop; modes</secondary></indexterm> <indexterm zone="uimodes-survey"> <primary>UI modes</primary></indexterm> <indexterm zone="uimodes-survey"> @@ -84,7 +84,7 @@ <primary>IDEAl</primary></indexterm> <para> -&kdevelop; offers developers four separate user interface modes (click on the mode name to view an example): +&tdevelop; 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> @@ -160,7 +160,7 @@ To switch the user interface mode select <menuchoice> <guimenu>Settings</guimenu </screenshot> <para> -(Older &kdevelop; versions provide the top mode selection section only.) +(Older &tdevelop; versions provide the top mode selection section only.) </para> <para> @@ -171,7 +171,7 @@ Dependent on the user interface mode you selected, other configuration sections </para> <note><para> -Do not forget to restart &kdevelop; in order to let your selections take effect. +Do not forget to restart &tdevelop; in order to let your selections take effect. </para></note> </sect2> <!-- uimodes-switch --> @@ -180,10 +180,10 @@ Do not forget to restart &kdevelop; in order to let your selections take effect. <title>How to Maximize the Work Space Area</title> <indexterm zone="maximize-workspace"> - <primary>&kdevelop;</primary> + <primary>&tdevelop;</primary> <secondary>work space</secondary></indexterm> <indexterm zone="maximize-workspace"> - <primary>&kdevelop;</primary> + <primary>&tdevelop;</primary> <secondary>maximize work space</secondary></indexterm> <indexterm zone="maximize-workspace"> <primary>user interface</primary> @@ -254,7 +254,7 @@ To <emphasis>hide</emphasis> the menubar select <menuchoice> <guimenu>Settings</ </sect2> <!-- ui-elements-workarea --> <sect2 id="ui-elements-titlebar"> -<title>The &kdevelop; Titlebar</title> +<title>The &tdevelop; Titlebar</title> <para> (... to be written ...) @@ -262,7 +262,7 @@ To <emphasis>hide</emphasis> the menubar select <menuchoice> <guimenu>Settings</ </sect2> <!-- ui-elements-titlebar --> <sect2 id="ui-elements-statusbar"> -<title>The &kdevelop; Statusbar</title> +<title>The &tdevelop; Statusbar</title> <para> (... to be written ...) @@ -312,7 +312,7 @@ To <emphasis>hide</emphasis> the menubar select <menuchoice> <guimenu>Settings</ <primary>project management</primary></indexterm> <para> -Globally, a project will rely on some form of project management system. &kdevelop; offers four <emphasis>project management systems</emphasis> the programmer can select from when creating a new project. +Globally, a project will rely on some form of project management system. &tdevelop; offers four <emphasis>project management systems</emphasis> the programmer can select from when creating a new project. <itemizedlist> <listitem><para> @@ -341,7 +341,7 @@ Globally, a project will rely on some form of project management system. &kdeve <secondary>projects</secondary></indexterm> <para> -Projects created with &kdevelop;'s &automanag; make it very easy for developers to use the &GNU; standard development tools. They provide +Projects created with &tdevelop;'s &automanag; make it very easy for developers to use the &GNU; standard development tools. They provide <itemizedlist> <listitem><para> a better way of <filename>Makefile</filename> generation and @@ -364,7 +364,7 @@ Projects created with &kdevelop;'s &automanag; make it very easy for developers <secondary>projects</secondary></indexterm> <para> -For developers who enjoy the flexibility and feel of &Qt;'s qmake system, &kdevelop; offers the ability to handle qmake based projects (.pro files) within the &GUI;. +For developers who enjoy the flexibility and feel of &Qt;'s qmake system, &tdevelop; offers the ability to handle qmake based projects (.pro files) within the &GUI;. </para> <para> For more information on the QMake project manager see the <quote>qmake User Guide</quote> which should be included in your distribution or have a look at the <ulink url="http://doc.trolltech.com/">TROLLTECH Documentation</ulink> home page where you may find the QMake documentation of your <quote>Qt C++ GUI Application Development Toolkit</quote> version. @@ -382,12 +382,12 @@ For more information on the QMake project manager see the <quote>qmake User Guid <secondary>projects</secondary></indexterm> <para> -CMake will be the &kde; build system for &kde; 4 and &kdevelop; already +CMake will be the &kde; build system for &kde; 4 and &tdevelop; already provides you some CMake based templates in C and C++. You only need the cmake program in your $<envar>PATH</envar> to build them. </para> <para> -To set up a new C or C++ project in &kdevelop; select +To set up a new C or C++ project in &tdevelop; select <menuchoice><guimenu>Project</guimenu> <guimenuitem>New Project...</guimenuitem> <guimenuitem>C or C++</guimenuitem> @@ -417,7 +417,7 @@ To set up a new C or C++ project in &kdevelop; select <secondary>Java</secondary></indexterm> <para> -&Java; developers may want to use the Apache ANT project manager for their projects. To set up a new Ant project in &kdevelop; select <menuchoice><guimenu>Project</guimenu> +&Java; developers may want to use the Apache ANT project manager for their projects. To set up a new Ant project in &tdevelop; select <menuchoice><guimenu>Project</guimenu> <guimenuitem>New Project...</guimenuitem> <guimenuitem>Java</guimenuitem> <guimenuitem>Ant Project</guimenuitem> @@ -441,7 +441,7 @@ For more information see <ulink url="http://ant.apache.org/">The Apache Ant Proj <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. +If you prefer to maintain your own <filename>Makefiles</filename> for your project you may use the custom project option of &tdevelop;. This may be feasible in unusually structured projects or if you want to retain full control over the <command>make</command> process. </para> <para> Yet, if you do not <emphasis>really need</emphasis> the extra flexibility and control of the custom project manager you should consider &automanag; or one of the other project managers, because they considerably ease the program building and distribution processes. @@ -470,10 +470,10 @@ The distribution of your applications does not require the end-user to have anyt <para> which at least for C++ applications is most often the case. But you can as well distribute <emphasis>binary packages</emphasis> of your application. <!-- ### more detail on binary construction needed somewhere --> -In either way, the end-user of your product does not need &kdevelop; installed. +In either way, the end-user of your product does not need &tdevelop; installed. </para> <para> -For giving away your sources, we advise to include the <emphasis>project file</emphasis> of &kdevelop; as well. This makes it very easy for other developers—if they use &kdevelop;—to work with your sources. +For giving away your sources, we advise to include the <emphasis>project file</emphasis> of &tdevelop; as well. This makes it very easy for other developers—if they use &tdevelop;—to work with your sources. </para> <para> For projects where <emphasis>several developers</emphasis>, maybe working on different places, are involved, this should be the case anyway. So you can ensure consistency of the <filename>Makefiles</filename> to not run into trouble. @@ -486,4 +486,4 @@ Especially on multi language applications, <emphasis>translators</emphasis> won' </sect1> <!-- makesystems --> -</chapter> <!-- kdevelop-survey --> +</chapter> <!-- tdevelop-survey --> diff --git a/doc/kdevelop/listplugins.sh b/doc/kdevelop/listplugins.sh index e21b3a15..f916b7fe 100755 --- a/doc/kdevelop/listplugins.sh +++ b/doc/kdevelop/listplugins.sh @@ -1,6 +1,6 @@ # kdevdir must be set to the KDevelop project directory. -kdevdir=/home/volker/data/prj/kdevelop/kdevelop/ +kdevdir=/home/volker/data/prj/tdevelop/tdevelop/ # The plugins are in the parts/ subdirectory. pushd $kdevdir/parts >/dev/null diff --git a/doc/kdevelop/nutshell.docbook b/doc/kdevelop/nutshell.docbook index 1c5395dd..59ee283b 100644 --- a/doc/kdevelop/nutshell.docbook +++ b/doc/kdevelop/nutshell.docbook @@ -10,7 +10,7 @@ This chapter is meant to provide short hints and tips together with (mandatory) There should be an additional FAQ section near the end nevertheless which contains more general stuff not directly related to navigating the manual. --> <para> -The information in this chapter is meant as a quick reference for a head start or if you (momentarily) forgot about some basic concept. There are also short hints on how to solve some common problems when working with &kdevelop;. +The information in this chapter is meant as a quick reference for a head start or if you (momentarily) forgot about some basic concept. There are also short hints on how to solve some common problems when working with &tdevelop;. </para> <para> If you want more information on a topic, just follow the link in the title starting that advice. @@ -34,16 +34,16 @@ Information on these topics is availabe: <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 +<para>By default &tdevelop; 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> +&tdevelop; 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 +<para>If you use an older &tdevelop; 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 +<filename>$KDEHOME/share/config/tdeveloprc</filename> configuration file as follows:</para> <simplelist> @@ -60,20 +60,20 @@ follows:</para> 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, +bars, etc.) and the &tdevelop; window seemingly uses a wrong display style, this may help:</para> <itemizedlist> <listitem><para>In your -<filename>$<envar>KDEHOME</envar>/share/config/kdeveloprc</filename> +<filename>$<envar>KDEHOME</envar>/share/config/tdeveloprc</filename> configuration file find the line containing <quote><computeroutput>Style=Checked</computeroutput></quote> and remove -it. Then restart &kdevelop;. +it. Then restart &tdevelop;. </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 +in one of the file navigators and &tdevelop; did load <application>KUIViewer</application> to show the &GUI; which was produced from this file.)</para> </listitem> @@ -231,7 +231,7 @@ try to update the information in the &GNU; Build System files. See <title>Other Topics</title> <varlistentry> <term id="nutshell-others-files"><link linkend="app-files">Configuration -Files used by &kdevelop;</link></term> +Files used by &tdevelop;</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> diff --git a/doc/kdevelop/plugin-tools.docbook b/doc/kdevelop/plugin-tools.docbook index 1c07cb7a..35e2c206 100644 --- a/doc/kdevelop/plugin-tools.docbook +++ b/doc/kdevelop/plugin-tools.docbook @@ -5,7 +5,7 @@ <primary>plugins</primary></indexterm> <para> -&kdevelop; contains a large number of little tools that help you to perform +&tdevelop; 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 @@ -179,7 +179,7 @@ it is because the plugin authors made them this way.</para> <table id="table-project-parts"> -<title>Project Management Plugins in &kdevelop;</title> +<title>Project Management Plugins in &tdevelop;</title> <tgroup cols="2"><tbody> <row> <entry>antproject</entry> @@ -205,7 +205,7 @@ in the future.</para> <table> -<title>Language Support Plugins in &kdevelop;</title> +<title>Language Support Plugins in &tdevelop;</title> <tgroup cols="2"> <tbody> <row><entry>cppsupport</entry><entry>Support for C/C++</entry></row> diff --git a/doc/kdevelop/project-advanced.docbook b/doc/kdevelop/project-advanced.docbook index d597e65e..a87b1658 100644 --- a/doc/kdevelop/project-advanced.docbook +++ b/doc/kdevelop/project-advanced.docbook @@ -45,7 +45,7 @@ <title>Converting Old KDevelop Project Files</title> <para> -&kdevelop; allows you to open old KDevelop 2.x project files and convert them to &kdevelop; files. To do so go to <guimenuitem>Open Project...</guimenuitem> and select <guilabel>KDevelop 2 project files</guilabel> in the <guilabel>Filter:</guilabel>. Then select project file you want to open. The project gets converted to &kdevelop; and saved as a <guilabel>&kdevelop; project file</guilabel>. +&tdevelop; allows you to open old KDevelop 2.x project files and convert them to &tdevelop; files. To do so go to <guimenuitem>Open Project...</guimenuitem> and select <guilabel>KDevelop 2 project files</guilabel> in the <guilabel>Filter:</guilabel>. Then select project file you want to open. The project gets converted to &tdevelop; and saved as a <guilabel>&tdevelop; project file</guilabel>. </para> </sect2> <!-- converting-projects --> @@ -54,7 +54,7 @@ <title>Importing an Existing Project</title> <para> -To import an existing directory in &kdevelop; select <guimenuitem>Import Existing Directory</guimenuitem> +To import an existing directory in &tdevelop; select <guimenuitem>Import Existing Directory</guimenuitem> from the <guimenu>Project</guimenu> menu. You should see the Import Directory Wizard, as seen below: </para> diff --git a/doc/kdevelop/project-management.docbook b/doc/kdevelop/project-management.docbook index 75674203..69ca9474 100644 --- a/doc/kdevelop/project-management.docbook +++ b/doc/kdevelop/project-management.docbook @@ -34,7 +34,7 @@ You will find here information on:</para> In the <link linkend="unixdev-buildsystems">Build systems</link> chapter we have given a rough overview of the build systems commonly in use on &UNIX; systems. In the following sections we will look at this in more detail. </para> <para> -There is some confusion about how to name such things. &GNU; calls them <quote>build systems</quote> when it describes Automake, Autoconf and Libtool. QMake calls itself <quote>a tool to write Makefiles for different compilers and platforms</quote>. In &kde; often the term <quote>project management systems</quote> is used. We will use this term in a broader sense to describe the built-in environments in &kdevelop; which are used to organize and build your projects. In the context of this section, however, we will mostly talk about <quote>automated build systems</quote>. +There is some confusion about how to name such things. &GNU; calls them <quote>build systems</quote> when it describes Automake, Autoconf and Libtool. QMake calls itself <quote>a tool to write Makefiles for different compilers and platforms</quote>. In &kde; often the term <quote>project management systems</quote> is used. We will use this term in a broader sense to describe the built-in environments in &tdevelop; which are used to organize and build your projects. In the context of this section, however, we will mostly talk about <quote>automated build systems</quote>. </para> <sect2 id="automake-manager-summary-buildsys"> @@ -95,7 +95,7 @@ A build system will iron out these differences for you. </itemizedlist> <para> -In brief, a build system offers safe and secure methods for your application to be compiled and installed correctly on any receiving machine. As we have shown before in the <link linkend="makesystems">Project Management Systems</link> survey, &kdevelop; offers three automated build systems and the option of creating your own Makefile, in short (click on the project names to get more information): +In brief, a build system offers safe and secure methods for your application to be compiled and installed correctly on any receiving machine. As we have shown before in the <link linkend="makesystems">Project Management Systems</link> survey, &tdevelop; offers three automated build systems and the option of creating your own Makefile, in short (click on the project names to get more information): </para> <itemizedlist> <listitem><para> @@ -126,7 +126,7 @@ One of these four alternatives must be chosen when you create a project and <emp There are several tutorials available on the &GNU; Build System (<command>Autoconf</command>, <command>Automake</command> and <command>Libtool</command>) of which the &automanag; makes use. </para> <itemizedlist> - <listitem><para>A short <ulink url="http://www.kdevelop.org/index.html?filename=tutorial_autoconf.html">autoconf tutorial</ulink> written by Christopher W. Curtis available on the &kdevelop; home page. It concentrates on some basic steps to modify a <filename>Makefile</filename>. + <listitem><para>A short <ulink url="http://www.tdevelop.org/index.html?filename=tutorial_autoconf.html">autoconf tutorial</ulink> written by Christopher W. Curtis available on the &tdevelop; home page. It concentrates on some basic steps to modify a <filename>Makefile</filename>. </para></listitem> <listitem><para> A more detailed tutorial can be found in a greater set of tutorials on <ulink url="http://www.amath.washington.edu/~lf/tutorials/autoconf/toolsmanual_toc.html"><quote>Developing software with GNU</quote></ulink>. @@ -181,14 +181,14 @@ How does this work? Well <command>configure</command> is a script that The <filename>Makefile.in</filename> are <quote>input</quote> files—templates which provide basic information for the <filename>Makefile</filename>s to be produced from them by filling in some system dependent information. They are generated by the <command>Automake</command> utility from the <filename>Makefile.am</filename> files. </para> <para> -The process of going from <filename>Makefile.am</filename> (<filename>.am</filename> denotes <quote>Automake</quote> template files) to <filename>Makefile</filename> files is handled automatically by the &kdevelop; &promanag;, using the <command>Autoconf</command> utility, <command>M4</command> macros and other arcana we need not go into here. +The process of going from <filename>Makefile.am</filename> (<filename>.am</filename> denotes <quote>Automake</quote> template files) to <filename>Makefile</filename> files is handled automatically by the &tdevelop; &promanag;, using the <command>Autoconf</command> utility, <command>M4</command> macros and other arcana we need not go into here. </para> <para> So when <command>make</command> runs, it automatically picks up the correct pieces from the current environment, such as compilers and libraries. Similarly, <command>make install</command> puts your application components, such as executables, documentation and data files in the correct places for that environment. </para> <para> -If you distribute your application as a <quote>tarball</quote> (a single compressed file that &kdevelop; can create for you), it will include the <filename>Makefile.in</filename> files and the <filename>configure</filename> script file, so the recipient can compile, build and install your application without having <command>Automake</command>, <command>Autoconf</command> or &kdevelop; on their machine. The <filename>Makefile.am</filename> files are also included, just in case the receiver needs to do any source-code modifications. +If you distribute your application as a <quote>tarball</quote> (a single compressed file that &tdevelop; can create for you), it will include the <filename>Makefile.in</filename> files and the <filename>configure</filename> script file, so the recipient can compile, build and install your application without having <command>Automake</command>, <command>Autoconf</command> or &tdevelop; on their machine. The <filename>Makefile.am</filename> files are also included, just in case the receiver needs to do any source-code modifications. </para> <note><para> The rules are rather different if you distribute via a web-based source-code repository such as &kde; &cvs;. @@ -290,7 +290,7 @@ As you can see, many of the items on the right hand side are symbols of the form </para> <para> -Also, sometime after you have started with &kdevelop;, it is a good idea to run the command <command>./configure --help</command>, which will show you the range of things you can change at build and installation time, such as for a test environment. In particular, the command: +Also, sometime after you have started with &tdevelop;, it is a good idea to run the command <command>./configure --help</command>, which will show you the range of things you can change at build and installation time, such as for a test environment. In particular, the command: <screen> ./configure --prefix=/where/you/wish @@ -346,7 +346,7 @@ In this chapter you will find a basic description of the &automanag; elements an On top of each view there is a <emphasis>toolbar</emphasis>, the buttons in which will become activated when an element in this view is selected. This provides one way you can access the actions provided for that view element. The other are context menus which pop up on right mouse button click as will be discussed below. </para></listitem> <listitem><para> - In IDEAl mode there are two additional small buttons in the &automanag; window titlebar left hand side – a triangular shaped right arrow, and a dot button. The arrow button is used to <emphasis>close the window</emphasis>. The dot button on the other hand will <emphasis>keep the window open</emphasis> even if another &kdevelop; window has been selected. (Otherwise the &automanag; window will automatically close whenever another window gets the input focus.) + In IDEAl mode there are two additional small buttons in the &automanag; window titlebar left hand side – a triangular shaped right arrow, and a dot button. The arrow button is used to <emphasis>close the window</emphasis>. The dot button on the other hand will <emphasis>keep the window open</emphasis> even if another &tdevelop; window has been selected. (Otherwise the &automanag; window will automatically close whenever another window gets the input focus.) </para></listitem> </itemizedlist></entry> </row></tbody></tgroup> @@ -429,7 +429,7 @@ In both the overall and the detail view you can left-click on the <symbol>+</sym <term>Opening a file for Edit</term> <listitem> <para>If you <emphasis>&LMB; click</emphasis> on a file name in the detail -view, the corresponding file opens up in &kdevelop;'s editing window.</para> +view, the corresponding file opens up in &tdevelop;'s editing window.</para> </listitem> </varlistentry> @@ -677,7 +677,7 @@ CXX = g++ <sect2 id="automake-manager"> -<title>&kdevelop;'s &automanag;</title> +<title>&tdevelop;'s &automanag;</title> <figure id="screenshot-automake-manager" float="1"> <title>A screenshot of the automake manager</title> diff --git a/doc/kdevelop/setup.docbook b/doc/kdevelop/setup.docbook index e5449a99..5dd15c06 100644 --- a/doc/kdevelop/setup.docbook +++ b/doc/kdevelop/setup.docbook @@ -7,10 +7,10 @@ </authorgroup> </chapterinfo> -<title>Configuring &kdevelop;</title> +<title>Configuring &tdevelop;</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. +&tdevelop; is a very powerful and flexible IDE which offers many ways to tailor it to your needs. To start configuration select <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &tdevelop;...</guimenuitem></menuchoice>. This will cause the configuration dialog to pop up consisting of a selection window to the left and the configuration dialog on the right hand side whose contents will vary upon the configuration item you did select. </para> <screenshot> @@ -56,7 +56,7 @@ If you want directly look up a certain configuration item use one of the followi <title>General Configuration</title> <para> -General configuration concerns the more common tasks of tailoring &kdevelop; as there are: +General configuration concerns the more common tasks of tailoring &tdevelop; as there are: </para> <itemizedlist> <listitem><para> @@ -88,7 +88,7 @@ General configuration concerns the more common tasks of tailoring &kdevelop; as <title>General Setup</title> <para> -The <guilabel>General</guilabel> configuration dialog allows you to define some basic &kdevelop; behaviour which seldom will change in everyday work. This concerns: +The <guilabel>General</guilabel> configuration dialog allows you to define some basic &tdevelop; behaviour which seldom will change in everyday work. This concerns: </para> <variablelist> @@ -97,10 +97,10 @@ The <guilabel>General</guilabel> configuration dialog allows you to define some <listitem> <itemizedlist> <listitem><para> - defining a <link linkend="setup-main-projects">default parent directory</link> &kdevelop; shall use for new projects. + defining a <link linkend="setup-main-projects">default parent directory</link> &tdevelop; shall use for new projects. </para></listitem> <listitem><para> - deciding whether you want &kdevelop; to <link linkend="setup-main-preload">automatically load</link> the project you last worked on. + deciding whether you want &tdevelop; to <link linkend="setup-main-preload">automatically load</link> the project you last worked on. </para></listitem> </itemizedlist> </listitem> @@ -114,7 +114,7 @@ namely:</term> <itemizedlist> <listitem> <para>the <link linkend="setup-main-messages-font">Messages Output -View</link> &kdevelop; uses to communicate ⪚ compilation progresses, +View</link> &tdevelop; uses to communicate ⪚ compilation progresses, and</para> </listitem> <listitem> @@ -166,7 +166,7 @@ messages</link> issued by <command>make</command> will be shown.</para> startup</guilabel></term> <listitem> <para> -Mark this checkbox if you want to continue to work with the last project you worked on. This will cause &kdevelop; to automatically load this project on start-up. It will usually be shown in the state you left work so you can readily proceed. +Mark this checkbox if you want to continue to work with the last project you worked on. This will cause &tdevelop; to automatically load this project on start-up. It will usually be shown in the state you left work so you can readily proceed. </para> </listitem> </varlistentry> @@ -176,9 +176,9 @@ Mark this checkbox if you want to continue to work with the last project you wor <guilabel>Default projects directory:</guilabel></term> <listitem> <para> -By default, &kdevelop; uses a common parent directory for all new +By default, &tdevelop; 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 +select it from your directory structure. &tdevelop; 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>. @@ -190,13 +190,13 @@ You may of course change the directory path of a new project at the time you set <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. +The <guilabel>Application Output View</guilabel> window is used to display error and state information from applications which are run from inside &tdevelop;. These are informations the applications usually sends to the console when run stand-alone. So you do not need to leave the IDE when testing the application you currently work on. </para> <para> To select a font suitable for the <guilabel>Messages Output View</guilabel> window click the <guilabel>Window Font</guilabel> button showing the currently selected font (it says <quote>Luxi Sans</quote> in the above illustration). The &kde; standard <guilabel>Select Font</guilabel> dialog will pop up from which you may select the font to be used. </para> <note><para> -On first start-up, &kdevelop; initializes this font setting to the standard font for which your &kde; user has been configured. <emphasis>This setting is fixed</emphasis>, so if you alter <menuchoice><guimenuitem>Preferences</guimenuitem><guimenuitem>Appearances & Themes</guimenuitem><guimenuitem>Fonts</guimenuitem></menuchoice> in the <guilabel>Control Center</guilabel>, this will not effect this &kdevelop; font selection. You will have to explicitely reselect the <guilabel>Messages Output View</guilabel> window font. +On first start-up, &tdevelop; initializes this font setting to the standard font for which your &kde; user has been configured. <emphasis>This setting is fixed</emphasis>, so if you alter <menuchoice><guimenuitem>Preferences</guimenuitem><guimenuitem>Appearances & Themes</guimenuitem><guimenuitem>Fonts</guimenuitem></menuchoice> in the <guilabel>Control Center</guilabel>, this will not effect this &tdevelop; font selection. You will have to explicitely reselect the <guilabel>Messages Output View</guilabel> window font. </para></note> </listitem> </varlistentry> @@ -205,7 +205,7 @@ On first start-up, &kdevelop; initializes this font setting to the standard font <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. +&tdevelop; preprocesses the messages the <guilabel>Messages Output View</guilabel> window receives during the build processes in order to filter superfluous information. You can control the level of detail &tdevelop; will display using the dropdown box in this field. </para> <variablelist> <varlistentry> @@ -238,7 +238,7 @@ There is an alternative way to switch the compiler output detail. Just right cli <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. +By default, &tdevelop; will wrap long lines around in the <guilabel>Messages Output View</guilabel> window so that valuable information will not be easily overlooked. In some cases this will clutter long message lists. Remove the checkbox mark if you do not want the lines wrap around. </para> <tip><para> There is an alternative way to switch the line wrapping. Just &RMB; click in the <guilabel>Messages Output View</guilabel> window and mark/unmark the <guimenuitem>Line Wrapping</guimenuitem> entry in the menu which will pop up. @@ -251,7 +251,7 @@ There is an alternative way to switch the line wrapping. Just &RMB; click in the messages</guilabel></term> <listitem> <para> -The <command>make</command> tool usually will display messages like <quote>Entering directory</quote>, or <quote>Leaving directory</quote> when it switches the directories it currently works in. As this clutters the messages list in the <guilabel>Messages Output View</guilabel> window, &kdevelop; suppresses those messages by default. Mark the checkbox if you want to protocol which directories <command>make</command> worked in. +The <command>make</command> tool usually will display messages like <quote>Entering directory</quote>, or <quote>Leaving directory</quote> when it switches the directories it currently works in. As this clutters the messages list in the <guilabel>Messages Output View</guilabel> window, &tdevelop; suppresses those messages by default. Mark the checkbox if you want to protocol which directories <command>make</command> worked in. </para> <note><para> Changes in this setting effect the processing of new messages only. Old directory navigation messages will be kept visible when you switch this feature off. @@ -263,14 +263,14 @@ Changes in this setting effect the processing of new messages only. Old director <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. +This let you choose the way you want <filename>.ui</filename> files to be displayed in &tdevelop;. &tdevelop; comes with its own UI designer called KDeveDesigner that can either be embedded or be run as a separate program. Qt Designer can also be used to edit <filename>.ui</filename> files. </para> <itemizedlist> <listitem><para> - Use &kdevelop;'s embedded designer - </para><para>This uses &kdevelop; own designer embedded within &kdevelop;</para></listitem> + Use &tdevelop;'s embedded designer + </para><para>This uses &tdevelop; own designer embedded within &tdevelop;</para></listitem> <listitem><para> - Run &kdevelop;'s designer as a separate application + Run &tdevelop;'s designer as a separate application </para><para>The KDevDesigner application will be run separately in its own window.</para> <screenshot> <mediaobject> @@ -285,7 +285,7 @@ This let you choose the way you want <filename>.ui</filename> files to be displa </listitem> <listitem><para> Run Qt Designer - </para><para>Qt Designer from your Qt installation will be started externally whenever you click on a <filename>.ui</filename> file in &kdevelop;.</para></listitem> + </para><para>Qt Designer from your Qt installation will be started externally whenever you click on a <filename>.ui</filename> file in &tdevelop;.</para></listitem> </itemizedlist> </listitem> </varlistentry> @@ -322,7 +322,7 @@ You choose here which terminal you want to be integrated within KDevelop. <primary>switch UI modes</primary></indexterm> <para> -As already said in the <link linkend="uimodes-survey">Available User Interface Modes</link> chapter there are five different ways the &kdevelop; work area may be set up, namely: +As already said in the <link linkend="uimodes-survey">Available User Interface Modes</link> chapter there are five different ways the &tdevelop; work area may be set up, namely: </para> <itemizedlist> <listitem><para> @@ -349,7 +349,7 @@ A typical example of this user interface mode is Borland Delphi 6.0.</para></lis </itemizedlist> <para> -To switch the user interface mode select <menuchoice> <guimenu>Settings</guimenu> <guimenuitem>Configure &kdevelop;...</guimenuitem> </menuchoice> from the menus. The <guilabel>Customize KDevelop</guilabel> dialog will pop up, where you have to select <guilabel>User Interface</guilabel> in the left hand tree. This will display the following settings dialog to the right.</para> +To switch the user interface mode select <menuchoice> <guimenu>Settings</guimenu> <guimenuitem>Configure &tdevelop;...</guimenuitem> </menuchoice> from the menus. The <guilabel>Customize KDevelop</guilabel> dialog will pop up, where you have to select <guilabel>User Interface</guilabel> in the left hand tree. This will display the following settings dialog to the right.</para> <screenshot> <mediaobject> @@ -368,7 +368,7 @@ Select the radio button of the user interface mode you want to switch to, then c </para> <note><para> -Do not forget to restart &kdevelop; in order to let any of these selections take effect. +Do not forget to restart &tdevelop; in order to let any of these selections take effect. </para></note> <para> @@ -384,26 +384,26 @@ In <guilabel>Simplified IDEAl window mode</guilabel> and in <guilabel>IDEAl wind <term id="setup-ui-tabs">Configuring the Documents Tab Bar Display</term> <listitem> <para> -In the IDEAl and tabbed pages modes there will be named tabs on top of the document windows by default, so you can easily select different documents with a &LMB; click. If you prefer to provide more space for the document windows in the &kdevelop; main work area, you may change to another behaviour in the <guilabel>Use Tabs</guilabel> configuration section. +In the IDEAl and tabbed pages modes there will be named tabs on top of the document windows by default, so you can easily select different documents with a &LMB; click. If you prefer to provide more space for the document windows in the &tdevelop; main work area, you may change to another behaviour in the <guilabel>Use Tabs</guilabel> configuration section. </para> <variablelist> <varlistentry> <term><guilabel>Always</guilabel></term> <listitem><para> - This is the default — show a tab comprising an icon and the document name on top of any document window in the &kdevelop; main area display. + This is the default — show a tab comprising an icon and the document name on top of any document window in the &tdevelop; main area display. </para></listitem> </varlistentry> <varlistentry> <term><guilabel>When more than one</guilabel></term> <listitem><para> - Do not show a tab when only one document is displayed. If there is more than one document, however, &kdevelop; will display an according tab bar as in the <guilabel>Always</guilabel> selection above. You may want to select this mode if you work on a single document most of the time as this provides more vertical space. + Do not show a tab when only one document is displayed. If there is more than one document, however, &tdevelop; will display an according tab bar as in the <guilabel>Always</guilabel> selection above. You may want to select this mode if you work on a single document most of the time as this provides more vertical space. </para></listitem> </varlistentry> <varlistentry> <term><guilabel>Never</guilabel></term> <listitem><para> - Never show any document selection tab. You may prefer this mode if you seldom use the mouse to switch between documents. It provides more vertical space for all document windows. To select another the document window or to close any, use the &kdevelop; <guimenu>Window</guimenu> menu. + Never show any document selection tab. You may prefer this mode if you seldom use the mouse to switch between documents. It provides more vertical space for all document windows. To select another the document window or to close any, use the &tdevelop; <guimenu>Window</guimenu> menu. </para></listitem> </varlistentry> </variablelist> @@ -415,7 +415,7 @@ In the IDEAl and tabbed pages modes there will be named tabs on top of the docum Tab</term> <listitem> <para> -When you configured &kdevelop; to display the documents tab bar, either always or when more than one document is displayed in the main work area, you may add more functionality to the tabs beyond their document selection capability. Use the <guilabel>Use Close On Hover</guilabel> coniguration section for this. +When you configured &tdevelop; to display the documents tab bar, either always or when more than one document is displayed in the main work area, you may add more functionality to the tabs beyond their document selection capability. Use the <guilabel>Use Close On Hover</guilabel> coniguration section for this. </para> <variablelist> @@ -428,13 +428,13 @@ When you configured &kdevelop; to display the documents tab bar, either always o <varlistentry> <term><guilabel>Yes</guilabel></term> <listitem><para> - When you selected this radio button, &kdevelop; will allow to close a document window by a &LMB; click. Use the mouse to point at the small icon on the on the left tab border. It will change to a close symbol. Now click with the &LMB; on this changed symbol and &kdevelop; will close the according document window. + When you selected this radio button, &tdevelop; will allow to close a document window by a &LMB; click. Use the mouse to point at the small icon on the on the left tab border. It will change to a close symbol. Now click with the &LMB; on this changed symbol and &tdevelop; will close the according document window. </para></listitem> </varlistentry> <varlistentry> <term><guilabel>Yes, Delayed</guilabel></term> <listitem><para> - After selecting this radio button, &kdevelop; will allow to close a document window as shown in the <guilabel>Yes</guilabel> case above. The icon will not change instantly, however, but there will be a short delay before the close icon shows up. + After selecting this radio button, &tdevelop; will allow to close a document window as shown in the <guilabel>Yes</guilabel> case above. The icon will not change instantly, however, but there will be a short delay before the close icon shows up. </para></listitem> </varlistentry> </variablelist> @@ -524,7 +524,7 @@ The active toolview window must be shown fixed (non-overlap mode), sharing the w <sect2 id="setup-editor"> <title>Selecting an Editor</title> -<para>&kdevelop; allows you to select your favorite text editor tool. Mark the <guilabel>Editor</guilabel> entry in the left hand side selections tree of the <guilabel>Configure KDevelop</guilabel> window. The following dialog will be displayed to the right. +<para>&tdevelop; allows you to select your favorite text editor tool. Mark the <guilabel>Editor</guilabel> entry in the left hand side selections tree of the <guilabel>Configure KDevelop</guilabel> window. The following dialog will be displayed to the right. </para> <screenshot> @@ -560,7 +560,7 @@ To select a new editor, click on the arrow on the drop down list field. Dependin </variablelist> <para> -These editor interfaces are fully integrated in the &kdevelop; IDE concept. Particularly the possibility to jump to the offending source code line by just clicking on an error message in the <guilabel>Messages Output View</guilabel> window has been provided. +These editor interfaces are fully integrated in the &tdevelop; IDE concept. Particularly the possibility to jump to the offending source code line by just clicking on an error message in the <guilabel>Messages Output View</guilabel> window has been provided. </para> <note><para> @@ -655,15 +655,15 @@ KDevelop lets you use editor interfaces which have registered with &kde; and tha <title>Selecting a Source Format Style</title> <para> -&kdevelop; automatically formats a source text in a predefined style. This style is highly configurable. +&tdevelop; automatically formats a source text in a predefined style. This style is highly configurable. </para> <note><para> -The reformat source feature is currently available for C, C++, and &Java; only. Especially you cannot use it for scripting languages like ⪚ PHP. This is because &kdevelop; uses the <ulink url="http://astyle.sourceforge.net/">astyle</ulink> application to implement this feature. +The reformat source feature is currently available for C, C++, and &Java; only. Especially you cannot use it for scripting languages like ⪚ PHP. This is because &tdevelop; uses the <ulink url="http://astyle.sourceforge.net/">astyle</ulink> application to implement this feature. </para></note> <para> -To set up a specific format style, select <menuchoice> <guimenu>Settings</guimenu> <guimenuitem>Configure &kdevelop;..</guimenuitem> </menuchoice> from the menubar. The <guilabel>Customize KDevelop</guilabel> dialog will pop up, where you have to select <guilabel>Source Formatter</guilabel> in the left hand tree. This will display a series of three settings dialog tabs to the right, namely a <link linkend="setup-format-general">General Formatting Setup</link>, a <link linkend="setup-format-indent">Indentation Style Setup</link>, and a <link linkend="setup-format-other">Other Formatting Setup</link>. +To set up a specific format style, select <menuchoice> <guimenu>Settings</guimenu> <guimenuitem>Configure &tdevelop;..</guimenuitem> </menuchoice> from the menubar. The <guilabel>Customize KDevelop</guilabel> dialog will pop up, where you have to select <guilabel>Source Formatter</guilabel> in the left hand tree. This will display a series of three settings dialog tabs to the right, namely a <link linkend="setup-format-general">General Formatting Setup</link>, a <link linkend="setup-format-indent">Indentation Style Setup</link>, and a <link linkend="setup-format-other">Other Formatting Setup</link>. </para> <tip><para> @@ -930,7 +930,7 @@ namespace foospace <term>Controlling Extra Spaces</term> <listitem> <para> -By default &kdevelop; does minimize the use of spaces in source texts. +By default &tdevelop; does minimize the use of spaces in source texts. </para> @@ -997,7 +997,7 @@ split a long line apart. For C/C++ code this can be controlled here.</para> <title>Setting Up the Code Snippets Tool</title> <para> -When editing in &kdevelop; you can store often used parts of code as <link linkend="editing-snippets">Code Snippets</link>. To configure the capabilities of the code snippets part select <menuchoice> <guimenu>Settings</guimenu> <guimenuitem>Configure &kdevelop;..</guimenuitem> </menuchoice> from the menubar. The <guilabel>Customize KDevelop</guilabel> dialog will pop up, where you have to select <guilabel>Code Snippets</guilabel> in the left hand tree. This will show the following dialog in the right hand side. +When editing in &tdevelop; you can store often used parts of code as <link linkend="editing-snippets">Code Snippets</link>. To configure the capabilities of the code snippets part select <menuchoice> <guimenu>Settings</guimenu> <guimenuitem>Configure &tdevelop;..</guimenuitem> </menuchoice> from the menubar. The <guilabel>Customize KDevelop</guilabel> dialog will pop up, where you have to select <guilabel>Code Snippets</guilabel> in the left hand tree. This will show the following dialog in the right hand side. </para> <screenshot> @@ -1069,7 +1069,7 @@ variables' mechanism. You can set up it's behaviour in the <title>Configuring the File Selector</title> <para> -&kdevelop; provides a <guilabel>File Selector</guilabel> plugin which, when +&tdevelop; provides a <guilabel>File Selector</guilabel> plugin which, when loaded at start-up, allows to navigate to any file or directory in the system. </para> @@ -1088,7 +1088,7 @@ system. <para>The behaviour of the <guilabel>File Selector</guilabel> can be highly configured. Select <menuchoice> <guimenu>Settings</guimenu> -<guimenuitem>Configure &kdevelop;..</guimenuitem> </menuchoice> from the +<guimenuitem>Configure &tdevelop;..</guimenuitem> </menuchoice> from the menubar. The <guilabel>Customize KDevelop</guilabel> dialog will pop up, where you have to select <guilabel>File Selector</guilabel> in the left hand tree. This will show the following dialog in the right hand side.</para> @@ -1240,11 +1240,11 @@ entries as follows.</para> <term>Controlling What Should be Remembered Between Sessions</term> <listitem> <para> -By default the <guilabel>File Selector</guilabel> is set up so that it shows the display of the most recent session again at the next &kdevelop; start-up. You may change this behaviour in the <guilabel>Session</guilabel> configuration group. +By default the <guilabel>File Selector</guilabel> is set up so that it shows the display of the most recent session again at the next &tdevelop; start-up. You may change this behaviour in the <guilabel>Session</guilabel> configuration group. </para> <note><para> -If &kdevelop; was automatically restarted by the &kde; session manager the changes in these settings will have no effect. In this case location and filter settings of the most recent &kde; session will always be restored. +If &tdevelop; was automatically restarted by the &kde; session manager the changes in these settings will have no effect. In this case location and filter settings of the most recent &kde; session will always be restored. </para></note> </listitem> </varlistentry> @@ -1310,7 +1310,7 @@ If &kdevelop; was automatically restarted by the &kde; session manager the chang <title>Configuring the Documentation</title> <para> -&kdevelop; contains a very powerful documentation facility which provides access to several kinds of extensive documentation. In ⪚ IDEAl mode you find a <guilabel>Documentation</guilabel> tab at the right border of the work area. +&tdevelop; contains a very powerful documentation facility which provides access to several kinds of extensive documentation. In ⪚ IDEAl mode you find a <guilabel>Documentation</guilabel> tab at the right border of the work area. </para> <screenshot> @@ -1318,19 +1318,19 @@ If &kdevelop; was automatically restarted by the &kde; session manager the chang <imageobject> <imagedata fileref="documents-contents.png" format="PNG"/> </imageobject> -<textobject><phrase>The &kdevelop; documentation window in IDEAl mode</phrase></textobject> +<textobject><phrase>The &tdevelop; documentation window in IDEAl mode</phrase></textobject> <caption><para> - The &kdevelop; documentation window (IDEAl mode) + The &tdevelop; documentation window (IDEAl mode) </para></caption> </mediaobject> </screenshot> <note><para> -&kdevelop; must have loaded the <guilabel>Documentation</guilabel> plugin in order to view the documentation tree. See the <link linkend="setup-plugins">Plugin Tools</link> section for more info. +&tdevelop; must have loaded the <guilabel>Documentation</guilabel> plugin in order to view the documentation tree. See the <link linkend="setup-plugins">Plugin Tools</link> section for more info. </para></note> <para> -You may set up contents and behaviour of the various parts of this documentation window if you select <menuchoice> <guimenu>Settings</guimenu> <guimenuitem>Configure &kdevelop;..</guimenuitem> </menuchoice> from the menubar. The <guilabel>Customize KDevelop</guilabel> dialog will pop up, where you have to select <guilabel>Documentation</guilabel> in the left hand window. +You may set up contents and behaviour of the various parts of this documentation window if you select <menuchoice> <guimenu>Settings</guimenu> <guimenuitem>Configure &tdevelop;..</guimenuitem> </menuchoice> from the menubar. The <guilabel>Customize KDevelop</guilabel> dialog will pop up, where you have to select <guilabel>Documentation</guilabel> in the left hand window. </para> <para> @@ -1347,7 +1347,7 @@ The thus displayed <link linkend="configure-docu-general">configuration page</li <title>Setting Up Documentation Collections</title> <para> -The documentation configuration settings have been divided into a series of documentation collections, each providing access to documentation files of some unique format and content type. These setups control which documentation items will be listed on the <guilabel>Contents</guilabel> page of the &kdevelop; <guilabel>Documentation</guilabel> facility, and how the user may access documentation details by indexed and full text searches. +The documentation configuration settings have been divided into a series of documentation collections, each providing access to documentation files of some unique format and content type. These setups control which documentation items will be listed on the <guilabel>Contents</guilabel> page of the &tdevelop; <guilabel>Documentation</guilabel> facility, and how the user may access documentation details by indexed and full text searches. </para> <para> The <guilabel>Documentation</guilabel> tab provides a series of configuration pages which are ordered vertically like a stack of index cards. One page at a time will open after a click on its index card title: @@ -1356,7 +1356,7 @@ The <guilabel>Documentation</guilabel> tab provides a series of configuration pa <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-toc">&tdevelop; 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> @@ -1445,7 +1445,7 @@ Every documentation setup page shows the listed documentation items in a table w <term><guilabel>TOC</guilabel></term> <listitem> <para> - If this check box is marked, this documentation item will show up on the <guilabel>Contents</guilabel> page of the &kdevelop; <guilabel>Documentation</guilabel> facility. + If this check box is marked, this documentation item will show up on the <guilabel>Contents</guilabel> page of the &tdevelop; <guilabel>Documentation</guilabel> facility. </para> <note><para> Unchecking the <guilabel>TOC</guilabel> check box will in turn disable the <guilabel>Index</guilabel> and <guilabel>Search</guilabel> check boxes (see below). Thus you cannot have documentation collection items indexed but not shown in the contents. @@ -1456,7 +1456,7 @@ Every documentation setup page shows the listed documentation items in a table w <term><guilabel>Index</guilabel></term> <listitem> <para> - If this check box is marked, an internal index will be built of this documentation item. This provides fast access to the documentation by the use of the <guilabel>Index</guilabel> and (optionally) <guilabel>Finder</guilabel> pages of the &kdevelop; <guilabel>Documentation</guilabel> facility. + If this check box is marked, an internal index will be built of this documentation item. This provides fast access to the documentation by the use of the <guilabel>Index</guilabel> and (optionally) <guilabel>Finder</guilabel> pages of the &tdevelop; <guilabel>Documentation</guilabel> facility. </para> <note> <para> @@ -1472,14 +1472,14 @@ Every documentation setup page shows the listed documentation items in a table w <term><guilabel>Search</guilabel></term> <listitem> <para> - If this check box is marked, the contents of this documentation item will be included in the full text search path of the <guilabel>Search</guilabel> page of the &kdevelop; <guilabel>Documentation</guilabel> facility. + If this check box is marked, the contents of this documentation item will be included in the full text search path of the <guilabel>Search</guilabel> page of the &tdevelop; <guilabel>Documentation</guilabel> facility. </para> <note> <para> - &kdevelop; utilizes the htdig application collection to perform full text searches. This search is done over an internal index, the htdig machinery has to build before it can be used. + &tdevelop; utilizes the htdig application collection to perform full text searches. This search is done over an internal index, the htdig machinery has to build before it can be used. </para> <para> - Any change of the <guilabel>Search</guilabel> check box marks will thus effect the search runs only after you rebuilt the index on the <guilabel>Search</guilabel> page of the &kdevelop; <guilabel>Documentation</guilabel> facility. + Any change of the <guilabel>Search</guilabel> check box marks will thus effect the search runs only after you rebuilt the index on the <guilabel>Search</guilabel> page of the &tdevelop; <guilabel>Documentation</guilabel> facility. </para> </note> </listitem> @@ -1487,13 +1487,13 @@ Every documentation setup page shows the listed documentation items in a table w <varlistentry> <term><guilabel>Title</guilabel></term> <listitem><para> - This is the name of the Documentation item as it will be shown on the <guilabel>Contents</guilabel> page of the &kdevelop; <guilabel>Documentation</guilabel> facility. + This is the name of the Documentation item as it will be shown on the <guilabel>Contents</guilabel> page of the &tdevelop; <guilabel>Documentation</guilabel> facility. </para></listitem> </varlistentry> </variablelist> <note><para> -Former &kdevelop; versions allowed to select the documentation items to be displayed on a per-project basis. This is not available any more. +Former &tdevelop; versions allowed to select the documentation items to be displayed on a per-project basis. This is not available any more. </para></note> </listitem> </varlistentry> @@ -1521,7 +1521,7 @@ On this configuration page all &Qt; documentation is set up. </screenshot> <para> -Normally &kdevelop; will fill this in on its first start-up. It looks for standard <filename>*.xml</filename>, or <filename>*.dcf</filename> documentation files in the &Qt; installation directory. The table to the left lists the files &kdevelop; found by their standard titles. +Normally &tdevelop; will fill this in on its first start-up. It looks for standard <filename>*.xml</filename>, or <filename>*.dcf</filename> documentation files in the &Qt; installation directory. The table to the left lists the files &tdevelop; found by their standard titles. </para> <para> @@ -1529,11 +1529,11 @@ If you have a non-standard installation, either there will be no information lis </para> <note><para> -&kdevelop; will use the titles already provided by the installed &Qt; documentation. Hence the <guilabel>Title</guilabel> field in the <guilabel>Documentation Catalog Properties</guilabel> dialog is inaccessible. +&tdevelop; will use the titles already provided by the installed &Qt; documentation. Hence the <guilabel>Title</guilabel> field in the <guilabel>Documentation Catalog Properties</guilabel> dialog is inaccessible. </para></note> <para> -By default, not all &Qt; documentation will be shown on the <guilabel>Contents</guilabel> page of the &kdevelop; <guilabel>Documentation</guilabel> facility. Use the <guilabel>TOC</guilabel> check box in the <link linkend="setup-docu-columns">setup table</link> to select the documentation to be shown. +By default, not all &Qt; documentation will be shown on the <guilabel>Contents</guilabel> page of the &tdevelop; <guilabel>Documentation</guilabel> facility. Use the <guilabel>TOC</guilabel> check box in the <link linkend="setup-docu-columns">setup table</link> to select the documentation to be shown. </para> <para> @@ -1562,7 +1562,7 @@ On this configuration page you may collect documentation according to the &Micro </screenshot> <para> -By default, this configuration page will be empty (as shown above). You may add new entries using the <link linkend="setup-docu-buttons">buttons</link> to the right of the list field. &kdevelop; will filter <filename>*.chm</filename> files in the directory dialog associated to the <guibutton>Add</guibutton> and <guibutton>Edit</guibutton> buttons. +By default, this configuration page will be empty (as shown above). You may add new entries using the <link linkend="setup-docu-buttons">buttons</link> to the right of the list field. &tdevelop; will filter <filename>*.chm</filename> files in the directory dialog associated to the <guibutton>Add</guibutton> and <guibutton>Edit</guibutton> buttons. </para> <para> @@ -1594,13 +1594,13 @@ On this configuration page all &API; documentation generated by &doxygen; is set In short, such an &API; documents the interface to certain library functions. The &API; documentation on this page should be produced by the externally provided <ulink url="http://www.stack.nl/~dimitri/doxygen/">&doxygen;</ulink> tool. </para> <para> -&doxygen; generated &API; documentationconsists of a series of <filename>html</filename> files, starting with <filename>index.html</filename>. Additionally there may exist <filename>tag</filename> files which contain information to link to already existing &API; documentations. Thus &kdevelop; will look for <filename>index.html</filename> and <filename>*.tag</filename> files when seaching for &doxygen; generated &API; documentation. +&doxygen; generated &API; documentationconsists of a series of <filename>html</filename> files, starting with <filename>index.html</filename>. Additionally there may exist <filename>tag</filename> files which contain information to link to already existing &API; documentations. Thus &tdevelop; will look for <filename>index.html</filename> and <filename>*.tag</filename> files when seaching for &doxygen; generated &API; documentation. </para> <para> There are some structural constraints assumed when searching for &doxygen; generated &API; documentation. The directory in which the <filename>index.html</filename> file resides should contain subdirectories with separate documentation collections. Each of these subdirectories is assumed to contain a <filename>.tag</filename> file and a <filename class="directory">html/</filename> subdirectory. </para> <para> -You may have a look at <filename class="directory">$<envar>KDEDIR</envar>/share/doc/HTML/en/kdelibs-apidocs</filename> for an example of such a &doxygen; &API; documentation layout. +You may have a look at <filename class="directory">$<envar>KDEDIR</envar>/share/doc/HTML/en/tdelibs-apidocs</filename> for an example of such a &doxygen; &API; documentation layout. </para> <note><para> @@ -1608,25 +1608,25 @@ The older &kde; <ulink url="http://sirtaj.net/projects/kdoc/">KDoc</ulink> gener </para></note> <para> -&kdevelop; will have filled in a link to the current &kde; Libraries &API;, provided it found one. There are several ways for &kdevelop; to find out: +&tdevelop; will have filled in a link to the current &kde; Libraries &API;, provided it found one. There are several ways for &tdevelop; to find out: </para> <itemizedlist> <listitem><para> Either you provided the <command>configure</command> command with the - <option>--with-kdelibsdoxy-dir</option> option when you compiled - &kdevelop; (see the <link linkend="make-api">How to Obtain a &kdevelop; &API; Documentation</link> chapter). + <option>--with-tdelibsdoxy-dir</option> option when you compiled + &tdevelop; (see the <link linkend="make-api">How to Obtain a &tdevelop; &API; Documentation</link> chapter). </para></listitem> <listitem><para> Or the <command>configure</command> command did automatically find a &doxygen; generated &kde; Libraries &API; in one of several standard locations it knows of. </para></listitem> <listitem><para> - Or as a last resort the <filename class="directory">$<envar>KDEDIR</envar>/share/doc/HTML/en/kdelibs-apidocs/</filename> was found at the first &kdevelop; startup. + Or as a last resort the <filename class="directory">$<envar>KDEDIR</envar>/share/doc/HTML/en/tdelibs-apidocs/</filename> was found at the first &tdevelop; startup. </para></listitem> </itemizedlist> <para> -If &kdevelop; did not find a valid &doxygen; generated &kde; Libraries &API; at its first start-up the <guilabel>Doxygen Documentation Collection</guilabel> list will be empty. +If &tdevelop; did not find a valid &doxygen; generated &kde; Libraries &API; at its first start-up the <guilabel>Doxygen Documentation Collection</guilabel> list will be empty. </para> <para> @@ -1634,12 +1634,12 @@ You may add your own &API; documentation entries (⪚ from your current project </para> <note><para> -&kdevelop; uses the title information from the <filename>index.html</filename>. Hence the <guilabel>Title</guilabel> field in the <guilabel>Documentation Catalog Properties</guilabel> dialog is inaccessible. +&tdevelop; uses the title information from the <filename>index.html</filename>. Hence the <guilabel>Title</guilabel> field in the <guilabel>Documentation Catalog Properties</guilabel> dialog is inaccessible. </para></note> <tip> <para> - The &kde; system provides more &API; documentation than the &kde; Libraries &API; only. You will need additional interfaces information if you want to ⪚ include the &kate; part into you programs. For this &kate; part &API; for example you should compile and install the &kde; Base Libraries &API; from the <ulink url="http://developer.kde.org/source/index.html">sources</ulink> (using the <command>make apidox</command> and <command>make install</command> commands on the <filename class="directory">kdebase</filename> sources) and then add an entry to the <guilabel>Doxygen Documentation Collection</guilabel> list like this: + The &kde; system provides more &API; documentation than the &kde; Libraries &API; only. You will need additional interfaces information if you want to ⪚ include the &kate; part into you programs. For this &kate; part &API; for example you should compile and install the &kde; Base Libraries &API; from the <ulink url="http://developer.kde.org/source/index.html">sources</ulink> (using the <command>make apidox</command> and <command>make install</command> commands on the <filename class="directory">tdebase</filename> sources) and then add an entry to the <guilabel>Doxygen Documentation Collection</guilabel> list like this: </para> <screenshot><mediaobject> <imageobject> @@ -1656,7 +1656,7 @@ You may add your own &API; documentation entries (⪚ from your current project </tip> <note><para> -You must put the &API; of your current project into this <guilabel>Doxygen Documentation Collection</guilabel> as well. Former &kdevelop; versions did put it into the documentation tree on a per-project basis. This is not provided any more. +You must put the &API; of your current project into this <guilabel>Doxygen Documentation Collection</guilabel> as well. Former &tdevelop; versions did put it into the documentation tree on a per-project basis. This is not provided any more. </para></note> </sect3> <!-- setup-docu-general-dox --> @@ -1665,7 +1665,7 @@ You must put the &API; of your current project into this <guilabel>Doxygen Docum <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. +The main bulk of the &tdevelop; documentation facility provides immediate access to structured documentation, local as well as remote ones. You can configure this on the <guilabel>KDevelopTOC Documentation Collection</guilabel> page. </para> <screenshot> @@ -1680,31 +1680,31 @@ The main bulk of the &kdevelop; documentation facility provides immediate access </screenshot> <para> -&kdevelop; comes with a bunch of predefined KDevelopTOC files which are automatically entered in the table at installation time. To keep the display manageable only the most often used will initially be marked for display. If you want to see another documentation, mark the <guilabel>TOC</guilabel> check box in the <link linkend="setup-docu-columns">setup table</link>. +&tdevelop; comes with a bunch of predefined KDevelopTOC files which are automatically entered in the table at installation time. To keep the display manageable only the most often used will initially be marked for display. If you want to see another documentation, mark the <guilabel>TOC</guilabel> check box in the <link linkend="setup-docu-columns">setup table</link>. </para> <para> -KDevelopTOC files cannot be indexed to perform a full text search because they usually point to a remote location. On the other hand, such a <filename>.toc</filename> file can have an index manually defined, using the <computeroutput><index></computeroutput> tag. Thus the <guilabel>Index</guilabel> check box will be enabled ony when &kdevelop; finds an <computeroutput><index></computeroutput> tag in the <filename>.toc</filename> file. (For more detail see the description below in the <link linkend="setup-docu-general-toc-files">&kdevelop; TOC Files</link> section.) +KDevelopTOC files cannot be indexed to perform a full text search because they usually point to a remote location. On the other hand, such a <filename>.toc</filename> file can have an index manually defined, using the <computeroutput><index></computeroutput> tag. Thus the <guilabel>Index</guilabel> check box will be enabled ony when &tdevelop; finds an <computeroutput><index></computeroutput> tag in the <filename>.toc</filename> file. (For more detail see the description below in the <link linkend="setup-docu-general-toc-files">&tdevelop; TOC Files</link> section.) </para> <para> The <guilabel>Search</guilabel> check box in the <link linkend="setup-docu-columns">setup table</link> will alway be disabled. </para> <para> -You may add new entries using the <link linkend="setup-docu-buttons">buttons</link> to the right of the list field. &kdevelop; will filter <filename>*.toc</filename> files in the directory dialog associated to the <guibutton>Add</guibutton> and <guibutton>Edit</guibutton> buttons. +You may add new entries using the <link linkend="setup-docu-buttons">buttons</link> to the right of the list field. &tdevelop; will filter <filename>*.toc</filename> files in the directory dialog associated to the <guibutton>Add</guibutton> and <guibutton>Edit</guibutton> buttons. </para> <note><para> -Other than former &kdevelop; versions will the <guibutton>Remove</guibutton> button not change the <filename>*.toc</filename> files on disk, so the remove operation is safe now. +Other than former &tdevelop; versions will the <guibutton>Remove</guibutton> button not change the <filename>*.toc</filename> files on disk, so the remove operation is safe now. </para></note> </sect3> <!-- setup-docu-general-toc --> <sect3 id="setup-docu-general-toc-files"> -<title>&kdevelop; TOC Files</title> +<title>&tdevelop; TOC Files</title> <para> -There is a special feature associated with this. To illustrate, follow these steps: In the documentation tree find an entry shortly below the &Qt;/&kde; documentation (⪚ <quote>KDE2 Development Book (kde.org)</quote>). Click on the plus sign next to it. A tree will open where you can quickly navigate to subsequent chapters nested several levels deep, all offline. But if you finally select one of the chapters, &kdevelop; will in many cases try to access a <emphasis>remote</emphasis> documentation file. +There is a special feature associated with this. To illustrate, follow these steps: In the documentation tree find an entry shortly below the &Qt;/&kde; documentation (⪚ <quote>KDE2 Development Book (kde.org)</quote>). Click on the plus sign next to it. A tree will open where you can quickly navigate to subsequent chapters nested several levels deep, all offline. But if you finally select one of the chapters, &tdevelop; will in many cases try to access a <emphasis>remote</emphasis> documentation file. </para> <para> @@ -1712,15 +1712,15 @@ The rationale behind this is not only to locally navigate remote documentation w </para> <para> -Such structured access is made possible through the use of special <quote>table of content</quote> files, which are denoted by <filename>.toc</filename> filename extensions. Any such &kdevelop; TOC file contains an &XML; structured description of the document to be accessed. +Such structured access is made possible through the use of special <quote>table of content</quote> files, which are denoted by <filename>.toc</filename> filename extensions. Any such &tdevelop; TOC file contains an &XML; structured description of the document to be accessed. </para> <variablelist> <varlistentry> -<term>Standard Directory of &kdevelop; TOC Files</term> +<term>Standard Directory of &tdevelop; TOC Files</term> <listitem> <para> -When &kdevelop; was installed usually a series of predefined <filename>.toc</filename> files has been put into the <filename class="directory">$KDEDIR/share/apps/kdevdocumentation/tocs</filename> directory. These are fairly simple, structured text files. You may look at them using a text editor or other text display facility. +When &tdevelop; was installed usually a series of predefined <filename>.toc</filename> files has been put into the <filename class="directory">$KDEDIR/share/apps/kdevdocumentation/tocs</filename> directory. These are fairly simple, structured text files. You may look at them using a text editor or other text display facility. </para> </listitem> </varlistentry></variablelist> @@ -1730,16 +1730,16 @@ When &kdevelop; was installed usually a series of predefined <filename>.toc</fil <!-- this first revision is done. --> <variablelist id="toc-file-structure"> - <title>Basic Structure of &kdevelop; TOC Files</title> + <title>Basic Structure of &tdevelop; TOC Files</title> <varlistentry> <term>header</term> <listitem> <simplelist> <member> - <computeroutput><!DOCTYPE kdeveloptoc></computeroutput> + <computeroutput><!DOCTYPE tdeveloptoc></computeroutput> </member> <member> - <computeroutput><kdeveloptoc></computeroutput> + <computeroutput><tdeveloptoc></computeroutput> </member> <member> <emphasis>(title)</emphasis> @@ -1754,11 +1754,11 @@ When &kdevelop; was installed usually a series of predefined <filename>.toc</fil <emphasis>(index structure)</emphasis> </member> <member> - <computeroutput></kdeveloptoc></computeroutput> + <computeroutput></tdeveloptoc></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. + This &XML; structure will be parsed by the &tdevelop; <guilabel>Documentation</guilabel> plugin to set up the documentation tree contents and to guide the user in navigating the documentation. It contains all information necessary to display titles and access the documentation file contents. </para> </listitem> </varlistentry> @@ -1773,7 +1773,7 @@ When &kdevelop; was installed usually a series of predefined <filename>.toc</fil </member> </simplelist> <para> - This is the title &kdevelop; will display at the basic levels in the documentation tree. + This is the title &tdevelop; will display at the basic levels in the documentation tree. </para> <note><para> This displayed title cannot be changed by the user. If you want another text be displayed, you must manually change the <computeroutput><title></computeroutput> entry in the <filename>.toc</filename> file. @@ -1826,7 +1826,7 @@ When &kdevelop; was installed usually a series of predefined <filename>.toc</fil Any <computeroutput><tocsecti></computeroutput> entry must have a <computeroutput>name="xxx"</computeroutput> attribute associated with it (the "xxx" denotes the actual title string). This name will be displayed as level title in the documentation tree. It should correspond to an actual documentation section. </para> <para> - There may be an <computeroutput>url=""</computeroutput> attribute associated with any <emphasis>i</emphasis> nesting level. When the user clicks on a section title in the documentation tree &kdevelop; will try to access the file at the location pointed to by the combined base and section &URL;. + There may be an <computeroutput>url=""</computeroutput> attribute associated with any <emphasis>i</emphasis> nesting level. When the user clicks on a section title in the documentation tree &tdevelop; will try to access the file at the location pointed to by the combined base and section &URL;. </para> <para> The <computeroutput><tocsectn/></computeroutput> entry must have an <computeroutput>url=""</computeroutput> attribute whatsoever. @@ -1869,7 +1869,7 @@ When &kdevelop; was installed usually a series of predefined <filename>.toc</fil <title>DevHelp Documentation</title> <para> -DevHelp documentation is another means of structured documentation access. It uses structured table of content files denoted by a <filename>.devhelp</filename> extension similar to <link linkend="setup-docu-general-toc-files">&kdevelop; TOC files</link> to access documentation for the GNOME 2 desktop. +DevHelp documentation is another means of structured documentation access. It uses structured table of content files denoted by a <filename>.devhelp</filename> extension similar to <link linkend="setup-docu-general-toc-files">&tdevelop; TOC files</link> to access documentation for the GNOME 2 desktop. </para> <para> You can control which DevHelp files should be accessible on the <guilabel>DevHelp Documentation Collection</guilabel> configuration page. @@ -1891,11 +1891,11 @@ DevHelp files originally were accessible on the <ulink url="http://lidn.sourcefo </para> <para> -When &kdevelop; is installed it will attempt to find all <filename>.devhelp</filename> files in some standard places in the system, ⪚ in the subdirectories of <filename class="directory">/opt/gnome/share/</filename>. Initially these files will not be marked for display. If you want to see another documentation, mark the <guilabel>TOC</guilabel> check box in the <link linkend="setup-docu-columns">setup table</link>. +When &tdevelop; is installed it will attempt to find all <filename>.devhelp</filename> files in some standard places in the system, ⪚ in the subdirectories of <filename class="directory">/opt/gnome/share/</filename>. Initially these files will not be marked for display. If you want to see another documentation, mark the <guilabel>TOC</guilabel> check box in the <link linkend="setup-docu-columns">setup table</link>. </para> <para> -You may add new entries using the <link linkend="setup-docu-buttons">buttons</link> to the right of the list field. &kdevelop; will filter <filename>*.toc</filename> files in the directory dialog associated to the <guibutton>Add</guibutton> and <guibutton>Edit</guibutton> buttons. +You may add new entries using the <link linkend="setup-docu-buttons">buttons</link> to the right of the list field. &tdevelop; will filter <filename>*.toc</filename> files in the directory dialog associated to the <guibutton>Add</guibutton> and <guibutton>Edit</guibutton> buttons. </para> </sect3> <!-- setup-docu-general-devhelp --> @@ -1919,14 +1919,14 @@ This is for your own purpose. You may add almost any documentation files here, p </screenshot> <para> -Usually this collection will be empty at first &kdevelop; startup. We have filled in a deliberate item to show the entry structure. +Usually this collection will be empty at first &tdevelop; startup. We have filled in a deliberate item to show the entry structure. </para> <para> -Handling is straightforward here. Use the <link linkend="setup-docu-buttons">buttons</link> to the right of the list field to add, edit or remove the document items. &kdevelop; will not filter anything in the directory dialog associated to the <guibutton>Add</guibutton> and <guibutton>Edit</guibutton> buttons. +Handling is straightforward here. Use the <link linkend="setup-docu-buttons">buttons</link> to the right of the list field to add, edit or remove the document items. &tdevelop; will not filter anything in the directory dialog associated to the <guibutton>Add</guibutton> and <guibutton>Edit</guibutton> buttons. </para> <para> -You will have to explicitely select the items for display in the &kdevelop; documentation facility. Mark the <guilabel>TOC</guilabel> check box of the entry in the <link linkend="setup-docu-columns">setup table</link>. +You will have to explicitely select the items for display in the &tdevelop; documentation facility. Mark the <guilabel>TOC</guilabel> check box of the entry in the <link linkend="setup-docu-columns">setup table</link>. </para> <note><para> diff --git a/doc/kdevelop/survey-manual.docbook b/doc/kdevelop/survey-manual.docbook index d9611a03..0bd59c8d 100644 --- a/doc/kdevelop/survey-manual.docbook +++ b/doc/kdevelop/survey-manual.docbook @@ -2,30 +2,30 @@ <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. +This user manual is intended to describe the contents and use of the &tdevelop; &kdevrelease; Integrated Development Environment (IDE) from a user's point of view. It is not a programming manual, nor does it describe the development process in detail. Its only aim is to guide you in the handling of the IDE. </para> <para> Here you will find information on the following topics: </para> <variablelist> <varlistentry> -<term><link linkend="getting-started">Getting Started with &kdevelop; — a Guided Tour</link> </term> +<term><link linkend="getting-started">Getting Started with &tdevelop; — a Guided Tour</link> </term> <listitem> <para>Gives you a quick start on the use of this &IDE;, introducing the basic steps of how to work on a project.</para></listitem> </varlistentry> <varlistentry> -<term><link linkend="kdevelop-survey">Overview of the Features of - &kdevelop;</link></term> +<term><link linkend="tdevelop-survey">Overview of the Features of + &tdevelop;</link></term> <listitem> <para>Extends the guided tour in the previous chapter, giving an overall -view of what is built-in within &kdevelop; and gets you acquainted with the +view of what is built-in within &tdevelop; and gets you acquainted with the look and feel of this &IDE;.</para> </listitem> </varlistentry> <varlistentry> -<term><link linkend="setup">Configuring &kdevelop;</link></term> +<term><link linkend="setup">Configuring &tdevelop;</link></term> <listitem> <para>Shows how you can tailor the &IDE; to suit your needs.</para> </listitem> @@ -35,7 +35,7 @@ look and feel of this &IDE;.</para> <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; +<para>Describes the basics of how to set up a new project in &tdevelop; using the built-in &appwizard;.</para> </listitem> </varlistentry> @@ -60,7 +60,7 @@ and how to access the files you want to work with.</para> <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 +<para>Describes one of the most powerful tools of &tdevelop; which lets you navigate through class dependencies and allows you to easily create and access the classes and methods you need. </para> @@ -70,7 +70,7 @@ access the classes and methods you need. <varlistentry> <term><link linkend="documentation">Documentation</link></term> <listitem> -<para>Shows how to access the rich built-in documentation &kdevelop; +<para>Shows how to access the rich built-in documentation &tdevelop; 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> @@ -103,16 +103,16 @@ for diverse platforms, or to make an embedded system using the <listitem> <para>Describes how to use the integrated <application>gdb</application> debugger interface so you can hunt down bugs without leaving -&kdevelop;.</para> +&tdevelop;.</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;. + <link linkend="python">Python</link> — an overview of how to create Python-based applications in &tdevelop;. </para></listitem> <listitem><para> - <link linkend="php">PHP</link> — an overview of how to create PHP-based HTML applications in &kdevelop;. + <link linkend="php">PHP</link> — an overview of how to create PHP-based HTML applications in &tdevelop;. </para></listitem>//--> <varlistentry> @@ -127,7 +127,7 @@ project.</para> <!-- <listitem><para> - <link linkend="kdevelop-scripting">Scripting &kdevelop;</link> — describes how to add scripts to automate &kdevelop;. + <link linkend="tdevelop-scripting">Scripting &tdevelop;</link> — describes how to add scripts to automate &tdevelop;. </para></listitem> @@ -140,9 +140,9 @@ Some commonly used information has been put into the <emphasis>appendix</emphasi <variablelist> <varlistentry> -<term><link linkend="kdevelop-install">Installing &kdevelop;</link></term> +<term><link linkend="tdevelop-install">Installing &tdevelop;</link></term> <listitem> -<para>Tells you where to obtain &kdevelop; and how to get it up and +<para>Tells you where to obtain &tdevelop; and how to get it up and running.</para> </listitem> </varlistentry> @@ -155,7 +155,7 @@ Tricks</link></term> <listitem> <para>A quick reference to commonly used commands and actions. And a short guide to solve common problems when working with -&kdevelop;.</para> +&tdevelop;.</para> </listitem> </varlistentry> @@ -173,14 +173,14 @@ necessary and why you need an &IDE;.</para> </para></listitem> <listitem><para> - <link linkend="app-shortcuts">Shortcut Keys</link> — the keys you can use to work with &kdevelop; without resorting to the mouse. + <link linkend="app-shortcuts">Shortcut Keys</link> — the keys you can use to work with &tdevelop; without resorting to the mouse. </para></listitem> --> <varlistentry> <term><link linkend="app-files">Configuration Files Used by - &kdevelop;</link></term> -<listitem><para>Lists the files &kdevelop; uses to save its internal + &tdevelop;</link></term> +<listitem><para>Lists the files &tdevelop; uses to save its internal information. This is particularly useful in case something went wrong with your setup.</para> </listitem> @@ -189,12 +189,12 @@ necessary and why you need an &IDE;.</para> <varlistentry><term> <link linkend="plugin-tools">Plugin Tools</link> </term><listitem><para>Lists the pluggable tools you can use to taylor the capabilities of -&kdevelop; to your needs. +&tdevelop; to your needs. </para></listitem></varlistentry> <!-- <listitem><para> - <link linkend="plugin-tools">Plugin tools</link> — provides you with an overview of the parts which make up &kdevelop; and how you can tailor it to suit your needs by only loading the parts that are necessary, both IDE and project-wide. + <link linkend="plugin-tools">Plugin tools</link> — provides you with an overview of the parts which make up &tdevelop; and how you can tailor it to suit your needs by only loading the parts that are necessary, both IDE and project-wide. </para></listitem> --> <varlistentry><term> diff --git a/doc/kdevelop/unixdev.docbook b/doc/kdevelop/unixdev.docbook index d7881afb..8151f30b 100644 --- a/doc/kdevelop/unixdev.docbook +++ b/doc/kdevelop/unixdev.docbook @@ -241,7 +241,7 @@ Basically the <command>make</command> command will read the rules one after anot <para> There are several additional possibilities to control such a make process, and a <filename>Makefile</filename> can thus grow very complex. We cannot go into the details here. However, we recommend that you make yourself accustomed to the syntax of <command>make</command>. Even if you do not normally use it directly, an understanding of the fundamentals of the build system can be useful. See the <ulink url="info://make/Top"> <quote>GNU Make Manual</quote></ulink> for more information. </para> <para> -For more &kdevelop; specific detail see the <link linkend="project-management">Building and Project Management</link> chapter of this manual. +For more &tdevelop; specific detail see the <link linkend="project-management">Building and Project Management</link> chapter of this manual. </para> <para> There are several tutorials available, see the <link linkend="automake-references">references</link> in the Building and project management chapter. @@ -307,16 +307,16 @@ For example—would it not be convenient if a debugger were able to open the To more easily accomplish such a scheme, <emphasis>Integrated Development Environments</emphasis> (&IDE;s) were devised. Such an &IDE; integrates all templates, tools, and scripts which are commonly needed in the development process into one single environment. </para> <para> -For the &kde; platform &kdevelop; is such an &IDE;. It provides a wide range of tools which ease program development and maintenance, even for different programming languages and across platforms. +For the &kde; platform &tdevelop; is such an &IDE;. It provides a wide range of tools which ease program development and maintenance, even for different programming languages and across platforms. </para> -<sect2 id="unixdev-ide-kdevelop"> -<title>Basic Features of &kdevelop; &kdevrelease;</title> +<sect2 id="unixdev-ide-tdevelop"> +<title>Basic Features of &tdevelop; &kdevrelease;</title> -<indexterm zone="unixdev-ide-kdevelop"> - <primary>&kdevelop;</primary> +<indexterm zone="unixdev-ide-tdevelop"> + <primary>&tdevelop;</primary> <secondary>features</secondary></indexterm> -<indexterm zone="unixdev-ide-kdevelop"> +<indexterm zone="unixdev-ide-tdevelop"> <primary>features</primary></indexterm> <!-- ### copied from web page, needs to be updated --> @@ -378,7 +378,7 @@ For the &kde; platform &kdevelop; is such an &IDE;. It provides a wide range of </listitem> </itemizedlist> -</sect2> <!-- unixdev-ide-kdevelop --> +</sect2> <!-- unixdev-ide-tdevelop --> </sect1> <!-- unixdev-ide --> diff --git a/doc/platform/Mainpage.dox b/doc/platform/Mainpage.dox index dd69ba92..b5d008c6 100644 --- a/doc/platform/Mainpage.dox +++ b/doc/platform/Mainpage.dox @@ -22,18 +22,18 @@ This document is targeted at all those that want to build their own IDE or impro If you are instead looking for a user manual, just go to the help menu of your KDevelop and select KDevelop handbook. This documentation contains the KDevelop Platform online class reference for the current development version of KDevelop. Additionally, you -can subscribe or read the <a href="http://www.kdevelop.org/index.html?filename=mailinglist.html">mailing list</a> for any additions and/or +can subscribe or read the <a href="http://www.tdevelop.org/index.html?filename=mailinglist.html">mailing list</a> for any additions and/or modifications to the Platform %API. -An on-line, updated every 24H, html version of this documentation can be found at: http://www.kdevelop.org/HEAD/doc/platform/html/index.html +An on-line, updated every 24H, html version of this documentation can be found at: http://www.tdevelop.org/HEAD/doc/platform/html/index.html -You can also download a local browseable copy form http://www.kdevelop.org/HEAD/doc/platform/kdevplatformdoc.tar.bz2 . It gets updated every single day too. +You can also download a local browseable copy form http://www.tdevelop.org/HEAD/doc/platform/kdevplatformdoc.tar.bz2 . It gets updated every single day too. More information about the KDevelop Platform architecture in form of tutorials, Wikis, HOWTOs, and FAQs can be found at -the <a href="http://www.kdevelop.org">KDevelop website</a>. +the <a href="http://www.tdevelop.org">KDevelop website</a>. -Quick overviews of the architecture can also be found in the issues of <a href="http://www.kdevelop.org/doc/tehcnotes"> +Quick overviews of the architecture can also be found in the issues of <a href="http://www.tdevelop.org/doc/tehcnotes"> KDevelop Technotes</a>. \section platformapi Platform Libraries API @@ -122,7 +122,7 @@ KDevelop Technotes</a>. Here is a priority ordered list: -# fix the dispersed fixme - -# <a href="http://bugs.kde.org/buglist.cgi?product=kdevelop&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=bugs.bug_id">reported bugs in bugzilla database</a> + -# <a href="http://bugs.kde.org/buglist.cgi?product=tdevelop&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=bugs.bug_id">reported bugs in bugzilla database</a> -# fix the dispersed todo all over the code. . diff --git a/doc/std/kdev3api.toc b/doc/std/kdev3api.toc index 28d9cf3a..be3c7f0c 100644 --- a/doc/std/kdev3api.toc +++ b/doc/std/kdev3api.toc @@ -1,7 +1,7 @@ -<!DOCTYPE kdeveloptoc> -<kdeveloptoc> +<!DOCTYPE tdeveloptoc> +<tdeveloptoc> <title>KDevelop API Documentation</title> -<base href="http://www.kdevelop.org/HEAD/doc/api/html"/> +<base href="http://www.tdevelop.org/HEAD/doc/api/html"/> <tocsect1 name="Overview" url="index.html"> <tocsect2 name="KDevelop 3 Architecture" url="KDev3Arch.html"/> <tocsect2 name="Programming Languages Status" url="LangSupportStatus.html"/> @@ -42,4 +42,4 @@ <tocsect2 name="Known Bugs" url="bug.html"/> <tocsect2 name="F.A.Q." url="FAQ.html"/> </tocsect1> -</kdeveloptoc> +</tdeveloptoc> |