ASDSO Dam Safety Toolbox

Guidelines for Creating a Topic Page: Difference between revisions

From ASDSO Dam Safety Toolbox
Jump to: navigation, search
No edit summary
No edit summary
Line 27: Line 27:
----
----
==New Topic Page Template Code==
==New Topic Page Template Code==
<!-- Code for generic [[Topic Page Template]] -->
<!-- Code for generic [[Topic Page Template]] -->


<nowiki><!-- Delete any sections that are not necessary to your topic. Add pictures/sections as needed --> </nowiki></br>
<nowiki></nowiki></br>
<nowiki><!-- Remove Table of Contents from page --></nowiki></br>
<nowiki>__NOTOC__ </nowiki></br>
<nowiki></nowiki></br>
<nowiki><!-- Add Category to drive breadcrumb menus --> </nowiki></br>
<nowiki>[[Category:<!-- Insert parent category here -->]] </nowiki></br>
<nowiki></nowiki></br>
<nowiki><!-- Add link break between breadcrumbs and page content --></nowiki></br>
<nowiki>----</nowiki></br>
<nowiki></nowiki></br>
<nowiki><!-- Insert image using {{Picture}} template --></nowiki></br>
<nowiki>{{Picture </nowiki></br>
<nowiki><!-- Add image file name (ex.image.jpg) --> </nowiki></br>
<nowiki>|image= </nowiki></br>
<nowiki><!--Add link if applicable --> </nowiki></br>
<nowiki>|link= </nowiki></br>
<nowiki><!-- Add picture caption --> </nowiki></br>
<nowiki>|caption= </nowiki></br>
<nowiki>}} </nowiki></br>
<nowiki></nowiki></br>
<nowiki><!-- Introductory paragraph or topic page summary --> </nowiki></br>
<nowiki>Paragraph text </nowiki></br>
<nowiki></nowiki></br>
<nowiki>== Heading Title == </nowiki></br>
<nowiki>Paragraph text </nowiki></br>
<nowiki></nowiki></br>
<nowiki>== Examples == </nowiki></br>
<nowiki>{{Website Icon}} <!-- Internal Link Format --> [[Page Name | Internal Link Text]] </nowiki></br>
<nowiki>{{Website Icon}} <!-- External Link Format --> [External-Link Text] </nowiki></br>
<nowiki>{{Video Icon}} <!-- Internal Link Format --> [[Page Name | Internal Link Text]] </nowiki></br>
<nowiki>{{Video Icon}} <!-- External Link Format --> [External-Link Text] </nowiki></br>
<nowiki></nowiki></br>
<nowiki>== Best Practices Resources == </nowiki></br>
<nowiki>{{Document Icon}} [[Page Name |  Link Text, Author, Publication Date]] </nowiki></br>
<nowiki></nowiki></br>
<nowiki>== Trainings == </nowiki></br>
<nowiki>{{Website Icon}} <!-- Internal Link Format --> [[Page Name | Internal Link Text]] </nowiki></br>
<nowiki>{{Website Icon}} <!-- External Link Format --> [External-Link Text] </nowiki></br>
<nowiki>{{Video Icon}} <!-- Internal Link Format --> [[Page Name | Internal Link Text]] </nowiki></br>
<nowiki>{{Video Icon}} <!-- External Link Format --> [External-Link Text] </nowiki></br>
<nowiki></nowiki></br>
<nowiki><!-- In the location of an in text citation, simply enclose the citation as follows: <ref name="[reference name]"> citation </ref>. Additional citations for the same source use <ref name="[reference name]"/> at the end of the citation. Citations will automatically populate. Learn more at the Guidelines for Inserting a Citation page or visit https://www.mediawiki.org/wiki/Help:Cite. --></nowiki></br>
<nowiki>{{Citations}} </nowiki></br>
<nowiki></nowiki></br>
<nowiki><!-- Revision history information --> </nowiki></br>
<nowiki>{{revhistinf}} </nowiki></br>
----
----


<!-- Revision history information -->
<!-- Revision history information -->
{{revhistinf}}
{{revhistinf}}

Revision as of 20:42, 21 December 2022


Relevant Policies

Below is a list of policies relevant to the creation of a new Topic Page. Click to learn more.

Guidelines for Creating a New Topic Page

Topic Pages introduce a topic by providing relevant background information and peer-reviewed guidance that follows identified Best Practices Resources and are generally between 100-500 words in length. The typical organization of a Topic Page consists of the following items:

  1. Topic title (this item is included in the title of the page)
  2. Introductory paragraph (and image if provided)
  3. List of links to pages on related subtopics or Sections with Guidance on Related Subtopics (when content for related subtopics is short or limited). When content for sections with guidance on related subtopics is added, consider moving the content for these sections to their own subtopic page to prevent the parent topic page from becoming too expansive.
    • Click here for help with creating internal and external links
  4. List of examples that illustrate the concepts explained in the previous section(s). These can be links to content on other websites such as ASDSO's DamFailures.org, news articles, videos, etc.
  5. List of Best Practices Resources that are applicable to the topic described and whose content may have been used in the creation of the previous sections.
  6. List of Trainings that are applicable to the topic such as webinars, presentations, etc. and consist of more than just cursory or introductory information on the topic (if applicable).
  7. List of citations (if any) used in the previous sections. Click here for guidance on using the Citations Template.
    • Click here for guidance on using the Citations Template

New Topic Page Template Code

<!-- Delete any sections that are not necessary to your topic. Add pictures/sections as needed -->

<!-- Remove Table of Contents from page -->
__NOTOC__

<!-- Add Category to drive breadcrumb menus -->
[[Category:<!-- Insert parent category here -->]]

<!-- Add link break between breadcrumbs and page content -->
----

<!-- Insert image using {{Picture}} template -->
{{Picture
<!-- Add image file name (ex.image.jpg) -->
|image=
<!--Add link if applicable -->
|link=
<!-- Add picture caption -->
|caption=
}}

<!-- Introductory paragraph or topic page summary -->
Paragraph text

== Heading Title ==
Paragraph text

== Examples ==
{{Website Icon}} <!-- Internal Link Format --> [[Page Name | Internal Link Text]]
{{Website Icon}} <!-- External Link Format --> [External-Link Text]
{{Video Icon}} <!-- Internal Link Format --> [[Page Name | Internal Link Text]]
{{Video Icon}} <!-- External Link Format --> [External-Link Text]

== Best Practices Resources ==
{{Document Icon}} [[Page Name | Link Text, Author, Publication Date]]

== Trainings ==
{{Website Icon}} <!-- Internal Link Format --> [[Page Name | Internal Link Text]]
{{Website Icon}} <!-- External Link Format --> [External-Link Text]
{{Video Icon}} <!-- Internal Link Format --> [[Page Name | Internal Link Text]]
{{Video Icon}} <!-- External Link Format --> [External-Link Text]

<!-- In the location of an in text citation, simply enclose the citation as follows: <ref name="[reference name]"> citation </ref>. Additional citations for the same source use <ref name="[reference name]"/> at the end of the citation. Citations will automatically populate. Learn more at the Guidelines for Inserting a Citation page or visit https://www.mediawiki.org/wiki/Help:Cite. -->
{{Citations}}

<!-- Revision history information -->
{{revhistinf}}



Revision ID: 6196
Revision Date: 12/21/2022