Template:Version: Difference between revisions

From Untold Dawn
Jump to navigation Jump to search
No edit summary
No edit summary
 
(6 intermediate revisions by the same user not shown)
Line 4: Line 4:
<code><pre><nowiki>
<code><pre><nowiki>
{{Version
{{Version
|version=         <!-- Required. The main version this content applies to -->
|version          <!-- Required. The main version this content applies to -->
|since=            <!-- Optional. The version where this feature was introduced -->
|since=            <!-- Optional. The version where this feature was introduced -->
|until=            <!-- Optional. The last version where this feature applies -->
|until=            <!-- Optional. The last version where this feature applies -->
Line 13: Line 13:
</nowiki></pre></code></noinclude>
</nowiki></pre></code></noinclude>
<includeonly>
<includeonly>
<div class="version-box{{#if:{{{status|}}}| {{#ifeq:{{{status}}}|deprecated|deprecated|{{#ifeq:{{{status}}}|removed|removed}}}}}">
<div class="version-box">
<!-- Check if version provided -->
<!-- Check if version provided -->
{{#if:{{{version|}}|
{{#if:{{{1|}}|
   <!-- Version is provided -->
   <!-- Version is provided -->


   <!-- Construct base message depending on since/until -->
   <!-- Construct base message depending on since/until -->
   {{#if:{{{since|}}|
   {{#if:{{{since|}}}|
     <!-- 'since' is provided -->
     <!-- 'since' is provided -->
     This {{{type|page}}}, introduced in version {{{since}}}{{#if:{{{until|}}|
     This {{{type|page}}}, introduced in version {{{since}}}{{#if:{{{until|}}}|
       , applies to versions {{{since}}} through {{{until}}} (current: {{{version}}})
       , applies to versions {{{since}}} through {{{until}}} (current: {{{1}}})
       | , applies starting from version {{{since}}} (current: {{{version}}})
       | , applies starting from version {{{since}}} (current: {{{1}}})
     }}
     }}
   | <!-- else no 'since' -->
   | <!-- else no 'since' -->
     {{#if:{{{until|}}|
     {{#if:{{{until|}}}|
       This {{{type|page}}} applies up to version {{{until}}} (current: {{{version}}})
       This {{{type|page}}} applies up to version {{{until}}} (current: {{{1}}})
       | This {{{type|page}}} applies to version {{{version}}}
       | This {{{type|page}}} applies to version {{{1}}}
     }}
     }}
   }}
   }}{{#if:{{{status|}}}|
 
  <!-- Add status information if applicable -->
  {{#if:{{{status|}}|
     {{#ifeq:{{{status}}}|deprecated
     {{#ifeq:{{{status}}}|deprecated
       | , but is now deprecated.
       | , but is now deprecated.
Line 41: Line 38:
       }}
       }}
     }}
     }}
   | <!-- no status -->
   |.}}{{#if:{{{notes|}}}|
    .
  }}
 
  <!-- Add notes link if provided -->
  {{#if:{{{notes|}}|
     See [[{{{notes}}}]] for more details.
     See [[{{{notes}}}]] for more details.
   }}
   }}

Latest revision as of 23:30, 10 December 2024

This template helps manage documentation that is version-specific. It allows you to specify which versions a page or section applies to, indicate if something is deprecated, and link to release notes.

Usage[edit source]

{{Version
|version          <!-- Required. The main version this content applies to -->
|since=            <!-- Optional. The version where this feature was introduced -->
|until=            <!-- Optional. The last version where this feature applies -->
|status=           <!-- Optional. Can be 'deprecated' or 'removed' -->
|notes=            <!-- Optional. A page or section linking to detailed changelog/release notes -->
|type=             <!-- Optional. Defaults to 'page'. Could be 'section', 'feature', etc. -->
}}