I volunteer to help build mx2 docs and samples.

[APCParticipant]

I want to know were I can find information to start writing a MX2 documentation and samples.

I am struggling to learn Monkey 2 like many others in this forum.

The question is, where can I get information to write samples?

For instance if I want to add components like Button, check box to a view and to the window?

I know there is information all over the place but it takes time, time that most of us don’t have.

I read the post from AdamStrange http://monkey2.monkey-x.com/forums/topic/mark-please-look-and-take-note/ and all I can do is offer some of my time to help.

Monkey 2 needs to get to a stage to replace Monkey and Mojo2.

 

Can some one let me know how can I help???

[codifiesParticipant]

IF I SHOUT TOO, CAN I ALSO HELP? AND WILL THERE BE AN OFFICIAL WIKI ?

[XaronParticipant]

Why should it replace Monkey 1? As long as I cannot use my Java libs for Android it actually NEVER will for me.

Oh and mojo 2 is the current graphics framework Monkey 2 uses.

Beside that, I really appreciate that offer.

[codifiesParticipant]

nice you call it mojo2 but when I type #import I call it mojo and when the compiler links it it also calls it mojo (not mojo2) indeed browsing the docs I only see the module called mojo…

[XaronParticipant]

You are right. Basically this is mojo 2 which was introduced both for Monkey 1 AND Monkey 2. But yeah, as Monkey 2 had no mojo 1 I guess Mark just called it mojo there.

[nerobotParticipant]

What about dokuwiki ? It’s database-free wiki engine. As there are plain text files then easy to write converter from monkeydoc to actualizing docs.

And also there is a way to combine monkeydocs with any samples on the fly by php script.

Just need to declare some rules for namespacing of samples to use php-grabber.

I need the same wiki for my proj, so I try to do it. If it will be as easy as I think…

And if anyone add libcurl module I can implement online docs into ted2go.

[codifiesParticipant]

@nerobot any investigation into different types of wiki will no doubt be helpful, I’d love to see an official wiki sanctioned by Mark even if it wasn’t hosted here and was on one of the ad bound various “free” wiki services… (but I’d much prefer it directly under community control or Marks…

[nerobotParticipant]

Mark said that he going to expanding monkeydocs, and including samples right there.

But he said nothing about collective wiki.

To be honest, I’m not sure we’d be a good writers, but I hope it will be better than nothing. Especially if someone writes the whole article, not the short examples.

I don’t pretend to create the official documentation, but if I get a convenient system, it can be taken as a basis.

[scurtyParticipant]

Well BuddyPress Docs is a WordPress plugin that seems to be exactly what we need for community editing. It handles User Invites and Authoring of Pages. So Mark would have to install that on this site, and give a few of us permission to edit various sections(Permission being handled by the plugin). Also has feed back capabilities.

[peterigzParticipant]

I’d be happy to contribute where I can, an open docs system (with invited users) sounds like a good way to go.

[coconParticipant]

Here is how the system work:

1. Any #Rem comments with special notation, exist within the Monkey2 source code and modules.
2. They are automatically converted to HTML documentation with the mx2cc tool.
3. After that, they are placed into a database. Each entry will have a unique ID, for example the well known command to add something to a list will be: “std:std.collections.List.Add”
4. When you watch information about a command, you can see also posts of other users. (I really like that one on the PHP website were users post clever snippets for every command).

Generally, this is how the current system for the Docs work.
http://monkey2.monkey-x.com/monkey2-docs

The point of question, if the new system will be better than the current one. One argument is that the current system works like this:

• Monkey source -> Generate Documentation
  With this approach any modification to the comments must be done within the source code, by creating new commits. In order to keep commit logs clean without overhead, ALL of the projects in the world, avoid modification of comments. Either the programmers do not comment the code at all, either they write it once and for good.
• Monkey Source + Monkey Documentation
  With this approach the documentation can be maintained externally, in a separate repository. It might be a completely new Git project, or a real XML snapshot of an online Wiki, or for more advanced IDE features, they can be called directly with an HTTP request.

  The bottom line is that the community will be able to make modifications and enrich the documentation, independently.
  http://softwareengineering.stackexchange.com/questions/211938/hyperlinked-externalized-source-code-documentation

  Only one downside exists with this approach, is that all of the documentation is stripped out of the source code so it won’t be easily accessible at once. That’s the worst case scenario if you are working from a terminal or with the Microsoft Notepad, but otherwise with the help of a capable IDE the comments can be presented at will more dynamically.

I just throw some ideas, I don’t know which you prefer better.

[codifiesParticipant]

the autog enerated doc’s aint that hot, for example there are a number of places where you can’t access links to WindowEvent docs (and I bet there are other broken links in the docs)

I’d quite like to see some kind of document validator.

What is far more pressing is the examples of *how* stuff should actually be used, rather than just a description of the API

With a trusted group of wiki moderators examples could be submitted, even honed by others, and fleshed out with a small article, all without taking up Marks valuable time…

[dubbstaParticipant]

as a rookie i have a major request for those making tutorials, first thank you, when naming variables can you pls pls pls name them relative to its function. sometime xx, yd, bxy… can be very confusing especially when there is no explanation for the code. i think this is critical for learning, it would stink to have tons of tutorials beginners are fighting to get through. thanks again hope you all get this up and running!!!

[coconParticipant]

I see, in this case a creation of a wiki will be helpfull.

For example some users of Unity have created this wiki to post cool recipees. http://wiki.unity3d.com/index.php/Scripts.
(e.g. http://wiki.unity3d.com/index.php/SQLite)

Similarly, this is no different approach from what Blitz users used 10 years now.
http://www.blitzmax.com/codearcs/codearcs.php?cat=6

In some sense, the idea is the same. Only the underlying website mechanism changes. Either you call it a Wiki/Forum/LAMP Stack.

[codifiesParticipant]

I’ve taken a look at pmwiki it looks quite nice, it should be very easy to have the doc generator optionally generate wiki markup instead of html…

[Author]

Posts