Style Guide: Difference between revisions
Makerspace (talk | contribs) (Created page with "This is a guide to how pages on the wiki should be created and written, in order to keep things consistent. == Page Names & Titles == * Page names and titles, when relating to equipment, includes only the equipment name and model number not the particular type of equipment it is. An exception to this would be if this is included in the manufacturer's model name. ** "Haas UMC-500" ''not'' "Haas UMC-500 5-axis CNC Mill" ** "Bambu Lab X1E" ''not'' "Bambu Lab X1E...") |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
This is a guide to how pages on the wiki should be created and written, in order to keep things consistent. | This is a guide to how pages on the wiki should be created and written, in order to keep things consistent. | ||
== Page Names | == Page Names and Titles == | ||
* Page names and titles, when relating to equipment, includes only the equipment name and model number not the particular type of equipment it is. An exception to this would be if this is included in the manufacturer's model name. | * Page names and titles, when relating to equipment, includes only the equipment name and model number not the particular type of equipment it is. An exception to this would be if this is included in the manufacturer's model name. | ||
| Line 17: | Line 17: | ||
** "[[Anycubic Wash & Cure 3]]" is OK, the ampersand is part of the model name. | ** "[[Anycubic Wash & Cure 3]]" is OK, the ampersand is part of the model name. | ||
** "Power Up & Power Down (CMM)" is not OK, it should be spelled out "Power Up and Power Down (CMM)". | ** "Power Up & Power Down (CMM)" is not OK, it should be spelled out "Power Up and Power Down (CMM)". | ||
== Headings == | |||
* Headings should normally be in "Title Case". | |||
* There should normally be no final punctuation in a heading or sub heading. | |||
* Subheadings may be in "Sentence case" if appropriate. | |||
== Bulleted Lists and Numbered Lists == | |||
Items in lists should normally end with a full stop. | |||
== Capital Letters == | |||
=== Title case === | |||
According to the [[wikipedia:AP_Stylebook|Associated Press Stylebook]]. Examples taken [[wikipedia:Title_case#AP_Stylebook|from Wikipedia]]. | |||
* Capitalize the principal words. | |||
* Capitalize prepositions and conjunctions of four letters or more. | |||
* Lowercase the articles ''the'', ''a'', and ''an''. | |||
* Capitalize the first and last words (overrides the rules above). | |||
* Capitalize the "to" in infinitives (e.g., I Want To Play Guitar). | |||
=== Sentence case === | |||
https://en.wikipedia.org/wiki/Letter_case#Stylistic_or_specialised_usage | |||
Latest revision as of 18:11, 15 December 2023
This is a guide to how pages on the wiki should be created and written, in order to keep things consistent.
Page Names and Titles
- Page names and titles, when relating to equipment, includes only the equipment name and model number not the particular type of equipment it is. An exception to this would be if this is included in the manufacturer's model name.
- "Haas UMC-500" not "Haas UMC-500 5-axis CNC Mill"
- "Bambu Lab X1E" not "Bambu Lab X1E 3D printer"
- "Axminster AT540PD" not "Pillar Drill" or "Axminster AT540PD Pillar Drill"
- "Axminster G700 Dust Processor" is named this way by the manufacturer.
- When pages are named the same, or cover the same topic for a different process then the page title should be differentiated by the process or machine in parentheses at the end of the title.
- "Power Up and Power Down (CMM)" and "Power Up and Power Down (Haas UMC-500)"
- "Toolholders (Haas UMC-500)" and "Toolholders (AXYZ Innovator)"
- The process or machine can also be added to page titles for disambiguation purposes.
- Page titles should be in Title Case.
- Titles should avoid using special characters such as & unless it is included in the model name or generally accepted process name.
- "Anycubic Wash & Cure 3" is OK, the ampersand is part of the model name.
- "Power Up & Power Down (CMM)" is not OK, it should be spelled out "Power Up and Power Down (CMM)".
Headings
- Headings should normally be in "Title Case".
- There should normally be no final punctuation in a heading or sub heading.
- Subheadings may be in "Sentence case" if appropriate.
Bulleted Lists and Numbered Lists
Items in lists should normally end with a full stop.
Capital Letters
Title case
According to the Associated Press Stylebook. Examples taken from Wikipedia.
- Capitalize the principal words.
- Capitalize prepositions and conjunctions of four letters or more.
- Lowercase the articles the, a, and an.
- Capitalize the first and last words (overrides the rules above).
- Capitalize the "to" in infinitives (e.g., I Want To Play Guitar).
Sentence case
https://en.wikipedia.org/wiki/Letter_case#Stylistic_or_specialised_usage