commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Dennis Lundberg <denn...@apache.org>
Subject Re: [all] xdoc vs. apt
Date Mon, 17 Sep 2012 20:23:32 GMT
On 2012-09-17 21:24, Sébastien Brisard wrote:
> Hi,
> I'm looking into extending the user's guide of Commons-Math for
> special functions. xdoc seems to be offering only very crude
> formatting possibiliities, and apt seems much better. It should work
> out of the box, alongside with existing xdoc pages. However, I can't
> seem to make it work, and I was wondering (being no maven expert) if
> there was anything in commons-parent that prevented from using apt?
> Should I change anything in our pom.xml?

Nothing in our parent prevents you from using apt documents. Just put
them in the src/site/apt folder and make sure they have a ".apt" extension.

For an example have a look at the source for Maven Site Plugin itself:
https://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/
It uses documents in apt, xdoc and fml flavors.

That being said, I think you'll find the formating options to be about
equal between the two.

> At the moment, I'm just toying with the idea. I want to give apt a go
> locally, and see how it goes. I haven't found (yet) a commons project
> that uses this format. Is there a good reason? Should I stick with
> xdoc instead?
> 
> Thanks for your advice!
> Sébastien
> 
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org
> 


-- 
Dennis Lundberg

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Mime
View raw message