History of Documentation
''__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 [http://www.bitweaver.org/index.php?content_id=837|here].''
!Bitweaver Overview
*[http://www.bitweaver.org/wiki/index.php?page=WhybitweaverIsCool|About Bitweaver]
+[http://www.bitweaver.org/wiki/index.php?page=bitweaverOverview|Bitweaver Overview]
+[http://www.bitweaver.org/wiki/index.php?page=bitweaver|Bitweaver Framework]
+[http://www.bitweaver.org/wiki/bitweaverArchitecture|Bitweaver Architecture]
+(''Note: can the above be combined and condensed?'')
*[http://www.bitweaver.org/wiki/bitweaverPackage|Package Architecture]
*[http://www.bitweaver.org/wiki/index.php?page=bitweaverFeatures|Packages]
+(''NOTE: would be nice to maybe break this up into Included Packages and Optional Packages and other, maybe Underdevelopment Packages'')
*[http://www.bitweaver.org/wiki/bitweaverFAQ|Bitweaver FAQs]
!Installation and Configuration
*[http://www.bitweaver.org/wiki/bitweaverRequirements|System Requirements]
*[http://www.bitweaver.org/wiki/InstallbitweaverDoc|Installing Bitweaver] - [http://www.bitweaver.org/wiki/InstallUnderSafeMode|Install Under Safe Mode]
*[http://sourceforge.net/project/showfiles.php?group_id=141358&release_id=336854|Download]
+(''NOTE: create localized download page if possible instead of redirect to Source Forge'')
*[http://www.bitweaver.org/wiki/bitweaverUpgrade|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: [http://www.bitweaver.org/wiki/KernelPackage|Kernel] and [http://www.bitweaver.org/wiki/LibertyPackage|Liberty]
*[http://www.bitweaver.org/index.php?structure_id=37|Class Structure]
*Database Tables
*API Documentation
**[http://www.bitweaver.org/doc/php/|PHPDoc]
**[http://www.bitweaver.org/doc/dox/|doxygen]
**Kernel APIs
**Liberty APIs
**Basic Package APIs (Store Expunge List etc)
*[http://www.bitweaver.org/wiki/SamplePackage|Sample Package]
!!Tutorials
Creating a Package
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
!!Contributing
*Road Map
*[http://www.bitweaver.org/index.php?structure_id=24|Get The Code]
*[http://www.bitweaver.org/index.php?structure_id=67|Getting Started With CVS]
*[http://www.bitweaver.org/wiki/WhoWhatWhy|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.'')
*[http://www.bitweaver.org/wiki/CodingGuidelines|Coding Guidelines]
*[http://www.bitweaver.org/wiki/ReleaseProcess|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
*[http://www.bitweaver.org/wiki/index.php?page=ConnectingToIrc|Join Us On IRC]
*[http://www.bitweaver.org/wiki/MailingLists|Bitweaver Mailing Lists]
*[http://www.bitweaver.org/forums/index.php|Forums]
!For Administrators and Designers
!!BW Features
Overview
Included Packages
Optional Packages
Plugins
Administration
User Management
- all other feature documentation happens on package pages
!!Installing
Requirements
Download (Do NOT redirect to SourceForge)
Upgrade
Install
- include mention of files need to create if not installing from CVS
Configure (maybe?)
[http://www.bitweaver.org/index.php?structure_id=92|Troubleshooting]
!!Customizing Graphics (Themes)
Overview
CSS & XHTML
Smarty
The Themes Directory
Per Package Rules (if any)
Package A
Package B
Included Themes
Download Themes
Tutorials (same as below)
*[http://www.bitweaver.org/wiki/bitweaver_sites|Live Sites Using Bitweaver]
!!Tutorials
!!FAQ
- list questions up top and then provide explanations.
!!Support
*[http://www.bitweaver.org/wiki/index.php?page=ConnectingToIrc|Join Us On IRC]
*[http://www.bitweaver.org/wiki/MailingLists|Bitweaver Mailing Lists]
*[http://www.bitweaver.org/forums/index.php|Forums]
!Bitweaver Overview
*[http://www.bitweaver.org/wiki/index.php?page=WhybitweaverIsCool|About Bitweaver]
+[http://www.bitweaver.org/wiki/index.php?page=bitweaverOverview|Bitweaver Overview]
+[http://www.bitweaver.org/wiki/index.php?page=bitweaver|Bitweaver Framework]
+[http://www.bitweaver.org/wiki/bitweaverArchitecture|Bitweaver Architecture]
+(''Note: can the above be combined and condensed?'')
*[http://www.bitweaver.org/wiki/bitweaverPackage|Package Architecture]
*[http://www.bitweaver.org/wiki/index.php?page=bitweaverFeatures|Packages]
+(''NOTE: would be nice to maybe break this up into Included Packages and Optional Packages and other, maybe Underdevelopment Packages'')
*[http://www.bitweaver.org/wiki/bitweaverFAQ|Bitweaver FAQs]
!Installation and Configuration
*[http://www.bitweaver.org/wiki/bitweaverRequirements|System Requirements]
*[http://www.bitweaver.org/wiki/InstallbitweaverDoc|Installing Bitweaver] - [http://www.bitweaver.org/wiki/InstallUnderSafeMode|Install Under Safe Mode]
*[http://sourceforge.net/project/showfiles.php?group_id=141358&release_id=336854|Download]
+(''NOTE: create localized download page if possible instead of redirect to Source Forge'')
*[http://www.bitweaver.org/wiki/bitweaverUpgrade|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: [http://www.bitweaver.org/wiki/KernelPackage|Kernel] and [http://www.bitweaver.org/wiki/LibertyPackage|Liberty]
*[http://www.bitweaver.org/index.php?structure_id=37|Class Structure]
*Database Tables
*API Documentation
**[http://www.bitweaver.org/doc/php/|PHPDoc]
**[http://www.bitweaver.org/doc/dox/|doxygen]
**Kernel APIs
**Liberty APIs
**Basic Package APIs (Store Expunge List etc)
*[http://www.bitweaver.org/wiki/SamplePackage|Sample Package]
!!Tutorials
Creating a Package
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
!!Contributing
*Road Map
*[http://www.bitweaver.org/index.php?structure_id=24|Get The Code]
*[http://www.bitweaver.org/index.php?structure_id=67|Getting Started With CVS]
*[http://www.bitweaver.org/wiki/WhoWhatWhy|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.'')
*[http://www.bitweaver.org/wiki/CodingGuidelines|Coding Guidelines]
*[http://www.bitweaver.org/wiki/ReleaseProcess|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
*[http://www.bitweaver.org/wiki/index.php?page=ConnectingToIrc|Join Us On IRC]
*[http://www.bitweaver.org/wiki/MailingLists|Bitweaver Mailing Lists]
*[http://www.bitweaver.org/forums/index.php|Forums]
!For Administrators and Designers
!!BW Features
Overview
Included Packages
Optional Packages
Plugins
Administration
User Management
- all other feature documentation happens on package pages
!!Installing
Requirements
Download (Do NOT redirect to SourceForge)
Upgrade
Install
- include mention of files need to create if not installing from CVS
Configure (maybe?)
[http://www.bitweaver.org/index.php?structure_id=92|Troubleshooting]
!!Customizing Graphics (Themes)
Overview
CSS & XHTML
Smarty
The Themes Directory
Per Package Rules (if any)
Package A
Package B
Included Themes
Download Themes
Tutorials (same as below)
*[http://www.bitweaver.org/wiki/bitweaver_sites|Live Sites Using Bitweaver]
!!Tutorials
!!FAQ
- list questions up top and then provide explanations.
!!Support
*[http://www.bitweaver.org/wiki/index.php?page=ConnectingToIrc|Join Us On IRC]
*[http://www.bitweaver.org/wiki/MailingLists|Bitweaver Mailing Lists]
*[http://www.bitweaver.org/forums/index.php|Forums]