|
Size: 5237
Comment: update content (in progress)
|
Size: 6305
Comment: add content (very incomplete)
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 19: | Line 19: |
| '''Please observe the following for all structure pages''': | '''Please observe the following for all structure pages:''' |
| Line 100: | Line 100: |
| === Syntax === The Syntax section consists of |
=== Data Fields === The Data Fields section provides basic information about each field in the structure and is presented in table format. '''The basic format is as follows:''' {{{ ||type||'''field1'''||description|| ||type||'''field2'''||description|| ... ||type||'''fieldN'''||description|| }}} ''Markup'': Use [[http://wiki.libsdl.org/moin.cgi/SGWikiBasics#Tables|basic table markup]] and enclose each field name in [[http://wiki.libsdl.org/moin.cgi/SGWikiBasics#Text_Formatting|bold]] markup. * The __first column__ contains the field types and any pointers. * The __second column__ contains the field names, without types or pointers, in bold. * The __third column__ contains a simple description of each field using some specific formatting conventions. . ''<<Color2(red,Important!)>>'' All descriptions begin with a ''lower case'' letter, end ''without'' a period, and are generally ''not'' complete sentences. * There are a few content-dependent conventions we have chosen for consistency across pages - see the tables below for details. ''Example'': [[SDL_HapticCondition]]() |
DRAFT |
Style Guide: Structure Pages
This guide provides specific instructions for editing or adding your own content to each section of a Structure page in this wiki.
Contents
General Guidelines
Structure pages should provide basic information about the SDL structures to allow users to most effectively utilize them in their projects.
red |
Please observe the following for all structure pages:
- Do not post anything that you do not have permission to post publicly.
- Sections should have adequate details to make them clear and useful while remaining brief wherever possible. Code Examples and Remarks may be more extensive than other sections if necessary.
- Please remember to keep it accurate, simple, and easy to understand.
- Do not remove, modify, or add to the markup (#pragma, etc.) above the page title.
- Do not remove, modify, or add section headings unless specifically mentioned below.
- In general, we prefer that you do not remove or modify existing content unless it is clearly incorrect or out of date.
Pages with red at the top are in progress and will often contain unusual content, formatting, or notes. Please do not remove or modify these. That will all be corrected/removed upon final edit.
For assistance with editing, saving, or wiki-appropriate markup see the Wiki Basics Style Guide or contact us at <ANTI SPAM wiki AT libsdl DOT org>.
Editing Specific Sections
Title
Do not edit the Title.
The Title section consists of the page heading and its markup:
= SDL_StructureName =
For structure pages this is the name of the structure being described on the page and should match the address of the page.
Example: The page address http://wiki.libsdl.org/moin.cgi/SDL_PixelFormat should have matching title SDL_PixelFormat and describe the SDL_PixelFormat structure.
If you believe a change is necessary please submit Feedback from that page or contact us at <ANTI SPAM wiki AT libsdl DOT org>.
Description
The Description section immediately follows the page title and does not have it's own heading.
Structure descriptions begin with: A structure that contains
- or very rarely
A union that contains
followed by a clear and concise description of what the structure contains.
Note: Information presented in this section is meant to be limited. Extended description information for more complicated structures should be placed in the Remarks section instead.
- The Description should not contain a link to the Remarks section even if additional information is located there.
Note: Exceptions to the basic description are very unusual. Follow established patterns in the wiki (based on similar pages which may be found by text search) whenever possible if an exception seems appropriate.
If the page describes a union rather than a structure |
Action: Use the alternate description (A union that contains...) and, if necessary, replace the word structure with the word union where appropriate throughout the page. |
Example: SDL_Event |
|
If another API page is referenced in the description |
Action: Be sure to hyperlink it and use () outside the link markup if it is a function. |
Example: [[SDL_FunctionName]](), [[SDL_StructureName]] |
|
If a parameter on that page is referenced in the description |
Action: Use bold for the parameter name. |
Note: This is a very rare occurrence. |
|
Note: If the reference is to the parameter as a concept (ie: the window to do something with) rather than directly to the parameter itself (ie: SDL_Function(window)) do not make it bold. |
Table of Contents
Do not edit the Table of Contents.
The Table of Contents consists of the following markup and is generated automatically on the parsed page.
<<TableOfContents()>>
If you believe a change is necessary please submit Feedback from that page or contact us at <ANTI SPAM wiki AT libsdl DOT org>.
Data Fields
The Data Fields section provides basic information about each field in the structure and is presented in table format.
The basic format is as follows:
||type||'''field1'''||description|| ||type||'''field2'''||description|| ... ||type||'''fieldN'''||description||
Markup: Use basic table markup and enclose each field name in bold markup.
The first column contains the field types and any pointers.
The second column contains the field names, without types or pointers, in bold.
The third column contains a simple description of each field using some specific formatting conventions.
red All descriptions begin with a lower case letter, end without a period, and are generally not complete sentences.
- There are a few content-dependent conventions we have chosen for consistency across pages - see the tables below for details.
Example: SDL_HapticCondition()
