Skip to:
Content
Pages
Categories
Search
Top
Bottom

Codex Standards & Guidelines

Codex HomeParticipate & Contribute → Codex Standards & Guidelines

Contributing to the Codex

If you are considering contributing to the codex this simple guide is here to help you with the formatting of pages and standards & conventions to follow to keep a set appearance to pages.

The Codex is curated by the bbPress community if you are unsure about the status of an article head over to the forums and post a topic and add the topic tag codex, if you want to follow along with the codex development discussions you can visit this link or subscribe to the codex RSS feed.

Please note: All entries to the Codex are covered by the GNU General Public Licence. All entries may be edited or altered by other contributors.

How to Create a New Codex Article

  1. Log in using your WordPress username and password.
  2. Click on the “Create New Page” link in the sidebar.
  3. You can also copy the example template layout from this template to get started quicker.
  4. Add the Title of your article.
  5. Add the article metas: Versions, Components, Types and Context. Meta boxes are located on the screen’s right sidebar. Note, try to keep these as generalised as possible for example, setting the version to ‘2.5’ is preseumed to include 2.5 and all incremental version such as 2.5.1, 2.5.2, etc.
  6. Add your article in the appropriate codex section in the Page Attributes meta box under the Context box. If you are unsure where you should add your article head over the handbook Table of Contents for a guide or head over to the forums and create a topic with the codex topic tag and we will try to work out the best place for your article.
  7. Add content of your article. Check that it follows the Codex General Guidelines, Codex Conventions, and Formatting guides posted below for your reference.
  8. After you’re done, click on the “Publish” button.

How to Edit/Update an Article in the Codex

  1. Log in using your WordPress username and password.
  2. Navigate to the page you want to edit/update.
  3. Click on the “Edit This Page” link in the sidebar.
  4. After you have made the edit/update, please double-check that the Versions, Components, Types and Context are correct and updated as well, again try to keep these broadly focused so they are easily discovered.
  5. Click on the “Update” button in the Publish meta box.

General Guidelines

Broad guidelines on writing for the bbPress Codex

Codex Conventions

Formatting Guide

If writing a technical guide please use the template format provided in this draft document ( copy paste to new page ) Codex template – technical examples layout

1. Heading Tags:

When you use h2 as a heading tag a section in the contents sidebar and link will be automatically created for you. Use h3 – h6 for sub headings of sections under the h2’s.

2. Code examples: Surround your code with the appropriate shortcodes

[php] your PHP code [/php]
[html] your HTML code [/html]
Also available are bash, shell, css, diff, patch, js, javascript, plain, text, sql and xml and are used in the same format as the previous examples.
When adding code examples please escape angle brackets < > with Numeric/Decimal entities rather than ‘Named ones, so use < and  >.

3. Lists: Use unordered, ordered and delimited lists where appropriate.

4. File names: Surround file names with the code tags

<code>index.php</code>

5. The structure of a technical guide

[Intro]
a brief intro to the guide
[/Intro][Functions]
List the functions, location, params etc.
[/Functions]

[Your Content]
The content body – explanation/guide.
[/Your content]

[Example Usage]
Provide a simple example of code use – using pre/code tags.
[/Example Usage]

[Additional Resources]
Add any links to off site or internal pages that might help further.
[/Additional Resources]

Flagging articles – adding article header messages

Page may be tagged in the body with two ‘Notes’

1/ This page is a legacy document, at top of page, example, if a page is deemed to be outdated or superseded by bbPress versions, or changes then it may be marked with this code block and the page would be re-assigned under the parent section ‘legacy’


<p style="background: #8dc770;border: 1px solid #328C00;padding: 5px;color: #fff">This is Legacy Document, the details in this page have either been updated or are deprecated completely. Legacy Docs are retained for historic reference</p>

2/ This page is in need of updating

A page is considered incomplete or needs to be verified for detail.


<p style="background: #8dc770;border: 1px solid #328C00;padding: 5px;color: #fff">This page is incomplete or needs checking and verifying.<p>
Skip to toolbar