Edit Guide: Difference between revisions

From howdoi
No edit summary
No edit summary
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[https://docs.google.com/spreadsheets/d/1dh7Myh6vxGqvw0BchbLgyjTPJ1lEUBH-E429ARk6xGk/edit#gid=0 Our Google spreadsheet] for organizing content for this wiki.
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.


==General style guide==
== Before you begin writing your article ==
* each page answers a single question -- e.g. how do I find a list of Riverdale Google Calendars
Every article should start with the <code><nowiki>{{AboxNew}}</nowiki></code> 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 <code><nowiki>{{AboxNew}}</nowiki></code> and then search for the "AboxNew" template, or you can click [https://howdoi.riverdale.edu/wiki/Template:AboxNew 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!
** it is not a catch-all for everything about a subject -- other question means another page
*** except for our Get help from Google page, which is a catch-all
* each page starts with an <nowiki>{{abox}} and ends with a {{CategoryTemplate}}</nowiki>
* inline images (for instructions) are now added in a very particular way, with a variation of this code:<br>
::<nowiki>[[File:Interesting cal.png|thumbnail]]Here's a picture of what you should do<br clear="all"></nowiki>
:which gives you this, including the open space before the next instruction:<br>
::[[File:Interesting cal.png|thumbnail]]Here's a picture of what you should do<br clear="all">
:plus you can alter the size of the images by adding "|100px" (or another size) as follows:
::<nowiki>[[File:Interesting cal.png|thumbnail|100px]]</nowiki>
:to get this:
::[[File:Interesting cal.png|thumbnail|100px]]Here's a tiny image. It's cheaper that way.<br clear="all">


See [https://howdoi.riverdale.edu/wiki/Add_a_Riverdale_calendar_(of_any_type_--_event,_room,_or_resource)_to_my_own_calendar/edit this example] for a guide to our style.
==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.


== Article Templates ==
* 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.
; [[Template:abox|<nowiki>{{abox}}</nowiki>]]
<syntaxhighlight lang="markdown">
: used on every Article to indicate authorship, currency, audience, etc.
{{AboxNew
== Category Templates ==
| name = Access myRiverdale
Just ONE of these should be placed at the very bottom of an article. Choose its main category. Don't worry about listing a secondary/specific category.
| learning = x
; [[Template:Calendaring|<nowiki>{{Calendaring}}</nowiki>]]
| instruction = x
: Adds Article to [[:Category:Calendars and Scheduling]], and inserts a list of other Articles in that Category.
| community = x
; [[Template:SS|<nowiki>{{SS}}</nowiki>]]
| summ = Access many of our RCS applications with a single log-on
: Adds Article to [[:Category:Software and Services]], and inserts a list of other Articles in that Category.
| maintained = MV
; [[Template:ClassTech|<nowiki>{{ClassTech}}</nowiki>]]
| year = 2023-2024
: Adds Article to [[:Category:Classroom technology and systems]], and inserts a list of other Articles in that Category.
}}
; [[Template:Communication|<nowiki>{{Communication}}</nowiki>]]
__TOC__
: Adds Article to [[:Category:Communication]], and inserts a list of other Articles in that Category.
</syntaxhighlight>
<!--
* Use the '''''Heading''''' styling ( ^ 2 ) for major section titles. If a sub-section is needed, then use '''''Sub-heading 1''''' ( ^ 3 ).
; [[Template:|<nowiki>{{}}</nowiki>]]
* 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.
; [[Template:|<nowiki>{{}}</nowiki>]]
** Ex: click on '''''Submit'''''
:
* If the user needs to type something in a textfield or text area, then "place the text in quotation marks".
; [[Template:|<nowiki>{{}}</nowiki>]]
* 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.
; [[Template:|<nowiki>{{}}</nowiki>]]
[[File:Wraptextimage.png|none|thumb|274x274px]]
:
-->

Latest revision as of 14:38, 24 January 2024

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