[Freeciv-Dev] Re: (PR#15007) Improving civmanual

["Guillaume Melquiond" <guillaume.melquiond@xxxxxxxxx>]

<URL: http://bugs.freeciv.org/Ticket/Display.html?id=15007 >

On 2005/12/28, Per I. Mathisen wrote:

> On Wed, 28 Dec 2005, Guillaume Melquiond wrote:
> > I will use this report to post patches for improving civmanual until
> > it can be used to update the current wiki documentation (Freeciv 2.0
> > *beta*, it still contains older graphics and translations).
>
> Good work!
>
> However, please follow the style guide concerning braces and please try to
> avoid adding tabs where there were none before. Also why write
>
>    if (is_great_wonder(id) == (manuals == MANUAL_BUILDINGS)) {
>
> when
>
>    if (is_great_wonder(id) && manuals == MANUAL_BUILDINGS) {
>
> is much easier to read?

Indeed, it is easier to read, but it does only half the work. The
correct equivalent conditional would have been:

if ((is_great_wonder(id) && manuals == MANUAL_BUILDINGS)
    || (!is_great_wonder(id) && manuals != MANUAL_BUILDINGS)) {

and it is not that readable imo. But I will let you choose which one you prefer.

> Finally I wonder now if it might be smarter to just remove the wiki style
> version, and move the manual out of the wiki, since having people put a
> lot of work into something that will be overwritten with each release is
> just silly. I see many commits having been done against the manual since
> it was uploaded.

Unless I am mistaken, there is no conflict, since none of the commits
was done against the terrains/buildings/wonders templates. So it is
important to have civmanual generates them. This is exactly the reason
why I started working on it: these templates are more than one year
old, and their translations contain many mistakes (Freeciv 2.0 beta
was used, the translations were not yet complete), while the game
translations are now fine.

All the commits in the wiki were done against general concepts and
explanations of the game, and such things are not generated by
civmanual anyway. Civmanual actually generates five pages: list of
server commands, list of settings, list of terrains, list of
buildings, list of wonders. It makes sense to have all of them be
automatically generated for the wiki. It would make sense to have the
list of technologies too. The only page in the wiki for which
civmanual has not enough information is the list of units, since it is
classified by eras in the wiki.