Tags support in jDownloads

Introduction



As shown in the picture opposite jDownloads supports the Joomla! Content Tags system.

This article will show the ways in which Joomla! Content Tags may be created, added to or removed from jD Categories and  Downloads. 

It is important to note that jD Categories and Downloads are just as much Content as regular Joomla! categories and articles.
article tags01
The words 'tag' and 'Tag' are much used to describe a whole host of different items.  For example the html character sequence such as  denotes the start of emboldening a portion of text, and is often referred to as a tag. It should be  referred to  as an HTML tag.

In these notes the Joomla! Content Tags, such as the blue boxes above, are written here as a Tag or Tags to avoid having to write Joomla! Content Tags.  That is Tag with a capital T denotes a Joomla! Content Tag.

This article does not consider the best ways of using Tags as there are numerous articles on the web that explain the usage of Tags.  However an appendix shows some examples.

All we need note at this juncture is that Tags allow a much greater freedom in the way Downloads may be 'linked'. The same applies to Categories.

If you are not familiar with Tags then a good place to start is the short note How To Use Content Tags in Joomla! (opens in a new tab/page)

Tags may be created either directly in Joomla! using the Tags component or directly in jDownloads from the Back End or from the Front End.

Tags in a Download may be added in the Front End or the Back End but they can only be added to a Category in the Back End.

To show Tags they need to be enabled in the jDownloads menu and the placeholder needs to be in the relevant layout

Any Tags created in jDownloads are 'regular' Tags and may be used in articles and other content just as if they had been created in the Joomla! Tags Component.

Configure Tags Component


NB
Only Tags for Downloads may be added in the front end.

When configuring the Tags Component your first view will like the image opposite.

If you are only using Tags in jDownloads then you do not need to 'Add your First Tag'

Note the V4 button options2 button on the top right.  We will be using this to configure the Tags component for use in jDownloads.
V4 Tags ComponentFirst View

Allow Creating in jD Front End

In order to allow Tags to be managed from the jDownloads Front End it is neccessary to set the relevant User Group permissions in the Tags Component. 
So select the Tags Component  V4 tags component and then click on the V4 button options (top right).
Next select the V4 button permissions Tab.  This will bring up the permissions settings screen for the User Groups.  Select the relevant User Group that is to be allowed to manage Tags in the Front End with Create, Delete, Edit and Edit State.

Use the pulldowns for the permissions you wish the UG to have and choose 'Allowed'.  A 'tick' mark will appear alongside. NB Never choose Deny as it has unwelcome 'side effects'.

Then ensure you do a V4 button save to check those permissions have been set.
article tags15

The view opposite shows the Result of the V4 button save.

What is happening is that the permissions are being propagated as required.

Doing a V4 button save close also propagates, but I always like to see the confirmation!

V4-permission02

Set Entry Mode to AJAX


One thing that needs to be checked is that in Tag Component, Options - Data Entry tab the 'Tag Entry Mode' option must be set to Ajax mode for tags to work in jDownloads. 

The 'Nested' Mode is not supported in jDownloads.  AJAX mode is the default.

article tags05

Adding Tags in Backend


Adding Tags in the Backend to a Category or to a Download is the same procedure.

Much of what follows here also applies to adding Tags in the Frontend to Downloads.

In this example we will add a Tag called 'PDF-file'.

When creating or editting a Download, the V4 general tab tab has a side  panel that allows selecting properties such as Status, Category and similar. 

One of these properties is Tags as shown opposite.

First use the pull-down to see if there the required Tag has already been created.
V4 tag pull downJust click on the appropriate Tag to add it. The 'pull-down will remain showing to enable adding several Tags. As the Tags are added the look like below.
V4 tags added01Each Tag has a small x V4 tag delete01 If you click on it the Tag will be removed from the current selection

V4 Tags Add01J
In this example a Tag 'PDF-file' is being entered as in image V4 number 1When complete use the Enter (Return) key to signify the Tag is complete.

This then gives a view as shown inV4 number 2.


V4 tag enter01V4 tag enter02

Adding Tags in Frontend

Reminder As described above, it is essential to set the relevant Permissions in the Tag Component for any User Group allowed to edit or create Tags in the front end.

After setting up the Tags component, then Adding Tags in the Frontend is basically the same as adding them in the Backend.

The Tags field in the Frontend upload form looks much the same as the one in the Backend. 

In the Frontend it appears in the Publishing tab

 article tags02
But we need to make the Tags field appears in the edit/create Download form and also to decide whether the User Group will or will not be able to create new Tags.

