doc conventions on the wiki (was: Re: svn commit: r265602 ...)

Wed, 31 Aug 2005 23:10:04 -0700

I just added a Documentation Conventions page to the wiki. I feel like the easiest thing to do is to put votes by each item on that page, rather than have a separate mail thread for each one. Does this sound OK? 

http://wiki.apache.org/beehive/DocConventions

Rich

Steve Hanson wrote:
As for the tabification, I hit Ctrl+F in Eclipse at one point by accident, that is probably the culprit. I will check the indent style on my Eclipse editor.
I have endeavored to avoid < wherever I can -- but I see no way to avoid it when you want to display angle brackets in bold font.
I have some questions of my own: Should it be "Page Flow" or "Page Flow"? I am neutral on this question. Should it be "Controller class" or "controller class"? I have a slight preference for "Controller class", since it suggests a reference to a Java class. 

On 8/31/05, Eddie O'Neil <[EMAIL PROTECTED]> 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 &lt;. 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

Reply via email to