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
- Configuring BuddyPress
- 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
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.
ubernaut 1:11 am on September 13, 2013 Permalink |
i like it i would say 2 things:
#1 we should try to make sure that section 2 of the landing/home page is above the fold get people who are looking for answers directly to the nitty gritty. i like the idea of a general overview just saying we should keep that as short as possible.
#2 i would suggestion some general hosting recommendations as well as best practices stuff like fighting spam in the all users section since those are some of the most common issues raised in the forums.
bonus: i think we should make sure to have a very clear tutorial or something relating to how the registration process works, seems like we get a lot of questions pertaining to that as well.
hnla 4:24 pm on September 18, 2013 Permalink |
#1 Those sectional links ought to be above the fold unless one has a very small screen.
#2 Personally I’m adverse to any particular recommendation for hosting however we could add some detail on best setups, server specs for a BP site.
#3 Yes we can add a page on registration process I’ll add as new page under ‘for all users > user guide’
ubernaut 4:25 pm on September 18, 2013 Permalink
RE; #2 yeah i wasn’t suggesting making specify host recommendations so much as general server spec guidelines.
hnla 10:04 am on September 25, 2013 Permalink |
Two new sections added for using BP with MS – under ‘for all user’ > ‘getting started’ & under ‘Developers’
Comments or thoughts on whether worthwhile? Partly prompted by existence of a guide to customizing xprofile fields on a per site basis already published and prompting comment request for feedback below this one.
hnla 10:13 am on September 25, 2013 Permalink |
Comments & feedback required on whether it’s thought a good idea to have ‘Tutorial / How To ‘ sections. Currently we have added Tutorial sections under each main top level sections – if we do run with user submitted tuts or code snippets these will need to be checked over first by an authorised set of devs before publishing to avoid any possible bad practise examples being published.
hnla 10:21 am on September 25, 2013 Permalink |
Codex Curation & Moderation:
Thoughts & feedback sought. Proposal is that Codex must be curated and moderated, we can follow two possible routes to achieving this , allow all aarticles/pages to be written and published by author and rely on retrospectively hoping we are aware of newly published articles so we can check them or we request that authors in the first instance save their work as ‘Draft’ for curators/editors to review and publish, therefater allowing author to continue with revisions or updates as they see fit.
Question: Can the codex email notify of newly drafted pages or published pages as a means of call to action to check over?
Paul Gibbs 11:25 am on September 25, 2013 Permalink |
I don’t like the idea of featuring legacy docs on the front page. It’s just clutter.
I don’t think there’s any point in having a MS section under Developers.
Codex needs to remain open for anyone to publish on without moderation. In terms of tracking new pages, how about we add Pages to the (unused) RSS feed?
hnla 1:23 pm on September 25, 2013 Permalink |
Yes agree on legacy docs/clutter, question is where do they neatly sit, guess under ‘Developer’ but equally don’t really want them under any of the three prime sections which is why placed them at top level.
The MS section under developers was more that there was an existing page written showing code examples of hacking xprofile to work on a per site basis, and wanted somewhere to place that, equally though it could go under the general tuts for developers but as for general page do we not think there are aspects of MS from a developers point of view that are unique to working in that mode?
Understand the view that Codex needs to be open, but equally do believe that a degree of curation must take place otherwise the codex could end up in the slight jumble it is now that we’re trying to audit. If RSS feed could work in that fashion then that might be a solution. One thing though to bear in mind that if one accepts that order has to be maintained to a degree, then a degree of moderation or curation will at times need to take place, exactly what form that takes is open to discussion and I’ve proposed and drafted(with no detail as yet) a codex guidelines page where we can set out a few do’s & don’t , codex standards etc.
hnla 9:01 am on October 1, 2013 Permalink |
Renaming ‘Tutorials’ to ‘HowTo’ to accommodate the number of shorter examples of how to achieve something and that are not quite tutorials, implying something of greater length & detail, for the moment this is just for the Developer section where this is more pertinent.
ubernaut 3:18 pm on October 1, 2013 Permalink |
that makes a lot of sense imo