enlightenment/www-content
enlightenment
/
www-content
6
0
Fork 2
Code Issues Pull Requests 1 Projects Releases Wiki Activity

Wiki page documentation-guide.md changed with summary [] by Gareth Halfacree

This commit is contained in:
Gareth Halfacree 2017-11-07 06:54:20 -08:00 committed by apache
parent f91627356e
commit c5632499ed
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
pages/contrib/docs/documentation-guide.md.txt
View File

@ -135,6 +135,8 @@ Where a code block contains extracts from a larger program it should follow the
Where referencing code within a paragraph of documentation, use paired double-backticks (\`\`) to format the reference as in-line code. Writing \`\`-EINVAL;\`\`, for example, will render as ``-EINVAL;``.
When referencing a method in a document always include the parentheses that go with it: ``efl_add()`` rather than ``efl_add``, for example.
For information on the formatting of the code itself, please consult the [Coding Convention Guide](https://phab.enlightenment.org/w/coding_convention/).
### Table Formatting ###
@ -262,7 +264,11 @@ Note that these pages are in DokuWiki markup format, not Markdown Extra. Each en
## Programming Tutorials ##
Programming tutorials, and other hands-on educational documentation, require a specific approach in order to be both accessible and informative. The template below demonstrates a rough approach to which you should adhere:
Programming tutorials, and other hands-on educational documentation, require a specific approach in order to be both accessible and informative. As with all other documentation, programming tutorials must be written in American English and in the second person active voice, present tense. If using a text editor with spell-checking capabilities, please install an American English dictionary. Additionally, treat the Enlightenment Foundation Libraries (EFL) as a collective noun and refer to it as a singular entity using "is" rather than "are".
Particular care should be taken that programming tutorials adhere to the guidelines in the [Code Formatting section](#Code_Formatting) of this guide, and any freshly-written code follows the [Coding Conventions](https://www.enlightenment.org/contrib/devs/coding-conventions.md).
The template below demonstrates a rough approach to which you should adhere where possible:
````markdown
---