Mailing-List: contact notifications-help@ant.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@ant.apache.org
From: bugzilla@apache.org
To: notifications@ant.apache.org
Subject: DO NOT REPLY [Bug 46797] New: Broken links in Ant manual (with
 proposed fixes)
Message-ID: <bug-46797-48744@https.issues.apache.org/bugzilla/>
Auto-Submitted: auto-generated
Content-Type: text/plain; charset="UTF-8"
MIME-Version: 1.0
Date: Tue,  3 Mar 2009 13:58:21 -0800 (PST)

https://issues.apache.org/bugzilla/show_bug.cgi?id=46797

           Summary: Broken links in Ant manual (with proposed fixes)
           Product: Ant
           Version: 1.7.1
          Platform: Macintosh
               URL: http://ant.apache.org/manual/
        OS/Version: Mac OS X 10.4
            Status: NEW
          Severity: minor
          Priority: P2
         Component: Documentation
        AssignedTo: notifications@ant.apache.org
        ReportedBy: quinntaylor@mac.com


Created an attachment (id=23325)
 --> (https://issues.apache.org/bugzilla/attachment.cgi?id=23325)
A diff of changes to fix the broken links in the Ant manual.

I downloaded the Ant manual to avoid constantly having to Google for task
definitions, especially when traveling with my laptop. During the download
(using SiteSucker, http://www.sitesucker.us) I noticed 15 reports of broken
links.

I've gone through the HTML files and fixed the broken links, plus a few other
minor fixes. The unified diff patch is attached.

Half of these are for non-existent API links, which I'll discuss in a moment. I
also want to suggest a change for the broken API links (in
base_task_classes.html and OptionalTasks/script.html). They currently point to
manual/api/... and an explanatory pseudo-error page (manual/api/index.html) is
provided to explain the problem. However, this it really only useful (online)
if a user navigates to http://ant.apache.org/manual/api/ to search for the root
of the problem; otherwise, they just get a 404.

This is fine, but it makes it more difficult to integrate the manual into my
local Ant documentation. On OS X Leopard, Ant is installed in /usr/share/ant/,
and the API Javadocs are at /usr/share/ant/docs/javadocs/. It would be really
nice if users could seamlessly install the Ant manual at
/usr/share/ant/docs/manual/ and have the API links "just work". (I'm not sure
exactly how other Ant installs are structured, but this seems fairly standard.)

The easy way to fix this is to replace all occurrences of "api/org/apache" with
"../javadocs/org/apache". The file currently at
http://ant.apache.org/manual/api/index.html could be moved to
http://ant.apache.org/javadocs/index.html to preserve continuity for online
users. (Users that download the manual will have to select where to install it
anyway, and a simple note on base_task_classes.html about where the Javadocs
are assumed to be can solve the bulk of the problem.)

-- 
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.