Documentation project

I've renamed this forum to the Documentation forum, the place where we can organise the development of documentation for Construct.

Documentation is a very important part of Construct and we should have something substantial by the time 1.0 rolls around. I've decided the best place to collaboratively develop documentation is the Wiki:

Construct Wiki

Note (2nd January 2008): The Wiki has been moved to the above URL hosted on SourceForge since this thread was posted. Links in this thread to the old Wiki will not work.

I really need everyone's help to pitch in and help get this done - even if you just sign on and add a doc for one property in the Sprite object, it's a start - if everyone did that, we'd be well on our way to documentation <img src="{SMILIES_PATH}/icon_smile.gif" alt=":)" title="Smile"> Thanks!

I made a page for Sprite Properties

http://www.scirra.com/wiki/SpriteProperties

I couldn't figure out how to upload images to the wiki, so if you could move that image that'd be great <img src="{SMILIES_PATH}/icon_smile.gif" alt=":)" title="Smile"> (I don't want to piss off the xs.to guy, he runs my favorite free image host)

Let me know if there's any incorrect information or anything, too.

Edit:

Hehe, it looks like I blew up the WantedPages with my links... someone get on that <img src="{SMILIES_PATH}/icon_biggrin.gif" alt=":D" title="Very Happy">

[quote:2431f7qf]Hehe, it looks like I blew up the WantedPages with my links... someone get on that

Wikiprojects works like this <img src="{SMILIES_PATH}/icon_smile.gif" alt=":)" title="Smile" />... very nice article. I've made only one but it took me over 2 hours for just one little article... well, English it quite hard <img src="{SMILIES_PATH}/icon_sad.gif" alt=":(" title="Sad" />.

[quote:1fpvang9]Hehe, it looks like I blew up the WantedPages with my links... someone get on that

Wikiprojects works like this <img src="{SMILIES_PATH}/icon_smile.gif" alt=":)" title="Smile">... very nice article. I've made only one but it took me over 2 hours for just one little article... well, English it quite hard <img src="{SMILIES_PATH}/icon_sad.gif" alt=":(" title="Sad">.

Yeah, it takes me forever to write them too.

Anyway, I made another page for the Picture Editor. It has three images that need to be moved (I still don't know how to upload images to the wiki, or if it's even possible).

Thanks Deadeye, you've done some great work <img src="{SMILIES_PATH}/icon_smile.gif" alt=":)" title="Smile" /> I'm going to split Common properties in to its own article from Sprite properties though, because it applies to all objects.

Okay, it's a little later than I anticipated, but here's the page on Containers.

Needs to be checked for accuracy.

Mediawiki > Whatever wiki engine this is

I hope to add to the wiki as I figure things out that aren't already listed in it. I don't know enough yet to add in entire new articles, but I can at least add clarification to little bits here and there. Does it make sense to add things like the following?

On the "Common Properties" page add a note about "Z Order." It's not listed as a property but it is kept track of and available on the Layers tab by selecting list by Z Order. Speaking of this should this be made visible as an uneditable property like Unique ID? Could also explain how this property can be changed by using move the Order pop-up menu and using layers.

On the "DirectSound Object" page add a note about the currently missing looping support for music and list the work arounds suggested on this forum.

I don't want to add things to the wiki that don't belong there. Should I add small clarifications like these to the wiki?

Maybe I should hold of until I'm further along with learning Construct before adding to the wiki? Or is it better to update the wiki as I go along as it seems likely others will run into the same questions as I did?

Thanks,

Snoop

I'd say edit away to your heart's content, so long as you're familiar with the area you're writing about. Even if you're not, myself (and hopefully other people) review the recent changes from time to time, and will correct anything which isn't exactly right. Documenting Construct on the Wiki is a pretty big job so the more people we have helping the better!

I've made a few articles... just search for User:Piman

Thanks for your contributions piman <img src="{SMILIES_PATH}/icon_smile.gif" alt=":)" title="Smile" />

I've created a wiki account and added my two notes to the wiki. I'll take your advice and do my best to contribute content of value as I become more familiar with Construct.

Thanks for your contributions efgh062! <img src="{SMILIES_PATH}/icon_biggrin.gif" alt=":D" title="Very Happy" />

They're deleted now. I'm not sure how these bots get through the captcha and email verification. They're either clever bots, or real people being paid for it!

I think they're real people, they invaded another forum I go to and the responses seemed tailored to that forum (though it was obvious they weren't reading threads). If it were a bot you'd think the responses would be the same everywhere.

Plus, I don't want to imagine a bot that smart.