diff options
Diffstat (limited to 'doc/kdevelop/applicationwizard.docbook')
| -rw-r--r-- | doc/kdevelop/applicationwizard.docbook | 38 |
1 files changed, 19 insertions, 19 deletions
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> |