Difference between revisions of "FontAwesome filter"

Jump to: navigation, search
(Created page with "{{Filters}} This is a contributed (third party) filter for Moodle written by Julian (Moodleman) Ridden and shared on Moodle.org Essential is a ...")
 
Line 2: Line 2:
 
This is a [[:Category:Contributed_code|contributed (third party)]] filter for Moodle written by Julian (Moodleman) Ridden and shared on Moodle.org
 
This is a [[:Category:Contributed_code|contributed (third party)]] filter for Moodle written by Julian (Moodleman) Ridden and shared on Moodle.org
  
Essential is a three column Responsive theme based on Bootstrap for Moodle 2.5 designed to provide a more professional and clean website focused look and feel. It provides Admins with an image slider and Marketing spots on the homepage to drive users where you need to. The theme also makes strong use of Font Awesome to provide icons throughout the design.
+
Font Awesome provides sites with scalable vector icons that can instantly be customized — size, color, drop shadow, and anything that can be done with the power of CSS. Font Awesome is fully open source and is GPL compatible. No attribution is required when using the fonts although the project does say it is appreciated.
  
The theme is highly customisable through Moodle's theme settings. You can adjust images, text and colours all without changing code. As this theme has several advanced functions, this page exists to provide some basic instruction on it's use. Please be sure to target any questions related to this theme in the [https://moodle.org/mod/forum/discuss.php?d=231970 Theme's forums] at moodle.org and bugs to the [[Tracker|Moodle Tracker]]
+
This filter makes it easy to add FontAwesome icons to course content in any FontAwesome enabled moodle site. Please be sure to target any questions related to this filter in the [https://moodle.org/mod/forum/discuss.php?d=240159 Filter's forums] at moodle.org and bugs to the [[Tracker|Moodle Tracker]]
  
 
==Filter Objectives==
 
==Filter Objectives==
The aim of this theme was to provide a template that challenged what could be done with theme design. To create a Moodle instance that looked more like a professional standalone website and less like a Moodle instance.
+
The aim of this filter was to provide an easy and functional way for content creators to easily add FontAwesome icons anywhere in course content. If using the recommended method provide by FontAwesome which involves creating custom <i> classes you will find that the text editor strips these out automatically as unrecognised/bad code. This filter provides another mechanism to add FontAwesome icons that won't be stripped out by the editor.
  
This theme will not suit all audiences because of this. For a full list of contributed themes including Rocket to find one that meets your needs please check the [http://moodle.org/plugins/browse.php?list=category&id=3 Moodle Plugins database].
+
==Adding an icon==
 +
 
 +
Adding an icon to anywhere in your course that you wish is now a simple process. The hardest part is finding the icon you wish to use. To browse the full list of over 360 icons please visit [[http://fontawesome.io/icons/ this link]]. Once you have found the icon you are after you just have to surround it with a set of square brackets. e.g.  
 +
<nowiki>[icon-retro-camera]</nowiki>
 +
 
 +
If you have typed in the icon name correctly you will see the icon appear once you have hit save.
  
 
==Configurable Options==
 
==Configurable Options==
  
As themes are, by nature, a visual medium, these instructions will reference the screenshot listed below. This theme makes strong use of [[Theme_settings|Moodle Theme Settings]], [[theme/custom|Custom Theme settings]] and [[https://docs.moodle.org/dev/Very_flexible_block_system_proposal Custom Block]] locations.
 
  
 
===Advanced Tips===
 
===Advanced Tips===

Revision as of 06:12, 16 October 2013

This is a contributed (third party) filter for Moodle written by Julian (Moodleman) Ridden and shared on Moodle.org

Font Awesome provides sites with scalable vector icons that can instantly be customized — size, color, drop shadow, and anything that can be done with the power of CSS. Font Awesome is fully open source and is GPL compatible. No attribution is required when using the fonts although the project does say it is appreciated.

This filter makes it easy to add FontAwesome icons to course content in any FontAwesome enabled moodle site. Please be sure to target any questions related to this filter in the Filter's forums at moodle.org and bugs to the Moodle Tracker

Filter Objectives

The aim of this filter was to provide an easy and functional way for content creators to easily add FontAwesome icons anywhere in course content. If using the recommended method provide by FontAwesome which involves creating custom classes you will find that the text editor strips these out automatically as unrecognised/bad code. This filter provides another mechanism to add FontAwesome icons that won't be stripped out by the editor.

Adding an icon

Adding an icon to anywhere in your course that you wish is now a simple process. The hardest part is finding the icon you wish to use. To browse the full list of over 360 icons please visit [this link]. Once you have found the icon you are after you just have to surround it with a set of square brackets. e.g. [icon-retro-camera]

If you have typed in the icon name correctly you will see the icon appear once you have hit save.

Configurable Options

Advanced Tips

If you want to get your theme looking really fancy why not check out some of these Advanced Tips and Tricks

Download link

This theme is only available for Moodle 2.5 and above. You can download the theme from http://moodle.org/plugins/view.php?plugin=theme_essential

See also

8FontAwesome Official website