cocoon-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Stefano Mazzocchi <stef...@apache.org>
Subject Re: [RT] Improved navigation of learning objects
Date Thu, 16 Oct 2003 10:07:06 GMT

On Wednesday, Oct 15, 2003, at 00:36 Europe/Rome, Conal Tuohy wrote:

>>> But topics can also be safely created automatically in some cases:
>>> where
>>> good structured metadata exists we can confidently base
>> topics on it.
>>> e.g.
>>> topics can usefully be automatically harvested from Java
>> classes that
>>> implement particular interfaces (generators, transformers, etc).
>>
>> True, but again, I don't see the point. I'm sure that if we make the
>> editing interface to our doc system people will find it much
>> easier to
>> just make a list of components and update them as we go (expecially
>> since they are not so many).
>
> I respectfully disagree.
>
> For example: there are many sitemap components that are not adequately 
> documented. The same is true of xml namespaces used in Cocoon. Which 
> ones are undocumented? Well, who knows? It's not easy to see because 
> they're not documented! :-)
>
> If we could "harvest" a topic from the java source of the component, 
> then the lack of documentation for a given component or ns would be 
> immediately obvious, in the form of a topic without any useful 
> content: a blank page saying "write something here". A slightly 
> similar phenomenon exists on the Wiki, where you can reify a topic as 
> a Wiki page just by referring to it in another page.

Very true. Good point.

Now we just have to make it work ;-)

--
Stefano.


Mime
View raw message