[
https://issues.apache.org/jira/browse/TAP5-2192?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14054366#comment-14054366
]
Barry Books commented on TAP5-2192:
-----------------------------------
I created this Jira because I started writing a documentation module and found
that to be impossible because there is no way to get a list of what's
installed. I think it would also be useful to have a documentation mapped
configuration that modules could contribute to if they want to. As Lance said
it would be useful to define these interfaces in Tapestry but I think the code
that shows the documentation should be in a separate module
(tapestry-documentaton?). This way if you include that you get it. Personally I
would want it on my development machine but not in production. This way if a
module cares to it could add something like this to it's module.
@Contribute(ModuleDocumentationService.class)
public static void arbitraryMethodName(MappedConfiguration<String,
ComponentLibraryInfo > configuration)
{
configuration.add("ModuleName", new My ComponentLibraryInfo());
}
This way core just needs to define two interfaces. One for the Service and one
for the Documentation. The service one is easy it just needs to return the
configuration map. I think Lance's ComonentLibraryInfo is a good start.
> Add support for distributed documentation
> -----------------------------------------
>
> Key: TAP5-2192
> URL: https://issues.apache.org/jira/browse/TAP5-2192
> Project: Tapestry 5
> Issue Type: Improvement
> Affects Versions: 5.4
> Reporter: Barry Books
> Assignee: Thiago H. de Paula Figueiredo
> Labels: documentation, month-of-tapestry
>
> Please add support for a distributed documentation system. The basic
> requirements are:
> 1. Access to a list of Pages/Compoents/Mixins. (ComponentClassResolver
> supports pages)
> 2. Access to a Map of all Configurations. The map would have the
> configuration class as the Key and contain an object such a list or map that
> contains the configuration.
> 3. Access to a list of configured services.
> From this it should be possible to build documentation of a running system.
> Thanks
> Barry
--
This message was sent by Atlassian JIRA
(v6.2#6252)
