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:
2094 sites
493 downloads
76 fans
Moodle 2.9, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9, 3.10, 3.11

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

Contributors

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

Comments RSS

Show comments
  • Mon, Aug 5, 2019, 1:38 PM
    Hello, I'm a private music teacher who is very excited about Moodle... BUT lost as to how to solve a problem. I need a simple way to show individual students information that is only for them. When each logs in, they see only what they need. Even though several students are enrolled in the same course ("Level 3" perhaps), I want each to log in and see the recording from their own lesson. Is this something I could use the Generico filter for? I read the documentation and I was still a little fuzzy on it. Thanks!
  • Tue, Apr 14, 2020, 1:19 AM
    Hi,
    awesome plugin!
    Passing by to note that custom profile fields only works if their shortnames are in lower case. Didn't find it elsewhere, have to read the code, so noting here smile
  • Fri, Aug 14, 2020, 6:28 PM
    Hi Justin, thank you very much for this amazing plugin. I would like to ask if you have any idea for this problem: When anybody uses the global search by Moodle they are going to see the plain text tags. Do I have to filter the filters out of the search? Any idea? Thank you very much!
  • Tue, Oct 13, 2020, 8:11 PM
    Hi there,
    Is it possible to create a Line Chart with multiple lines? If so, how? I can't manage to do it :s i.e. to compare two different cities.
    Thanks!
  • Wed, Oct 14, 2020, 9:37 AM
    Hi Javier, the default line chart template just supports one series. There is another chart library called Chartist that is also in Generico. You can create it from a preset, since it is not set up by default. This can show multiple lines, but its not that great actually because you can not define the range and series labels are not set up. It works better with other chart types. With a bit of work I could fix it up, but that wont be soon.
  • Tue, Jan 19, 2021, 7:11 PM
    Hi,
    We are using Generico Version 1.4.10(Build 2019071300) with Moodle 3.3.2 (Build: 20170911). We have AWS Auto Scaling environment, Generico was working fine for a long time.
    Suddenly, we started getting "generico - Missing from disk!", but Generico is present in project. After some time it started working. Do you have any idea why did it happened.
  • Wed, Jan 20, 2021, 10:32 AM
    Generico is just a plugin and does not do anything special with the file system or database. So in this case I think one of your instances does not have Generico filter installed in the program directory, ie it is based on an AMI image that is old. Or at least one of your instances has changes not reflected in the AMI.
  • Wed, Jan 20, 2021, 2:12 PM
    Hi Justin,
    Thanks for quick reply. I had verified every thing, like presence of Generico and all of its subdirectories in all (two) running instances and in source of AMI image being used, permissions of Generico directory. While setting investigation, when I opened page .../admin/plugins.php?updatesonly=1, it started working.
  • Picture of Dominique Bauer
    Sat, May 22, 2021, 8:39 AM
    Hello Justin,
    It is possible to load a Generico template into a Moodle page from JavaScript?
    I tried:
    document.getElementById('tag-id').innerHTML = '{GENERICO:type=foo-template}';
    but it doen't work.
  • Sat, May 22, 2021, 1:55 PM
    Hi Dominique. The reason that will not work is that the filters are processed by PHP when the page is prepared and before it is sent to the browser. At that time any CSS or JS that the template deems necessary is also added to the page. Your script is running in the browser after all the processing is over and there is no way to send the template back up to PHP for another round (that I know of).

    The way you really want to do this, is to add that JS to set content to the div, inside the template. Or even just add the content to the template body. When the filter string is put on the page, and the page displayed your template will be run and any content/js or CSS will be sent to the browser. Encapsualting all your login in the template is how it is supposed to work. You can do quite a lot within Generico, but just get the basics working first.
  • Picture of Dominique Bauer
    Tue, May 25, 2021, 1:13 PM
    Hello Justin,

    Thank you very much for taking the time to answer me. My question sounded a bit silly, but I wasn't sure. Now I am in the right direction.

    Your plugin is awesome.
  • Wed, Jun 16, 2021, 10:37 PM
    Hi there,

    Do you know if there's an ETA on a fix for the bug that only passes the first set of variables specified in the Dataset variables to the plugin.

    Love the plugin so far, it's really helpful!

    Richard


  • Thu, Jun 17, 2021, 2:24 PM
    Hi Richard, Its not really as you describe. The full set of values returned from a DB query are returned in the dataset. Only the first set of these is available in the template body, because we would need to figure out a way to reference the array of data from there, since its just html not js. And there is no way to loop from html either.

    So if your query returns an array of data you need to access it from the JS field. And set it to HTML from there. The results will be in the @@DATASET@@ variable.

    Perhaps you are referring to the situation where your query does not return a unique ID as the first field in each row in the query result set. In that case when it put into json and back out again everything gets written to row 0 in the array (ie you just get one row). In that case you should make sure your result set contains a unique id as the first field in the result set.
  • Thu, Jun 17, 2021, 8:51 PM
    Hi Justin. Apologies, I think I misread from the Moodle Docs. I've been having a bit more of a play with it and it's been working perfectly. This plugin's been an absolute life saver!
  • Sat, Jul 24, 2021, 3:39 AM
    Hi Justin. Loving the Plugin, it's really powerful. Just a quick (hopefully) question. I know a user can set the variables when they select the template in the Genero Atto plugin (or just type it), and I know you can also set a default for variables, but is there any other way to change the variable?

    Example: I have some text in a p tag, and I basically want THAT text to be the content for one of the variables. I've got JQuery to isolate and copy the text, but I can't seem to figure out a way to get this text to become the variable (so a subsequent SQL query uses this new variable in it's select statement).

    Hope that all makes sense.

    Cheers.

    Richard
1 2 3 4 5 6
Please login to post comments