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 [2023/01/28 09:13] – [Practicing] caveat about using the playground atariwiki:wiki-editing-practices [2024/07/10 02:55] (current) – [Managing the sidebar] it is not automatically linked (anymore) atari
Line 2: Line 2:
  
 <WRAP center round tip> <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. New users will require their edits get approved by an approver first before it gets shown to the general public.
 </WRAP> </WRAP>
Line 16: 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 35: 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 46: 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 56: 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**
Line 101: 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) and doesn't need to be manually added.+  * 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, link it in the [[:systems|systems overview page]] instead of the sidebar.
   * 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.
  • wiki/wiki-editing-practices.1674897227.txt.gz
  • Last modified: 3 years ago
  • by atari