Alter DITA validation to ignore ISO Schematron warning

[steinbacherGE]

When we run DITA map validation, we get some warnings that we don’t care about, and they really clutter up the results. We aren’t going to fix them, so it would be better to just not report them at all. (I also wonder if the map validation would be faster if we didn’t check for these? That would be nice)

Example:
ISO Schematron
warning
Please remove the "p" element and place its text directly in the note. If there is just one block of text in the note, then the note should be left as string-only. This stores the minimum of mark-up, and simplifies the processed output. If there are multiple blocks in the note, then paragraphs, lists (or other block elements) should be used.

Our transformation puts anything it finds in a note in a <p> for various reasons. In the validation we just ran on a medium sized pub, it gave us 1264 of these.

[Radu]

Hi,

We have on the Oxygen XML Blog a small article about adding your own Schematron rules for DITA editing and then sharing them with others:

http://blog.oxygenxml.com/2017/02/shari ... rules.html

As you want the other way around, you should skip steps 2, 3 and in step 7 instead of adding a new validation stage, remove the validation stage from the default DITA validation scenario which validates using OXYGEN_INSTALL_DIR\frameworks\dita\styleguide\rules\styleguide.sch.
We'll consider removing also by default this validation rule. I'm not a big fan about telling our users how they should write their docs, as long as the documentation is valid according to the DITA standard.

Regards,
Radu

[cbrzeski]

Thanks Radu! Leroy is my colleague so I'm interested in this too. A follow-up question: How would we distribute the updated validation rules to our global authors?

Thanks
Corinne

[Radu]

Hi Corinne,

At the end of the blog post I gave you it says:

There are several methods for sharing the framework and you can read about them here:
https://www.oxygenxml.com/doc/versions/ ... aring.html.

Regards,
Radu

[cbrzeski]

Oh, thanks. I missed that.

[Radu]

Hi,

Just to update this thread, we released Oxygen 20.1 which should no longer report these warnings by default.

Regards,
Radu