Template:PageTitle: Difference between revisions

Revision as of 15:13, 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 )

Usage Examples

Example 01 (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 02 (using switches)

Code:

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

{{PageTitle|logo=nomanssky|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

Your Title Here

Your subtitle text here

by: Team XYZ | Forum Topic

Example 03

No Subtitle

Code:

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

Result:

Your Title Here

by: Team XYZ | Forum Topic

Title Only

Code:

{{PageTitle|title=Your Title Here}}

Result:

Your Title Here

@@ Line 57: / Line 57: @@
 : '''How to use:''' <code>forumtid=<uniqueForumID></code> (e.g. <code>forumtid=14917</code> )
-==Example 01 (title only)==
+==Usage Examples==
-'''Code:'''
+===Example 01 (all options w/default logo)===
-<pre>{{PageTitle|title=Your Title Here}}</pre>
+: '''Code:'''
-'''Result:'''
+:: <code><nowiki>{{PageTitle|logo=delta|title=Your Title Here|subtitle=Your subtitle text here|author= Team XYZ|forumtid=423}}</nowiki></code>
-{{PageTitle|title=Your Title Here}}
+: '''Result:'''
-<br/>
+:: {{PageTitle|logo=delta|title=Your Title Here|subtitle=Your subtitle text here|author= Team XYZ|forumtid=423}}
-<br/>
+<br>
+<hr>
+<hr>
-==Example 02 (all options w/default logo)==
+===Example 02 (using switches)===
-'''Code:'''
+: '''Code:'''
-<pre>{{PageTitle|logo=delta|title=Your Title Here|subtitle=Your subtitle text here|author= Team XYZ|forumtid=423}}</pre>
+:: <code><nowiki>{{PageTitle|logo=fo3|title=Your Title Here|subtitle=Your subtitle text here|author= Team XYZ|forumtid=423}}</nowiki></code>
-'''Result:'''
+:: <code><nowiki>{{PageTitle|logo=nomanssky|title=Your Title Here|subtitle=Your subtitle text here|author= Team XYZ|forumtid=423}}</nowiki></code>
-{{PageTitle|logo=delta|title=Your Title Here|subtitle=Your subtitle text here|author= Team XYZ|forumtid=423}}
+: '''Result:'''
+:: {{PageTitle|logo=fo3|title=Your Title Here|subtitle=Your subtitle text here|author= Team XYZ|forumtid=423}}
+:: {{PageTitle|logo=nomanssky|title=Your Title Here|subtitle=Your subtitle text here|author= Team XYZ|forumtid=423}}
+<br>
+<hr>
+<hr>
-==Example 03 (all options w/custom logo)==
+===Example 03 ===
-'''Code:'''
+==== No Subtitle ====
-<pre>{{PageTitle|logo=Fallout3.png|title=Your Title Here|subtitle=Your subtitle text here|author=Team XYZ|forumtid=423}}</pre>
+: '''Code:'''
-'''Result:'''
+:: <code><nowiki>{{PageTitle|logo=delta|title=Your Title Here|author= Team XYZ|forumtid=423}}</nowiki></code><br>
-{{PageTitle|logo=Fallout3.png|title=Your Title Here|subtitle=Your subtitle text here|author=Team XYZ|forumtid=423}}
+: '''Result:'''
+:: {{PageTitle|logo=delta|title=Your Title Here|author= Team XYZ|forumtid=423}}
-'''Code:'''
-<pre>{{PageTitle|logo=TechGuideImage.png|title=Your Title Here|subtitle=Your subtitle text here|author=Team XYZ|forumtid=423}}</pre>
-'''Result:'''
-{{PageTitle|logo=TechGuideImage.png|title=Your Title Here|subtitle=Your subtitle text here|author=Team XYZ|forumtid=423}}
-==Example 04 (wo/subtitle)==
-'''Code:'''
-<pre>{{PageTitle|logo=delta|title=Your Title Here|author= Team XYZ|forumtid=423}}</pre>
-'''Result:'''
-{{PageTitle|logo=delta|title=Your Title Here|author= Team XYZ|forumtid=423}}
-==Example 05 (wo/subtitle or forum topic)==
-'''Code:'''
-<pre>{{PageTitle|logo=delta|title=Your Title Here|author= Team XYZ}}</pre>
-'''Result:'''
-{{PageTitle|logo=delta|title=Your Title Here|author= Team XYZ}}
-==Example 06 (wo/author or forum topic)==
-'''Code:'''
-<pre>{{PageTitle|logo=delta|title=Your Title Here|author= Team XYZ}}</pre>
-'''Result:'''
-{{PageTitle|logo=delta|title=Your Title Here|subtitle=Your subtitle text here}}
-==Example 07 (wo/author, subtitle or forum topic)==
-'''Code:'''
-<pre>{{PageTitle|logo=delta|title=Your Title Here|author= Team XYZ}}</pre>
-'''Result:'''
-{{PageTitle|logo=delta|title=Your Title Here}}
+==== Title Only ====
+: '''Code:'''
+:: <code><nowiki>{{PageTitle|title=Your Title Here}}</nowiki></code><br>
+: '''Result:'''
+:: {{PageTitle|title=Your Title Here}}
+<br>
 </noinclude>