On 24/10/2010, at 7:40 AM, Paul Speed wrote:

> While not really in plug-in form, I've played with generating content from 
> textile markup like Confluence, etc. uses.  I find this to be a more natural 
> way to write documentation but different people have different needs, I guess.
> 
> If you are curious what I've done, you can look here:
> http://filament.svn.sourceforge.net/viewvc/filament/trunk/site/build.gradle?revision=380&view=markup
> 
> It's doing more than just content transformation as it also applies a site 
> template, etc... but hopefully it's readable.  Maybe gives some additional 
> ideas to someone.  Someday I will get back to making these things more 
> pluggable.

This might be useful as 2 plugins:
* A general-purpose website plugin which takes care of the templating and 
bundling.
* A textile plugin which contributes a textile -> html converter for the 
website plugin.

We could also split up the jdocbook plugin into a couple of pieces:
* A general-purpose documentation plugin which introduces concepts such as 
books, translations and formats, and the plumbing for these things.
* A docbook plugin which contributes docbook -> html, singleHtml, pdf 
converters.

This way, you could generate a website using plain html, textile or docbook or 
any combination. And similarly, you could generate a userguide using any of 
these formats. And to support more formats, we'd only need to implement a 
converter plugin.


> 
> -Paul
> 
> On 10/23/2010 4:01 PM, Dierk König wrote:
>> Hi,
>> 
>> ok, there is groovydoc and javadoc. Anyway, it would be great to have a 
>> facility to
>> easily write a more high-level documentation like a userguide for a project 
>> and
>> gradle should be able to generate it.
>> 
>> What comes to mind is the docbook approach that gradle uses for itself:
>>   http://docs.codehaus.org/display/GRADLE/How+to+build+the+documentation
>> or the grails-doc as e.g. used by GPars in a gradle build
>>   
>> http://code.google.com/p/gparallelizer/source/browse/trunk/build.gradle?spec=svn1110&r=1110
>> .
>> 
>> Is there yet any plugin for this purpose?
>> 
>> cheers
>> Dierk
>> ---------------------------------------------------------------------
>> To unsubscribe from this list, please visit:
>> 
>>     http://xircles.codehaus.org/manage_email
>> 
>> 
> 
> 
> ---------------------------------------------------------------------
> To unsubscribe from this list, please visit:
> 
>   http://xircles.codehaus.org/manage_email
> 
> 


--
Adam Murdoch
Gradle Developer
http://www.gradle.org
CTO, Gradle Inc. - Gradle Training, Support, Consulting
http://www.gradle.biz

Reply via email to