Ogre Head
Ogre Wiki - The Grand Overview

About the Ogre Wiki and how it's organised.

Introduction

This page tries to explain what this wiki is, how it's organised and the thought behind it.

Motivation

The MediaWiki powered Ogre Wiki is a great resource, but it suffers from several problems:

  • The information is hard to find: pages get lost and its not easy to get an overview.
  • The information therein is not kept up to date.


Wouldn't it be nice to have a structured wiki instead?
Where each and every page is part of a hierarchy?

There's a lot of quality content in our wiki, so why not take maximum advantage of that wealth of information?

And, in the end, make it easier to update and even extend that resource?

The new Ogre Wiki tries to satisfy those questions.

Structure

The best answer to disorder is order.smile

Picture a room full of randomly arranged books, and imagine trying to find the information you need.
You realise that you spend an inordinate amount of time trying to keep them organised - and one day you become fed up with it.
After much thought, you decide to get six bookshelves to help you organise them.
That would serve as the first, and most important, step towards a total overview.

The Main Sections

The wiki is divided into 6 sections: 'Tutorials', 'Cookbook', 'Libraries', 'Tools', 'Development' and 'Community'.

Those are - under the hood - ordered, hierarchical structures, where each page is either a child, parent or both.

A birds eye view of the sections and what's in them:

1) Tutorials

  • Basic Tutorials
  • Intermediate Tutorials
  • In-Depth Tutorials
  • External Tutorials
  • Older Tutorials
2) Cookbook
  • Codebank
  • Snippets
  • Experiences
  • Articles
3) Libraries
  • Libraries
  • Assembling a Toolset
  • Alternative Languages
4) Tools
  • Tools
    • Exporters
  • DCC Tutorials
  • DCC Articles
  • DCC Resources
5) Development
  • Roadmap
  • Building Ogre
  • Installing An SDK
  • Setting Up An Application
  • FAQs
  • Summer of Code
  • Core Ogre Articles
6) Community
  • Project Using Ogre
  • Contractors
  • Recommended Reading
  • Wiki

Tutorials

This is where the 'official' tutorials live.
This structure is divided into 5 sections:

  • Basic Tutorials
  • Intermediate Tutorials
  • In-Depth Tutorials
    Advanced Tutorials has been abandoned and merged in this section.
  • External Tutorials
    Links to tutorials hosted elsewhere.
  • Older Tutorials
    Those are tutorials which need a lot of attention to become current.
    Kept mainly due to historical reasons.

Any source code is in child pages of the tutorial page to which they belong.

tutorial overview page uses INCLUDE and the main section pages uses toc...

Cookbook

Snippets, tutorials, articles...

  • CodeBank
    WIP a quick way to submit smaller snippets.
  • Snippets
    Categorised wiki pages with code.
  • Experiences
    Series of 'Post-mortems' covering a wide range of real-world Ogre projects (Needs contributors!)
  • Ogre Articles
    Wiki pages *without* code goes here.

Libraries

Libraries goes here - everything which is not a tool.

  • Libs
    Addon Libraries - like NxOgre, SkyX, Hydrax, ...
  • Alternative Languages
    MOGRE, OgreDotNet, ...
  • Assembling A Toolset
    Overview of all the other libraries, besides Ogre, which you might need.

Tools

Exporters, tools, utilities - everything else but code.

  • DCC Tools
    Exporters, utilities, ...
  • DCC Tutorials
    Various tutorials related to content-creation, tools usage, etc.
  • DCC Articles
    Guides, etc. covering tools, arts, pipe-line, ...
  • DCC Resources
    List of resources related to tools, assets, ...
  • Assembling a Production Pipe-Line
    Overview of the things you might need to get assets into your Ogre projects.

Development

All things related to the development of Ogre goes here: roadmap, how to build Ogre, articles written by the Ogre Team, ...

  • Roadmap
  • Building Ogre
  • Installing the Ogre SDK
  • Setting Up An Application
  • Frequently Asked Questions
  • Google Summer Of Code
  • Help Requested
  • Ogre Core Articles

Community

