Generico Filter

Filters ::: filter_generico
Maintained by Justin Hunt
Generico is a simple filter for creating templates of code snippets and text that can be inserted into Moodle text areas.
Latest release:
2410 sites
815 downloads
98 fans
Current versions available: 5

Generico is a simple templating filter, that allows you to set up text and code snippet templates for use in Moodle text areas. It allows an unlimited number of templates to be registered. When Moodle encounters a Generico filter string it will use the data in the filter string to fill out the template, and insert it into the page. 

It is useful for ad-hoc template purposes where writing a new plugin would be overkill, or just for re-using common pieces of text. It can be used to centralise and manage the embedding of iframe content from video hosting services, and educational app providers.

In the latest version there are approx. 20 presets from which you can make templates. They include templates for an info box, tabset, accordian, lightbox and image gallery. And there is a companion Atto editor plugin for Generico. The combination of these two features make it possible to use Generico like the Wordpress shortcode plugins.

This 8 minute video walks through the basic Generico Filter and should give you a good idea of what it is, and how it works. 



How it works

Templates for use with the filter are available at:

Site Administration -> plugins -> filters -> Generico -> templates

A template primarily consists of a "key", a "template," and some "defaults." (It can also load CSS and Javascript. But for now lets keep things simple.)

The key is just a one word name, that tells Generico which template to use. 

The template is just passage of text that you want to use, and the parts of the template that you want to mark as variables you surround in @@ marks.

The defaults are a comma delimited list of variablename=value pairs. It is possible to specify multiple values for a single variable in the defaults. The Generico Atto editor plugin will display these values in a drop down list. eg size="100|120|140".  The first of the values will be the true "default."

Here is an example template.

templatekey: wildthings

template: Inside this box are @@thing1@@ and @@thing2@@

template defaults: thing2=Silly


A possible filter string for this "wildthings" template would look like this:

{GENERICO:type=wildthings,thing1=Sally}


Generico would replace the above filter string with:

"Inside this box are Sally and Silly"


The filter string must follow this format,

{GENERICO:type=templatekey,variable1=data1,variable2=data2}


The wildthings example above is trivial of course. Instead imagine using it to embed YouTube videos by registering the standard iframe code YouTube gives you, as a template. Then it would only be necessary to insert the id of the video in a generico filter string and the template would do the rest. e.g

{GENERICO:type=youtube,id=ABC12345678}


USING PRESETS

Generico comes with about 20 template presets. By default they are not set up as templates yet. To create the actual template:

  1. Open an empty template settings page
  2. Select a preset from the dropdown list at the top of the page
    This will fill in the fields on the template settings page.
  3. Press the "Save Changes" button at the bottom of the page.


USING BUNDLES

So that people can share the templates they have made, there is a system to share them called "bundles." On each template settings page there is a green bundle box.


