Pretty Links manual

Below you will find the following manuals for "Pretty Links":

• Installing Pretty Links with the download
• Installing Pretty Links with Install from Web
• Configuration of Pretty Links
• Assign or adjust module position / page view Pretty Links
• Update Pretty Links
• Uninstall Pretty Links

Installing Pretty Links with the download

These steps download Pretty Links and install it in Joomla by uploading the file.

1. Download the Pretty Links module from GitHub (free, no account needed):
   
   Download Pretty Links
   
   Under Assets, click the ZIP file mod_prettylinks-1.1.0.zip (1). A newer version has a higher version number in its name. The file is downloaded. Do not unzip it, and remember where you saved it.
   
   
2. Open the back-end (administrator) of Joomla, usually at https://<yourdomain>/administrator/. Enter your Username (1) and Password (2) of a Super User account and click Log in (3).
   
   
3. In the menu on the left, click System (1).
   
   
4. In the block Install, click Extensions (1).
   
   
5. The tab Upload Package File (1) is open. Drag the ZIP file into the frame (2), or click the green button Or browse for file (3), select the file and click Open.
   
   
6. The module is installed right away. The message "Installation of the module was successful." appears (1).
   
   
7. You can now set up the module. See Configuration of Pretty Links.

Installing Pretty Links with Install from Web

These steps install Pretty Links straight from the Joomla Extensions Directory, without downloading a file. The tab Install from Web is provided by the plugin Installer - Install from Web. If you do not see the tab, click System, then Plugins, search for "Install from Web" and enable the plugin.

1. Log in to the back-end (administrator) of Joomla with a Super User account. You usually find it at https://<yourdomain>/administrator/. Then click System in the menu on the left, as in steps 2 and 3 of the first manual.
2. In the block Install, click Extensions (1).
   
   
3. Click the tab Install from Web (1). Type Pretty Links in the search field (2) and click the magnifying glass (3).
   
   
4. Click Pretty Links in the results (1).
   
   
5. Click the green button Install (1).
   
   
6. Joomla shows the name of the extension and the address it is installed from. Confirm with the blue button Install (1).
   
   
7. The module is installed. The message "Installation of the module was successful." appears (1).
   
   
8. The Joomla Extensions Directory can offer an older version than GitHub. When this manual was written, Joomla installed version 1.0.1 this way. Then update the module with the manual Update Pretty Links.
9. You can now set up the module. See Configuration of Pretty Links.

Configuration of Pretty Links

These steps set up the module after you installed it with one of the manuals above. The example makes a row of three contact links at the top of the website.

1. Log in to the back-end (administrator) of Joomla with a Super User account. You usually find it at https://<yourdomain>/administrator/. Then click System in the menu on the left, as in steps 2 and 3 of the first manual.
2. In the block Manage, click Site Modules (1).
   
   
3. The installation has added a module called Pretty Links. It is not published yet and has no position. Click its title (1).
   
   
4. On the tab Module:
   • Change the Title (1), for example to Contact links.
   • With Title on the right (2) you choose whether the title is shown on the website: Show or Hide.
   • Choose the Position (3) of your template where the links should appear. In this example with the Cassiopeia template: Top Bar [topbar].
   • Set Status (4) to Published. A new module is always unpublished.
   
   
   
5. Click the tab Pretty Links (1). Under Settings you find the settings for all links of this module:
   • Vertical layout (2): choose Yes to show the links below each other, or No to show them next to each other.
   • Link position (3): align the links on the left, in the centre or on the right.
   
   
   
6. Under Links one empty link is ready. Fill in the fields:
   • Icon class (1): the class of a Font Awesome icon shown in front of the text, for example fas fa-envelope for an envelope. Leave it empty for no icon. Font Awesome is loaded automatically when a link has an icon.
   • Text (2): the text of the link. This field is required; screen readers also read the text when it is hidden on mobile.
   • URL (3): where the link goes. This can be a web address (https://...), a path on your own site (/contact), an email address (mailto:This email address is being protected from spambots. You need JavaScript enabled to view it.) or a phone number (tel:+31201234567).
   • Target (4): open the link in the same window (SELF) or in a new window (BLANK).
   • Hide text on mobile (5): choose Yes to show only the icon on small screens.
   • With the green plus button (6) you add another link below this one, and with the red minus button (7) you remove this link. With the arrows on the left you change the order.
   
   
   
7. Click the tab Menu Assignment (1) and choose at Module Assignment (2) on which pages the module is shown:
   • On all pages: on every page of the website.
   • No pages: on no page at all.
   • Only on the pages selected: only on the menu items you tick in the list (3).
   • On all pages except those selected: on every page, except the menu items you tick.
   
   
   
8. Click Save (1) to save and keep the module open, so you can check the result on your website and adjust it. Click Save & Close (2) when you are done.
   
   
9. The result on the website (1):
   
   

You can find examples here: https://extensions.tlwebdesign.nl/en/pretty-links

Assign or adjust module position / page view Pretty Links

These steps move Pretty Links to another module position or change the pages it is shown on.

1. Log in to the back-end (administrator) of Joomla with a Super User account. You usually find it at https://<yourdomain>/administrator/. Then click System in the menu on the left, as in steps 2 and 3 of the first manual.
2. In the block Manage, click Site Modules and then click the title of your Pretty Links module. The column Type shows which modules are of the type Pretty Links.
   
   
3. On the tab Module, choose the new Position (3) on the right.
   
   
4. Click the tab Menu Assignment (1) and choose at Module Assignment (2) on which pages the module is shown. With "Only on the pages selected" and "On all pages except those selected" you tick the menu items in the list (3).
   
   
5. Click Save & Close and check on your website that the module is shown on the right pages.

Update Pretty Links

When a new version is available, Joomla shows it in the back-end, just like updates of other extensions. Important: always make a backup of your website before updating!

1. Log in to the back-end (administrator) of Joomla with a Super User account.
2. On the Home Dashboard, in the block Notifications, click Updates are available! (1). You can also click System and then, in the block Update, Extensions.
   
   
3. Tick the box in front of Pretty Links (1) and click Update (2). In this example the module goes from version 1.0.1 to 1.1.0.
   
   
4. The message "Updating module was successful." appears (1).
   
   
5. Check on your website that Pretty Links still works properly.

Uninstall Pretty Links

If you no longer want to use Pretty Links, you can uninstall it. All Pretty Links modules you made are removed as well.

1. Log in to the back-end (administrator) of Joomla with a Super User account. You usually find it at https://<yourdomain>/administrator/. Then click System in the menu on the left, as in steps 2 and 3 of the first manual.
2. In the block Manage, click Extensions (1).
   
   
3. Type Pretty Links in the search field (1) and click the magnifying glass (2).
   
   
4. Tick the box in front of Pretty Links (1), click Actions (2) and then Uninstall (3).
   
   
5. Joomla asks whether you are sure. Click Yes (1).
   
   
6. The extension is removed. A message confirms that uninstalling the module was successful (1).
   
   

If you run into a problem, let us know with the button below. This is the only way we can improve this extension.

Report problem

If you are satisfied, please leave a review on the Joomla Extensions Directory: https://extensions.joomla.org/extension/pretty-links/

Thanks in advance!