Difference between revisions of "New Equipment Template"

From Makespace
Jump to: navigation, search
(Created page with "This is a '''work-in-progress''' to standardise the information on equipment pages, as of January 2020. To create a new page for equipment, follow the steps below. To learn m...")
 
(Training)
 
(8 intermediate revisions by 2 users not shown)
Line 3: Line 3:
 
To create a new page for equipment, follow the steps below. To learn more about working with our wiki, see [https://www.mediawiki.org/wiki/Help:Contents Media Wiki Help].
 
To create a new page for equipment, follow the steps below. To learn more about working with our wiki, see [https://www.mediawiki.org/wiki/Help:Contents Media Wiki Help].
  
* edit the [[Equipment|equipment page]], choose the relevant section of equipment for your new piece, and add a link to your equipment in this format: <nowiki>[[link|name]]</nowiki> (note the pipe or vertical bar separator), for example <nowiki>[[Equipment/BandSaw|Band Saw]]</nowiki> for the bandsaw
+
* choose a name for your equipment without underscores or camel case, for example "Laser Cutter" and not "LaserCutter" or "Laser_Cutter". This name will become the heading of the page. The wiki will convert spaces to underscores in the URL but keep spaces in the heading, which is more readable. Note that the name is case-sensitive ("Laser cutter" with lowercase "c" is different from "Laser Cutter" with uppercase "C").
* save the Equipment page and hover on the link you just created; if the page does not exit, the tooltip will read "page does not exist", and clicking on it will take you to the interface to create the page; the page title is already filled with the display text of the link
+
* edit the [[Equipment|Equipment page]], choose the relevant section of equipment for your new piece, and add a link to your equipment in this format: <nowiki>[[Equipment/name]]</nowiki>, for example <nowiki>[[Equipment/Laser Cutter]]</nowiki> for the laser cutter;
* edit this page, select everything south of this message, and paste into your new page, then edit as appropriate.
+
* save the Equipment page and hover on the link you just created; if the page does not exist, the tooltip will read "page does not exist", and clicking on it will take you to the interface to create the page; the page title is already filled with the display text of the link;
 +
* click "edit" on this page, select everything south of this message, and paste into your new page, then edit as appropriate;
 +
* print the wiki page and place it next to the equipment, along with your personal contact information (don't put it on this public wiki because of GDPR)
  
 
Add this line at the top of the mage to mark equipment as red, orange, or green, respectively: <nowiki>{{RedTool}}, {{OrangeTool}}, {{GreenTool}}</nowiki>.
 
Add this line at the top of the mage to mark equipment as red, orange, or green, respectively: <nowiki>{{RedTool}}, {{OrangeTool}}, {{GreenTool}}</nowiki>.
  
= Requirements for use =
+
Add the following "breadcrumb" path, indicating current user location, <nowiki>[[Equipment|Equipment]] / Equipment name as used in page title</nowiki>, for example <nowiki>[[Equipment|Equipment]] / Disc and Belt Sander</nowiki>.
  
== Training ==
+
= Summary =
 +
 
 +
Summarise the tool, and its uses. If possible, add a photo.
  
Does this equipment need training? How do people get it?
 
  
== Safety ==
+
= Safety =
  
 
Words and Icons would be best in this section.
 
Words and Icons would be best in this section.
  
=== Before use ===
+
== Before use ==
  
 
* What Personal Protective Equipment (PPE) should users have?
 
* What Personal Protective Equipment (PPE) should users have?
Line 27: Line 30:
 
* What materials to cut, to not cut?
 
* What materials to cut, to not cut?
 
   
 
   
=== During use ===
+
== During use ==
  
 
* What to watch for?
 
* What to watch for?
 
* When to stop?
 
* When to stop?
  
=== After use ===
+
== After use ==
  
 
* How to shut down?
 
* How to shut down?
Line 42: Line 45:
 
** suggestions for improvement:
 
** suggestions for improvement:
 
   
 
   
 +
= Training =
 +
 +
Does this equipment need training? How do people get it?
 +
 +
'''To be confirmed'''
 +
 +
Some equipment pages contain the following warning in this section:
 +
<nowiki><div style="background:#FADADD; border:1px solid #FFC0CB; padding:5px">
 +
<b>YOU CAN ONLY USE THE CIRCULAR SAW IF YOU HAVE BEEN TRAINED</b><br>
 +
and have been added to the list by one of the Owners
 +
</div>
 +
</nowiki>
 +
 +
For example:
 +
<div style="background:#FADADD; border:1px solid #FFC0CB; padding:5px">
 +
<b>YOU CAN ONLY USE THE CIRCULAR SAW IF YOU HAVE BEEN TRAINED</b><br>
 +
and have been added to the [[Equipment/5704RK/Training#Trained_Users|Trained Users]] list by one of the Owners
 +
</div>
 +
 
= Contact information =
 
= Contact information =
  
 
== Owner(s) ==
 
== Owner(s) ==
  
For the wiki, which is public, add only first name and initial of last name to comply with GDPR
+
The Owners are those who have volunteered to be in charge of the equipment, organising maintenance, and generally being a point of contact. The current Owners are:
 +
 
 +
(For the wiki, which is public, add only first name and initial of last name to comply with GDPR.)
  
 
== Trainer(s) ==
 
== Trainer(s) ==
  
For the wiki, which is public, add only first name and initial of last name to comply with GDPR.
+
The Trainers are those who have volunteered to train others to use it. The current Trainers are:
 +
 
 +
(For the wiki, which is public, add only first name and initial of last name to comply with GDPR.)
  
 
== In an emergency ==
 
== In an emergency ==

Latest revision as of 20:01, 27 January 2020

This is a work-in-progress to standardise the information on equipment pages, as of January 2020.

To create a new page for equipment, follow the steps below. To learn more about working with our wiki, see Media Wiki Help.

  • choose a name for your equipment without underscores or camel case, for example "Laser Cutter" and not "LaserCutter" or "Laser_Cutter". This name will become the heading of the page. The wiki will convert spaces to underscores in the URL but keep spaces in the heading, which is more readable. Note that the name is case-sensitive ("Laser cutter" with lowercase "c" is different from "Laser Cutter" with uppercase "C").
  • edit the Equipment page, choose the relevant section of equipment for your new piece, and add a link to your equipment in this format: [[Equipment/name]], for example [[Equipment/Laser Cutter]] for the laser cutter;
  • save the Equipment page and hover on the link you just created; if the page does not exist, the tooltip will read "page does not exist", and clicking on it will take you to the interface to create the page; the page title is already filled with the display text of the link;
  • click "edit" on this page, select everything south of this message, and paste into your new page, then edit as appropriate;
  • print the wiki page and place it next to the equipment, along with your personal contact information (don't put it on this public wiki because of GDPR)

Add this line at the top of the mage to mark equipment as red, orange, or green, respectively: {{RedTool}}, {{OrangeTool}}, {{GreenTool}}.

Add the following "breadcrumb" path, indicating current user location, [[Equipment|Equipment]] / Equipment name as used in page title, for example [[Equipment|Equipment]] / Disc and Belt Sander.

Summary

Summarise the tool, and its uses. If possible, add a photo.


Safety

Words and Icons would be best in this section.

Before use

  • What Personal Protective Equipment (PPE) should users have?
  • What safety checklist to verify before using?
  • Other activities in the area
  • Ventilation
  • What materials to cut, to not cut?

During use

  • What to watch for?
  • When to stop?

After use

  • How to shut down?
  • Where to store tools?
  • How to clean up?
  • How to report:
    • problems:
    • repair and maintenance needs:
    • suggestions for improvement:

Training

Does this equipment need training? How do people get it?

To be confirmed

Some equipment pages contain the following warning in this section: <div style="background:#FADADD; border:1px solid #FFC0CB; padding:5px"> <b>YOU CAN ONLY USE THE CIRCULAR SAW IF YOU HAVE BEEN TRAINED</b><br> and have been added to the list by one of the Owners </div>

For example:

YOU CAN ONLY USE THE CIRCULAR SAW IF YOU HAVE BEEN TRAINED
and have been added to the Trained Users list by one of the Owners

Contact information

Owner(s)

The Owners are those who have volunteered to be in charge of the equipment, organising maintenance, and generally being a point of contact. The current Owners are:

(For the wiki, which is public, add only first name and initial of last name to comply with GDPR.)

Trainer(s)

The Trainers are those who have volunteered to train others to use it. The current Trainers are:

(For the wiki, which is public, add only first name and initial of last name to comply with GDPR.)

In an emergency

Emergency numbers and contact: how do users contact you? Did you write your contact information near the equipment, or would they contact on the general google group?

Mailing list or Google Group

Do you have a specific mailing list or Google Group for this equipment? One example is Glass Kiln training. If not, leave blank.

References

Training syllabus

If training for the equipment is substantial, please consider moving it to a separate page, and link to it from this page.

Information covered

Example quiz questions

Design files for example piece

Signage to be posted at the equipment

Manufacturer's Manuals

External resources

Instructional video(s)

Materials

Comments from members

Observations and contributions from the members. (Much of the existing information currently on the wiki.) Do we want this section? If so, what kind of contributions come here instead of the problem report contact above?