Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
wiki:contributing [2017/04/24 08:21] claudio |
wiki:contributing [2017/06/05 16:46] smartin [Formatting conventions] |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ===== Contributing to the wiki ===== | + | ====== Contributing to the wiki ====== |
This wiki is an ongoing effort by a group of enthusiasts, | This wiki is an ongoing effort by a group of enthusiasts, | ||
- | The wiki uses the dokuwiki engine. Its syntax is explained here: | + | The wiki uses the dokuwiki engine. Its syntax is explained here:\\ |
- | [[https:// | + | [[https:// |
- | [[https:// | + | [[https:// |
- | For mathematical formulas, it uses the Mathjax engine, its syntax is explained here: | + | For mathematical formulas, it uses the Mathjax engine, its syntax is explained here:\\ |
- | [[http:// | + | [[http:// |
- | === General Article guidelines === | + | ==== General Article guidelines ==== |
- | * Wiki articles should use heading level 2 as the highest (for section titles). | + | |
* Write as if you are writing a book, not as if you are writing an email (impersonal, | * Write as if you are writing a book, not as if you are writing an email (impersonal, | ||
* For RPL code samples, use the proper Unicode characters. In normal text, the wiki engine will replace %%<< -> >>%% with << -> >> but not inside a code block, so it's best to directly insert the proper symbol. There' | * For RPL code samples, use the proper Unicode characters. In normal text, the wiki engine will replace %%<< -> >>%% with << -> >> but not inside a code block, so it's best to directly insert the proper symbol. There' | ||
* Don't cite forum posts or hpgcc3.org articles, those are considered " | * Don't cite forum posts or hpgcc3.org articles, those are considered " | ||
+ | |||
+ | ==== Formatting conventions ==== | ||
+ | * Wiki articles should use heading level 2 as the highest (for section titles, level 2 has 5 equal signs). | ||
+ | * Each Section with a level 2 title needs to be separated with %%----%% in a newline. This allows the automatic table of contents to kick in, and allows editing sections individually. | ||
+ | * Variables, commands, objects or anything that is presented "as shown on the calculator screen", | ||
+ | * RPL code needs to be included in %%< | ||
+ | * Key press conventions are summarized in chapter 1 under [[manual: | ||