Template:ChangeLog Item/doc

This is a documentation subpage for Template:ChangeLog Item.
It contains usage information, categories and other content that is not part of the original template page.

This template is used on the change log to describe updates. It should only be used by the developers, except in few cases, which should be obvious.

Usage

{{ChangeLog Item
|date=month/day/year
|type=type
[|name=name]
[|version=version]
[|summary=summary]
[|websitechange=changes]
[|studiobugfix=fixes]
[|renderingfix=fixes]
[|onlinebugfix=fixes]
[|luafix=fixes]
[|newobjects=updates]
[|otherchanges=changes]
}}

Note: text between brackets ([ and ]) is optional, text in bold represents a certain value (something you must replace) and the rest represents things that must be present as-is.

Parameters

date: The date the update was released.
version: The version number of the update. If there is no version number, ignore this.
type: The type of the update. This will usually be "Client" or "Web".
name: The name of the update, if the update has a specific name. Otherwise, ignore this.
summary: The summary of the update. Can be used to specify things that can not be noted as changes using the lists of changes.
websitechanges: List of changes made to the website. Only use for changes made to the website.
studiobugfix: List of bugs related to the studio that were fixed in the update.
renderingfix: List of bugs related to rendering that were fixed in the update.
onlinebugfix: List of bugs related to networking/online/performance stuff that were fixed in the update.
luafix: List of bugs related to scripting that were fixed in the update.
newobjects: List of changes to existing objects and their members, and new objects or members of objects introduced. Even though the name of this section is "newobjects", it should also contain changes to objects that are not new and already exist.
otherchanges: List of changes that do not belong in any other section.

Example

This is an example of the use of this template for a client update.

Code

{{ChangeLog Item
|date=03/24/2012
|type=Client
|version=1.33.7
|summary=Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed sit amet nisl nisi. Aenean nunc tortor, sagittis vel rhoncus a, aliquam nec felis. Nullam laoreet faucibus justo vitae posuere. Ut at dictum ipsum. Praesent hendrerit elementum dolor vel aliquam. Curabitur blandit massa ut ante commodo fermentum eget sit amet erat. Nunc id orci neque. Aenean consequat, quam accumsan mattis ultricies, purus lectus ullamcorper justo, at malesuada turpis ipsum sed elit.
|studiobugfix=
* Morbi sed velit est.
* Etiam leo urna, condimentum et suscipit et, consectetur sed dolor.
* Nullam sollicitudin placerat eros, eu consequat mi sodales non.
* Mauris tortor tortor, pharetra eget rutrum nec, tincidunt vulputate risus.
* Donec semper, neque in varius euismod, ligula est commodo arcu, ut eleifend dui diam et nunc. 
|websitechange=
*Proin elementum, orci ut commodo vehicula, est diam sodales lacus, id feugiat est nulla non eros.
*Phasellus et orci dolor.
*Suspendisse convallis, purus ac tincidunt lacinia, purus nibh ornare lorem, porttitor pretium risus velit nec ipsum.
|renderingfix=
*In hac habitasse platea dictumst.
*Cras in bibendum risus.
|newobjects=
*Nulla vel odio nec justo euismod tincidunt sit amet nec tellus.
*Vestibulum sed dolor nibh, id rutrum lorem.
}}

Result

03/24/2012 - 1.33.7

03/24/2012 | Client 1.33.7

Version: 1.33.7
Type: Client
Summary: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed sit amet nisl nisi. Aenean nunc tortor, sagittis vel rhoncus a, aliquam nec felis. Nullam laoreet faucibus justo vitae posuere. Ut at dictum ipsum. Praesent hendrerit elementum dolor vel aliquam. Curabitur blandit massa ut ante commodo fermentum eget sit amet erat. Nunc id orci neque. Aenean consequat, quam accumsan mattis ultricies, purus lectus ullamcorper justo, at malesuada turpis ipsum sed elit.

Studio Bug Fixes

Morbi sed velit est.
Etiam leo urna, condimentum et suscipit et, consectetur sed dolor.
Nullam sollicitudin placerat eros, eu consequat mi sodales non.
Mauris tortor tortor, pharetra eget rutrum nec, tincidunt vulputate risus.
Donec semper, neque in varius euismod, ligula est commodo arcu, ut eleifend dui diam et nunc.

Website Changes

Proin elementum, orci ut commodo vehicula, est diam sodales lacus, id feugiat est nulla non eros.
Phasellus et orci dolor.
Suspendisse convallis, purus ac tincidunt lacinia, purus nibh ornare lorem, porttitor pretium risus velit nec ipsum.

Rendering Fixes

In hac habitasse platea dictumst.
Cras in bibendum risus.

New/Updated Objects

Nulla vel odio nec justo euismod tincidunt sit amet nec tellus.
Vestibulum sed dolor nibh, id rutrum lorem.