You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@maven.apache.org by TomStrummer <to...@gmail.com> on 2009/03/17 15:09:30 UTC

Verbatim HTML in site documentation

Hi,  I'm trying to figure out how I can add a little HTML into a site
documentation page.  I haven't found any examples of this in the APT or XDoc
documentation.  Is it possible?  I'm actually trying to insert a little
markup for a generated PayPal "Donate" button.  

Thanks in advance.
-- 
View this message in context: http://www.nabble.com/Verbatim-HTML-in-site-documentation-tp22559536p22559536.html
Sent from the Maven - Users mailing list archive at Nabble.com.


---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org


Re: Verbatim HTML in site documentation

Posted by TomStrummer <to...@gmail.com>.
Know what?  The section on validation and block elements gave me the
impression that XDoc provided a restricted subset of HTML.  I missed where
it said any valid XHTML could be used.

I tried it and it works great.  Sorry for the confusion and thanks again for
the help.




Lukas Theussl-3 wrote:
> 
> 
> Can't you use xdoc? Xdoc is basically xhtml with some additional tags, see 
> http://maven.apache.org/doxia/references/xdoc-format.html
> 
> -Lukas
> 
> 
> TomStrummer wrote:
>> I just realized the "snippet" macro is actually not at all what I'm
>> looking
>> for.  I don't want the source of a file displayed in my document; instead
>> I
>> want to actually _render_ a piece of verbatim HTML.  So that I can i.e.
>> include a form that the user can fill out and submit.  
>> 
>> Thanks!
>> 
>> 
>> 
>> Lukas Theussl-3 wrote:
>>>>> TomStrummer wrote:
>>>>>> Hi,  I'm trying to figure out how I can add a little HTML into a site
>>>>>> documentation page.  I haven't found any examples of this in the APT
>>>>>> or
>>>>>> XDoc
>>>>>> documentation.  Is it possible?  I'm actually trying to insert a
>>>>>> little
>>>>>> markup for a generated PayPal "Donate" button.  
>>>>>>
>>>>>> Thanks in advance.
>>>>> Sounds like this issue:
>>>>>
>>>>> http://jira.codehaus.org/browse/DOXIA-142
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
> For additional commands, e-mail: users-help@maven.apache.org
> 
> 
> 

-- 
View this message in context: http://www.nabble.com/Verbatim-HTML-in-site-documentation-tp22559536p22781966.html
Sent from the Maven - Users mailing list archive at Nabble.com.


---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org


Re: Verbatim HTML in site documentation

Posted by Lukas Theussl <lt...@apache.org>.
Can't you use xdoc? Xdoc is basically xhtml with some additional tags, see 
http://maven.apache.org/doxia/references/xdoc-format.html

-Lukas


TomStrummer wrote:
> I just realized the "snippet" macro is actually not at all what I'm looking
> for.  I don't want the source of a file displayed in my document; instead I
> want to actually _render_ a piece of verbatim HTML.  So that I can i.e.
> include a form that the user can fill out and submit.  
> 
> Thanks!
> 
> 
> 
> Lukas Theussl-3 wrote:
>>>> TomStrummer wrote:
>>>>> Hi,  I'm trying to figure out how I can add a little HTML into a site
>>>>> documentation page.  I haven't found any examples of this in the APT or
>>>>> XDoc
>>>>> documentation.  Is it possible?  I'm actually trying to insert a little
>>>>> markup for a generated PayPal "Donate" button.  
>>>>>
>>>>> Thanks in advance.
>>>> Sounds like this issue:
>>>>
>>>> http://jira.codehaus.org/browse/DOXIA-142

---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org


Re: Verbatim HTML in site documentation

Posted by TomStrummer <to...@gmail.com>.
I just realized the "snippet" macro is actually not at all what I'm looking
for.  I don't want the source of a file displayed in my document; instead I
want to actually _render_ a piece of verbatim HTML.  So that I can i.e.
include a form that the user can fill out and submit.  

Thanks!



