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
"filename or icon name" requested icon else
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 "

Examples

  • %ICON{"flag-gray"}% displays as flag-gray
  • %ICON{"pdf"}% displays as pdf
  • %ICON{"docx" default="doc"}% displays as docx
  • %ICON{"smile.pdf"}% displays as smile.pdf
  • %ICON{"/dont/you/dare/smile.pdf"}% returns /dont/you/dare/smile.pdf
  • %ICON{"data.unknown" alt="Unknown file type"}% displays as Unknown file type
  • %ICON{"data.unknown"}% displays as data.unknown
  • %ICON{"http://trunk.foswiki.org/pub/System/DocumentGraphics/xsl.gif"}% displays http://trunk.foswiki.org/pub/System/DocumentGraphics/xsl.gif

  • Graphics: arrowbright arrowbright, bubble bubble, choice-yes choice-yes, hand hand
  • File types: bmp bmp, doc doc, gif gif, hlp hlp, html html, mp3 mp3, pdf pdf, ppt ppt, txt txt, xls xls, xml xml, zip 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
  • %ICON{"pdf" quote="'"}%
You can also use formatting tokens such as $quot and $dollar in quote.

ICONURL, ICONURLPATH, DocumentGraphics
Topic revision: r1 - 2015-06-18, ProjectContributor
This site is powered by FoswikiCopyright © by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback