Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
wiki:wiki-editing-practices [2021/11/22 06:56] – [Spelling and formatting] added retroarch stuff atariwiki:wiki-editing-practices [2023/03/02 23:47] (current) – old revision restored (2023/03/01 02:33) atari
Line 1: Line 1:
 ====== Good Wiki Editing Practices ====== ====== Good Wiki Editing Practices ======
 +
 +<WRAP center round tip>
 +In order to create a wiki editing account, ask for one on [[https://discord.gg/ndyUKA5|the Discord server]].
 +
 +New users will require their edits get approved by an approver first before it gets shown to the general public.
 +</WRAP>
  
 Recommended reading: https://www.dokuwiki.org/tips:good_style Recommended reading: https://www.dokuwiki.org/tips:good_style
Line 12: Line 18:
   * Can the page be put into a relevant sub-category? For example, something purely related to a single system should be appended to its relevant [[:systems|system page]].   * Can the page be put into a relevant sub-category? For example, something purely related to a single system should be appended to its relevant [[:systems|system page]].
   * Is the information somewhere else already, and if so, is it in the correct place?   * Is the information somewhere else already, and if so, is it in the correct place?
-  * Ultimately, //something// is better than **nothing**. Even if the information is not robust or high quality enough for the wiki, it's better than a complete absence of it. It can always be revisited to be amended later.+  * Ultimately, //something// is better than **nothing**. Even if the information is not robust or high quality enough for the wiki, it's better than a complete absence of it. It can always be revisited to be amended later. The playground can be used if help is needed with certain edits, without going straight to publication.
  
 Once that's all checked for, you can begin editing the wiki. Once that's all checked for, you can begin editing the wiki.
Line 24: Line 30:
 When starting out, you should use [[playground:playground|the playground]] to test things. This page is ordinarily not visible to public search engines so any changes made here are inconsequential. You can also preview your changes before committing them with the Save button, it is good practice to do this with every edit to ensure that links and embedded images are working correctly. When starting out, you should use [[playground:playground|the playground]] to test things. This page is ordinarily not visible to public search engines so any changes made here are inconsequential. You can also preview your changes before committing them with the Save button, it is good practice to do this with every edit to ensure that links and embedded images are working correctly.
  
 +If uploading images to a page in the playground, be sure to set the namespace of the image to your intended finalised namespace. Otherwise, when the page gets moved from the playground to its official namespace, all the images will not be visible to guest users!
 ===== Spelling and formatting ===== ===== Spelling and formatting =====
  
Line 30: Line 37:
   * **General spelling**   * **General spelling**
     * This wiki uses American English, so as to be approachable by the widest audience possible and to assist with the auto-translator. Spelling for words such as "color" and "bastardization" should use their American spelling. This is consistent within Batocera itself as well.     * This wiki uses American English, so as to be approachable by the widest audience possible and to assist with the auto-translator. Spelling for words such as "color" and "bastardization" should use their American spelling. This is consistent within Batocera itself as well.
-    * Level 1 title headers should be Camel Cased. Remaining headers should use standard capitalization. No period marks should appear at the end of any header.+    * Level 1 title headers should be Title Cased. Remaining headers should use standard capitalization. No period marks should appear at the end of any header.
     * Unordered bullet lists and tables should have each element end without a period mark, unless the list entries are full sentences (such as this bullet list).     * Unordered bullet lists and tables should have each element end without a period mark, unless the list entries are full sentences (such as this bullet list).
     * "Batocera" and "Buildroot" are proper nouns, so they should always be capitalized. For instance, this is how Batocera and Buildroot appear in the middle of a sentence. Batocera.linux is the full name of the project, and is usually used when referring to the [[https://github.com/batocera-linux|Github page]]. It follows standard capitalization rules. For instance, this is how batocera.linux appears in the middle of a sentence.     * "Batocera" and "Buildroot" are proper nouns, so they should always be capitalized. For instance, this is how Batocera and Buildroot appear in the middle of a sentence. Batocera.linux is the full name of the project, and is usually used when referring to the [[https://github.com/batocera-linux|Github page]]. It follows standard capitalization rules. For instance, this is how batocera.linux appears in the middle of a sentence.
Line 41: Line 48:
     * Paths to files/directories should always use path formatting. For example, ''/userdata/roms/psx/'', which is encoded as %%''/userdata/roms/psx/''%%.     * Paths to files/directories should always use path formatting. For example, ''/userdata/roms/psx/'', which is encoded as %%''/userdata/roms/psx/''%%.
     * Paths to directories should end with a / and paths to a file should end with their extension (if they have one).     * Paths to directories should end with a / and paths to a file should end with their extension (if they have one).
-    * Certain file types should be referred to by their capitalized name. For example, the ISO file. It is also acceptable to use path notation with regex to indicate what can be replaced, such as ''*.iso''.+    * Certain file types should be referred to by their capitalized name. For example, the ISO file. It is also acceptable to use path notation with wildcard characters to indicate what can be replaced, such as ''*.iso''.
     * If using a path at the end of a sentence punctuation should still be used. For example, ''/userdata/roms/psx/''.     * If using a path at the end of a sentence punctuation should still be used. For example, ''/userdata/roms/psx/''.
   * **Button labels**   * **Button labels**
Line 51: Line 58:
   * **Strings and menu items**   * **Strings and menu items**
     * Strings that need to be replaced by the user should be enclosed in less-than and greater-than symbols, followed by a single-sentence explanation of what's being replaced. Eg. Name the file ''es_systems_<system name>.xml'' where ''<system name>'' is the name of the system you want to customize.     * Strings that need to be replaced by the user should be enclosed in less-than and greater-than symbols, followed by a single-sentence explanation of what's being replaced. Eg. Name the file ''es_systems_<system name>.xml'' where ''<system name>'' is the name of the system you want to customize.
-    * Menu items should be **CAPITALIZED AS THEY APPEAR IN ES AND BOLDED**, and menu navigation directions should have menu items separated by the arrow icon (->, coded as %%->%%) enclosed in spaces. Eg. Go to **MAIN MENU** -> **SYSTEM SETTINGS** -> **AUDIO**. Camel Case is also acceptable. Just be consistent with it.+    * Menu items should be **CAPITALIZED AS THEY APPEAR IN ES AND BOLDED**, and menu navigation directions should have menu items separated by the arrow icon (->, coded as %%->%%) enclosed in spaces. Eg. Go to **MAIN MENU** -> **SYSTEM SETTINGS** -> **AUDIO**. Title Case is also acceptable. Just be consistent with it.
     * Items selected from within menus should be enclosed in double-quotes ("). Eg. From **Audio**, select "HDMI1".     * Items selected from within menus should be enclosed in double-quotes ("). Eg. From **Audio**, select "HDMI1".
   * **Images**   * **Images**
  • wiki/wiki-editing-practices.1637560618.txt.gz
  • Last modified: 2 years ago
  • by atari