aldaris / docbook-linktester

Tests external links and olinks in DocBook documentation for validity
3 stars 1 forks source link

RFE: Ignore some URLs by default #2

Closed markcraig closed 11 years ago

markcraig commented 11 years ago

It would be cool if docbook-linktester could ignore well-formed links to JIRA by default, for example. In other words, skip links like https://bugster.forgerock.org/jira/browse/OPENAM-1234. Release notes tend to include long lists of these kinds of links, lists which are initially generated from a query anyway. So either they're all wrong, or none of them are wrong.

<skipJIRA>true</skipJIRA> <!-- recommended default -->

If this would make the linkchecker too dependent on a particular format, perhaps instead of <skipJIRA> it could be <skipMatches> with a <urlPatterns> that takes a set of URL Patterns to match.

aldaris commented 11 years ago

Sounds reasonable, I guess I should have thought of that while implementing skipUrls/skipOlinks. :) I'll move towards the more generic fix I think.

aldaris commented 11 years ago

This should be implemented now, please check the README for usage details. ;)