Page 1 of 3

Updating all documents

Posted: 29 May 2012, 04:15
by vexed
I have read a few posts about this, and I figure I might as well toss it out there and hope people will step up to the plate and fix the documents that need fixing.

Unfortunately, things don't get done by themselves.

Anyway, as you can see, these documents are out of date, and some of them, are very out of date (we are talking years!).

https://github.com/Warzone2100/warzone2 ... 10/AUTHORS
and pretty much everthing you see in https://github.com/Warzone2100/warzone2 ... e07310/doc

Once you have edited the file(s) in question, make a trac ticket, and we can then update the document in question.

Any takers ?

Re: Updating all documents

Posted: 29 May 2012, 14:50
by Rman Virgil
.

Besides making a Trac Ticket for changes, would there be any other provisos or guidelines for the changes themselves.?

.

Re: Updating all documents

Posted: 29 May 2012, 20:47
by aubergine
Would some of the stuff I've been working on be any use?

* Warzone Encyclopaedia
* Warzone Modding Guides
* Javascript API Guide

Re: Updating all documents

Posted: 30 May 2012, 01:20
by aubergine
I tried sanity checking the "config" file but without reading through source code I can't check too much stuff. https://warzone.atlassian.net/wiki/display/mod/config -- few issues found, but not sure how to relay those without editing the whole https://github.com/Warzone2100/warzone2 ... /Readme.en file :s

Re: Updating all documents

Posted: 30 May 2012, 03:44
by vexed
Rman Virgil wrote:.

Besides making a Trac Ticket for changes, would there be any other provisos or guidelines for the changes themselves.?

.
Well, we did start to do some work here: Contributors and that was meant to be able to generate the AUTHORS file more easily, and keep track of everyone more efficiently.

The way people get on that list is pretty easy, if they did something that we include in the game, then we add them to the list.

This however don't cover people who we have no record of what they did, (as in, they are not listed in the git/svn logs anyplace) and I was hoping someone else would come up with a solution on how to handle other individuals that fall into this category.
Perhaps add a HISTORY file on how WZ was released, or something along those lines ?
Sidenote, it would have been really cool to have a postmortem on WZ from Pumpkin studio's POV, though, not sure if that is even possible anymore though--I know they went under :cry: . (See http://www.gamedev.net/page/resources/_ ... ortem-r977 for a example of how they do it )

Re: Updating all documents

Posted: 30 May 2012, 04:01
by vexed
aubergine wrote:Would some of the stuff I've been working on be any use?

* Warzone Encyclopaedia
* Warzone Modding Guides
* Javascript API Guide
Not sure about the JS stuff, at least for 3.1, that isn't the main focus of it.
For the other stuff, just how would that be distributed, as a complete html file or what ?

aubergine wrote:I tried sanity checking the "config" file but without reading through source code I can't check too much stuff. https://warzone.atlassian.net/wiki/display/mod/config -- few issues found, but not sure how to relay those without editing the whole https://github.com/Warzone2100/warzone2 ... /Readme.en file :s
Perhaps drop the Readme.en file, and just have one html guide based on what you have done ? :hmm: That might be a better way to handle all this.

Re: Updating all documents

Posted: 30 May 2012, 05:35
by aubergine
I can export content on the wiki in PDF, Word and XML formats.

Re: Updating all documents

Posted: 30 May 2012, 12:11
by Emdek
That Contributors page is already a bit outdated and well, nobody added me as translator. :-P

Re: Updating all documents

Posted: 30 May 2012, 15:07
by Rman Virgil
.

Sounds like nothing less than me getting a principle WZ Creator (like Alex McLean) to come here, identify themselves, even provide evidence that they are who they are and not some imposter, and tell you all flatly that I have spoken the truth and nothing but... which is one of the many reasons why I was put in the original source distro by name. Would that work?

.

Re: Updating all documents

Posted: 30 May 2012, 17:04
by Saberuneko
Emdek wrote:That Contributors page is already a bit outdated and well, nobody added me as translator. :-P
I think none of us, (the translators), are documented there yet... Maybe we'll appear in there some day. :P
I think this should be separate in coders, artists, translators... you know, like usual credits in usual stuff.

Re: Updating all documents

Posted: 30 May 2012, 17:07
by Emdek
Saberuneko, I meant that wiki page, you are listed there. ;-)

Re: Updating all documents

Posted: 30 May 2012, 23:40
by crass
aubergine wrote:Would some of the stuff I've been working on be any use?
* Warzone Encyclopaedia
that is pretty good where did you get all that info from?

Re: Updating all documents

Posted: 31 May 2012, 02:49
by aubergine
@Crass mostly these forums, I've spent ages reading through old topics, etc. Also, I've been watching every single in-game video and listening to every audio file to find as much info as possible. It's very time consuming, but I feel not having a resource like that is a major blocker to developing mods and other things that are in keeping with the game.

@vexed: I've been chipping away at the modding guides, some examples:

* Updated: https://warzone.atlassian.net/wiki/display/mod/config
* Added: https://warzone.atlassian.net/wiki/page ... Id=7635546
* Prettified: https://warzone.atlassian.net/wiki/disp ... fig+folder

Rather than doing exports of content, would it not be easier to just provide URLs to what's on the wiki?

Re: Updating all documents

Posted: 31 May 2012, 03:47
by vexed
Emdek wrote:That Contributors page is already a bit outdated and well, nobody added me as translator. :-P
:stressed:
Rman Virgil wrote:.

Sounds like nothing less than me getting a principle WZ Creator (like Alex McLean) to come here, identify themselves, even provide evidence that they are who they are and not some imposter, and tell you all flatly that I have spoken the truth and nothing but... which is one of the many reasons why I was put in the original source distro by name. Would that work?

.
O_o How do you come up with that from what I said ?
While it would be nice to see Alex come to the forum (and do a postmortem as I posted before), I am not following your logic train here.

Nobody has said you haven't spoken the truth, so... ?
aubergine wrote:
Rather than doing exports of content, would it not be easier to just provide URLs to what's on the wiki?
Yes, please.

Re: Updating all documents

Posted: 31 May 2012, 03:50
by aubergine
@Rman, I don't think anyone here doubts that you are the real deal, it's clear from your vast encyclopaedic knowledge of all things Warzone that you've been around since the early days. Vexed was merely stating that there are are lots of people who contributed but for which he has no record, he wasn't saying that there was no record of you contributing - subtle but important difference ;)