On Nov 30, 2006, at 5:39 PM, David Blevins wrote:

This is an idea i've had for a while and this seems like a great place to try it out....

I'd like to create a tool that will scrape a (java) codebase for i18n message properties files and create a confluence page for each message using the message key as the page key and the message text as the initial page text. People could then comment on the confluence pages or otherwise add more documentation about the message such as how to get around it, what probable causes are, what sections of which specifications are possibly related, suggest better message text and any other general experience one user may want to share with another user regarding the message or the concept to which the message refers.

The easy part will be creating the initial pages, the hard part will be keeping the i18n messages in sync with the messages in the confluence space and general maintenance of the "error base".

Other possible additions could be using ASM to crawl through the codebase and auto-link to viewvc any java files that use the messages, so users could quickly jump to the code that produced the message and possibly figure out for themselves what they've done wrong or what we could do better. Something like that may even lead to more patches, who knows.

Thoughts?


Here's the doap file.

<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"; xmlns="http://usefulinc.com/ns/doap#"; xmlns:foaf="http://xmlns.com/foaf/0.1/"; xmlns:labs="http:// labs.apache.org/doap-ext/1.0#"
         xmlns:projects="http://projects.apache.org/ns/asfext#";>
  <Project rdf:about="http://labs.apache.org/labs#errbase";>
    <name>ErrBase</name>
    <shortname>errbase</shortname>
<shortdesc xml:lang="en">Auto creates and updates an error message base using i18n files</shortdesc> <description xml:lang="en">ErrBase scrapes your code for i18n message files and generates a Confluence space containing a dedicated page for each message that users can update with information on workarounds, possible
      causes and other information.</description>
    <homepage rdf:resource="http://labs.apache.org/errbase/"/>
    <license rdf:resource="http://usefulinc.com/doap/licenses/asl20"/>
    <created>2006-11-30</created>
    <labs:status>active</labs:status>
    <maintainer>
      <foaf:Person rdf:about="http://people.apache.org/~dblevins/#me";>
        <foaf:name>David Blevins</foaf:name>
<foaf:homepage rdf:resource="http://people.apache.org/ ~dblevins/"/> <foaf:mbox_sha1sum>58398db18ede7e094fa0ebf74a489adee3edb14b</ foaf:mbox_sha1sum>
      </foaf:Person>
    </maintainer>
    <repository>
      <SVNRepository>
<location rdf:resource="http://svn.apache.org/repos/asf/labs/ errbase/"/> <browse rdf:resource="http://svn.apache.org/viewvc/labs/ errbase/"/>
      </SVNRepository>
    </repository>
    <programming-language>java</programming-language>
  </Project>
</rdf:RDF>





---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to