One other thing to add to this...
Let's choose a target right-margin location for doc files. I personally
think 80 characters is ridiculous and would advocate 100 or more... but
would be most happy if we all agreed on a single value (even 80 if
others want it), so that reformatting doesn't make diffing files impossible.
Ideas on this one?
Rich
Eddie O'Neil wrote:
Steve--
Great to have some "professional" edits to the documentation. :)
A few comments on some of the changes made here which we might take
a closer look at:
1) I think your editor is tab-ifying some of the documentation. We're
standardized on using four spaces rather than tabs for the doc. This
happened at least in xdocs/netui/overview.xml
2) unless there is formatting (like <strong>) that is used inside of
JSP content, it's much easier to write documentation using "<"
characters than <. This makes copy/paste from samples simpler
3) when referring to NetUI, we tend to use the term "NetUI" rather
than "Netui". This happened in the labels in site.xml. Also, in this
case, it seems like we can call the NetUI Overview section just
"Overview" since it's under the NetUI tab already. I've tried to
remove some of that reduncancy from the docs in recent weeks.
Thoughts?
Eddie
On 8/31/05, [EMAIL PROTECTED] <[EMAIL PROTECTED]> wrote:
Author: steveh
Date: Wed Aug 31 16:09:14 2005
New Revision: 265602
URL: http://svn.apache.org/viewcvs?rev=265602&view=rev
Log:
Editing run-through.
Modified:
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/controls/tutorial_controls.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/getting_started.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/jspOverview.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/overview.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/pageFlowControllers.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/projects.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/site.xml
beehive/trunk/docs/how_to_contribute_docs.txt
Modified:
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/controls/tutorial_controls.xml
