Joomla! Plugin v1.0 Installation and Administration Guide

N.B. This guide covers plugin version 1.0 a separate set of instructions for beta versions is available here

Contents:

1 Installation

1.1 Install DiscussIt for Joomla!

1.2 Uninstall DiscussIt for Joomla!

- 1.2.1 Uninstall DiscussIt for Joomla! 1.5

- 1.2.2 Uninstall DiscussIt for Joomla! 1.6

2 Plugin Management

2.1 Key

2.2 Show Comment Link

2.3 Enable DiscussIt Link

2.4 Show in all Articles

2.5 Show in Categories

2.6 Language

2.7 Widget Width

2.8 Widget Top Margin

2.9 Comments Disabled Message

3 Additional Features

3.1 Manual Enabling or Disabling Comments on Individual Articles.

3.2 Using DiscussIt widget as a module


1. Installation


1.1. Install Plugin

Before installing the plugin please ensure you have signed up for an account here as doing so will provide you with the API key you will need to enable the plugin to work properly. A setup guide is available here if you need further help with this step.

To install the Joomla! plugin, first log in to your Joomla administration page and select 'Extensions' -> 'Extension Manager'.

screen-capture.jpg

Click the 'Browse' button in the 'Upload Package File' panel and select the plugin package .zip.
screen-capture-1.jpg

Now click 'Upload & Install.'

screen-capture-2.jpg

Next, go to 'Extensions' -> 'Plug-in Manager'

screen-capture-3.jpg

Now click on the 'Content - Discussit' link to go to the plugin's administration page.

screen-capture-5.jpg

On this page enter your DiscussIt API key in the box labelled 'Key' (if you don't already have a DiscussIt API key you can get one by signing up here)

screen-capture-6.jpg

Finally, click 'Save' and wait 3 seconds for the page to reload.

screen-capture-1.png



1.2. Uninstall DiscussIt for Joomla!

1.2.1. Uninstall DiscussIt for Joomla! 1.5

To uninstall, first click on 'Extensions' -> 'Install/Uninstall' in your Joomla administration

step1.jpg

Now click 'Components' as shown below:

screen-capture.jpg

Select the DiscussIt component by clicking on the radio button next to the DiscussIt entry in the on-screen list.

screen-capture-1.jpg

Now click the 'Uninstall' button in the top-right of the screen.

screen-capture-2.jpg

You should recieve a message telling you the uninstall was successful.

screen-capture-3.jpg

1.2.2. Uninstall DiscussIt for Joomla! 1.6

To uninstall, first go to your Joomla! administration page and select 'Extensions' -> 'Extension Manager'

screen-capture.jpg

Click on 'Manage'

screen-capture.jpg

Type 'Discussit' into the text box labelled 'Filter:' and click 'Search'

screen-capture-1.jpg

Click the tick-box next to 'DiscussIt for Joomla 1.6 Package' to select the DiscussIt package for uninstallation.

screen-capture-2.png

Now click the 'Uninstall' button in the top right of the screen.

screen-capture-3.jpg

If the plugin has been successfully uninstalled you should see a message similar to this one:

screen-capture-4.jpg



2. Plugin Management


screen-capture-3.png

2.1 Key

This is where your discussit.com API key needs to go - if you don't yet have a DiscussIt API key you will need to sign-up for one here.

If you have lost your API key you can recover it by signing-in to your DiscussIt account at: http://account.discussit.com/ and clicking on 'Properties' for your site's entry on the page.

2.2 View Comment Link

This allows you to add a link underneath articles on the featured page to view the full article including comments. This is set to 'View / Add Comments' in the Joomla 1.5 plugin as article titles are not linkable by default in Joomla! 1.5. This is left blank by default in the Joomla! 1.6 plugin as article titles are linkable by default in Joomla! 1.6

2.3 Enable DiscussIt Link

Enabled by default - this adds a link back to discussit.com underneath your comments widget.

2.4 Show in All Articles

Enabled by default - this setting allows you to enable or disable comments on all articles except those in categories specified in 'Show in Categories' (see section 2.5 for more info).

Using {showcomments} or {nocomments} overrides this setting on the individual article - See section 3.1 for more information.

Please not that changing the value of this will change the functionality of 'Show in Categories,' which is covered next.

2.5 Show in Categories

Optional - Depending on what the 'Show in all Articles' settings are, this function will either disable or enable comments in all articles in the categories specified in the box.

Please note that {nocomments} and {showcomments} supersede this functionality.

2.6 Language

Set's the language to be used in the plugin.

Please note that that this does not affect the View Comments Link or the Comments Disabled text.

2.7 Widget Width

Default is 600 - This specifies the width (in pixels) of the comments widget so you can adjust it to best fit your template. Numerical values only.

Set this to 0 to make the widget to fill the width of the article

2.8 Widget Top Margin

Default is 0 - This allows you to set the space (in pexels) between the bottom of your article text and the top of the comments widget.

2.9 Comments Disabled Message

Optional - This allows you to append a message to the end of articles in which comments are switched off e.g: 'Comments disabled on this page'



3 Additional Features

3.1 Manual Enabling or Disabling Comments on Individual Articles.

You can manually enable comments on an article by adding the tag {showcomments} (including curly braces) to the beginning of your article text. this supersedes other plugin settings to ensure comments are always enabled on that article.

You can manually disable comments on an article by adding the tag {nocomments} (including curly braces) to the beginning of your article text. this supersedes other plugin settings to ensure comments are always disabled on that article.

3.2 Using DiscussIt widget as a Module

You can now use DiscussIt as a module. select the position you want the module to appear in and enable it, or create a custom position and add it to your articles using {loadposition } and select the articles you want it to appear in the modules settings

Enabling the module automatically disables the plugin to avoid loading the widget more than once. the module inherits the plugins properties although not all features are available.

[Back to top]