Wiki Page Content

Revision 7 as of 2011-09-29 05:11:54

Clear message

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

  1. Style Guide: Structure Pages
    1. General Guidelines
    2. Editing Specific Sections
      1. Title
      2. Description
      3. Table of Contents
      4. Data Fields

General Guidelines

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

red


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

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

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

Return to Table of Contents

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.
Please don't just make the word bold every time it occurs on the page.

Return to Table of Contents

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

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: 

||type1||'''field1'''||description||
||type2*||'''field2'''||description||
||[[type3]]||'''field3'''||description||
...
||typeN||'''fieldN'''||description||

Markup: Use basic table markup and enclose each field name in bold markup.

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

    • 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_Surface, SDL_JoyButtonEvent, SDL_Palette, SDL_HapticCondition

General (whole table)

If another API page is referenced

Action: Be sure to hyperlink it and use () outside the link markup if it is a function.

Example: SDL_Event, SDL_AudioSpec

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
<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_HapticConstant, SDL_HapticRamp

If the field is for internal use, deprecated, unused, or read-only

Action: In addition to the notation (ie: deprecated), 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 should be included within the same set of angle brackets (<>) and separated from this markup by a space.

Example: ||<rowstyle="color: #808080;">||type||'''field'''||description||, SDL_Palette, SDL_Color

First Column (type)

If there is a pointer associated with the field

Action: Place the pointer symbol(s) at the end of the type with no space between.

Example: ||type*||..., SDL_Surface, SDL_assert_data

If

Action:

Example:

Second Column (field)

Third Column (description)

If a field references another field on that same page

Action: Use 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.
Please don't just make the word bold every time it occurs on the page.

Example: SDL_AudioCVT()

large remarks SDL_RendererInfo

(Page Info.)
Feedback
Please include your contact information if you'd like to receive a reply.
Submit