Documentation :: cBB AutoWords


Quick Guide • Requirements

cBB AutoWords needs very few requirements to run correctly.

The basic requirements are:
  1. A phpBB forum whose version is equal or greater than 3.2.0.
  2. The browser must support Javascript in order to use and manage the extension.

Quick Guide • Install

  1. Unzip the cBB AutoWords file to a local directory (on your computer).
  2. Upload all the files contained in the upload folder of that file (maintaining the directory structure) to the ext directory located in the root directory of your forum.
    The final route for the extension files should be: /ext/canidev/autowords/
  3. Using your web browser, navigate to Admin Panel >> Personalize >> Extensions
  4. Find cBB AutoWords and click on the Enable option.

Quick Guide • Update

  1. Using your web browser, navigate to the Administration Panel and go to Customize >> Extensions, Find cBB AutoWords and click in the Disable option.
  2. Delete the folder autowords which is within the directory /ext/canidev/ in the server.
  3. Download and unzip the cBB AutoWords zip file in a local folder on your computer.
  4. Upload all files contained in the upload directory in that file (keeping the directory structure) to the ext directory in the root of your forum.
  5. Using your web browser, navigate to the Administration Panel and go to Customize >> Extensions, Find cBB AutoWords and click in the Enable option.

Quick Guide • Uninstall

cBB AutoWords can be uninstalled in a few steps:

  1. Using your web browser, navigate to Admin Panel >> Personalize >> Extensions.
  2. Find cBB AutoWords and click on the Disable option.
  3. Once disabled, if you want to completely delete it, click on Delete Data and then delete the directory /ext/canidev/autowords from your server.

Quick Guide • Extension operation

From the PCA you can define the words that will be substituted.
These words are replaced when viewing the content, they are not permanently modified in the database.

The available options are:
  1. Delete: Remove the word or phrase from all forum content.
  2. Link: Converts the word or phrase into a link to the specified url (This is discarded if the word is already within a link).

    The available options are:
    1. Link to Web: The url to the link.
    2. Popup content: Specifies the text to display as additional information. The floating box will appear when the mouse is over the text.
  3. Customize: It allows defining the new text that will replace the original word or phrase.

    The available options are:
    1. Change text: Replace the word or phrase with what is specified here. BBcode is allowed.

      Note 1: The [url] bbcode will be removed if the original word is already within a link
      Note 2: You can use the {TEXT} tag that will be replaced by the original word, keeping upper and lower case.
    2. Popup content: Specifies the text to display as additional information. The floating box will appear when the mouse is over the text.