Difference: VarICON (2 vs. 3)

Revision 32010-01-02 - TWikiContributor

Line: 1 to 1
 
META TOPICPARENT name="TWikiVariables"

ICON{"name"} -- small documentation graphic or icon of common attachment types

Changed:
<
<
  • 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 filename, in which case the type of the file will be used to select one of a collection of common file type icons.
>
>
  • 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"}%
Added:
>
>
  • Supported parameters:
    Parameter:
    <-- -->
    Sorted ascending
    Description: Default:
    "name" Name of icon required
    default="else" Alternate icon if named icon is not defined default="$name"
    format="..." Format of icon. Supported variables (with Person %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"
 
  • Examples:
Changed:
<
<
    • %ICON{"flag-gray"}% returns Gray flag
    • %ICON{"pdf"}% returns PDF
    • %ICON{"smile.pdf"}% returns PDF
    • %ICON{"/dont/you/dare/smile.pdf"}% returns PDF
    • %ICON{"http://twiki.org/doc/xhtml.xsl"}% returns XSL (XML style sheet)
>
>
    • %ICON{"flag-gray"}% returns: Gray flag
    • %ICON{"pdf"}% returns: PDF
    • %ICON{"smile.pdf"}% returns: PDF
    • %ICON{"/home/sweet/home.pdf"}% returns: PDF
    • %ICON{"http://twiki.org/doc/xhtml.xsl"}% returns: XSL (XML style sheet)
    • %ICON{"bubble" format="$description icon is defined in $web.$topic"}% returns: Speech bubble icon is defined in TWikiDocGraphics
 
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2019 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.VarICON.