BP Codex TOC Update

Revised Codex TOC Outline

This outline represents a revised version based in part from the feedback received from the recent codex survey. This revised version is subject to the comments and views of everyone and can be updated if sufficient comments concur on an aspect.

Introduction – Primary landing page

The actual codex landing page has been re-factored to follow this outline but can be changed.

Section 1: Intro

Introductory text- possibly stating the obvious? and could be removed?

Section 2: Main codex Areas – linking to parent page for sections.

  • For Regular Users
  • For Theme Builders
  • For Developers

Section 2: Contribute

Guidance on how people can get involved with the BP project – links to two pages ‘Codex formatting guide’ & general Participate & Contribute’ page with full BP project links

Section 3: Version list & changelogs

Links to full list of all BP version releases – updated to include links to zip downloads.

Section 4: Legacy docs – all docs prior to 1.7 are removed to this section

For All Users
Getting Started
  • Before Installing
    • System & Server Requiremets
    • Plugins > Add New
    • FTP/cpanel
    • Securing install – backups etc ( guide exists)
  • The installation process overview
  • BuddyPress Components and Features Overview
  • Using BuddyPress with WP MultiSite (guide to using BP with MS – how bp functions with subsites) new page

User Guide

  • Introduction (page parent, right hand sub page menu) –
    • Configuring BuddyPress
      • Settings > BuddyPress > Components
      • Settings > BuddyPress > Pages
      • Settings > BuddyPress > Settings
  • Managing Components
  • The registration process ( overview of reg process, email, activation, extending reg fields using xprofile fields) NP
    • Activity Stream Admin Panels
    • Group Management Admin Panel
  • Languages & translations, labels
  • Frequently Asked Questions
  • Tutorials(1)
  • For Theme Builders

    • Introduction (page parent, right hand sub page menu) – covers the essential principles for building sites / themes e.g. Standalone, working as child theme, clarifies bp-default/bp legacy.
    • BP Theme Compatibility 1.7 ( overview section )
      • intro to theme compat 1.7
      • The template hierarchy in detail
      • Upgrading template packed themes to theme compat
    • Building themes ( general pages covering actual approaches to theme building )
      • An overview on the various approaches one can take in managing BP templates/themes (N)
      • BP Default Child Theming
      • Working with BP Legacy -Theme Compatibility (N)
      • Building from theme compatibility templates in custom theme (N)
      • Building themes using Template Pack
      • BP Theme Unit Test – ala WP Theme Review Test – BP Default Theme and Twenty Twelve theme – @mercime already started this then stopped to create those BP Component Pages in Codex
      • Tutorials(1) ?

    For Developers

    • Introduction (page parent, right hand sub page menu)
      • Template Tags
      • Main BP loops, e.g. members loop, activity loop etc.
      • Functions list ?
      • Conditional Tags
      • Building and extending components, working with Queries.
        • Extending BP user account screens
        • Extending Group component
        • Working with the template stack / extending BP_Theme_Compat (N)
        • BP_User_Query (N)
      • Developing plugins for BuddyPress
      • Developing for BuddyPress & WP MultiSite
        • Guide to how BP functions with MS – intro page, new.
        • User Submitted Tutorials/code snippets –
      • Unit Tests
      • How To(1) – General ( collects series of shorter examples of how to do something e.g. ‘force ssl admin’)
      • develop.buddypress.org (PHPDocs)

    Feedback on this proposed structure, suggestions for improvement is welcome and hoped for.

    Snipped from the codex survey is this comment Please make something scalable that won’t be obsolete by the time 1.9 comes out! and is something we try and bear in mind moving forward. This codex structural revision needs to be something we can build on and that serves to clearly manage pages under a clear hierarchy that allows people to quickly find the information they are looking for, to that end w welcome comments and feedback on the nature of nesting pages under sections, are there too many? Are pages buried too deeply? based on the old paradigm that any web page should not be more than three or four clicks away how do we stack up on that score?

    With the developers section certain information such as references to ‘Actions’ will be provided by PHPDocs to be implemented for the Codex.