Template:PageTitle: Difference between revisions

Revision as of 15:12, June 19, 2021

Purpose & Usage

Used at top of pages to include a standardized page-title header. This template relies upon global CSS classes.

NOTE

The format for image icons is 105+ px X 105+ px with 5px transparency on the right (PNG). This template also includes the __NOTITLE__ by default, therefore, it's not necessary to include it on the page when the PageTitle template is used.

Parameters:

Required

title=: This is the text that displays for the title and is a required parameter.; How to use: title=text

Optional

logo=

(optional) Displays a logo to the left of the content

Notes:

Logos are constrained to a minimum of 105px in width. Images with H > W work best.
User should upload logo images used in combination with this template to the wiki.
If this parameter is left out, then the Step delta logo will be displayed.

How to use: logo=<uploadedFileName> or <switch> (e.g. logo=Delta_c.png or logo=fo3 )

Available switches:

fo3
fo4
fnv
nomanssky
skyrim
skyrimse

classList=

(optional) This is used to provide a list of classes that are applied to the image.

Notes:

Will only work with classes that are pre-defined and those that work on images.
Multiple classes are separated by a blank space.

How to use: classList=p-3 rounded-circle

subtitle=: (optional) This is the text that displays for the subtitle.; How to use: subtitle=text

author=: (optional) field for the author(s); How to use: author=text

forumtid=

(optional) use a forum topic's ID to include a link to related forum topic

Notes:

The <uniqueForumID> is found in the forum topic's URL:
https://stepmodifications.org/forum/topic/14917-system-setup-guide/

How to use: forumtid=<uniqueForumID> (e.g. forumtid=14917 )

Example 01 (title only)

Code:

{{PageTitle|title=Your Title Here}}

Result:

Your Title Here

Example 02 (all options w/default logo)

Code:

{{PageTitle|logo=delta|title=Your Title Here|subtitle=Your subtitle text here|author= Team XYZ|forumtid=423}}

Result:

Your Title Here

Your subtitle text here

by: Team XYZ | Forum Topic

Example 03 (all options w/custom logo)

Code:

{{PageTitle|logo=Fallout3.png|title=Your Title Here|subtitle=Your subtitle text here|author=Team XYZ|forumtid=423}}

Result:

Your Title Here

Your subtitle text here

by: Team XYZ | Forum Topic

Code:

{{PageTitle|logo=TechGuideImage.png|title=Your Title Here|subtitle=Your subtitle text here|author=Team XYZ|forumtid=423}}

Result:

Your Title Here

Your subtitle text here

by: Team XYZ | Forum Topic

Example 04 (wo/subtitle)

Code:

{{PageTitle|logo=delta|title=Your Title Here|author= Team XYZ|forumtid=423}}

Result:

Your Title Here

by: Team XYZ | Forum Topic

Example 05 (wo/subtitle or forum topic)

Code:

{{PageTitle|logo=delta|title=Your Title Here|author= Team XYZ}}

Result:

Your Title Here

by: Team XYZ

Example 06 (wo/author or forum topic)

Code:

{{PageTitle|logo=delta|title=Your Title Here|author= Team XYZ}}

Result:

Your Title Here

Your subtitle text here

Example 07 (wo/author, subtitle or forum topic)

Code:

{{PageTitle|logo=delta|title=Your Title Here|author= Team XYZ}}

Result:

Your Title Here

@@ Line 15: / Line 15: @@
 ===Parameters:===
-* '''''logo'':''' (optional) Displays a logo to the left of the content
+==== Required ====
-** fill with the file name (with extension) of an uploaded image (e.g. Delta_c.png )
+; {{fc|red|<nowiki>title=</nowiki>}}
-** if ''logo=delta'', then the Step delta logo will be displayed
+: This is the text that displays for the title and is a required parameter.
-* '''''title''''': is the text for the title
+: '''How to use:''' <code>title=text</code>
-* '''''subtitle''''': (optional) this is this the text that appears below the title.
-* '''''author''''': (optional) field for the author(s)
+==== Optional ====
-* '''''forumtid''''': (optional) use a ''forum topic's ID'' to include a link to related forum topic
+; {{fc|green|<nowiki>logo=</nowiki>}}
+: (optional) Displays a logo to the left of the content
+: '''Notes:'''
+:* Logos are constrained to a minimum of '''105px''' in width. Images with H > W work best.
+:* User should [[Special:Upload|upload logo images]] used in combination with this template to the wiki.
+:* If this parameter is left out, then the Step delta logo will be displayed.
+: '''How to use:''' <code>logo=<uploadedFileName> or <switch></code> (e.g. <code>logo=Delta_c.png</code> or <code>logo=fo3</code>  )
+:: Available switches:
+::* fo3
+::* fo4
+::* fnv
+::* nomanssky
+::* skyrim
+::* skyrimse
+; {{fc|green|<nowiki>classList=</nowiki>}}
+: (optional) This is used to provide a list of classes that are applied to the image.
+: '''Notes:'''
+:* Will only work with classes that are pre-defined and those that work on images.
+:* Multiple classes are separated by a blank space.
+: '''How to use:''' <code>classList=p-3 rounded-circle</code>
+; {{fc|green|<nowiki>subtitle=</nowiki>}}
+: (optional) This is the text that displays for the subtitle.
+: '''How to use:''' <code>subtitle=text</code>
+; {{fc|green|<nowiki>author=</nowiki>}}
+: (optional) field for the author(s)
+: '''How to use:''' <code>author=text</code>
+; {{fc|green|<nowiki>forumtid=</nowiki>}}
+: (optional) use a ''forum topic's ID'' to include a link to related forum topic
+: '''Notes:
+:* The <uniqueForumID> is found in the forum topic's URL:<br>{{fc|important|<nowiki>https://stepmodifications.org/forum/topic/</nowiki>{{fc|yellow|'''14917'''}}<nowiki>-system-setup-guide/</nowiki>}}
+: '''How to use:''' <code>forumtid=<uniqueForumID></code> (e.g. <code>forumtid=14917</code> )
 ==Example 01 (title only)==