Your Moodle version

Filters: IPA

filter_ipa
Maintained by Picture of Kevin Wiliarty Kevin Wiliarty
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.
375
1

Linguists sometimes use X-SAMPA as a way to represent the International Phonetic Alphabet using the more limited ASCII character set. Although the widespread adoption of utf8 and Unicode has made it increasingly easy to display the several IPA glyphs, a character substitution scheme like X-SAMPA can be useful when composing IPA. Many of the substitutions are fairly intuitive, and there is no need to scan through symbol charts or navigate away from the content you are editing.

This filter will treat text between hyphen/curly-brace combinations as X-SAMPA to be rendered as Unicode IPA. Mark the beginning of X-SAMPA with "-{" and the end with "}-".

For full support it is also recommended that Moodle administrators load an appropriate web font. Details on how to do so will be found in the README file.

Screenshots

Screenshot
Screenshot

Contributors

Picture of Kevin Wiliarty
Kevin Wiliarty (Lead maintainer)
Please login to view contributors details and/or to contact them

Comments RSS

Show comments
  • Anthony Borrow
    Wed, May 14, 2014, 12:37 PM
    Kevin,

    Many thanks for sharing this plugin with the Moodle community. I wonder if the fact that when I saw the same of the filter I thought of beer might mean I have been spending too much time at the local pub ;)

    Please review the validation results and fix all of the issues mentioned. These changes are typically pretty easy to make but if you have any questions just let us know.

    Warning Release name ($plugin->release) not found in version.php
    Warning Found more than one file with possible release notes. Used text from ipa/README.md

    For the readme file, you may want to remove the README.txt file and when uploading a version check the box to have the readme renamed. If you are not familiar with it, you may want to try using the Github file repository on Moodle.org to upload a new version. If you have any questions with that just let me know. I think doing so allows folks to focus on the code and makes packaging it a lot easier.

    I noticed that you did not specify an issue tracker for your plugin. Providing a place for users of your plugin to report issues encourages participation and provides a way for users to report bugs, make feature requests, or suggest other types of improvements. There are a couple of options. You are welcome to request that a component be created in the Moodle Tracker. This will allow for you to become more familiar with how issues are managed in Moodle core but may take a little more time to setup. Alternatively, for folks who are using Github.com, you can use the issues feature of Github to handle such requests. Kindly let me know which of these two options seems best for you.

    Please provide a documentation URL. You are welcome to create your documentation in Moodle Docs, See http://docs.moodle.org/dev/Plugin_documentation for more information. Alternatively, given the relative simplicity of the addon, you could just point directly to the README file.

    It is encouraged to follow Moodle's coding style as outlined in:

    http://docs.moodle.org/dev/Coding_style
    http://docs.moodle.org/dev/Coding

    Tthe code checker plugin can be quite helpful in fine tuning your code and can be found at:

    https://moodle.org/plugins/view.php?plugin=local_codechecker

    You may wish to consider using that tool to further improve your plugin. Below, are the initial results:

    Files found: 9
    filter/ipa/lib.php - 1 error(s) and 0 warning(s)
    filter/ipa/doulos.css
    filter/ipa/lang/en/filter_ipa.php - 1 error(s) and 0 warning(s)
    filter/ipa/styles.css
    filter/ipa/version.php - 1 error(s) and 0 warning(s)
    filter/ipa/gentium.css
    filter/ipa/filter.php - 1 error(s) and 0 warning(s)
    filter/ipa/tinos.css
    filter/ipa/README.txt - 1 error(s) and 0 warning(s)

    Actually looking at the errors listed they are: Default timezone is required since PHP 5.4 and a whitespace error so nothing of significance.

    I am going to approve this plugin but when you have a chance let me know how you wish to handle the tracker and docs URLs. Peace - Anthony
  • Anthony Borrow
    Wed, May 14, 2014, 1:12 PM
    Kevin - I am not sure why but when I attempted to approve this plugin I received a parse error from AMOS about the language strings. I will try to look further and see what is happening. Thanks for your patience. Peace - Anthony
  • Picture of David Mudrák
    Wed, May 14, 2014, 6:05 PM
    I believe this had nothing to do with this plugin. AMOS site was having troubles last night and I guess it was just temporarily down when Anthony was approving the plugin. I just re-approved it and deleted the older of two versions uploaded. Thanks both.

    Welcome to Plugins directory!
  • Picture of Kevin Wiliarty
    Thu, May 15, 2014, 12:26 AM
    Thank you both! I will address all of the issues in short order. And then I might have to celebrate with an IPA.
  • Picture of Kevin Wiliarty
    Thu, May 15, 2014, 1:13 PM
    I've uploaded a new version that addresses the validation warnings by including a release name and by following your advice concerning the README.txt. I used the github file repository to add the download straight from github, renaming the main directory and the README.md file in the process. Thanks for the great tip.

    For me the codechecker is coming up all green at this point. I've seen the default timezone issue before, but it was something I had to set in server environment rather than in the plugin files, as I recall.

    I've added discussion and documentation URL's, both on moodle.org, and I created a task on the tracker to create a component for the plugin there. Not sure I put that in the right place, so just let me know if I need to do anything differently.

    Thanks again for your help.
  • Anthony Borrow
    Fri, May 16, 2014, 1:27 PM
    Thanks Kevin for your great work and patching things up. Peace - Anthony
Please login to post comments