Differences between revisions 1 and 8 (spanning 7 versions)

Style Guide: Enumerations Pages

This guide provides specific instructions for editing or adding your own content to each section of an Enumeration page in this wiki.

Enumeration pages should provide basic information about the SDL enumerations to allow users to most effectively utilize them in their projects.

Contents

Style Guide: Enumerations Pages

General Guidelines

red

The basic enumeration template is also used for hints that have pages in the wiki. For simplicity, the following guidelines for enumerations will also apply to hints unless a specific difference is noted.

Please observe the following for all enumeration 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 above the page title (processing instructions (ie: #pragma, #acl), red
markup, etc.) except:
- On CategoryCompat pages, place the following markup above the page title and below the processing instructions or DRAFT markup, if present:
- ||<tablewidth="100%" #000000 style="color: #FF8C00;" :> <<BR>>~+For Backward Compatibility Only+~<<BR>><<BR>> ||
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.

Return to Table of Contents

Getting Started

Begin by going to the page you wish to edit and selecting blue
or blue in the left column to begin editing.
- Markup info provided here is specifically for use in the Text editor but should work in both.
Scroll down in the edit window to the section(s) you want to edit. Add your content following the conventions in this style guide.
Find information relevant to your content in the style guide sections below and apply the appropriate formatting as you edit.
Preview your work as you go by clicking blue in the left column. Preview often and any time you are unsure of formatting.
- (Keep in mind that a few things (like Color2 text) don't preview exactly as they parse.)
Save your work by clicking blue in the left column after you are satisfied with your content and have filled in the Comment field under the editing box.

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>.

Return to Table of Contents

Editing Specific Sections

Title

Do not edit the Title.

The Title section consists of the page heading and its markup:

= SDL_EnumerationName =

For enumeration pages this is the name of the enumeration being described on the page and should match the address of the page.

Example: The page address http://wiki.libsdl.org/moin.cgi/SDL_EventType should have matching title SDL_EventType and describe the SDL_EventType 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>.

Return to Table of Contents

Description

The Description section immediately follows the page title and does not have it's own heading.

Enumeration descriptions begin with:

An enumeration of
- or very rarely
A hint that specifies
followed by a clear and concise description of what the enumeration (or hint) is.

Note: Information presented in this section is meant to be limited. Extended description information for more complicated enumerations 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 hint rather than an enumeration	Action: Use the alternate description (`A hint that specifies...`) and, if necessary, replace the word `enumeration` with the word `hint` where appropriate throughout the page.
If the page describes a hint rather than an enumeration	Example: SDL_EventType, SDL_HINT_RENDER_SCALE_QUALITY
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.
If another API page is referenced in the description	Example: `[[SDL_FunctionName]](), [[SDL_StructureName]]`, SDL_BlendMode
If a value on that page is referenced in the description	Action: There is no special formatting for enumeration values since most are already in all caps and distinct enough. (This is different from function parameters or structure data values.)

Return to 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>.

Return to Table of Contents

Values

The Values section provides basic information about each value in the enumeration and is presented in table format.

The basic format is as follows:

||value1||description||
||value2||description||
...
||valueN||description||

Markup: Use basic table markup. All text in the table is left-justified. Do not use bold.

The first column contains the value name, usually in all caps (format as in the API).
The second column contains a simple description of each value using some specific formatting conventions.
- red
  All descriptions begin with a lower case letter, end without a period, and are generally not complete sentences.

Example: SDL_BlendMode, SDL_HintPriority, SDL_PowerState, SDL_WindowFlags

Action: There are a few content-dependent conventions we have chosen for consistency across pages. See the tables below for details.

General (whole table)
If the value is for internal use, deprecated, or unused (greyed out)	Action 1: Place a text notation in parentheses at the end of the description (ie: `(deprecated)`)
	Action 2: Make the text in the row grey by including the following, verbatim, in the first cell of the row between the starting table markup and the text: `<rowstyle="color: #808080;">`
	Note: Although a rare case, any other style markup for that row/cell should be included within the same set of angle brackets (`<>`) and separated from this markup by a space.
	Markup: `\|\|<rowstyle="color: #808080;">value\|\|description\|\|`
	Example: SDL_EventType, SDL_LOG_CATEGORY
If the value is specified as read-only	Action: Place the text notation `(read-only)` in parentheses at the end of the description. Do not grey out the line. If all values are read-only notate it in the Remarks instead.
	Note: This also applies to the rare case that "`(read-write)`" is specified.
	Example: There are currently no enumeration examples of this. SDL_Surface, SDL_PixelFormat
If another API page is referenced and the value is greyed out (see above)	Action 1: DO NOT hyperlink the page in the table.
	Action 2: List the page, with a hyperlink, in the description and/or in the appropriate "Related" section at the bottom of the page, if appropriate.
	Example: There are currently no enumeration examples of this. SDL_Event
If another API page is referenced and the value is not greyed out (see above)	Action1: Be sure to hyperlink it and use () outside the link markup if it is a function.
	Action 2: List the page in the appropriate "Related" section at the bottom of the page, if appropriate.
	Example: There are currently no enumeration examples of this. SDL_Event, SDL_BlendMode
If there are important, distinct groups of values within the enumeration	Action: Create sections by placing a full-width row with a grey background and centered, italics title above each group.
	Markup: Begin the row with empty table cells equal to the number of columns in the table -1 (ie: 1 empty cell for a 2 column table). Place the following markup in the last cell `<bgcolor="#EDEDED">''Section Title''` Replace `Section Title` with appropriate text and close the last column.
	Note: This is a rare occurrence. Do not use sections unless they significantly improve the meaning, clarity, or usability of the information.
	Example: this table, SDL_AudioFormat, SDL_EventType
Specific (description column)
If more than one statement must be included in the description	Action: Separate them with a semi-colon (;)
	Note: This should be avoided whenever possible. See "If a more detailed description is required to adequately explain a value" below for more details.
	Example: SDL_HintPriority, SDL_GLattr
If a more detailed description is required to adequately explain a value	Action 1 : Append the following, verbatim, to the end of the brief description `; see [[#Remarks\|Remarks]] for details`
	Action 2: Place the more detailed information in the Remarks section.
	Action 3: See "If the Remarks section is large" below for more details.
	Example: SDL_PixelFormatEnum, SDL_GLattr
If the Remarks section is large	Action 1: Create an anchor immediately before the additional comments you are adding to the Remarks section.
	Markup: Use `<<Anchor(anchorname)>>`, where `anchorname` is a name of your choosing, to create the anchor in the Remarks section. See Anchors for details.
	Action 2: Modify the Remarks link in the parameter description (see Action 1 in "If a more detailed description is required to adequately explain a value" above) to the following: `; see [[#anchorname\|Remarks]] for details` where `anchorname` matches the name you chose for the anchor in Action 1.
	Example: SDL_GLattr, SDL_PixelFormatEnum
If there is no relevant description text	Action: It is acceptable to leave the description cell blank, although it is preferable to put some information there even if it is redundant with the field name or otherwise does not really provide any novel information.
	Note: If none of the values has relevant description text it is acceptable to remove the entire description column, but this should be done with caution and only extremely rarely.
	Example: SDL_PixelFormatEnum, SDL_AudioStatus, SDL_HINT_RENDER_DRIVER

Return to Table of Contents

Code Examples

The Code Examples section is meant to contain simple, meaningful examples of how to use the enumeration in a program.

Unlike other sections, which should rarely require editing once DRAFT is removed, this section is expected to change over time.

This is one of the few sections that is intended to grow and adjust as users discover more information about an enumeration that would be helpful to share with other users.

For the most part the contents of the Code Examples section will be user-generated and this section will remain as-is until users input their examples.

Please see the Code Examples Style Guide for details on editing this section.

Return to Table of Contents

Remarks

The Remarks section is meant to contain additional information that did not fit in the other sections as well as comments regarding the behavior and use of the enumeration in real-world applications.

Unlike other sections, which should rarely require editing once DRAFT is removed, this section is expected to change over time.

This is one of the few sections that is intended to grow and adjust as users discover more information about how an enumeration behaves under different circumstances.

For the most part the contents of the Remarks section will be user-generated and this section will remain as-is until users input their comments.

Note: This is not an appropriate place to post questions, suggestions, bugs, or commentary. Please use the other communication channels available to you, especially the forums and mailing lists, for these types of remarks.

Please see the Remarks Style Guide for details on editing this section.

Return to Table of Contents

Related Enumerations

The Related Enumerations section provides a list of enumerations specifically referenced by the enumeration or otherwise closely related to it. This section is very rarely used.

This list should include:

other enumerations that are specifically referenced in the enumeration (may never occur)
other enumerations that are indirectly referenced by or very closely related to the enumeration
- (ie: the enum is not used as a value but its values are used to fill in a value or they are different aspects of the same idea)
- This is very uncommon.

This list should not include:

the primary enumeration on that page
every enumeration that might be considered "related" to the enumeration or any other listed enumerations
- Including too many would make these lists much less valuable.
all enumerations of similar type
all enumerations of a related category
enumerations that are indirectly related
- (ie: it might be common to use them together)
enumerations that do not have a page in the wiki
non-enumerations
- (ie: do not include functions or structures in this list)

Markup: Each line should begin with a single blank space and a period followed by the enumeration name enclosed in double brackets to create a hyperlink.

Note: Do not include empty parentheses after the name.
The basic format for the Related Enumerations list is:

== Related Enumerations ==
 .[[SDL_EnumerationName]]
 .[[SDL_EnumerationName]]

Note: The heading was included to more clearly illustrate the blank space before the period at the beginning of each list line. Without this markup the format will not parse correctly.

If there is more than one enumeration in the list	Action: List the enumerations in alphabetical order.
If there are no related enumerations	Action: This section may be removed entirely (including the heading) and added back at a later time if it becomes relevant.
If there are no related enumerations	Note: It is common for this section to be empty and removed from the page.

Example: SDL_Keycode, SDL_Scancode

Return to Table of Contents

Related Structures

The Related Structures section provides a list of structures (or unions) specifically referenced by the enumeration or otherwise closely related to it.

This list should include:

structures that specifically reference the enumeration
structures that indirectly reference but are closely related to the enumeration
- This is uncommon.

This list should not include:

every other structure that might be considered "related"
- Including too many would make these lists much less valuable.
all structures of similar type
all structures of a related category
structures that are indirectly related
- (ie: it might be common to use them together)
structures that do not have a page in the wiki
non-structures
- (ie: do not include functions or enumerations in this list)

Markup: Each line should begin with a single blank space and a period followed by the structure name enclosed in double brackets to create a hyperlink.

Note: Do not include empty parentheses after the name.
The basic format for the Related Structures list is:

== Related Structures ==
 .[[SDL_StructureName]]
 .[[SDL_StructureName]]

Note: The heading was included to more clearly illustrate the blank space before the period at the beginning of each list line. Without this markup the format will not parse correctly.

If there is more than one structure in the list	Action: List the structures in alphabetical order.
If the structure is a member of the SDL_Event union	Action: Include SDL_Event in this section of the page.
If there are no related structures	Action: This section may be removed entirely (including the heading) and added back at a later time if it becomes relevant.
If there are no related structures	Note: It is common for this section to be empty and removed from the page.

Example: SDL_AudioFormat, SDL_BlendMode, SDL_PixelFormatEnum

Return to Table of Contents

Related Functions

The Related Functions section provides a list of functions specifically associated with that enumeration or otherwise closely related to it.

In general, a "Related Function" is one that uses the given enumeration.

This list should include:

functions that use or are otherwise very closely related to the enumeration

This list should not include:

every other function that might be considered "related"
- Including too many would make these lists much less valuable.
all functions of similar type or action
all functions of a related category
functions that are indirectly related (ie: a similar function that does not use the structure)
functions that do not have a page in the wiki
non-functions (ie: do not include structures or enumerations in this list)

Markup: Each line should begin with a single blank space and a period followed by the function name enclosed in double brackets to create a hyperlink.

Note: Do not include empty parentheses after the function names in this section. They are all functions so it should be understood/unnecessary.
The basic format for the Related Functions list is:

== Related Functions ==
 .[[SDL_FunctionName]]
 .[[SDL_FunctionName]]

Note: The heading was included to more clearly illustrate the blank space before the period at the beginning of each list line. Without this markup the format will not parse correctly.

If there is more than one function in the list	Action: List the functions in alphabetical order.
If there are no related functions	Action: This section may be removed entirely (including the heading) and added back at a later time if it becomes relevant.

Example: SDL_AudioStatus, SDL_HintPriority, SDL_TextureAccess

Return to Table of Contents

red

See Hint Pages below for details on how this section is different for Hint pages.

The Footer section consists of a horizontal rule followed by two links separated by a comma.

Markup:

----
[[CategoryEnum]], [[CategoryHeader]]

where CategoryEnum is the same for every enumeration page and CategoryHeader is enumeration-specific with Header varying based on the header file containing the enumeration (see below).

red

Category names do not always match the header file name. Please consult the following table for the correct name to use so the enumeration will appear in the correct list(s).

Action 1: Do not edit the CategoryEnum link!

Action 2: The CategoryHeader link may be edited if the page still says [[CategoryHeader]] (as on a new page) or if the structure has been relocated to another header (very rare).

red

There are a few exceptions to this rule (pages with a category name that does not match their header file according to the table). These have been determined by the SDL team. Please do not change an existing page's category name simply because it does not match its header file. If you are concerned that a name is incorrect please submit your concern in the forums or mailing lists or contact us at <ANTI SPAM wiki AT libsdl DOT org> to confirm the change first.

Markup: Replace CategoryHeader with the appropriate category name from the table that follows, or contact us at <ANTI SPAM wiki AT libsdl DOT org> to find out what category name to use if you are unsure or if the category appears to be missing.

Header File Containing the Structure*	Corresponding Category Name
SDL.h	CategoryInit
SDL_assert.h	CategoryAssertions
SDL_atomic.h	CategoryAtomic
SDL_audio.h	CategoryAudio
SDL_clipboard.h	CategoryClipboard
SDL_compat.h	CategoryCompat
SDL_cpuinfo.h	CategoryCPU
SDL_endian.h	CategoryEndian
SDL_error.h	CategoryError
SDL_events.h	CategoryEvents
SDL_haptic.h	CategoryForceFeedback
SDL_hints.h	CategoryHints
SDL_joystick.h	CategoryJoystick
SDL_keyboard.h	CategoryKeyboard
SDL_keycode.h	CategoryKeyboard
SDL_loadso.h	CategorySharedObject
SDL_log.h	CategoryLog
SDL_mouse.h	CategoryMouse
SDL_mutex.h	CategoryMutex
SDL_pixels.h	CategoryPixels
SDL_platform.h	CategoryPlatform
SDL_power.h	CategoryPower
SDL_quit.h	CategoryEvents
SDL_rect.h	CategoryRect
SDL_render.h	CategoryRender
SDL_rwops.h	CategoryIO
SDL_scancode.h	CategoryKeyboard
SDL_surface.h	CategorySurface
SDL_syswm.h	CategorySWM
SDL_thread.h	CategoryThread
SDL_timer.h	CategoryTimer
SDL_version.h	CategoryVersion
SDL_video.h	CategoryVideo
*Some exceptions exist. See above.

Return to Table of Contents

Special

This section contains details for special formatting circumstances that are best described separately from the average enumeration page. In general these guidelines should be used in conjunction with the above.

Hint Pages

In some cases Hints are formatted slightly differently than enumerations. Use the following formatting specifics in addition to those listed above for all CategoryHints pages::

Action 1: All Hint pages contain an additional section not present on enumeration pages - Default

Markup: Add the following section to all CategoryHints pages between the Values and Code Examples sections.

```
== Default ==
```

Action: Immediately under this section include at least one sentence beginning with the following, and describing the default state, if any, for that hint:
- By default...

Example: SDL_HINT_FRAMEBUFFER_ACCELERATION, SDL_HINT_RENDER_SCALE_QUALITY

Action 2: The Footer section of a Hint page follows the same guidelines as for an enumeration page with the following differences:

Use [[CategoryDefine]], [[CategoryHints]] as the link pair at the bottom instead.
The table above is irrelevant to this section since they are all the same.

Note: To date there are no Related Enumerations, Related Structures, or Related Functions listed on any Hint page. Should there be, follow the same general guidelines as for enumerations.

Return to Table of Contents

Resources

Our goal is to create accurate, consistent, helpful, user-friendly documentation. We appreciate your efforts to make your additions fit into the existing framework and retain the same look and feel as much as possible.

If you have questions that aren't addressed here:

Search for another page that contains something similar to what you want to do and copy all the basics as much as applicable.
Check the other SDL Style Guides.
Post a question to Feedback and include a way to contact you.
Post a question to the Mailing List.
Send a comment or question to <ANTI SPAM wiki AT libsdl DOT org> for clarification.

If you have suggestions for changes or additions to this document or any other portion of the wiki please don't hesitate to contact us with your thoughts. We are happy to have the participation!

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>.

-  ⇤ ← Revision 1 as of 2011-12-15 05:59:33 → 
  Size: 37392
  Editor: SheenaSmith
  Comment: create page - in progress (very incomplete)
+   ← Revision 8 as of 2012-01-06 00:09:48 → ⇥
  Size: 26393
  Editor: SheenaSmith
  Comment: remove draft
-Deletions are marked like this.
+Additions are marked like this.
 Line 4:
-||<tablewidth="100%" style="color: #FF0000;" :> DRAFT||
-Line 45:
+Line 44:
-  . ~-(Keep in mind that a few things (like [[SGWikiBasics#Text_Formatting|Color2 text]]) don't preview exactly as they parse.)-~
+  . ~-(Keep in mind that a few things (like [[SGWikiBasics#color2|Color2 text]]) don't preview exactly as they parse.)-~
-Line 50:
+Line 49:
-#############################################################
-Line 62:
+Line 61:
- {{{= 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.
+ {{{= SDL_EnumerationName =}}} 

For enumeration pages this is the name of the enumeration being described on the page and should match the address of the page.

''Example'': The page address {{{http://wiki.libsdl.org/moin.cgi/SDL_EventType}}} should have matching title {{{SDL_EventType}}} and describe the [[SDL_EventType]] structure.
-Line 77:
+Line 76:
-'''Structure descriptions begin with:
 {{{A structure that contains}}}'''
+'''Enumeration descriptions begin with:
 {{{An enumeration of}}}'''
-Line 80:
+Line 79:
- {{{A union that contains}}}

 . followed by a ''clear and concise'' description of what the structure contains.
+ {{{A hint that specifies}}}

 . followed by a ''clear and concise'' description of what the enumeration (or hint) is.
-Line 85:
+Line 84:
-''Note'': Information presented in this section is meant to be limited.  Extended description information for more complicated structures should be placed in the [[#Remarks|Remarks]] section instead.
+''Note'': Information presented in this section is meant to be limited.  Extended description information for more complicated enumerations should be placed in the [[#Remarks|Remarks]] section instead.
-Line 90:
+Line 89:
-||<( |2 30%>''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]]||
+||<( |2 30%>''If'' the page describes __a hint__ rather than an enumeration||''Action'': Use the alternate description (`A hint that specifies...`) and, if necessary, replace the word `enumeration` with the word `hint` where appropriate throughout the page.||
||''Example'': [[SDL_EventType]], [[SDL_HINT_RENDER_SCALE_QUALITY]]||
-Line 93:
+Line 92:
-||''Example'': {{{[[SDL_FunctionName]](), [[SDL_StructureName]]}}}, [[SDL_GetThreadName]]()||
||<( |4 30%>''If'' __a parameter on that page__ is referenced in the description||''Action'': Use '''[[SGWikiBasics#Text_Formatting|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.<<BR>>~-Please don't just make the word bold every time it occurs on the page.-~||
||''Example'': [[SDL_LoadWAV_RW]]||
+||''Example'': {{{[[SDL_FunctionName]](), [[SDL_StructureName]]}}}, [[SDL_BlendMode]]||
||<( 30%>''If'' __a value on that page__ is referenced in the description||''Action'': There is no special formatting for enumeration values since most are already in all caps and distinct enough. (This is different from function parameters or structure data values.)||
-Line 117:
+Line 111:
-=== Data Fields ===
The Data Fields section provides basic information about each field in the structure and is presented in table format.
+=== Values ===
The Values section provides basic information about each value in the enumeration and is presented in table format.
-Line 122:
+Line 116:
-||type1||'''field1'''||description||
||type2*||'''field2'''||description||
||[[type3]]||'''field3'''||description||
+||value1||description||
||value2||description||
-Line 126:
+Line 119:
-||typeN||'''fieldN'''||description||
}}}

''Markup'': Use [[SGWikiBasics#Tables|basic table markup]] and enclose each field name in [[SGWikiBasics#Text_Formatting|bold]] markup.  All text in the table is left-justified.

 * The __first column__ contains the field type and any pointers if applicable.
 * The __second column__ contains the field name, without types or pointers, in bold.
 * The __third column__ contains a simple description of each field using some specific formatting conventions.
+||valueN||description||
}}}

''Markup'': Use [[SGWikiBasics#Tables|basic table markup]].  All text in the table is left-justified.  Do not use bold.

 * The __first column__ contains the value name, usually in all caps (format as in the API).
 * The __second column__ contains a simple description of each value using some specific formatting conventions.
-Line 136:
+Line 128:
-''Example'': [[SDL_Surface]], [[SDL_JoyButtonEvent]], [[SDL_Palette]], [[SDL_HapticCondition]]
+''Example'': [[SDL_BlendMode]], [[SDL_HintPriority]], [[SDL_PowerState]], [[SDL_WindowFlags]]
-Line 141:
+Line 133:
-||<( |4 30%>''If'' the field is __for internal use, deprecated, or unused__ (greyed out)||<<Anchor(grey)>>''Action 1'': Place a text notation in parentheses at the ''end'' of the description (ie: `(deprecated)`)||
+||<( |5 30%>''If'' the value is __for internal use, deprecated, or unused__ (greyed out)||<<Anchor(grey)>>''Action 1'': Place a text notation in parentheses at the ''end'' of the description (ie: `(deprecated)`)||
-Line 144:
+Line 136:
-||''Example'': {{{||<rowstyle="color: #808080;">type||'''field'''||description||}}}, [[SDL_Palette]], [[SDL_Color]]||
||<( |3 30%>''If'' the field is __read-only__||''Action'': Place the text notation `(read-only)` in parentheses at the end of the description.<<BR>>Do not grey out the line.||
||''Note'': This also applies to the rare "`(read-write)`" field.||
||''Example'': [[SDL_Surface]], [[SDL_Overlay]]||
||<( |3 30%>''If'' __another API page__ is referenced ''and'' __the field is greyed out__ (see [[#grey|above]])||''Action 1'': DO NOT hyperlink the page in the type column.||
+||''Markup'': {{{||<rowstyle="color: #808080;">value||description||}}}||
||''Example'': [[SDL_EventType]], [[SDL_LOG_CATEGORY]]||
||<( |3 30%>''If'' the value is specified as __read-only__||''Action'': Place the text notation `(read-only)` in parentheses at the end of the description.<<BR>>Do not grey out the line.<<BR>>If ''all'' values are read-only notate it in the Remarks instead.||
||''Note'': This also applies to the rare case that "`(read-write)`" is specified.||
||''Example'': There are currently no enumeration examples of this.  [[SDL_Surface]], [[SDL_PixelFormat]]||
||<( |3 30%>''If'' __another API page__ is referenced ''and'' __the value is greyed out__ (see [[#grey|above]])||''Action 1'': DO NOT hyperlink the page in the table.||
-Line 150:
+Line 143:
-||''Example'': [[SDL_Event]]||
||<( |3 30%>''If'' __another API page__ is referenced ''and'' __the field is ''not'' greyed out__ (see [[#grey|above]])||''Action1'': Be sure to [[SGWikiBasics#Hyperlinks|hyperlink]] it and use () outside the link markup if it is a function.||
+||''Example'': There are currently no enumeration examples of this.  [[SDL_Event]]||
||<( |3 30%>''If'' __another API page__ is referenced ''and'' __the value is ''not'' greyed out__ (see [[#grey|above]])||''Action1'': Be sure to [[SGWikiBasics#Hyperlinks|hyperlink]] it and use () outside the link markup if it is a function.||
-Line 153:
+Line 146:
-||''Example'': [[SDL_Event]], [[SDL_AudioSpec]], [[SDL_SysWMinfo]]||
||<( |4 30%>''If'' there are __important, distinct groups of fields__ within the structure||''Action'': Create sections by placing a full-width row with a grey background and centered, italics title above each group.||
||''Markup'': Begin the row with empty table cells equal to the number of columns in the table -1 (ie: 2 empty cells for a 3 column table).  Place the following markup in the next cell<<BR>>`<bgcolor="#EDEDED">''Section Title''`<<BR>>Replace `Section Title` with appropriate text and close the last column.||
+||''Example'': There are currently no enumeration examples of this.  [[SDL_Event]], [[SDL_BlendMode]]||
||<( |4 30%>''If'' there are __important, distinct groups of values__ within the enumeration||''Action'': Create sections by placing a full-width row with a grey background and centered, italics title above each group.||
||''Markup'': Begin the row with empty table cells equal to the number of columns in the table -1 (ie: 1 empty cell for a 2 column table).  Place the following markup in the last cell<<BR>>`<bgcolor="#EDEDED">''Section Title''`<<BR>>Replace `Section Title` with appropriate text and close the last column.||
-Line 157:
+Line 150:
-||''Example'': this table, [[SDL_HapticConstant]], [[SDL_HapticRamp]]||
||<( |2 30%>''If'' the structure includes __padding__ fields||''Action'': Omit all `padding` fields from the wiki page.||
||''Example'': [[SDL_AudioSpec]], [[SDL_WindowEvent]]||
||<( |3 30%>''If'' there is __a pointer__ associated with the field||''Action 1'': Place the pointer symbol(s) at the end of the type in the ''first column'' with no space between.||
||''Action 2'': In general, avoid mentioning the pointer in the description unless it is necessary to understand the field.||
||''Example'': {{{||type*||...}}}, [[SDL_Surface]], [[SDL_assert_data]]||
||||<bgcolor="#EDEDED">''First Column (type) & Second Column (field)''||
||||<(>There are currently no special formatting instructions that affect only these columns.  See [[#general|''General'']] above.||
||||<bgcolor="#EDEDED">''Third Column (description)''||
+||''Example'': this table, [[SDL_AudioFormat]], [[SDL_EventType]]||
||||<bgcolor="#EDEDED">''Specific (description column)''||
-Line 167:
+Line 153:
-||''Note'': This should be avoided whenever possible.  See "''If'' a __[[#detailed|more detailed description]]__ is required to adequately explain a field" below for more details.||
||''Example'': [[SDL_JoyButtonEvent]], [[SDL_Keysym]]||
||<( |4 30%>''If'' a __more detailed description__ is required to adequately explain a field||<<Anchor(detailed)>>''Action 1'' : Append the following, verbatim, to the end of the brief description<<BR>>{{{; see [[#Remarks|Remarks]] for details}}}||
+||''Note'': This should be avoided whenever possible.  See "''If'' a __[[#detailed|more detailed description]]__ is required to adequately explain a value" below for more details.||
||''Example'': [[SDL_HintPriority]], [[SDL_GLattr]]||
||<( |4 30%>''If'' a __more detailed description__ is required to adequately explain a value||<<Anchor(detailed)>>''Action 1'' : Append the following, verbatim, to the end of the brief description<<BR>>{{{; see [[#Remarks|Remarks]] for details}}}||
-Line 172:
+Line 158:
-||''Example'': [[SDL_RendererInfo]], [[SDL_HapticEffect]]||
+||''Example'': [[SDL_PixelFormatEnum]], [[SDL_GLattr]]||
-Line 175:
+Line 161:
-||''Action 2'': Modify the Remarks link in the parameter description (see ''Action 1'' in "''If'' a __[[#detailed|more detailed description]]__ is required to adequately explain a field" above) to the following:<<BR>>{{{; see [[#anchorname|Remarks]] for details}}}<<BR>>where `anchorname` matches the name you chose for the anchor in ''Action 1''.||
||''Example'': [[SDL_RendererInfo]]||
||<( |4 30%>''If'' __a field references another field__ on that same page||''Action'': Use '''[[SGWikiBasics#Text_Formatting|bold]]''' for the field name.||
||''Note'': This is a very rare occurrence.||
||''Note'': If the reference is to the field as a ''concept'' rather than ''directly'' to the field itself do not make it bold.<<BR>>~-Please don't just make the word bold every time it occurs on the page.-~||
||''Example'': [[SDL_AudioCVT]], [[SDL_HapticCustom]]||
||<( |2 30%>''If'' there is __no relevant description text__||''Action'': It is acceptable to leave the description cell blank, although it is preferable to put some information there even if it is redundant with the field name or otherwise does not really provide any novel information.||
||''Example'': [[SDL_Color]]||
+||''Action 2'': Modify the Remarks link in the parameter description (see ''Action 1'' in "''If'' a __[[#detailed|more detailed description]]__ is required to adequately explain a value" above) to the following:<<BR>>{{{; see [[#anchorname|Remarks]] for details}}}<<BR>>where `anchorname` matches the name you chose for the anchor in ''Action 1''.||
||''Example'': [[SDL_GLattr]], [[SDL_PixelFormatEnum]]||
||<( |3 30%>''If'' there is __no relevant description text__||''Action'': It is acceptable to leave the description cell blank, although it is preferable to put some information there even if it is redundant with the field name or otherwise does not really provide any novel information.||
||''Note'': If ''none'' of the values has relevant description text it is acceptable to remove the entire description column, but this should be done with caution and only extremely rarely.||
||''Example'': [[SDL_PixelFormatEnum]], [[SDL_AudioStatus]], [[SDL_HINT_RENDER_DRIVER]]||
-Line 191:
+Line 174:
-The Code Examples section is meant to contain simple, meaningful examples of how to use the structure in a program.
+The Code Examples section is meant to contain simple, meaningful examples of how to use the enumeration in a program.
-Line 194:
+Line 177:
-This is one of the few sections that is intended to grow and adjust as users discover more information about a structure that would be helpful to share with other users.
+This is one of the few sections that is intended to grow and adjust as users discover more information about an enumeration that would be helpful to share with other users.
-Line 205:
+Line 188:
-The Remarks section is meant to contain additional information that did not fit in the other sections as well as comments regarding the behavior and use of the structure in real-world applications.
+The Remarks section is meant to contain additional information that did not fit in the other sections as well as comments regarding the behavior and use of the enumeration in real-world applications.
-Line 208:
+Line 191:
-This is one of the few sections that is intended to grow and adjust as users discover more information about how a structure behaves under different circumstances.
+This is one of the few sections that is intended to grow and adjust as users discover more information about how an enumeration behaves under different circumstances.
-Line 212:
+Line 195:
-''Note'': This is __not__ an appropriate place to post questions, suggestions, bugs, or commentary.  Please use the other communication channels available to you, especially the [[http://forums.libsdl.org/|forums]] and ''Feedback'' form, for these types of remarks.
+''Note'': This is __not__ an appropriate place to post questions, suggestions, bugs, or commentary.  Please use the other communication channels available to you, especially the [[http://forums.libsdl.org/|forums]] and [[http://www.libsdl.org/mailing-list.php|mailing lists]], for these types of remarks.
-Line 221:
+Line 204:
-The Related Enumerations section provides a list of enumerations specifically referenced by the structure or otherwise ''closely'' related to it.
+The Related Enumerations section provides a list of enumerations specifically referenced by the enumeration or otherwise ''closely'' related to it.  '''This section is very rarely used.'''
-Line 224:
+Line 207:
- * enumerations that are specifically referenced in the structure
 * enumerations that are indirectly referenced by but still closely related to the structure
  . ~-(ie: the enum is not a field type but its values are used to fill in a field as with [[SDL_EventType]] for the `type` field in many event structures)-~
+ * other enumerations that are specifically referenced in the enumeration (may never occur)
 * other enumerations that are indirectly referenced by or ''very'' closely related to the enumeration
  . ~-(ie: the enum is not used as a value but its values are used to fill in a value or they are different aspects of the same idea)-~
  . ~-This is very uncommon.-~
-Line 229:
+Line 213:
- * every enumeration that might be considered "related" to the structure or any other listed enumerations
+ * the primary enumeration on that page
 * every enumeration that might be considered "related" to the enumeration or any other listed enumerations
-Line 251:
+Line 236:
-||<( 30%>''If'' the structure is __a member of the [[SDL_Event]] union__||''Action'': Include [[SDL_EventType]] in this section of the page.||
-Line 255:
+Line 239:
-''Example'': [[SDL_Event]], [[SDL_Keysym]], [[SDL_WindowEvent]]
+''Example'': [[SDL_Keycode]], [[SDL_Scancode]]
-Line 262:
+Line 246:
-The Related Structures section provides a list of other structures (or unions) specifically referenced by the structure or otherwise ''closely'' related to it.
+The Related Structures section provides a list of structures (or unions) specifically referenced by the enumeration or otherwise ''closely'' related to it.
-Line 266:
+Line 250:
- * other structures that are specifically referenced in the structure
 * other structures that are indirectly referenced by but closely related to the structure
+ * structures that specifically reference the enumeration
 * structures that indirectly reference but are closely related to the enumeration
-Line 271:
+Line 255:
- * the primary structure on that page
-Line 298:
+Line 281:
-''Example'': [[SDL_Event]], [[SDL_Color]], [[SDL_HapticDirection]]



~-[[#ToC|Return to Table of Contents]]-~
<<BR>>
<<BR>>
<<Anchor(RFs)>>
=== Related Macros ===
{i} This is a custom section that should not be used except in the most specific circumstances.  
''Example'': [[SDL_version]]
The Related Macros section provides a list of functions specifically associated with that structure or otherwise ''closely'' related to it.
+''Example'': [[SDL_AudioFormat]], [[SDL_BlendMode]], [[SDL_PixelFormatEnum]]
-Line 317:
+Line 290:
-The Related Functions section provides a list of functions specifically associated with that structure or otherwise ''closely'' related to it.
 * In general, a "Related Function" is one that __uses the given structure__.
+The Related Functions section provides a list of functions specifically associated with that enumeration or otherwise ''closely'' related to it.
 * In general, a "Related Function" is one that __uses the given enumeration__.
-Line 321:
+Line 294:
- * functions that use or are otherwise very closely related to the structure
+ * functions that use or are otherwise very closely related to the enumeration
-Line 346:
+Line 319:
-''Example'': [[SDL_TextInputEvent]](), [[SDL_SysWMinfo]]()
+''Example'': [[SDL_AudioStatus]], [[SDL_HintPriority]], [[SDL_TextureAccess]]
-Line 354:
+Line 327:
+||<tablewidth="100%" ><<Color2(red,''Important!'')>><<BR>>See [[#hints|Hint Pages]] below for details on how this section is different for Hint pages.||
-Line 360:
+Line 334:
-[[CategoryStruct]], [[CategoryHeader]]
}}}
  . where `CategoryStruct` is the same for every structure page and `CategoryHeader` is structure-specific with `Header` varying based on the header file containing the structure (see below).

<<Color2(red,''Important!'')>> Category names do not always match the header file name.  Please consult the following [[#CategoryTable|table]] for the correct name to use so the structure will appear in the correct list(s).

''Action 1'': '''Do not edit the `CategoryStruct` link!'''
+[[CategoryEnum]], [[CategoryHeader]]
}}}
  . where `CategoryEnum` is the same for every enumeration page and `CategoryHeader` is enumeration-specific with `Header` varying based on the header file containing the enumeration (see below).

<<Color2(red,''Important!'')>> Category names do not always match the header file name.  Please consult the following [[#CategoryTable|table]] for the correct name to use so the enumeration will appear in the correct list(s).

''Action 1'': '''Do not edit the `CategoryEnum` link!'''
-Line 370:
+Line 344:
-''<<Color2(red,Important!)>>'' There are a few exceptions to this rule (pages with a category name that does not match their header file).  These have been determined by the SDL team.  Please do not change an existing page's category name simply because it does not match its header file.  If you are concerned that a name is incorrect please submit ''Feedback'' from that page or contact us at <<MailTo(ANTI SPAM wiki AT libsdl DOT org)>> to confirm the change first.
+''<<Color2(red,Important!)>>'' There are a few exceptions to this rule (pages with a category name that does not match their header file according to the table).  These have been determined by the SDL team.  Please do not change an existing page's category name simply because it does not match its header file.  If you are concerned that a name is incorrect please submit your concern in the [[http://forums.libsdl.org/|forums]] or [[http://www.libsdl.org/mailing-list.php|mailing lists]] or contact us at <<MailTo(ANTI SPAM wiki AT libsdl DOT org)>> to confirm the change first.
-Line 431:
+Line 405:
+#############################################################
-Line 433:
+Line 407:
-This section contains details for special formatting circumstances that are best described separately from the average structure page.  In general these guidelines should be used in conjunction with the above.

<<Anchor(callback)>>
==== Callback Functions ====
Although having a callback function associated with a structure is rare, it does occasionally occur.  Documenting this will affect two (2) sections of the structure's page - Data Fields and Remarks.

 . ''Note'': Because callback functions are so rare with structures most of the examples listed here will be on function pages.  This is for illustrative purposes only.  '''As of this writing the only callback associated with a structure is the audio callback, found with [[SDL_AudioSpec]].'''  Because of this rarity many of the guidelines below will not currently apply to a structure-based callback, but this is being written with the future possibilities in mind.

''Action 1'': '''Use the following formatting specifics in addition to those listed [[#Data Fields|above]] for the structure whenever a callback function is included on a structure page:'''

||||<bgcolor="#EDEDED">''Data Fields Section Formatting Details''||
||<( |3 30%>For the field that refers to the __callback__ function||''Action'': Use the following wording, modified as necessary, to describe the field:<<BR>>`the` `function` `to` `call` `<when``/``why>;` `see` `[[#Remarks|Remarks]]` `for` `details`<<BR>>where the text in `<>` is replaced with an appropriate description of when or why the callback would be called.||
||''Note'': This parameter is often named '''callback''' but may have other names.||
||''Example'': [[SDL_LogSetOutputFunction]](), [[SDL_AddEventWatch]](), [[SDL_CreateThread]](), [[SDL_SetAssertionHandler]]()||
||<( |4 30%>For the field that passes __user data__ to the callback||<<Anchor(UserData)>>''Action'': Use the following wording, modified as necessary, to describe the field:<<BR>>`a` `pointer` `that` `is` `passed` `to` `'''callback'''`<<BR>>where `callback` is replaced with the callback function field name (if necessary).||
||''Note'': In rare cases this may be a pointer to a pointer and should be described as such.||
||''Note'': This field is often named '''userdata''', but may have other names.  It is important to distinguish this field from other fields that are passed to the callback also, but that are not strictly carrying "user data", and from other fields that are unrelated to the callback function (such as '''samples''', '''channels''').  See below for details.||
||''Example'': [[SDL_AudioSpec]], [[SDL_LogSetOutputFunction]](), [[SDL_CreateThread]]()||
||<( |2 30%>For other fields __related to the callback__||''Action'': There may be other fields that are passed to the callback function but which are sufficiently different from the __[[#UserData|user data]]__ concept that the wording above does not really apply.  In these cases use a description that is appropriate.  Often it will still be appropriate to include the phrase `passed to` `'''callback'''` in these descriptions.||
||''Example'': [[SDL_AddTimer]](), [[SDL_SetTimer]]()||
||<( |2 30%>For additional data fields __''not'' related to the callback__||<<Anchor(notCallback)>>''Action'': Follow any applicable guidelines listed [[#Data Fields|above]]||
||''Example'': [[SDL_CreateThread]]()||

<<Anchor(prototype)>>
''Action 2'': '''Detail the syntax and parameters of the callback function in the Remarks section using the following __basic format__ with the changes listed in the table below:'''
   {{{{
The function prototype for '''callback''' is:
 {{{#!highlight cpp
callback syntax
}}}
 . where its parameters are:
 ||`callback parameter`||description||
 . optional return value info...
 . optional remarks or details...
}}}}
    . to display
The function prototype for '''callback''' is:
 {{{#!highlight cpp
callback syntax
}}}
 . where its parameters are:
 ||`callback parameter`||description||
 . optional return value info...
 . optional remarks or details...

||||<bgcolor="#EDEDED">''Remarks Section Formatting Details''||
||<( |2 30%>__Location__||''Action'': Generally the Remarks section is roughly organized in the same order as the data fields.  Callback details should be located in the appropriate region of the Remarks section or at the top if all other Remarks are less directly related to a particular data field.  But, logic should prevail in determining where to place this information if the Remarks section is large. The callback information should be prominent.||
||''Example'': [[SDL_CreateThread]](), [[SDL_AddEventWatch]](), [[SDL_SetAssertionHandler]]()||
||<( 30%>__Alignment__||''Action'': As shown in the [[#prototype|basic format]] above, only the first line should be left-justified.  Everything else related directly to the callback should be [[SGWikiBasics#Indenting|indented]] one level (or more) to indicate it's relationship to the callback as opposed to the structure.||
||<( |2 30%>''If'' the callback field is __not '''callback'''__||''Action'': Replace '''callback''' in the [[#prototype|basic format]] above with the data field name used in the structure to refer to the callback function.||
||''Example'': [[SDL_SetEventFilter]](), [[SDL_CreateThread]](), [[SDL_SetAssertionHandler]]()||
||<( 30%>For __"callback syntax"__ in the [[#prototype|basic format]] above||''Action'': Replace "callback syntax" with the callback function's syntax formatted the same as [[SGFunctions#Syntax|regular functions]].||
||<( |2 30%>''If'' the __callback function name__ requires any explanation||''Action'': Replace "where its parameters are:" in the [[#prototype|basic format]] above with the following:<<BR>>`where` `<CallbackName>` `is` `<some` `explanation>` `and` `its` `parameters` `are:`<<BR>>replacing `<CallbackName>` with the name of the callback function and `<some` `explanation>` with an explanation of the name (ie: your function name).||
||''Example'': [[SDL_AddEventWatch]]()||
||<( |4 30%>For __| `callback parameter` | description |__ in the [[#prototype|basic format]] above||''Action 1'': Duplicate the line from above for each parameter in the callback (ie: there should be 2 lines for 2 parameters).||
||''Action 2'': Replace "callback parameter" with the name of each callback function parameter using the same formatting instructions as [[SGFunctions#Syntax|regular functions]] '''''except''''' use {{{`monospace`}}} (surrounding backticks) rather than bold to highlight the parameter names in the first column.||
||''Action 3'': Replace "description" with an appropriate description of the callback's parameter. See the following for specific parameters.||
||''Example'': [[SDL_FilterEvents]](), [[SDL_LogSetOutputFunction]]()||
||<( |2 30%>For the __`userdata`__ parameter (or comparable)||''Action'': Use the following text (modified as necessary):<<BR>>`an` `application-``specific` `parameter` `saved` `as` '''`userdata`''' `in` `[[SDL_StructureName]]()`<<BR>>replacing '''userdata''' with the appropriate parameter name if necessary, and replacing `StructureName` with the name of the structure on the page.||
||''Example'': [[SDL_AddEventWatch]](), [[SDL_AddTimer]]()||
||<( |3 30%>''If'' the callback function's __return value__ is important||''Action 1'': Replace "optional return value info..." in the [[#prototype|basic format]] above with the relevant return value information.  Be sure to indent text one level as shown.||
||''Note'': Callback return value information may be omitted if it is not important.  It may be left-justified if it is discussed in the context of the structure rather than the callback itself.||
||''Example'': [[SDL_AudioSpec]], [[SDL_AddEventWatch]](), [[SDL_AddTimer]]()||
||<( |2 30%>''If'' there are __"optional remarks or details"__||''Action'': Replace "optional remarks or details..." in the [[#prototype|basic format]] above with any other relevant information about the callback function.  Be sure to indent text at least one level as shown.||
||''Example'': [[SDL_LogGetOutputFunction]](), [[SDL_LogSetOutputFunction]]()||


<<BR>>


==== Compatibility Structures ====
Compatibility Structures are present in the API for backward compatibility only and thus are treated slightly differently than structures from the current version.  '''Use the following formatting specifics in addition to those listed above for all [[#CategoryCompat|CategoryCompat]] pages:''':

''Action 1'': The top of every compatibility structure page should include the following, verbatim, to be placed below the pragma markup, below <<Color2(red,DRAFT)>> if present, and above the page title:
 {{{
||<tablewidth="100%" #000000 style="color: #FF8C00;" :> <<BR>>~+For Backward Compatibility Only+~<<BR>><<BR>> ||
}}}

''Action 2'': 
 ||<( 30%>''If'' __only one SDL 1.3 structure__ replaces the compatibility structure||''Action'': See ''Markup A'' below.||
 ||<( |2 30%>''If'' __more than one SDL 1.3 structure__ has replaced the compatibility structure||''Action'': See ''Markup B'' below.||
 ||''Note'': This should occur only very rarely, if at all.  Please avoid making the list any larger than necessary.  This is NOT a related structures list!||
 ||<( 30%>''If'' there are __no equivalent structures__ in SDL 1.3||''Action'': See ''Markup C'' below.||
 ||||''Example'': [[SDL_ActiveEvent]], [[SDL_Overlay]], [[SDL_VideoInfo]]||
<<BR>>
 . ''Markup A'': Add the following section to the end of the page above the footer.  Replace `SDL_Structure` with the name of the appropriate SDL 1.3 structure:
+This section contains details for special formatting circumstances that are best described separately from the average enumeration page.  In general these guidelines should be used in conjunction with the above.

<<Anchor(hints)>>
==== Hint Pages ====
In some cases Hints are formatted slightly differently than enumerations.  '''Use the following formatting specifics in addition to those listed above for all [[CategoryHints|CategoryHints]] pages:''':

''Action 1'': All Hint pages contain an additional section not present on enumeration pages - Default

''Markup'': Add the following section to all `CategoryHints` pages between the Values and Code Examples sections.
-Line 520:
+Line 417:
-== SDL 1.3 Replacement(s) ==
||<tablewidth="100%" #000000 style="color: #FF8C00;">'''This structure has been replaced by the following in SDL 1.3:  [[SDL_Structure]]'''||
}}}
<<BR>>
 . ''Markup B'': Add the following section to the end of the page above the footer.  Create a list of structures by repeating the `[[SDL_Structure]]` markup, separating each member of the list with a comma, and placing the most direct counterpart first, alphabetizing any additional structures after that.
  {{{
== SDL 1.3 Replacement(s) ==
||<tablewidth="100%" #000000 style="color: #FF8C00;">'''This structure has been replaced by the following in SDL 1.3:  [[SDL_Structure]], [[SDL_Structure]]'''||
}}}
<<BR>>
 . ''Markup C'': Add the following section to the end of the page above the footer.  Replace `Other options here` with text describing other options in SDL 1.3 that could be used to accomplish the same goal, or remove it if there is no applicable text:
  {{{
== SDL 1.3 Replacement(s) ==
||<tablewidth="100%" #000000 style="color: #FF8C00;">'''There are currently no equivalent structures in SDL 1.3.'''||
Other options here
}}}

''Example'': See other [[CategoryCompat]] pages for examples
##Specific examples need to be added in this section, but at this time it is unclear which will serve as the best examples so specifics are being left out at present.
##Alternate text if it's worded better:  This is deprecated in favor of [[SDL_Structure]].  This is only for backward compatibility.
+== Default ==
}}}
 . ''Action'': Immediately under this section include at least one sentence beginning with the following, and describing the default state, if any, for that hint:
  `By default...`

''Example'': [[SDL_HINT_FRAMEBUFFER_ACCELERATION]], [[SDL_HINT_RENDER_SCALE_QUALITY]]


''Action 2'': The [[#Footer|Footer]] section of a Hint page follows the same guidelines as for an enumeration page with the following differences:
 . Use {{{[[CategoryDefine]], [[CategoryHints]]}}} as the link pair at the bottom instead.
 . The table above is irrelevant to this section since they are all the same.

''Note'': To date there are no Related Enumerations, Related Structures, or Related Functions listed on any Hint page.  Should there be, follow the same general guidelines as for enumerations.

Wiki Navigation

Wiki Page Content

Style Guide: Enumerations Pages

General Guidelines

Getting Started

Editing Specific Sections

Title

Description

Table of Contents

Values

Code Examples

Remarks

Related Enumerations

Related Structures

Related Functions

Footer

Special

Hint Pages

Resources

Disclaimer