Wiki Page Content

Style Guide: New Pages

This guide provides instructions for adding new pages to this wiki.

Most of the pages in the SDL API already exist and will only require editing as time goes on. See the other Style Guides for details on editing existing pages. But, if you encounter a component of the API that should have a page in this wiki but does not, this guide is your starting point.

General Guidelines

This wiki contains the following page types:

  • API pages

    pages describing the various Hints, Enumerations, Structures, and Functions of SDL

    Category pages

    pages that list all parts of the API related to a specific topic, or category, and may contain some introductory discussion about the topic

    Tutorials

    pages that help people use SDL

    Administrative pages

    these include most of the other pages linked in the left sidebar, such as the FrontPage, Introduction, Support, and Contributing pages

red It is highly unlikely that you will be creating new Administrative pages. If you feel that something of this nature is warranted, or if you feel an Administrative page needs editing, please contact us at <ANTI SPAM wiki AT libsdl DOT org> or post about it in a Mailing List or Forum.

Action - Tutorials: Please see the Tutorials Style Guide if you wish to create a new Tutorial page.

Action - Other: At present, all of the categories (headers) that will have a Category page (see a list here) and all of the Hints, Enumerations, Structures, and Functions that will have an API page in this wiki have been created. However, since SDL is a dynamic entity, should it become necessary to create a new Category or API page, please follow the instructions in the remainder of this Style Guide.

Please only create a new Category or API page if you are certain that it does not already exist and that it fits with and will enhance this documentation.

  • Do not post anything that you do not have permission to post publicly.
  • Please remember to keep it accurate, simple, and easy to understand.
  • Please carefully follow the guidelines in this and the other Style Guides to ensure the continuing value and quality of this documentation.

Return to Table of Contents

Creating A New Page

The basic steps required to create a new page in this wiki are the same regardless of page type. If you have determined that it is necessary to create a new page, begin here and use the following guidelines as they apply to your page type:

Action 1: Create an address for the page.

  • How: Type the following into the address bar and replace PageName with the name of your page. Press Enter to begin creating the page.

    • http://wiki.libsdl.org/moin.cgi/PageName
    • Note: There are several ways to create a new page address. You may choose another method if you prefer.

    Note: The convention in this wiki is that the name of the page is also the address of the page and that CamelCase is preferable to blank spaces.
    Page addresses are case-sensitive.

    Example: The address for the page SDL_BuildAudioCVT() is

    • http://wiki.libsdl.org/moin.cgi/SDL_BuildAudioCVT

    red Be careful to name and spell accurately when creating a new page! You cannot delete a page or edit a page address after the page is created and saved.

    If you discover a typo in the address prior to saving the page

    Action: DO NOT SAVE THE PAGE! Copy any of your contents you'd like to save, blue or close the page, and start over.
    Paste your contents into the new page and continue editing.

    Note: Your old page and address will not be saved.

    If you discover a typo in the address after you saved the page

    Action: Send a message to <ANTI SPAM wiki AT libsdl DOT org> requesting a correction.

    Note: You will not be able to correct it yourself.

    Note: If you type in an address and land on an existing page then most likely you do not need to create a page but may need to edit the existing one instead. If a new page is still required you will need to select a different address.

Action 2: Choose the correct Template.

  • How: If you have chosen a unique address in Action 1 above then you will arrive at a page that has the following at the top followed by a table with 2 columns.

    • This page does not exist yet. You can create a new empty page, or use one of the page templates.

      blue

  • Use the following table to determine which template to select.

    If you need to create a new Category page

    Action: See Creating a Category Page below for further details

    If you need to create a new API page

    Action: See Creating an API page below for further details

    Note: When editing a new page the default method is the Text editor. If you prefer to use the GUI editor click blue in the left column to switch to the GUI editor on the new page.

    Note: For information on markup used in this wiki see SGWikiBasics.

Return to Table of Contents

Creating a Category Page

Action 1: Select blue in the LEFT column of the table.

Action 2: Follow the commented instructions (after ## at the beginning of a line) on the template page and use other Category pages as examples. There is no special Category Style Guide. Contact us if you need help or have questions.

Return to Table of Contents

Creating an API Page

Action 1: In the LEFT column of the table click on:

  • blue

    to create a page for an Enumeration or Hint

    blue

    to create a page for a Function

    blue

    to create a page for a Structure or Union

Action 2: There are some very basic instructions commented (after ## at the beginning of a line) into the 3 templates, but these will be inadequate in most cases. Depending upon the type of API page, see the appropriate Style Guide for further details.

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:

  1. Search for another page that contains something similar to what you want to do and copy all the basics as much as applicable.
  2. Check the other SDL Style Guides.

  3. Post a question to Feedback and include a way to contact you.

  4. Post a question to the Mailing List.

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

None: SGNewPages (last edited 2013-10-24 05:27:28 by Sam Lantinga)

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