Link directory tool - Documentation Ametys

The plugin link directory provides a back-office tool for link management.

Directory tool presentation
Inserting a link in the directory
Restricted access
Theme management
1. Version 2.13 or higher
2. Versions below 2.13
Link modification/deletion
Arrange links
Displaying links on the site

Directory tool presentation

Click on the Link directory button in the Home to open the Link Directory tool

This tool takes the form of a table.

It allows you to create, modify, delete or order links and classify them by theme.

You can customize the display of search results by selecting the columns of your choice.
Click on the icon to the right of the column of your choice.

You can:

- Sort the information in the selected column in ascending or descending order.
- Check or uncheck the columns you wish to display.

Internal links are clickable and open the page in a new tab.

Inserting a link in the directory

You can add 2 types of links:

an external link: link to an external site(http://..., https://...)
a link to a page on CMS: a link to a page on the current site or another site managed by Ametys

1/ Click on the menu New link and select the type of link you wish to create :

2/ In the dialog box that opens, enter the link information

Please note that some fields are only available in version 2.6 of the plugin

Field	Description	Mandatory
Url	Present only for a link "to an external URL " - no IP restriction set in the administrator configuration. Url complete link. Should be in the form http://... or https://...	Yes
URL external	Present only for a link "to an external URL " - with IP restriction set in administrator configuration Url complete external link to IP configuration (to be used for IP addresses outside the network) Should be http://... or https://...	Yes
URL internal	Present only for a link "to an external URL " - with IP restriction set in admin configuration Url complete internal link to IP configuration (to be used for network-internal IP addresses) Should be http://... or https://...	Yes
Page	Present only for a link "to a page on CMS" Select a page from the current site or another site.	Yes
Link text	Text to be displayed instead of the link (optional) If this is empty,url will be displayed.	No
Short description	Additional help in the link text, displayed as a tooltip on mouse-over (e.g. "Go to ...", "Visit the site of ...").	No
Description	Multi-line link description (optional)	No
Additional page	An additional page to be chosen from the sitemap. (help or documentation page, for example) Version 2.6 onwards!	No
Vignette	Link illustration or pictogram (optional)	No
Alternative vignette	Alternative thumbnail text when image cannot be displayed	No
Color	Color associated with the link. From version 2.6 !	No
Themes	Link themes	No
Dynamic information	Select a dynamic information provider. See Third-party service integration for more information. From version 2.1 ! Since version 2.14.0, the "Dummy information (for testing purposes)" entry has been added. This entry provides dummy information for testing purposes.	No
Status	Choose from a drop-down list: Normal / New / Out of order Status allows you to modify the display of the link according to its status. From version 2.6 !	No

3/ Select themes

Click on the button in the "Themes" field to select themes.

From version 2.13 onwards, you can select themes from those defined by the graphic charter or from those defined in the "Themes" tool.

For versions below 2.13, the dialog box for theme selection is as follows:

Restricted access

From version 2.6 onwards, link access limitation is carried out in a dedicated tool.

To restrict access to a link, select the link and click on the Restrict access.

The link restriction tool opens in the central area.

The directory link restriction tool works in the same way as page access restriction.

For versions 2.5 and below, access is restricted directly in the link creation/modification dialog box.

with

Limited to logged-in users	Check this box to restrict access to the link to logged-in users only. If the box is checked, the following settings "Restricted to users" and "Restricted to groups" will be ignored.
Limited to users	Restricts access to the link to selected users. This value has no effect if "Restricted to logged-in users" is checked.
Limited to groups	Restricts access to the link to selected groups. This value has no effect if "Restricted to logged-in users" is checked.

Theme management

Version 2.13 or higher

Starting with version 2.13, there are 2 types of themes:

the themes conveyed by the graphic charter
personalized themes, by language

Graphic themes cannot be modified in the back office.

Click on "Themes" to add, modify or delete customized themes.

The link theming tool opens:

A theme consists of a label and a description. The identifier (for internal use and for the charter creator) is calculated automatically.

The themes are defined for a given language.

Versions below 2.13

Click on "Manage themes" to add, modify or delete themes. It is also possible to manage themes directly from the dialog box for adding or modifying a link.

A theme consists of a single label. The identifier (for internal use and for the charter creator) is calculated automatically.

Link modification/deletion

Select the link you wish to modify or delete in the table, then click on the button in the ribbon corresponding to the desired action.

Arrange links

Use the "To top", "Up", "Down" and "To bottom" buttons to change the order in which links are displayed.

Displaying links on the site

To display a list of links on the site, you need to add the "Links directory" service.