Style Guide

From Make In Salford
Revision as of 11:16, 14 December 2023 by 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...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

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.
  • 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.
  • 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)".