This javascript library allows you to add a text highlighter to your web pages, which gives the users of your site the ability to share with others their own highlighted text passages on your web pages. Another way to see EFatMarker: a "TL;DR mitigator".
I used a copy of a page on gnu.org and embedded EFatMarker's js
and
css
files in it, added the efm-target
class to the HTML element
which contains the main content, and so here are examples of permalinked
highlights:
- http://www.raymondhill.net/efatmarker/foreign-signs.html#efmAW0AX2
- http://www.raymondhill.net/efatmarker/foreign-signs.html#efmA8IA9h
This one is a version which include jQuery and uses the efm-button-container
class in order to control the position of the EFatMarker button:
The content of the page itself doesn't change, the fragment identifier (http://www.w3.org/TR/html4/intro/intro.html#fragment-uri) in the URL address specifies what portion of text must be dynamically highlighted after the page loads.
In the <head>
section of your HTML file, include:
<link rel="stylesheet" type="text/css" href="efatmarker.css" />
To change the style of the highlighted text, style the class .efm-hi
in your own file, provided your CSS file is loaded after efatmarker.css
.
Also, anywhere in your file, usuably preferably before the closing </body>
tag, include:
<script type="text/javascript" src="efatmarker.js"></script>
You must identify the HTML container element in your document which
contains the text which will inherit the ability to be dynamically
highlighted. Identify this container element by adding the class
efm-target
to its class attribute.
If there is more than one HTML element with class efm-target
, EFatMarker
will consider only the first one encountered.
Optional: If there is an HTML element with the class efm-button-container
in the page, this element will be used to receive the EFatMarker button,
otherwise, the <body>
tag is used by default, with the button at the
bottom right corner.
There are no outside dependencies, however, if jQuery or MooTools' Fx is present, these will be used to auto scroll to the first highlight when the page loads the first time.
So far, tested on
== LinuxMint 14 (25.0.1364.160-0ubuntu0.12.10.1):
- Chromium 25.0.1364.160
- Firefox 20.0
If the content of the target text changes, highlights made before change will no longer be accurately displayed.
- Author: Raymond Hill
- Home: https://github.com/gorhill/efatmarker
EFatMarker icon: http://openiconlibrary.sourceforge.net/gallery2/?./Icons/apps/kedit-2.png
Copyright (C) 2013 Raymond Hill
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.