From CoderDojo Kata
Jump to: navigation, search

Before you start

If you haven't done so already, you will need to:

  1. Create an account
  2. Get set up as an Approved Editor (this may take a few days for confirmation and turn around)

Uploading your resource

  1. Upload your file using this special page.
  2. You will get a page (e.g. File:Game Design.pdf) as a result.

Creating a Resource page

Example

My First Website Sushi Cards — view the wiki code of the page to see how it's put together.

Goals

A resource page should contain a single resource, or set of related resources, that cover a certain skill level (beginner, intermediate or advanced). For example, the My First Website Sushi Cards are a single resource, but the Intermediate HTML cards are a separate resource.

Naming

The page should be named in a descriptive fashion, but avoid things like arbitrary/incremental numbers or the name of the Dojo or person who originally created the resource. There is a field in the template to give credit, but the title should help another Mentor trying to understand what a resource is.

Actually creating a page

  1. Go to "http://kata.coderdojo.com/wiki/[THE NAME OF YOUR SUSHI SERIES]"
  2. You will, most likely, see a page telling you the resource you're looking for doesn't exist and giving you the option to "edit this page". If you do see a resource page, pick a new name.
  3. Choose the edit option and copy-paste and complete the resource page template outlined below.

Resource page template

A template is used to create a resource page. If you copy-paste this sample template into a page and modify the fields indicated in the comments, you'll get a resource page with the appropriate categories, search indicies, etc.

Under the Content section, include "<pdf>[The name of your PDF]</pdf>" with, obviously, the name of your PDF in place of my placeholder text! You can find the name of the file on its wiki page. For example, in the case of the File:Game Design.pdf Sushi Cards, it's Game_Design.pdf.


<!-- UPDATE OR DELETE INCOMPLETE FIELDS AS REQUIRED -->
{{Resource
<!-- THE AREA THE RESOURCE PRIMARILY ADDRESSES: Programming / Hardware / Design / Other -->
|area=Incomplete
<!-- IF A PROGRAMMING RESOURCE, THE LANGUAGE THE RESOURCE PRIMARILY ADDRESSES E.G. HTML -->
|language=Incomplete
<!-- THE DIFFICULTY LEVEL OF THE RESOURCE. CHOOSE ONE OF: Beginner / Intermediate / Advanced -->
|level=Incomplete
<!-- THE NUMBER OF DOJOS THAT THE RESOURCE WILL, ON AVERAGE, TAKE TO COMPLETE e.g. 6 -->
|length=Incomplete
<!-- THE PRIMARY MEDIUM OF THE RESOURCE. CHOOSE ONE OF: Sushi Card / Document / Video / Audio / Interactive -->
|medium=Incomplete
<!-- THE FILE FORMAT OF THE RESOURCE, E.G. PDF -->
|format=Incomplete
<!-- UPDATE WITH THE NAME OF THE AUTHOR, IF KNOWN -->
|author=Incomplete
}}
==Summary==
<onlyinclude>
<!-- INCLUDE A SHORT SUMMARY OF THE CONTENT -->
</onlyinclude>
==Content==
<!-- INCLUDE A VIEW OF THE CONTENT, OR A LINK TO IT -->
==Source Files==
<!-- IF YOU HAVE THEM, AND THE RIGHT TO SHARE THEM HERE, INCLUDE THE SOURCE FILES OF THE CONTENT -->

Adding a resource to a path

Adding a resource to a Path is a simple matter of including a few lines at the end of the page. You can add the same resource to any number of paths. It can be a core resource on one path and a supplementary resource on another.

This is the wiki code you need to include, just making the appropriate substitutions where the comments (in <!-- -->) are.

{{InPath
|pathname=<!-- TITLE OF THE PATH — THIS WILL BE THE PAGE NAME OF THE PATH -->
|association=<!-- ONE OF core / supplementary / project -->
|order=<!-- An integer, indicating what order the resource should be listed in under the path. Tie it to the difficulty level by adding 100, 200, 300 for beginner, intermediate, advanced -->
}}