PrF UG projects including a project - Revision history

RichMorin at 01:33, November 14, 2008

2008-11-14T01:33:10Z

RichMorin at 19:49, October 25, 2008

2008-10-25T19:49:35Z

RichMorin at 19:24, October 16, 2008

2008-10-16T19:24:13Z

RichMorin at 19:23, October 16, 2008

2008-10-16T19:23:28Z

RichMorin: Automated import of articles

2008-10-09T09:06:06Z

Automated import of articles

New page

__NOTOC__
== Including a Project ==

{{PrF_UG_TOC_projects}}<div id='prf_ug'>

You can include an existing project in your current {{#var:PrF}} project.
An included project stays as a separate project which you can open and edit separately;
edits made in the file for the included project will appear in the including project the next time it is loaded.
This allows you to build a single large project from one or more smaller projects.

With an included project:

<ul class='a'>
<li>
you can


<ul>
<li>
view and refer to the frames of the included project,
e.g.,
you can create a subclass of an included class or associate an included slot to a class


<li>
edit instances from the included project and create new instances for included classes


<li>
edit included forms


<li>
edit and override included slots

</ul>

<li>
you cannot


<ul>
<li>
make edits that would affect classes in the included project,
e.g.,
you cannot edit or delete an included class

</ul>
</ul>

Including a project

To include a project into an existing {{#var:PrF}} project:

<ol class='a'>
<li>
Select Manage Included Projects from the Project menu.
The current project,
and its included projects,
if any,
will be shown in a project hierarchy.


<li>
Click the Add Project
[[Image:PrF_UG_projects_project.add.gif|projects_project.add]]
button,
at the top right of the Manage Included Projects dialog box.


<li>
In the Select Project dialog box,
browse to the location of the project you want to include and select the .pprj file of the desired project.


<li>
Click Open.


<li>
The included project will be shown in the dialog box,
with "(not loaded)" after it to indicate that the actual inclusion process has not yet taken place.
If the included project already includes any other projects,
they will also be added to the hierarchy.

 <div>[[Image:PrF_UG_projects_included_add.png|projects_included_add]]</div>


<li>
To include additional projects,
repeat steps 2-6.


<li>
Click OK.
You will see a warning:

 <div>[[Image:PrF_UG_projects_included_reload_warn.png|projects_included_reload_warn]]</div>


<li>
Click OK.


<li>
If there are any classes that are duplicated in your project,
you will see a warning:

 <div>[[Image:PrF_UG_projects_include_duplicate_errors.png|projects_include_duplicate_errors]]</div>


<li>
Click Close to continue. {{#var:PrF}} will include your files at this time.

</ol>

The project is included into your current project.
Frames in the included project appear with pale icons to show they cannot be edited.
For example:
[[Image:PrF_UG_classes_class.pale.gif|classes_class.pale]],
[[Image:PrF_UG_classes_class.abstract.pale.gif|classes_class.abstract.pale]],
etc.

=== Included Projects and Duplicate Class Names ===

If an included project defines a class that is already defined in the including project (i.e.,
has the same name),
then one of the duplicate class definitions is ignored.
(Usually the included definition is used,
but there is no hard rule about this.)
A warning is given at load time
(Duplicate class definition was ignored")
and the project is loaded.
All references to the class work from both projects,
because the reference mechanism uses the class name.

This feature allows you to exchange the included project - for example,
with a different version.
Ignoring duplicate classes also allows for the situation where one project
(A)
is included in two separate projects (B and C),
which in turn are included in a final larger project (D):

<div>[[Image:PrF_UG_projects_inclusion_diagram.png|projects_inclusion_diagram]]</div>

</div>

@@ Line 2: / Line 2: @@
 == Including a Project ==
-{{PrF_UG_TOC_projects}}<div id='prf_ug'>
+<noinclude>{{PrF_UG_TOC_projects}}<div id='prf_ug'></noinclude>
 You can <i>include</i> an existing project in your current {{#var:PrF}} project.
@@ Line 142: / Line 142: @@
-</div>
+<noinclude></div></noinclude>

@@ Line 63: / Line 63: @@
    <li><p>
      Click the <b>Add Project</b>
-     [[Image:PrF_UG_projects_project.add.gif|projects_project.add]] button,
+     ([[Image:PrF_UG_projects_project.add.gif|projects_project.add]]) button,
      at the top right of the <b>Manage Included Projects</b> dialog box.
      </p>
@@ Line 84: / Line 84: @@
      they will also be added to the hierarchy.
      </p>
-     <div>[[Image:PrF_UG_projects_included_add.png|
+     <div>[[Image:PrF_UG_projects_included_add.png|frame|none|
-            projects_included_add]]</div>
+            Manage Included Projects dialog]]</div>
    <li><p>
@@ Line 95: / Line 95: @@
      You will see a warning:
      </p>
-     <div>[[Image:PrF_UG_projects_included_reload_warn.png|
+     <div>[[Image:PrF_UG_projects_included_reload_warn.png|frame|none|
-            projects_included_reload_warn]]</div>
+            save/reload warning dialog]]</div>
    <li><p>
@@ Line 106: / Line 106: @@
      you will see a warning:
      </p>
-     <div>[[Image:PrF_UG_projects_include_duplicate_errors.png|
+     <div>[[Image:PrF_UG_projects_include_duplicate_errors.png|frame|none|
-            projects_include_duplicate_errors]]</div>
+            duplicated class warning dialog]]</div>
    <li><p>
@@ Line 116: / Line 116: @@
 The project is included into your current project.
-Frames in the included project appear with pale icons to show they cannot be edited.
+Frames in the included project appear with pale icons
-For example: [[Image:PrF_UG_classes_class.pale.gif|classes_class.pale]],
+(e.g., [[Image:PrF_UG_classes_class.pale.gif|classes_class.pale]],
-[[Image:PrF_UG_classes_class.abstract.pale.gif|classes_class.abstract.pale]], etc.
+[[Image:PrF_UG_classes_class.abstract.pale.gif|classes_class.abstract.pale]])
 === Included Projects and Duplicate Class Names ===
@@ Line 137: / Line 138: @@
 which in turn are included in a final larger project (D):
-<div>[[Image:PrF_UG_projects_inclusion_diagram.png|
+<div>[[Image:PrF_UG_projects_inclusion_diagram.png|frame|none|
-       projects_inclusion_diagram]]</div>
+        multiple inclusion diagram]]</div>
 </div>

@@ Line 6: / Line 6: @@
 You can <i>include</i> an existing project in your current {{#var:PrF}} project.
 An included project stays as a separate project which you can open and edit separately;
-edits made in the file for the included project will appear in the including project the next time it is loaded.
+edits made in the file for the included project
 This allows you to build a single large project from one or more smaller projects.
@@ Line 19: / Line 20: @@
      <li><p>
        view and refer to the frames of the included project,
-       e.g.,
+       e.g., you can create a subclass of an included class
-      you can create a subclass of an included class or associate an included slot to a class
+      or associate an included slot to a class
        </p>
      <li><p>
-       edit instances from the included project and create new instances for included classes
+       edit instances from the included project
        </p>
@@ Line 43: / Line 45: @@
      <li><p>
        make edits that would affect classes in the included project,
-       e.g.,
+       e.g., you cannot edit or delete an included class
        </p>
    </ul>
@@ Line 56: / Line 57: @@
    <li><p>
      Select <b>Manage Included Projects</b> from the <b>Project</b> menu.
-     The current project,
+     The current project, and its included projects, if any,
      will be shown in a project hierarchy.
      </p>
@@ Line 64: / Line 63: @@
    <li><p>
      Click the <b>Add Project</b>
-     [[Image:PrF_UG_projects_project.add.gif|projects_project.add]]
+     [[Image:PrF_UG_projects_project.add.gif|projects_project.add]] button,
      at the top right of the <b>Manage Included Projects</b> dialog box.
      </p>
@@ Line 71: / Line 69: @@
    <li><p>
      In the <b>Select Project</b> dialog box,
-     browse to the location of the project you want to include and select the <b>.pprj</b> file of the desired project.
+     browse to the location of the project you want to include
      </p>
@@ Line 80: / Line 79: @@
    <li><p>
      The included project will be shown in the dialog box,
-     with "(not loaded)" after it to indicate that the actual inclusion process has not yet taken place.
+     with "(not loaded)" after it to indicate
      If the included project already includes any other projects,
      they will also be added to the hierarchy.
      </p>
-     </p><p> <div>[[Image:PrF_UG_projects_included_add.png|projects_included_add]]</div>
+    <div>[[Image:PrF_UG_projects_included_add.png|
      </p>
    <li><p>
-     To include additional projects,
+     To include additional projects, repeat steps 2-6.
      </p>
@@ Line 95: / Line 95: @@
      Click <b>OK</b>.
      You will see a warning:
      </p>
-     </p><p> <div>[[Image:PrF_UG_projects_included_reload_warn.png|projects_included_reload_warn]]</div>
+    <div>[[Image:PrF_UG_projects_included_reload_warn.png|
      </p>
@@ Line 106: / Line 107: @@
      If there are any classes that are duplicated in your project,
      you will see a warning:
      </p>
-     </p><p> <div>[[Image:PrF_UG_projects_include_duplicate_errors.png|projects_include_duplicate_errors]]</div>
+    <div>[[Image:PrF_UG_projects_include_duplicate_errors.png|
      </p>
    <li><p>
-     Click <b>Close</b> to continue. {{#var:PrF}} will include your files at this time.
+     Click <b>Close</b> to continue.
      </p>
 </ol>
@@ Line 117: / Line 120: @@
 The project is included into your current project.
 Frames in the included project appear with pale icons to show they cannot be edited.
-For example:
+For example: [[Image:PrF_UG_classes_class.pale.gif|classes_class.pale]],
-[[Image:PrF_UG_classes_class.pale.gif|classes_class.pale]],
+[[Image:PrF_UG_classes_class.abstract.pale.gif|classes_class.abstract.pale]], etc.
 === Included Projects and Duplicate Class Names ===
-If an included project defines a class that is already defined in the including project (i.e.,
+If an included project defines a class that is already defined in the including project
-has the same name),
+(i.e., has the same name),
 then one of the duplicate class definitions is ignored.
-(Usually the included definition is used,
+(Usually the included definition is used, but there is no hard rule about this.)
-but there is no hard rule about this.)
+A warning is given at load time (Duplicate class definition was ignored")
 and the project is loaded.
 All references to the class work from both projects,
 because the reference mechanism uses the class name.
-This feature allows you to exchange the included project - for example,
+This feature allows you to exchange the included project -
-with a different version.
+for example, with a different version.
-Ignoring duplicate classes also allows for the situation where one project
+Ignoring duplicate classes also allows for the situation where one project (A)
 is included in two separate projects (B and C),
 which in turn are included in a final larger project (D):
-<div>[[Image:PrF_UG_projects_inclusion_diagram.png|projects_inclusion_diagram]]</div>
+<div>[[Image:PrF_UG_projects_inclusion_diagram.png|
 </div>