Author: tfmorris
Date: 2007-12-18 00:28:37-0800
New Revision: 13940
Modified:
trunk/documentation/cookbook/building.xml
trunk/documentation/cookbook/cookbook_modules.xml
trunk/documentation/cookbook/documentationstandards.xml
trunk/documentation/cookbook/extending.xml
trunk/documentation/cookbook/glossary.xml
trunk/documentation/cookbook/inside_subsystems.xml
trunk/documentation/cookbook/introduction.xml
trunk/documentation/cookbook/process.xml
trunk/documentation/cookbook/repository.xml
trunk/documentation/cookbook/require.xml
trunk/documentation/cookbook/standard.xml
trunk/documentation/cookbook/subsystemcritics.xml
trunk/documentation/cookbook/subsystemdiagrams.xml
trunk/documentation/cookbook/subsysteminternationalization.xml
trunk/documentation/cookbook/subsystemlogging.xml
trunk/documentation/cookbook/subsystemnotation.xml
trunk/documentation/cookbook/subsystempropertypanels.xml
trunk/documentation/cookbook/subsystems.xml
Log:
Issue 4943: edits for grammatical errors in cookbook - contributed by Dave Thompson
Modified: trunk/documentation/cookbook/building.xml
Url: http://argouml.tigris.org/source/browse/argouml/trunk/documentation/cookbook/building.xml?view=diff&rev=13940&p1=trunk/documentation/cookbook/building.xml&p2=trunk/documentation/cookbook/building.xml&r1=13939&r2=13940
==============================================================================
--- trunk/documentation/cookbook/building.xml (original)
+++ trunk/documentation/cookbook/building.xml 2007-12-18 00:28:37-0800
@@ -81,7 +81,7 @@
In order to develop the ArgoUML source it is absolutely mandatory that
you work with ArgoUML from the source repository.
How you checkout this is described in
-<xref endterm="checkout_term" linkend="checkout"></xref>.
+<xref linkend="checkout"></xref>.
</para>
<para>
Notice that the source repository contains not only a set of source
@@ -262,7 +262,7 @@
The properties described here are project conventions and should be
applied to the files in the repository.
This is normally only needed when creating new files because
-the existing files should have their properties set correctly..
+the existing files should have their properties set correctly.
</para>
<para>
Alas, Subversion and the Tigris set-up does not allow us in the project
@@ -511,7 +511,8 @@
The easiest thing to do now, is
just check out the whole
<parameter>argouml</parameter> project.
-For this use the Subversion URL http://argouml.tigris.org/svn/argouml/trunk.
+For this use the Subversion URL
+<filename>http://argouml.tigris.org/svn/argouml/trunk</filename>.
</para>
<para>
If you want to limit the download size,
@@ -1091,7 +1092,7 @@
<para>generate - optional</para>
<para>
This is a step that, if it exists, can be run before compile.
-The result of this is some files that is a prerequisite for compile
+The result of this is some files that are prerequisites for compile
so the compile target runs this automatically.
</para>
</listitem>
@@ -1191,8 +1192,8 @@
</indexterm>
<para>
You need to have a developer role in the ArgoUML project
-or in the subproject you are working with..
-If you don't then you cannot do commits yourself.
+or in the subproject you are working with.
+If you don't, then you cannot do commits yourself.
Discuss what you have done and how best to test it on the
ArgoUML project developers mailing list or the developers' mailing list
for your subproject.
@@ -1229,10 +1230,10 @@
code changes before even starting ArgoUML.
</para>
<para>
-The JUnit test cases are residing in a separate directory and
-run from ant targets in the
+The JUnit test cases reside in a separate directory and
+run from ant targets in
<filename>src_new/build.xml</filename>.
-They are never distributed with ArgoUML but merely a tool for
+They are never distributed with ArgoUML; they are merely a tool for
developers.
</para>
@@ -1357,7 +1358,7 @@
<classname>org.argouml.<replaceable>x.y</replaceable>.<replaceable>z</replaceable></classname>
stored in the file
<filename class="directory">src_new/org/argouml/<replaceable>x/y</replaceable>/<replaceable>z</replaceable>.java</filename>
-have its JUnit test case class called
+has its JUnit test case class called
<classname>org.argouml.<replaceable>x.y</replaceable>.Test<replaceable>z</replaceable></classname>
stored in the file
<filename class="directory">tests/org/argouml/<replaceable>x/y</replaceable>/Test<replaceable>z</replaceable>.java</filename>
@@ -1370,8 +1371,8 @@
<filename class="directory">tests/org/argouml/<replaceable>x/y</replaceable>/GUITest<replaceable>z</replaceable>.java</filename>
</para>
<para>
-If, for convenience reason, you would like to split the tests of a single
-class in several test classes, just name them with some extra suffix.
+If, for convenience reasons, you would like to split the tests of a single
+class into several test classes, just name them with some extra suffix.
Either 1, 2, 3, or something describing what part that test case tests.
</para>
<para>
@@ -1425,7 +1426,7 @@
</para>
<para>
A lot of times it is useful just to run the compiler to verify that
-the signatures are correct on the interfaces. Therefor Linus has
+the signatures are correct on the interfaces. Therefore Linus has
thought it is a good idea to add methods called
<methodname>compileTestStatics</methodname>,
<methodname>compileTestConstructors</methodname>, and
@@ -1520,7 +1521,7 @@
<para>
Test cases are better if they are simpler.
Strive to involve as little part of the ArgoUML code as possible.
-Ideally you are just testing a single class at the time.
+Ideally you are just testing a single class at a time.
</para>
<para>
The involvement of the Model subsystem is in most cases inevitable
@@ -1768,9 +1769,9 @@
</itemizedlist>
<para>
The file
-<filename><replaceable>manual</replaceable>/<replaceable>argomanual-generated.xml</replaceable></filename>
-is a temporary file that only exists while processing the XML.
-If you are editing the XML be sure to edit
+<filename><replaceable>manual</replaceable>/<replaceable>argomanual-generated.xml</replaceable></filename> is
+a temporary file that only exists while processing the XML.
+If you are editing the XML be sure to edit
the file
<filename><replaceable>manual</replaceable>/<replaceable>argomanual.xml</replaceable></filename>
and not the temporary file.
@@ -1797,7 +1798,7 @@
<para>
If you are running Eclipse 3.1 or 3.2
-we have a prepared and recommended setup
+we have a prepared a recommended setup
committed into our repository.
This setup is slightly different than the ant setup
with regard to the directory tree structure of the checked out copy
@@ -2291,8 +2292,8 @@
</itemizedlist>
<para>
Leave the rest of the fields at their default (empty). The File Filters
-are defined on an additional preferences tab rather than in separate
-file as in earlier versions of Checkclipse. If this isn't populate with
+are defined on an additional preferences tab rather than in a separate
+file as in earlier versions of Checkclipse. If this isn't populated with
the saved values from SVN you can add individual files to the exclude
list as you encounter them, but generally any machine generated source
file (JavaLexer, JavaRecognizer, etc) should be excluded from the checks.
@@ -2306,7 +2307,7 @@
The argouml-core-tests Eclipse project has its compile time dependencies
set up to include the things needed to compile the test cases.
This means that it is possible to compile the test cases and
-nobody will create tests that uses the insides of some subsystem that
+nobody will create tests that use the insides of some subsystem that
is supposed to be hidden.
</para>
<para>
@@ -2410,8 +2411,8 @@
</para>
<para>
-Another cause might be that the tests relies on certain other files being
-in specified places and that the Eclipse set up doesn't provide that.
+Another cause might be that the tests rely on certain other files being
+in specified places that the Eclipse set up doesn't provide.
</para>
</listitem>
@@ -2619,9 +2620,9 @@
</indexterm>
<para>
The purpose of this chapter is
-to simplify for the person that is actually doing the release work and
-to make sure that everything is done in the exact same way
-every time and nothing is forgotten.
+to simplify the procedure for the person actually doing the release work, and
+to make sure that everything is done in the exact same way
+every time without anything being forgotten.
</para>
<para>
The scripts involved have been developed and are mostly run
@@ -2922,7 +2923,7 @@
For Java Web Start,
update the "Latest development" or perhaps the
"Latest stable" files
-essentially with the contents of the newly create JNLP file.
+essentially with the contents of the newly created JNLP file.
</para>
<para>
@@ -2990,13 +2991,13 @@
<para>Make the release tag into a branch</para>
</listitem>
<listitem>
- <para>Checked out that branch</para>
+ <para>Check out that branch</para>
</listitem>
<listitem>
<para>Fix the problem in your checked out copy</para>
</listitem>
<listitem>
- <para>Commit the problem in the branch</para>
+ <para>Commit the problem to the branch</para>
</listitem>
<listitem>
<para>Continue the build process</para>
Modified: trunk/documentation/cookbook/cookbook_modules.xml
Url: http://argouml.tigris.org/source/browse/argouml/trunk/documentation/cookbook/cookbook_modules.xml?view=diff&rev=13940&p1=trunk/documentation/cookbook/cookbook_modules.xml&p2=trunk/documentation/cookbook/cookbook_modules.xml&r1=13939&r2=13940
==============================================================================
--- trunk/documentation/cookbook/cookbook_modules.xml (original)
+++ trunk/documentation/cookbook/cookbook_modules.xml 2007-12-18 00:28:37-0800
@@ -167,7 +167,7 @@
but the example used for testing loaded the ProjectBrowser "too early"
<!-- See issue ??? -->
and the result wasn't so good.
-I (Linus) hopes this can be eventually fixed.)
+I (Linus) hope this can be eventually fixed.)
</para>
</sect3>
Modified: trunk/documentation/cookbook/documentationstandards.xml
Url: http://argouml.tigris.org/source/browse/argouml/trunk/documentation/cookbook/documentationstandards.xml?view=diff&rev=13940&p1=trunk/documentation/cookbook/documentationstandards.xml&p2=trunk/documentation/cookbook/documentationstandards.xml&r1=13939&r2=13940
==============================================================================
--- trunk/documentation/cookbook/documentationstandards.xml (original)
+++ trunk/documentation/cookbook/documentationstandards.xml 2007-12-18 00:28:37-0800
@@ -88,8 +88,8 @@
<listitem>
<para>
-Break up your writing in short sections.
-Each section dealing with one topic.
+Break up your writing into short sections,
+each section dealing with a single topic.
</para>
</listitem>
@@ -297,7 +297,7 @@
<literal>ref.</literal> is allowed
to distinguish tutorial and reference
material. The remainder of the tag should be descriptive, but concise
- with words separate by underscore. Where a graphic is involved this
+ with words separated by underscores. Where a graphic is involved this
remainder should correspond to the file name. For example
<literal>fig.ref.navigation_pane</literal> for a figure showing the
explorer, with the diagram in
@@ -434,7 +434,7 @@
<sect1>
<title>For Eclipse Users</title>
- <para>If you use the Eclipse, then the XML editor that comes
+ <para>If you use Eclipse, then the XML editor that comes
with the Eclipse <emphasis>Tools Platform (WTP)</emphasis>
project allows comfortable editing.
</para>
@@ -442,7 +442,7 @@
<para>Regretfully, the docbook-validation of this editor
(as any other suitable editor that has been evaluated)
currently does not support the way the cookbook
- and quickguide are divided in
+ and quickguide are divided into
seperate XML files.
The manual
consists of one single XML file,
@@ -635,7 +635,7 @@
around an &ooad; process
(any preferences), and that each UML concept is introduced with each step
of the process, followed by an explanation of how to do it under
-&argouml;. A <emphasis>simple</emphasis>case study will be needed
+&argouml;. A <emphasis>simple</emphasis> case study will be needed
throughout.
</para>
@@ -713,7 +713,7 @@
<para>What &argouml; has that other tools are missing
(critics,
to-do list,
-based in cognitive psychology theory).
+based on cognitive psychology theory).
</para>
</listitem>
Modified: trunk/documentation/cookbook/extending.xml
Url: http://argouml.tigris.org/source/browse/argouml/trunk/documentation/cookbook/extending.xml?view=diff&rev=13940&p1=trunk/documentation/cookbook/extending.xml&p2=trunk/documentation/cookbook/extending.xml&r1=13939&r2=13940
==============================================================================
--- trunk/documentation/cookbook/extending.xml (original)
+++ trunk/documentation/cookbook/extending.xml 2007-12-18 00:28:37-0800
@@ -61,7 +61,7 @@
&cookbookmodules;
<sect1>
- <title>How are modules organized in the Java code</title>
+ <title>How are modules organized in the Java code?</title>
<para>
The previous section describes how modules and plug-ins are
organized at the Java level independent of how they are actually
Modified: trunk/documentation/cookbook/glossary.xml
Url: http://argouml.tigris.org/source/browse/argouml/trunk/documentation/cookbook/glossary.xml?view=diff&rev=13940&p1=trunk/documentation/cookbook/glossary.xml&p2=trunk/documentation/cookbook/glossary.xml&r1=13939&r2=13940
==============================================================================
--- trunk/documentation/cookbook/glossary.xml (original)
+++ trunk/documentation/cookbook/glossary.xml 2007-12-18 00:28:37-0800
@@ -217,9 +217,9 @@
<para>
Usually used as "Remove from Diagram". The object that will be removed is
not deleted from the model, i.e. it still exists, but is simply not present
-anymore on the current diagram. It might still be present on other diagrams,
+any more on the current diagram. It might still be present on other diagrams,
or not, but it is surely present in the explorer.
-Additionally, all objects that can not be drawn without the removed object,
+Additionally, all objects that cannot be drawn without the removed object,
are removed from the diagram, too. E.g. removing a class also removes all
its associations.
Once removed, an object can be "added" to a diagram (again).
@@ -232,7 +232,7 @@
<glossdef>
<para>
Save the existing project to a file.
-The Save operation save everything (it is a no-loss operation).
+The Save operation saves everything (it is a no-loss operation).
A Save, Open cycle does not loose any information.
(Don't use Export, or Write for this).
</para>
Modified: trunk/documentation/cookbook/inside_subsystems.xml
Url: http://argouml.tigris.org/source/browse/argouml/trunk/documentation/cookbook/inside_subsystems.xml?view=diff&rev=13940&p1=trunk/documentation/cookbook/inside_subsystems.xml&p2=trunk/documentation/cookbook/inside_subsystems.xml&r1=13939&r2=13940
==============================================================================
--- trunk/documentation/cookbook/inside_subsystems.xml (original)
+++ trunk/documentation/cookbook/inside_subsystems.xml 2007-12-18 00:28:37-0800
@@ -184,8 +184,8 @@
<classname>org.argouml.language</classname>.
In the case of languages
other than Java, these classes will come from independent projects and
- be package separately even though they share this package name space.
- <warning>NOTE: There is a potential conflict here if two separately
+ be packaged separately even though they share this package name space.
+ <warning>NOTE: There is a potential conflict here if two separate
language implementations use this name space in an uncoordinated fashion
(e.g. two Ruby implementations using org.argouml.language.ruby).
</warning>
@@ -363,7 +363,7 @@
</para>
<para>
- The components that wants to be placed into any of these
+ The components that want to be placed into any of these
register with the GUI subsystem using the appropriate method in
<classname>org.argouml.ui.GUI</classname>.
</para>
@@ -428,7 +428,7 @@
</para>
<para>Via an event mechanism this manager makes sure
that all objects interested
- in knowing whether the selection changed are acknowledged.
+ in knowing whether the selection changed are notified.
</para>
<para>The TargetManager does not depend on the
<classname>org.argouml.ui</classname> package,
@@ -525,8 +525,7 @@
<para> The Help System is not yet implemented. </para>
<para> The Help System will be located in
<classname>org.argouml.help</classname>. </para>
- <para> The Help System is a Model subsystem. See <xref
- linkend="model_subsystems"></xref>.
+ <para> The Help System is a ??Infrastructure?? subsystem.
<!--
TODO: It however violates the layer concept by providing menu items that fit
into the GUI Framework.
@@ -596,8 +595,7 @@
</para>
<warning>This is a set of classes in the Cognitive subsystem, not a
subsystem of its own.</warning>
- <para> The To do items is a Model subsystem. See <xref
- linkend="model_subsystems"></xref>. </para>
+
</sect1>
<sect1 id="explorer">
@@ -911,7 +909,7 @@
contains finitely many elements and I assume that no-one will add
go rules that add branches of infinite length that does not
infinitely often contain elements from the model), but I don't
- think anyone has don't it. Obviously finding all occurrences
+ think anyone has done it. Obviously finding all occurrences
cannot be done. </para>
</listitem>
</itemizedlist> </para>
@@ -983,7 +981,7 @@
<itemizedlist>
<listitem>
<para> We use the same APIs for the modules that we use within
- ArgoUML meaning that we implement at document it only once.
+ ArgoUML meaning that we implement and document it only once.
This replaces the Pluggable class at every point where
ArgoUML can be augmented. </para>
</listitem>
@@ -1024,11 +1022,11 @@
<para> The solution suggested is that the module loader persists in
its attempts to enable a module so that the order among the modules
is not important. For this to work the modules needs to signal when
- they fail. This is done by returning false or throwing a Exception
+ they fail. This is done by returning false or throwing an Exception
from the module enabling method. </para>
<para> The module loader also provides an API that the well-behaving
modules can use to test if the modules they depend on are enabled.
- The less well-behaving module can just throw an exception when
+ The less well-behaving modules can just throw an exception when
they fail to enable themselves properly. </para>
<para> If a module cannot be disabled, because some other module
depends on it then this is signaled by returning false from the
Modified: trunk/documentation/cookbook/introduction.xml
Url: http://argouml.tigris.org/source/browse/argouml/trunk/documentation/cookbook/introduction.xml?view=diff&rev=13940&p1=trunk/documentation/cookbook/introduction.xml&p2=trunk/documentation/cookbook/introduction.xml&r1=13939&r2=13940
==============================================================================
--- trunk/documentation/cookbook/introduction.xml (original)
+++ trunk/documentation/cookbook/introduction.xml 2007-12-18 00:28:37-0800
@@ -190,7 +190,7 @@
</para>
<para>
-From this on you can comment on bugs yourself directly in Issuezilla.
+From this point on you can comment on bugs yourself directly in Issuezilla.
</para>
<para> You can also verify issues according to the verification
@@ -293,7 +293,7 @@
</para>
<para>
This role is granted by the Project leader after he is convinced
-that you have learned the enough about the project w.r.t.:
+that you have learned enough about the project with regard to:
</para>
<itemizedlist>
<listitem>
@@ -341,10 +341,10 @@
<sect1>
<title>About this Cookbook</title>
<para> This document, the Cookbook for Developers of ArgoUML, is provided
- with the hopes of being helpful for the developers of ArgoUML when it comes to
- learning and understanding how ArgoUML work in order to improve on its
+ with the hope of being helpful for the developers of ArgoUML when it comes to
+ learning and understanding how ArgoUML works in order to improve on its
functions and features.
- It can also be of interest for persons that wish to analyze the ArgoUML
+ It may also be of interest for persons that wish to analyze the ArgoUML
project for whatever purpose that may be. </para>
<sect2>
<title>In this Cookbook, you will find...</title>
Modified: trunk/documentation/cookbook/process.xml
Url: http://argouml.tigris.org/source/browse/argouml/trunk/documentation/cookbook/process.xml?view=diff&rev=13940&p1=trunk/documentation/cookbook/process.xml&p2=trunk/documentation/cookbook/process.xml&r1=13939&r2=13940
==============================================================================
--- trunk/documentation/cookbook/process.xml (original)
+++ trunk/documentation/cookbook/process.xml 2007-12-18 00:28:37-0800
@@ -453,7 +453,7 @@
</listitem>
<listitem>
<para>
-Set the issue in the end on "RESOLVED".
+Set the issue in the end to "RESOLVED".
</para>
<para>
When the resolver is finished with the issue,
@@ -477,7 +477,7 @@
The task of the Verifier is to check the quality of the solution by
confirming that the solution is complete, to the point, bug-free, etc.
This is an important part of the quality assurance work we do
-in the ArgoUML project and the object is to make sure that a resolved
+in the ArgoUML project and the objective is to make sure that a resolved
issue is in fact resolved.
</para>
<para>
@@ -552,7 +552,7 @@
<para>
Pick any Issue that is NEW or REOPENED
that you from the description think that you are able to solve.
-Best result if you also find some Issue that you really feel
+Best results are often obtained if you find an Issue that you really feel
needs to be solved.
<ulink url="http://argouml.tigris.org/issues/buglist.cgi?component=argouml&issue_status=NEW&issue_status=REOPENED">The list of all of them</ulink>.
</para>
@@ -651,7 +651,7 @@
</listitem>
<listitem>
<para>
-Sit back and feel the personal satisfaction of having completed a
+Sit back and feel the personal satisfaction of having completed
something that will be part of the ArgoUML product.
</para>
</listitem>
@@ -720,8 +720,8 @@
<itemizedlist>
<listitem>
<para>
-If the problem is gone, the feature is present put the Issue in
-Status VERIFIED and
+If the problem is gone or the feature is present, set the Issue
+Status to VERIFIED and
add the version of the ArgoUML used for the test in in the comment.
</para>
<para> Remark: As an additional activity, the
@@ -734,7 +734,7 @@
If the problem is still there, the feature does not work, put the
Issue in Status REOPENED with a description of what is still there, is
still missing.
-Also state what version of ArgoUML used for the test in the comment.
+Also state what version of ArgoUML was used for the test in the comment.
</para>
</listitem>
</itemizedlist>
@@ -852,7 +852,7 @@
by the QA responsible for that area,
or by anyone for issues that are verified.
You need to be a member of the project (any role).
-This can also be done by someone who would raise the issue but
+This can also be done by someone who would have raised the issue but
did not because it was already present in Issuezilla.
</para>
<orderedlist>
@@ -909,7 +909,7 @@
</indexterm>
<para>
ArgoUML uses products internally and is very
-dependent on that these products are functioning well.
+dependent on these products functioning well.
This are products like GEF, MDR, OCL, log4j, ...
</para>
<para>
@@ -918,7 +918,7 @@
within ArgoUML.
</para>
<para>
-If this happens this is the way to handle this problem.
+If this happens, this is the way to handle this problem.
</para>
<para>
This can be performed by any member of the project (any role).
@@ -1023,7 +1023,7 @@
For dependencies that are not delivered with ArgoUML
(JRE, Xerces, OS, drivers, HW, ...),
the same process is taken except that
-the issue solved when it is entered in the ArgoUML FAQ or documentation
+the issue is solved when it is entered into the ArgoUML FAQ or documentation
or in some cases as tests in the code testing that we are not using that
version.
At that point is resolved (as RESOLVED/FIXED).
@@ -1036,7 +1036,7 @@
</sect1>
<sect1 id="proc-create-stable-releases">
- <title>How to Create Stable Release</title>
+ <title>How to Create a Stable Release</title>
<para>
We have two kinds of releases of ArgoUML:
@@ -1069,9 +1069,9 @@
</para>
<para>
-To increase the quality of a stable release, it is preceded by
-period during which a sequence of releases with increased quality
-standards.
+To increase the quality of a stable release, a stable release is preceded
+by a period during which there are a sequence of releases with increased
+quality standards.
</para>
<para>
Modified: trunk/documentation/cookbook/repository.xml
Url: http://argouml.tigris.org/source/browse/argouml/trunk/documentation/cookbook/repository.xml?view=diff&rev=13940&p1=trunk/documentation/cookbook/repository.xml&p2=trunk/documentation/cookbook/repository.xml&r1=13939&r2=13940
==============================================================================
--- trunk/documentation/cookbook/repository.xml (original)
+++ trunk/documentation/cookbook/repository.xml 2007-12-18 00:28:37-0800
@@ -114,7 +114,7 @@
Take care also to make the versions of these libraries explicit,
so as to allow people building from sources to figure out
exact dependencies. Easiest way is to rename the files to
-include version informations, the same way as shared
+include version information, the same way as shared
libraries in Unix world: foo-x.y.z.jar, bar-x.y.z.jar,
etc...
</para>
Modified: trunk/documentation/cookbook/require.xml
Url: http://argouml.tigris.org/source/browse/argouml/trunk/documentation/cookbook/require.xml?view=diff&rev=13940&p1=trunk/documentation/cookbook/require.xml&p2=trunk/documentation/cookbook/require.xml&r1=13939&r2=13940
==============================================================================
--- trunk/documentation/cookbook/require.xml (original)
+++ trunk/documentation/cookbook/require.xml 2007-12-18 00:28:37-0800
@@ -55,9 +55,9 @@
a number (REQ1, REQ2, REQ3, ...) that never changes,
a revision (REVa, REVb, REVc, ...) that changes when the requirement change,
a text that is the requirement text to implement,
-a rationale that is the description on why this is important,
-a stakeholder that is one of the stakeholders in the vision for who
-this is important.
+a rationale that is the description of why the requirement is important,
+and a stakeholder, i.e. a person or group that the requirement is
+important to.
</para>
<sect1>
@@ -88,7 +88,7 @@
<sect2 id="REQ2">
<title>
-All views of a model element shall be update
+All views of a model element shall be updated
as soon as the model element is updated.
</title>
<para>
@@ -182,14 +182,14 @@
</para>
<para>
<emphasis>Rationale:</emphasis>
-Writing a correct syntax of anything is complicated.
+Writing anything in the correct syntax is complicated.
Good compilers are helpful in pinpointing where the problem is
(what line and what token is in error).
The text fields in ArgoUML are
not developed in the same way as source code and
we have no compiler step to verify it all.
Instead this validation needs to be done while editing meaning that
-the user needs all the help he can get to as quickly as possible,
+the user needs all the help he can get, as quickly as possible, to
get the syntax right.
TODO: Is this the correct motivation for this?
</para>
@@ -212,7 +212,7 @@
<emphasis>Rationale:</emphasis>
An exception in the log or on the screen is always the sign of a serious
error in the application that should be reported as a DEFECT.
-If a mistyping generates such a problem the user might loose interest in
+If a mistyping generates such a problem the user might lose interest in
ArgoUML as a tool because he percieves it as not working correctly.
</para>
<para>
@@ -241,7 +241,7 @@
<listitem>
<para>
Pressing F1 or choosing help from the menu shall display a popup
-window explaining for data and format required by the current input
+window explaining the data and format required by the current input
field.
Input focus shall be left on the field during any user
interaction with the popup (dragging, scrolling or closing).
Modified: trunk/documentation/cookbook/standard.xml
Url: http://argouml.tigris.org/source/browse/argouml/trunk/documentation/cookbook/standard.xml?view=diff&rev=13940&p1=trunk/documentation/cookbook/standard.xml&p2=trunk/documentation/cookbook/standard.xml&r1=13939&r2=13940
==============================================================================
--- trunk/documentation/cookbook/standard.xml (original)
+++ trunk/documentation/cookbook/standard.xml 2007-12-18 00:28:37-0800
@@ -127,7 +127,7 @@
<para>
This is partly checked by Checkstyle.
Checkstyle does currently only warn if a Javadoc comment is omitted for
-a public, protected or default visibility variables.
+public, protected or default visibility variables.
</para>
</listitem>
<listitem>
@@ -153,7 +153,7 @@
</para>
<para>
This is exactly as it is stated in the Sun Code Conventions.
-It is here just for the emphasis.
+It is here just for emphasis.
</para>
<para>
This is checked by Checkstyle.
@@ -271,9 +271,9 @@
<para>
Comment:
<!-- What does this mean? It makes no sense to me. - tfm -->
-There is an ongoing work (probably perpetually) to change
+There is an ongoing task (probably perpetually) to change
the calls to deprecated methods and classes that
-has been deprecated after used in ArgoUML.
+have been deprecated after use in ArgoUML.
This is a normal part of improving ArgoUML.
If this work is too slow it makes it impossible to upgrade to new
versions of different sub-tools.
@@ -294,7 +294,7 @@
</para>
<para>
Historically in the ArgoUML design,
-a deep package structure has been used.
+a deep package structure was used.
There are several places in the code where the package structure is
mimicking the UML hierarchy of objects resulting in impossibly long
package names like
@@ -351,7 +351,7 @@
<filename class="directory">argouml/src_new</filename>.
</para>
<para>
-The last couple of Checkstyle result are also available in
+The last couple of Checkstyle results are also available in
the Xenofarm result.
</para>
<para>
@@ -392,13 +392,13 @@
This means that once you commit your stuff it has the potential
of getting in the way of everybody else's work in the project.
For this reason special considerations are needed.
-This chapter describes the how you should do to limit the risk
+This chapter describes what you should do to limit the risk
of causing someone else problems.
</para>
<para>
When you have done all the work, and all the testing and
-are about to commit something please do:
+are about to commit something please do the following:
<orderedlist>
<listitem>
<para>
@@ -421,31 +421,31 @@
<listitem>
<para>
If your changes include removing public or protected operations and
-attributes make a clean compile
+attributes, make a clean compile
(<command>build clean</command> followed by
<command>build run</command> or <command>build package</command>).
</para>
<para>
-The build mechanism does not yet have reliable
+The build mechanism does not yet have a reliable
dependency checker enabled so this is the best way to make sure.
</para>
</listitem>
<listitem>
<para>
-If your changes include adding abstract operations make a clean compile
+If your changes include adding abstract operations, make a clean compile
(<command>build clean</command> followed by
<command>build run</command> or <command>build package</command>).
</para>
<para>
-The build mechanism does not yet have reliable
+The build mechanism does not yet have a reliable
dependency checker enabled so this is the best way to make sure.
</para>
</listitem>
<listitem>
<para>
-If you have changed anything that has the potential of affecting
+If you have changed anything that has the potential to affect
something in a totally different part of the code like internal
data structure, handling of exceptions,
run all JUnit test cases
@@ -471,7 +471,7 @@
from the repository and start over with the compilation.
</para>
<para>
-If someone else have updated a file
+If someone else has updated a file
(<command>svn update</command> shown U, or R)
please compile again.
</para>
@@ -507,11 +507,11 @@
</para>
<para>
<emphasis>Rationale:</emphasis>
-These ground rules is for the purpose of not stopping or hindering
-the work for anyone.
+These ground rules are not intended to stop or hinder
+anyone's work.
Remember that there might be several developers working with
different agendas and different efficiency (slower or faster)
-and the commits is the melting point of this.
+and the commits are the melting point of this.
</para>
<para>
<emphasis>Perspective:</emphasis>
@@ -595,8 +595,8 @@
<listitem>
<para>
-Public targets shall have description.
-Non-public targets shall not have description
+Public targets shall have descriptions.
+Non-public targets shall not have descriptions
(write xml comments or echos instead).
</para>
</listitem>
@@ -636,7 +636,7 @@
Here is the list of things to check in the dependency
and to discuss with yourself and maybe with the rest of the
ArgoUML development team
-before considering to use it in the ArgoUML project.
+before considering it's use in the ArgoUML project.
</para>
<itemizedlist>
<listitem>
@@ -665,8 +665,8 @@
Java version
</para>
<para>
-The dependency must have a policy that matches the ArgoUML project policy
-on Java version requirements.
+The dependency must have a policy that is compatible with the ArgoUML project
+policy on Java version requirements.
</para>
<para>
Rationale:
@@ -817,7 +817,7 @@
prerequisites,
package (two places),
new target check.<replaceable>dependency</replaceable>), and
-One possibly place in <filename>AboutBox.java</filename> (Constructor).
+one possible place in <filename>AboutBox.java</filename> (Constructor).
Notice especially that <filename>build.xml</filename> shall not contain
any version information.
Notice also that the text in <filename>AboutBox.java</filename>
@@ -840,7 +840,7 @@
<para>
See <xref linkend="issues_dependencies"></xref> for a discussion on
-how to handle bugs found in dependency and
+how to handle bugs found in a dependency and
updates of the version of a dependency.
</para>
</sect1>
Modified: trunk/documentation/cookbook/subsystemcritics.xml
Url: http://argouml.tigris.org/source/browse/argouml/trunk/documentation/cookbook/subsystemcritics.xml?view=diff&rev=13940&p1=trunk/documentation/cookbook/subsystemcritics.xml&p2=trunk/documentation/cookbook/subsystemcritics.xml&r1=13939&r2=13940
==============================================================================
--- trunk/documentation/cookbook/subsystemcritics.xml (original)
+++ trunk/documentation/cookbook/subsystemcritics.xml 2007-12-18 00:28:37-0800
@@ -182,7 +182,7 @@
<command>addSupportedDecision(UMLDecision.dec<replaceable>AAAA</replaceable>);</command>
where <replaceable>AAAA</replaceable> is the design issue category
this critic falls into
-(examples include STORAGE, PATTERN METHODS).
+(examples include STORAGE, PATTERNS, METHODS).
</para>
</listitem>
<listitem>
@@ -249,7 +249,7 @@
which will be named respectively
<constant>critics.<replaceable>CrXxxxxYyyyZzzz</replaceable>-head</constant>
and
-<constant>critics<replaceable>CrXxxxxYyyyZzzz</replaceable>-desc</constant>.
+<constant>critics.<replaceable>CrXxxxxYyyyZzzz</replaceable>-desc</constant>.
There are plenty of examples to look at there.
Headlines shall be unique, see issue 618.
The other files
Modified: trunk/documentation/cookbook/subsystemdiagrams.xml
Url: http://argouml.tigris.org/source/browse/argouml/trunk/documentation/cookbook/subsystemdiagrams.xml?view=diff&rev=13940&p1=trunk/documentation/cookbook/subsystemdiagrams.xml&p2=trunk/documentation/cookbook/subsystemdiagrams.xml&r1=13939&r2=13940
==============================================================================
--- trunk/documentation/cookbook/subsystemdiagrams.xml (original)
+++ trunk/documentation/cookbook/subsystemdiagrams.xml 2007-12-18 00:28:37-0800
@@ -40,13 +40,13 @@
the diagrams through the view.
</para>
<para>
-The Diagrams are be located in <classname>org.argouml.uml.diagram</classname>.
+The Diagrams are located in <classname>org.argouml.uml.diagram</classname>.
</para>
<para>
-The Diagrams is a View subsystem. <xref linkend="view_control_subsystems"></xref>.
+The Diagrams are a View subsystem. <xref linkend="view_control_subsystems"></xref>.
</para>
<para>
-The Diagrams are depending on the Model subsystem and the GUI.
+The Diagrams depend on the Model subsystem and the GUI.
</para>
<para>
@@ -339,10 +339,10 @@
<orderedlist>
<listitem>
<para>
-For nodes, that are Figs that are enclosed figures like
+Nodes that are Figs that are enclosed figures like
<classname>FigClass</classname>,
extend from <classname>FigNodeModelElement</classname>.
-For edges, that are lines like <classname>FigAssociation</classname>,
+Edges that are lines like <classname>FigAssociation</classname>,
extend from <classname>FigEdgeModelElement</classname>.
The name of the Fig has to start with (yes indeed) Fig.
The rest of the name should be equal to the model element name.
Modified: trunk/documentation/cookbook/subsysteminternationalization.xml
Url: http://argouml.tigris.org/source/browse/argouml/trunk/documentation/cookbook/subsysteminternationalization.xml?view=diff&rev=13940&p1=trunk/documentation/cookbook/subsysteminternationalization.xml&p2=trunk/documentation/cookbook/subsysteminternationalization.xml&r1=13939&r2=13940
==============================================================================
--- trunk/documentation/cookbook/subsysteminternationalization.xml (original)
+++ trunk/documentation/cookbook/subsysteminternationalization.xml 2007-12-18 00:28:37-0800
@@ -59,7 +59,7 @@
Command line argument
</para>
<para>
-The prepared Java Web Start alternatives also uses this to override
+The prepared Java Web Start alternatives also use this to override
everything else.
</para>
</listitem>
@@ -140,9 +140,9 @@
problems as to how it works but more so the problems are with
getting, keeping and coordinating the correct competences to do
the job.
-This comes from the fact that by necessity the different
-persons working with internationalization have different native languages
-and that complicates the communications.
+This comes from the fact that, as would be expected, the different
+persons working with internationalization often have different native languages
+which complicates the communication.
</para>
<para>
To handle this problem for GNU applications
@@ -197,8 +197,8 @@
needs to be modified to allow for localization.
</para>
<para>
-As ArgoUML is originally built without localization there may still have
-places in the GUI that is not localizable just by
+As ArgoUML was originally built without localization there may still be
+places in the GUI that are not localizable just by
modifying the resource bundles.
Each such place is a Defect and shall be corrected.
</para>
@@ -312,8 +312,8 @@
you have understood the responsibilities.
</para>
<para>
-The project are argouml subprojects so they are listed at the bottom of
-the argouml web page.
+The projects are ArgoUML subprojects so they are listed at the bottom of
+the ArgoUML web page.
</para>
</listitem>
@@ -345,7 +345,7 @@
This is only applicable for members of the language team.
</para>
<para>
-Make sure you are a Developer in the appropriate project.
+Make sure you are a Developer in the appropriate language project.
</para>
<para>
Look at the files in
@@ -427,7 +427,7 @@
to convert them to wherever they are used.
</para>
<para>
-This is how a real example would look like:
+This is how a real example would look:
<programlisting>
import org.argouml.i18n.Translator;
...
@@ -456,7 +456,7 @@
Contact all language-teams so that they can update their files.
</para>
<para>
-Currently (November 2003) there is a great confusion as to where
+Currently (November 2003) there is great confusion as to where
we stand on the different translations.
For this reason we can't say if any language team is up to date
with the changes and served by such a contact.
@@ -482,7 +482,7 @@
spot the modification.
</para>
<para>
-There allegedly are tools in the java world to spot this kind of changes.
+There allegedly are tools in the java world to spot these kinds of changes.
Until we have the tools and processes in place to handle them
it is better to rely on this simpler mechanism to guarantee correctness.
</para>
Modified: trunk/documentation/cookbook/subsystemlogging.xml
Url: http://argouml.tigris.org/source/browse/argouml/trunk/documentation/cookbook/subsystemlogging.xml?view=diff&rev=13940&p1=trunk/documentation/cookbook/subsystemlogging.xml&p2=trunk/documentation/cookbook/subsystemlogging.xml&r1=13939&r2=13940
==============================================================================
--- trunk/documentation/cookbook/subsystemlogging.xml (original)
+++ trunk/documentation/cookbook/subsystemlogging.xml 2007-12-18 00:28:37-0800
@@ -296,7 +296,7 @@
<sect3>
<title>...when running ArgoUML from the command line</title>
<para>
- There are currently two possibilities of running
+ There are currently two ways of running
<application>ArgoUML</application> from the command
line:
<orderedlist>
Modified: trunk/documentation/cookbook/subsystemnotation.xml
Url: http://argouml.tigris.org/source/browse/argouml/trunk/documentation/cookbook/subsystemnotation.xml?view=diff&rev=13940&p1=trunk/documentation/cookbook/subsystemnotation.xml&p2=trunk/documentation/cookbook/subsystemnotation.xml&r1=13939&r2=13940
==============================================================================
--- trunk/documentation/cookbook/subsystemnotation.xml (original)
+++ trunk/documentation/cookbook/subsystemnotation.xml 2007-12-18 00:28:37-0800
@@ -61,7 +61,7 @@
<para>
In the scope of issue 3140,
- the notation architecturehas been discussed.
+ the notation architecture has been discussed.
Later, a change has been performed to resolve dependency cycles.
</para>
<para>
@@ -70,7 +70,7 @@
shall be a user-choice with project scope -
and we will never refine the scope
to something more detailed.
- Hence we need not store the notationlanguage per Fig.
+ Hence we need not store the notation language per Fig.
So, this means that you can set
the notation language in the project properties,
Modified: trunk/documentation/cookbook/subsystempropertypanels.xml
Url: http://argouml.tigris.org/source/browse/argouml/trunk/documentation/cookbook/subsystempropertypanels.xml?view=diff&rev=13940&p1=trunk/documentation/cookbook/subsystempropertypanels.xml&p2=trunk/documentation/cookbook/subsystempropertypanels.xml&r1=13939&r2=13940
==============================================================================
--- trunk/documentation/cookbook/subsystempropertypanels.xml (original)
+++ trunk/documentation/cookbook/subsystempropertypanels.xml 2007-12-18 00:28:37-0800
@@ -33,7 +33,7 @@
<para>
Purpose - to provide a form view of the diagrams and objects in the model.
-The contents of the model is modifiable.
+The contents of the model are modifiable from the panel.
</para>
<para>
The Property panels will be located in
@@ -58,9 +58,8 @@
<filename>PropPanel<replaceable>XXX</replaceable>.java</filename>,
where <replaceable>XXX</replaceable> is the
UML meta-class. They are in sub-packages of org.argouml.uml.ui
-corresponding to the <replaceable>XXX</replaceable> UML packages,
-which in turn correspond to
-their section in the chapter 2 of the UML 1.3 spec.
+corresponding to the UML package which contains the
+<replaceable>XXX</replaceable> metaclass in the UML specification.
</para>
<para>
@@ -86,7 +85,7 @@
You will need to make an icon, in .gif format, 16 X 16 pixels,
with the transparent background color set to white.
Place this file in the org.argouml.Images directory
- (it must be named like Name.gif).
+ (it must be named like <literal>Name.gif</literal>).
This icon will automatically be used in the toolbar
and in the Navigation pane.
</para>
@@ -225,7 +224,7 @@
Model subsystem event name by invoking the constructor of the parent class,
with the event name as parameter.
</para>
- <para> A string naming an Model subsystem event that should force a refresh of
+ <para> A string naming a Model subsystem event that should force a refresh of
the list model. A null value will cause all events to trigger a
refresh. The name of the event is the same as the name of the associated
attribute or association end from the UML 1.4 metamodel.
@@ -913,7 +912,7 @@
<methodname>HandleEvent</methodname> updates the property in
<classname>UMLTextProperty</classname> if it is really changed.
If the update comes via user input, it is checked if it is valid input.
-If it is not, a <classname>JOptionPane</classname> is shown with '
+If it is not, a <classname>JOptionPane</classname> is shown with
a warning and the change is not committed into the model.
If it is not via user input, the input is not checked and the
property is set. If the property is set, the update method is called.
Modified: trunk/documentation/cookbook/subsystems.xml
Url: http://argouml.tigris.org/source/browse/argouml/trunk/documentation/cookbook/subsystems.xml?view=diff&rev=13940&p1=trunk/documentation/cookbook/subsystems.xml&p2=trunk/documentation/cookbook/subsystems.xml&r1=13939&r2=13940
==============================================================================
--- trunk/documentation/cookbook/subsystems.xml (original)
+++ trunk/documentation/cookbook/subsystems.xml 2007-12-18 00:28:37-0800
@@ -34,7 +34,7 @@
<indexterm>
<primary>subsystem</primary> </indexterm> <indexterm>
<primary>component</primary> </indexterm>
- <para> The code within ArgoUML is separated in subsystems that each have a few
+ <para> The code within ArgoUML is separated into subsystems that each have a few
responsibilities. </para>
<para> In Issuezilla each subsystem has its issues sorted in a subcomponent with
the same name as the subsystem. Furthermore the Diagrams subsystem has a set of
@@ -47,7 +47,7 @@
<para> The subsystems are organized in layers. The purpose of the layers is to
make it easy to see in what direction the dependencies are and thus allow us to
know what dependencies are to be removed in the cases where we have circular
- dependencies. This will also allow us to know which other subsystems that are
+ dependencies. This will also allow us to know which other subsystems are
involved when testing a subsystem. </para>
<sect1 id="subsystems_definition">
@@ -88,14 +88,17 @@
<itemizedlist>
<listitem>
<para> a Facade class </para>
- <para> The facade can be used by all other subsystems when using the
- subsystem. </para>
- <para> The Facade class is called
- <classname><replaceable>SubsystemName</replaceable>
- Facade</classname> and is located in the subsystem package. How it
- is used is primarily documented in the class file itself (as javadoc)
- but the more complex picture is documented in the Cookbook (in <xref
- linkend="inside_subsystems"></xref>). </para>
+ <para>
+The facade can be used by all other subsystems when using the subsystem.
+ </para>
+ <para>
+The Facade class is called
+<classname><replaceable>SubsystemName</replaceable>Facade</classname>
+and is located in the subsystem package.
+How it is used is primarily documented in the class file itself (as javadoc)
+but the more complex picture is documented in the Cookbook (in
+<xref linkend="inside_subsystems"></xref>).
+ </para>
</listitem>
<listitem>
@@ -118,12 +121,12 @@
</listitem>
<listitem>
- <para> If the subsystem uses a callback-technique the callback is
- always made to an interface defined by the subsystem. The interface
- is also in the subsystem package and it is called
- <classname><replaceable>SubsystemName</replaceable>
- <replaceable>PluginType</replaceable>Interface</classname>
- . Example: <classname>ModelDiagramInterface</classname>,
+ <para>
+If the subsystem uses a callback-technique the callback is always made to
+an interface defined by the subsystem.
+The interface is also in the subsystem package and it is called
+<classname><replaceable>SubsystemName</replaceable><replaceable>PluginType</replaceable>Interface</classname>.
+Example: <classname>ModelDiagramInterface</classname>,
<classname>ModelTypeInterface</classname>. </para>
<para>
<mediaobject>
@@ -148,12 +151,14 @@
<para> The use of Facade class is not wide spread in ArgoUML. This is
because ArgoUML is traditionally built as a whole and no subsystems
were clearly defined. </para>
- <para> A Facade class provides the most common functions other
- subsystems want to do when using that subsystems to reduce the need of
- having to use anything else but the Facade class. The Facade class
- should be very much more stable than the subsystem itself. Methods in
- the Facade should change really slowly and only be removed after
- several months (and one stable release) of deprecation. </para>
+ <para>
+A Facade class provides the most common functions other subsystems want to do
+when using that subsystem to reduce the need of having to use anything else
+but the Facade class.
+The Facade class should be very much more stable than the subsystem itself.
+Methods in the Facade should change very slowly and only be removed after
+several months (and one stable release) of deprecation.
+ </para>
<para> The Facade class is documented in the class file itself (as
javadoc) and the more complex picture (if needed) is documented in
the Cookbook (in <xref linkend="inside_subsystems"></xref>).
@@ -192,10 +197,12 @@
Facade class of subsystem Y (putting only one import
org.argouml.Y.YFacade; in each file in the subsystem X that uses subsystem
Y). </para>
- <para> The API solution makes the subsystem X depending on the subsystem Y
- meaning that when we change the API of the subsystem Y we must also change
- subsystem X. The facade calls solution doesn't make the subsystem X
- depending on the API of subsystem Y but just the Facade of subsystem Y.
+ <para>
+The API solution makes subsystem X depend on subsystem Y
+meaning that when we change the API of the subsystem Y we must also change
+subsystem X.
+The facade calls solution doesn't make the subsystem X
+depend on the API of subsystem Y but just the Facade of subsystem Y.
</para>
<para> The choice between the usage of the API or the Facade shall be stated in
the Cookbook's description of subsystem X in the list of used subsystems.
lmpx.com only provides a reader for public news (NNTP) servers. It is not
affiliated with the servers or forums shown here and is not responsible for
the content of articles, which is written by their respective authors.