Template talk:ChangeLog Item
Documenting
Huh, I'm having some trouble figuring out how to use the template exactly. Quenty, would you mind explaining exactly how each argument should be used, so I can create the documentation? --JulienDethurens 20:02, 24 March 2012 (EDT)
- Lucklily for you, I just wrote something up.
03/15/2012
03/15/2012 |Type:
- Change info goes here
- And here
- and here.
</syntaxhighlight>
From what I see, this is the basic template. You can pretty much copy and paste it when you want to add a change, and then just change variables to reflect the change. The first line will always stay the same. On the second line, you just change the date to the day of the change. The third line is the version, or release number. If the devs aren’t using release numbers, just leave that one blank. The fourth line is the type. This will generally be web or client. Each change in the web section will have web set as the type, each change in the client section will have client set as the type. The fifth line is the summary. This one is optional. If there is something important you want to add, you can add it here. If not, leave it blank.
The sixth line is probably the most difficult, as it has been given a bunch of possible variables. They are:
- Studiobugfix
- Websitechange
- renderingfix
- newobjects
- onlinebugfix
- luafix
They are fairly self explanatory. If the change you are adding is a new object, you would change the sixth line to “newobjects”. If it is a change to the website, you set it as “websitechange”.
Below the sixth line you have your actual changes. This is done with an asterisk followed by the change.
When you’ve changed the template to fit what you are adding, hit save, and you should have a good template.
What I'm working on now is making it so the template shows up in the Table of comments. I'll figure it out eventually, but if somebody already knows, go for it.--Gordonrox24 | Talk 20:15, 24 March 2012 (EDT)
- Had already guessed everything you've told me. I just wasn't sure about what each list was exactly for, but I tried it with nothing to see the name and guess it.. :P --JulienDethurens 20:40, 24 March 2012 (EDT)
- Good work. Documentation looks good. I'm searching for a way to make the date in the template a subheading for the table of contents. I'm pretty sure I've done this before, but it's not working for me. Have any ideas?If we keep switching over to the template our table of contents will disappear.--Gordonrox24 | Talk 20:47, 24 March 2012 (EDT)
