openpreserve / jhove

File validation and characterisation.
http://jhove.openpreservation.org
Other
171 stars 79 forks source link

Change anchors in wiki hul messages to more predictable ones #859

Open RvanVeenendaal opened 1 year ago

RvanVeenendaal commented 1 year ago

When working on definitions, explanations, etc. of JHOVE error messages, it is useful to be able to link to JHOVE's hul error ID wiki pages. But the anchors on those pages are difficult to automatically 'predict'. Could you please change the anchors to reflect that they belong to an ID and together?

In e.g. the JPEG-hul there is an entry for https://github.com/openpreserve/jhove/wiki/JPEG-hul-Messages#jpeg-hul-5. In that section there are anchors for Message, Details, Impact and Remediation. Their anchors are:

While these anchors are predictable using the pattern JPEG-hul-Messages#message<ID-1>, this is more difficult when you look at the PDF-hul messages. There you have, e.g. https://github.com/openpreserve/jhove/wiki/PDF-hul-Messages-2#pdf-hul-87 with:

While one could parse the PDF-hul-Messages-2 page to find the correct anchors, it would be more user and climate friendly if anchors would be changed into a predictable pattern like .../wiki/<name>-hul-Messages#<name>-hul-<id> resulting in:

Example:

Post-submission edit: there are also 'Reference' anchors.