joomla:autolinks:documentation

Dokumentation

AutoLinks ships with a Administrator Component, accessible through your Joomla! Administrator Backend: Components » Automatic Links:


This view allows to:

  • Publish one or more selected Links. When being published, these links are active.
  • Unpublish one or more selected Links. When being unpublished, these links are inactive.
  • Trash one ore more selected Links. This removes these links.
  • Edit the currently selected Link.
  • New creates a new Link.



For all Links directing to a Content Article, and when the related Content Article is unpublished, this shown in the Links To column (see example in list item #3). Such Links are suspended from being created automatically. To reactivate such links, reactivate the related Content Article.

Multiple Languages

When using multiple languages, create the link with the Expression in each language. See the picture above for a example in liste item #1 and #2.



Each Link allows to be defined with various parameters and properties:

Expression

The Expression to be searched for. May be a Phrase or Regular Expression. When using a Regular Expression, make sure to use the starting and ending delimiters of /. Regular Expression options, such as /i for case-insensitive matching are supported.

Any Regular Expression without the starting and ending delimiters will be interpreted as phrase.

AutoLinks uses the found Expression, matching this Expression (either as Phrase or Regular Expression) as Title for the Link. To prevent nested Links being caused by duplicate found Expressions, only the first found Expression is used for the link. To influence this behaviour use the Order of AutoLinks to create a Link hierarchy.

Description

A description for this link, which may later be used in the following ways:

  • As title property for any Link inline of the Article
  • As additional description to the Link for any link shown at the Top or the Bottom of the Article


HTML in the Description is allowed. When filling the title property, all HTML tags are removed. When the description is used in the Top or Bottom of the Article, the full HTML of the description is used. This behaviour is able to be customized with the AutoLinks Templates.

The target to which the Link shall lead to:

  • Redirect to URL: Use a fully qualified URL for this Link
  • Redirect to Article: Choose the Article to link to from the Dialog showing with the [Select] button



The behaviour of each link is described through this multiple-select property sheet. Select the properties for this link as wanted, the following limitations are applied by AutoLinks:

  • The Expression is Case Sensitive: Tell AutoLinks to make a case-sensitive match for the Expression. Only applicable if the Expression is a phrase, unrequired for a Regular Expression where the case match is to be part of the Regular Expression.
  • Show this Link in the Section View: Makes this link active only when the Article Section View is shown in the Frontend. (Commercial Unlimited License only)
  • Show this Link in the Category View: Makes this link active only when the Article Category View is shown in the Frontend. (Commercial Unlimited License only)
  • Show this Link in the Article View: Makes this link active only when the Article itself is shown in the Frontend.
  • Show this Link Inline of the Article: Makes the link appear as part of the Article Text.
  • Show this Link at the Top of the Article: Makes the link appear at the top of the Article, with the description. Inside the Article Text the expression is left unchanged.
  • Show this Link at the End of the Article: Makes the link appear at the end of the Article, with the description. Inside the Article Text a bookmark is set to the link in the article end.
  • Create a inline Bookmark to the Link when shown at the Top of the Article: Inside the Article Text the Expression is set to a bookmark directing to the link when shown in the article top.
  • Create a inline Bookmark Link to the Link when shown at the End of the Article: Inside the Article Text the Expression is set to a bookmark directing to the link when shown in the article end.
  • Open this link in a new Browser Window or Tab: Makes the link such that a new browser window or tab is opened when the link is clicked.



You may assign a link to show in both locations, the top and bottom of the Article. When also selecting to Bookmark this link inside the Article, the bookmark to the top of the Article takes precedence. This to avoid nesting Bookmarks in the Article.

(Commercial Unlimited License only)

When using this Link as inline Link in the Article, a alternate template for creating this link may get used. See Creating and Using a new Template for inline Links on more in this.
Enter the template name of the alternate template created for this Link here. If you add the .php file extension for the alternate template, it will get removed by the Manager on save of the entry.

Make sure you follow the directions for Creating and Using a new Template and to have a valid template file. Otherwise Joomla! will show a error message describing that the layout is missing.



(Commercial Unlimited License only)

Select the Sections and/or Categories for which this Link is active for. Also if this Link is active for all Uncategorized Content. This allows to determine where the Link may appear.

Please note that:

  • All Sections » All Categories does also include all Uncategorized Content (the “static” content).
  • Uncategorized Content does select the Uncategorized Content (“static” content) only.



Published

Allows to set this Link into Published and active State, or Unpublished and deactive State.

For Links to Content Items, AutoLinks does check for the Publish Status of the Content Item linked to. If the linked Content Item is unpublished, pending in time or already expired, the AutoLink to it is suspended (but still published). The AutoLinks Manager will show a status message of Unpublished on such Links.



AutoLinks uses Template File for creating the links, see Customizing the AutoLinks Templates for more on this…

(Commercial Unlimited License only)

AutLinks also allows to create a Cross-Link to another Article directly within the Article Content. To create such a link use the following Tag in your Content:

AutoLinks Content Tag

{autolink <content-id>}

<content-id> ... is the Content ID of the Article to create a link to


AutoLinks Content Tag Example

This links to our Article on {autolink 54}...


The inserted link is created with the title of the Article being linked to. Each link is created dynamically on page load, allowing to change the article title at any time and these changes being reflected at the same time throughout your site.