Template:Guide/doc: Difference between revisions

From Path of Exile 2 Wiki
Jump to navigation Jump to search
m (Reverted edits by Angelic knight (talk) to last revision by Vinifera7)
No edit summary
 
(4 intermediate revisions by 2 users not shown)
Line 4: Line 4:


==Usage==
==Usage==
This template should be placed at the top the guide.
This template should be placed at the top of the guide.


The subject of the guide should be specified with <code>|subject=</code>.
The subject of the guide should be specified with <code>|subject=</code>.
Line 17: Line 17:


<pre>{{Guide|version=2.2.0}}</pre>
<pre>{{Guide|version=2.2.0}}</pre>
An additional note to readers can be added with <code>|note=</code>. This parameter is optional.
<pre>{{Guide|note=This guide pertains to an older version of Path of Exile.}}</pre>
Articles using this template are automatically added to [[:Category:Guides]]. You can use <code>|nocat=1</code> to avoid this for test cases, etc.


===Examples===
===Examples===
Example with all parameters used:
Example with all parameters used:


<pre>{{Guide|subject=completing [[Harvest]] encounters|version=3.14.0|date=March 20, 2021}}</pre>
<pre>{{Guide
|subject=completing [[Harvest]] encounters
|date=March 20, 2021
|version=3.14.0
|note=This guide pertains to an older version of Path of Exile.
}}</pre>


{{Guide|subject=completing [[Harvest]] encounters|version=3.14.0|date=March 20, 2021}}
{{Guide
|subject=completing [[Harvest]] encounters
|note=This guide pertains to an older version of Path of Exile.
|version=3.14.0
|date=March 20, 2021
|nocat=1
}}


{{Documentation categories|
{{Documentation categories|
<!-- Categories and interwikis go here. -->
<!-- Categories and interwikis go here. -->
[[Category:Notice templates]]
[[Category:Notice templates]]
[[Category:Guide space templates]]
{{Sister|poewiki}}
}}
}}

Latest revision as of 19:00, 14 October 2024

This subpage provides documentation for Template:Guide.

This template displays a notice that the page it appears on is a guide. It is used to quickly inform readers of the subject matter covered and how up to date it is.

Usage

This template should be placed at the top of the guide.

The subject of the guide should be specified with |subject=.

{{Guide|subject=using item filters}}

Show the date of the guide's most recent update using |date=. By default, the date of the most recent edit is used, but specifying the date manually means that minor revisions to the guide will not cause the date to change.

{{Guide|date=May 6, 2021}}

To indicate that the guide is valid as of a specific game version, use |version=. This parameter is completely optional, as it may not be applicable to the guide.

{{Guide|version=2.2.0}}

An additional note to readers can be added with |note=. This parameter is optional.

{{Guide|note=This guide pertains to an older version of Path of Exile.}}

Articles using this template are automatically added to Category:Guides. You can use |nocat=1 to avoid this for test cases, etc.

Examples

Example with all parameters used:

{{Guide
|subject=completing [[Harvest]] encounters
|date=March 20, 2021
|version=3.14.0
|note=This guide pertains to an older version of Path of Exile.
}}

This is a guide on the subject of completing Harvest encounters.

This guide pertains to an older version of Path of Exile.

Valid as of version 3.14.0. Last updated on March 20, 2021.