ICON -- small documentation graphic or icon of common attachment types
Generates a small graphic image from the set attached to
DocumentGraphics.
Images typically have a 16x16 pixel size.
You can select a specific image by name, or you can give a full filename, in which case the type of the file will be used to select one of a collection of common file type icons.
If you specify an icon which cannot be found, the one specified in the
default
parameter will be used (and if that fails, the
else
icon will be used)
Parameters
Parameter |
Description |
Default |
default |
default icon to use if requested icon is not found |
|
alt |
alt text to be added to the HTML img tag |
|
quote |
allows you to control the quote used in the generated HTML |
" |
"filename or icon name" |
requested icon |
else |
Examples
-
%ICON{"flag-gray"}%
displays as
-
%ICON{"pdf"}%
displays as
-
%ICON{"docx" default="doc"}%
displays as
-
%ICON{"smile.pdf"}%
displays as
-
%ICON{"/dont/you/dare/smile.pdf"}%
returns
-
%ICON{"data.unknown" alt="Unknown file type"}%
displays as
-
%ICON{"data.unknown"}%
displays as
-
%ICON{"http://trunk.foswiki.org/pub/System/DocumentGraphics/xsl.gif"}%
displays
- Graphics:
arrowbright
, bubble
, choice-yes
, hand
- File types:
bmp
, doc
, gif
, hlp
, html
, mp3
, pdf
, ppt
, txt
, xls
, xml
, zip
If you find that ICON is producing broken HTML when it is used in another macro e.g. for formatting search results, then this may be because it is
using the wrong kind of quotes for the context. In this case you can control the quotes it uses using the
quote
parameter. For example
You can also use formatting tokens such as
$quot
and
$dollar
in
quote
.
ICONURL,
ICONURLPATH,
DocumentGraphics