History of Documentation
Version 10
Documentation
References for novice and experience bitweaver users, administrators, and developers.
NOTE: This page is under development and should not be used as a guide yet to bitweaver documentation. For now the best gateway to bitweaver documentation is here.
Basic Package APIs (Store Expunge List etc)
Comments
History
Security
Commerce (?)
(?)
phpDocumentor
Schema
Basics: Store, Expunge, List etc
Commenting Your Code
Extending Content
Adding Comments
Adding History
Adding Permissions
Adding Search Indexing
Caching
Templates
Layout Components
Using Smarty
Dynamic Data
Loops
Custom Values
Custom HTML tag properties
Custom HEAD content
Plugins
Integrating Other Apps as a Package
- phpBB example
All Other Tutorials
Included Packages
Optional Packages
Plugins
Administration
User Management
- all other feature documentation happens on package pages
Download (Do NOT redirect to SourceForge)
Upgrade
Install
- include mention of files need to create if not installing from CVS
Configure (maybe?)
Troubleshooting
CSS & XHTML
Smarty
The Themes Directory
Per Package Rules (if any)
Package A
Package B
Included Themes
Download Themes
Tutorials (same as below)
Bitweaver Mailing Lists
Forums
Bitweaver Overview
- About Bitweaver
Bitweaver Overview
Bitweaver Framework
Bitweaver Architecture
(Note: can the above be combined and condensed?) - Package Architecture
- Packages
(NOTE: would be nice to maybe break this up into Included Packages and Optional Packages and other, maybe Underdevelopment Packages)
Installation and Configuration
- System Requirements
- Installing Bitweaver - Install Under Safe Mode
- Download
(NOTE: create localized download page if possible instead of redirect to Source Forge) - Upgrading
(NOTE: Is this relevant any more? Seems like this sort of thing should be in release notes for which ever version.)
For Developers
Framework and Core Services
- Framework Overview
- Package Summaries
- The Bitweaver Core: Kernel and Liberty
- Class Structure
- Database Tables
- APIs
Basic Package APIs (Store Expunge List etc)
Comments
History
Security
Commerce (?)
(?)
phpDocumentor
Tutorials
Creating a PackageSchema
Basics: Store, Expunge, List etc
Commenting Your Code
Extending Content
Adding Comments
Adding History
Adding Permissions
Adding Search Indexing
Caching
Templates
Layout Components
Using Smarty
Dynamic Data
Loops
Custom Values
Custom HTML tag properties
Custom HEAD content
Plugins
Integrating Other Apps as a Package
- phpBB example
All Other Tutorials
Contributing
- Road Map
- Get The Code
- Getting Started With CVS
- The Core Development Team
(NOTE: This who what why looks old, not well maintained. Might be nice to have profiles of key people, but should be maintained by someone, not left to the community. If someone can not keep up with it, then prolly has no use.) - Coding Guidelines
- Release Process
- Documentation Project
Developer Info (?)
- Progress Reports
- Change Log (APIs and Schema)
- Bounties
- BW Developer Columns/Blogs
- Bug Log
Join The Community
- Developer Portal
- Join Us On IRC
- Bitweaver Mailing Lists
- Forums
For Administrators and Designers
BW Features
OverviewIncluded Packages
Optional Packages
Plugins
Administration
User Management
- all other feature documentation happens on package pages
Installing
RequirementsDownload (Do NOT redirect to SourceForge)
Upgrade
Install
- include mention of files need to create if not installing from CVS
Configure (maybe?)
Troubleshooting
Customizing Graphics (Themes)
OverviewCSS & XHTML
Smarty
The Themes Directory
Per Package Rules (if any)
Package A
Package B
Included Themes
Download Themes
Tutorials (same as below)
Tutorials
FAQ
- list questions up top and then provide explanations.Support
Join Us On IRCBitweaver Mailing Lists
Forums