Guidelines for Creating a Topic Page - Revision history

Aideng@uci.edu at 05:23, 18 January 2024

2024-01-18T05:23:25Z

← Older revision		Revision as of 05:23, 18 January 2024
Line 5:		Line 5:

	Where appropriate, headings should be included to organize and distinguish between subsections of a single Topic Page. If more than a few subsections are needed to convey the information for a single topic page, the creation of new subtopic pages for each of the subsections should be considered. This will help keep Topic Pages concise and focused, thereby increasing the ability to link between subtopic pages and reducing the potential for redundancies in content.		Where appropriate, headings should be included to organize and distinguish between subsections of a single Topic Page. If more than a few subsections are needed to convey the information for a single topic page, the creation of new subtopic pages for each of the subsections should be considered. This will help keep Topic Pages concise and focused, thereby increasing the ability to link between subtopic pages and reducing the potential for redundancies in content.

			Watch the {{Video Icon}} [https://www.youtube.com/watch?v=SmMctTfnz78 Dam Safety Toolbox Tutorial: Creating a New Topic Page] for additional help.

	== Naming and Creating a New Topic Page ==		== Naming and Creating a New Topic Page ==

Grichards@gfnet.com at 15:34, 30 October 2023

2023-10-30T15:34:06Z

← Older revision		Revision as of 15:34, 30 October 2023
Line 9:		Line 9:
	Care should be taken when naming a new Topic Page. Avoid simplistic titles or terms that can mean multiple things or apply to more than one discipline. Rather, names of Topic Pages should be as specific as possible. For example, if creating a page about the design of relief wells, the page should be called "Design of Relief Wells." If it was simply called "Design", this generic page title may inadvertently auto-link to other pages on the website where the term "design" is used but a link to the very specific topic of relief wells is not appropriate.		Care should be taken when naming a new Topic Page. Avoid simplistic titles or terms that can mean multiple things or apply to more than one discipline. Rather, names of Topic Pages should be as specific as possible. For example, if creating a page about the design of relief wells, the page should be called "Design of Relief Wells." If it was simply called "Design", this generic page title may inadvertently auto-link to other pages on the website where the term "design" is used but a link to the very specific topic of relief wells is not appropriate.

	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. In cases where similar content or page titles already exist, the existing page should be edited where possible to avoid duplication of content. 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 ~~reference~~ 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 topic page. The contributor then simply follows the instructions and template below to complete the creation of the new topic page.		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. In cases where similar content or page titles already exist, the existing page should be edited where possible to avoid duplication of content. 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 topic page. The contributor then simply follows the instructions and template below to complete the creation of the new topic page.

	== Typical Topic Page Content ==		== Typical Topic Page Content ==

Grichards@gfnet.com at 15:30, 30 October 2023

2023-10-30T15:30:30Z

← Older revision		Revision as of 15:30, 30 October 2023
Line 9:		Line 9:
	Care should be taken when naming a new Topic Page. Avoid simplistic titles or terms that can mean multiple things or apply to more than one discipline. Rather, names of Topic Pages should be as specific as possible. For example, if creating a page about the design of relief wells, the page should be called "Design of Relief Wells." If it was simply called "Design", this generic page title may inadvertently auto-link to other pages on the website where the term "design" is used but a link to the very specific topic of relief wells is not appropriate.		Care should be taken when naming a new Topic Page. Avoid simplistic titles or terms that can mean multiple things or apply to more than one discipline. Rather, names of Topic Pages should be as specific as possible. For example, if creating a page about the design of relief wells, the page should be called "Design of Relief Wells." If it was simply called "Design", this generic page title may inadvertently auto-link to other pages on the website where the term "design" is used but a link to the very specific topic of relief wells is not appropriate.

	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 reference 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 topic page. The contributor then simply follows the instructions and template below to complete the creation of the new topic page.		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. In cases where similar content or page titles already exist, the existing page should be edited where possible to avoid duplication of content. 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 reference 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 topic page. The contributor then simply follows the instructions and template below to complete the creation of the new topic page.

	== Typical Topic Page Content ==		== Typical Topic Page Content ==

Grichards@gfnet.com at 15:26, 30 October 2023

2023-10-30T15:26:19Z

← Older revision		Revision as of 15:26, 30 October 2023
Line 9:		Line 9:
	Care should be taken when naming a new Topic Page. Avoid simplistic titles or terms that can mean multiple things or apply to more than one discipline. Rather, names of Topic Pages should be as specific as possible. For example, if creating a page about the design of relief wells, the page should be called "Design of Relief Wells." If it was simply called "Design", this generic page title may inadvertently auto-link to other pages on the website where the term "design" is used but a link to the very specific topic of relief wells is not appropriate.		Care should be taken when naming a new Topic Page. Avoid simplistic titles or terms that can mean multiple things or apply to more than one discipline. Rather, names of Topic Pages should be as specific as possible. For example, if creating a page about the design of relief wells, the page should be called "Design of Relief Wells." If it was simply called "Design", this generic page title may inadvertently auto-link to other pages on the website where the term "design" is used but a link to the very specific topic of relief wells is not appropriate.

	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 reference 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 ~~resource~~ page. The contributor then simply follows the instructions and template below to complete the creation of the new topic page.		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 reference 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 topic page. The contributor then simply follows the instructions and template below to complete the creation of the new topic page.

	== Typical Topic Page Content ==		== Typical Topic Page Content ==

Grichards@gfnet.com at 15:25, 30 October 2023

2023-10-30T15:25:05Z

← Older revision		Revision as of 15:25, 30 October 2023
Line 6:		Line 6:
	Where appropriate, headings should be included to organize and distinguish between subsections of a single Topic Page. If more than a few subsections are needed to convey the information for a single topic page, the creation of new subtopic pages for each of the subsections should be considered. This will help keep Topic Pages concise and focused, thereby increasing the ability to link between subtopic pages and reducing the potential for redundancies in content.		Where appropriate, headings should be included to organize and distinguish between subsections of a single Topic Page. If more than a few subsections are needed to convey the information for a single topic page, the creation of new subtopic pages for each of the subsections should be considered. This will help keep Topic Pages concise and focused, thereby increasing the ability to link between subtopic pages and reducing the potential for redundancies in content.

	== Naming a New Topic Page ==		== Naming and Creating a New Topic Page ==
	Care should be taken when naming a new Topic Page. Avoid simplistic titles or terms that can mean multiple things or apply to more than one discipline. Rather, names of Topic Pages should be as specific as possible. For example, if creating a page about the design of relief wells, the page should be called "Design of Relief Wells." If it was simply called "Design", this generic page title may inadvertently auto-link to other pages on the website where the term "design" is used but a link to the very specific topic of relief wells is not appropriate.		Care should be taken when naming a new Topic Page. Avoid simplistic titles or terms that can mean multiple things or apply to more than one discipline. Rather, names of Topic Pages should be as specific as possible. For example, if creating a page about the design of relief wells, the page should be called "Design of Relief Wells." If it was simply called "Design", this generic page title may inadvertently auto-link to other pages on the website where the term "design" is used but a link to the very specific topic of relief wells is not appropriate.

			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 reference 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 resource page. The contributor then simply follows the instructions and template below to complete the creation of the new topic page.

	== Typical Topic Page Content ==		== Typical Topic Page Content ==

Grichards@gfnet.com at 20:10, 28 September 2023

2023-09-28T20:10:45Z

← Older revision		Revision as of 20:10, 28 September 2023
Line 31:		Line 31:
	#* ''[[Guidelines for Inserting Links \| Learn how to create internal and external links]]''		#* ''[[Guidelines for Inserting Links \| Learn how to create internal and external links]]''
	#* ''[[Guidelines for Using Templates \| Learn how to create icons for document, website, and video hyperlinks]]''		#* ''[[Guidelines for Using Templates \| Learn how to create icons for document, website, and video hyperlinks]]''
	# '''List of Other Resources''' that are applicable to the topic of interest. Other resources are not as thoroughly vetted as best practices documents, but are still valuable resources for dam safety professionals. Examples include guidance documents and tools developed by state dam safety agencies, landmark technical papers, ~~and~~ academic research ~~supporting the broad spectrum of dam safety topics~~.		# '''List of Other Resources''' that are applicable to the topic of interest. Other resources are not as thoroughly vetted as best practices documents, but are still valuable resources for dam safety professionals. Examples include guidance documents and tools developed by state dam safety agencies, landmark technical papers, or academic research.
	#* [[Guidelines for Creating a Resource Page \| ''Learn how to create an Other Resource Page'']]		#* [[Guidelines for Creating a Resource Page \| ''Learn how to create an Other Resource Page'']]
	#* ''[[Guidelines for Inserting Links \| Learn how to create internal and external links]]''		#* ''[[Guidelines for Inserting Links \| Learn how to create internal and external links]]''

Grichards@gfnet.com at 20:09, 28 September 2023

2023-09-28T20:09:00Z

← Older revision		Revision as of 20:09, 28 September 2023
Line 34:		Line 34:
	#* [[Guidelines for Creating a Resource Page \| ''Learn how to create an Other Resource Page'']]		#* [[Guidelines for Creating a Resource Page \| ''Learn how to create an Other Resource Page'']]
	#* ''[[Guidelines for Inserting Links \| Learn how to create internal and external links]]''		#* ''[[Guidelines for Inserting Links \| Learn how to create internal and external links]]''
	#* ''[[Guidelines for Using Templates \| Learn how to create icons for document, website, and video hyperlinks]]''# '''List of Trainings''' that are applicable to the topic such as webinars, presentations, etc.		#* ''[[Guidelines for Using Templates \| Learn how to create icons for document, website, and video hyperlinks]]''
			# '''List of Trainings''' that are applicable to the topic such as webinars, presentations, etc.
	#* [[Guidelines for Creating a Training Page \| ''Learn how to create a new Training Page'']]		#* [[Guidelines for Creating a Training Page \| ''Learn how to create a new Training Page'']]
	#* ''[[Guidelines for Inserting Links \| Learn how to create internal and external links]]''		#* ''[[Guidelines for Inserting Links \| Learn how to create internal and external links]]''

Grichards@gfnet.com at 20:08, 28 September 2023

2023-09-28T20:08:04Z

← Older revision		Revision as of 20:08, 28 September 2023
Line 27:		Line 27:
	#* ''[[Guidelines for Inserting Links \| Learn how to create internal and external links]]''		#* ''[[Guidelines for Inserting Links \| Learn how to create internal and external links]]''
	#* ''[[Guidelines for Using Templates \| Learn how to create icons for document, website, and video hyperlinks]]''		#* ''[[Guidelines for Using Templates \| Learn how to create icons for document, website, and video hyperlinks]]''
	# '''List of Best Practices Resources''' that are applicable to the topic of interest.		# '''List of Best Practices Resources''' that are applicable to the topic of interest. Best practices resources are defined as documents that are highly vetted and widely accepted in the dam safety industry (e.g., federal agency documents).
	#* [[Guidelines for Creating a ~~Best Practices~~ Resource Page \| ''Learn how to create a New Best Practices Resource Page'']]		#* [[Guidelines for Creating a Resource Page \| ''Learn how to create a New Best Practices Resource Page'']]
	#* ''[[Guidelines for Inserting Links \| Learn how to create internal and external links]]''		#* ''[[Guidelines for Inserting Links \| Learn how to create internal and external links]]''
	#* ''[[Guidelines for Using Templates \| Learn how to create icons for document, website, and video hyperlinks]]''		#* ''[[Guidelines for Using Templates \| Learn how to create icons for document, website, and video hyperlinks]]''
	# '''List of Trainings''' that are applicable to the topic such as webinars, presentations, etc.		# '''List of Other Resources''' that are applicable to the topic of interest. Other resources are not as thoroughly vetted as best practices documents, but are still valuable resources for dam safety professionals. Examples include guidance documents and tools developed by state dam safety agencies, landmark technical papers, and academic research supporting the broad spectrum of dam safety topics.
			#* [[Guidelines for Creating a Resource Page \| ''Learn how to create an Other Resource Page'']]
			#* ''[[Guidelines for Inserting Links \| Learn how to create internal and external links]]''
			#* ''[[Guidelines for Using Templates \| Learn how to create icons for document, website, and video hyperlinks]]''# '''List of Trainings''' that are applicable to the topic such as webinars, presentations, etc.
	#* [[Guidelines for Creating a Training Page \| ''Learn how to create a new Training Page'']]		#* [[Guidelines for Creating a Training Page \| ''Learn how to create a new Training Page'']]
	#* ''[[Guidelines for Inserting Links \| Learn how to create internal and external links]]''		#* ''[[Guidelines for Inserting Links \| Learn how to create internal and external links]]''
Line 41:		Line 44:


	==~~Best Practices~~ Resources, Trainings, and Examples==		==Resources, Trainings, and Examples==
	When creating and updating a Topic Page, it is important to make sure that the content is supported by links to the best resources that are available about that topic. Contributors and moderators should review the following lists of resources that have been uploaded to the Dam Safety Toolbox and add links to topic pages as appropriate.		When creating and updating a Topic Page, it is important to make sure that the content is supported by links to the best resources that are available about that topic. Contributors and moderators should review the following lists of resources that have been uploaded to the Dam Safety Toolbox and add links to topic pages as appropriate.
	*[[Best Practices Resources Catalog]]		*[[Best Practices Resources Catalog]]
			*[[Other Resources Catalog]]
	*[[Training Opportunities \| Training Catalog]]		*[[Training Opportunities \| Training Catalog]]
	*[https://damtoolbox.org/wiki/Category:Example_Pages Example Page Listing]		*[https://damtoolbox.org/wiki/Category:Example_Pages Example Page Listing]

	If important references are missing from the website, they should be added to the site as part of the Topic Page creation process and subsequently linked to the Topic Page in accordance with the following:		If important references are missing from the website, they should be added to the site as part of the Topic Page creation process and subsequently linked to the Topic Page in accordance with the following:
	*[[Guidelines for Creating a ~~Best Practices~~ Resource Page]]		*[[Guidelines for Creating a Resource Page]]
	*[[Guidelines for Creating a Training Page]]		*[[Guidelines for Creating a Training Page]]
	*[[Guidelines for Creating an Example Page]]		*[[Guidelines for Creating an Example Page]]
Line 86:		Line 90:
	''<nowiki><!-- To facilitate updates to the website, do not include the year/date of a reference listed here in the Best Practices Resources section. --></nowiki></br>		''<nowiki><!-- To facilitate updates to the website, do not include the year/date of a reference listed here in the Best Practices Resources section. --></nowiki></br>
	''<nowiki>== Best Practices Resources == </nowiki></br>		''<nowiki>== Best Practices Resources == </nowiki></br>
			''<nowiki>{{Document Icon}} [[Page Name \| Title, Author]] </nowiki></br>
			''<nowiki></nowiki></br>
			''<nowiki>== Other Resources == </nowiki></br>
	''<nowiki>{{Document Icon}} [[Page Name \| Title, Author]] </nowiki></br>		''<nowiki>{{Document Icon}} [[Page Name \| Title, Author]] </nowiki></br>
	''<nowiki></nowiki></br>		''<nowiki></nowiki></br>

Mpollei@gfnet.com at 16:58, 17 July 2023

2023-07-17T16:58:41Z

← Older revision		Revision as of 16:58, 17 July 2023
Line 42:		Line 42:

	==Best Practices Resources, Trainings, and Examples==		==Best Practices Resources, Trainings, and Examples==
	When creating and updating a Topic Page, it is important to make sure that the content is supported by links to the best resources that are available about that topic. Contributors and ~~editors~~ should review the following lists of resources that have been uploaded to the Dam Safety Toolbox and add links to topic pages as appropriate.		When creating and updating a Topic Page, it is important to make sure that the content is supported by links to the best resources that are available about that topic. Contributors and moderators should review the following lists of resources that have been uploaded to the Dam Safety Toolbox and add links to topic pages as appropriate.
	*[[Best Practices Resources Catalog]]		*[[Best Practices Resources Catalog]]
	*[[Training Opportunities \| Training Catalog]]		*[[Training Opportunities \| Training Catalog]]
Line 54:		Line 54:
	----		----
	== New Topic Page Template Code ==		== New Topic Page Template Code ==
	The following template code should be copied and pasted into the editor when creating a new Topic Page to facilitate the process of creating, formatting, and reviewing new content. ~~Users~~ should add or delete sections, pictures, and code as necessary for a specific topic.		The following template code should be copied and pasted into the editor when creating a new Topic Page to facilitate the process of creating, formatting, and reviewing new content. Contributors should add or delete sections, pictures, and code as necessary for a specific topic.

	''<nowiki><!-- Default code to remove table of contents and add line break at top of page --></nowiki></br>		''<nowiki><!-- Default code to remove table of contents and add line break at top of page --></nowiki></br>

Grichards@gfnet.com at 16:23, 10 July 2023

2023-07-10T16:23:01Z

← Older revision		Revision as of 16:23, 10 July 2023
Line 84:		Line 84:
	''<nowiki>{{Video Icon}} <!-- External Link Format --> [ExternalURL Displayed Text] </nowiki></br>		''<nowiki>{{Video Icon}} <!-- External Link Format --> [ExternalURL Displayed Text] </nowiki></br>
	''<nowiki></nowiki></br>		''<nowiki></nowiki></br>
			''<nowiki><!-- To facilitate updates to the website, do not include the year/date of a reference listed here in the Best Practices Resources section. --></nowiki></br>
	''<nowiki>== Best Practices Resources == </nowiki></br>		''<nowiki>== Best Practices Resources == </nowiki></br>
	''<nowiki>{{Document Icon}} [[Page Name \| Title, Author]] </nowiki></br>		''<nowiki>{{Document Icon}} [[Page Name \| Title, Author]] </nowiki></br>

← Older revision		Revision as of 20:10, 28 September 2023
Line 31:		Line 31:
	#* ''[[Guidelines for Inserting Links \| Learn how to create internal and external links]]''		#* ''[[Guidelines for Inserting Links \| Learn how to create internal and external links]]''
	#* ''[[Guidelines for Using Templates \| Learn how to create icons for document, website, and video hyperlinks]]''		#* ''[[Guidelines for Using Templates \| Learn how to create icons for document, website, and video hyperlinks]]''
	# '''List of Other Resources''' that are applicable to the topic of interest. Other resources are not as thoroughly vetted as best practices documents, but are still valuable resources for dam safety professionals. Examples include guidance documents and tools developed by state dam safety agencies, landmark technical papers, ~~and~~ academic research ~~supporting the broad spectrum of dam safety topics~~.		# '''List of Other Resources''' that are applicable to the topic of interest. Other resources are not as thoroughly vetted as best practices documents, but are still valuable resources for dam safety professionals. Examples include guidance documents and tools developed by state dam safety agencies, landmark technical papers, or academic research.
	#* [[Guidelines for Creating a Resource Page \| ''Learn how to create an Other Resource Page'']]		#* [[Guidelines for Creating a Resource Page \| ''Learn how to create an Other Resource Page'']]
	#* ''[[Guidelines for Inserting Links \| Learn how to create internal and external links]]''		#* ''[[Guidelines for Inserting Links \| Learn how to create internal and external links]]''

← Older revision		Revision as of 20:09, 28 September 2023
Line 34:		Line 34:
	#* [[Guidelines for Creating a Resource Page \| ''Learn how to create an Other Resource Page'']]		#* [[Guidelines for Creating a Resource Page \| ''Learn how to create an Other Resource Page'']]
	#* ''[[Guidelines for Inserting Links \| Learn how to create internal and external links]]''		#* ''[[Guidelines for Inserting Links \| Learn how to create internal and external links]]''
	#* ''[[Guidelines for Using Templates \| Learn how to create icons for document, website, and video hyperlinks]]''# '''List of Trainings''' that are applicable to the topic such as webinars, presentations, etc.		#* ''[[Guidelines for Using Templates \| Learn how to create icons for document, website, and video hyperlinks]]''
			# '''List of Trainings''' that are applicable to the topic such as webinars, presentations, etc.
	#* [[Guidelines for Creating a Training Page \| ''Learn how to create a new Training Page'']]		#* [[Guidelines for Creating a Training Page \| ''Learn how to create a new Training Page'']]
	#* ''[[Guidelines for Inserting Links \| Learn how to create internal and external links]]''		#* ''[[Guidelines for Inserting Links \| Learn how to create internal and external links]]''