Skip to content

Commit 3f8a2dc

Browse files
committed
doc(readme): explain new validation mode
1 parent c5006ae commit 3f8a2dc

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,9 @@ Should you encounter documentation for features that are deprecated in the minim
4242

4343
### Unit tests
4444
The full test-suite consists of validation, unit, and integration tests, it runs automatically on travis. To be able to run integration tests locally, contributors should run `npm i` to download and install [cypress.js](https://www.cypress.io). This is only required once. To execute the tests run the following commands:
45-
- To validate xml files run `mvn validate`,
45+
- To validate article files run `mvn validate`,
46+
- Validation uses both the official `docbook.rng` and our own `exist-docs.rng` (experimental) schema.
47+
- The schema files are located at: `src/main/relaxng`
4648
- to run the javascript or XQSuite unit tests run: `mvn test`. We do **not** support testing via node alone, aka `npm test`, use the maven command instead.
4749
- To run the Integrations tests, however, use `npm run cypress`.
4850

src/main/xar-resources/data/author-reference/listings/structure.xml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@
99
1Q18
1010
</date>
1111
<keywordset>
12-
<keyword>blah</keyword>
12+
<keyword>
13+
blah
14+
</keyword>
1315
</keywordset>
1416
</info>
1517
<para>

0 commit comments

Comments
 (0)