MMEX Documentation Wiki

[madhan]

Hello Guys, Shall we setup a wiki to capture all the information related to MMEX for users as well as for developers? I can set it up quickly.

[Vadim]

Good idea! Also I think the very important task is setup bugtracker for our project. May be sourceforge offers this capability, I don't know.

[madhan]

SF.net already has a bug tracker. There are already lots of bugs/enhancements reported there in the last few years.

[madhan]

Wiki is up at
http://www.codelathe.com/mmex/wiki

[elliswr]

Madhan,

I have the ability to edit pages, but in order to upload images, I need to have access to the "playground" and that is read only for me. Username elliswr.

[madhan]

Its odd, you have

Code: Select all

User elliswr currently has the following permissions in namespace playground: Read, Edit, Create, Upload.

So you do seem to have upload permissions.

[omalleypat]

Playground seems to be read only for me too.

[madhan]

I couldn't figure out why playground remains read only.
But please go ahead and upload files directly. You don't need playground access for it.

[elliswr]

Works great now. For some reason last night I couldn't figure out how to upload images. At any rate the Mac write-up is much better now. Thanks Madhan!

[madhan]

Looks fantastic.

[elliswr]

Those headings make a world of difference.

[omalleypat]

So just a question, are we intending to move the mmex documentation (from the help menu in the program) to the wiki? Dokuwiki has the ability to export to html (since it is based on files and not a database), so we could just export the Documentation namespace and wrap it into the release. On the plus side, we would have people potentially willing to help flesh out the documentation more, but we lose a little control and have to be more vigilant about checking it for accuracy.

Thoughts?

[elliswr]

I think that's a good idea. Having users flesh out the documentation is key, and it would help to keep the documentation current with the features that are added/changed.

[elliswr]

I've added the Future Development Roadmap and filled it with some feature requests from the forum. I also added a long term goals section in which I added the feature requests that I have as well as some that we can implement with the next stable release of wxWidgets.

[omalleypat]

Ok, so I added the bulk of the (English) documentation to the wiki. Pictures are still missing and all the formatting is not great, but it will evolve. I think the structure is a good one though. We can then export the entire documentation namespace to roll with out releases in the future.

I am not so sure how we want to handle translations. I realized that after I had already uploaded everything. Perhaps we make a namespace for each language? We would then have namespaces such as documentation (for english) documentation_fr (for french) and so on. Here are some links:

http://www.dokuwiki.org/tips:multilingual_content
http://www.dokuwiki.org/plugin:translation

[omalleypat]

Also for future reference, this is a good way to get from HTML to Wiki:

http://www.shareknow.cn/htmltowiki/index.cgi