History of bitweaverFAQ

Differences from version 33 to 55



@@ -1,170 +1,160 @@

 To [/wiki/edit.php?page_id=478|edit this page] and add some wisdom please [/users/register.php|register]. ++#ffffcc:If you have a question, please [/forums/viewforum.php?f=5|ask in the support forum].++ Mention your [/wiki/bitweaverFAQ#HowdoIfindoutwhichversionofbitweaverIhav|version] of bitweaver and as much information as possible - operating system of your server, name and version of your database, client details like browser name/version, where'd you click, what's the error message and so forth ... __or__ you could just go ahead and [/forums/viewforum.php?f=5|ask] ;)
 
-{maketoc maxdepth=2 title="Frequently Asked Questions:" class=faqtoc}
+{backtotop min=2}
+{maketoc maxdepth=2 title="Frequently Asked Questions:"}
 
 ---
 
 ! Releases
 !! How do I get the latest stable version of bitweaver? (official release)
-((GetCode|Go to this page: GetCode)) and follow possibility 2 or 3.
+Please view the page ((GetCode)) for details.
 
-!! How do i get the latest and greatest of bitweaver? (beta release)
-you need access to CVS. to set up cvs and how to use it, please view:
+!! How do I get the latest and greatest of bitweaver? (beta release)
+you need access to CVS. To set up CVS and how to use it, please view:
 bitweaverCVS
 
-!! How can i get hold of packages that haven't been released yet?
-try accessing [/builds/packages] and see if the package is available for testing. if it's not available there, you can get it using cvs. for a list of available packages, you can check out CVSROOT and look in the modules file. with most packages, the cvs module name is _bit_<package> (e.g.: use _bit_wiki for the wiki)
+!! How can I get hold of packages that haven't been released yet?
+Try accessing [/builds/packages] and see if the package is available for testing. If it's not available there, you can get it using CVS. For a list of available packages, you can check out CVSROOT and look in the modules file. With most packages, the CVS module name is _bit_<package> (e.g.: use _bit_wiki for the wiki)
 
 !! What is happening in CVS? How stable is CVS?
