MDN/Projects/Development/Diagramming tool: Difference between revisions
< MDN | Projects | Development
Jump to navigation
Jump to search
(Created page with "This is a proposed plan for a project to add a drawing/diagramming tool to the MDN wiki powered by [https://github.com/mozilla/kuma/ Kuma]. It's a longer-term project; somethi...") |
No edit summary |
||
| Line 10: | Line 10: | ||
# Support for editing new or existing diagrams. | # Support for editing new or existing diagrams. | ||
# Keep the editor's native file around for updating or localizing. | # Keep the editor's native file around for updating or localizing. | ||
See [bug|1069343] for status etc. | |||
==Goals== | ==Goals== | ||
Revision as of 14:13, 18 September 2014
This is a proposed plan for a project to add a drawing/diagramming tool to the MDN wiki powered by Kuma. It's a longer-term project; something very useful, but not urgent.
Project statement
The goal of this project is to improve our documentation by making it both easier to create diagrams and making it easier to update and localize them by having the diagrams' source file available (by saving it alongside the output SVG or PNG file).
Features desired:
- Ability to insert an existing or new diagram into an article at any place.
- Ability to specify the size to draw the diagram at.
- Support for editing new or existing diagrams.
- Keep the editor's native file around for updating or localizing.
See [bug|1069343] for status etc.
Goals
- Improve content by making it easy to create, insert, update, and translate diagrams.
- Improve standardization of diagrams' appearance using diagram templates or predefined styles.
Inspirations
Additional thoughts and requirements
Development resources
- Consider using the editor behind https://draw.io/ -- mxGraph. This is a fantastic JavaScript based editor which can output SVG and PNG, and can be hacked on to integrate it with MDN better.