'Wiki' is the main bulk of the Community section, but it also contains other, community related information.

  • Projects Using Ogre
    Games, tools, engines and frameworks powered by Ogre.
  • Recommended Reading
    List of literature recommended by the Ogre community.
  • Contractors
    List of people offering Ogre related services commercially.
  • Wiki
    Help, guides, to-do lists - the backstage area of this wiki.

The Hidden Sections

In addition to the main, visible sections above, there's several 'hidden' sections or - more accurate: structures in this wiki.

Ogre Lexicon

Ogre Lexicon is a information bank, glossary, vocabulary, you name it - of common terms associated with Ogre and what Ogre is associated with.
All pages in this structure must have names starting with a prepending dash!
See Ogre Wiki Use Cases for instructions on how to add Ogre Lexicon entries.

Templates

This is where you put all the templates for use in the rest of the wiki.
Equivalent to the Template namespace in the old MediaWiki powered wiki.

Users

All user pages should go in this structure.

Talks

This is the old Talks pages.
There's still some good stuff in it, although it's obsoleted by the fact that each page bears a Comments section.
Unlike Talks, the comments are signed by the submitter and there's date and threaded layout as well.
And they're on the page in question.

Sandbox

This is the 'anything-goes' structure.
Use it to train yourself, try out ideas, and keep works in progress.
Ask a WikiAdmin to move, delete or help out if need be.

How does a wikiadmin move a page?

  • Go to the structure edit page by clicking the structure edit icon (treelike picture) in the structure nav header.
  • Find the page and click the delete icon (red cross).
  • Remove only from structure. (Important!)
  • Confirm your action.
  • While still on the structure edit page, find the page where you want your new page to be a child of, and click the View button (magnifier image).
  • When you're viewing the page in question, enter the name of the page you deleted from the structure into the Add Page text field and check the 'Child' box, just like you would add a new child page.
  • If the page exists - which we know it does - it will be added as a child of the page.

The Main Decisions

A structured wiki comes at a price: You can't just create a page and start writing.
You need to think about where to put the page first.

Therefore some decisions has been made.

All pages must belong to a structure

All pages, except the Main page and the Sandbox belongs to a structure.

That means that to add a page, you need to first navigate to the place where you want the page to be put.

New pages should be added from the structure header 'Add Page' textbox, not by clicking a yet-to-be-created wiki link.

Although the 'stray' page can be added to a structure after it's creation, it's far easier to do it right from the onset.

Benefits:

Drawbacks:

Ogre Lexicon page names are prepended with a dash

To avoid name clashing with regular wiki pages, all pages in the Ogre Lexicon must be created from the Ogre Lexicon structure, and their name must be prepended by as dash.
For instance, to add a new Ogre Lexicon entry for 'Wiki', create a page called -Wiki.

In order to make a lexicon page turn up on the Ogre Lexicon table of contents, you need to categorise it as 'Lexicon' - when adding a new page to the Ogre Lexicon structure, the page will automatically inherit the 'Lexicon' category, otherwise use the 'Categorise' tool in the sidebar.

That means that Wiki and -Wiki refers to two different things: a regular wiki page and an Ogre Lexicon entry.
Use the LEX wiki-plugin - the Image button on the toolbar - to link to the -Wiki lexicon entry: {LEX()}Wiki{LEX}.

Benefits:

  • You don't have to worry about wiki page names and lexicon page names because they can never clash.
  • Links to the Ogre Lexicon looks different from regular links. What You See Is What You Get.
  • When hovering over the Ogre Lexicon links with your mouse pointer, a title will show the description of the page. Therefore you can stay on the page in question, if the description is enough to enlighten you. :-)
  • When reading a page with lots of Ogre Lexicon links, you will not get too distracted, because the links are styled to be less intrusive.


Drawbacks:

  • A bit more work is involved.


Where To Put It

This wiki has been carefully organised to ensure a logical and intuitive structure, but even so, some things are not easily categorised and could belong in more than one section.

Pages

Files and Images

Features

Productivity

Overview

Nothing Gets Lost

Hot Out Of The Oven

The Ogre Wiki Tracker

The Codebank

