Edit Guide: Difference between revisions

From howdoi
No edit summary
No edit summary
Line 1: Line 1:
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.
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.


== Top of the article ==
== Before you begin writing your article ==
Every article should start with the <code><nowiki>{{abox}}</nowiki></code> template. With this template, you will fill in the following information to correctly categorize and maintain articles in our wiki.
Every article should start with the <code><nowiki>{{abox}}</nowiki></code> template. With this template, you will fill in the following information to correctly categorize and maintain articles in our wiki.
[[File:Aboxsample.png|none|thumb]]
[[File:Aboxsample.png|none|thumb]]
To use this template, you can either start typing <code><nowiki>{{abox}}</nowiki></code> and then search for the "abox" template, or you can click [https://howdoi.riverdale.edu/wiki/Template:Abox here for the abox template]. Once you copy and paste the code, click on '''''Edit source''''', and then paste the block of text (for the template) at the top of your article.  
To use this template, you can either start typing <code><nowiki>{{abox}}</nowiki></code> and then search for the "abox" template, or you can click [https://howdoi.riverdale.edu/wiki/Template:Abox here for the abox template]. Once you copy and paste the code, click on '''''Edit source''''', and then paste the block of text (for the template) at the top of your article.  


==Article content==
==Writing your article==
* each page answers a single question -- e.g. how do I find a list of Riverdale Google Calendars
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.
** 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>
* 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>
* inline images (for instructions) are now added in a very particular way, with a variation of this code:<br>

Revision as of 12:59, 23 May 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 {{abox}} template. With this template, you will fill in the following information to correctly categorize and maintain articles in our wiki.

Aboxsample.png

To use this template, you can either start typing {{abox}} and then search for the "abox" template, or you can click here for the abox template. Once you copy and paste the code, click on Edit source, and then paste the block of text (for the template) at the top of your article.

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.

  • each page starts with an {{abox}} and ends with a {{CategoryTemplate}}
  • inline images (for instructions) are now added in a very particular way, with a variation of this code:
[[File:Interesting cal.png|thumbnail]]Here's a picture of what you should do<br clear="all">
which gives you this, including the open space before the next instruction:
Interesting cal.png
Here's a picture of what you should do
plus you can alter the size of the images by adding "|100px" (or another size) as follows:
[[File:Interesting cal.png|thumbnail|100px]]
to get this:
Interesting cal.png
Here's a tiny image. It's cheaper that way.

See this example/edit for source code examples.

Bottom of article - category templates

ONE of these should be placed at the very bottom of an article. Choose its main category.

  • Don't list a secondary/specific category unless it's critical to show two sets of "other articles in this category" links.
  • Do list a secondary/specific category for the subsets under the main categories below.
{{Calendaring}}
Adds Article to Category:Calendars and Scheduling, and inserts a list of other Articles in that Category.
{{SS}}
Adds Article to Category:Software and Services, and inserts a list of other Articles in that Category.
{{ClassTech}}
Adds Article to Category:Classroom technology and systems, and inserts a list of other Articles in that Category.
{{Chromebooks}} (level 2, specific category)
Adds Article to Category:Chromebooks, and inserts a list of other Articles in that Category.
{{Communication}}
Adds Article to Category:Communication, and inserts a list of other Articles in that Category.