Re: [digester] @author tag tidyup
On 3 Apr 2004, at 08:18, Simon Kitching wrote: Hi Robert, On Thu, 2004-04-01 at 07:46, robert burrell donkin wrote: i quite like author tags for aesthetic reasons :) the reason why i favour including a link is that (judging from the volume of personal email i've received from users over the years) there are still quite a few users who don't know how to find the existing ASF resources. i'm not really sure whether i prefer the link targeting the jakarta mail page, the jakarta commons page or the main jakarta page, though. How exactly are these users finding your personal email address? If it is through a personal @author tag within the source code, then that will no longer happen :-). Will this resolve your concern on this topic? the point i tried (but failed to make clearer) is that users who only have the javadocs available to them seem to be unable to locate the right place to find the information that they need can be found (which is jakarta.apache.org). Personally, I have no sympathy for java developers who are looking at a source code file containing the apache licence and the package declaration org.apache.commons.digester and still can't find the main website. I think we're probably better off without them! i like to give users as much help as possible to get started especially newbies. many organizations host internal copies of the javadocs. there are still developers out there who have never heard of the ASF. one of the reasons why jakarta (in general) and commons (in particular) have proved popular is that we're better at communicating with users than some other open source projects. but users need to find us before they can take advantage. we're now top on google, msn and yahoo so all they have to do is search but i still like the idea (and the aesthetics) of a very obvious link from the documentation. I'm not trying to push anybody one way or the other; I don't care too much, except that we have to resolve this one way or the other in order to get a release out the door. I guess if there isn't an obvious consensus, then we need a vote? i think that the consensus has been reached that there's no harm in removing author tags for committers. the question of whether they should be replaced with a jakarta or ASF tag (and what that tag should be) is unresolved but isn't too important. i don't think that anyone would veto the removal of the author tags just because you didn't replace them with their favoured replacement. if a consensus about author tags emerges (or if someone feels motivate enough to do the work) then they can easily be added later. On a separate issue, is there a BeanUtils release anywhere in the near future? It would be great to release Digester with the new BeanUtils and therefore no dependency on Collections. 1 i think that a release of beanutils and time soon is very unlikely 2 due to a missed reference in the public API (darn :) the dependency on collections cannot be removed without a new major version of beanutils - robert - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: [digester] @author tag tidyup
Hi Robert, On Thu, 2004-04-01 at 07:46, robert burrell donkin wrote: i quite like author tags for aesthetic reasons :) the reason why i favour including a link is that (judging from the volume of personal email i've received from users over the years) there are still quite a few users who don't know how to find the existing ASF resources. i'm not really sure whether i prefer the link targeting the jakarta mail page, the jakarta commons page or the main jakarta page, though. How exactly are these users finding your personal email address? If it is through a personal @author tag within the source code, then that will no longer happen :-). Will this resolve your concern on this topic? Personally, I have no sympathy for java developers who are looking at a source code file containing the apache licence and the package declaration org.apache.commons.digester and still can't find the main website. I think we're probably better off without them! I'm not trying to push anybody one way or the other; I don't care too much, except that we have to resolve this one way or the other in order to get a release out the door. I guess if there isn't an obvious consensus, then we need a vote? On a separate issue, is there a BeanUtils release anywhere in the near future? It would be great to release Digester with the new BeanUtils and therefore no dependency on Collections. Regards, Simon - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: [digester] @author tag tidyup
Simon Kitching wrote: Hi, We had a discussion about author tags a while ago. The general consensus was that individuals should no longer be listed in these tags [NB: not an official vote]. I think this is now also apache policy? It's a recommendation of the ASF Board. Robert Donkin suggested using them to credit the commons team, with the benefit that a link would lead back to apache. I see that these tags have started appearing in Betwixt: * @author a href='http://jakarta.apache.org/'Jakarta Commons Team/a I'm happy with this; the line length is 73 chars, so it fits nicely within an 80-char line without wrapping and seems useful. Does anyone have any objections if I replace all the existing @author tags in digester with this? I have already copied all author info into the project.xml file... [NB: I might make it The Jakarta Commons Team for grammatical reasons :-] I'd actually prefer to just get rid of the @author line entirely. If we're going to keep it, though, the link should really point at something useful, like perhaps the home page of the Digester website. Regards, Simon Craig - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
RE: [digester] @author tag tidyup
I'd actually prefer to just get rid of the @author line entirely. If we're going to keep it, though, the link should really point at something useful, like perhaps the home page of the Digester website. For projects that choose to follow the Board recommendation of not using personal @author tags, it would be nice to have a consistent format across Jakarta. For codec, we now use: * @author Apache Software Foundation I am not sure why this string and not something project specific with an href. Gary - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: [digester] @author tag tidyup
Gary Gregory wrote: I'd actually prefer to just get rid of the @author line entirely. If we're going to keep it, though, the link should really point at something useful, like perhaps the home page of the Digester website. For projects that choose to follow the Board recommendation of not using personal @author tags, it would be nice to have a consistent format across Jakarta. For codec, we now use: * @author Apache Software Foundation I am not sure why this string and not something project specific with an href. If the @author tag doesn't refer to an individual, I think the easiest bet would be to just remove them. @author Apache Software Foundation -- this is restating the obvious. Unless incubator projects would refer to the original author, and not Apache? In that case, it may make sense. (example) @author Jakarta Commons Codec Team -- also very redundant. Who else would have written it? Anyone who commits or submits patches to the project already knows who the official author is, and also the individuals who actually wrote the code behind the scenes. So, the target audience for these new @author tags seems to be people who are unfamiliar with Jakarta Commons. Now, seeing as though these people will probably be viewing the JavaDoc at: http://jakarta.apache.org/commons/codec/apidocs Isn't it redundant to include an href to: http://jakarta.apache.org/commons/codec in each file? I say let's get rid of the @author tags and save ourselves some work. I may be misunderstanding some political issues here, maybe? - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
[digester] @author tag tidyup
Hi, We had a discussion about author tags a while ago. The general consensus was that individuals should no longer be listed in these tags [NB: not an official vote]. I think this is now also apache policy? Robert Donkin suggested using them to credit the commons team, with the benefit that a link would lead back to apache. I see that these tags have started appearing in Betwixt: * @author a href='http://jakarta.apache.org/'Jakarta Commons Team/a I'm happy with this; the line length is 73 chars, so it fits nicely within an 80-char line without wrapping and seems useful. Does anyone have any objections if I replace all the existing @author tags in digester with this? I have already copied all author info into the project.xml file... [NB: I might make it The Jakarta Commons Team for grammatical reasons :-] Regards, Simon - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