The ability to add Tags and create Tags is controlled from the V4 button user group settings. This allows different abilities for different User Groups.
Select the appropriate User Group in V4 button user group settings. Then select  theV4 tab group creation edit tab.
If the User Group that will be allowed to create Tags scroll down to find the 'Allow creating tags and ensure it is set to Yes as indicatedarticle tags createotherwise set to V4 create tags No.
Continue to scroll down to the V4 data field section and in the V4 tab publishing section  section locate  the Tags tickbox and ensure it is 'ticked' as shown.V4 allow tags tickbox

The default setting is 'unticked', that is by default User Groups are not allowed to add any Tags to Downloads.


Remember: It is also necessary to set the Tags component Create permission to Allowed as noted earlier.

View Tags in the Control Panel


The jDownloads Control Panel has a good view of the Tags that are being used in Categories and Downloads.

Clicking on a Tag will show the relevent Categories or Downloads that have that Tag.
tags46

View Access and Permissions

If you have set some permissions that say restrict downloading to Registered or to other specific user groups then also remember to set the view Access on the Category or Download appropriately. This avoids showing the 'you do not have permission' message.

If, for example, you have set a Download to only say Registered users may download then also set View Access to Registered.

If it is left at Public then the Download, or Category, will be included in the relevant Tag listing but if a user clicks on it they will get the message 'You do not have Permission' or similar.

Menu Settings for Tags

Each jDownloads menu type that shows Categories or Downloads has a field, Show Tags, that allows Tags to be shown or hidden when that menu item is used.

The default setting is Global.  That is it will use the same setting as specified in the Tags Component Options.

This ensures that existing menus will not need modification, but at the same time gives another degree of flexibility.

article tags03A
Specifically the relevant menu types are listed opposite.

In most menu types the "Show Tags" field is in the List Layouts tab, but in the Single Download type it is in the Options tab.
  • List All Categories (Default);
  • List All Downloads;
  • List my Downloads;
  • Single Category;
  • Single Download.

{tag} placeholder in Layouts

To show Tags associated with a Category or a Download then the place holder {tag} is already included in the following Standard Layout Types:
  • Categories
  • Subcategories
  • Category
  • Downloads
  • Download Details
In these standard layouts it is located in the main part of the layout.

For  Download and Download Details layouts typically have 
placeholder is not available for Summary layouts.

More Configuration Items

Setting Display
If the Tags component is left as installed then if you click on a Tag it will just show a simple linked list of all the Downloads with that Tag as illustrated in the image immediately opposite.
If you go tothe Tag component and select V4 button optionsand then V4 tab tagged itemsthen in option 'Default Tagged Items Layout' select 'Compact layout' the view is less agressive as shown on the far right.
V4 tag07tags07A


The Tags component provides many options for showing how the list is displayed.

To access these click on the Options Button in the Tags Component.

This shows a whole set of tabs to allow customising as illustrated opposite.

It is not the intention here to discuss all of this as there are several web articles on the topic of configuring the Tags list. 

However it is useful to note one specific item which if enabled will show the Short Description associated with the Tags List.

tags05
After setting  the field Item Description in the Tagged Items Options tab to Show then the Short Description from the Download will be shown in the Tag list.

You can limit the size of the description shown by setting the Maximum Characters option.
 tags02
The result is then as shown opposite. 

Of course one may add appropriate styling and organise the layout in different ways.

Note: Presently  the images associated with a Download are not shown.
tags08

Limitation

jDownloads has a directory based structure with Categories and Downloads just like Joomla! with Categories and Articles.  An added feature in the Tags in Joomla!  Articles is that the Tags system checks if the Category containing the Article is Published.  If the Category is Unpublished then the Article is not listed in a Tags list view. 

This feature is not available in jDownloads.

The reason for this is that the reference to the Categories table in the Joomla! core code is hard coded to the Joomla! categories database!  The Joomla! people are 'unwilling' to change that aspect. 
So if you want to prevent Tags associated with an unpublished  Category listing the Downloads in that Category, then it is necessary to unpublish both the Category itself and the Downloads in that Category. 

It is of course very simple in the jD backend to unpublish all the Downloads. Go to the Downloads section, use the Select Category box to select the category.  This will list all the Downloads in that Category together with those in subcategories of the selected category. 

Next click on the tick box beside the Title column.  This selects all the items listed so then click on Unpublish button.

We must make it clear that Tags are supported in both jD Categories and Downloads.
Note to Author: need to add menu examples when Tags challenge resolved.

ColinM, October 2019, updated August 2020 , June 2023

Print Email

We use cookies

We use cookies on our website. Some of them are essential for the operation of the site, while others help us to improve this site and the user experience (tracking cookies). You can decide for yourself whether you want to allow cookies or not. Please note that if you reject them, you may not be able to use all the functionalities of the site.