Installation of 7.x-2.x versions

  • Download Contextly module and unpack it to the modules folder (usually "sites/all/modules").
  • Download Contextly integration kit.
  • Extract archive contents to the "sites/all/libraries/contextly-kit" folder. With the Libraries API module installed you can also use website-specific folder "sites/your.website/libraries/contextly-kit".
  • Enable Contextly module and follow appeared instructions to get your API key. In case you've missed it for some reason, visit "Configuration -> Content authoring -> Contextly" and follow instructions to get an API key.
  • Go to "Configuration -> Content authoring -> Text formats" and enable "Contextly sidebars" filter on each text format you use for nodes. This filter converts special HTML comment into an empty tag (<span> by default) with the "class" attribute. The order of filters is important. We recommend to put the "Contextly sidebars" filter before the "Limit allowed HTML tags" filter (if any) and add sidebar tag name to the list of allowed.
  • Grant permission "Manage Contextly links and sidebars" to content editors.

Widgets displaying

Sidebars can only be displayed through the text formats as a part of the node body. But there are two ways of displaying Related module and FollowUp button:

  • Widgets may be displayed as a part of the node content. Their position and visibility are managed through the field UI. Visit the following path on the administration pages to control this way of rendering: Structure -> Content Types -> [Specific type] -> Manage Display. Although widget entries appear on the field UI for every enabled view mode, they are visible on the "full" mode only.
  • Alternative way to display widgets on the page is blocks. Just visit Structure -> Blocks and turn on Contextly modules for your theme. (Available since 7.x-2.3)

Important! The Related module and FollowUp button are only displayed once per page. For the most predictable results it's recommended to use only one of two described methods on each node type.

Supported WYSIWYG content editors:

  • CKEditor: at least 3.6.1, tested with versions up to 4.2.
  • TinyMCE: at least 3.4, 4.x versions are NOT supported yet.

WYSIWYG module setup (TinyMCE or CKEditor)

Contextly module provides integration for TinyMCE and CKEditor through the WYSIWYG module.

  • Set up WYSIWYG module and TinyMCE or CKEditor if not already done. See WYSIWYG module for instructions.
  • Edit WYSIWYG profile you want to use on Contextly-enabled nodes (Configuration-> Content authoring -> WYSIWYG Profiles), enable Contextly link and Contextly sidebar buttons. Save the profile.
  • Edit the node. Contextly buttons should appear on editor panel.

CKEditor module setup

Contextly module also provides integration with CKEditor Drupal module.

  • Set up CKEditor module and editor itself if not already done.
  • Edit CKEditor profile you want to use on Contextly-enabled nodes (Configuration -> Content authoring -> CKEditor), expand "Editor appearance" fieldset and in Toolbar section drag all Contextly buttons to the "Used buttons".
  • At the same page in Plugins section enable Contextly plugin.
  • Save the profile.
  • Edit the node. Contextly buttons should appear on editor panel.

Upgrade from 7.x-1.x to 7.x-2.x version

Starting from 7.x-2.0 version the Contextly integration kit is required. You must install it before module upgrade. See installation instructions above for a download link.