Currently Online

Latest Posts

Topic: Generated Documentation

Forums » Player Forums » Technical Help » Generated Documentation
alexxismachine

Topic Opener
Joined: 2010-05-11, 12:00
Posts: 3
Ranking
Just found this site
 Posted at: 2010-05-11, 13:49

Hi,

I just started a tool wich extracts data from a Widelands installation and generates doucmentation just like the one found here on the site.

I've seen the writeHTML.cc, the post http://wl.widelands.org/forum/topic/53/ and (hopefully) all what is available here online, but I still decided to create another tool. Here some reasons:

  • I'm a Java-Freak an programming Java is my kind of fun, so I didn't like to jump into C.
  • When I read the writeHTML.cc I can imagine the pain it must be to create another page. My tool is based on a templating engine, so when all data is parsed you can generate what you like. No C or Java knowledge anymore, just plain templating (FreeMarker). (When I'm ready it should be possible to create totally different template-sets to put the stuff together as one likes)
  • I want to have full documentation offline in all languages (especally in de since I play in de and it is hard for me to guess the english names of buildings etc.) and want it now.

Currently I just deliver a set of HTML-pages with the generated documentation since my code just a quick hack and I have to clean it up before release to the community.

More information (in german) is found at http://www.japrost.de/java/widelands-doc-1.0/index.html

The html sets (I consider them pre alpha) are available as zip at

Cheers,

Uli

Top Quote
SirVer

Joined: 2009-02-19, 14:18
Posts: 1445
Ranking
One Elder of Players
Location: Germany - Munich
Posted at: 2010-05-11, 19:58

while I appreciate your hard work, yet another partly documentation attempt is not so terrible useful. Also a tool in java would add another heavy weight dependency to widelands. Someone who would finish the documentation here on the site (it is written in python) would be very welcome.

Sorry to be a drag. I just like to see work focused. Thanks for your work, Uli!

Top Quote
alexxismachine

Topic Opener
Joined: 2010-05-11, 12:00
Posts: 3
Ranking
Just found this site
 Posted at: 2010-05-15, 13:29

I just uploaded my version 0.2 of the html with pages for initializations, trainingsite types and warhouse types. I forgot to mention that the tempates work against build 15.

More information (in german) is still found at http://www.japrost.de/java/widelands-doc-1.0/index.html

The new html sets (I consider them pre alpha) are available as zip at

@SirVer Your completely right that java is another heavy weight dependency, but as said, my kind of fun. On my computers (OS-Independent) there is always a java and rarely a C-compiler or python.

Top Quote
alexxismachine

Topic Opener
Joined: 2010-05-11, 12:00
Posts: 3
Ranking
Just found this site
 Posted at: 2010-07-14, 23:21

Just saw that I missed to annouce version 0.3. Nasty me! But better that way since I thougt using graphviz in addition to java was a good idea, but the resulting files were really too big.

So now for verson 0.4, using tables to display the waretype flows. Additionally I found some time to do an english version of my site, so english speakers can get more information at http://www.japrost.de/java/widelands-doc-1.0/en/index.html

Again the zips can be found in my releases at

Seems that now I really have to learn Widelands well. No excuses anymore not knowing the economic dependencies.

Cheers,

Uli

Top Quote