Hello,

----- Original Message -----
From: "Geir Magnusson Jr." <[EMAIL PROTECTED]>
Date: Monday, February 11, 2002 7:16 pm
Subject: Re: DVSL: broken links in xdocs/ant_task_reference.xml

> On 2/11/02 7:09 PM, "Bill Burton" <[EMAIL PROTECTED]> wrote:
> 
> > Hello,
> > 
> > There are several links in xdocs/ant_task_reference.xml which 
> expect that
> > some related Ant documentation is available in a parallel 
> directory.  Of
> > course these links are all broken.  You can see in the <head> 
> section I
> > have a <base href ... /> but the site.dvsl doesn't recognize it.
> > 
> > Should site.dvsl be modified to recognize <base href />?
> > 
> 
> It could. 
> 
> > Or,
> > 
> > Should the URL to Ant's documentation be specified as a Toolbox 
> property> and then all the links in the XML file modified to 
> reference this
> > property.  For example, add something like this to the build.xml:
> > 
> >  <property name="ant.manual.url"
> > value="http://jakarta.apache.org/ant/manual"; />
> >  ...
> >  <dvsl ...>
> >      <tool name="toolbox.string.ant_manual_url"
> > value="${ant.manual.url}" />
> >  </dvsl>
> > 
> >  Then, in xdocs/ant_task_reference.xml, modify links to Ant docs 
> like:>      href="$toolbox.ant_manual_url/CoreTypes/fileset.html"
> 
> Not great, but not bad.

I would like it better if $ant_manual_url could be used instead of
$toolbox.ant_manual_url.  Does the Toolbox support creating variables in
this manner instead of them all existing under a single context?

> > Or, 
> > 
> > Copy and reformat some of the files linked to in the Ant docs and 
> reformat> into XML.  However, any links in those files should 
> reference the Ant
> > site.  Although it's better to not duplicate Ant docs, it would 
> be a nice
> > demonstration of how DVSL could be used to format the Ant manual. 
> Each of
> > these files could have a link to the current version on the Ant 
> site so
> > the latest version is just a click away.
> 
> To me, the upside of doing this means we can make up some dvsl 
> match rules
> for ant docs (to help them convert)
> 
> The downside is, as you note, being out of sych with ant.

I don't think this is an issue at present as the public docs are based
on the 1.4.1 release.  It doesn't seem as a 1.5 release is in the works
anytime soon so we would be okay for a while.

> I guess we can still develop the match rules (since we have our own 
> anttask)  and keeps it maintenance free if we don't have to track 
> the ant docs.

Yes, however it's better to have more representative files to work with. 

> Maybe #2 is the way.

I'm thinking a combination of #2 and #3.  If nothing else, the converted
files can be considered as examples.  I'll try and convert a couple of
the more important links.  What I'll do is put something like this near
the top of each file:

    "This page was converted from the corresponding HTML version in the
Ant 1.4.1 release as a convenience to have it locally available and as a
demonstration of capabilities of DVSL.  The currently available version
of this page from the Ant release can be viewed at
http://jakarta.apache.org/ant/manual/CoreTasks/XXXX.html.";

-Bill



--
To unsubscribe, e-mail:   <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>

Reply via email to