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/09/30 07:20] – added "lower" or "higher" to versions 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 =====
  
 It's important to make sure you're using correct spelling and grammar, but for large documentations such as this wiki it's also useful to be consistent in the spelling of Batocera-specific terminology and to be consistent in the formatting of things such as buttons and menu items. It's generally more a rule-of-thumb than a strict guideline, but should you want your edits to look higher quality you should follow these conventions: It's important to make sure you're using correct spelling and grammar, but for large documentations such as this wiki it's also useful to be consistent in the spelling of Batocera-specific terminology and to be consistent in the formatting of things such as buttons and menu items. It's generally more a rule-of-thumb than a strict guideline, but should you want your edits to look higher quality you should follow these conventions:
  
-  * 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. +  * **General spelling** 
-  * 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. +    * 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. 
-  * 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). +    * 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. 
-  * "Batocera" is a proper noun, so it should always be capitalized. For instance, this is how Batocera appears in the middle of a sentence. +    * 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). 
-  * When referring to specific Batocera versions, use "Batocera **v<version number>** and lower" or "Batocera **v<version number>** and higher", where the "**v<version number>**" is **bolded**. Batocera versions before **v29** should be referred to by the old versioning scheme (eg. Batocera **5.27**), whereas new versions should use the single-number versioning scheme (eg. Batocera **v29**). There is no Batocera **v28**. +    * "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. 
-  * "EmulationStation" is stylized by having capitals for both the "E" and "S". An accepted abbreviation of this is "ES", but try to use its full name especially when it's only mentioned once in the document. +    * When referring to specific Batocera versions, use "Batocera **v<version number>** and lower" or "Batocera **v<version number>** and higher", where the "**v<version number>**" is **bolded**. Batocera versions before **v29** should be referred to by the old versioning scheme (eg. Batocera **5.27**), whereas new versions should use the single-number versioning scheme (eg. Batocera **v29**). There is no Batocera **v28**. 
-  * Face buttons should use their graphical representation to avoid confusion, such as {{:wiki:south.png?nolink&20|South button (B SNES)}}. Refer to [[:batocera_wiki_code_snippets#graphical_elements|the Batocera-specific wiki syntax page]] on how to use it. +    * "EmulationStation" is stylized by having capitals for both the "E" and "S". An accepted abbreviation of this is "ES", but try to use its full name especially when it's only mentioned once in the document
-  * Other buttons should use path formatting (%%enclosed in ''%%) so they aren't translated by the auto-translator, be capitalized as they appear on their printed label and be enclosed in square brackets within the path formatting to differentiate it from actual paths. For example, ''[START]'', which is coded as %%''[START]''%%. +    * "Wi-Fi", "Bluetooth" are stylized proper nouns, and should always be capitalized in their stylized format. For instance, that's how the [[hardware:compatible_dongle_list|compatible Wi-Fi/Bluetooth dongle list]] handles it. 
-  * Shoulder buttons use their PlayStation format, such as ''[R1]'' and ''[L2]''. Refer to the first-tier shoulder buttons as buttons, and the second-tier triggers as triggers. +    * "RetroArch" is stylized by having capitals for both the beginning "R" and the "A" in "Arch". "RA" is not an acceptable abbreviation due to its ambiguity and should be avoided. 
-  * Due to ambiguity with ''[L3]'' and ''[R3]'', mention "pushing in" when referring to pushing in the sticks. Eg. Then push in ''[L3]'' to switch mem-pak. +    * "libretro" is stylized by only using lower-case letters. An accepted abbreviation of libretro cores this "lr-<core name>", but try to use its full name especially when it's only mentioned once in the document. "lr" by itself is not an acceptable abbreviation due to ambiguity and lack of context, and should be avoided
-  * If needing to note buttons where formatting is not available (such as in a code block), refer to the buttons by their cardinal direction followed by their equivalent SNES button in parenthesis. Eg. Press the South button (B SNES), then the START button. +  * **Paths and file extensions** 
-  * 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. +    * Paths to files/directories should always use path formatting. For example, ''/userdata/roms/psx/'', which is encoded as %%''/userdata/roms/psx/''%%. 
-  * 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. +    * Paths to directories should end with a / and paths to a file should end with their extension (if they have one). 
-  * Items selected from within menus should be enclosed in double-quotes ("). Eg. From **Audio**, select "HDMI1"+    * 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''
-  * Should you embed an image that you are not the owner of, put credits to the original work/licensing information in "less significant" wrap %%<wrap lo>%% (can be applied with the Wrap plugin button in the toolbar). For example, <wrap lo>Image illustrated by Wikimedia user [[https://commons.wikimedia.org/wiki/User:LucasVB|LucasVB]]. Licensed under [[https://creativecommons.org/licenses/by-sa/3.0/deed.en|Creative Commons]].</wrap>+    * If using a path at the end of a sentence punctuation should still be used. For example, ''/userdata/roms/psx/''
 +  * **Button labels** 
 +    * Face buttons should use their graphical representation to avoid confusion, such as {{:wiki:south.png?nolink&20|South button (B SNES)}}. Refer to [[:batocera_wiki_code_snippets#graphical_elements|the Batocera-specific wiki syntax page]] on how to use it. 
 +    * Other buttons should use path formatting (%%enclosed in ''%%) so they aren't translated by the auto-translator, be capitalized as they appear on their printed label and be enclosed in square brackets within the path formatting to differentiate it from actual paths. For example, ''[START]'', which is coded as %%''[START]''%%. 
 +    * Shoulder buttons use their PlayStation format, such as ''[R1]'' and ''[L2]''. Refer to the first-tier shoulder buttons as buttons, and the second-tier triggers as triggers. 
 +    * Due to ambiguity with ''[L3]'' and ''[R3]'', mention "pushing in" when referring to pushing in the sticks. Eg. Then push in ''[L3]'' to switch mem-pak. 
 +    * If needing to note buttons where formatting is not available (such as in a code block), refer to the buttons by their cardinal direction followed by their equivalent SNES button in parenthesis. Eg. Press the South button (B SNES), then the START button. 
 +  * **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. 
 +    * 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"
 +  * **Images** 
 +    * Should you embed an image that you are not the owner of, put credits to the original work/licensing information in "less significant" wrap %%<wrap lo>%% (can be applied with the Wrap plugin button in the toolbar). For example, <wrap lo>Image illustrated by Wikimedia user [[https://commons.wikimedia.org/wiki/User:LucasVB|LucasVB]]. Licensed under [[https://creativecommons.org/licenses/by-sa/3.0/deed.en|Creative Commons]].</wrap>
  
 ===== Tense, tone and formality ===== ===== Tense, tone and formality =====
Line 84: Line 103:
 If you've created a new page, the next job is to add a link to it to [[:sidebar|the sidebar page]]. You edit this page just like you would any other page. If you've created a new page, the next job is to add a link to it to [[:sidebar|the sidebar page]]. You edit this page just like you would any other page.
  
-  * When considering which category to put it under, avoid adding anything to **Getting Started**. Put it in the category you believe would be the one a new user would use to find the information on your page. If adding a new system page in particular, it will be automatically linked in the [[:systems|systems overview page]] (as long as you've used the correct shortname).+  * When considering which category to put it under, avoid adding anything to **Getting Started**. Put it in the category you believe would be the one a new user would use to find the information on your page. If adding a new system page in particular, it will be automatically linked in the [[:systems|systems overview page]] (as long as you've used the correct shortname) and doesn't need to be manually added.
   * Pages linked to in the sidebar should use [[:batocera_wiki_code_snippets#in-links|internal links]] with the page's proper name as the display text. The page's proper name should use regular capitalization rules, not Camel Case like the page title is on the page itself.   * Pages linked to in the sidebar should use [[:batocera_wiki_code_snippets#in-links|internal links]] with the page's proper name as the display text. The page's proper name should use regular capitalization rules, not Camel Case like the page title is on the page itself.
   * New pages should also be added to the appropriate section in the [[:navigation|navigation page]] along with a laconic description (if applicable). This is to assist those new to the wiki navigating to the appropriate page.   * New pages should also be added to the appropriate section in the [[:navigation|navigation page]] along with a laconic description (if applicable). This is to assist those new to the wiki navigating to the appropriate page.
Line 180: Line 199:
  
 Compare it to how other similar pages have done it! The beauty of the wiki is that you will be covering information that hasn't been covered before, so there may not be a consistent formatting for it yet. Look at how other, similar-enough pages have formatted their information and take it from there. Compare it to how other similar pages have done it! The beauty of the wiki is that you will be covering information that hasn't been covered before, so there may not be a consistent formatting for it yet. Look at how other, similar-enough pages have formatted their information and take it from there.
 +
 +For making a new system page specifically, you can follow [[playground:systems:template|the system template in the playground]].
  
  • wiki/wiki-editing-practices.1632979217.txt.gz
  • Last modified: 3 years ago
  • by atari