-CSV branch R1 is considered stable and only bugfixes are going into R1. we have got a database schema as well as an api lockdown. This means that you can update using the cvs R1 branch without much concern. obviously, we're not miracle workers and we suggest you backup your file / database before upgrading (expecially after a prolonged period). for upgrade instructions, please view bitweaverUpgrade
+__CSV branch R1__ (versions 1.3 of Bitweaver) is stable, but not updated anymore. It's got a database schema and API lockdown. Also, there are known security problems with Bitweaver below version 2, depending on your specific packages/feature set. However, you can update using the CVS R1 branch without harming your install. Backup your files and database before. For detailed upgrade instructions, please view ((bitweaverUpgrade)).
+
+__CVS branch R2__ (versions 2 of Bitweaver) is also available. While many version 2 live sites are being updated directly from CVS (mainly the ones that the developers are running), you need to do extensive testing after an upgrade. An alternative to CVS are weekly builds in [http://bitweaver.org/builds]. It's an advantage to monitor changes via IRC, if you plan on running your site off CVS in the sense of frequently updating your code to the most recent.
+
+__Final releases__ (versions) are made from the code in CVS after extensive testing and debugging (unlike weekly builds). For the highest quality, this process of coding, testing, and releasing takes several months between versions of Bitweaver. See also [/articles/102|Help Wanted].
+
 
 ---
 
 ! Installs, Migrations and Upgrades
-!! How do i install bitweaver?
-first [http://sourceforge.net/project/showfiles.php?group_id=141358&release_id=336854|download bitweaver] from sourceforge and unpack it in a place of your choice. point your browser to install/install.php, and follow the on screen instructions. after installation, for security reasons we recommend that you set the permissions of your install dir to something that users cannot access it.
+!! How do I install bitweaver?
+[/downloads/gallery/15488|Download bitweaver] and unpack it in a place of your choice. Point your browser to install/install.php, and follow the on screen instructions. After installation, set the permissions of your install directory so that users cannot access it. To see what the installer does, before actually installing Bitweaver, [/downloads/file/15256|watch: Bitweaver Installation (Screencast)].
 
-!! What files should i take care of when upgrading?
-please view bitweaverUpgrade for details
+!! What files should I take care of when upgrading?
+Please view the page ((bitweaverUpgrade)) for details.
 
-!! How do i upgrade bitweaver to the latest version?
-please view bitweaverUpgrade for details
+!! How do I upgrade bitweaver to the latest version?
+Please view the page ((bitweaverUpgrade)) for details.
 
-!! I have just upgraded bitweaver to the latest version but i can't log in anymore
-since bitweaver is in constant developement, there might be changes to the way logins are handled.
-first off, try deleting the cookies in your browser.
-if the problem persists after clearing out the cookies, try removing the cookie related entries in ))tiki_preferences((:
+!! I have just upgraded bitweaver to the latest version but I can't log in anymore
+Since problem appears mostly when using Bitweaver version 1.3 and below. The reason were changes to the way logins were handled. First off, try deleting the cookies in your browser. If the problem persists after clearing out the cookies, try removing the cookie related entries in the table tiki_preferences:
 {code source=SQL title="Removing cookie related entries in the database"}
 DELETE FROM `tiki_preferences` WHERE `name` = 'cookie_domain' LIMIT 1
 DELETE FROM `tiki_preferences` WHERE `name` = 'cookie_path' LIMIT 1
 {/code}
 
-!! How do i convert my existing TikiWiki install to bitweaver?
-download and unpack bitweaver in a place of your choice. __make a backup of your database!!!__. Point your browser to install/install.php and follow the on screen instructions. when asked what path you want to follow, choose __upgrade__ and point your browser to the __backup database__ first to test if it works. if you are using MySQL, the __upgrade process requires at least version 4.1__. bitweaver will work on previous version of MySQL as well, but the upgrader requires it. if your host does not provide MySQL > 4.1, you need to upgrade on a server that does and then export / import the converted database onto your host server.
+!! How do I convert my existing ((TikiWiki)) install to bitweaver?
+[http://sourceforge.net/project/showfiles.php?group_id=141358&release_id=336854|Download bitweaver] and unpack the archive in a place of your choice. __Make a backup of your database__. Point your browser to /yourbitweaver/install/install.php and follow the on screen instructions. When asked what path you want to follow, choose __upgrade__ and point your browser to the __backup database__ first to test if it works. If you are using MySQL, the __upgrade process requires at least version 4.1__. Bitweaver will work on previous version of MySQL as well, but the upgrader requires it. If your host does not provide MySQL 4.1, you need to upgrade on a server that does and then export/import the converted database onto your host server. For further information see our ((bitweaverDatabaseUpgrades|page on Database Upgrades)) and on ((bitweaver and TikiWiki)).
 
-!! Where can i find more documentation on installing bitweaver?
-* bitweaverRequirements
-* InstallbitweaverDoc
-* bitweaverUpgrade
+!! Where can I find more documentation on installing bitweaver?
+* ((bitweaverRequirements))
+* ((InstallbitweaverDoc))
+* ((bitweaverUpgrade))
 
 !! The installer can't detect my database
-Please make sure the database is available from php. to do so, create a file with the following contents:
+Please make sure the database is available from PHP. To do so, create a file with the following contents:
 {code source=PHP title=PHPinfo}
 <?php
 phpinfo();
 ?>
 {/code}
-and point your browser to it. This will display all your php settings and will also show you if your database is accessible from php. if the database does not show up, you need to recompile php or add the appropriate extension.
-If it still fails, please look at install/install_database.php where the database recognition code is. if you can fix the bug, please report it to the bitweaver development team.
+and point your browser to it. This will display all your PHP settings and will also show you if your database is accessible from php. If the database does not show up, you need to recompile PHP or add the appropriate extension. If it still fails, please look at /yourbitweaver/install/install_database.php where the database recognition code is. If you can fix the bug, please report it to the bitweaver development team.
 
-!! During the installation process, I get the following error "bitweaver cannot connect to the database", even though I have checked the database name, username and password to be correct. How can I fix this error?
-Errors like might indicate an issue with permissions set in the pg_hba.conf file. This file is used to configure which software is permitted to connect tot the PostgreSQL database. For a detailed overview of this configuration file, please check the [http://www.postgresql.org/docs/7.4/static/client-authentication.html|PostgreSQL FAQ]
+!! During the installation process, I get the following error "bitweaver cannot connect to the database", even though I have checked the database name, username and password to be correct.
+This indicates an issue with permissions set in the pg_hba.conf file. This file is used to configure which software is permitted to connect to the PostgreSQL database. For a detailed overview of this configuration file, please check the [http://www.postgresql.org/docs/7.4/static/client-authentication.html|PostgreSQL FAQ]
 
-!! I get a 404 File not found when trying to access anything in the /users/ folder.
-You are most likey running ISPConfig, if so comment out the following line(s) from /etc/apache2/vhosts/Vhosts_ispconfig.conf:
+!! I get an error "404 File not found" when trying to access anything in the /users/ folder.
+You are most likey running ISPConfig, if so comment out the following line(s) from /etc/apache2/vhosts/Vhosts_ispconfig.conf. There is one entry per vhost, so you will need to comment out the particular webs you want to run bitweaver on:
 {code source=Apache title="/etc/apache2/vhosts/Vhosts_ispconfig.conf"}
 AliasMatch ^/users/([^/]+)(/(.*))? /var/www/web1/user/$1/web/$3
 {/code}
-There is one entry per vhost, so you will need to comment out the particular webs you want to run bitweaver on.
 
-!! I get a 403 Forbidden when trying to access bitweaver after a clean install.
-The rewriteEngine needs supporting settings in Apache's httpd.conf. Alternatively you can change each .htaccess file that includes "rewriteEngine on". Add the following line:
+!! I get an error "403 Forbidden" when trying to access bitweaver after a clean install.
+The rewriteEngine needs supporting settings in Apache's httpd.conf. Alternatively you can change each .htaccess file that includes "rewriteEngine on". There are several .htaccess files that need to be edited. They are in each package directory. Add the following line:
 {code source=Apache title="Add to .htaccess"}
 Options +FollowSymlinks
 {/code}
-There are several .htaccess files that need to be edited. They are in the folders for various packages.
 
-!! I forgot / lost my admin password an cannot access my site anymore. How can i reset the admin password?
-Try doing something like this in your database:
+!! I forgot/lost my admin password an cannot access my site anymore. How can I reset the admin password?
+Try the following command in your database. It should allow you to log in using admin/foobar:
 {code source=SQL title="Reset admin password in the database"}
-update users_users set hash=md5('foobar') where login='admin';
+UPDATE users_users SET hash=md5('foobar') WHERE login='admin';
 {/code}
-This should allow you to log in using admin / foobar.
 
 !! How do I find out which version of bitweaver I have?
 Login as admin and click __Administration -> Kernel -> Check version__. If you can't login or did not install bitweaver yet, open __<path to your bitweaver directory>/kernel/setup_inc.php__ to find the version number.
+
+!! How do I migrate my users from one bitweaver install to another?
+Please view the page ((Migrating Users Between Bitweaver Sites)) for details.
+
+!! Is it possible to install bitweaver within another bitweaver directory?
+It's not possible out of the box, due to the way bitweaver scans directories. If you insist on having one install within another, you will have to modify ''/kernel/BitSetup.php'', function scanPackages(), to exclude the directory where you have that second bitweaver installation:
+{code source=PHP}
+// change this line
+if( ($dirName != '..') && ($dirName != '.') && is_dir(BIT_ROOT_PATH . '/' . $dirName) && ($dirName != 'CVS') && (preg_match( '/^\w/', $dirName )) ) {
+
+// to
+if( ($dirName != '..') && ($dirName != '.') && ($dirName != 'bitweaver_sub_dir') && is_dir(BIT_ROOT_PATH . '/' . $dirName) && ($dirName != 'CVS') && (preg_match( '/^\w/', $dirName )) ) {
+{/code}
+
 
 ---
 
 ! Configuration Problems
-!! I created a custom module and when i inserted it into the layout, the site died.
-Unfortunately we don't have an easy way of fixing this yet or for checking for syntax errors when saving a custom module. The data you submitted is in the database in the __tiki_user_modules__ table in the __data__ column. Please edit / remove the data of the culprit module manually.
 
----
+!! I created a custom module and when I inserted it into the layout, the site died.
+This only happens with Bitweaver version 1.3.x and below. The problems are syntax errors when saving a custom module. The data submitted goes to the database table ''tiki_user_modules'', column ''data''. The data of the culprit module has to be edited/removed manually.
 
-! Documentation
-!! Where can i find Documentation on package X?
-in the packages administration screen ( Administration --> Kernel --> Packages ), there is a description of all packages and a link to the relevant page on bitweaver. if the page does not exist here, it is likely that there is no decent documentation for that given package. in this case, you could create such a wiki page requesting for information from the author or someone using the package.
+!! Cannot upload files larger than 8 Megabytes
+This is caused by your php.ini configuration. To get PHP to accept files larger than that, php.ini must be configured. The -+upload_max_filesize+-, -+memory_limit+-, and -+post_max_size+- variables should be equal, at minimum, to the size of the file you'd like to upload. The -+memory_limit+- may need to be set even larger than the size of your file.
 
-!! Where can i find Documentation on feature X?
-our inline help provides a brief description in virtually all forms and input areas. should something not be clear, please search this site for the feature you don't understand. chances are that it's been answered somewhere. if you find an answer to your question, please add the __question__ and __answer__ to this page for others to use.
+!! How to get non-English characters display correctly (UTF-8)
+To a certain degree, it depends on your server setup if "special" characters are displayed correctly. If they are not, and you're using MySQL, try the page __((MySQL and character encoding))__ for more information.
 
-!! Where can i find some basic dev tools?
-we have a set of debugging functions and tools available for developers:
-we recommend the use of [http://www.xdebug.org/|xdebug].
-{code source=PHP}
-# our version of var_dump();
-vd();
+---
 
-# our version of backtrace(); - this is also the function used to generate the WSOD output
-bt();
+! Documentation
 
-# this will generate lots of output: all SQL queries and some other random functions will display
-$gDebug = 99;
+!! Where can I find documentation on package X?
+In your bitweaver install, click on ''Administration -> Kernel -> Packages'', there is a description of all packages and a link to the relevant page on bitweaver.org. If a page does not exist here, it is likely that there is no decent documentation for that package available yet. In this case, you could create such a wiki page and fill in the information yourself. The packages's author, other developers, and other users of the package will be glad to help.
 
-# this file has various settings useful for developers
-kernel/config_inc.php
-{/code}
+!! Where can I find documentation on feature X?
+Our inline help provides a brief description in virtually all forms and input areas. Should something not be clear, please [http://bitweaver.org/ilike/|search bitweaver.org] for that feature. If you find an answer to your question, please add the question and answer to this page.
 
-!! Where can i find Developers Documentation?
+!! Where can I find developers documentation?
 * PHPDoc: [/doc/php/]
 * Doxygen: [/doc/dox/]
 * Developers FAQ: [/blogs/12]
+
 
 ---
 
 ! Theming
-!! How the hell do i create a new theme?
-we have an extensive ThemeTutorial, which gives you an outline how our themes work, how you create a theme. it even includes some basic css rules should you not have much experience with css.
+!! How do I create a new theme?
+We have an extensive ((ThemeTutorial)), which gives you an outline how our themes work, how you create a theme. It includes some basic CSS rules.
 
-!! How do i change the center width when side columns disappear?
-Please note that this has probably become obsolete with R2 thanks to the StyleLayouts.
+!! How do I change the layout of columns, including shuffling them, or hiding them?
+Bitweaver version 2 and above has a feature called ((StyleLayouts)) which takes care of this automatically (a specific CSS class name is applied to the center column depending on what side columns are visible). Which columns or content areas appear to the users can be controlled manually: ''Administration -> Themes -> Columns''.
 
-I use a simple technique where i apply a specific css class name to the center column depending on what side columns are visible. the code in the template looks like this (taken from the native theme):
-{code source=Html4Strict title="Adjust css class depending on number of columns"}
-<div id="bitmain" class="bit-cols-{
- if $gBitSystem->isFeatureActive( 'feature_left_column' ) && $l_modules && !$gHideModules and $gBitSystem->isFeatureActive( 'feature_right_column' ) && $r_modules && !$gHideModules
- }3{
- elseif $gBitSystem->isFeatureActive( 'feature_left_column' ) && $l_modules && !$gHideModules}2l{elseif $gBitSystem->isFeatureActive( 'feature_right_column' ) && $r_modules && !$gHideModules
- }2r{
- else
- }1{
- /if}">
-{/code}
+!! How do I customize the top menu?
+You can make all sorts of customizations to the top menu, you will find options at: ''Administration -> Themes -> Menus''
 
-all the above does, is apply one of the following classes:
-{code source=CSS title="Resultant CSS classes"}
-.bit-cols-1 /* applied when only the center column is visible */
-.bit-cols-2l /* only the center and the left column are visible */
-.bit-cols-2r /* only the center and the right column are visible */
-.bit-cols-3 /* all three columns are present */
-{/code}
-
-the corresponding css looks like this:
-{code source=CSS title="Sample CSS"}
-#bitmain {margin:0 0 1em 0.5%;}
-.bit-cols-1 {margin:0 1% 1em 1% !important;}
-.bit-cols-2l {float:left; width:77%;}
-.bit-cols-2r {float:left; width:79%;}
-.bit-cols-3 {float:left; width:61%;}
+!! Create a random digit in a template?
+{code}
+// Try {0|rand:7} to output a random digit between 0 and 7.
+// Can be used for
+interface-image_{0|rand:7}.jpg
+// or for interfaces with flaws:
+<something style="margin-left:{0|rand:7}0px">…
 {/code}
 
 !! Theming with MSIE in mind
-we have some ((theme compilance with MSIE|msie related tips))
+Please view the page ((theme compliance with MSIE)) for details.
 
-!! How do i add google adsense to all my pages?
-You can simply include the adsense script in one of your templates such as footer.tpl.
-Copy kernel/templates/footer.tpl to your theme directory ( or themes/force/, also see ThemeTutorial ) and insert the javascript there.
+!! How do I add Google AdSense to all my pages?
+* __Automatically 1:__ Find the AdSense module in ''Admin > Themes > Layout'' and indlude it.
+* __Automatically 2:__ Create a Custom Module with the code below, then assign this module you just made via ''Admin -> Themes -> Layout''.
+* __Manually:__ Include the AdSense script in one of your templates such as footer.tpl. Copy kernel/templates/footer.tpl to your theme directory (or themes/force/, see ((ThemeTutorial))) and insert the AdSense Javascript code there. This applies also for similiar Javascript code like user tracking.
 {code source=JavaScript title="Insert something like this into your template"}
 <script type="text/javascript">
  /* <![CDATA[ */

@@ -179,43 +169,60 @@

 <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"></script>
 {code}
 
-!! Include a module anywhere? Like Last Modified Pages in the footer instead of in a column?
-There's a smarty plugin for that. Read the [http://www.bitweaver.org/doc/php/Smarty/plugins/_kernel_smarty_bit_function_inlinemodule_php.html|documentation page of function.inlinemodule.php]. In short: __{inlinemodule file="bitpackage:wiki/mod_last_modif_pages.tpl" rows="50"}__
+!! Include a module anywhere? For instance, Last Modified Pages in the footer instead of in a column?
+There's a smarty plugin for that. Read the [http://www.bitweaver.org/doc/php/Smarty/plugins/_kernel_smarty_bit_function_inlinemodule_php.html|documentation page of function.inlinemodule.php]. In short:
+{code}
+{inlinemodule file="bitpackage:wiki/mod_last_modif_pages.tpl" rows="50"}
+{/code}
+
 
-!! Create a random digit in a template?
-Try {0|rand:7} to output a random digit between 0 and 7. Can be used for something like interface-image_{0|rand:7}.jpg or style="margin:{0|rand:32}" for interfaces with flaws.
 
 ---
 
 ! Development
-!! How do i start my own package?
-we have some useful documentation on how to start your own package and how to get started on the SamplePackage page.
+!! How do I start my own package?
+Please view the page ((SamplePackage)) for details.
 
-!! How do i share a package?
-you have written a package and you want to share it with others? currently we don't have a dedicated method / area for this, and we only use cvs to organise our packages. if you drop by IRC, we can have a chat about how and what you want to share.
+!! How do I share a package?
+You have written a package and you want to share it with others? We only use CVS to organize our packages. If you drop by IRC, we can have a chat about how and what you want to share.
 
-!! Where do i put functions?
-* CodingGuidelines
-* if it has SQL, it should go in Class.php or _lib.php file.
-* other functions can be sprinkled in the logic php
-* if two different logic php files need the same function, put it in a Class or _lib
+!! Where do I put functions?
+* ((CodingGuidelines))
+* if it has SQL, it should go in Class.php or _lib.php
+* other functions can be sprinkled in the logic PHP
+* if two different logic PHP files need the same function, put it in a Class or _lib
 
-!! Where and how do i get hold of PHP reserved variables and constants in smarty templates?
+!! Where and how do I get hold of PHP reserved variables and constants in smarty templates?
 {code source=PHP title="PHP reserved variables in Smarty templates"}
 $_REQUEST['foo'] => {$smarty.request.foo}
 $_SERVER['foo'] => {$smarty.server.foo}
 PHP_CONSTANT => {$smarty.const.PHP_CONSTANT}
+{/code}
+
+!! What are your generic dev tools?
+We have a set of debugging functions and tools available for developers. We recommend the use of [http://www.xdebug.org/|xdebug].
+{code source=PHP title="Commonly used dev tools"}
+# our version of var_dump();
+vd();
+
+# our version of backtrace(); - this is also the function used to generate the WSOD output
+bt();
+
+# this will generate lots of output: all SQL queries and some other random functions will display
+$gDebug = 99;
+
+# this file has various settings useful for developers
+kernel/config_inc.php
 {/code}
 
 !! What files get included on a typical page load?
+Due to the modular nature of bitweaver, this question is very hard to answer. Depending on your settings, a number of files might be included that are not listed here. All active services will probably load some of their files and the active package will probably load a number of its files as well.
 {code source=php title="PHP file inclusion on a typical page load"}
 /bit_setup_inc.php
 /kernel/setup_inc.php
 /kernel/config_defaults_inc.php
-/kernel/preflight_inc.php
 /kernel/Bit*.php
 /liberty/Liberty*.php
-/<pkg>/bit_setup_inc.php
-/<active pkg>/...
+/<package>/bit_setup_inc.php
+/<active package>/...
 {/code}
-
Page History
Date/CommentUserIPVersion
29 Mar 2009 (23:10 UTC)
try to make column control faq question a little more general sounding
Will69.203.72.16155
Current • Source
Will69.203.72.16154
View • Compare • Difference • Source
xing62.47.253.18953
View • Compare • Difference • Source
xing62.47.240.2552
View • Compare • Difference • Source
xing62.47.240.2551
View • Compare • Difference • Source
laetzer85.178.55.15850
View • Compare • Difference • Source
laetzer85.178.28.6249
View • Compare • Difference • Source
laetzer85.177.83.3648
View • Compare • Difference • Source
laetzer85.179.32.2747
View • Compare • Difference • Source
laetzer85.179.32.2746
View • Compare • Difference • Source
laetzer85.178.47.1444
View • Compare • Difference • Source
laetzer85.178.47.1443
View • Compare • Difference • Source
laetzer85.178.10.6241
View • Compare • Difference • Source
laetzer85.178.62.11740
View • Compare • Difference • Source
xing194.152.164.4537
View • Compare • Difference • Source
Marco Lussetti87.8.239.12536
View • Compare • Difference • Source
xing194.152.164.4535
View • Compare • Difference • Source
xing194.152.164.4534
View • Compare • Difference • Source
xing194.152.164.4533
View • Compare • Difference • Source
laetzer85.178.9.21432
View • Compare • Difference • Source
Dan Nehring68.74.5.15131
View • Compare • Difference • Source
laetzer85.178.61.22930
View • Compare • Difference • Source
xing194.152.164.4529
View • Compare • Difference • Source
Mike Williamson203.173.156.7828
View • Compare • Difference • Source
laetzer85.178.57.10327
View • Compare • Difference • Source
laetzer85.178.57.10324
View • Compare • Difference • Source