I have seen earlier requests for this in the discussions, but I did not find an answer. So I am trying to revive the question. Is anyone working on a documentation language which provides basic markup similar to HTML? If not is anyone interested in helping me develop one?
Here are my (non-exhaustive) requirements:
- basic markup without language-specific extensions. A small set of markup concepts (i.e. more HTML-like than Docbook-like)
- strict separation of structure and presentation
- strict rules so texts will have a uniform structure:
- hierarchical section levels
- ancestors and descendants (e.g. strong inside a strong at any depth is not allowed)
- be able to extend it with documentation elements specific for a language (e.g. links to types or members in Javadoc)
- have multiple root concepts:
- complete document
- single section at a specific level (e.g. an h3 with its associated content)
- content of a section at a specific level. The content can only contain headings for lower levels (e.g. used for body text of Javadoc assuming that the heading itself for that level is generated by the Javadoc tool)
- inline items only (used for text of param and return tags in Javadoc)
- reasonably user-friendly editors. I understand a WYSIWYG or even a WYSIWYM editor can probably not be built, but it shouldn't be too cumbersome to read/edit text
I already have a tiny prototype of a documentation language, but unfortunately I can't get it working as I want to (largely due to lack of experience with MPS). So before putting a lot more effort into it I would like to know if it is possible to build a documentation using MPS as it is now. And if it is possible, I would like to know if it is smart to do it by creating a language, or that it would be much better to simply add a HTML editor component to an editor and let that do all the heavy lifting.