Database templates

From MoodleDocs

Templates for the Database activity module allow you to control the visual layout of information when listing, viewing or editing database entries. It is a similar to the technique used to mail merge letters in word processors such as Open Office Writer or Microsoft Word.

Tag usage

The content of each field you create for your database and some special tags (listed below) can be inserted into the output template by the use of tags.

Fields have the format [[fieldname]]. All other tags have the format ##sometag##.

To use the tags in the box on the left of the page, first click to Disable the editor and then place your cursor in the text area of your target edit and click on the tag you want to insert. When you have finished, click to save the template. Alternatively, you may simply type the appropriate name within the required symbols like ##this## or [[this]], respectively.

Tags related to specific fields require writing the database field name inside double-squared braces. For example, all tags related to a field called "myfield" will use the [[fieldname#TAGNAME]] format. The available field tags are:

  • [[fieldname]] will be replaced by the field value. In the case of the "Add template", it will be replaced by the field's form input.
  • [[fieldname#name]] will be replaced by the field name
  • [[fieldname#description]] will be replaced by the field name

Those are the rest of the tags that could be used inside templates:

  • ##actionsmenu## creates a dropdown menu with the available user's actions in the current database entry. This is the recommended way to add options to entry. However, for legacy reasons, individual actions links tags are still available: ##edit##, ##delete##, ##approve## or ##disapprove##.
  • ##more## creates a link to the single view, which may contain more detailed info
  • ##moreurl## creates just the URL for the above link, useful for creating your own links. You can click on the link icon and type ##moreurl## into URL field or in source view type
    <a href="##moreurl##">[[fieldname]]</a>
  • ##comments## creates a link to the view/edit comments page, the link text is the current number of comments (only appears if comments are turned on)
  • ##user## creates a link to the user page of the user who submitted the entry, link text is their name
  • ##timeadded##
  • ##timemodified##
  • ##userpicture## displays the user picture in List view
  • ##approvalstatus## inserted as inline css provides highlighting for unapproved entries
  • ##tags## displays tags (enabled by default in Manage tags in the Site administration)
Example of ##userpicture## tag

List template

This template allows you to control the fields used and their layout when viewing multiple entries simultaneously (e.g. search results). It is possible that this view may provide an overview with more detailed information available by clicking on an entry to access the single view of the entry.

See Designing a list view in Moodle database activity for instructions on how to create a list template table.

The list template can also be used as a way to export your database as a CSV file.

Single template

This is used to display a single entry at a time and so has more space for display and can use, for example, larger versions of images or optionally provide more information than shown in the list view.

database single template

Advanced search template

An advanced search template is for creating the interface form used in the advanced search.

Add template

This template creates the interface form used when adding or editing database entries.

RSS template

Lets you control the content of the RSS feed for database entries.

CSS template

If any of the HTML in your other templates requires CSS to provide visual style you can specify it here.

Javascript template

You can use javascript to manipulate the way elements are displayed in either the List, Single or Add templates. Basically you need to enclose the part you want to manipulate in some named html element. The naming is essential as it allows you to identify the element for manipulation.

Let's say, for example, you have a field in your database that stores a person's name and when you display the names in the List View you want to count the times a name matches some criteria and display the result.

Your database will contain a field which we will call "name". In your List template you will be able to display the contents of that field by using the [[name]] construct at the place where you want that information displayed. For example, in the Repeated entry on the list template you will have

     <td>Name: [[name]]</td>

You now need to modify that entry to ensure that the part you want to manipulate is a named element.

     <td name="named">Name: [[name]]</td>

The footer of your list view can then contain another named element to display the result.

  <div name="result"></div>

Your javascript template can now look as follows

 var cnt = 0;
 var re = /foo|Foo/;
 function init(){
   var namedElements = document.getElementsByName("named");
   for (i=0; i < namedElements.length; i++) {
       if(re.test(namedElements[i].innerHTML)) cnt++;
   var namedResult = document.getElementsByName("result");
   namedResult[0].innerHTML = cnt;
 window.onload = init;

This will display a table of names as is usual in the list view. Now at the bottom there will also be the count of the names that matched foo or Foo.

Note that window.onload does not handle any dependencies on YUI code, so any YUI modules required by your init() code may not be loaded, and your code will fail.

In this case, instead of onload, use:

YUI().use('node', 'other', 'dependencies', function(Y) {

  // Your code here.

  // This function is a closure so the Y object you define in the function definition is yours and nothing else on the page should be able to break it.


Reset templates button

When you first create a database the templates will be pre-filled with appropriate HTML. If you later add fields then you can press the reset templates button and it will add HTML for the new fields in a similar fashion. If you have edited any of the templates in the meantime then your changes will be lost. It is recommended that you finalize the database fields before changing the template code.

See also