Difference between revisions of "Help:Guide to 'How-to' wiki pages"
(Created page with "This pages give a short overview of the available templates and functionalities available for writing the help pages. ==URL links== ===Link to CAA user management website===...") |
|||
| Line 17: | Line 17: | ||
===Requirements=== | ===Requirements=== | ||
| − | {{Requirements|UserLevel= | + | {{Requirements|UserLevel=Permission level|Connectivity=Required connectivity}} |
| − | To specify the requirements for the task discussed on a wiki page use <nowiki>{{Requirements|UserLevel=User Level|Connectivity=Required connectivity}}</nowiki>, which produces a blue box in the right top hand corner of the current section. | + | To specify the requirements for the task discussed on a wiki page use <nowiki>{{Requirements|UserLevel=User Level|Connectivity=Required connectivity}}</nowiki>, which produces a blue box in the right top hand corner of the current section. Use the requirement div on the second line of a How-to page right under the <nowiki>_NOTOC_</nowiki> line. |
Use the following enumerations for the permission levels: | Use the following enumerations for the permission levels: | ||
| Line 28: | Line 28: | ||
Use the following enumerations for the connectivity levels: | Use the following enumerations for the connectivity levels: | ||
* Online only | * Online only | ||
| − | * | + | * Online and partial offline |
| + | * Online and offline | ||
Edit the template [[Template:Requirements]] to make changes to this floating div. | Edit the template [[Template:Requirements]] to make changes to this floating div. | ||
| + | |||
| + | ==Notes== | ||
| + | Note divs are used to highlight noteworthy aspects of the application that directly relate to the particular step within the step-by-step description of a task. To add a note div use <nowiki>{{Note | Content. | Style(default: NoteNoImage)}}</nowiki>, which produces {{Note|Content.}}. | ||
| + | |||
| + | Use <nowiki>{{Note | Content. | NoteWithImage}}</nowiki> to create a note div that nicely fits next to a image on the right hand side. | ||
| + | |||
| + | Edit the template [[Template:Note]] to make changes to this floating div. | ||
| + | |||
| + | ==Issues== | ||
| + | Issue divs are used to highlight existing bugs that directly relate to the particular step within the step-by-step description of a task. To add a issue div use <nowiki>{{Issue | Content. | Style(default: NoteNoImage) | Issue Number | Date}}</nowiki>, which produces {{Issue|Content.|}} | ||
| + | |||
| + | Use <nowiki>{{Issue | Content. | IssueWithImage}}</nowiki> to create a issue div that nicely fits next to a image on the right hand side. | ||
| + | |||
| + | Edit the template [[Template:Issue]] to make changes to this floating div. | ||
Revision as of 09:50, 18 October 2013
This pages give a short overview of the available templates and functionalities available for writing the help pages.
Contents
URL links
Link to CAA user management website
To add a link to the CAA user management website use {{UserAdminURL|OptionalExtension}}, which produces http://user.avalanche.ca/#/OptionalExtension.
Edit the template Template:UserAdminURL to make changes to the URL trunk.
Link to InfoEx application
To add a link to the InfoEx application website use {{InfoExURL|OptionalExtension}}, which produces https://infoex.avalancheassociation.ca/OptionalExtension.
Edit the template Template:InfoExURL to make changes to the URL trunk.
Floating divs
Requirements
| REQUIREMENTS | |
| Permission | Permission level |
| Connectivity | Required connectivity |
To specify the requirements for the task discussed on a wiki page use {{Requirements|UserLevel=User Level|Connectivity=Required connectivity}}, which produces a blue box in the right top hand corner of the current section. Use the requirement div on the second line of a How-to page right under the _NOTOC_ line.
Use the following enumerations for the permission levels:
- All users
- Observation moderators and higher
- Operation administrator and higher
- Super user only
Use the following enumerations for the connectivity levels:
- Online only
- Online and partial offline
- Online and offline
Edit the template Template:Requirements to make changes to this floating div.
Notes
Note divs are used to highlight noteworthy aspects of the application that directly relate to the particular step within the step-by-step description of a task. To add a note div use {{Note | Content. | Style(default: NoteNoImage)}}, which produces
| NOTE | Content. |
.
Use {{Note | Content. | NoteWithImage}} to create a note div that nicely fits next to a image on the right hand side.
Edit the template Template:Note to make changes to this floating div.
Issues
Issue divs are used to highlight existing bugs that directly relate to the particular step within the step-by-step description of a task. To add a issue div use {{Issue | Content. | Style(default: NoteNoImage) | Issue Number | Date}}, which produces
| ISSUE | Content. JIRA: -Issue Number (Date) |
Use {{Issue | Content. | IssueWithImage}} to create a issue div that nicely fits next to a image on the right hand side.
Edit the template Template:Issue to make changes to this floating div.
