Tags support in jDownloads

The Joomla! Content Tags are integrated in jDownloads.
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.

The words 'tag' and 'Tag' are much used to describe a whole host of different items.  For example the html character sequence such as  <b> 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 opposite, 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 associated and shown.  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)
article tags01

The notes below are organised into the following sections.
  1. adding Tags from the Back End;
  2. adding Tags from the Front End, including the relevant User Groups Settings;
  3. adding Tags using the batch facility, add same Tag to multiple Downloads;
  4. Using Tags from the jDownloads Control Panel;
  5. View Access and Permissions;
  6. Setting the jDownloads Menu items to permit Tags;
  7. Using the {tags} placeholder in Layouts to show Tags;
  8. Configuring in Tags Component;
  9. Limitation when unpublishing a Category;
  10. Examples.
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 may be added to a Download from either the Front End or the Back End but they can only be added to a Category from the Back End.  To show Tags they need to be enabled in the jDownloads menu and the {tags} placeholder needs to be in the relevant layout.  In the picture opposite the {tags} placeholder is in the current Files layout as described in the Layouts section at the end of this article.

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.


1. Adding Tags from Backend to jDownloads Categories and Downloads

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

article tags01A article tags01B
The Tags input field is in the Content tab on the righthand side.

To add a Tag either just start typing into the field or click on the field to show a selection list of existing Tags.
article tags01D
To create a new Tag type the name of the Tag then just press the Enter (or Return) key.  Note the name of the new Tag must be unique. article tags01EE article tags01FF

2. Adding Tags to Downloads from Frontend


Note
It is also essential to set the relevant Permissions in the Tag Component for the User Group. Please see the section below Setting Permissions in the in Tags Component setup before you attempt to add Tags from the Front End.
After setting up the Tags component settings, then Adding Tags in the Frontend is basically the same as adding them in the Backend.  The Tags field in the upload form looks much the same as the one in the Backend.  In the front End it appears in the Publishing tab

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.

Both the ability to add Tags and create Tags are controlled from the User Groups Settings.  This allows different abilities for different User Groups.
article tags02
The first thing to ensure is in the User Groups Settings - Group Creation/Editing Settings section is that the Tags 'tick' box is 'ticked' for each User Group that will be allowed to add existing Tags, and subject to the 'allow creating Tags' noted below, is also allowed to create new tags.   The default setting is 'unticked', that is by default User Groups are not allowed to add any Tags to Downloads.
 
article tags02D
Only 'tick' the 'Allow custom tags' field if the User Group is to be allowed to create new Tags directly in jDownloads.

article tags02E

3. Adding Tags using the Batch facility
Sometimes there is a need to add the same Tag to multiple Downloads. Using the jDownloads Batch facility simplifies the process. In the backend it enables adding the same Tag to selected Downloads that are in a specified category and its subcategories.

The first step is to go to Downloads and by using the Search Tools select the relevant Category or sub category, which in this example is the 'Dated Cats' category.
tags41

This lists all the Downloads in that Category and its subcategories as illustrated opposite.

In this example the selected Downloads are actually in separate sub -categories. 
tags42
To add the required Tag to all of the selected Downloads click on the tags45png   button on the control bar.

This will give a view as illustrated opposite.

Ensure you select the 'parent ' Category or sub category, that you have selected the required Tag and, most importantly, that No is selected in the Copy/Move choices.

Then click on the Process button which will now add the Tag to all the selected Downloads.
tags43

4. Using Tags from the jDownloads 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 shows the relevent catesories or Downloads
tags46

5. View Access and Permissions - avoiding 'you do not have permission'.
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.

If for example you have set a Download to only say Registered 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.

6. Menu Settings to Allow Tags to be shown
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 for Tags in the Joomla! global setup. This ensures that existing menus will not need modification, but at the same time gives another degree of flexibility.

Specifically the relevant menu types are listed below.

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.
article tags03A

7. The {tag} placeholder in Layouts
To show Tags associated with a Category or a Download then the {tags} placeholder needs to appear in the active layout. The position of the placeholder in the layout controls where the Tags will appear.The {tags} place holder is already included in the following Standard Layout Types:
  • Categories
  • Category
  • Files
  • Details
In these standard layouts it is located in the main "Edit Layout" part typically on a line by itself as  <div class="jd_clear">{tags}</div> .

The jd_cear class is effectively a new line so that the Tags appear on a line by themselves.
It is desirable to put the Tags on their own line as they standout better that way and also because the number of Tags associated with a Category or a Download is not known.

In the Details Layout it is typically just the placeholder itself at the very end of the layout.  Support for the {tags} placeholder is not available for Summary layouts.

8. Configuring Tags Component

Setting Permission to allow Tag creation from Front End
In order to allow allow Tags to be set from the jDownload Front End it is neccessary to set the relevant User Group permissions in the Tag Component.

So in Components select the Tags Component and then click on the Options Button (top right) and then select the Permissions Tab.

This will bring up the permissions settings screen for the User Groups. So select the relevant User Group that is allowed to create Downloads.
And obviously repeat for all those User Groups allowed to upload.Then use the puldowns for Create and choose Allowed.  A 'tick' mark will appear alongside.

Also for do the same for the Edit and Delete permissions as the example opposite shows if you want to give that ability.
article tags15
The view opposite shows the Result of the Save.

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

Doing a Save & Close also propagates, but I always like to see the confirmation!
article tags15A
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.
tags07


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.

Also see below about setting the 'Entry Mode' to Ajax.
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.

Note: Presently  the images associated with a Download are not shown.
tags06
The result is then as shown opposite. 

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

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' field must be set to Ajax mode for tags to work in jDownloads. 

The 'Nested' Mode is not supported.
AJAX mode is the default.
article tags05

9. 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.

Appendix - Some Examples
The following gives examples of the use of two Tag related menu items

One useful menu item is the "Compact list of tagged items" type where one specifies the specific tag  whose items are to be listed.

As shown opposite this may optionally have a description about the tag type, and various images.

The main purpose of the menu item is to list all the related articles and Downloads that have been 'tagged' with that Tag, which in this example is 'pdf download'.

The listing has an option to select which date is shown.  Probably the most useful is the 'Modified Date' as illustrated.

Note that with jDownloads in order for the associated date to be changed then field "Mark Download as Updated" has to be set to Yes. 

This is deliberate so that the person carrying out the edit of a Download can select whether the change is actually an update. 
article tags11
For example correcting or extending the description part of an update may or may not be considered as an update.   jDownloads cannot make such decisions itself to satisfy all situations.  One can leave the field set to Yes of course so that any change will rate as an Update and always change the modification date.

Another useful menu item is the 'List of all tags' item.

This gives a view such as opposite, which can be a little disjointed in view.

Clicking on one of the tag names will then list all the items with that tag
article tags12

 


One can of course change the view by adding CSS such as illustrated opposite.

Here the CSS for a border and some separating padding has been added.
style="border:2px solid grey;padding:10px;}

The menu supports selection of number of columns.
article tags13

 

ColinM, October 2019

Print Email

This site uses cookies. By continuing to browse the site, you are agreeing to our use of cookies.