| -''__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].''
|
| +{maketoc} |
| +! Bitweaver Overview |
| +*((Bitweaver Overview)) |
| +*((Bitweaver Features)) |
| +*((Bitweaver Framework)) |
| +*((bitweaverPackage|Package Architecture)) |
| +*((DatabaseComparison|Database Options)) |
| +*((bitweaverFAQ|Bitweaver FAQs)) |
| +*((Screenshots)) |
| +*((bitweaverGlossary|Glossary)) |
| +*[http://www.opensourcecms.com/index.php?option=com_content&task=view&id=2155&PHPSESSID=c7c8f321cab4f67b9dca147abcee97b3|Live Demo] |
| +*((New for R2|New Features in R2)) |
| +*((Top 10 reasons to use Bitweaver)) |
| +*((Use bitweaver to build a web site that is very nice)) |
|
|
| -!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/bitweaverRequirements|System Requirements]
|
| -*[http://www.bitweaver.org/wiki/InstallbitweaverDoc|Installing Bitweaver] - [http://www.bitweaver.org/wiki/InstallUnderSafeMode|Install Under Safe Mode]
|
| +! Installation and Configuration |
| +*((bitweaverRequirements|System Requirements)) |
| +*((InstallbitweaverDoc|How to install Bitweaver)) |
| +* [/downloads/file/15256|Video: Installation of Bitweaver] |
| *[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.'')
|
| +*((bitweaverUpgrade|Upgrading)) |
| +*((Groups and Permissions|Configuring Permissions)) |
| +*[http://www.bitweaver.org/index.php?structure_id=92|Troubleshooting] |
| +*[http://www.bitweaver.org/pigeonholes/view.php?structure_id=190#members|Optimization] |
| +*((Importing Content From Other CMS)) |
| +*((Top 10 things to do immediately after installing Bitweaver)) |
| +*((Top 10 mistakes after installing Bitweaver)) |
|
|
| +! For Administrators and Designers |
| +!! Administration |
| +*((Groups and Permissions|Permissions)) |
| +*((Security|Security)) |
| +*((Troubleshooting)) |
| +!!Theming |
| +*((Themes Package|Overview)) |
| +*((ThemeTutorial|Creating Your Own Theme)) |
| +*((CssSchema|Basic CSS Schema)) |
| +*((A beginners guide to CSS selectors)) |
| +*((IconThemes|Icon Themes)) |
| +*[http://smarty.php.net/|Smarty Template Documentation] |
| +*Bitweaver's Additional ((Smarty Functions)) |
| +*Included Themes |
| +*[/downloads/gallery/1916|Additional Themes] |
| +*((bitweaver_sites|Live Sites Using Bitweaver)) |
| +*[/forums/viewforum.php?f=15|Themes Forum] |
| +!!Support |
| +*((Support|How to find Support)) |
| +*[http://www.bitweaver.org/forums/index.php|Forums on bitweaver.org] |
| +*((ConnectingToIrc|Live Support (Chat))) |
|
|
| -!For Developers
|
| -!!Framework and Core Services
|
| -*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=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/index.php?structure_id=37|Class Structure]
|
| -*Database Tables
|
| -*APIs
|
| - Core Kernel and Liberty APIs
|
| - Basic Package APIs (Store Expunge List etc)
|
| - Comments
|
| - History
|
| - Security
|
| - Commerce (?)
|
| - (?)
|
| - phpDocumentor
|
| - Tutorials (same as below)
|
| -*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
|
| -*Road Map
|
| - Goals (call to action)
|
| - Kernel & Liberty
|
| - Packages
|
| - Transitioning from Tikiwiki
|
| - Progress Reports
|
| - Developer Blog Post Includes
|
| - Change Log (APIs and Schema)
|
| - Bounties
|
| - Documentation Project
|
| - BW Developer Columns/Blogs
|
| - Progress Reports
|
| - Forum
|
| - Report a Bug
|
| - Contributing
|
| - About CVS
|
| - Process
|
| -*Coding Standards
|
| -*Package Summaries
|
| -!!Join The Community
|
| -*[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 Developers |
|
|
| +!! Framework and Core Services |
| +*((Bitweaver Framework)) |
| +*((bitweaverPackage|Package Architecture)) |
| +*The Bitweaver Core: ((KernelPackage|Kernel)) and ((LibertyPackage|Liberty)) |
| +*((LibertyServices|Liberty Services)) |
| +*[/index.php?structure_id=37|Class Structure] |
| +*[/wiki/Groups+and+Permissions#DevelopingPackagesandPermissionsProgramm|Content and Group Permissions] |
| +*((SamplePackage|Sample Package)) |
| +*((SamplePackageDissection|Sample Package Dissection)) |
| +*((DataPlugins|Data Plugins)) |
| +*((AuthenticationPlugins|Authentication Plugins)) |
| +*[/pigeonholes/view.php?structure_id=186#members|Change Logs] |
| +*[http://www.bitweaver.org/doc/database/core.html|Core database tables] |
| +*[http://www.bitweaver.org/doc/database/core.jpg|Core database tables map] |
| +*[http://www.bitweaver.org/doc/database/bitweaver.html|Database tables in bitweaver] |
| +*[http://www.bitweaver.org/doc/database/bitweaver.jpg|Database tables in bitweaver map] |
| + |
| +!! API Documentation |
| +*((APIDocumentation|API Documentation Overview)) |
| +*[http://www.bitweaver.org/doc/php/|PHPDoc] |
| +*[http://www.bitweaver.org/doc/dox/|doxygen] |
| +*[http://www.bitweaver.org/cvs-repo/|CVS source browse] |
| +*[http://www.bitweaver.org/cvs-repo-search/|CVS source search] |
|
|
| -!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)
|
| !!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]
|
| +*((Tutorial_Custom_Package|Creating Your Own Package)) also see ((SamplePackageDissection)) |
| +*((IntegrationTutorial|Integrating Other Apps as a Package)) |
| +*((CreatingServices|Creating Services)) |
| +*((Tutorial - Liberty Plugins|Creating Your Own Data Plugin)) |
| +*((Pluggable Authentication Tutorial|Creating Your Own Authentication Plugin)) |
| +*((ThemeTutorial|Creating Your Own Theme)) |
| +*((bitweaverPerformance|Optimizing Performance)) |
| +*[/pigeonholes/view.php?structure_id=170#members|All Tutorials] |
| + |
| +!! Best Practices |
| +*((Table_vs_Div)) |
| +*((CreateTabbedPages)) |
| +*((TemplateOptimization)) |
| + |
| +!!Contributing |
| +*[http://www.bitweaver.org/index.php?structure_id=39|Road Map] |
| +*((GetCode|Get The Code)) |
| +*[http://www.bitweaver.org/index.php?structure_id=67|Getting Started With CVS] |
| +*((CodingGuidelines|Coding Guidelines)) |
| +*((ReleaseProcess|Release Process)) |
| +*((Documentation Project)) |
| +*((TranslationTutorial|Help translating)) |
| + |
| +!!Join The Community |
| +*((Developer Center)) |
| +*[http://www.bitweaver.org/forums/index.php|Forums] |
| +*((ConnectingToIrc|Join Us On IRC)) |
| +*((MailingLists|Bitweaver Mailing Lists)) |
| |