The Ogre Lexicon

Plusses And Minuses

More Power More Responsibility

The Inevitable Tiki Versus MediaWiki

Let's put it this way:

Where MediaWiki is C, Tiki is C++.

That sums it up nicely.

To elaborate a bit, let's look at the differences:
Categories Tags
HTML CSS
Speciality Versatility

Tiki Contributions

phpBB Authentication

Plugin TRANSCLUDE

Plugin Toc Improvement

Alternative Center Tag

Ogre Wiki Specifics

Plugin LEX

Plugin WIKIPEDIA

Plugin CUT

Custom Structure Administration Templates

Conclusion

What Now?

Use Cases

Ogre Wiki Use Cases

<HR>
Creative Commons Copyright -- Some rights reserved.


THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED.

BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS.

1. Definitions

  • "Collective Work" means a work, such as a periodical issue, anthology or encyclopedia, in which the Work in its entirety in unmodified form, along with a number of other contributions, constituting separate and independent works in themselves, are assembled into a collective whole. A work that constitutes a Collective Work will not be considered a Derivative Work (as defined below) for the purposes of this License.
  • "Derivative Work" means a work based upon the Work or upon the Work and other pre-existing works, such as a translation, musical arrangement, dramatization, fictionalization, motion picture version, sound recording, art reproduction, abridgment, condensation, or any other form in which the Work may be recast, transformed, or adapted, except that a work that constitutes a Collective Work will not be considered a Derivative Work for the purpose of this License. For the avoidance of doubt, where the Work is a musical composition or sound recording, the synchronization of the Work in timed-relation with a moving image ("synching") will be considered a Derivative Work for the purpose of this License.
  • "Licensor" means the individual or entity that offers the Work under the terms of this License.
  • "Original Author" means the individual or entity who created the Work.
  • "Work" means the copyrightable work of authorship offered under the terms of this License.
  • "You" means an individual or entity exercising rights under this License who has not previously violated the terms of this License with respect to the Work, or who has received express permission from the Licensor to exercise rights under this License despite a previous violation.
  • "License Elements" means the following high-level license attributes as selected by Licensor and indicated in the title of this License: Attribution, ShareAlike.

2. Fair Use Rights

Nothing in this license is intended to reduce, limit, or restrict any rights arising from fair use, first sale or other limitations on the exclusive rights of the copyright owner under copyright law or other applicable laws.

3. License Grant

Subject to the terms and conditions of this License, Licensor hereby grants You a worldwide, royalty-free, non-exclusive, perpetual (for the duration of the applicable copyright) license to exercise the rights in the Work as stated below:

  • to reproduce the Work, to incorporate the Work into one or more Collective Works, and to reproduce the Work as incorporated in the Collective Works;
  • to create and reproduce Derivative Works;
  • to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission the Work including as incorporated in Collective Works;
  • to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission Derivative Works.
  • For the avoidance of doubt, where the work is a musical composition:
    • Performance Royalties Under Blanket Licenses. Licensor waives the exclusive right to collect, whether individually or via a performance rights society (e.g. ASCAP, BMI, SESAC), royalties for the public performance or public digital performance (e.g. webcast) of the Work.
    • Mechanical Rights and Statutory Royalties. Licensor waives the exclusive right to collect, whether individually or via a music rights society or designated agent (e.g. Harry Fox Agency), royalties for any phonorecord You create from the Work ("cover version") and distribute, subject to the compulsory license created by 17 USC Section 115 of the US Copyright Act (or the equivalent in other jurisdictions).
    • Webcasting Rights and Statutory Royalties. For the avoidance of doubt, where the Work is a sound recording, Licensor waives the exclusive right to collect, whether individually or via a performance-rights society (e.g. SoundExchange), royalties for the public digital performance (e.g. webcast) of the Work, subject to the compulsory license created by 17 USC Section 114 of the US Copyright Act (or the equivalent in other jurisdictions).


The above rights may be exercised in all media and formats whether now known or hereafter devised. The above rights include the right to make such modifications as are technically necessary to exercise the rights in other media and formats. All rights not expressly granted by Licensor are hereby reserved.

