Skip to content

kwiliarty/moodle-filter_ipa

Repository files navigation

Moodle IPA Filter

Build Status

Source URL

The Moodle IPA Filter displays X-SAMPA as unicode IPA. The intent is to offer an easy and fast way to display the International Phonetic Alphabet in Moodle.

Installing the filter

  1. Download the latest version of the Moodle IPA Filter and put the ipa folder in Moodle at /filter/ipa.

  2. OR... From your main Moodle directory: git clone https://github.com/kwiliarty/moodle-filter_ipa.git filter/ipa

  3. In Moodle go to Site administration > Notifications and install the filter

  4. Next go to Site Administration > Plugins > Filters > Manage Filters

  5. Enable the IPA filter (or set it to "Off but available")

  6. Test the filter by entering a string such as the following to the content of a label:

    -{D@ "fIlt@r Iz "w@rkIN}-

Fonts

In order to ensure that the IPA displays correctly -- especially the combining marks (diacritics) -- you will want to be loading at least one fully compatible web font. The Moodle IPA filter ships with two fonts that you can call, or you can use a carefully selected Google Web Font. In each case you will need to add a link to a particular style sheet in the HEAD area of Site administration > Appearance > Additional HTML.

Gentium is the first font listed in the 'font-family' so it is the font that will display even if you call more than one. Gentium is a slightly fanciful serif font that is very readable even at smaller sizes -- important when you are using unusual glyphs. Sample

To use Gentium add something like this to your Additional HTML:

<link rel="stylesheet" href="URL_TO_YOUR_MOODLE/filter/ipa/gentium.css" type="text/css">

You will need to provide the URL to your own Moodle site as the first part of the href.

Doulos is a somewhat compact serif font without unnecessary flourishes. Doulos is listed second in the 'font-family'. Sample

To use Doulos add a line like this to your Additional HTML:

<link rel="stylesheet" href="URL_TO_YOUR_MOODLE/filter/ipa/doulos.css" type="text/css">

Tinos is a stylish serif font and one of only a couple Google Web Fonts that handles the spacing for the combining marks well. To use Tinos you would add a line like this to your Additional HTML:

<link rel="stylesheet" href="URL_TO_YOUR_MOODLE/filter/ipa/tinos.css" type="text/css">

Usage

Enclose X-SAMPA in curly braces with hyphens outermost: "-{" opens a stretch of X-SAMPA, and "}-" closes the stretch.

About

A filter to render X-SAMPA markup as unicode IPA

Resources

Stars

Watchers

Forks

Packages

No packages published