Scholarly XML is a VSCode extension with a RELAX NG validator and autocomplete with features typically needed by academic encoding projects.
Unlike most XML VSCode extensions, Scholarly XML does not require Java. The extension builds on a fork of Salve, a TypeScript RELAX NG implementation. This makes Scholarly XML easy to install for use with students, in workshops, and in minimal computing projects.
To validate, your XML file needs to be associated to a RELAX NG schema via
Validation will trigger automatically when you open an XML file and when you make changes. Or you can trigger it manually like this:
Validation continues as you type and the result is shown in the status bar at the bottom.
Suggestions and documentation
Schema-aware suggestions will be made as you type elements, attributes, and attribute values. You can also bring them up like all other suggestions using Ctrl+Space.
If it's available in the schema, documentation will be shown.
Wrap selection with element
Select some text and wrap it in a tag using Ctrl+e or by bringing up the Command Palette and typing "Scholarly XML: Wrap selection with element".
For a better XML editing experience we recommend also installing the following extensions:
You can read the change log here.
Like this extension? Star it on GitHub!
Do you have an idea or suggestion? Open a feature request.
Found something wrong? File an issue.