Template:Upcoming/doc: Difference between revisions
imported>Aeywoo m Updated. |
imported>Pathoschild + custom message |
||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
== Description == | ==Description== | ||
This template wraps features available in a future version of Stardew Valley or SMAPI to avoid confusion. | This template wraps features available in a future version of Stardew Valley or SMAPI to avoid confusion. | ||
== | ==Basic usage== | ||
=== As a | ===As a header=== | ||
<pre>{{ | <pre>{{upcoming|1.3 beta}}</pre> | ||
{{ | {{upcoming|1.3 beta}} | ||
=== As a | ===As a content block=== | ||
<pre>{{ | <pre>{{upcoming | ||
|version = 1.3 beta | |version = 1.3 beta | ||
|content = Feature documentation goes here. | |content = Feature documentation goes here. | ||
}}</pre> | }}</pre> | ||
{{ | {{upcoming | ||
|version = 1.3 beta | |version = 1.3 beta | ||
|content = Feature documentation goes here. | |content = Feature documentation goes here. | ||
}} | }} | ||
=== As an | ===As an inline phrase=== | ||
<pre>{{upcoming|1.3 beta|Feature description goes here.|inline=1}}</pre> | <pre>{{upcoming|1.3 beta|Feature description goes here.|inline=1}}</pre> | ||
{{upcoming|1.3 beta|Feature description goes here.|inline=1}} | {{upcoming|1.3 beta|Feature description goes here.|inline=1}} | ||
=== For non-Stardew Valley | ==Advanced usage== | ||
===For non-Stardew Valley releases=== | |||
By default the template will say 'Stardew Valley'. For something else, specify the name argument: | By default the template will say 'Stardew Valley'. For something else, specify the name argument: | ||
<pre>{{ | <pre>{{upcoming | ||
|name = SMAPI | |name = SMAPI | ||
|version = 3.0 | |version = 3.0 | ||
|content = Feature documentation goes here. | |content = Feature documentation goes here. | ||
}}</pre> | }}</pre> | ||
{{ | {{upcoming | ||
|name = SMAPI | |name = SMAPI | ||
|version = 3.0 | |version = 3.0 | ||
| Line 34: | Line 35: | ||
}} | }} | ||
== See | ===Custom message=== | ||
For rare cases, you can completely override the message displayed with any of the previous forms. For example: | |||
<pre>{{upcoming | |||
|version = 3.0 | |||
|message = '''This page describes an unreleased pre-alpha version of the game with no estimated release date. Things ''will'' change before it's released!''' | |||
}}</pre> | |||
{{upcoming | |||
|version = 3.0 | |||
|message = '''This page describes an unreleased pre-alpha version of the game with no estimated release date. Things ''will'' change before it's released!''' | |||
}} | |||
==See also== | |||
* [[Template:SMAPI upcoming]] | * [[Template:SMAPI upcoming]] | ||
<includeonly>[[Category:Modding templates]] | |||
<includeonly>{{Addlanglinks}}[[Category:Modding templates]]</includeonly> | |||
<noinclude>[[Category:Template documentation]]</noinclude> | <noinclude>[[Category:Template documentation]]</noinclude> | ||
Latest revision as of 20:40, 1 March 2025
Description
This template wraps features available in a future version of Stardew Valley or SMAPI to avoid confusion.
Basic usage
As a header
{{upcoming|1.3 beta}}
The following describes the upcoming Stardew Valley 1.3 beta, and may change before release.
As a content block
{{upcoming
|version = 1.3 beta
|content = Feature documentation goes here.
}}
The following describes the upcoming Stardew Valley 1.3 beta, and may change before release.
Feature documentation goes here.
As an inline phrase
{{upcoming|1.3 beta|Feature description goes here.|inline=1}}
As of the upcoming Stardew Valley 1.3 beta: Feature description goes here.
Advanced usage
For non-Stardew Valley releases
By default the template will say 'Stardew Valley'. For something else, specify the name argument:
{{upcoming
|name = SMAPI
|version = 3.0
|content = Feature documentation goes here.
}}
The following describes the upcoming SMAPI 3.0, and may change before release.
Feature documentation goes here.
Custom message
For rare cases, you can completely override the message displayed with any of the previous forms. For example:
{{upcoming
|version = 3.0
|message = '''This page describes an unreleased pre-alpha version of the game with no estimated release date. Things ''will'' change before it's released!'''
}}
This page describes an unreleased pre-alpha version of the game with no estimated release date. Things will change before it's released!