wiki:contributing

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
wiki:contributing [2021/09/29 10:17]
jojo1973 Redone 		wiki:contributing [2021/09/29 10:22] (current)
jojo1973
Line 3: Line 3:
 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).
  
 +----
 +
 +===== Resources =====
 The wiki uses the [[https://www.dokuwiki.org/dokuwiki|DokuWiki]] engine. Some useful resources are: The wiki uses the [[https://www.dokuwiki.org/dokuwiki|DokuWiki]] engine. Some useful resources are:
   * the [[https://newrpl.wiki.hpgcc3.org/doku.php?id=wiki:syntax|syntax]] documentation;   * the [[https://newrpl.wiki.hpgcc3.org/doku.php?id=wiki:syntax|syntax]] documentation;
Line 11: Line 14:
  
 ---- ----
-==== Formatting conventions ====+ 
 +===== Formatting conventions =====
   * Wiki articles should use heading level 2 as the highest (for section titles, level 2 has 5 equal signs);   * 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;   * 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;
Line 19: Line 23:
  
 ---- ----
-==== General article guidelines ====+ 
 +===== General article guidelines =====
   * 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. There's a toolbar in the editor with most symbols used in the RPL language;   * 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.
  
  • wiki/contributing.1632935874.txt.gz
  • Last modified: 2021/09/29 10:17
  • by jojo1973