Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
wiki:contributing [2017/04/24 07:49]
claudio created
wiki:contributing [2019/09/11 08:08] (current)
claudioadmin [Contributing to the wiki]
Line 1: Line 1:
-===== Contributing to the wiki =====+====== Contributing to the wiki ======
  
 This wiki is an ongoing effort by a group of enthusiasts,​ and while is not open to the public, if you consider yourself an enthusiast and think you can contribute, feel free to contact the author of newRPL via email to request access (for email address, use hpgcc3.org as the domain, and the first name as the user). This wiki is an ongoing effort by a group of enthusiasts,​ and while is not open to the public, if you consider yourself an enthusiast and think you can contribute, feel free to contact the author of newRPL via email to request access (for email address, use hpgcc3.org as the domain, and the first name as the user).
  
-The wiki uses the dokuwiki engine. Its syntax is explained here: +The wiki uses the dokuwiki engine. Its syntax is explained here:\\ 
-[[https://​www.dokuwiki.org/​wiki:​syntax]] +[[https://​www.dokuwiki.org/​wiki:​syntax]]\\ 
-[[https://​www.dokuwiki.org/​cheatsheet]]+[[https://​www.dokuwiki.org/​cheatsheet]]\\
  
-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://​docs.mathjax.org/​en/​latest/tex.html]]+[[http://​docs.mathjax.org/​en/​latest]]\\
  
-=== 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,​ detached from the subject).   * Write as if you are writing a book, not as if you are writing an email (impersonal,​ detached from the subject).
-  * 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.+  * 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'​s a toolbar in the editor with most symbols used in the RPL language.
   * Don't cite forum posts or hpgcc3.org articles, those are considered "​internal"​ to the project, only include citations of third-party websites where appropriate.   * Don't cite forum posts or hpgcc3.org articles, those are considered "​internal"​ to the project, only include citations of third-party websites where appropriate.
 +
 +==== 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",​ should be enclosed in two single quotes %%''​VAR''​%% to be displayed as ''​VAR''​. For example: "​Variable ''​X''​ is assigned the list ''​{ 1 2 3 }''​."​
 +  * RPL code needs to be included in %%<​code>​ </​code>​%% markers.
 +  * Key press conventions are summarized in chapter 1 under [[manual:​chapter1:​notation|Notations and conventions]].
  
  
  • wiki/contributing.1493045358.txt.gz
  • Last modified: 2017/04/24 07:49
  • by claudio