Skip to content
This repository was archived by the owner on Jun 1, 2020. It is now read-only.
LaurentGomila edited this page Apr 1, 2011 · 8 revisions

This page describes general guidelines for editing the wiki.

Main rules

This wiki is maintained by the SFML community, and as a consequence you are allowed (and encouraged) to edit or add any relevant contribution. However, it is recommended to follow the general organisation and page layout, in order to keep a consistent and pleasant wiki for all. In other words, don't put your source code under the tutorials section.

There's no restriction on the whole wiki for creating or editing pages; you can even create new categories for subjects that don't exist yet, if you think it's worth sharing.

You are also free to edit pages created by other users, if you have relevant additions or corrections to make.

Contents

You are encouraged to share anything related to SFML with no restriction: tutorials, source codes, links, tips and tricks, personal projects, … as long as you find it relevant.

English is the main language of this wiki. However, you can provide translations of certain pages if you want. But keep in mind that the english version has to be the default/main one, if other languages are provided they must only appear as translations of the corresponding english page. Never make wiki links directly point to non-english pages.

When you edit content, please leave a comment in the dedicated text field at the bottom of the page (above the Save and Preview buttons) when you edit it, to let others know what you've done.

Major modifications

If you have requests, suggestions or questions about this wiki, feel free to create a new discussion on the Wiki section of the forum. You should also use this forum to report any bug encountered while using the wiki.

Local links

When you create a link to a new page, you must separate the label of the link (for example A class for animated sprites) and the address of the page (for example animated_sprite). This allows to use descriptive link labels while keeping the name of pages simple.

The example above would translate the following wiki syntax:

[A class for animated sprites](animated_sprite)

Always use relative links inside the wiki, so that pages are properly organized (ie. tutorials are under "wiki/tutorial/", etc.).

Please use capitals to separate words in pages names. Avoid slashes, underscores and spaces. Example: wiki/Sources/CollisionDetection.

Media (images)

There's no option to upload images or other types of files directly to the wiki, you must instead find an external storage for them. If you do so, please make sure that the file will always be available, and not be automatically deleted from the website where you host it after a certain amount of days.

Clone this wiki locally