If you click on the box, it will automatically download the "bundle" as a text file. If you then drag that bundle (or somebody else's bundle) onto the green bundle box of another template, it will fill the fields on that template settings page. Be sure to save the template after you have done that.

There are a number of bundles that people have shared over in the this forum thread. 
https://moodle.org/mod/forum/discuss.php?d=324771


And there is a special category here on the Moodle plugins directory for sharing templates: 
https://moodle.org/plugins/browse.php?list=category&id=69



USER PROFILE VARIABLES

It is also possible to add user profile variables to your templates. Just make the first part of the variable name USER: and the next part the name of the user profile field. It also works with custom profile fields. There are two "special" user profile fields, picurl and pic that respectively output the url of the user's profile pic, and their picture itself.

e.g

User's first name: @@USER:firstname@@

User's ice cream preference (custom profile field): @@USER:icecreampref@@
Users profile pic url: @@USER:picurl@@

User's profile pic:  @@USER:pic@@


INSTALLATION

Generico installs like any Moodle plugin. Please see here for more information on that process:
https://docs.moodle.org/en/Installing_plugins#Installing_directly_from_the_Moodle_plugins_directory

On the final page of the installation you will be able to register templates. its best to skip that step, and just press "save changes." Later you can do this from the Generico template settings pages.


After installing you will need to enable the Generico filter. You can enable the Generico filter at:

Site Administration -> plugins -> filters -> manage filters

More Documentation

https://docs.moodle.org/31/en/filter_generico

https://poodll.freshdesk.com/solution/articles/19000083258-how-do-widgets-work-for-developers-


Screenshots

Screenshot #0
Screenshot #1
Screenshot #2
Screenshot #3

Contributors

Justin Hunt (Lead maintainer)
Please login to view contributors details and/or to contact them

Comments RSS

Show comments
  • Dave Foord
    Tue, 12 Dec 2023, 4:21 PM
    I haven't used Generico filters before, but am liking what I see...

    I have a need to display a countdown timer for an upcoming exam, and found this post https://moodle.org/mod/forum/discuss.php?d=324771#p1309563 which uses Generico filters to acheive just this. I recognise that this post was written a few years ago, and the filter templates now have more boxes - and I have added the relevant bits to the relevant boxes (e.g. main code into one box, css into another, and javascript into the javascript box) - but this isn't quite working - I get the boxes displayed, but no text within them. Has anyone got a countdown timer working more recently, and can point me to the code?
  • Laurent Dairaine
    Sun, 3 Mar 2024, 6:10 AM
    Hi, thanks for this great plugin. Is there any way to get the value of a dropdown custom field ? I can only get the index value. e.g, a Course dropdown custom field named level is defined with 3 value 1: Beginner, 2:Intermediate, 3: Advanced. With @@COURSE:level@@ return "2", but I would like to get "Intermediate".
  • Justin Hunt
    Sun, 3 Mar 2024, 9:57 AM
    HI Laurent. I tried that and I got the same result as you. The value of the custom variable internally is not "intermediate" but "2" (which is its index in the drop down list). I had a look to see how to get drop down list values from custom fields but it would require a bit more work than I have time for now. So in the short term, you are best to use javascript to do this. I made a template for you but I can't post anything here. You need to create forum post and I will add it as a reply there. Do that here: https://moodle.org/mod/forum/discuss.php?d=261896
  • Mary Blue
    Mon, 29 Apr 2024, 10:07 PM
    Dear Justin, I tried to insert the course image via @@COURSE:image@@ into a template.
    Unfortunately it didn't display the image. Can you help me?
    Best regards, Mary
  • Justin Hunt
    Fri, 3 May 2024, 11:54 PM
    Hi Mary, because of the way images are stored in Moodle that won't work. Its just the content of the course database table in the course object. It would be possible to implement that, but its not there now
  • Matt Faber
    Mon, 16 Sept 2024, 5:59 PM
    Hi Justin, I hope you can help. I have been trying to find a way of personalising messages in the bulk email plugin. My thinking was to use Generico which I have installed and it seems to be working , however when I use the code Dear @@USER:firstname@@ @@USER:lastname@@, the code displays my names (the sender) and not the recipients names. Am I doing somehting wrong or is this function not possible with Generico? Many thanks, Matt
  • Justin Hunt
    Tue, 17 Sept 2024, 7:32 PM
    Hi Matt, I do not think that is possible with Generico. USER is the currently logged in user. That is why its you. You would need some custom functionality to get the intended mail recipients names into Generico. It doesn't look like bulk email plugin provides that, so its probably not really practical. If "Hi there, ...." is not good enough, I would suggest you look at an integration with MailChimp or another mail provider and Moodle.
  • Matt Faber
    Tue, 17 Sept 2024, 9:57 PM
    Hi Justin, Many thanks for your response. It seems that there is quite a functionality gap here: to bulk email users with a personalised greeting would seem pretty useful to most admins yet it doesn't currently exist. Definitely some scope there for a developer...
  • Justin Hunt
    Wed, 18 Sept 2024, 3:31 PM
    There are many cool things still to be built.That would be one of them. In the meantime you can use my Zapier integration to integrate with Mailchimp. See here: https://support.poodll.com/en/support/solutions/articles/19000161459-connecting-moodle-to-mailchimp
  • Laurent Dairaine
    Sat, 19 Oct 2024, 9:15 PM
    Hi Justin. I have installed the "Custom field for Activity Module" https://moodle.org/plugins/local_modcustomfields that allow to define fields using standard Moodle approach. Then How to access these fields from GENERICO?
  • Justin Hunt
    Sat, 19 Oct 2024, 9:48 PM
    HI Laurent. I don't know, I have never tried. I suspect Generico needs to add support for the custom fields api for that to be possible. If it helps, you can use Course custom fields in Generico. Also, I don't think you should post your question here and in the local_modcustomfields plugin. Both devs have to answer.
  • Mary Blue
    Wed, 20 Nov 2024, 6:29 PM
    Dear Justin, I really love your plugin. Especially because it gives us the possibility to manage standard content like texts that you find in any couse from a central position in the system. Just great!!!
    My question for is, if it is possible to display the progressbar for activities in a course through the generico filter.
  • Dave Foord
    Tue, 11 Mar 2025, 10:15 PM
    I am trying to write some how to guides for staff inside Moodle, and I want the generic filter to display as text, but not render as the filter. I need to keep the filters active on the page for other things. are them some 'tags' I can put around the filters to stop them rendering?
  • Justin Hunt
    Wed, 12 Mar 2025, 9:08 AM
    Hi Dave, thats a super question because there is indeed a way to do that. The very last attribute on the filterstring, with no spaces or quotes should be; passthrough=1
    e.g {GENERICO:type="houses",color="green",owner="jim",passthrough=1}

    Also note that there is some old but still applicable documentation here: https://poodll.freshdesk.com/a/solutions/articles/19000083258
  • Dave Foord
    Wed, 12 Mar 2025, 3:05 PM
    Thanks Justin - that works. I am loving this plugin.
1 2 3 4 5 6 7 8
Please login to post comments