Lukas Theussl-3 wrote:
> 
>>> TomStrummer wrote:
>>>> Hi,  I'm trying to figure out how I can add a little HTML into a site
>>>> documentation page.  I haven't found any examples of this in the APT or
>>>> XDoc
>>>> documentation.  Is it possible?  I'm actually trying to insert a little
>>>> markup for a generated PayPal "Donate" button.  
>>>>
>>>> Thanks in advance.
>>> Sounds like this issue:
>>>
>>> http://jira.codehaus.org/browse/DOXIA-142
> 
-- 
View this message in context: http://www.nabble.com/Verbatim-HTML-in-site-documentation-tp22559536p22749025.html
Sent from the Maven - Users mailing list archive at Nabble.com.


---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org


Re: Verbatim HTML in site documentation

Posted by Lukas Theussl <lt...@apache.org>.
There is a snapshot deployed (version 2.1-SNAPSHOT) but it requires maven 2.1
(currently being voted on, should be released next week).

Cheers,
-Lukas


TomStrummer wrote:
> Thanks Dennis.  That's exactly what I'm looking for.  So there's no snapshot
> release of the site plugin that uses Doxia 1.1?
> 
> Thanks again.
> 
> -Tom
> 
> 
> dennisl-2 wrote:
>> TomStrummer wrote:
>>> Hi,  I'm trying to figure out how I can add a little HTML into a site
>>> documentation page.  I haven't found any examples of this in the APT or
>>> XDoc
>>> documentation.  Is it possible?  I'm actually trying to insert a little
>>> markup for a generated PayPal "Donate" button.  
>>>
>>> Thanks in advance.
>> Sounds like this issue:
>>
>> http://jira.codehaus.org/browse/DOXIA-142
>>
>> Note that this was fixed in Doxia 1.1. The Site Plugin 2.0 uses Doxia
>> 1.0. There is a branch in svn for a Site Plugin that uses Doxia 1.1, but
>> it hasn't been released.
>>
>> http://svn.eu.apache.org/repos/asf/maven/plugins/branches/maven-site-plugin-doxia-1.1/
>>
>> -- 
>> Dennis Lundberg
>>
>> ---------------------------------------------------------------------
>> 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: Verbatim HTML in site documentation

Posted by TomStrummer <to...@gmail.com>.
Thanks Dennis.  That's exactly what I'm looking for.  So there's no snapshot
release of the site plugin that uses Doxia 1.1?

Thanks again.

-Tom


dennisl-2 wrote:
> 
> TomStrummer wrote:
>> Hi,  I'm trying to figure out how I can add a little HTML into a site
>> documentation page.  I haven't found any examples of this in the APT or
>> XDoc
>> documentation.  Is it possible?  I'm actually trying to insert a little
>> markup for a generated PayPal "Donate" button.  
>> 
>> Thanks in advance.
> 
> Sounds like this issue:
> 
> http://jira.codehaus.org/browse/DOXIA-142
> 
> Note that this was fixed in Doxia 1.1. The Site Plugin 2.0 uses Doxia
> 1.0. There is a branch in svn for a Site Plugin that uses Doxia 1.1, but
> it hasn't been released.
> 
> http://svn.eu.apache.org/repos/asf/maven/plugins/branches/maven-site-plugin-doxia-1.1/
> 
> -- 
> Dennis Lundberg
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
> For additional commands, e-mail: users-help@maven.apache.org
> 
> 
> 

-- 
View this message in context: http://www.nabble.com/Verbatim-HTML-in-site-documentation-tp22559536p22567148.html
Sent from the Maven - Users mailing list archive at Nabble.com.


---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org


Re: Verbatim HTML in site documentation

Posted by Dennis Lundberg <de...@apache.org>.
TomStrummer wrote:
> Hi,  I'm trying to figure out how I can add a little HTML into a site
> documentation page.  I haven't found any examples of this in the APT or XDoc
> documentation.  Is it possible?  I'm actually trying to insert a little
> markup for a generated PayPal "Donate" button.  
> 
> Thanks in advance.

Sounds like this issue:

http://jira.codehaus.org/browse/DOXIA-142

Note that this was fixed in Doxia 1.1. The Site Plugin 2.0 uses Doxia
1.0. There is a branch in svn for a Site Plugin that uses Doxia 1.1, but
it hasn't been released.

http://svn.eu.apache.org/repos/asf/maven/plugins/branches/maven-site-plugin-doxia-1.1/

-- 
Dennis Lundberg

---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org