4. Restrictions

The license granted in Section 3 above is expressly made subject to and limited by the following restrictions:

  • You may distribute, publicly display, publicly perform, or publicly digitally perform the Work only under the terms of this License, and You must include a copy of, or the Uniform Resource Identifier for, this License with every copy or phonorecord of the Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Work that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder. You may not sublicense the Work. You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Work itself to be made subject to the terms of this License. If You create a Collective Work, upon notice from any Licensor You must, to the extent practicable, remove from the Collective Work any credit as required by clause 4(c), as requested. If You create a Derivative Work, upon notice from any Licensor You must, to the extent practicable, remove from the Derivative Work any credit as required by clause 4(c), as requested.
  • You may distribute, publicly display, publicly perform, or publicly digitally perform a Derivative Work only under the terms of this License, a later version of this License with the same License Elements as this License, or a Creative Commons iCommons license that contains the same License Elements as this License (e.g. Attribution-ShareAlike 2.5 Japan). You must include a copy of, or the Uniform Resource Identifier for, this License or other license specified in the previous sentence with every copy or phonorecord of each Derivative Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Derivative Works that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder, and You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Derivative Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Derivative Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Derivative Work itself to be made subject to the terms of this License.
  • If you distribute, publicly display, publicly perform, or publicly digitally perform the Work or any Derivative Works or Collective Works, You must keep intact all copyright notices for the Work and provide, reasonable to the medium or means You are utilizing: (i) the name of the Original Author (or pseudonym, if applicable) if supplied, and/or (ii) if the Original Author and/or Licensor designate another party or parties (e.g. a sponsor institute, publishing entity, journal) for attribution in Licensor's copyright notice, terms of service or by other reasonable means, the name of such party or parties; the title of the Work if supplied; to the extent reasonably practicable, the Uniform Resource Identifier, if any, that Licensor specifies to be associated with the Work, unless such URI does not refer to the copyright notice or licensing information for the Work; and in the case of a Derivative Work, a credit identifying the use of the Work in the Derivative Work (e.g., "French translation of the Work by Original Author," or "Screenplay based on original Work by Original Author"). Such credit may be implemented in any reasonable manner; provided, however, that in the case of a Derivative Work or Collective Work, at a minimum such credit will appear where any other comparable authorship credit appears and in a manner at least as prominent as such other comparable authorship credit.

5. Representations, Warranties and Disclaimer

UNLESS OTHERWISE AGREED TO BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE MATERIALS, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.

6. Limitation on Liability.

EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. Termination

  • This License and the rights granted hereunder will terminate automatically upon any breach by You of the terms of this License. Individuals or entities who have received Derivative Works or Collective Works from You under this License, however, will not have their licenses terminated provided such individuals or entities remain in full compliance with those licenses. Sections 1, 2, 5, 6, 7, and 8 will survive any termination of this License.
  • Subject to the above terms and conditions, the license granted here is perpetual (for the duration of the applicable copyright in the Work). Notwithstanding the above, Licensor reserves the right to release the Work under different license terms or to stop distributing the Work at any time; provided, however that any such election will not serve to withdraw this License (or any other license that has been, or is required to be, granted under the terms of this License), and this License will continue in full force and effect unless terminated as stated above.

8. Miscellaneous

  • Each time You distribute or publicly digitally perform the Work or a Collective Work, the Licensor offers to the recipient a license to the Work on the same terms and conditions as the license granted to You under this License.
  • Each time You distribute or publicly digitally perform a Derivative Work, Licensor offers to the recipient a license to the original Work on the same terms and conditions as the license granted to You under this License.
  • If any provision of this License is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this License, and without further action by the parties to this agreement, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
  • No term or provision of this License shall be deemed waived and no breach consented to unless such waiver or consent shall be in writing and signed by the party to be charged with such waiver or consent.
  • This License constitutes the entire agreement between the parties with respect to the Work licensed here. There are no understandings, agreements or representations with respect to the Work not specified here. Licensor shall not be bound by any additional provisions that may appear in any communication from You. This License may not be modified without the mutual written agreement of the Licensor and You.