Guidelines for Creating a Training Page: Difference between revisions
Rmanwaring (talk | contribs) No edit summary |
mNo edit summary |
||
(7 intermediate revisions by 4 users not shown) | |||
Line 2: | Line 2: | ||
[[Category: Dam Safety Toolbox Formatting/Style Guide]] | [[Category: Dam Safety Toolbox Formatting/Style Guide]] | ||
---- | ---- | ||
Training Pages introduce a training resource and presenter(s)/speaker(s), provide a summary with key takeaways, and provide a link to the resource. The typical organization of a Training Page consists of the following items: | Training Pages introduce a training resource and presenter(s)/speaker(s), provide a summary with key takeaways, and provide a link to the resource. The typical organization of a Training Page consists of the following items: | ||
# '''Title of training''' (this item is included in the title of the page) | # '''Title of training''' (this item is included in the title of the page) | ||
# '''Sponsoring organization and date of release''' | # '''Sponsoring organization and date of release''' | ||
# '''Summary of training and key takeaways (list or paragraph format) | # '''List of speakers''' | ||
# '''Summary of training and key takeaways''' (list or paragraph format) | |||
# '''Link to access training resource''' | # '''Link to access training resource''' | ||
Watch the {{Video Icon}} [https://www.youtube.com/watch?v=xBbj5co7occ Dam Safety Toolbox Tutorial: Creating a Training Page] for additional help. | |||
== Step 1: Adding a New Resource to the Catalog == | |||
The first step in adding a training resource to the Dam Safety Toolbox is to add it to the [[Training Opportunities|Training Catalog]]. Before a contributor adds the training to the catalog, they should first ensure that it is not already on the site. Variations in name should be considered in confirming that the training needs to be added. The browser search function can be helpful in doing this. | |||
To add a new training to the catalog, the [[Training Opportunities]] page must be edited by adding the following code to the table: | |||
:''<nowiki>|-</nowiki><br/> | |||
:''<nowiki>| Author || [[Title]] || Year of Publication</nowiki> | |||
The reference should be added to the table in the following order: | |||
#alphabetically by author (A to Z), | |||
#numerically by date (newest to oldest), and | |||
#alphabetically by title. | |||
The title of the training should include a brief descriptor of the type of training (e.g., On-Demand Webinar, PowerPoint Presentation, Curriculum) followed by the descriptive title of the course. | |||
== Step 2: Creating a New Training Resource Page == | |||
Once a training has been added to the [[Training Opportunities | Training Catalog]], an accompanying Training Page can be created. An easy way to create a new page within the wiki is use the "Search Toolbox" utility in the header of the site to search for the exact title of the page you wish to create. If the page or something similar already exists on the site, it will open or appear within the search results. If the page does not exist, an option to create this page will appear at the top of the search results. The title of the page should appear as red text indicating that an internal hyperlink has been created, but the linked page does not yet exist. By clicking on the red title link, the contributor is taken to the content editor for the new training page. The contributor then simply follows the instructions and template below to complete the creation of the new training page. | |||
---- | ---- | ||
== | == Training Page Template Code == | ||
The following template code should be copied and pasted into the editor when creating a new training page to facilitate the process of creating, formatting, and reviewing new content. Contributors should not add or delete sections of code except where specified. If specific items are not applicable or unavailable, these fields should be left blank. | |||
<!-- Code for generic Training Page Template]] --> | <!-- Code for generic Training Page Template]] --> | ||
<nowiki>{{Trainings Template</nowiki></br> | ''<nowiki>{{Trainings Template</nowiki></br> | ||
<nowiki></nowiki></br> | ''<nowiki></nowiki></br> | ||
<nowiki>|author= | ''<nowiki>|author= <!-- Add author/publisher on blank line below--></nowiki></br> | ||
''<nowiki></nowiki></br> | |||
<nowiki></nowiki></br> | ''<nowiki>|year=<!-- Add publication year on blank line below--></nowiki></br> | ||
<nowiki>|year= | ''<nowiki></nowiki></br> | ||
''<nowiki>|abstract= <!-- Add presentation summary on blank line below--></nowiki></br> | |||
<nowiki></nowiki></br> | ''<nowiki></nowiki></br> | ||
<nowiki>|abstract= | ''<nowiki></nowiki></br> | ||
''<nowiki>Key Takeaways:<!-- Use bulleted / ordered list on blank lines below (add/delete lines as necessary) --></nowiki></br> | |||
<nowiki></nowiki></br> | ''<nowiki>*</nowiki></br> | ||
<nowiki> | ''<nowiki>*</nowiki></br> | ||
<nowiki> | ''<nowiki>|link= <!-- Add URL to access training on blank line below--></nowiki></br> | ||
<nowiki></nowiki></br> | ''<nowiki></nowiki></br> | ||
<nowiki> | ''<nowiki>|speaker(s)=<!-- Add list of speakers on a single, blank line below --></nowiki></br> | ||
<nowiki><!-- Add | ''<nowiki></nowiki></br> | ||
<nowiki></nowiki></br> | ''<nowiki>}}</nowiki></br> | ||
<nowiki>|speaker(s)= | |||
<nowiki></nowiki></br> | |||
<nowiki>}}</nowiki></br> | |||
---- | ---- |
Latest revision as of 05:24, 18 January 2024
Training Pages introduce a training resource and presenter(s)/speaker(s), provide a summary with key takeaways, and provide a link to the resource. The typical organization of a Training Page consists of the following items:
- Title of training (this item is included in the title of the page)
- Sponsoring organization and date of release
- List of speakers
- Summary of training and key takeaways (list or paragraph format)
- Link to access training resource
Watch the
Dam Safety Toolbox Tutorial: Creating a Training Page for additional help.
Step 1: Adding a New Resource to the Catalog
The first step in adding a training resource to the Dam Safety Toolbox is to add it to the Training Catalog. Before a contributor adds the training to the catalog, they should first ensure that it is not already on the site. Variations in name should be considered in confirming that the training needs to be added. The browser search function can be helpful in doing this.
To add a new training to the catalog, the Training Opportunities page must be edited by adding the following code to the table:
- |-
- | Author || [[Title]] || Year of Publication
The reference should be added to the table in the following order:
- alphabetically by author (A to Z),
- numerically by date (newest to oldest), and
- alphabetically by title.
The title of the training should include a brief descriptor of the type of training (e.g., On-Demand Webinar, PowerPoint Presentation, Curriculum) followed by the descriptive title of the course.
Step 2: Creating a New Training Resource Page
Once a training has been added to the Training Catalog, an accompanying Training Page can be created. An easy way to create a new page within the wiki is use the "Search Toolbox" utility in the header of the site to search for the exact title of the page you wish to create. If the page or something similar already exists on the site, it will open or appear within the search results. If the page does not exist, an option to create this page will appear at the top of the search results. The title of the page should appear as red text indicating that an internal hyperlink has been created, but the linked page does not yet exist. By clicking on the red title link, the contributor is taken to the content editor for the new training page. The contributor then simply follows the instructions and template below to complete the creation of the new training page.
Training Page Template Code
The following template code should be copied and pasted into the editor when creating a new training page to facilitate the process of creating, formatting, and reviewing new content. Contributors should not add or delete sections of code except where specified. If specific items are not applicable or unavailable, these fields should be left blank.
{{Trainings Template
|author= <!-- Add author/publisher on blank line below-->
|year=<!-- Add publication year on blank line below-->
|abstract= <!-- Add presentation summary on blank line below-->
Key Takeaways:<!-- Use bulleted / ordered list on blank lines below (add/delete lines as necessary) -->
*
*
|link= <!-- Add URL to access training on blank line below-->
|speaker(s)=<!-- Add list of speakers on a single, blank line below -->
}}
Revision ID: 7794
Revision Date: 01/18/2024