You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@maven.apache.org by sebb <se...@gmail.com> on 2011/09/10 04:58:24 UTC
Doxia APT - possible to reference Maven properties?
Is it possible to reference Maven properties in APT documents? or
environment variables?
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org
Re: Doxia APT - possible to reference Maven properties?
Posted by Hervé BOUTEMY <he...@free.fr>.
ok, [1] is not easy to understand (I know I need to improve the doc, it took
me a long time to understand, now I need to explain it better)
the point is that:
1. code handling variable substitution is in fact not only variable
substitution but full Velocity power
2. it is in doxia-site-renderer [6] and doxia-doc-renderer [7], which are only
*using* Doxia core: other tools can integrate Doxia core, without this
Velocity feature
Explaining Velocity feature in Doxia core means pointing to a specific use
case.
I'll see how to do that
Regards,
Hervé
[6] http://maven.apache.org/doxia/doxia-sitetools/doxia-site-
renderer/xref/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.html#105
[7] http://maven.apache.org/doxia/doxia-sitetools/doxia-doc-
renderer/xref/org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.html#82
Le samedi 10 septembre 2011, sebb a écrit :
> On 10 September 2011 15:49, Hervé BOUTEMY <he...@free.fr> wrote:
> > yes, there should be some documentation in Doxia site
> >
> > the Velocity templating feature is in Doxia Site Tools
> > (doxia-site-renderer and doxia-doc-renderer), not Doxia Core: the doc
> > should go in [1]
>
> I've no idea what [1] means.
>
> > if you have an idea of the way to document it in a way that people will
> > find...
>
> I did a search for APT, and found [2] and [3]; also looked at macros
> [4] (I'd hoped there would be a property or variable macro)
> The general format page [5] might also be a good place.
>
> Perhaps add a line ot each to say that the file can be pre-processed
> by velocity (and link to the page about that) before it is handed to
> the specific input processor.
>
> [2] http://maven.apache.org/doxia/references/apt-format.html
> [3] http://maven.apache.org/doxia/references/doxia-apt.html
> [4] http://maven.apache.org/doxia/macros/index.html
> [5] http://maven.apache.org/doxia/references/index.html
>
> > Regards,
> >
> > Hervé
> >
> > [1] http://maven.apache.org/doxia/doxia-sitetools/index.html
> >
> > Le samedi 10 septembre 2011, sebb a écrit :
> >> On 10 September 2011 05:01, Lukas Theussl <lt...@apache.org> wrote:
> >> > http://maven.apache.org/plugins/maven-site-plugin/examples/creating-co
> >> > nte nt.html#Filtering
> >>
> >> I see, thanks.
> >>
> >> Perhaps there should be a link to that from the Doxia Plugin site ...
> >>
> >> > HTH,
> >> > -Lukas
> >> >
> >> > sebb wrote:
> >> >> Is it possible to reference Maven properties in APT documents? or
> >> >> environment variables?
> >> >>
> >> >> ---------------------------------------------------------------------
> >> >> 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
> >>
> >> ---------------------------------------------------------------------
> >> 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
>
> ---------------------------------------------------------------------
> 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: Doxia APT - possible to reference Maven properties?
Posted by sebb <se...@gmail.com>.
On 10 September 2011 15:49, Hervé BOUTEMY <he...@free.fr> wrote:
> yes, there should be some documentation in Doxia site
>
> the Velocity templating feature is in Doxia Site Tools (doxia-site-renderer
> and doxia-doc-renderer), not Doxia Core: the doc should go in [1]
I've no idea what [1] means.
> if you have an idea of the way to document it in a way that people will find...
I did a search for APT, and found [2] and [3]; also looked at macros
[4] (I'd hoped there would be a property or variable macro)
The general format page [5] might also be a good place.
Perhaps add a line ot each to say that the file can be pre-processed
by velocity (and link to the page about that) before it is handed to
the specific input processor.
[2] http://maven.apache.org/doxia/references/apt-format.html
[3] http://maven.apache.org/doxia/references/doxia-apt.html
[4] http://maven.apache.org/doxia/macros/index.html
[5] http://maven.apache.org/doxia/references/index.html
> Regards,
>
> Hervé
>
> [1] http://maven.apache.org/doxia/doxia-sitetools/index.html
>
> Le samedi 10 septembre 2011, sebb a écrit :
>> On 10 September 2011 05:01, Lukas Theussl <lt...@apache.org> wrote:
>> > http://maven.apache.org/plugins/maven-site-plugin/examples/creating-conte
>> > nt.html#Filtering
>>
>> I see, thanks.
>>
>> Perhaps there should be a link to that from the Doxia Plugin site ...
>>
>> > HTH,
>> > -Lukas
>> >
>> > sebb wrote:
>> >> Is it possible to reference Maven properties in APT documents? or
>> >> environment variables?
>> >>
>> >> ---------------------------------------------------------------------
>> >> 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
>>
>> ---------------------------------------------------------------------
>> 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
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org
Re: Doxia APT - possible to reference Maven properties?
Posted by Hervé BOUTEMY <he...@free.fr>.
yes, there should be some documentation in Doxia site
the Velocity templating feature is in Doxia Site Tools (doxia-site-renderer
and doxia-doc-renderer), not Doxia Core: the doc should go in [1]
if you have an idea of the way to document it in a way that people will find...
Regards,
Hervé
[1] http://maven.apache.org/doxia/doxia-sitetools/index.html
Le samedi 10 septembre 2011, sebb a écrit :
> On 10 September 2011 05:01, Lukas Theussl <lt...@apache.org> wrote:
> > http://maven.apache.org/plugins/maven-site-plugin/examples/creating-conte
> > nt.html#Filtering
>
> I see, thanks.
>
> Perhaps there should be a link to that from the Doxia Plugin site ...
>
> > HTH,
> > -Lukas
> >
> > sebb wrote:
> >> Is it possible to reference Maven properties in APT documents? or
> >> environment variables?
> >>
> >> ---------------------------------------------------------------------
> >> 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
>
> ---------------------------------------------------------------------
> 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: Doxia APT - possible to reference Maven properties?
Posted by sebb <se...@gmail.com>.
On 10 September 2011 05:01, Lukas Theussl <lt...@apache.org> wrote:
>
> http://maven.apache.org/plugins/maven-site-plugin/examples/creating-content.html#Filtering
I see, thanks.
Perhaps there should be a link to that from the Doxia Plugin site ...
> HTH,
> -Lukas
>
>
> sebb wrote:
>>
>> Is it possible to reference Maven properties in APT documents? or
>> environment variables?
>>
>> ---------------------------------------------------------------------
>> 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
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org
Re: Doxia APT - possible to reference Maven properties?
Posted by Lukas Theussl <lt...@apache.org>.
http://maven.apache.org/plugins/maven-site-plugin/examples/creating-content.html#Filtering
HTH,
-Lukas
sebb wrote:
> Is it possible to reference Maven properties in APT documents? or
> environment variables?
>
> ---------------------------------------------------------------------
> 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