You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@maven.apache.org by Marco Huber <mh...@project-team.de> on 2008/01/25 17:58:35 UTC
Using wiki-style syntax for documentation
Hi all,
Is there the possibility to use a wiki-styled syntax for the
documentation on an project. As I know maven2 uses apt, xdoc or fml out
of the box.
On the doxia web site there is a module guide with other markup language
like latex, confluence, pdf or twiki which are supported, but I get no
information, if they are only supported for the output or also can be
used as input markup.
Have someone used other markup to document his/her project, especally a
wiki-styled syntax?
Thanks in advance.
Marco
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org
Re: Using wiki-style syntax for documentation
Posted by Marco Huber <mh...@project-team.de>.
Thank you Lukas,
you gave me (literally) the missing links ;-)
I didn't know that I must configure the site plugin using twiki or
confluence, nor I found the information which [2] gave me on the doxia
page. Maybe it would be good to add this article as external resources
or add a page how to configure the plugin for the modules doxia doesn't
support out of the box.
Thanks again
Marco
Lukas Theussl wrote:
> There is a table on the doxia site that indicates the detailed
> parser/sink support [1].
>
> In particular for wiki style markup there is a confluence and a twiki
> parser, an xwiki module is currently in the works. I am not up to date
> about how well they are supported, but the original author of the twiki
> module has posted instructions about it's usage [2] and a lot of work
> has gone into the confluence parser in the current development version
> of doxia [3].
>
> HTH,
> -Lukas
>
>
> [1] http://maven.apache.org/doxia/references/index.html
> [2] http://juan.zauber.com.ar/2007/10/28/maven-site-twiki
> [3]
> http://jira.codehaus.org/browse/DOXIA?report=com.atlassian.jira.plugin.system.project:roadmap-panel
>
>
> Marco Huber wrote:
>> Hi all,
>>
>> Is there the possibility to use a wiki-styled syntax for the
>> documentation on an project. As I know maven2 uses apt, xdoc or fml
>> out of the box.
>>
>> On the doxia web site there is a module guide with other markup
>> language like latex, confluence, pdf or twiki which are supported, but
>> I get no information, if they are only supported for the output or
>> also can be used as input markup.
>>
>> Have someone used other markup to document his/her project, especally
>> a wiki-styled syntax?
>>
>> Thanks in advance.
>>
>> Marco
>>
>> ---------------------------------------------------------------------
>> 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: Using wiki-style syntax for documentation
Posted by Lukas Theussl <lt...@apache.org>.
There is a table on the doxia site that indicates the detailed
parser/sink support [1].
In particular for wiki style markup there is a confluence and a twiki
parser, an xwiki module is currently in the works. I am not up to date
about how well they are supported, but the original author of the twiki
module has posted instructions about it's usage [2] and a lot of work
has gone into the confluence parser in the current development version
of doxia [3].
HTH,
-Lukas
[1] http://maven.apache.org/doxia/references/index.html
[2] http://juan.zauber.com.ar/2007/10/28/maven-site-twiki
[3]
http://jira.codehaus.org/browse/DOXIA?report=com.atlassian.jira.plugin.system.project:roadmap-panel
Marco Huber wrote:
> Hi all,
>
> Is there the possibility to use a wiki-styled syntax for the
> documentation on an project. As I know maven2 uses apt, xdoc or fml out
> of the box.
>
> On the doxia web site there is a module guide with other markup language
> like latex, confluence, pdf or twiki which are supported, but I get no
> information, if they are only supported for the output or also can be
> used as input markup.
>
> Have someone used other markup to document his/her project, especally a
> wiki-styled syntax?
>
> Thanks in advance.
>
> Marco
>
> ---------------------------------------------------------------------
> 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