Loading...
 

tikicon

According to a comment, this can't work in Tikiwiki without breaking compatibility.
This concept is also mentioned in IconThemes.


tikicon is a new function available to smarty templates to support two things:

1) Icon themes - tikicon allows icons to be overidden in the same way that smarty allows templates to be over ridden. This allows a site to mix and match themes with icon sets for a more customized look with less work.
2) Better support of WAI accessibility for the handicapped - tikicon automatically generates any additional HTML needed to enable accessibility devices to function.

tikicon is used in your templates to replace the hard coded image tags that are used for icons through out Tiki. In a template it would look like this:

{$tikicon igroup="admin" iname="blogs" iexplain="Configure blog settings" class="somecssclass"}

Very similar to an image tag in usage. These are the defined attributes:

igroup: We have so many icons in Tiki that it was time to organize them in some way. This also allows us to have a seperate "nextPage" icon for forums, one for image galleries, and one for wiki.

iname: This is the base name of the icon that you want to use. Notice that there is no extension like .png, .gif, ect. This is intentional and tikicon will allow any type of image to be used and find the correct file for you. It will also generate correctly formed HTML for that file class.

iexplain: This is equivelent to the alt attribute in an img tag. This will generate the alt tag in the page, but will also be used to correctly generate HTML to allow screen readers and other accessibility devices for the physically challenged to function correctly.

These are the only three attributes specific to tikicon. Any other attributes, such as class above, are pased through to the HTML tag unaltered.

The image file used for the icon is selected by searching a defined set of folders including the current icon theme from the admin-general panel, the current site theme, and a default set of core Tiki icons. Each icon is treated seperately, so icon themes or site themes can overide only the individual icons they want to change. Tikicon will automatically fall back to the defaults if there is no override. It works much like the template override system that allows themes. So the above command might generate:

<img src="img\icons\loveandkisses\admin\blogs.png" alt="="Configure blog settings" class="somecssclass"> if the icon theme is loveandkisses and it overides that icon.

<img src="styles\classicarcade\admin\blogs.gif" alt="="Configure blog settings" class="somecssclass"> if the site theme is classicarcade and it overides that icon.

<img src="img\icons\default\admin\blogs.jpg" alt="="Configure blog settings" class="somecssclass"> if the neithier the icon theme or site theme override the admin icons.


Details to follow when I've had more sleep biggrin, but please send questions/comments to me or to the email list.


Page last modified on Sunday 25 April 2004 02:48:45 GMT-0000

Upcoming Events

1)  Thu 19 Dec 2019 14:00 GMT-0000
Roundtable Meeting 2019 12

Why Register?

Register at tiki.org and you'll be able to use the account at any *.tiki.org site, thanks to the InterTiki feature. A valid email address is required to receive site notifications and occasional newsletters. You can opt out of these items at any time.