Difference between revisions of "FontAwesome"

From Freephile Wiki
Jump to navigation Jump to search
 
(One intermediate revision by the same user not shown)
Line 69: Line 69:
 
The best way I've found is to modify [[MediaWiki:Common.js]], but I ran into [[#Problems]] with that too.
 
The best way I've found is to modify [[MediaWiki:Common.js]], but I ran into [[#Problems]] with that too.
 
<source lang=javascript>
 
<source lang=javascript>
/*To add <script src="https://use.fontawesome.com/14c71d3de0.js"></script>
+
/*To add script tags to the page we use load instead of the deprecated importScriptURI */
  we use load instead of the deprecated importScriptURI */
+
/* You'll need to visit the fontawesome site to get a KEY to use */
mw.loader.load('//use.fontawesome.com/14c71d3de0.js');
+
mw.loader.load('//use.fontawesome.com/aldfjsdlkfjdlskf0.js');
 
</source>
 
</source>
  
Line 95: Line 95:
 
=== Problems ===
 
=== Problems ===
 
There may be bugs that have to be tracked down with regard to using it on a wiki site.  
 
There may be bugs that have to be tracked down with regard to using it on a wiki site.  
# The problems I originally encountered mysteriously disappeared. The main caveat being that FA does not preview.  It only shows up on 'Save'.
+
It turns out that Tidy was interfering with FontAwesome by removing the empty tags.
 +
# <strike>The problems I originally encountered mysteriously disappeared. The main caveat being that FA does not preview.  It only shows up on 'Save'.</strike>
 
# <strike>Font Awesome only seems to work if there is an actual image on the page. For example, this is an edit icon from a normal svg file. <nowiki>[[Image:Edit icon.svg|30px]]</nowiki>.  Remove that and your Font Awesome icon will disappear. Note: the image file doesn't even have to exist, it's just that the image processing code is not called unless there is a <nowiki>[[File:]]</nowiki> tag in the wikitext.</strike>
 
# <strike>Font Awesome only seems to work if there is an actual image on the page. For example, this is an edit icon from a normal svg file. <nowiki>[[Image:Edit icon.svg|30px]]</nowiki>.  Remove that and your Font Awesome icon will disappear. Note: the image file doesn't even have to exist, it's just that the image processing code is not called unless there is a <nowiki>[[File:]]</nowiki> tag in the wikitext.</strike>
 
# <strike>And FA doesn't work if I close the tag properly.  </strike>
 
# <strike>And FA doesn't work if I close the tag properly.  </strike>

Latest revision as of 20:27, 27 January 2017

Font Awesome[edit | edit source]

So you want a rocket on your page to show how awesome your stuff is. Something like this: http://fontawesome.io/icon/rocket/


If your wiki supports Font Awesome, then it's as easy as <i class="fa fa-pull-left fa-5x fa-rocket" aria-hidden="true"></i>

That is how to show a Font Awesome icon, pulled to the left, 5x bigger than normal, and explicitly telling screen readers to ignore the item as decorative.

If your wiki uses a theme like Foreground (FontAwesome 4.3) or Chameleon that is bootstrap compatible, then you can also mix-in layouts like this (won't work with Vector):

Bootstrap Example[edit | edit source]

     One of three columns
     Two of three columns
     Three of three columns
     
     Coffee
     I love coffee!!!
     
     cloud
     Cloud deployment means instantly available and scalable.  We can also do on-premise / local installations to meet your custom requirements.
     
     Blocks
     All the pieces are put together for you.  NO assembly required!

We specialize in

Websites that are simple to use
Collaboration / Data / Knowledge / Publishing / Docs systems
Web Applications
Development Operations


How To[edit | edit source]

Adding Font Awesome used to be an extension that you could install[1]. However, the source is no longer available, except as a GPL-violating purchase with no source; and the link doesn't even work.

The best way I've found is to modify MediaWiki:Common.js, but I ran into #Problems with that too.

/*To add script tags to the page we use load instead of the deprecated importScriptURI */
/* You'll need to visit the fontawesome site to get a KEY to use */
mw.loader.load('//use.fontawesome.com/aldfjsdlkfjdlskf0.js');

I'll check into all the recent details of the 'ResourceLoader' mechanism, and write a new extension or update comments here.

Some would say that you can shim into OutputPage by calling a hook in your LocalSettings.php

$wgHooks['BeforePageDisplay'][] ='onBeforePageDisplay';

function onBeforePageDisplay( OutputPage &$out, Skin &$skin )
{
  $script = '<script type="text/javascript" src="https://use.fontawesome.com/14c71d3de0.js"></script>';
  $out->addHeadItem("wowhead script", $script);
  return true;
};

But that did not seem effective.

Then there is another extension called mw:Extension:PhpTags_Widgets. That extension looks great (because it comes with stuff like Vega, and for other features too) and was recently updated to FontAwesome 4.5[2] But installing that has a bunch of dependencies on other extensions by the same author; which are marked experimental; and which go deep into murky waters that are not remotely connected to simply getting FontAwesome in your wiki. In short: Interesting stuff; not the best way to get FontAwesome.

Problems[edit | edit source]

There may be bugs that have to be tracked down with regard to using it on a wiki site. It turns out that Tidy was interfering with FontAwesome by removing the empty tags.

  1. The problems I originally encountered mysteriously disappeared. The main caveat being that FA does not preview. It only shows up on 'Save'.
  2. Font Awesome only seems to work if there is an actual image on the page. For example, this is an edit icon from a normal svg file. [[Image:Edit icon.svg|30px]]. Remove that and your Font Awesome icon will disappear. Note: the image file doesn't even have to exist, it's just that the image processing code is not called unless there is a [[File:]] tag in the wikitext.
  3. And FA doesn't work if I close the tag properly.
  4. The fa element is duplicated throughout the rest of the page since it wasn't closed.


Getting it[edit | edit source]

  1. Sign up for a unique embed code at the fontawesome website.
  2. Add the script source to your wiki by editing the MediaWiki:Common.js file where you add a call to 'load' the external script mw.loader.load('//use.fontawesome.com/14c71d3de0.js');
  3. Insert the <i> tags where ever you want. Note that there are various sizes pre-defined as fa-1 (smallest) to fa-6 (largest)

More[edit | edit source]

  1. Check http://fontawesome.io/examples/
  2. http://fontawesome.io/icons/ The icons (Note there is a new kickstarter for a Pro product https://www.kickstarter.com/projects/232193852/font-awesome-5)
  3. https://cdn.fontawesome.com/help#qa-icons-code
  4. https://stackoverflow.com/questions/tagged/font-awesome
  5. https://github.com/FortAwesome/Font-Awesome

Other Extensions[edit | edit source]

There is also an older 'bootstrap-mediawiki' extension which uses Bootstrap 3 and FontAwesome 4 https://github.com/borkweb/bootstrap-mediawiki

References[edit source]

  1. Extension:FontAwesome has been stagnant since 2014 and the developer has been changing around URLs with the current pay link saying it's "out of stock"!? Really, you ran out of source code?
  2. https://gerrit.wikimedia.org/r/#/q/project:mediawiki/extensions/PhpTagsWidgets,n,z