---

I think it is a very good idea to use the wiki-format for documentation. This way the documentation is very easy to read. There should be also some more topics in this documentation like text-formating etc.

Another proposal is to include this documentation into the downloadable ErfurtWiki demo files.

It should be not that much more work to update both the README and this documentation.

Rudi

---

milky: I strongly discourage against this README incarnation, as the README file is updated daily (see CVS), but these pages will be outdated in just a few weeks, because nobody will be here to actively maintain it. There are of course some points that could be extracted onto the sf.net site about ewiki, but there is probably no need to do it by hand, I could easily utilize some regex and the ewikictl utility to bring it up automatically.

However, most of the stuff from the README does not make much sense to visitors, as it documents the ewiki.php script and only that. It does not document what the software can do, but rather what's happening inside the software. So all this is only useful if one wishes to set up a copy of ErfurtWiki on its own, and the right place for that documentation is the README!

So I fear, you guy invested too much time and work into separating the README into all the small sections (which the engine, btw, renders not very well). It also believe it is a good thing to have a hypertextual Documentation (instead of the insearchable and static text file), but this is could probably be the wrong way to do it.

---

I like the idea of having detailed documentation on-line. Could the distribution readme be extracted from the wiki? Perhaps we could eventually use *EWikiJavadoc or EWikiAppendedCommentsStyle.

Could we use the online documentation as an extension of the readme with more detailed information? For example I find myself in need of information on the EWikiTableStructure and the meaning behind it.

• Andy

---

milky: Again I think most of the README is only suitable for setup (we cannot expect users to read over multiple WikiDocPages, when they actually need to get the software running initially). But it's true that it could be advantageous to have it online, and I would also prefer to have it in hypertextformat, but this only additonally to the README (like Rudi said: it is a very good idea to use the wiki-format for documentation).

but the main disadvantage of converting or simply copying it into a bunch of wikipages is, that it is impossible to keep two versions up-to-date, both will get outdated at some point. So my idea about this was to create a new (mpi) plugin which loads the README (server-side) and first parses it from text into Wiki-format, to get it rendered by ewiki.php again.

• the online version would always contain latest facts
• -- using such a module, the Documentation could not be edited by users anymore, one could just append comments or additions to the text pieces (appendonly)

Another point: In fact I didn't like how you extracted the pieces from the README, because the titles were no WikiWords, and carried too much detail to be useful as titles (remember the "

Deep discount dvd - Discount Dvds Online Shop: Here you buy cheap dvds online, cheap dvd movies, music dvds, special interest dvds, country music, documentary dvds and discount cds for sale by *DiscountDvdShop.co.uk

search engine marketing Company - UK's leading search engine marketing company