From WxWiki
Jump to: navigation, search

A wiki is a website that can be edited by anyone; no knowledge of HTML and such is required. The wxWiki is currently using MediaWiki (anyone familiar with how Wikipedia works should already know how to use this wiki). If you need help navigating, reading, and searching the wxWiki, take a look at the MediaWiki Reader Handbook. If you need help editing any page of the wxWiki or just need reference for a specific feature of the page editor, see the MediaWiki Editor Handbook.

Editing Pages

You can start editing a page by clicking on the Edit link at the top of any page (with exception to the pages locked by the wxWiki administrators). You will see a page featuring a large text area where the text of the page is along with some markup. After modifying any of the information or adding new information in that text area, add a short description of what you changed in the Summary field. You should always preview any changes you make before clicking Save Page so you don't need to make multiple edits to a single page to fix mistakes.

Optionally, checking the "This is a minor edit" lets the wiki administrators, editors, and other readers know that your changes do not include any new information related to the article you are editing. Ideally, this is used when making spelling, code, or formatting corrections. Checking the "Watch this page" option (if you are logged in) will notify you of any future changes to the page you are editing in your watchlist.

Adding New Pages

Every page is identified by a unique string. To make a new page, you must first make a link to that page, by making some text with double brackets like this: [[My New Page Title]]. When you save this, the text will show up on the page as a red color link if the page doesn't already exist. Clicking on the link will open a new editor to start editing your new page that will look and work exactly the same as editing an existing page.

Additional wxWiki Features

The wxWiki supports additional wxWidgets specific features separate from the markup found in the MediaWiki Handbook.

Syntax Highlighting

The wiki supports a custom source highlighting extension to automatically link to wxWidgets classes, functions, and macros inside a block of source code:

Text Result
wxBitmap bitmap( 100, 100 );
wxMemoryDC dc;
panel = new wxPanel(m_book);
m_hsizer = new wxBoxSizer( wxHORIZONTAL );
wxBitmap bitmap( 100, 100 );
wxMemoryDC dc;
panel = new wxPanel(m_book);
m_hsizer = new wxBoxSizer( wxHORIZONTAL );

The <source></source> tags also support highlighting in other programming languages using the lang="" attribute. Specify lang="other" and hit preview to see other supported languages:

<source lang="other"></source>

Bugs & Suggestions

All bugs and feature requests should be submitted to the wxWidgets Trac.

Templates used in this wiki

See Template messages.


Feel free to practice and play with any and all features of the wxWiki in the Sandbox page. You can also find a lot of examples there.