Jump to content

Edit Guide: Difference between revisions

No change in size ,  10 August 2023
no edit summary
No edit summary
No edit summary
Line 6: Line 6:
Each howdoi page should answer a question (ex. ''How do I find a list of Riverdale Google Calendars''). This is so that articles stayed focused on the question at hand and provides only the necessary information.
Each howdoi page should answer a question (ex. ''How do I find a list of Riverdale Google Calendars''). This is so that articles stayed focused on the question at hand and provides only the necessary information.


# Each article starts with an <code><nowiki>{{AboxNew}}</nowiki></code> template. Update the template accordingly and make sure the fields are appropriately filled in. An example is shown below.
* Each article starts with an <code><nowiki>{{AboxNew}}</nowiki></code> template. Update the template accordingly and make sure the fields are appropriately filled in. An example is shown below.
<syntaxhighlight lang="markdown">
<syntaxhighlight lang="markdown">
{{AboxNew
{{AboxNew
Line 19: Line 19:
__TOC__
__TOC__
</syntaxhighlight>
</syntaxhighlight>
# Use the '''''Heading''''' styling ( ^ 2 ) for major section titles. If a sub-section is needed, then use '''''Sub-heading 1''''' ( ^ 3 ).
* Use the '''''Heading''''' styling ( ^ 2 ) for major section titles. If a sub-section is needed, then use '''''Sub-heading 1''''' ( ^ 3 ).
# Use '''''Paragraph''''' ( ^ 0 ) mode for other text.
* Use '''''Paragraph''''' ( ^ 0 ) mode for other text.
# If you refer to a menu item or UI element for the intended user to interact with, then '''''bold and italicize''''' that item. This is to make the article easy navigable, so that the key steps are easy to find at a first glance without getting lost in the text.
* If you refer to a menu item or UI element for the intended user to interact with, then '''''bold and italicize''''' that item. This is to make the article easy navigable, so that the key steps are easy to find at a first glance without getting lost in the text.
#* Ex: click on '''''Submit'''''  
** Ex: click on '''''Submit'''''  
# If the user needs to type something in a textfield or text area, then "place the text in quotation marks".
* If the user needs to type something in a textfield or text area, then "place the text in quotation marks".
# Include images that you think are necessary, but also remember the following: the more images you include in your article, the harder it will be to update content when UI's and OS's change.
* Include images that you think are necessary, but also remember the following: the more images you include in your article, the harder it will be to update content when UI's and OS's change.
# If you want to include images, make sure to un-check the '''''Wrap text around this item''''' box. Images, as a rule of thumb, should not exceed a width of 500 pixels unless there is a good reason to do so.
* If you want to include images, make sure to un-check the '''''Wrap text around this item''''' box. Images, as a rule of thumb, should not exceed a width of 500 pixels unless there is a good reason to do so.
[[File:Wraptextimage.png|none|thumb|274x274px]]
[[File:Wraptextimage.png|none|thumb|274x274px]]
1,646

edits