You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@maven.apache.org by Ylan Segal <yl...@gmail.com> on 2004/10/18 19:10:47 UTC
Newbie: Reference for documentation xml files
I am a new maven user and I want to start using maven to generate my
project's documentation. I have looked at maven's own cvs repository
in the xdocs directory and I see the XML files that generate the html
site. However, I have never used anakia or velocity and I can't find a
complete reference for what tags are accepted in the xml files.
I keep going in circles from the xdoc plugin page, to the jakarta2
site page, to the velocity anakaia page, but can't find a
straightforward reference of what tags can be used and how.
I would appreciate someone pointing me in the right direction.
Thank you,
Ylan Segal.
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org
Re: Newbie: Reference for documentation xml files
Posted by Ylan Segal <yl...@gmail.com>.
Thanks for the info. I am going to give it a try. I guess it is simple
enough that there is no need for the complete reference.
On Mon, 18 Oct 2004 22:51:15 +0200, Martijn Dashorst
<ma...@dashorst.dds.nl> wrote:
> There isn't much documentation on the subject. What you've seen is what
> there is.
> http://jakarta.apache.org/site/jakarta-site-tags.html
> There are no more tags than listed in the previous document to my
> knowledge, except standard HTML. Make sure your
> document is well formed.
>
> Try to copy the text of one of the documentation files of maven (or
> jwebunit.sf.net, or wicket.sf.net, or any other open source
> project using maven) and adjust it to your needs. Generate the XDOCs and
> see what comes out of it. That is probably the best way
> and apparently the only way to learn it.
>
> Martijn
>
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org
Re: Newbie: Reference for documentation xml files
Posted by Martijn Dashorst <ma...@dashorst.dds.nl>.
There isn't much documentation on the subject. What you've seen is what
there is.
http://jakarta.apache.org/site/jakarta-site-tags.html
There are no more tags than listed in the previous document to my
knowledge, except standard HTML. Make sure your
document is well formed.
Try to copy the text of one of the documentation files of maven (or
jwebunit.sf.net, or wicket.sf.net, or any other open source
project using maven) and adjust it to your needs. Generate the XDOCs and
see what comes out of it. That is probably the best way
and apparently the only way to learn it.
Martijn
Ylan Segal wrote:
>I am a new maven user and I want to start using maven to generate my
>project's documentation. I have looked at maven's own cvs repository
>in the xdocs directory and I see the XML files that generate the html
>site. However, I have never used anakia or velocity and I can't find a
>complete reference for what tags are accepted in the xml files.
>
>I keep going in circles from the xdoc plugin page, to the jakarta2
>site page, to the velocity anakaia page, but can't find a
>straightforward reference of what tags can be used and how.
>
>I would appreciate someone pointing me in the right direction.
>
>Thank you,
>
>Ylan Segal.
>
>---------------------------------------------------------------------
>To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
>For additional commands, e-mail: users-help@maven.apache.org
>
>
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org
RE: Newbie: Reference for documentation xml files
Posted by Eric Pugh <ep...@upstate.com>.
I would recommend checking out some existing mavenized projects and see how
they do it. Maven itself or the various plugnis are good examples.. Skip
the jakrata2 or anakia sites, they are old.
> -----Original Message-----
> From: Ylan Segal [mailto:ylan.segal@gmail.com]
> Sent: Monday, October 18, 2004 6:11 PM
> To: users@maven.apache.org
> Subject: Newbie: Reference for documentation xml files
>
>
> I am a new maven user and I want to start using maven to generate my
> project's documentation. I have looked at maven's own cvs repository
> in the xdocs directory and I see the XML files that generate the html
> site. However, I have never used anakia or velocity and I can't find a
> complete reference for what tags are accepted in the xml files.
>
> I keep going in circles from the xdoc plugin page, to the jakarta2
> site page, to the velocity anakaia page, but can't find a
> straightforward reference of what tags can be used and how.
>
> I would appreciate someone pointing me in the right direction.
>
> Thank you,
>
> Ylan Segal.
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
> For additional commands, e-mail: users-help@maven.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org