← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/kdevelop/file-browsers.docbook

  • Committer: Bazaar Package Importer
  • Author(s): Jeremy Lainé
  • Date: 2006-05-23 18:39:42 UTC
  • Revision ID: james.westby@ubuntu.com-20060523183942-hucifbvh68k2bwz7
Tags: upstream-3.3.2
Import upstream version 3.3.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/kdevelop/file-browsers.docbook
 
1
<chapter id="file-browsers">
 
2
<title>The File Browsers</title>
 
3
 
 
4
<para>
 
5
On the left side of the main window, &kdevelop; can display various kinds of
 
6
lists and trees for the selection of files:
 
7
</para>
 
8
 
 
9
<variablelist>
 
10
<varlistentry>
 
11
<term>File Tree</term>
 
12
<listitem>
 
13
<para>
 
14
This shows a tree view of the file hierarchy below the project directory. If
 
15
you click on a file, it is loaded into the editor. For files which do not
 
16
contain text, &kdevelop; starts an application that can handle the respective
 
17
MIME type.
 
18
</para>
 
19
 
 
20
<para>
 
21
The file tree is regularly updated whenever something changes in the file
 
22
system. For example, if you create new files or directories (even outside
 
23
&kdevelop;), this is immediately reflected in the file list. On &Linux;,
 
24
this feature makes use of the FAM library. On other operating systems or over
 
25
NFS, the directories shown are polled in small intervals.
 
26
</para>
 
27
 
 
28
<para>
 
29
The file tree hides files which are usually not interesting, like object
 
30
files. In the <guimenuitem>Project options</guimenuitem> under
 
31
<guibutton>File views</guibutton>, you can configure (as a comma separated
 
32
list of wildcards) which patterns are used to filter out irrelevant files.
 
33
</para>
 
34
 
 
35
<para>
 
36
Furthermore, you can decide to restrict the file tree to show only files which
 
37
belong to the currently loaded project. This can be toggled by clicking with
 
38
the right mouse button on the root item of the tree.
 
39
</para>
 
40
 
 
41
<figure id="screenshot-filetree" float="1">
 
42
<title>A Screenshot of the File Tree</title>
 
43
<mediaobject>
 
44
<imageobject><imagedata fileref="filetree.png"/></imageobject>
 
45
<textobject><phrase>A Screenshot of the File Tree</phrase></textobject>
 
46
</mediaobject>
 
47
</figure>
 
48
 
 
49
</listitem>
 
50
</varlistentry>
 
51
<varlistentry>
 
52
<term>File Groups</term>
 
53
<listitem>
 
54
<para>
 
55
This shows the files belonging to the project, grouped by their file name
 
56
extension. As in the file tree, you can edit a file by clicking on it
 
57
with the &LMB;.
 
58
</para>
 
59
 
 
60
<para>
 
61
The groups shown in this view can be configured under
 
62
<guibutton>File views</guibutton> in the
 
63
<guimenuitem>Project options</guimenuitem> dialog. In order to customize the
 
64
view to your needs, it is helpful to understand how files are distributed on
 
65
the groups. For each file, &kdevelop; goes through all groups from top to
 
66
bottom. In each group, it looks whether the file name matches one of the
 
67
patterns. If there is a match, the file is shown in this group and the
 
68
iteration is aborted. This makes it clear that more general patterns should
 
69
be put below more specific ones. For example, an asterisk for the
 
70
<guilabel>Other</guilabel> group should  be the last pattern.
 
71
</para>
 
72
 
 
73
</listitem>
 
74
</varlistentry>
 
75
</variablelist>
 
76
 
 
77
</chapter> <!-- file-browsers -->
 
78
 
 
79
<!-- ====================================================================== -->