Updating the Wiki - collaborators needed.
Posted: Fri May 16, 2014 9:42 am
Noticed that the wiki needs updating as well. Would like to see if I can help.
I figured that getting interested people together and discussing some proposals at organized updating would be better than everybody going in and changing things as we feel. I do have some ideas to start with, but would like other people who are interested to counter-check my ideas.
To try to get the ball rolling, I've started on some experiments on templates (ages since I last do mediawiki templating)
The idea is to first come up with a means of easily telling which pages needs updating and mark them as such, firstly to prevent unhappiness of people finding outdated information without knowing so, and secondarily to encourage people who knows the updated info to contribute updates.
A demo is under my user-space here:
http://kenshi.wikia.com/wiki/User:Sublogic/Test/Test1
(Note that the actual templates used now is under my user namespace. In the actual version, it should be in the wiki template space to make them easier to use)
The other issues that I scratched off the top of my head are as followed:
1. Article versioning. This helps keep track which articles needs to be updated after a game version update.
- Use a template CurrentVersion to always hold the current game version
- Use a ArticleVersion template that must be included in all pages which also declares the version of the game it was last updated for. If this declared version does not match the CurrentVersion, it will show a message that indicates the page needs to be updated, and also automatically include the page in an "Update" category, so that we can easily list all the pages whose article version do not match current version. (Note that upon changing the CurrentVersion, it may take some time before the affected pages are categorized correctly. This is done on the server side by a job queue).
Demo (same as mentioned earlier here: (Note that the templates are not declared in global space yet)
http://kenshi.wikia.com/wiki/User:Sublogic/Test/Test1
2. Entity objectification. Use of standard templates to unify information/format of articles referring to entities of the same type (e.g. Weapon classes, NPCs, Items etc). This will include unified way to extract/display information or icons and infoboxes etc. Those pages which cannot be objectified will not be affected.
TODO: after article versioning get sorted out.
Example:
http://kenshi.wikia.com/wiki/User:Sublo ... WeaponTest
The katana entity page defines its parameters using the Weapon template, but the rendering of the page itself can be done using a common template which pulls specific parameters from weapon definition to be displayed in a standard way.
3. Navigation boxes. Quick access to other related articles, or of possible interest to the reader. E.g. When viewing a weapon page, a Weapon Nav Box can appear at the bottom, which has quick links to all other weapons. There can be a way to automagically generate this on-the-fly based on method for point 2 above.
TODO: after previous 2 points.
4. Bug tracking. The aim of this is to have a semi-standard means of documenting known bugs and possible workarounds. It can go hand-in-hand with forums in the checking of whether a bug was reported, and whether a bug has been fixed. If an external bug tracking software is used by the dev, the bug id could also be linked from the wiki such that people can keep-track or contribute to the same bug report (without creating duplicates). For a start, a "Bugs" section under the related page which lists out the associated bugs will be a good start, I think. Not only may it be of use to the dev, but it can help reduce frustration of a player who encounters the bug for the first time.
I figured that getting interested people together and discussing some proposals at organized updating would be better than everybody going in and changing things as we feel. I do have some ideas to start with, but would like other people who are interested to counter-check my ideas.
To try to get the ball rolling, I've started on some experiments on templates (ages since I last do mediawiki templating)
The idea is to first come up with a means of easily telling which pages needs updating and mark them as such, firstly to prevent unhappiness of people finding outdated information without knowing so, and secondarily to encourage people who knows the updated info to contribute updates.
A demo is under my user-space here:
http://kenshi.wikia.com/wiki/User:Sublogic/Test/Test1
(Note that the actual templates used now is under my user namespace. In the actual version, it should be in the wiki template space to make them easier to use)
The other issues that I scratched off the top of my head are as followed:
1. Article versioning. This helps keep track which articles needs to be updated after a game version update.
- Use a template CurrentVersion to always hold the current game version
- Use a ArticleVersion template that must be included in all pages which also declares the version of the game it was last updated for. If this declared version does not match the CurrentVersion, it will show a message that indicates the page needs to be updated, and also automatically include the page in an "Update" category, so that we can easily list all the pages whose article version do not match current version. (Note that upon changing the CurrentVersion, it may take some time before the affected pages are categorized correctly. This is done on the server side by a job queue).
Demo (same as mentioned earlier here: (Note that the templates are not declared in global space yet)
http://kenshi.wikia.com/wiki/User:Sublogic/Test/Test1
2. Entity objectification. Use of standard templates to unify information/format of articles referring to entities of the same type (e.g. Weapon classes, NPCs, Items etc). This will include unified way to extract/display information or icons and infoboxes etc. Those pages which cannot be objectified will not be affected.
TODO: after article versioning get sorted out.
Example:
http://kenshi.wikia.com/wiki/User:Sublo ... WeaponTest
The katana entity page defines its parameters using the Weapon template, but the rendering of the page itself can be done using a common template which pulls specific parameters from weapon definition to be displayed in a standard way.
3. Navigation boxes. Quick access to other related articles, or of possible interest to the reader. E.g. When viewing a weapon page, a Weapon Nav Box can appear at the bottom, which has quick links to all other weapons. There can be a way to automagically generate this on-the-fly based on method for point 2 above.
TODO: after previous 2 points.
4. Bug tracking. The aim of this is to have a semi-standard means of documenting known bugs and possible workarounds. It can go hand-in-hand with forums in the checking of whether a bug was reported, and whether a bug has been fixed. If an external bug tracking software is used by the dev, the bug id could also be linked from the wiki such that people can keep-track or contribute to the same bug report (without creating duplicates). For a start, a "Bugs" section under the related page which lists out the associated bugs will be a good start, I think. Not only may it be of use to the dev, but it can help reduce frustration of a player who encounters the bug for the first time.