Documentation :: cBB QuickQuote v1.0.0


Quick Guide • Requirements

cBB QuickQuote needs very few requirements to run correctly.

The basic requirements are:
  1. A previously phpBB forum installed whose version is 3.1.8 (3.2.x is the recommended version).
  2. The browser must support Javascript in order to use and manage the extension.

Quick Guide • Install

  1. Unzip the cBB QuickQuote 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/quickquote/
  3. Using your web browser, navigate to Admin Panel >> Personalize >> Extensions
  4. Find cBB QuickQuote and click on the Enable option.

Quick Guide • Uninstall

cBB QuickQuote can be uninstalled in a few steps:

  1. Using your web browser, navigate to Admin Panel >> Personalize >> Extensions.
  2. Find cBB QuickQuote 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/quickquote from your server.

Quick Guide • Extension operation

When you select a text fragment of any forum message, a small menu appears that gives you the option to save that text as a quote, to be used later, or reply directly to that fragment.
When saving a quote, the corresponding button will appear at the bottom of the page or in the text editor (depending on the established configuration). This button gives access to the dialog that shows all saved quotes and allows you to insert them in the editor, either one at a time or all together.

  1. Quotes can be used both in forum messages and in private messages to other users.
  2. Quotes are deleted once inserted in the message, so as not to generate an endless list.

Events • Javascript


core.onready
  • Added in version: 1.0.0
  • Arguments: None
  • Description: Loaded when the page is ready.

core.onload
  • Added in version: 1.0.0
  • Arguments: None
  • Description: Loaded when the page has been fully loaded.

quickquote.beforeInit
  • Added in version: 1.0.0
  • Arguments: this (main class)
  • Description: Loaded when the extension is initialized, after loading the configuration and before processing it.

quickquote.onInit
  • Added in version: 1.0.0
  • Arguments: this (main class)
  • Description: Loaded when the extension has been fully loaded.

quickquote.onInitDialog
  • Added in version: 1.0.0
  • Arguments: this (main class)
  • Description: Loaded when opening the dialog that contains the quotes.

quickquote.onCloseDialog
  • Added in version: 1.0.0
  • Arguments: this (main class)
  • Description: Loaded when closing the dialog that contains the quotes.

quickquote.onShowTooltip
  • Added in version: 1.0.0
  • Arguments: this (main class)
  • Description: Loaded when the text selection is completed in a message.

quickquote.onShowBtn
  • Added in version: 1.0.0
  • Arguments: this (main class)
  • Description: Loaded when showing/hiding the button that opens the quote's dialog.