Difference between revisions of "Template:History/doc"

From TFC:TNG
Jump to navigation Jump to search
(Update to TNG standards and new history template.)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{doc/start}}
+
This template is used for creating the new history sections.
This template is used for creating the new history sections. It is currently a work in progress.
 
  
 
To create a History section, you need to use this template multiple times:
 
To create a History section, you need to use this template multiple times:
 +
* A single version can be represented like so: <code><nowiki>{{History||1.12.2-0.24.2.79|Removed pickaxe harvestability from ProPick.}}</nowiki></code>.
 +
:* Do not specify the development stage! Only use '''FULL''' version numbers or '''BUILD''' numbers!
 +
:* If multiple changes have been made in a single version update, simply list them like so: <code><nowiki>{{History||Build #79|This isn't a real change log but it shows you how it works|Now you have two things that changed this version!.}}</nowiki></code>. The template currently supports up to 10 changes per version.
 +
* Make sure that all Github interlinks are removed. Things like this: <code>Fix knapping with only one rock (close #369)</code> should be <code>Fix knapping with only one rock.</code>
  
* The various development phases of ''TerraFirmaCraft'' are represented by sections. For example, you start the [[Beta]] section with <tt><nowiki>{{History|beta}}</nowiki></tt>.
+
* End the history section with <code><nowiki>{{History|closetable}}</nowiki></code>.
 
 
* A single version can be represented like so: <tt><nowiki>{{History||77.22|Ingots can no longer be placed in vessels.}}</nowiki></tt>.
 
:* Do not specify the development stage here (e.g. use ''77.22'', not ''Beta 77.22''). The development stage is already in the section header.
 
:* By default, the version number will be a link to the [[version history]] page. You can use <tt><nowiki>{{{link}}}</nowiki></tt> to change this. Possible values are:
 
::* <tt><nowiki>ver</nowiki></tt> — link to the version history, i.e. the default behavior.
 
::* Any URI/URL — external link to this URI/URL.
 
::* <tt><nowiki>none</nowiki></tt> — no link.
 
:* If multiple changes have been made in a single version update, simply list them like so: <tt><nowiki>{{History||77.22|Ingot piles break and drop items when the block underneath them is broken|Ingot piles must be placed on top of solid blocks, or a full ingot pile.}}</nowiki></tt>. The template currently supports up to 10 changes per version.
 
* End the history section with <tt><nowiki>{{History|foot}}</nowiki></tt>.
 
  
 
Sample usage:
 
Sample usage:
  
 
<pre><nowiki>
 
<pre><nowiki>
{{History|v1h|Ingots are stackable after they've lost their heat.}}
+
{{History|Build #36|Added custom charcoal pile sounds.|Added charcoal place sounds to the block placement.}}
{{History|v2 Pre 12|Swords require double ingots.}}
+
{{History|Build #73|Nerfed charcoal creation calculation so that a full log pile doesn't always produce max charcoal - the calculation is now the same as 1.7.10.|Fixed charcoal piles causing logs to drop their contents, effectively duplicating the logs}}
{{History|v2 Build 47f|Melting an ingot with no molds in a forge no longer provides a free mold.}}
+
{{History|closetable}}
{{History|Build 76|Added Ingot Piles.}}
 
{{History|Build 76 Hotfix 8|Hot ingots can be placed in water barrels to cool them down.}}
 
{{History|77.22|Ingot piles break and drop items when the block underneath them is broken.|Ingot piles must be placed on top of solid blocks, or a full ingot pile.}}
 
{{History|foot}}
 
 
</nowiki></pre>
 
</nowiki></pre>
  
 
Produces:
 
Produces:
  
{{History|v1h|Ingots are stackable after they've lost their heat.}}
+
{{History|Build #36|Added custom charcoal pile sounds.|Added charcoal place sounds to the block placement.}}
{{History|v2 Pre 12|Swords require double ingots.}}
+
{{History|Build #73|Nerfed charcoal creation calculation so that a full log pile doesn't always produce max charcoal - the calculation is now the same as 1.7.10.|Fixed charcoal piles causing logs to drop their contents, effectively duplicating the logs}}
{{History|v2 Build 47f|Melting an ingot with no molds in a forge no longer provides a free mold.}}
+
{{History|closetable}}
{{History|Build 76|Added Ingot Piles.}}
 
{{History|Build 76 Hotfix 8|Hot ingots can be placed in water barrels to cool them down.}}
 
{{History|77.22|Ingot piles break and drop items when the block underneath them is broken.|Ingot piles must be placed on top of solid blocks, or a full ingot pile.}}
 
{{History|foot}}
 
 
 
{{doc/end}}
 

Latest revision as of 22:37, 13 October 2019

This template is used for creating the new history sections.

To create a History section, you need to use this template multiple times:

  • A single version can be represented like so: {{History||1.12.2-0.24.2.79|Removed pickaxe harvestability from ProPick.}}.
  • Do not specify the development stage! Only use FULL version numbers or BUILD numbers!
  • If multiple changes have been made in a single version update, simply list them like so: {{History||Build #79|This isn't a real change log but it shows you how it works|Now you have two things that changed this version!.}}. The template currently supports up to 10 changes per version.
  • Make sure that all Github interlinks are removed. Things like this: Fix knapping with only one rock (close #369) should be Fix knapping with only one rock.
  • End the history section with {{History|closetable}}.

Sample usage:

{{History|Build #36|Added custom charcoal pile sounds.|Added charcoal place sounds to the block placement.}}
{{History|Build #73|Nerfed charcoal creation calculation so that a full log pile doesn't always produce max charcoal - the calculation is now the same as 1.7.10.|Fixed charcoal piles causing logs to drop their contents, effectively duplicating the logs}}
{{History|closetable}}

Produces:

Build #36
Added custom charcoal pile sounds.
Added charcoal place sounds to the block placement.
Build #73
Nerfed charcoal creation calculation so that a full log pile doesn't always produce max charcoal - the calculation is now the same as 1.7.10.
Fixed charcoal piles causing logs to drop their contents, effectively duplicating the logs