MimeIconPlugin < System

You are here: Foswiki>System Web>MimeIconPluginEditAttach

---+!! %TOPIC%
%SHORTDESCRIPTION%

%TOC%

This plugin tries to map known mime types commonly found on the internet to an icon set.
There are not many icon sets that have a got coverage of mime types despite looking nicely,
yet still coherent, not too exotic so that they can be used with a variety of web designs
without too much of a problem.

!MimeIconPlugin comes with two complete icon sets, namely =oxygen= and =crystal= provided in 
several sizes.

---++ Usage

!MimeIconPlugin implements a single macro [[VarMIMEICON][%MIMEICON]] which returns the right icon
in the desired size of an icon theme for a given file.

For instance you type:
<verbatim class="tml">
%MIMEICON{
  "screenshot.png" 
  size="48" 
  theme="oxygen"
}%
</verbatim>

will give you:

%MIMEICON{
  "screenshot.png" 
  size="48" 
  theme="oxygen"
}%

if this plugin is installed.

The idea is that you can pretty much throw any file at it and =%MIMEICON= will return the right icon for it
reflecting the mimetype of this file. Well, obviously there is a fallback to a neutral icon in case some
file extension is totally unknown.

---++ Examples

---+++ Oxygen
<img src="%ATTACHURLPATH%/MimeIconPluginSnap2.png" /> 

---+++ Crystal
<img src="%ATTACHURLPATH%/MimeIconPluginSnap1.png" /> 

---++ Installation Instructions

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server.

Open configure, and open the "Extensions" section. Use "Find More Extensions" to get a list of available extensions. Select "Install".

If you have any problems, or if the extension isn't available in =configure=, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions for more help.


---++ Info
<!--
   * Set SHORTDESCRIPTION = Icon sets for mimetypes
-->
|  Author(s): | Michael Daum|
|  Copyright: | &copy; 2010-2013 Michael Daum http://michaeldaumconsulting.com |
|  License: | [[http://www.gnu.org/licenses/gpl.html][GPL (Gnu General Public License)]] |
|  Release: | 1.20 |
|  Version: | 1.20 |
|  Change History: | <!-- versions below in reverse order -->&nbsp; |
|  2013-05-22: | (1.20) only ship icons covered by a mapping |
|  2011-11-16: | (1.10) fixed mapping in oxygen icon set; fix to make sure the icon mapping is read in properly |
|  Dependencies: | None |
|  Home page: | Foswiki:Extensions/%TOPIC% |
|  Support: | Foswiki:Support/%TOPIC% |

Topic attachments
I	Attachment	Action	Size	Date	Who	Comment
png	MimeIconPluginSnap1.png	manage	18.4 K	22 May 2013 - 08:13	UnknownUser
png	MimeIconPluginSnap2.png	manage	40.6 K	22 May 2013 - 08:13	UnknownUser

Topic revision: r2 - 14 Oct 2014, MatthiasGeorgi

System

Copyright © by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback