← Back to branch summary

~ubuntu-branches/debian/sid/kdevelop/sid

« back to all changes in this revision

Viewing changes to doc/kdevelop/survey-manual.docbook

  • Committer: Bazaar Package Importer
  • Author(s): Jeremy Lainé
  • Date: 2010-05-05 07:21:55 UTC
  • mfrom: (1.2.3 upstream) (5.1.2 squeeze)
  • Revision ID: james.westby@ubuntu.com-20100505072155-h78lx19pu04sbhtn
Tags: 4:4.0.0-2
http://bugs.debian.org/579947
http://bugs.debian.org/481832
http://bugs.debian.org/562410
http://bugs.debian.org/546961
* Upload to unstable (Closes: #579947, #481832).
* Acknowledge obsolete NMU fixes (Closes: #562410, #546961).

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/kdevelop/survey-manual.docbook
1
 
<chapter id="survey-manual">
2
 
<title>What This Manual Contains</title>
3
 
 
4
 
<para>
5
 
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.
6
 
</para>
7
 
<para>
8
 
Here you will find information on the following topics:
9
 
</para>
10
 
<variablelist>
11
 
<varlistentry>
12
 
<term><link linkend="getting-started">Getting Started with &kdevelop; &mdash; a Guided Tour</link> </term>
13
 
<listitem>
14
 
<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>
15
 
</varlistentry>
16
 
 
17
 
<varlistentry>
18
 
<term><link linkend="kdevelop-survey">Overview of the Features of
19
 
 &kdevelop;</link></term>
20
 
<listitem>
21
 
<para>Extends the guided tour in the previous chapter, giving an overall
22
 
view of what is built-in within &kdevelop; and gets you acquainted with the
23
 
look and feel of this &IDE;.</para>
24
 
</listitem>
25
 
</varlistentry>
26
 
 
27
 
<varlistentry>
28
 
<term><link linkend="setup">Configuring &kdevelop;</link></term>
29
 
<listitem>
30
 
<para>Shows how you can tailor the &IDE; to suit your needs.</para>
31
 
</listitem>
32
 
</varlistentry>
33
 
 
34
 
<varlistentry>
35
 
<term><link linkend="applicationwizard">Getting started: the
36
 
&appwizard;</link></term>
37
 
<listitem>
38
 
<para>Describes the basics of how to set up a new project in &kdevelop;
39
 
using the built-in &appwizard;.</para>
40
 
</listitem>
41
 
</varlistentry>
42
 
 
43
 
<varlistentry>
44
 
<term><link linkend="editing">Editing tools</link></term>
45
 
<listitem>
46
 
<para>All you need to write your source files: using the editor, searching
47
 
for text both locally and project-wide, up to integrating new files and
48
 
classes into the project.</para>
49
 
</listitem>
50
 
</varlistentry>
51
 
 
52
 
<varlistentry>
53
 
<term><link linkend="file-browsers">The File Browsers</link></term>
54
 
<listitem>
55
 
<para>Demonstrates various tools to look at the structure of your project
56
 
and how to access the files you want to work with.</para>
57
 
</listitem>
58
 
</varlistentry>
59
 
 
60
 
<varlistentry>
61
 
<term><link linkend="class-browsers">The Class Browsers</link></term>
62
 
<listitem>
63
 
<para>Describes one of the most powerful tools of &kdevelop; which lets you
64
 
navigate through class dependencies and allows you to easily create and
65
 
access the classes and methods you need.
66
 
</para>
67
 
</listitem>
68
 
</varlistentry>
69
 
 
70
 
<varlistentry>
71
 
<term><link linkend="documentation">Documentation</link></term>
72
 
<listitem>
73
 
<para>Shows how to access the rich built-in documentation &kdevelop;
74
 
provides and tells you how to create documentation of your project, concise
75
 
and powerful &API; documentation providing you an overall view of all your
76
 
project sources as well as docbook-based user documentation.</para>
77
 
</listitem>
78
 
</varlistentry>
79
 
 
80
 
<varlistentry>
81
 
<term><link linkend="project-management">Building and Project
82
 
 Management</link></term>
83
 
<listitem>
84
 
<para>Deals with the creation and management of your project; describing the
85
 
basics of autoconf and automake as well as how to set up custom make files
86
 
and how to use compiler or make options to tailor your application to suit
87
 
your needs.</para>
88
 
</listitem>
89
 
</varlistentry>
90
 
 
91
 
<varlistentry>
92
 
<term><link linkend="adv-build-management">Advanced Build
93
 
 Management</link></term>
94
 
<listitem>
95
 
<para>Looks at ways to keep multiple build configurations, to cross-compile
96
 
for diverse platforms, or to make an embedded system using the
97
 
<application>Qt/embedded</application> library.</para>
98
 
</listitem>
99
 
</varlistentry>
100
 
 
101
 
<varlistentry>
102
 
<term><link linkend="debugger">The Debugger Interface</link></term>
103
 
<listitem>
104
 
<para>Describes how to use the integrated <application>gdb</application>
105
 
debugger interface so you can hunt down bugs without leaving
106
 
&kdevelop;.</para>
107
 
</listitem>
108
 
</varlistentry>
109
 
 
110
 
<!-- ### Currently disabled. Probably too specialized programming stuff. Check later again.
111
 
  <listitem><para>
112
 
  <link linkend="python">Python</link> &mdash; an overview of how to create Python-based applications in &kdevelop;.
113
 
  </para></listitem>
114
 
  <listitem><para>
115
 
  <link linkend="php">PHP</link> &mdash;  an overview of how to create PHP-based HTML applications in &kdevelop;.
116
 
  </para></listitem>//-->
117
 
 
118
 
<varlistentry>
119
 
<term><link linkend="cvs">Using CVS</link></term>
120
 
<listitem>
121
 
<para>Tells you how you can maintain your project using the CVS versioning
122
 
system; a must, especially if many developers work on the same
123
 
project.</para>
124
 
</listitem>
125
 
</varlistentry>
126
 
</variablelist>
127
 
 
128
 
<!--
129
 
  <listitem><para>
130
 
  <link linkend="kdevelop-scripting">Scripting &kdevelop;</link> &mdash; describes how to add scripts to automate &kdevelop;.
131
 
  </para></listitem>
132
 
 
133
 
 
134
 
  <listitem><para>
135
 
  Some commonly used information has been put into the <emphasis>appendix</emphasis>. Amongst others this consists of:
136
 
-->
137
 
<para>
138
 
Some commonly used information has been put into the <emphasis>appendix</emphasis>. Amongst others this consists of:
139
 
</para>
140
 
 
141
 
<variablelist>
142
 
<varlistentry>
143
 
<term><link linkend="kdevelop-install">Installing &kdevelop;</link></term>
144
 
<listitem>
145
 
<para>Tells you where to obtain &kdevelop; and how to get it up and
146
 
running.</para>
147
 
</listitem>
148
 
</varlistentry>
149
 
</variablelist>
150
 
 
151
 
<variablelist>
152
 
<varlistentry>
153
 
<term><link linkend="nutshell">In a Nutshell &mdash; Tips and
154
 
Tricks</link></term>
155
 
<listitem>
156
 
<para>A quick reference to commonly used commands and actions. And a short
157
 
guide to solve common problems when working with
158
 
&kdevelop;.</para>
159
 
</listitem>
160
 
</varlistentry>
161
 
 
162
 
<varlistentry>
163
 
<term><link linkend="unixdev">Development on &UNIX;</link></term>
164
 
<listitem>
165
 
<para>A historical overview of &UNIX; program development, the main tools
166
 
necessary and why you need an &IDE;.</para>
167
 
</listitem>
168
 
</varlistentry>
169
 
 
170
 
<!--    
171
 
    <listitem><para>
172
 
    <link linkend="app-menus">Menus and Toolbars Overview</link> &mdash; provides you with a short overall view of the menu and toolbar selections available.
173
 
    </para></listitem>
174
 
 
175
 
    <listitem><para>
176
 
      <link linkend="app-shortcuts">Shortcut Keys</link> &mdash; the keys you can use to work with &kdevelop; without resorting to the mouse.
177
 
    </para></listitem>
178
 
-->
179
 
 
180
 
<varlistentry>
181
 
<term><link linkend="app-files">Configuration Files Used by
182
 
 &kdevelop;</link></term>
183
 
<listitem><para>Lists the files &kdevelop; uses to save its internal
184
 
 information. This is particularly useful in case something went wrong with
185
 
 your setup.</para>
186
 
</listitem>
187
 
</varlistentry>
188
 
 
189
 
<varlistentry><term>
190
 
<link linkend="plugin-tools">Plugin Tools</link>
191
 
</term><listitem><para>Lists the pluggable tools you can use to taylor the capabilities of
192
 
&kdevelop; to your needs.
193
 
</para></listitem></varlistentry>
194
 
 
195
 
<!--  
196
 
  <listitem><para>
197
 
  <link linkend="plugin-tools">Plugin tools</link> &mdash; 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.
198
 
  </para></listitem>
199
 
-->
200
 
<varlistentry><term>    
201
 
<link linkend="app-uimodes-examples">KDevelop User Interface Mode Examples </link>
202
 
</term><listitem><para>Shows user interface modes.
203
 
</para></listitem></varlistentry>
204
 
  
205
 
<varlistentry><term>
206
 
<link linkend="app-misc-info">Further Information </link> </term><listitem><para>
207
 
Getting Information, reporting Bugs etc.
208
 
</para></listitem></varlistentry>
209
 
  
210
 
<varlistentry><term>
211
 
<link linkend="app-changelog">Changelog </link>
212
 
</term><listitem><para>Shows the history of this documentation.
213
 
</para></listitem></varlistentry>
214
 
  
215
 
<varlistentry><term>
216
 
<link linkend="app-bibliography">Bibliography </link> 
217
 
</term><listitem><para>Bibliography 
218
 
</para></listitem></varlistentry>
219
 
 
220
 
</variablelist>  
221
 
    <!--
222
 
    <listitem><para>
223
 
    <link linkend="documentation-index">Index </link> &mdash; 
224
 
    </para></listitem>
225
 
-->  
226
 
 
227
 
  
228
 
</chapter>