Naicum extensions

Using SmartIcons 2.0

General information

The SmartIcons extension is comprised of and component and a module. They are both installed at the same time during the extension installation and the module is published instead of the QuickIcon module normally found in any Joomla! site.

Interface

Being comprised of two separate parts, we will discus the extension accordingly, starting with the SmartIcons Module and continuing with the SmartIcons Component.

SmartIcons module

The module is what the administrator will most commonly see. There are two layouts for the module : grid layout and list layout.

The Grid layout is a common site for seasoned Joomla! administrators as it is the default layout for the QuickIcons module in Joomla! versions prior to 3.0

The List layout is the standard layout used for the QuickIcons module in Joomla! 3.0

The SmartIcons module look will also change based on how you organize your shortcuts. If your shortcuts are split into categories, the module will add tabs for each category. also based on the configuration of the component, the quickicon plugins can also be included in a separate tab.

After the installation of the extension your administration panel will look identical to what you are used to with the difference that the SmartIcons module will be displayed instead of the QuickIcons module.

SmartIcons component

The component is the “business” side of the extension and is where the module layout and shortcuts are going to be defined. Accessing the component is done using the administrator menu:

Once accessed, the component administrator panel looks like this:

The administration panel is divided into two sections : the shortcuts (Icon) and the tabs (Categories) layout.
In the Icon layout, all the shortcuts are visible with all their details visible:

  • Status - Shows whether the shortcut will be displayed in the module
  • Name - The text that will appear on the shortcut with the name of the category in which the shortcut is
  • Title - The title of the link
  • Display - Shows how the shortcut will be displayed. Options include:
    • Image and text
    • Icon and text
    • Image
    • Icon
    • Text
  • Target - The URL to which the shortcut points.

There are numerous actions available to the administrator :

  • New - creates a new shortcut
  • Edit - edits an existing, selected, shortcut. (Note: The administrator can easily edit a shortcut by clicking the name of the shortcut.
  • Publish - publishes a shortcut
  • Unpublish - unpublishes a shortcut
  • Check In - checks in an shortcut so that no other users can edit it.
  • Delete - deletes an icon.
  • Import - import shortcuts from a XML file
  • Export - export shortcuts defined in a XML file
  • Options - Opens a window for setting the default values for the shortcuts in the module and permissions for the component.

Selecting one or multiple shortcuts in the menu, using the checkboxes, grants the administrator the possibility to publish, unpublish, check in and delete multiple shortcuts at once.

 

The Categories layout uses the default category system in Joomla!. Each tab in SmartIcons is a category managed by the Categories extension in Joomla!
In the Category view, all the tabs are visible with are their details:

  • Title - The title of the tab and the text that will appear over the tag.
  • Published - Shows whether the tab is published or not.
  • Ordering - Shows the order of the tabs. When the order is modified, the tabs appear in the particular order specified:

Administration

Creating shortcuts

In order to create a new shortcut you must follow these steps:

  1. Go to the SmartIcons control panel.
  2. Click the “New” button, the new Icon view appears:

  1. Fill out the shortcut details:
    1. Icon name - the name that will appear under the icon of the shortcut (if the icon will be displayed)
    2. Link title - the title of the link of the shortcut (used for accessibility)
    3. Alternative text - the alternative text of the shortcut’s image.
    4. Display - Select how the shortcut will be displayed. Options include:
      1. Image and text
      2. Icon and text
      3. Image
      4. Icon
      5. Text
    5. Image/Icon - based on the previous selection either the Image or the Icon control will be available
      1. Image - The image that will appear in the shortcut. Click on the “Select” button to select an image from the “Media manager”.
      2. Icon - You can select an icon from Joomla!'s standard icon list to use for your shortcut
    6. Category - The tab in which the icon will appear
    7. State - The published state of the shortcut.
    8. Target - The URL of the shortcut. You can select any extension from Joomla using the drop-down box below the Target input box

*Note: If the target is an Joomla! internal link, the extension will automatically check to see if the user has sufficient privileges to access the link before showing the shortcut.

  1. Set the display settings:
    1. Bold - If set, the shortcut’s name will appear in bold
    2. Italic - If set, the shortcut’s name will be in italic font
    3. Underline - If set, the shortcut’s name will be underlined
    4. New window - If set, the link from the shortcut will be opened in a new window.
    5. Icon width - The width of the icon can be changed using this control (only valid in the grid layout)
    6. Icon height - The height of the icon can be changed using this control (only valid in the grid layout)
    7. Modal window - If set, the shortcut will open the link in an modal window
    8. Modal window width - The width of the modal window in which the shortcut will open
    9. Modal window height - The height of the modal window in which the shortcut will open
  2. Advanced options:
    1. Skip permission check - If set, the module will not check if the user has permission to view the shortcut and will just display it.
    2. Insert token - If set, a security token will be inserted in the link.
    3. URL Parameters - If the shortcut requires special parameters to be passed via the link, they can be inserted here. The %user% wildcard can be used when the user id of the user is required.

*Note: During the entire creation of the new shortcut, your progress can be seen in the "Grid layout icon preview” and "List layout preview".

Editing shortcuts

Edit a shortcut, simply click on an shortcuts name, or click the checkbox on the same row as it and click on Edit for the editing view to appear. The steps to editing the icon are the same as that of creating new shortcuts.

Creating Tabs

To create a new tab you must follow these steps:

  1. Go to the SmartIcons control panel
  2. Select the categories layout by clicking on the “Categories” entry in the administrator sub-menu
  3. Create a new Category as you would normally do with any other Joomla! component (Ex. the Content component)

*Note the extension does not support nested categories.

  1. Save the category.
  2. Add shortcuts to the new tab by creating new ones or by editing existing ones.

Reordering tabs

To rearrange tabs you must follow these steps:

  1. Go to the SmartIcons control panel
  2. Select the categories layout by clicking on the “Categories” entry in the administrator sub-menu
  3. Reorder the categories to your liking by using the order controls of the Category component.

 

Support

If you have any issues with your SmartIcons extension do not hesitate to contact us via the contact form on this website or via e-mail at : This email address is being protected from spambots. You need JavaScript enabled to view it. .


Copyright © 2014 Naicum extensions. All Rights Reserved.
Joomla! is Free Software released under the GNU General Public License.

Download PDF

The documentation is also available for download in PDF format.

PDFSmartIcons user manual

Buy SmartIcons

SmartIcons is available for purchase for the sum of 5€

Transaction time

All transactions are handled manually so please be patient if you do not receive the extension right away.

Thank you