User Guide posted on site?

I’d like to suggest that we post the User Guide on the site somewhere. Lately there seem to be a fair number of game play-related questions on the forum: about what Vassal can and cannot do, as well as how to actually do things like play by email.

I realize the User Guide is included in the installer…this would just be an additional way to get it. It would also be a helpful way for newbies to learn about Vassal’s capabilities.

On Mar 19, 2010, at 2:37 PM, mycenae wrote:

I just added a page describing how to get to the User’s Guide.

I could also easily (I think) add the current User’s Guide to the Wiki
documentation page as well. The only concern is whether there would
be a problem with keeping the guide on the web page up-to-date with
what is in the application. It would be one more step whenever the
guide was updated and a new Vassal version released.

On the other hand, I expect that the guide doesn’t change as
frequently as the code, so perhaps it wouldn’t be too difficult to
keep these things synchronized.

Would we need to keep multiple versions of the guide around?

Messages mailing list …

Post generated using Mail2Forum (

On Mar 19, 2010, at 3:20 PM, Thomas Russ wrote:

Done. It’s now available as one of the options from the Wiki
Documentation for playing modules.

Messages mailing list …

Post generated using Mail2Forum (

Thanks for setting up the links, Thomas.

The user guide hasn’t been updated since I first published it last summer. However, as a result, version control is not really an issue.

It’s probably due for some small corrections, and of course will be updated when 3.2 eventually appears. (Will we need to keep the 3.1 guide around when 3.2 comes out?)

In future, as new versions are produced, I’ll make sure it gets updated in both places.

Thus spake Thomas Russ:

Someday I plan to make a list of everything I update when I build a
release, to document the release process. Having one more step on the
list is not a big deal. If it becomes to onerous, we can look for a
way to automate it.

If it’s significantly different between current, supported versions of
VASSAL, then yes. E.g., there will be some period after 3.2 is released
where both 3.1 and 3.2 are supported, so if the 3.1 and 3.2 guides don’t
agree, then there should be links to both.


Messages mailing list …

Post generated using Mail2Forum (