Site Tools


style_guidelines

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
style_guidelines [2025/03/08 18:41] – [Layout/Formatting Guidelines] -grammar hogwildstyle_guidelines [2025/06/09 16:06] (current) – [Layout/Formatting Guidelines] -Remove "name" from image file syntax description hogwild
Line 33: Line 33:
   * **Focus on content**.  Not everyone uses the same size monitor or resolution. \\ Some people use a mobile device to access the wiki. Different browsers \\ and accessibility features also affect how formatting appears (such as line breaks). \\ \\    * **Focus on content**.  Not everyone uses the same size monitor or resolution. \\ Some people use a mobile device to access the wiki. Different browsers \\ and accessibility features also affect how formatting appears (such as line breaks). \\ \\ 
   * **Subheadings use the Heading2** format, and subheadings below that, Heading3.\\ \\    * **Subheadings use the Heading2** format, and subheadings below that, Heading3.\\ \\ 
-  * **When taking screenshots**, always use the "Tomato" theme (set in [[admin-access|Admin Access]]).\\  \\ {{:pasted:20210921-184547.png?497|A screenshot in the Standard Tomato theme}}  \\   \\  \\ In general, please use this syntax for naming screenshots files for upload:\\ ''"top level node name-bottom level node name-section name-release.png'' \\ \\ \\ For example, a screenshot of the Options section in the //Basic///DHCP Reservation menu \\ should be named "basic-dhcp reservation-options-2024.1". \\ \\  +  * **When taking screenshots**, always use the "Tomato" theme (set in [[admin-access|Admin Access]]).\\  \\ {{:pasted:20210921-184547.png?497|A screenshot in the Standard Tomato theme}}  \\   \\  \\ In general, please use this syntax for naming screenshots files for upload:\\ ''"top node-bottom node-section name-release.png'' \\ \\ \\ For example, a screenshot of the Options section in the //Basic///DHCP Reservation menu \\ should be named "basic-dhcp reservation-options-2024.1". \\ \\  
-  * For screenshots of just one or few settings options under one section, use syntax: \\ ''"top level node name-bottom level node name-option name to option name-release.png"''  \\ \\ \\ Example: "advanced-wireless-roaming assistant to fragmentation threshold-2024.1" \\  \\  +  * For screenshots of just one or few settings options under one section, use syntax: \\ ''"top node-bottom node-option name to option name-release.png"''  \\ \\ \\ Example: "advanced-wireless-roaming assistant to fragmentation threshold-2024.1" \\  \\  
-  * Please save screenshots in .png format. Lossy formats are blurry, \\ and may reveal personal user data. \\ \\  +  * Please save screenshots in .png format. Lossy formats are blurry, \\ and may reveal your personal user data. \\ \\  
-  * Please wrap bulleted text at less than 50% frame width. \\ It makes things much easier to read/follow. Shorter bulleted portions \\ should be wrapped even earlier for reading ease. \\ \\ +  * Please wrap bulleted text at less than 50% frame width. \\ It makes things much easier to read/follow. Shorter bulleted portions \\ should be wrapped even earlier for reading ease. \\ \\  
-  * Screenshots in bitmap formats should be scaled/resized in even \\ multiples of their original size. Otherwise, they may appear blurry. \\ \\ +  * Screenshots in bitmap formats should be scaled/resized in even \\ multiples of their original size. Otherwise, they may appear blurry. \\ \\
  
   * **Avoid quotation marks**. They should be used only:   * **Avoid quotation marks**. They should be used only:
Line 45: Line 45:
   * **Avoid using the word “Note”**. Put notes in the Notes section that exists \\ at the bottom of most pages.\\ \\    * **Avoid using the word “Note”**. Put notes in the Notes section that exists \\ at the bottom of most pages.\\ \\ 
   * Except in a code window, **command strings should be set in the** ''monospace'' font, \\ or in a callout box.\\ \\    * Except in a code window, **command strings should be set in the** ''monospace'' font, \\ or in a callout box.\\ \\ 
-  * Avoid dividing lines. They're obsolete and make text hard to read. \\ Better spacing and modern formatting methods work better.//   //+  * Avoid dividing lines. They're obsolete and make text hard to read. \\ Better spacing and modern formatting methods work better. 
 + 
 + \\ 
 + 
 + \\
  
  
style_guidelines.1741459318.txt.gz · Last modified: by hogwild