|
Size: 4003
Comment: add anchors
|
← Revision 33 as of 2014-07-25 17:33:02 ⇥
Size: 4554
Comment: Removed a comma
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 2: | Line 2: |
| #pragma disable-camelcase | #pragma camelcase off |
| Line 5: | Line 5: |
| ||<tablewidth="100%" style="color: #FF0000;" :> DRAFT|| = Contributing = We are very pleased that you are interested in contributing! Here's what you need to know: |
|
| Line 12: | Line 6: |
| Due to spammers, write access to this wiki is disabled by default. If you haven't already, please email your wiki username and the type(s) of edits you would like to make to <<MailTo(ANTI SPAM wiki AT libsdl DOT org)>> to be given write access and to coordinate efforts. | Due to spammers, write access to this wiki is disabled by default. If you haven't already, please email your wiki username and the kind(s) of edits you would like to make to <<MailTo(ANTI SPAM wiki AT libsdl DOT org)>> to be given write access and to coordinate efforts. |
| Line 17: | Line 11: |
| = Contributing = We are very pleased that you are interested in contributing! |
|
| Line 28: | Line 25: |
| <<Anchor(feedback)>> | <<Anchor(form)>> |
| Line 30: | Line 27: |
| This is the quickest and simplest way to contribute! Every page of the wiki contains a drop down ''Feedback'' form (upper right) where you can post quick content ideas, questions, suggestions, etc. Simply click the form tab, fill in the text field with your contribution, and click ''Submit''. We'll take it from there! | . This is the quickest and simplest way for anyone to contribute to the wiki! There is no sign up and no permissions are required to use this option. Every page of the wiki contains a drop down ''Feedback'' form (upper right) where you can post quick content ideas, questions, suggestions, etc. Simply click the form tab, fill in the text field with your contribution, include your contact information if you would like a reply, and click ''Submit''. We'll take it from there! |
| Line 34: | Line 31: |
| The [[http://lists.libsdl.org/listinfo.cgi/docs-libsdl.org|Documentation Mailing List]] has been set up to allow users to discuss documentation-related topics. Anything from conventions to needed content, questions or comments, can be shared in the Mailing List. Plus, keep up with what others are saying and doing on the wiki. | . The [[http://lists.libsdl.org/listinfo.cgi/docs-libsdl.org|Documentation Mailing List]] has been set up to allow users to share documentation-related topics. (There is a separate mailing list for development-related topics.) Anything from conventions to needed content, questions or comments, can be posted to the Mailing List. Plus, keep up with what others are saying and doing on the wiki. |
| Line 36: | Line 33: |
| We encourage all contributors to join the mailing list and participate in the discussions there. It is a great place to discuss areas that need contributions and to let others know what you are working on or if you are able to help address a request. | . We encourage all contributors to join the mailing list and participate in the discussions there. It is a great place to discuss areas that need contributions and to let others know what you are working on or if you are able to help address a request. |
| Line 40: | Line 37: |
| These are the core of our contribution resources. There is a style guide for each type of contribution you may wish to make as well as the [[http://wiki.libsdl.org/moin.cgi/SGWikiBasics|Wiki Basics]] guide which contains global information that all contributors should have. | . These are the core of our contribution resources. There is a style guide for each type of contribution you may wish to make as well as the [[SGWikiBasics|Wiki Basics]] guide which contains global information that all contributors should have. |
| Line 42: | Line 39: |
| We recommend that you begin with Wiki Basics and then dive into the topic-specific guides that interest you before you begin to edit. Please check back periodically for reminders and updates! | . '''We recommend that you begin with [[SGWikiBasics|Wiki Basics]] and then dive into the topic-specific guides that interest you before you begin to edit.''' Please check back periodically for reminders and updates! |
| Line 44: | Line 41: |
| ||Table with links to each style guide||Basic description of SG contents|| ||[[http://wiki.libsdl.org/moin.cgi/SGWikiBasics|Wiki Basics]]||quick reference for wiki markup used in this wiki<<BR>>miscellaneous helpful notes|| ||[[|Code Examples]]||information on adding Code Examples to any API page|| ||[[|Remarks]]||information on adding Remarks to any API page|| ||[[|Tutorials]]||information on adding a tutorial to the tutorials page<<BR>>information on creating a new tutorial within the wiki|| |
||<bgcolor="#EDEDED">''Style Guide''||<bgcolor="#EDEDED">''Topics Covered''|| ||[[SGWikiBasics|Wiki Basics]]||Starting to edit<<BR>>Saving changes<<BR>>Style Guide basics<<BR>>Quick reference for wiki markup used in this wiki<<BR>>Miscellaneous notes|| ||[[SGCodeExamples|Code Examples]]||Adding Code Examples to any [[SGWikiBasics#api|API page]]|| ||[[SGRemarks|Remarks]]||Adding Remarks to any [[SGWikiBasics#api|API page]]|| ||[[SGTutorials|Tutorials]]||Adding an existing tutorial to the Tutorials page<<BR>>Creating a new tutorial within the wiki|| ||[[SGFunctions|Function Pages]]||Editing Function pages<<BR>>Editing Macro pages<<BR>>~-This is supplemental to the Code Examples and Remarks Style Guides-~|| ||[[SGStructures|Structure Pages]]||Editing Structure pages<<BR>>Editing Union pages<<BR>>~-This is supplemental to the Code Examples and Remarks Style Guides-~|| ||[[SGEnumerations|Enumeration Pages]]||Editing Enumeration pages<<BR>>Editing Hint pages<<BR>>~-This is supplemental to the Code Examples and Remarks Style Guides-~|| ||[[SGNewPages|New Pages]]||Creating new pages in the wiki<<BR>>~-This is supplemental to the other Style Guides-~|| |
| Line 50: | Line 51: |
| It is very important to us that this wiki remains as friendly and professional as possible. We have created detailed style guides to help you ensure that your contributions fit in seamlessly and help to make the wiki that much better for other users. If you find something that is not addressed or is unclear in a style guide please post your questions using the feedback form, the mailing list, or email us at <<MailTo(ANTI SPAM wiki AT libsdl DOT org)>>. |
. If you find something that is not addressed or is unclear in a style guide please post your questions to the Documentation mailing list, on a Forum, or email us at <<MailTo(ANTI SPAM wiki AT libsdl DOT org)>>. |
| Line 55: | Line 54: |
| === Email Contact === For anything that is not addressed in the above you can always send an email to <<MailTo(ANTI SPAM wiki AT libsdl DOT org)>>. |
=== Email === . For anything that is not addressed in the above you can always send an email to <<MailTo(ANTI SPAM wiki AT libsdl DOT org)>>. |
Due to spammers, write access to this wiki is disabled by default. If you haven't already, please email your wiki username and the kind(s) of edits you would like to make to <ANTI SPAM wiki AT libsdl DOT org> to be given write access and to coordinate efforts.
Thank you!
Contributing
We are very pleased that you are interested in contributing!
Our goal is to create the best documentation for SDL possible. To this end we have adopted the following guiding principles and would appreciate your keeping them in mind as you create your contributions.
- This wiki should:
- have a consistent look and feel throughout
- be easy to use
- be accurate
- contain high quality information
- be as simple and straight forward as possible
To help you with this we have created a series of resources:
Feedback Form
This is the quickest and simplest way for anyone to contribute to the wiki! There is no sign up and no permissions are required to use this option. Every page of the wiki contains a drop down Feedback form (upper right) where you can post quick content ideas, questions, suggestions, etc. Simply click the form tab, fill in the text field with your contribution, include your contact information if you would like a reply, and click Submit. We'll take it from there!
Mailing List
The Documentation Mailing List has been set up to allow users to share documentation-related topics. (There is a separate mailing list for development-related topics.) Anything from conventions to needed content, questions or comments, can be posted to the Mailing List. Plus, keep up with what others are saying and doing on the wiki.
- We encourage all contributors to join the mailing list and participate in the discussions there. It is a great place to discuss areas that need contributions and to let others know what you are working on or if you are able to help address a request.
Style Guides by Topic
These are the core of our contribution resources. There is a style guide for each type of contribution you may wish to make as well as the Wiki Basics guide which contains global information that all contributors should have.
We recommend that you begin with Wiki Basics and then dive into the topic-specific guides that interest you before you begin to edit. Please check back periodically for reminders and updates!
Style Guide
Topics Covered
Starting to edit
Saving changes
Style Guide basics
Quick reference for wiki markup used in this wiki
Miscellaneous notesAdding Code Examples to any API page
Adding Remarks to any API page
Adding an existing tutorial to the Tutorials page
Creating a new tutorial within the wikiEditing Function pages
Editing Macro pages
This is supplemental to the Code Examples and Remarks Style GuidesEditing Structure pages
Editing Union pages
This is supplemental to the Code Examples and Remarks Style GuidesEditing Enumeration pages
Editing Hint pages
This is supplemental to the Code Examples and Remarks Style GuidesCreating new pages in the wiki
This is supplemental to the other Style GuidesIf you find something that is not addressed or is unclear in a style guide please post your questions to the Documentation mailing list, on a Forum, or email us at <ANTI SPAM wiki AT libsdl DOT org>.
For anything that is not addressed in the above you can always send an email to <ANTI SPAM wiki AT libsdl DOT org>.
Disclaimer
All content modifications are subject to review for consistency and quality. We reserve the right to remove or modify any content added to this wiki at any time. You may direct questions or concerns to <ANTI SPAM wiki AT libsdl DOT org>.
