Template:AuthorizationCourseInfo/doc: Difference between revisions

From Pumping Station One
m Cleaned up sizing.
No edit summary
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
'''''This is the MediaWiki ToolsAuthorization Template, please don't mess with the template (Template:ToolAuthorization) unless you know what you are doing'''''
__NOTOC__
{{ambox|type=content|text=<span style="font-size: 120%; font-weight: bold; color: red ; ">DO NOT use this template on any tool pages, nor the central [[Authorizations]] page. Do not edit this template page directly, unless you know what you're doing.</span><br>}}


= Template Info =
=Authorization Course Info Box Template=
<span style="font-size: 120%; font-weight: bold; color: red ; ">DO NOT use this template on any tool pages.</span><br>
==How to create a new authorization info box==
<span style="font-size: 105%; font-weight: bold; ">Only use this template in the big list on the [[Authorizations]] page. You will later LINK TO the blue Authorization Info box in the [[Authorizations]] page from the tool page using the <code><nowiki>{{#lst:Authorizations|authslug_for_the_specific_auth_happening}}</nowiki></code> generated for that unique blue authorization box.</span>
===Step 1:===
'''Create a new child page under [[Authorizations]] using the title of the authorization course.''' Do not stick "auth" or "authorization" in the name. Note that '''a single authorization course page is all that's needed to cover multiple tools.''' To make a new page quickly, type in the name at the end of the URL to the [[Authorizations]]...


; Description of fields:
<code><nowiki>https://wiki.pumpingstationone.org/wiki/Authorizations/</nowiki>'''Hot_Air_Balloon'''</code>
* <span style="color: red ; ">'''Required:'''</span>
** '''authslug:''' Short no spaces unique ID used to reference the auth information elsewhere on the wiki. <code><nowiki>hotairballoon</nowiki></code>
** '''authorization_name:''' Name of tool or bundled authorization. <code><nowiki>Hot Air Balloon</nowiki></code> or <code><nowiki>General Wood Shop</nowiki></code>
** '''authorizer:''' Name of authorizer, preferably linked to their wiki user page where they can list off better contact info (like their Discord name). <code><nowiki>[[User:kai_hacker|Kai]]</nowiki></code>
** '''schedule_frequency:''' Roughly once a week, month, by request, etc. <code><nowiki>By request</nowiki></code>
** '''discord_channel_link:''' Right click the channel name to get a link. <code><nowiki>https://discord.com/channels/1270929620224704544/1270938360394809489</nowiki></code>
** '''discord_channel_name:''' <code><nowiki>#aviation-club</nowiki></code>
* <span style="color: blue ; ">'''Optional:'''</span>
** '''prerequisites:''' Any other auths the member needs to complete first, etc. <code><nowiki>Completed auth for [[Parachute]]</nowiki></code>
** '''step1:''' Free text field to provide steps needed to complete. <code><nowiki>[https://canvas.pumpingstationone.org/courses/40 Complete the Canvas course]</nowiki></code>
** '''step2:''' Free text field to provide steps needed to complete. <code><nowiki>Use Canvas to schedule with the next available in-person auth</nowiki></code>
** '''step3:''' Free text field to provide steps needed to complete. <code><nowiki>Attend and complete in-person auth</nowiki></code>
** '''required_materials:''' Tools or gear the member should bring. <code><nowiki>Aviator goggles, cape, propane.</nowiki></code>
** '''description:''' Free text field to provide steps needed to complete. <code><nowiki>Will be rescheduled if there's bad weather.</nowiki></code>
: At the end add in links to the tool pages that this auth is required for, after the template, example: <code><nowiki>[[Hot Air Balloon]]</nowiki></code>


; Copy and pasta this into the appropriate area section of [[Authorizations]]:
'''Create the page'''.<br>
<nowiki>{{Template:ToolAuthorization
 
|authslug =  
[[File:Authorization course info template example1.png|600px|frameless|center]]<br>
|authorization_name =  
===Step 2:===
|authorizer =  
 
|schedule_frequency =  
From the '''Insert''' menu select '''Template'''. Type in <code>AuthorizationCourseInfo</code> and select '''AuthorizationCourseInfo'''...<br>
|discord_channel_link =
 
|discord_channel_name =  
[[File:VisualEditor Template Insert Menu-en.png|150px|frameless|center]]<br>
|prerequisites =  
 
|step1 =
[[File:Authorization course info template example4.png|350px|frameless|center]]<br>
|step2 =  
 
|step3 =  
If you don't see the Insert menu, switch over to the visual editor...<br>
|required_materials =  
 
|description =  
[[File:Authorization course info template example3.png|200px|frameless|center]]<br>
}}
 
<!-- List off links to tool pages that this auth is required for -->
If you want to use the code editor, scroll down to find what to copy and paste.
[[Tool page]], [[Tool page]]</nowiki>
 
<nowiki></nowiki>
===Step 3:===
Finally save the [[Authorizations]] page
 
; Linking to the blue authorization info box from tool pages:
'''Fill out the template form.''' Authorization Course Name, Authorizer Name, and Schedule Frequency are required fields. Check mark optional fields on the left as needed.<br>
Once the updated [[Authorizations]] loads, under the blue authorization box you just created you'll see "Wiki snippet for admins: <nowiki>[Expand]</nowiki>. Click on this, copy the snippet code, and paste it into the tool's page under the <span style="font-family: monospace ; " >Template:EquipmentPage</span> template. Save that page and you'll see the blue authorization box there.
 
'''Insert the template.'''<br>
 
[[File:Authorization course info template example5.png|400px|frameless|center]]<br>
 
Description of each field can be found at the end of this page. Refer to this example if you want some inspiration...<br>
 
<table style="background: Crimson; border: 1px solid Black; width=100% ; " align="center"><tr>
<td style="vertical-align: top; padding: 0px 20px 0px 20px; ">
<span style="font-size: 150%; font-weight: bold; color: White ; ">EXAMPLE:</span><br>
{{Template:AuthorizationCourseInfo
|Authorization Course Name=Hot Air Balloon|Authorizer Name=[[User:Jane_hacker|Jane Hacker]]|Schedule Frequency=Roughly once a week|Discord Channel Name=#aviation-club|Discord Channel Link=https://discord.com/channels/1270929620224704544/1271319468055855165|Prerequisites=Completed auth for [[Parachute]]|Step 1=[https://canvas.pumpingstationone.org/courses/40 Complete the Canvas course]|Step 2=Use Canvas to schedule with the next available in-person auth|Step 3=Complete the in-person auth|Required Materials=Aviator goggles, cape, propane.|Notes=Will be rescheduled if there's bad weather.}}</td></tr></table><br>
 
Note that the '''Tools covered'' section will later autopopulate with every page that uses a copy of this Authorization Course Info page.
 
===Step 4:===
 
'''Save the page.''' Do not include any other content on the page.<br>
 
Once the page loads, '''click on the gear icon''' in the bottom right corner of the Authorization Course Info box, and '''copy the insert page code.'''<br>
 
[[File:Authorization course info template example6.png|400px|frameless|center]]<br>
 
===Step 5:===
 
'''Paste the code into all related tool pages and the appropriate section in the [[Authorizations]] page.'''<br>
 
[[File:Authorization course info template example7.png|400px|frameless|center]]<br>
 
===Step 6:===
 
In the future if you want to modify the authorization course info content, click on the go and go to the '''Edit this auth''' link.
 
That's it!

Latest revision as of 13:48, 29 March 2025

Authorization Course Info Box Template

How to create a new authorization info box

Step 1:

Create a new child page under Authorizations using the title of the authorization course. Do not stick "auth" or "authorization" in the name. Note that a single authorization course page is all that's needed to cover multiple tools. To make a new page quickly, type in the name at the end of the URL to the Authorizations...

https://wiki.pumpingstationone.org/wiki/Authorizations/Hot_Air_Balloon

Create the page.


Step 2:

From the Insert menu select Template. Type in AuthorizationCourseInfo and select AuthorizationCourseInfo...

File:VisualEditor Template Insert Menu-en.png



If you don't see the Insert menu, switch over to the visual editor...


If you want to use the code editor, scroll down to find what to copy and paste.

Step 3:

Fill out the template form. Authorization Course Name, Authorizer Name, and Schedule Frequency are required fields. Check mark optional fields on the left as needed.

Insert the template.


Description of each field can be found at the end of this page. Refer to this example if you want some inspiration...

EXAMPLE:

Authorization Course Info

Hot Air Balloon

Authorizer: Jane Hacker
Schedule Frequency: Roughly once a week
Discord Channel: #aviation-club
Prerequisites: Completed auth for Parachute
Step 1: Complete the Canvas course
Step 2: Use Canvas to schedule with the next available in-person auth
Step 3: Complete the in-person auth
Required Materials: Aviator goggles, cape, propane.
Notes: Will be rescheduled if there's bad weather.
Tools covered:
Edit this auth
Copy and paste this into the tool's wiki page
after the Template:EquipmentPage template.
{{:Authorizations/Hot Air Balloon}}
Auth info last updated by Rubin110 on March 29, 2025.


Note that the 'Tools covered section will later autopopulate with every page that uses a copy of this Authorization Course Info page.

Step 4:

Save the page. Do not include any other content on the page.

Once the page loads, click on the gear icon in the bottom right corner of the Authorization Course Info box, and copy the insert page code.


Step 5:

Paste the code into all related tool pages and the appropriate section in the Authorizations page.


Step 6:

In the future if you want to modify the authorization course info content, click on the go and go to the Edit this auth link.

That's it!