rubys 2002/11/24 15:52:19
Modified: docs/site idedevelopers.html
xdocs/site idedevelopers.xml
Log:
Fix some spelling errors. In the process, some lines had trailing spaces
removed by my editing process... (sorry)
Revision Changes Path
1.5 +46 -46 jakarta-site2/docs/site/idedevelopers.html
Index: idedevelopers.html
===================================================================
RCS file: /home/cvs/jakarta-site2/docs/site/idedevelopers.html,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- idedevelopers.html 24 Nov 2002 20:42:36 -0000 1.4
+++ idedevelopers.html 24 Nov 2002 23:52:19 -0000 1.5
@@ -153,24 +153,24 @@
<tr><td>
<blockquote>
<p>
- There is a new breed of developer in today's
- <a href="http://java.sun.com";>Java</a> community that is rapidly
- discovering <a href="http://www.apache.org";>Apache</a> and more
+ There is a new breed of developer in today's
+ <a href="http://java.sun.com";>Java</a> community that is rapidly
+ discovering <a href="http://www.apache.org";>Apache</a> and more
frequently the <a href="http://jakarta.apache.org";>Jakarta</a> part
- of the greater Apache community. These developers often come to us
+ of the greater Apache community. These developers often come to us
with little or no command-line experience, some cut their teeth on
- tools like <a href="http://www.microsoft.com";>Microsoft's</a>
+ tools like <a href="http://www.microsoft.com";>Microsoft's</a>
Visual Basic or other such tools and later moved on to IDEs such as
- <a href="http://www.borland.com/jbuilder/";>JBuilder</a>,
+ <a href="http://www.borland.com/jbuilder/";>JBuilder</a>,
<a href="http://www.netbeans.org/";>Netbeans</a> and now
<a href="http://www.eclipse.org/";>Eclipse</a>. While the first
generation of Java developer became intimately familiar with command
line tools, the JDK, the classpath and the ins and outs of things that
- are now the core of Java development, this "new breed" of developer
+ are now the core of Java development, this "new breed" of developer
often has little knowledge outside his own IDE, and sometimes doesn't
even understand what it is doing. This guide does not hope to fix that
but hopes to improve the situation and give the "IDE Developer" a stepping
- block, a starting point, if you will so that they too can participate
+ block, a starting point, if you will so that they too can participate
in our <a href="http://jakarta.apache.org";>Apache Jakarta</a> community.
</p>
</blockquote>
@@ -187,30 +187,30 @@
<tr><td>
<blockquote>
<p>
- The Classpath is the fundemental concept behind Java's library usagage.
+ The Classpath is the fundamental concept behind Java's library usage.
Think of the Classpath as the Java PATH in Windows or UNIX. Instead of
telling the operating system where to find executables, it tells Java
- where to find class files. You can read more about the classpath
+ where to find class files. You can read more about the classpath
<a href="http://java.sun.com/j2se/1.3/docs/tooldocs/win32/classpath.html";>
- here</a>, and <a
href="http://java.sun.com/docs/books/tutorial/getStarted/cupojava/win32.html";>here</a>
+ here</a>, and <a
href="http://java.sun.com/docs/books/tutorial/getStarted/cupojava/win32.html";>here</a>
</p>
<p>
Most IDEs abstract you from the classpath by having you declare and set
- up libraries. A common mistake that most IDE developers make is to
- include two versions of the same library in the classpath often in the
+ up libraries. A common mistake that most IDE developers make is to
+ include two versions of the same library in the classpath often in the
wrong order. This can cause a number of problems including errant behavior
- and strange jar sealing exceptions. Its best to start from scratch and
+ and strange jar sealing exceptions. It's best to start from scratch and
never just "bootstrap" your project with a classpath from another project
- that is full of things it doesn't need.
+ that is full of things it doesn't need.
</p>
<p>
<a href="http://jakarta.apache.org";>Apache Jakarta</a> is known for being
full of helpful expert developers, however, the a quick way to wear out
your welcome is to demand assistance without sorting out your classpath
- first. There is nothing more frustrating than a hard to kill bug that
+ first. There is nothing more frustrating than a hard to kill bug that
is actually fixed just someone has the old version in their classpath.
- So whether you're setting it in your IDE's library manager or at the
- commandline, shell script, or through <a
href="http://jakarta.apache.org/ant";>your Ant build tool</a>: make sure you know what
is in your classpath and
+ So whether you're setting it in your IDE's library manager or at the
+ command line, shell script, or through <a
href="http://jakarta.apache.org/ant";>your Ant build tool</a>: make sure you know what
is in your classpath and
that only what you need is there.
</p>
<p>TODO: IDE specific instructions
for JBuilder, Netbeans and Eclipse.</p>
@@ -228,16 +228,16 @@
<tr><td>
<blockquote>
<p>
- Most IDE developers see the IDE as the only modern and humane way to
- program and any other tools as primitive. This attitude will probably
+ Most IDE developers see the IDE as the only modern and humane way to
+ program and any other tools as primitive. This attitude will probably
get you laughed out of Jakarta and for good reason. When you're working
- with multiple developers accross multiple platforms, this is a very
+ with multiple developers across multiple platforms, this is a very
limited world view to have. Think of it, how well does your carefully
crafted "project" file help run nightly automated builds so that all the
- code that has been checked in to version control can be verified?
+ code that has been checked in to version control can be verified?
What about building on UNIX? Running unit tests as part of the build?
- Lastly, what about complex dependencies and source structures due to
- multiple code bases belonging to a project? (IDEs are notoriously
+ Lastly, what about complex dependencies and source structures due to
+ multiple code bases belonging to a project? (IDEs are notoriously
rigid in the source directory structures they allow, some are breaking this
presupposition, but some of the more popular ones still haven't). There
is a tool which meets all of these requirements and is the Cat's Meow too.
@@ -247,11 +247,11 @@
Ant started out as the build tool for the popular servlet engine
now known as <a href="http://jakarta.apache.org/tomcat";>Tomcat</a>.
Ant's cousin in the C world is called Make. However unlike Make, Ant
- doesn't give you pathetic error messages about using tabs instead of
- spaces (sick! really sick!) and has a much more easily digestible
+ doesn't give you pathetic error messages about using tabs instead of
+ spaces (sick! really sick!) and has a much more easily digestible
syntax. Ant's syntax is based on XML, mostly because they didn't want
to write a parser when there were plenty around. And writing an ant
- build.xml file is WAY easier than writing a makefile. Most modern
+ build.xml file is WAY easier than writing a makefile. Most modern
Java IDEs support Ant either natively or through plugins. Some even
have GUIs to abstract you from the build file, however, you will need
to acquire some familiarity with Ant over time as these tools often
@@ -274,14 +274,14 @@
<p>
Its a depressing fact, but most companies either do not use, or misuse
revision control. Are you emailing files around? That is the wrong way
- to work on the team. Without proper sourcecode control we'd be up the
- creek without a paddle at the Apache Jakarta project. So we make
+ to work on the team. Without proper sourcecode control we'd be up the
+ creek without a paddle at the Apache Jakarta project. So we make
extensive use of CVS here. One day this may change to a more modern and
- sophisticated revision control program like <a
href="http://subversion.tigris.org";>Subversion</a> but that day hasn't quite come yet.
+ sophisticated revision control program like <a
href="http://subversion.tigris.org";>Subversion</a> but that day hasn't quite come yet.
</p>
<p>
Revision control ensures that the old version of code is kept and that
- the deltas (or changes) are stored for newer versions. By using
+ the deltas (or changes) are stored for newer versions. By using
<a href="http://www.cvshome.org/docs/manual/cvs_4.html#SEC48";>Tags</a> you
can even reproduce an entire software release from history. By using
<a href="http://www.cvshome.org/docs/manual/cvs_5.html#SEC58";>Branches</a> you
can develop two versions at once. For instance
@@ -293,19 +293,19 @@
You NEED to read <a href="http://www.cvshome.org/docs/manual/";>this</a> if
you don't understand how CVS works. Even if you never use the command-line
tools, you need to understand the concepts behind CVS. At least scan it
- even if you're familiar with other revision control systems like
- Visual SourceSafe or PVCS, because CVS is its own beast.
+ even if you're familiar with other revision control systems like
+ Visual SourceSafe or PVCS, because CVS is its own beast.
</p>
<p>
- All of the Apache Jakarta Project's software is stored in CVS under
- revision control. And to contribute to the project you need to create
- "patches" with the cvs diff -u command (or the GUI equivilent). The
- -u specifies the more brief and useful format. To do that you need to
+ All of the Apache Jakarta Project's software is stored in CVS under
+ revision control. And to contribute to the project you need to create
+ "patches" with the cvs diff -u command (or the GUI equivalent). The
+ -u specifies the more brief and useful format. To do that you need to
have a working copy of the software. Instructions and a list of modules
can be found <a href="http://jakarta.apache.org/site/cvsindex.html";>here</a>.
You'll even find instructions on how to use GUI tools with CVS, many of
- which are free. <a href="http://www.eclipse.org";>Eclipse</a> and
- <a href="http://www.netbeans.org";>Netbeans</a> already have very good
+ which are free. <a href="http://www.eclipse.org";>Eclipse</a> and
+ <a href="http://www.netbeans.org";>Netbeans</a> already have very good
support for CVS built in.
</p>
</blockquote>
@@ -325,19 +325,19 @@
A frequent question asked is "How do I get all these classes loaded into
[name of IDE usually JBuilder] to run them in the debugger?" The answer
is often: you don't. This certainly might make sense for apps or applets,
- but most applications these days are run in a servlet engine or other
+ but most applications these days are run in a servlet engine or other
container such as <a
href="http://jakarta.apache.org/avalon/phoenix/index.html";>Phoenix</a>. For these: you
set the sourcepath, you put the binaries in the classpath
- but you debug the code remotely. Meaning the code runs in tomcat or
- whatever and you run the debugger against it. Modern IDEs such as
- <a href="http://www.eclipse.org";>Eclipse</a> when running against
+ but you debug the code remotely. Meaning the code runs in tomcat or
+ whatever and you run the debugger against it. Modern IDEs such as
+ <a href="http://www.eclipse.org";>Eclipse</a> when running against
JDK 1.4.x or later can even change the code at runtime while debugging!
</p>
<p>
It does generally involve editing shell scripts or batch files which can
- be difficult for the IDE developer to commit to, but once you do, its
- basically over with. These instructions will assume you're running
+ be difficult for the IDE developer to commit to, but once you do, its
+ basically over with. These instructions will assume you're running
<a href="http://jakarta.apache.org/tomcat";>Tomcat 4.1.12</a> or similar
- (meaning its doubtful that 4.1.13 will be different but 5.0 very well
+ (meaning its doubtful that 4.1.13 will be different but 5.0 very well
might be) on Windows 2000 or similar.
</p>
<ul>
1.5 +46 -46 jakarta-site2/xdocs/site/idedevelopers.xml
Index: idedevelopers.xml
===================================================================
RCS file: /home/cvs/jakarta-site2/xdocs/site/idedevelopers.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- idedevelopers.xml 24 Nov 2002 20:42:35 -0000 1.4
+++ idedevelopers.xml 24 Nov 2002 23:52:19 -0000 1.5
@@ -10,69 +10,69 @@
<section name="IDE Developer's Guide">
<p>
- There is a new breed of developer in today's
- <a href="http://java.sun.com";>Java</a> community that is rapidly
- discovering <a href="http://www.apache.org";>Apache</a> and more
+ There is a new breed of developer in today's
+ <a href="http://java.sun.com";>Java</a> community that is rapidly
+ discovering <a href="http://www.apache.org";>Apache</a> and more
frequently the <a href="http://jakarta.apache.org";>Jakarta</a> part
- of the greater Apache community. These developers often come to us
+ of the greater Apache community. These developers often come to us
with little or no command-line experience, some cut their teeth on
- tools like <a href="http://www.microsoft.com";>Microsoft's</a>
+ tools like <a href="http://www.microsoft.com";>Microsoft's</a>
Visual Basic or other such tools and later moved on to IDEs such as
- <a href="http://www.borland.com/jbuilder/";>JBuilder</a>,
+ <a href="http://www.borland.com/jbuilder/";>JBuilder</a>,
<a href="http://www.netbeans.org/";>Netbeans</a> and now
<a href="http://www.eclipse.org/";>Eclipse</a>. While the first
generation of Java developer became intimately familiar with command
line tools, the JDK, the classpath and the ins and outs of things that
- are now the core of Java development, this "new breed" of developer
+ are now the core of Java development, this "new breed" of developer
often has little knowledge outside his own IDE, and sometimes doesn't
even understand what it is doing. This guide does not hope to fix that
but hopes to improve the situation and give the "IDE Developer" a stepping
- block, a starting point, if you will so that they too can participate
+ block, a starting point, if you will so that they too can participate
in our <a href="http://jakarta.apache.org";>Apache Jakarta</a> community.
</p>
</section>
<section name="The classpath">
<p>
- The Classpath is the fundemental concept behind Java's library usagage.
+ The Classpath is the fundamental concept behind Java's library usage.
Think of the Classpath as the Java PATH in Windows or UNIX. Instead of
telling the operating system where to find executables, it tells Java
- where to find class files. You can read more about the classpath
+ where to find class files. You can read more about the classpath
<a href="http://java.sun.com/j2se/1.3/docs/tooldocs/win32/classpath.html";>
- here</a>, and <a
href="http://java.sun.com/docs/books/tutorial/getStarted/cupojava/win32.html";>here</a>
+ here</a>, and <a
href="http://java.sun.com/docs/books/tutorial/getStarted/cupojava/win32.html";>here</a>
</p>
<p>
Most IDEs abstract you from the classpath by having you declare and set
- up libraries. A common mistake that most IDE developers make is to
- include two versions of the same library in the classpath often in the
+ up libraries. A common mistake that most IDE developers make is to
+ include two versions of the same library in the classpath often in the
wrong order. This can cause a number of problems including errant behavior
- and strange jar sealing exceptions. Its best to start from scratch and
+ and strange jar sealing exceptions. It's best to start from scratch and
never just "bootstrap" your project with a classpath from another project
- that is full of things it doesn't need.
+ that is full of things it doesn't need.
</p>
<p>
<a href="http://jakarta.apache.org";>Apache Jakarta</a> is known for being
full of helpful expert developers, however, the a quick way to wear out
your welcome is to demand assistance without sorting out your classpath
- first. There is nothing more frustrating than a hard to kill bug that
+ first. There is nothing more frustrating than a hard to kill bug that
is actually fixed just someone has the old version in their classpath.
- So whether you're setting it in your IDE's library manager or at the
- commandline, shell script, or through <a
href="http://jakarta.apache.org/ant";>your Ant build tool</a>: make sure you know what
is in your classpath and
+ So whether you're setting it in your IDE's library manager or at the
+ command line, shell script, or through <a
href="http://jakarta.apache.org/ant";>your Ant build tool</a>: make sure you know what
is in your classpath and
that only what you need is there.
</p>
<p>TODO: IDE specific instructions for JBuilder, Netbeans and Eclipse.</p>
</section>
<section name="Ant and Compilation">
<p>
- Most IDE developers see the IDE as the only modern and humane way to
- program and any other tools as primitive. This attitude will probably
+ Most IDE developers see the IDE as the only modern and humane way to
+ program and any other tools as primitive. This attitude will probably
get you laughed out of Jakarta and for good reason. When you're working
- with multiple developers accross multiple platforms, this is a very
+ with multiple developers across multiple platforms, this is a very
limited world view to have. Think of it, how well does your carefully
crafted "project" file help run nightly automated builds so that all the
- code that has been checked in to version control can be verified?
+ code that has been checked in to version control can be verified?
What about building on UNIX? Running unit tests as part of the build?
- Lastly, what about complex dependencies and source structures due to
- multiple code bases belonging to a project? (IDEs are notoriously
+ Lastly, what about complex dependencies and source structures due to
+ multiple code bases belonging to a project? (IDEs are notoriously
rigid in the source directory structures they allow, some are breaking this
presupposition, but some of the more popular ones still haven't). There
is a tool which meets all of these requirements and is the Cat's Meow too.
@@ -82,11 +82,11 @@
Ant started out as the build tool for the popular servlet engine
now known as <a href="http://jakarta.apache.org/tomcat";>Tomcat</a>.
Ant's cousin in the C world is called Make. However unlike Make, Ant
- doesn't give you pathetic error messages about using tabs instead of
- spaces (sick! really sick!) and has a much more easily digestible
+ doesn't give you pathetic error messages about using tabs instead of
+ spaces (sick! really sick!) and has a much more easily digestible
syntax. Ant's syntax is based on XML, mostly because they didn't want
to write a parser when there were plenty around. And writing an ant
- build.xml file is WAY easier than writing a makefile. Most modern
+ build.xml file is WAY easier than writing a makefile. Most modern
Java IDEs support Ant either natively or through plugins. Some even
have GUIs to abstract you from the build file, however, you will need
to acquire some familiarity with Ant over time as these tools often
@@ -98,14 +98,14 @@
<p>
Its a depressing fact, but most companies either do not use, or misuse
revision control. Are you emailing files around? That is the wrong way
- to work on the team. Without proper sourcecode control we'd be up the
- creek without a paddle at the Apache Jakarta project. So we make
+ to work on the team. Without proper sourcecode control we'd be up the
+ creek without a paddle at the Apache Jakarta project. So we make
extensive use of CVS here. One day this may change to a more modern and
- sophisticated revision control program like <a
href="http://subversion.tigris.org";>Subversion</a> but that day hasn't quite come yet.
+ sophisticated revision control program like <a
href="http://subversion.tigris.org";>Subversion</a> but that day hasn't quite come yet.
</p>
<p>
Revision control ensures that the old version of code is kept and that
- the deltas (or changes) are stored for newer versions. By using
+ the deltas (or changes) are stored for newer versions. By using
<a href="http://www.cvshome.org/docs/manual/cvs_4.html#SEC48";>Tags</a> you
can even reproduce an entire software release from history. By using
<a href="http://www.cvshome.org/docs/manual/cvs_5.html#SEC58";>Branches</a> you
can develop two versions at once. For instance
@@ -117,19 +117,19 @@
You NEED to read <a href="http://www.cvshome.org/docs/manual/";>this</a> if
you don't understand how CVS works. Even if you never use the command-line
tools, you need to understand the concepts behind CVS. At least scan it
- even if you're familiar with other revision control systems like
- Visual SourceSafe or PVCS, because CVS is its own beast.
+ even if you're familiar with other revision control systems like
+ Visual SourceSafe or PVCS, because CVS is its own beast.
</p>
<p>
- All of the Apache Jakarta Project's software is stored in CVS under
- revision control. And to contribute to the project you need to create
- "patches" with the cvs diff -u command (or the GUI equivilent). The
- -u specifies the more brief and useful format. To do that you need to
+ All of the Apache Jakarta Project's software is stored in CVS under
+ revision control. And to contribute to the project you need to create
+ "patches" with the cvs diff -u command (or the GUI equivalent). The
+ -u specifies the more brief and useful format. To do that you need to
have a working copy of the software. Instructions and a list of modules
can be found <a href="http://jakarta.apache.org/site/cvsindex.html";>here</a>.
You'll even find instructions on how to use GUI tools with CVS, many of
- which are free. <a href="http://www.eclipse.org";>Eclipse</a> and
- <a href="http://www.netbeans.org";>Netbeans</a> already have very good
+ which are free. <a href="http://www.eclipse.org";>Eclipse</a> and
+ <a href="http://www.netbeans.org";>Netbeans</a> already have very good
support for CVS built in.
</p>
</section>
@@ -138,19 +138,19 @@
A frequent question asked is "How do I get all these classes loaded into
[name of IDE usually JBuilder] to run them in the debugger?" The answer
is often: you don't. This certainly might make sense for apps or applets,
- but most applications these days are run in a servlet engine or other
+ but most applications these days are run in a servlet engine or other
container such as <a
href="http://jakarta.apache.org/avalon/phoenix/index.html";>Phoenix</a>. For these: you
set the sourcepath, you put the binaries in the classpath
- but you debug the code remotely. Meaning the code runs in tomcat or
- whatever and you run the debugger against it. Modern IDEs such as
- <a href="http://www.eclipse.org";>Eclipse</a> when running against
+ but you debug the code remotely. Meaning the code runs in tomcat or
+ whatever and you run the debugger against it. Modern IDEs such as
+ <a href="http://www.eclipse.org";>Eclipse</a> when running against
JDK 1.4.x or later can even change the code at runtime while debugging!
</p>
<p>
It does generally involve editing shell scripts or batch files which can
- be difficult for the IDE developer to commit to, but once you do, its
- basically over with. These instructions will assume you're running
+ be difficult for the IDE developer to commit to, but once you do, its
+ basically over with. These instructions will assume you're running
<a href="http://jakarta.apache.org/tomcat";>Tomcat 4.1.12</a> or similar
- (meaning its doubtful that 4.1.13 will be different but 5.0 very well
+ (meaning its doubtful that 4.1.13 will be different but 5.0 very well
might be) on Windows 2000 or similar.
</p>
<ul>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
