Documentation :: cBB Follower v1.0.1


Quick Guide • Requirements

cBB Follower needs very few requirements to run correctly.

The basic requirements are:
  1. A phpBB forum whose version is greater than 3.0.8 (3.0.11 is recommended).
  2. The Javascript must be enabled on your browser to manage and use the mod.

Quick Guide • Install


Manual Installation:
  1. Unzip the cBB Follower zip file in a local folder on your computer.
  2. Upload all files contained in that file (keeping the directory structure) to your server or hosting account.
  3. Make changes into phpBB files as indicated in the file install.xml
  4. Using your web browser visit the location you placed phpBB3 adding /follower/install/.
    Examples:
    http://www.mydomain.com/phpBB3/follower/install/
    http://www.mydomain.com/forum/follower/install/
  5. Click the Install button and follow the steps and fill out all the requested information.

AutoMod Installation:
  1. Download the cBB Follower zip file in a local folder on your computer.
  2. Upload and install the MOD using AutoMod tools.
  3. Using your web browser visit the location you placed phpBB3 adding /follower/install/.
    Examples:
    http://www.mydomain.com/phpBB3/follower/install/
    http://www.mydomain.com/forum/follower/install/
  4. Click the Install button and follow the steps and fill out all the requested information.

If you experienced problems or do not know how to proceed with any of the steps above, you can put your problem in the correct section of this web forum, where it will help as we can.

Quick Guide • Uninstall

cBB Follower can be uninstalled in a few steps:

  1. Using your web browser visit the location you placed phpBB3 adding /follower/install/,
    Examples:
    http://www.mydomain.com/phpBB3/follower/install/
    http://www.mydomain.com/forum/follower/install/
  2. Click on the Uninstall button and follow the steps and fill out all the requested information.
  3. When finished, You have to edit the phpBB files following the steps of install.xml file, but in reverse, to remove the mod code. This is not essential, the forum works well even if you don't delete the mod codes.

Quick Guide • Update

To upgrade cBB Follower from a previous version, you must follow these steps:

  1. Unzip the cBB Follower zip file in a local folder on your computer.
  2. Upload all files contained in that file (keeping the directory structure) to your server or hosting account. (overwriting the files of the previous version).
  3. Make changes into phpBB files as indicated in the file contrib/update/1.X.X_to_1.X.X/update.xml located inside the package. ("1.X.X" correspond to the versions you are working).
  4. Using your web browser visit the location you placed phpBB3 adding /follower/install/.
    Examples:
    http://www.mydomain.com/phpBB3/follower/install/
    http://www.mydomain.com/forum/follower/install/
  5. Click the Update button and follow the steps.

If you experienced problems or do not know how to proceed with any of the steps above, you can put your problem in the correct section of this web forum, where it will help as we can.

Main Functions • User Profile

The follower gives a user profile where you can see user activity and most relevant information.

Each user can access their profile from the top button located on the top of the page and the other from the button on the default profile for users.
Note: If you set the user profile follower as the default profile, only need to click on the names of the users.

The sections shown in the profile are:
  1. Chronology: Displays the most recent activity of all users you follow.
    Esta pestaña solo se muestra en el perfil propio de cada usuario.
  2. Wall: This tab shows the comments posted by the user.
    This tab is only displayed if comments are enabled.
  3. Mentions: This tab displays all the comments and messages that the user has been mentioned.
  4. Posts: Here you can see the your approved posts.
  5. Topics: Displays a list of topics created by the user.
  6. Following: List of users who are following the user shown.
  7. Followers: List all users who follow the user shown.

Depending on the section you are in and the permissions you have awarded, each user will see different options in lists:
Some of the main options are: Delete comment, reply comment, share comments, reply to the topic, follow a user, etc ...

Main Functions • Comments

If this option is enabled in the Admin Panel and the user has the permissions involved, may post short comments (like twitter) in his wall.

The comments can be posted from any forum page using the button on the top of page.

No pictures allowed in comments, but users are allowed to mention.

Main Functions • Mentions

Mentions are references to users, similar to the mentions of Twitter, you can add both in comments and in the forum posts.
For the mentions will use the symbol @ followed by follower name that each user has (configurable from the Control Panel).
You can also mention a user using his real name between "[ ]".
Examples: @user @[real name] Thanks to Quick Mentions function and the smart list that appears when you are writing, mention another user is quickly and easily.

Quick Mentions
Quick Mentions allows to select the Follower Names available on the page being viewed and are available in several ways:
  1. Automatically, all available, when post a new comment.
  2. Automatically, in the message history, when replying a topic.
  3. Manually, in Quick Reply, using the available button.

Main Functions • Hashtags (Tags)

The hashtags are labels that can be used both in the comments and in the forum posts.
As in twitter, use the symbol # followed by the label.

The mod has its own search engine that allows you to find a label and display all the comments and messages that have that label.
In the user profile will be appears a list of Trends with the most used tags.

Main Functions • Users Follow

This feature allows a user to follow and be satisfied in real time (by notifications) of all activity of another user.

Among the activities that can be followed are:
  1. The comments posted.
  2. Topics posted.
  3. Posts posted.
  4. Mentions.
  5. The follow of other users.

Main Functions • Configuration

Each user can customize certain characteristics of MOD to taste.

These options are in their User Control Panel:
  1. Personal Profile:
    1. Follower name: Name to be used with @ to mention in comments and posts.
    2. About me: Small text will be viewing to other users.
  2. Notificaciones: Allows user to select when he will be notified and the means by which we arrive.

Manage • Options

Accessing the route ACP >> Mods >> Follower you can manage all the MOD options.

The options available in this version are:
  1. Main Configuration
    1. Follower enabled: Enable or disable the MOD completely.
    2. Set as default profile:If enabled, the wall and user movement is displayed instead of the conventional phpBB3 profile.
      If enabled, The information of the conventional profile will be appears in the follower profile.
    3. Row limit: Maximum number of rows to be displayed simultaneously.
    4. Notifications allowed: Sets the notification types permitted to users..
      This option overwrite the user preferences.
    5. Enable comments between users:: This options enable or disable the comments for all users.
    6. Maximum characters: Set the limit of characters allowed in comments.
    7. Save user comments: If you set a time limit, the comments are outside this limit will be automatically deleted.
    8. Slide menu - Autohide: If enabled, the menu will only be visible on mouse over it.
    9. Slide menu - Position: Sets the position of the menu in the header.
  2. Manage users Manage the follow data of the users.
  3. Tools Contains tools to solve synchronization errors in the data.

Manage • Permissions

For full control over the MOD it have multiple permissions for users and moderators.

User Permissions:
  1. Can delete own comments. Defines whether a user can delete their own comments.
  2. Can follow users. Defines whether a user can follow the activity of other forum users.
  3. Can mention users. Defines whether a user can make mentions of other users.
  4. Can post comments. Defines whether a user can post comments on their wall.
  5. Can reply or share comments. Defines whether a user can reply and share user comments.
Moderation Permissions:
  1. Can delete comments. Defines whether a user can delete comments, regardless of who is its author.

Note: To manage the Main Options of the MOD you not require additional permissions.
cron