Difference between revisions of "Help:Disclaimer templates"
(Created help article) |
m (2 revisions) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
The BYOAC Wiki has a few templates available for editors. This page lists those templates and contains a few guidelines on when to use them. | The BYOAC Wiki has a few templates available for editors. This page lists those templates and contains a few guidelines on when to use them. | ||
| + | |||
==General use== | ==General use== | ||
| − | Disclaimers are there for two reasons. The first: to protect the reader from doing something without thinking it completely over, second to protect BYOAC from angry readers who tried something described in the article and things went horribly wrong. | + | Disclaimers are there for two reasons. The first: to protect the reader from doing something without thinking it completely over, second to protect BYOAC from angry readers who tried something described in the article and things went horribly wrong. |
Rule of the thumb for these disclaimers is: when the reader can potentially harm him/herself (health risk) or when the reader can potentially ruin the material he/she is using, a disclaimer is a good thing to have on your page. | Rule of the thumb for these disclaimers is: when the reader can potentially harm him/herself (health risk) or when the reader can potentially ruin the material he/she is using, a disclaimer is a good thing to have on your page. | ||
Latest revision as of 10:09, 5 December 2013
The BYOAC Wiki has a few templates available for editors. This page lists those templates and contains a few guidelines on when to use them.
Contents
General use
Disclaimers are there for two reasons. The first: to protect the reader from doing something without thinking it completely over, second to protect BYOAC from angry readers who tried something described in the article and things went horribly wrong.
Rule of the thumb for these disclaimers is: when the reader can potentially harm him/herself (health risk) or when the reader can potentially ruin the material he/she is using, a disclaimer is a good thing to have on your page.
Modify electric equipment disclaimer
When to use
The disclaimer should be use when the Wiki article describes something that requires the user to modify circuit boards or any other electric equipment.
The disclaimer
The disclaimer looks like this:
| ---DISCLAIMER--- |
| This Wikipage explains how to modify or connect electric equipment. Build Your Own Arcade Controls Wiki recommends reading the manuals of the tools and equipment you are using.
|
It is inserted by using this code in the Wikipage:
{{DisclaimerElectricity}}
Construction disclaimer
When to use
The disclaimer should be use when the Wiki article describes something that requires the user to use powertools or hazardous materials. Note that sawdust can be hazardous to your health so do not just use it on pages that require the reader to split plutonium.
The disclaimer
The disclaimer looks like this:
| ---DISCLAIMER--- |
| This Wikipage explains how to build something using tools or recommendations on materials to use. Build Your Own Arcade Controls Wiki recommends reading the manual of the tools you are using. Also keep in mind that sawdust, glue and certain paints may be hazardous to your health: always wear safety goggles or a breathing mask when working with these kinds of materials (see also Safety Equipment). The supplier of the tools or materials might be able to advise you on this topic.
|
It is inserted by using this code in the Wikipage:
{{DisclaimerConstruction}}
Software disclaimer
When to use
The disclaimer should be use when the Wiki article describes how to change system settings or install software that is "at your own risk". That means it is not required when prompted to install software that has their own disclaimers (so if you recommend to install Adobe Photoshop, it is covered by Adobe so we don't need to bother). However if your article recommends to alter the Photoshop .INI file, the disclaimer is recommended.
The disclaimer
The disclaimer looks like this:
| ---DISCLAIMER--- |
| This Wikipage explains how to install software or modify your computer's settings. Build Your Own Arcade Controls Wiki recommends reading the manuals or "readme" files of the software. If you are changing settings on your computer make sure you understand what you are doing. In doubt let a more experienced user execute the steps for you.
|
It is inserted by using this code in the Wikipage:
{{DisclaimerSoftware}}
Note to editors
The disclaimers are also Wikipages and can be found in the template namespace:
