[crossfire] Documentation / wiki

[Nicolas Weeger (Laposte)]

>   I wonder how many people actually print out any of the crossfire docs -
> which is also a valid question regarding the existence of postcript files.

I'd say as long as it isn't too hard to generate them, let's generate them - 
worse case, no one will use it :)

>   As I thought about the docs some more, I did think that some general
> re-org, perhaps for 2.0, should perhaps be done:

<snipped points to which I agree>

> 6) I really like the idea of going to HTML docs - it is pretty much
> univerally readable, yet is also simple to generated.  To me, the biggest
> bonus is the ability to hyperlink - that could help out point #3 above
> (link from one doc to another).  The other thing is that would help to
> actually have a table of contents so you might actually be able to find the
> relevant documents, where as now, grep seems to be the most likely.

And we can always use a HTML to text converter, not too hard :)

> doc/MapMakers/: Information for making maps - files in here would also
> describe the archetype and treasure list information (since that is all
> related), how to add new archetypes of existing type (like adding a new
> sword - not about adding new archetypes that require code support).  Files
> here would also describe any special meaning for certain archetypes, etc. 
> It may be reasonable to this to instead be in the maps area, but since a
> map maker really needs their own server to test the maps, it may not be
> unreasonable to keep it here.

Doesn't SVN support the concept of soft-linked files? I mean the same contents 
under 2 names? If so we could simply put relevant files in both trees.

> client:
> doc/: Information that is useful to the player - how to create character,
> how to interact in the game world, the spell information (but that should
> really be moved into the archetypes itself where possible, but there are
> some broader concepts that don't really fit in there).  Hints on playing
> the game.  And as said, it would be nice to integrate this into a client
> help system within the client.

Agreed.


Nicolas