Wiki Editing Guidelines

The SproutCore Community Wiki is a set of documentation and training materials developed and maintained by members of the SproutCore community. Anyone with a free github account can edit the Wiki. Before you do make edits, though, please read through the following guidelines and try to apply them to your edits.

NOTE: For a great example of what a well-formed wiki page should look like, please see Unit Testing

If you have a comment

If you are reading a topic and you need more help on it, generally adding a comment to the page will not get you a good response. Instead, please send an email to the SproutCore mailing list or join us on IRC in #sproutcore (on irc.freenode.net).

If you want to comment on a page but you don’t need to modify the existing content, please add the comment to the bottom of the page in a section entitled “Comments”. This should be the last section on the page.

To add a comment, do the following:

1. Edit the page
2. If the Comments section does not exist, add it by adding the line h2. Comments
3. Add your comment in the paragraphs below. Be sure to sign your comment with your github username so that someone can follow up with you.

If you want to edit an existing page

If you find an error or want to add more detail to an existing page, do it! If you think you found an error or need to add some detail, but you aren’t entirely positive your change would make the page better, please add your proposed change as a comment to the page. This way someone who knows more will be able to review your comment and make the change for you if it is appropriate.

For best results, please leave a comment at the end of a page when you edit it explaining your changes. This will allow people reviewing your changes to make a more informed decision about whether to accept or reject it.

Linking to your own content

So what if you have written a blog post that expands on a topic or you’ve added a new page to the wiki that relates to a page topic. How do you link it up?

You can add a link directly to your page within the page text (see the Textile reference for info on how to do this) but you should also always add related links to a section at the bottom of the page called “Related Links”. This section should appear just before any comments section.

To add a related link to a page, do the following:

1. Edit the page
2. If the Related Links section does not exist, add it by adding the line h2. Related Links. This should appear just before any Comments section or at the end of the page, if the Comments section does not exist.
3. Add your link below. Follow a format like the example below:

"SproutCore Homepage":http://www.sproutcore.com The homepage for the SproutCore framework has more info on this. – sproutit (Github username)

Adding a new page

If you want to add a new page, you can do so by simply including a link to the new page in an existing page you want to link from. Then save the edit on that page and click on the link you just created to visit the new page.

In general you should link to all new pages from the front page unless you are simply expanding on a topic already covered by an existing page. In that case, you should link from the other page (see Related Links section above). When you link from the front page, please be sure to place your link in the proper section. Avoiding adding new sections to the front page as this makes it harder for people to find your page.

If you need to display an image

To embed an image, you need to host the image somewhere and then link to it. We recommend using the excellent Skitch tool to capture and share images if you are on Mac or Windows. Any image hosting will do though. To include the image, just place the URL to the image on a line by itself surrounded by exclamation marks:

!http://my.skitch.com/path/to/my/image.jpg!

And finally…

All changes to the SproutCore wiki are monitored by core contributors and your edits may be rejected or further modified. For the best results, leave a comment at the end of pages you edit explaining your changes.