Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mention plugin.rnc in the docs #61

Closed
stefan-jung opened this issue Jan 26, 2016 · 3 comments
Closed

Mention plugin.rnc in the docs #61

stefan-jung opened this issue Jan 26, 2016 · 3 comments
Assignees
Labels
enhancement Changes to an existing topic or feature
Projects
Milestone

Comments

@stefan-jung
Copy link
Contributor

There is a Relax NG schema (plugin.rnc) that can be used to validate plugin.xml files. This schema should be mentioned in the Plug-in configuration file topic.

@infotexture infotexture added the enhancement Changes to an existing topic or feature label Feb 4, 2016
@infotexture
Copy link
Member

This one's been open for a while.

@xephon2 Could you submit a PR with information on how this is used?

@stefan-jung
Copy link
Contributor Author

Raised PR #175

@infotexture
Copy link
Member

Apart from the XML validation errors in #175, I don't think it's enough to just paste a codeblock that contains the .rnc reference.

I do think it makes sense to provide information on this file and how it is used, but that may be better provided in a separate section or topic on ”Validating plug-in descriptor files” (or similar).

So worth doing 👍, but will require a bit more effort.

We'd also need to clarify whether any other editors (apart from oXygen) provide the necessary XML Catalog entries to automatically validate files based on the Schema reference in the processing instruction:

<?xml-model href="dita-ot/plugin.rnc" type="application/relax-ng-compact-syntax"?>

For future reference: See dita-ot/dita-ot#1757 for background information and history.

@infotexture infotexture added this to the 3.2 milestone Oct 6, 2018
@infotexture infotexture added this to To do in 3.2 Oct 6, 2018
infotexture added a commit that referenced this issue Oct 10, 2018
Use relative path to bundled `plugin.rnc` from `docsrc/samples/plugins/…/` to support validation per #61.

Signed-off-by: Roger Sheen <roger@infotexture.net>
3.2 automation moved this from To do to Done Oct 19, 2018
infotexture added a commit that referenced this issue Oct 21, 2018
Per #61

Signed-off-by: Roger Sheen <roger@infotexture.net>
@infotexture infotexture self-assigned this Oct 22, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Changes to an existing topic or feature
Projects
No open projects
3.2
  
Done
Development

No branches or pull requests

2 participants