~ubuntu-branches/ubuntu/utopic/pida/utopic

« back to all changes in this revision

Viewing changes to docs/2_users/4_projects.rst

  • Committer: Bazaar Package Importer
  • Author(s): Jan Luebbe
  • Date: 2007-04-17 16:08:06 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20070417160806-3ttlb6igf94x9i03
Tags: 0.4.4-1
* New upstream release (closes: #419129)
* Add dependency on python-glade2 (closes: #418716)
* Update copyright

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
 
 
2
Projects
 
3
--------
 
4
 
 
5
PIDA projects are the way in which PIDA organises a set of files. The default
 
6
project type maps to a single source directory, which is then used for quick
 
7
navigation and version control functions.
 
8
 
 
9
Adding a project to the workbench
 
10
+++++++++++++++++++++++++++++++++
 
11
 
 
12
Firstly, from the *Project* menu select *New Project*, and Enter the
 
13
information into the newly displayed form.
 
14
 
 
15
Name
 
16
  The name you would like to use for the project
 
17
 
 
18
Save In
 
19
  The directory you would like to save the project file in (or the default
 
20
  pida projects directory by default).
 
21
 
 
22
Type
 
23
  The type of project this project is
 
24
 
 
25
Once you have entered this information click *ok*.
 
26
 
 
27
You will be presented with the initial project configuration dialog for the
 
28
project.
 
29
 
 
30
Depending on the type of project, you will have different options. The most
 
31
common option is *Source Directory*. This is the directory that will be
 
32
navigated to when clicking on a project, and the directory that is used for
 
33
project functions, including version control. When you are happy with the
 
34
configuration, press the *save* button.
 
35
 
 
36
Your new project will have appeared on the project list, and is available to
 
37
browse and use.
 
38
 
 
39
.. note :: The project file may be stored in the project source directory if
 
40
  required. The initial value of the project source directory actually
 
41
  defaults to the location of the project source file. This allows you to add
 
42
  the project file to a version control system and monitor the changes.
 
43
 
 
44
Using a project
 
45
+++++++++++++++
 
46
 
 
47
First, Locate the project list. It is in the pane marked *plugins* and
 
48
has an icon signifying a project. This pane will be used to access projects.
 
49
 
 
50
Selecting a project from this project list will open a file manager in the
 
51
source directory of the project, whatever that is configured to be.
 
52
 
 
53
Right-clicking on a project gives the context menu. This context menu is
 
54
divided into three sections of contexts.
 
55
 
 
56
Directory 
 
57
    These are file system actions to be performed on the source directory.
 
58
 
 
59
Source Code
 
60
    These are version control commands to be performed in the context of the
 
61
    project.
 
62
 
 
63
Project
 
64
    These are actions to be performed on the actual project object, e.g.
 
65
    project configuration.
 
66
 
 
67
Configuring a project
 
68
+++++++++++++++++++++
 
69
 
 
70
Projects are configured using the project configuration dialog. To open the
 
71
project configuration dialog, either:
 
72
 
 
73
1.  Select *Properties* from the *Project* menu.
 
74
 
 
75
2.  Right click on a project, and in the context menu, select *Configure this
 
76
    project* from the *Project* submenu.
 
77
 
 
78
You should click the *Save* button when you have finished and are happy.
 
79
 
 
80
The *Undo* button allows you to revert changes to the configuration back to
 
81
the last saved state.
 
82
 
 
83
The *Cancel* button closes the dialog without saving any changes. Closing the
 
84
dialog manually will have the same effect as pressing *Cancel*.