Hi Mark,
my application-doc.xml contains an element that encapsulates the
content, like this:
<doc xml:lang="de" title="ChangeLog">
<p>
<h3>ChangeLog</h3>
<hr/>
<ul><li>stuff</li></ul>
</p>
</doc>
With this it's working. However, I also checked the generate-wadl sample
and modified the application-doc.xml so that it looks like this
<doc xml:lang="en" title="The doc for your API">
<p>
This is a paragraph that is added to the start of the generated
application.wadl
</p>
<p>
This is a second paragraph that is added to the start of the
generated application.wadl
</p>
</doc>
The resulting application.html (via mvn package) also contained both
paragraphs.
Cheers,
Martin
On Tue, 2009-05-12 at 10:20 -0500, Rabick, Mark A (IS) wrote:
> I managed to get it to work by encoding the < (<) and > (>) below.
> I'm using the multipld <doc></doc> elements as paragraph breaks for now.
> Do you have an example application-doc.xml that has embedded html
> formatting that doesn't need to encode special characters?
>
> --mark
>
> <doc xml:lang="en" title="CNODB ReST API (WADL)">
> This document describes the available resources and data
> input/output formats available
> in the CNODB ReSTful web services application.
> </doc>
> <doc xml:lang="en">
> The context root of the application is
> <b>i3/cnodb/cdal/rest</b>
> (<i>ie. http://{server}:{port}/i3/cnodb/cdal/rest
> </i> ).
> </doc>
> <doc xml:lang="en">
> The current services available include limited querying for
> Nodes, Links and Networks by
> id, name, level, allegiance, cc, general type and specific type
> values and patterns.
> The corresponding entity attribute maps are optionally included
> with the resulting entities.
> </doc>
> <doc>
> <b>Summary of Services:</b>
> </doc>
> <doc>
> <ul>
> <li>Nodes, Links, Networks - property query (including
> attribute maps) </li>
> <li>Nodes, Links, Networks - query by sk (including attribute
> maps) </li>
> <li>NetworkMembers for Networks </li>
> <li>Legal entity types including valid general/specific pairs
> for all entity types. </li>
> <li>Attribute maps - Retrieve all, query by entity type,
> general type and specific type </li>
> <li>Country Code and Allegiance - Retrieve lists </li>
> <li>LegalValues - Retrieve all available URIs, get by name or
> sk </li>
> </ul>
> </doc>
> <doc>
> <b>Authentication:</b>
> </doc>
> <doc>
> The services Servlet is configured for HTTP Basic Authentication
> using a BASE64
> encoded string containing the userid and password. There are 2
> roles configured
> for access: CnodbUsers and CnodbAdmin. CnodbUsers have read-only
> permission and
> may only perform GET operations. CnodbAdmin users will be able to
> perform all
> implemented HTTP operations (GET,PUT,POST,DELETE). These roles
> should be configured
> on the application server.
> </doc>
>
> _______________________________________________
> Mark A. Rabick - Software Engineer
> Em: mark.rabick_at_ngc.com
>
>
>
> > -----Original Message-----
> > From: Martin Grotzke [mailto:martin.grotzke_at_freiheit.com]
> > Sent: Tuesday, May 12, 2009 2:43 AM
> > To: users_at_jersey.dev.java.net
> > Subject: Re: [Jersey] WadlGeneratorApplicationDoc file contents??
> >
> > Hi Mark,
> >
> > it definitely support multiple elements per doc element, I'm
> > using it like this.
> >
> > In your snippet below there are opening <p> elements missing.
> > Can you check if that's the reason?
> >
> > Cheers,
> > Martin
> >
> >
> > On Mon, 2009-05-11 at 17:20 -0500, Rabick, Mark A (IS) wrote:
> > > I tried adding more than 1 sentence to my
> > application-doc.xml but the
> > > generated wadl only shows the first sentence....
> > >
> > >
> > > <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
> > > <applicationDocs
> > > targetNamespace="http://research.sun.com/wadl/2006/10">
> > >
> > > <doc xml:lang="en" title="My ReST API (WADL)">
> > > This document describes the available resources and data
> > > input/output formats available
> > > in the ReSTful web services application.
> > > <p/>
> > > The context root of the application is <code>rest</code>
> > > (http://{server}:{port}/rest).
> > > <p/>
> > > The current services available include limited querying for
> > > blah... by
> > > <i>id, name</i> values and patterns.
> > > <p/>
> > > Another paragraph
> > > <p/>
> > > <h1>Summary of Services</h1>
> > > <ul>
> > > <li>Something...</li>
> > > <li>Something Else...</li>
> > > </ul>
> > > </doc>
> > > </applicationDocs>
> > >
> > > Can it support more information or just 1 sentence? I'm
> > using Jersey
> > > 1.0.3
> > >
> > > --mark
> > > _______________________________________________
> > > Mark A. Rabick
> > >
> >
> >
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe_at_jersey.dev.java.net
> For additional commands, e-mail: users-help_at_jersey.dev.java.net