This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
style_guidelines [2022/02/03 16:23] – [Layout/Formatting Guidelines] hogwild | style_guidelines [2022/02/03 16:58] – [Style Guidelines (Wiki Edits)] hogwild | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Style Guidelines (Wiki Edits) ====== | + | ====== Style Guidelines (Wiki Editing) ====== |
===== Wiki Editing Rights ===== | ===== Wiki Editing Rights ===== | ||
- | To be able to edit the Wiki, you will need to get new user credentials. To request access, please send a personal message to @rs232, including your email address and preferred username. | + | To be able to edit the Wiki, you will need to get new user credentials. To request access, please send a personal message to user "rs232", including your email address and preferred username. |
Line 27: | Line 27: | ||
* Subheadings use the Heading2 format. | * Subheadings use the Heading2 format. | ||
* Subheadings below that use the Heading3 format. | * Subheadings below that use the Heading3 format. | ||
- | * Indicate web interface menu paths like this: "navigate to // | + | * Indicate web interface menu paths like this: "// |
- | * Always use the standard Tomato theme when taking screenshots. | + | * Always use the standard Tomato theme when taking screenshots. |
- | + | ||
- | \\\\ {{: | + | |
+ | \\ {{: | ||
\\ | \\ | ||
- | + | | |
- | * Avoid using quotation marks except where absolutely appropriate. Quotation marks are rarely appropriate, | + | * Avoid using quotation marks except where absolutely appropriate. Quotation marks are rarely appropriate, |
- | * Avoid underlining. It was considered obsolete since the 1980s. | + | * Avoid underlining. It has been considered obsolete since the 1980s. |
- | * Avoid using the word “NOTE”. | + | * Avoid using the word “NOTE”. |
- | * Unless they are in a code window, command strings should be emboldened, like this: **ssh root@192.168.10.1** | + | * Unless they are in a code window, command strings should be set in the '' |
* Variables should be italicized. | * Variables should be italicized. | ||
+ | * Process/ | ||
* Avoid using dividing lines. Better spacing, and other formatting methods work better. | * Avoid using dividing lines. Better spacing, and other formatting methods work better. | ||