Thank you for downloading cBB Blockgets. This README will guide through the basics of installation and operation of the mod. Please ensure you read this and the accompanying documentation fully before proceeding with the installation.

Readme


1. Installing cBB Blockgets

Installation instructions can be found in the install document contained in this distribution. We highly recommend you backup any existing data before proceeding!

To install cBB Blockgets from scratch, you must follow the steps listed in the install.xml file.

1.1. Change homepage path

You can change the name and folder of the "home.php" file to run into another directory.
To achieve this you only need to perform some simple steps:

  1. Move the file "home.php" to the directory you want (relative to the forum) and rename the file if you wish, for example to "index.php"
  2. Open the file you just moved, and find this line:
    $phpbb_root_path = (defined('PHPBB_ROOT_PATH')) ? PHPBB_ROOT_PATH : './';
    Replace ./ with the forum path, relative to the file
  3. Open the file "includes/hooks/hook_blockgets.php" and find:
    //$blockgets->set_home('Home filename (home.php)', 'Directory relative to the forum path (./)');
    and replace "Home filename (home.php)" for the name of the moved file and "Directory relative to the forum path (./)" for the path where the moved file is placed (Relative to the forum).
    After, delete "//" from the line.

For example, if the forum is in http://mydomain.com/forum/ and you want put the file "portal.php" in http://mydomain.com/index.php (http://mydomain.com/), the result is:

File to move (home.php)
$phpbb_root_path = (defined('PHPBB_ROOT_PATH')) ? PHPBB_ROOT_PATH : './forum/';

File "includes/hooks/hook_blockgets.php"
$blockgets->set_home('index.php', '../');

1.2. Create custom pages

For default, cBB Blockgets loads all the custom pages using "home.php" file but, you can create a separate file for each custom page.
To achieve this, you only need a few easy steps:

  1. Create a copy of the file "home.php" renaming it with the name you want.
  2. Open the file you just created, and find this line:
    //$blockgets->set_page('put here alias or id of the page');
    Replace 'put here alias or id of the page' by numerical ID or alias (if defined) of the page you want to display.
    After, delete "//" from this line.

For example, to display a page whose alias is "page_1" the result is:
$blockgets->set_page('page_1');


2. Uninstalling cBB Blockgets

To uninstall cBB Blockgets you only have to run the installer from Uninstall tab.
Once finished, you can choose to delete all the code files of the mod in the forum (following the installation steps on the contrary), although not necessary, since the portal, once removed, does not interfere with the forum.


3. Running cBB Blockgets

Once installed, cBB Blockgets is managed and configured easily from the Administration Control Panel.
If you need help with this mod, please go to Section 3.


4. Getting help with cBB Blockgets

If you have questions regarding the operation of cBB Blockgets there are several places you can turn.

5.i. Documentation

A comprehensive documentation is now available online and can be accessed from the following location:

http://www.canidev.com/docs.php?i=cbb-blockgets-v1.0.2

This covers everything from installation through final manage.

5.ii. Community Forum

CaniDev has a forum in which users can help each other, in addition to receiving support for the team. This site can be found at:

http://www.canidev.com/viewforum.php

If you do seek help via our forums please be sure to do a Search before posting. This may well save both you and us time and allow us to spend more time responding to people with unknown issues and problems. Please also remember that CaniDev is an entirely volunteer effort, no one receives any compensation for the time they give, this includes moderators as well as developers. So please be respectful and mindful when awaiting responses.


5. Status of this version

This is the first version avaliable of cBB Blockgets (in the past, this mod was known an cBB Portal), enhanced version with new features. We hope you enjoy it and continue to improve.


6. Reporting Bugs

cBB Blockgets has an area of reporting errors (bugs) to better manage them. We strongly urge that if you find an error, notify in order to correct.

http://www.canidev.com/viewforum.php

Before reporting an error, we ask that you consider the following:

  • Make sure the error is in cBB Portal and not from the hosting or any other changes into the forum

  • Make sure your error or one very similar is not already reported (create reports with existing topics will only delay the solution to the problem).

  • Verify that the help forum there are no issues talking about this error or similar.

When reporting an error, please tell us the following:

  • Your server type/version, e.g. Apache 1.3.28, IIS 4, Sambar, etc.
  • phpBB, cBB Portal versions you using
  • Additional mods installed (if proceed).

8. Copyright and disclaimer

This application is released under the GPL. Please see source code and the docs directory for more details. This package and its contents are Copyright (c) CaniDev. All Rights Reserved.

Additionally, this application is supplemented with some external content that has its respective license:

jQuery

jQuery is released under two licenses: MIT License and GPL