Edit Guide: Difference between revisions

Revision as of 10:34, 10 August 2023

To make our resources easily navigable for community members, please follow these guidelines for creating, editing, and maintaining articles in our knowledge base. 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.

Before you begin writing your article

Every article should start with the {{AboxNew}} template. With this template, you will fill in the following information to correctly categorize and maintain articles in our wiki. To use this template, you can either start typing {{AboxNew}} and then search for the "AboxNew" template, or you can click here for the abox template. Once you copy the code, click on Edit source, and then paste the block of text (for the template) at the top of your article. Make sure to update the categories and data as needed!

Writing your article

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 {{AboxNew}} template. Update the template accordingly and make sure the fields are appropriately filled in. An example is shown below.

{{AboxNew
| name = Access myRiverdale
| learning = x
| instruction = x
| community = x
| summ = Access many of our RCS applications with a single log-on
| maintained = MV
| year = 2023-2024
}}
__TOC__

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.
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
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.
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.

@@ 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 article starts with an <code><nowiki>{{AboxNew}}</nowiki></code> template. Update the template accordingly and make sure the fields are appropriately filled in. You put
+# 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">
+{{AboxNew
+| name = Access myRiverdale
+| learning = x
+| instruction = x
+| community = x
+| summ = Access many of our RCS applications with a single log-on
+| maintained = MV
+| year = 2023-2024
+}}
+__TOC__
+</syntaxhighlight>
 # 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.
 # 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:
+#* Ex: click on '''''Submit'''''
 # 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.
 # 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]]
-# If you think it would be useful for the article, feel free to add a <code><nowiki>{{Category}}</nowiki></code> tag to include a list of related articles. Some common categories includes...
-#* <code><nowiki>{{RCS Software and Services}}</nowiki></code>
-#* <code><nowiki>{{Classroom Technology and Systems}}</nowiki></code>
-#* <code><nowiki>{{Veracross}}</nowiki></code>
-#* <code><nowiki>{{Chromebook}}</nowiki></code>
-#* And others!
-:
-<!--
-; [[Template:|<nowiki>{{}}</nowiki>]]
-:
-; [[Template:|<nowiki>{{}}</nowiki>]]
-:
-; [[Template:|<nowiki>{{}}</nowiki>]]
-:
-; [[Template:|<nowiki>{{}}</nowiki>]]
-:
--->