Documentation

One way to contribute to the XBMC Project is to help us write good documentation.

The Online Manual was created in order to consolidate the vast amounts of information acquired in the wiki over the years. Although it was spawned by the visions of a few, it came into being and will continue to be updated through the efforts of many. Feel free to contribute in any way that you can. If something is missing -add it. If something is documented wrongly -fix it. XBMC always has and always will be a community effort, and its documentation should exist along those same lines. The manual was written using the default skin, Project Mayhem III, and uses the default keymapping for consistency.
Users who can produce high quality content and want to improve the wiki, can ask Pike on freenode for Ninja status (this is currently the only way to edit or add content to the wiki)

Tips for writing documents

Listed below are a few standards for writing/editing pages on the wiki:

  • Use Project Mayhem III for Screenshots
  • Use page sections
  • If you are writing a HOW-TO, please prefix the article with HOWTO:. (ie. HOWTO: SMB Shares)
  • If you are doing a non-English translation for an article, please prefix with the name of the language in English. (ie. French: About XBMC).
  • The standard for screenshots is thumbnailed to 360 pixel width. Add |360px to your image tag to implement.
  • Do not add images over 800x600 to a page
  • If you post XML code, embed it using <xml> </xml> tags please!

Tasks to Consider

You may also want to consider doing one of the following things, to help improve the quality and availability of XBMC's documentation:

  • Convert wiki into an 'offline' format such as DocBook, PDF or Word Document
  • Proofread for grammar and spelling mistakes and make the appropriate corrections
  • Translate the documentation into another language (currently its only available in English)

ยป Go to the Wiki

since 2003
SourceForge Powered
Proud member of