Changeset 5812 for trunk/core/data/System/VarICON.txt

Timestamp:

12/17/09 19:32:52 (2 years ago)

Author:

CrawfordCurrie

Message:

Item2511: document alt= parameter on %ICON - meant to do that years ago, forced to now for refactoring

File:

• trunk/core/data/System/VarICON.txt (modified) (2 diffs)

trunk/core/data/System/VarICON.txt

@@ -2 +2 @@
 %META:TOPICPARENT{name="Macros"}%
 #VarICON
----+++ ICON{"name"} -- small documentation graphic or icon of common attachment types
+---+++ ICON{"name" alt=""} -- small documentation graphic or icon of common attachment types
    * Generates the HTML img tag of a small graphic image 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.
    * Syntax: =%<nop>ICON{"name"}%=
@@ -11 +11 @@
       * =%<nop>ICON{"/dont/you/dare/smile.pdf"}%= returns %ICON{"/dont/you/dare/smile.pdf"}%
       * =%<nop>ICON{"http://trunk.foswiki.org/pub/System/DocumentGraphics/xsl.gif"}%= returns %ICON{"http://trunk.foswiki.org/pub/System/DocumentGraphics/xsl.gif"}%
+   * You can use the =alt= parameter to specify an alternate image, in case
+     the filename doesn't produce a recognised graphic e.g. ==%<nop>ICON{"data.docx" alt="doc"}%
    * Graphic samples: %ICON{"arrowbright"}% =arrowbright=, %ICON{"bubble"}% =bubble=, %ICON{"choice-yes"}% =choice-yes=, %ICON{"hand"}% =hand=
    * File type samples: %ICON{"bmp"}% =bmp=, %ICON{"doc"}% =doc=, %ICON{"gif"}% =gif=, %ICON{"hlp"}% =hlp=, %ICON{"html"}% =html=, %ICON{"mp3"}% =mp3=, %ICON{"pdf"}% =pdf=, %ICON{"ppt"}% =ppt=, %ICON{"txt"}% =txt=, %ICON{"xls"}% =xls=, %ICON{"xml"}% =xml=, %ICON{"zip"}% =zip=