User:Sam Hemelryk/Output 2.8 GDM reference: Difference between revisions
From MoodleDocs
Sam Hemelryk (talk | contribs) (Created page with "==General developer meeting output summary== Is the start of a large movement to organise and improve output in Moodle. Overall project goals: # Output documentation. # Adop...") |
Sam Hemelryk (talk | contribs) No edit summary |
||
| Line 4: | Line 4: | ||
Overall project goals: | Overall project goals: | ||
# Adoption + creation of elements. | # Adoption + creation of elements. | ||
# Addition of element library. | # Addition of element library. | ||
# Output documentation. | |||
==The specification== | |||
* The [[Render library specification]] is the spec document for these output changes. | |||
* [https://moodle.org/mod/forum/discuss.php?d=261202 Forum discussion on the spec] to see how things have evolved. | |||
==Elements and Atomic design== | |||
==The element library== | |||
==Documentation== | ==Documentation== | ||
==Renderer best practices== | ===Renderer best practices=== | ||
A [[Renderer best practices]] document has been started to aid people in writing better renderers. | A [[Renderer best practices]] document has been started to aid people in writing better renderers. | ||
| Line 22: | Line 27: | ||
To summarise some key ideas that have come through it: | To summarise some key ideas that have come through it: | ||
==Element HTML and CSS guidelines== | ===Element HTML and CSS guidelines=== | ||
An [[Element HTML and CSS guidelines]] document has been started outlining a style guide for writing HTML and CSS for elements.<br /> | An [[Element HTML and CSS guidelines]] document has been started outlining a style guide for writing HTML and CSS for elements.<br /> | ||
| Line 30: | Line 35: | ||
==Guide to creating output elements== | ===Guide to creating output elements=== | ||
A document has been written already on how to write an output element.<br /> | A document titled [[Guide to creating output elements]] has been written already on how to write an output element.<br /> | ||
This will aid us and others in writing consistent elements that conform to the ideals we have chosen. | This will aid us and others in writing consistent elements that conform to the ideals we have chosen. | ||
==Relevant links== | |||
'''Docs pages''' | |||
* [[Render library specification]] | |||
* [[Output element planning]] | |||
* [[Renderer best practices]] | |||
* [[Guide to creating output elements]] | |||
* [[Element HTML and CSS guidelines]] | |||
* [[Element Library]] | |||
'''Tracker issues''' | |||
* MDL-45770 Stage 1 epic (see [[Render library specification]]) | |||
* MDL-45827 Spec the element library (see [[Element Library]]) | |||
* MDL-45828 Create the element library | |||
* MDL-45829 Initial elements (see [[Output element planning]]) | |||
* MDL-45853 Document renderer best practices (see [[Renderer best practices]]) | |||
* MDL-45830 Document CSS style guide for elements (see [[Element HTML and CSS guidelines]]) | |||
* MDL-45885 Design and document elements (see [[Guide to creating output elements]]) | |||
* MDL-45854 Document JS and how it works with elements. | |||
Revision as of 11:56, 22 July 2014
General developer meeting output summary
Is the start of a large movement to organise and improve output in Moodle.
Overall project goals:
- Adoption + creation of elements.
- Addition of element library.
- Output documentation.
The specification
- The Render library specification is the spec document for these output changes.
- Forum discussion on the spec to see how things have evolved.
Elements and Atomic design
The element library
Documentation
Renderer best practices
A Renderer best practices document has been started to aid people in writing better renderers.
To summarise some key ideas that have come through it:
Element HTML and CSS guidelines
An Element HTML and CSS guidelines document has been started outlining a style guide for writing HTML and CSS for elements.
Important to note that this document is not intended to be applied outside of elements at present. As we are hoping to move entirely towards elements one day this will be the HTML and CSS guide for Moodle. However it will not be enforced in current output, its use may be recommended.
Key ideas in this document include:
Guide to creating output elements
A document titled Guide to creating output elements has been written already on how to write an output element.
This will aid us and others in writing consistent elements that conform to the ideals we have chosen.
Relevant links
Docs pages
- Render library specification
- Output element planning
- Renderer best practices
- Guide to creating output elements
- Element HTML and CSS guidelines
- Element Library
Tracker issues
- MDL-45770 Stage 1 epic (see Render library specification)
- MDL-45827 Spec the element library (see Element Library)
- MDL-45828 Create the element library
- MDL-45829 Initial elements (see Output element planning)
- MDL-45853 Document renderer best practices (see Renderer best practices)
- MDL-45830 Document CSS style guide for elements (see Element HTML and CSS guidelines)
- MDL-45885 Design and document elements (see Guide to creating output elements)
- MDL-45854 Document JS and how it works with elements.
