ICON{"name"} -- small documentation graphic or icon of common attachment types
- Generates the HTML img tag of a small graphic image attached to TWikiDocGraphics. Images typically have a 16x16 pixel size. You can select a specific image by name, or you can give a full file path or URL, in which case the type of the file will be used to select one of a collection of common file type icons.
- Syntax:
%ICON{"name"}% - Supported parameters:
Parameter: Description: Default: "name"Name of icon required format="..."Format of icon. Supported variables (with
%ICON{"person"}%example):
•$name- name of icon (person)
•$type- type of icon (gif)
•$filename- icon filename (person.gif)
•$web- web where icon is defined (TWiki)
•$topic- topic where icon is defined (TWikiDocGraphics)
•$description- icon description (Person)
•$width- width of icon ('16')
•$height- height of icon ('16')
•$img- full img tag of icon (<img src="... />)
•$info- icon tag with usage info in title
•$url- URL of icon (http://example.com/pub/TWiki/TWikiDocGraphics/person.gif)
•$urlpath- URL path of icon (/pub/TWiki/TWikiDocGraphics/person.gif)format="$img"default="else"Alternate icon if named icon is not defined default="$name" - Examples:
-
%ICON{"flag-gray"}%returns:
-
%ICON{"pdf"}%returns:
-
%ICON{"smile.pdf"}%returns:
-
%ICON{"/home/sweet/home.pdf"}%returns:
-
%ICON{"http://twiki.org/doc/xhtml.xsl"}%returns:
-
%ICON{"bubble" format="$description icon is defined in $web.$topic"}%returns: Speech bubble icon is defined in TWikiDocGraphics
-
- Graphic samples:
arrowbright,
bubble,
choice-yes,
hand - File type samples:
bmp,
doc,
gif,
hlp,
html,
mp3,
pdf,
ppt,
txt,
xls,
xml,
zip - Category: FormattingAndRenderingVariables
- Related: ICONURL, ICONURLPATH, TWikiPreferences, FileAttachments, TWikiDocGraphics
