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

[md2orchestra] Support purpose in documentation, appinfo element #29

Closed
donmendelson opened this issue Jul 21, 2020 · 0 comments
Closed

Comments

@donmendelson
Copy link
Member

Currently in md2orchestra, documentation element is populated without its purpose attribute. The Orchestra schema enumerates these values for purpose: synopsis, elaboration, example, and display. Tablature should support those keywords as column headers and use them to populate purpose in documentation. It can continue to map "documentation" column header to a <documentation> element without purpose attribute.

There remains the issue of what to do with columns that do not match an expected attribute. If the document writer thought it was important enough to add to rules of engagement, it should be saved somewhere in Orchestra. The <appinfo> element can be used for this. Like documentation, appinfo is a child of an annotation element, and it also has purpose attribute. Any unexpected column header can be mapped to the purpose attribute of appinfo element.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant