Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 176715

Summary:	Need a tool for checking the links in Eclipse tables of contents (TOC)
Product:	[Eclipse Project] PDE	Reporter:	Fei Min <feimin.lorente>
Component:	UI	Assignee:	PDE-UI-Inbox <pde-ui-inbox>
Status:	CLOSED DUPLICATE	QA Contact:
Severity:	enhancement
Priority:	P3	CC:	ankur_sharma, caniszczyk, curtis.windatt.public, curtispd, dash.alpha
Version:	3.3
Target Milestone:	---
Hardware:	PC
OS:	Windows XP
Whiteboard:

Description Fei Min

2007-03-08 10:45:52 EST

I'd like a tool to check that the href attributes of topic elements point to valid files. There are enough HTML checkers out there that I'm not worried about my HTML links, but since that XML DTD is peculiar to Eclipse, there isn't an off-the-shelf solution to ensuring that all those links work. If they don't, they render some of one's documentation inaccessible, so it's pretty serious. It would have to be case-sensitive, too.

I've been told that if I run an index, it will give me a problem report that identifies invalid links, but I'm not getting such a report. If you can tell me how to get this report, I won't need a link checker.

If you want to check the links from the plugin.xml file to the TOC file for each manual (because it lists all the manual's TOCs in that plugin), and pick up the toc.xml file along the way, that would be extra special.

Comment 1 Curtis d'Entremont

2007-03-13 10:43:00 EDT

During search indexing, help will crawl through your toc and index all the docs, and will log an error to the eclipse log (workspace/.metadata/.log) if it encountered any problems, like can't open a document. Indexing either occurs at build time if you pre-index your help content for fast searching, or at run-time (when searching) if you don't pre-index.

However, tooling would help here so I'm sending this over to PDE for future consideration.

Comment 2 David Henderson

2009-08-31 12:14:58 EDT

I'd like to see a custom Validator for eclipse toc xml files that hooks in to the validation framework to solve this problem.  Should that be made into a separate bug report?

Comment 3 Curtis Windatt

2009-08-31 12:33:32 EDT

(In reply to comment #2)
> I'd like to see a custom Validator for eclipse toc xml files that hooks in to
> the validation framework to solve this problem.  Should that be made into a
> separate bug report?

To fix this, it would make sense to run a builder and create markers.  I don't see any need for a separate report.  Especially since there are no plans to work on this currently.

Comment 4 Ankur Sharma

2009-09-08 21:14:21 EDT

looks similar to bug #203065?

Comment 5 Chris Aniszczyk

2009-09-08 22:02:53 EDT

Good catch Ankur.

*** This bug has been marked as a duplicate of bug 203065 ***