MDL-57338 templates: add missing example context

2025-01-18 05:58:34 +01:00 · 2016-12-09 12:17:39 +00:00 · 2016-12-09 12:17:39 +00:00 · 2d29386c44
commit 2d29386c44
parent b4a65796cf
32 changed files with 312 additions and 14 deletions
--- a/lib/templates/action_menu.mustache
+++ b/lib/templates/action_menu.mustache
@ -15,7 +15,20 @@
    along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 }}
 {{!
+    @template core/action_menu
+
    Action menu.
+
+    Example context (json):
+    {
+        "classes": "",
+        "primary": {
+            "items": [{"rawhtml": "<p>Item in primary menu</p>"}]
+        },
+        "secondary": {
+            "items": [{"rawhtml": "<p>Item in secondary menu</p>"}]
+        }
+    }
 }}
 <div class="{{classes}}" {{#attributes}}{{name}}="{{value}}"{{/attributes}}>
    {{#primary}}
@ -37,8 +50,6 @@
            {{#items}}<li role="presentation">{{> core/action_menu_item }}</li>{{/items}}
        </ul>
    {{/secondary}}
-
-    </span>
 </div>
 {{#js}}
 require(['core/yui'], function(Y) {
--- a/lib/templates/action_menu_item.mustache
+++ b/lib/templates/action_menu_item.mustache
@ -15,7 +15,14 @@
    along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 }}
 {{!
+    @template core/action_menu_item
+
    Action menu item.
+
+    Example context (json):
+    {
+        "rawhtml": "<p>[rawhtml]</p>"
+    }
 }}
 {{#actionmenulink}}{{> core/action_menu_link }}{{/actionmenulink}}
 {{#actionmenufiller}}<span class="filler">&nbsp;</span>{{/actionmenufiller}}
--- a/lib/templates/action_menu_link.mustache
+++ b/lib/templates/action_menu_link.mustache
@ -15,7 +15,16 @@
    along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 }}
 {{!
+    @template core/action_menu_link
+
    Action menu link.
+
+    Example context (json):
+    {
+        "text": "Example link text",
+        "showtext": true,
+        "url": "http://example.com/link"
+    }
 }}
 {{^disabled}}
    <a href="{{url}}" class="{{classes}}" {{#attributes}}{{name}}={{#quote}}{{value}}{{/quote}}{{/attributes}} {{#showtext}}aria-labelledby="actionmenuaction-{{instance}}"{{/showtext}}>{{#icon}}{{>core/pix_icon}}{{/icon}}{{#showtext}}<span class="menu-action-text" id="actionmenuaction-{{instance}}">{{{text}}}</span>{{/showtext}}</a>
--- a/lib/templates/action_menu_trigger.mustache
+++ b/lib/templates/action_menu_trigger.mustache
@ -15,6 +15,15 @@
    along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 }}
 {{!
+    @template core/action_menu_trigger
+
    Action menu trigger.
+
+    Example context (json):
+    {
+        "instance": "1",
+        "title": "Trigger me!",
+        "menutrigger": true
+    }
 }}
 <a href="#" class="toggle-display {{#menutrigger}}textmenu{{/menutrigger}}" id="action-menu-toggle-{{instance}}" title="{{title}}" role="menuitem">{{{actiontext}}}{{{menutrigger}}}{{#icon}}{{> core/pix_icon}}{{/icon}}{{#rawicon}}{{{.}}}{{/rawicon}}{{#menutrigger}}<b class="caret"></b>{{/menutrigger}}</a>
--- a/lib/templates/actions.mustache
+++ b/lib/templates/actions.mustache
@ -15,7 +15,14 @@
    along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 }}
 {{!
+    @template core/actions
+
    Actions.
+
+    Example context (json):
+    {
+        "actions": [{"event": "event", "jsfunction": "Y.log", "id": "id"}]
+    }
 }}
 {{#js}}
    require(['core/yui'], function(Y) {
--- a/lib/templates/chooser.mustache
+++ b/lib/templates/chooser.mustache
@ -15,7 +15,26 @@
    along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 }}
 {{!
+    @template core/chooser
+
    Chooser.
+
+    Example context (json):
+    {
+        "title": "Chooser title",
+        "method": "post",
+        "actionurl": "http://example.org/test",
+        "instructions": "Choose one:",
+        "paramname": "param",
+        "sections": [{
+            "id": "section-1",
+            "label": "Section one",
+            "items": [{
+                "label": "item one",
+                "description": "description one"
+            }]
+        }]
+    }
 }}
 <div class="hd choosertitle">
    {{title}}
--- a/lib/templates/chooser_item.mustache
+++ b/lib/templates/chooser_item.mustache
@ -15,7 +15,18 @@
    along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 }}
 {{!
+    @template core/chooser_item
+
    Chooser item.
+
+    Example context (json):
+    {
+        "id": "1",
+        "paramname": "param",
+        "value": "1",
+        "label": "item one",
+        "description": "description one"
+    }
 }}
 <div class="option">
    <label for="item_{{id}}">
--- a/lib/templates/dataformat_selector.mustache
+++ b/lib/templates/dataformat_selector.mustache
@ -17,8 +17,7 @@
 {{!
    @template core/dataformat_selector

-    Template for all html emails. Note that it may wrap content formatted
-    elsewhere in another a module template.
+    Template for dataformat selection and download form.

    Context variables required for this template:
    * label
@ -28,6 +27,16 @@
    * options
    * sesskey
    * submit
+
+    Example context (json):
+    {
+        "base": "http://example.org/",
+        "name": "test",
+        "label": "Download table data as",
+        "params": false,
+        "options": [{"label": "CSV", "name": "csv"}, {"label": "Excel", "name": "excel"}],
+        "submit": "Download"
+    }
 }}
 <form method="get" action="{{base}}" class="dataformatselector">
    <div class="mdl-align">
--- a/lib/templates/email_fromname.mustache
+++ b/lib/templates/email_fromname.mustache
@ -15,7 +15,7 @@
    along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 }}
 {{!
-    @template core/email_html
+    @template core/email_fromname

    Template for all email subjects.

@ -31,5 +31,10 @@
    * fromname
    * replyto
    * replytoname
+
+    Example context (json):
+    {
+        "fromname": "Joe Bloggs"
+    }
 }}
 {{{fromname}}}
--- a/lib/templates/email_html.mustache
+++ b/lib/templates/email_html.mustache
@ -34,5 +34,10 @@
    * replyto
    * replytoname
    * body
+
+    Example context (json):
+    {
+        "body": "Email body"
+    }
 }}
 {{{body}}}
--- a/lib/templates/email_subject.mustache
+++ b/lib/templates/email_subject.mustache
@ -15,7 +15,7 @@
    along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 }}
 {{!
-    @template core/email_html
+    @template core/email_subject

    Template for all email subjects.

@ -31,5 +31,10 @@
    * fromname
    * replyto
    * replytoname
+
+    Example context (json):
+    {
+        "subject": "Email subject"
+    }
 }}
 {{{subject}}}
--- a/lib/templates/email_text.mustache
+++ b/lib/templates/email_text.mustache
@ -33,5 +33,10 @@
    * replyto
    * replytoname
    * body
+
+    Example context (json):
+    {
+        "body": "Email body"
+    }
 }}
 {{{body}}}
--- a/lib/templates/help_icon.mustache
+++ b/lib/templates/help_icon.mustache
@ -15,7 +15,23 @@
    along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 }}
 {{!
+    @template core/help_icon
+
    Help icon.
+
+    Example context (json):
+    {
+        "title": "Help with something",
+        "url": "http://example.org/help",
+        "linktext": "",
+        "icon":{
+            "attributes": [
+                {"name": "class", "value": "iconhelp"},
+                {"name": "src", "value": "../../../pix/help.svg"},
+                {"name": "alt", "value": "Help icon"}
+            ]
+        }
+    }
 }}
 <span class="helptooltip">
    <a href="{{url}}" title={{#quote}}{{title}}{{/quote}} aria-haspopup="true" target="_blank">{{#icon}}{{>core/pix_icon}}{{/icon}}{{#linktext}}{{.}}{{/linktext}}</a>
--- a/lib/templates/hover_tooltip.mustache
+++ b/lib/templates/hover_tooltip.mustache
@ -27,6 +27,10 @@

    Context variables required for this template:
    * none
+
+    Example context (json):
+    {
+    }
 }}
 <div class="hover-tooltip-container">
    {{$anchor}}{{/anchor}}
--- a/lib/templates/loading.mustache
+++ b/lib/templates/loading.mustache
@ -29,5 +29,8 @@

    Context variables required for this template:
    *
+
+    Example context (json):
+    {}
 }}
 <span class="loading-icon">{{#pix}} y/loading, core, {{#str}} loading {{/str}} {{/pix}}</span>
--- a/lib/templates/login.mustache
+++ b/lib/templates/login.mustache
@ -18,6 +18,25 @@
    @template core/login

    Moodle template for the login page.
+
+    Example context (json):
+    {
+        "autofocusform": false,
+        "canloginasguest": true,
+        "canloginbyemail": true,
+        "cansignup": true,
+        "error": "testerror",
+        "errorformatted": "Test error formatted",
+        "forgotpasswordurl": "http://example.com/login/forgot_password.php",
+        "hasidentityproviders": false,
+        "hasinstructions": true,
+        "instructions": "For full access to this site, you first need to create an account.",
+        "loginurl": "http://example.com/stable_master/login/index.php",
+        "rememberusername": true,
+        "passwordautocomplete": false,
+        "signupurl": "http://localhost/stable_master/login/signup.php",
+        "cookieshelpiconformatted": ""
+    }
 }}
 {{#hasinstructions}}
 <div class="loginbox clearfix twocolumns">
@ -155,5 +174,5 @@
            });
        {{/autofocusform}}
    {{/error}}
-    })
+    });
 {{/js}}
--- a/lib/templates/pix_icon.mustache
+++ b/lib/templates/pix_icon.mustache
@ -33,8 +33,9 @@
    Example context (json):
    {
        "attributes": [
-            { "name": "src", "value": "http://moodle.com/wp-content/themes/moodle/images/logo-hat2.png" },
-            { "name": "class", "value": "iconsmall" }
+            { "name": "src", "value": "https://moodle.org/logo/moodle-logo.svg" },
+            { "name": "class", "value": "iconsmall" },
+            {"name": "alt", "value": "Alt text for icon"}
        ]
    }

--- a/lib/templates/progress_bar.mustache
+++ b/lib/templates/progress_bar.mustache
@ -15,12 +15,14 @@
    along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 }}
 {{!
+    @template core/progress_bar
+
    Progress bar.

    Example context (json):
    {
-        id: 'progressbar_test',
-        width: '500'
+        "id": "progressbar_test",
+        "width": "500"
    }
 }}
 <div class="progressbar_container" style="width: {{width}}px;" id="{{id}}">
--- a/lib/templates/select_time.mustache
+++ b/lib/templates/select_time.mustache
@ -15,7 +15,20 @@
    along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 }}
 {{!
+    @template core/select_time
+
    Select time.
+
+    Example context (json):
+    {
+        "id": "test-id",
+        "name": "test-name",
+        "label": "Test label",
+        "options": [
+            {"name": "Option 1", "value": "1"},
+            {"name": "Option 2", "value": "2"}
+        ]
+    }
 }}
 <label for="{{id}}" class="accesshide">{{label}}</label>
 <select name="{{name}}" id="{{id}}" {{#attributes}} {{name}}="{{value}}"{{/attributes}}>
--- a/lib/templates/signup_form_layout.mustache
+++ b/lib/templates/signup_form_layout.mustache
@ -1,2 +1,10 @@
+{{!
+    @template core/signup_form_layout
+
+    Example context (json):
+    {
+        "formhtml": "<p>(Form html would go here)</p>"
+    }
+}}
 <h3>{{#str}}newaccount{{/str}}</h3>
 {{{formhtml}}}
--- a/lib/templates/skip_links.mustache
+++ b/lib/templates/skip_links.mustache
@ -1,3 +1,14 @@
+{{!
+    @template core/skip_links
+
+    Example context (json):
+    {
+        "links": [
+            {"url": "http://example.com/link1", "text": "Link 1"},
+            {"url": "http://example.com/link2", "text": "Link 2"}
+        ]
+    }
+}}
 <div class="skiplinks">
 {{#links}}
    <a href="#{{{url}}}" class="skip">{{{text}}}</a>
--- a/theme/boost/templates/core/action_menu.mustache
+++ b/theme/boost/templates/core/action_menu.mustache
@ -15,7 +15,20 @@
    along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 }}
 {{!
+    @template core/action_menu
+
    Action menu.
+
+    Example context (json):
+    {
+        "classes": "",
+        "primary": {
+            "items": [{"rawhtml": "<p>Item in primary menu</p>"}]
+        },
+        "secondary": {
+            "items": [{"rawhtml": "<p>Item in secondary menu</p>"}]
+        }
+    }
 }}
 <div class="action-menu {{classes}}" {{#attributes}}{{name}}="{{value}}"{{/attributes}}>
    {{#primary}}
--- a/theme/boost/templates/core/action_menu_item.mustache
+++ b/theme/boost/templates/core/action_menu_item.mustache
@ -15,7 +15,14 @@
    along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 }}
 {{!
+    @template core/action_menu_item
+
    Action menu item.
+
+    Example context (json):
+    {
+        "rawhtml": "<p>[rawhtml]</p>"
+    }
 }}
 {{#actionmenulink}}{{> core/action_menu_link }}{{/actionmenulink}}
 {{#actionmenufiller}}<span class="filler">&nbsp;</span>{{/actionmenufiller}}
--- a/theme/boost/templates/core/action_menu_link.mustache
+++ b/theme/boost/templates/core/action_menu_link.mustache
@ -15,7 +15,16 @@
    along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 }}
 {{!
+    @template core/action_menu_link
+
    Action menu link.
+
+    Example context (json):
+    {
+        "text": "Example link text",
+        "showtext": true,
+        "url": "http://example.com/link"
+    }
 }}
 {{^disabled}}
    <a href="{{url}}" class="{{classes}}" {{#attributes}}{{name}}={{#quote}}{{value}}{{/quote}}{{/attributes}} {{#showtext}}aria-labelledby="actionmenuaction-{{instance}}"{{/showtext}}>{{#icon}}{{>core/pix_icon}}{{/icon}}{{#showtext}}<span class="menu-action-text" id="actionmenuaction-{{instance}}">{{{text}}}</span>{{/showtext}}</a>
--- a/theme/boost/templates/core/chooser.mustache
+++ b/theme/boost/templates/core/chooser.mustache
@ -15,7 +15,26 @@
    along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 }}
 {{!
+    @template core/chooser
+
    Chooser.
+
+    Example context (json):
+    {
+        "title": "Chooser title",
+        "method": "post",
+        "actionurl": "http://example.org/test",
+        "instructions": "Choose one:",
+        "paramname": "param",
+        "sections": [{
+            "id": "section-1",
+            "label": "Section one",
+            "items": [{
+                "label": "item one",
+                "description": "description one"
+            }]
+        }]
+    }
 }}
 <div class="hd choosertitle">
    {{title}}
--- a/theme/boost/templates/core/dataformat_selector.mustache
+++ b/theme/boost/templates/core/dataformat_selector.mustache
@ -25,6 +25,16 @@
    * options
    * sesskey
    * submit
+
+    Example context (json):
+    {
+        "base": "http://example.org/",
+        "name": "test",
+        "label": "Download table data as",
+        "params": false,
+        "options": [{"label": "CSV", "name": "csv"}, {"label": "Excel", "name": "excel"}],
+        "submit": "Download"
+    }
 }}
 <form method="get" action="{{base}}" class="dataformatselector m-a-1">
    <div class="form-inline text-xs-right">
--- a/theme/boost/templates/core/help_icon.mustache
+++ b/theme/boost/templates/core/help_icon.mustache
@ -1,3 +1,22 @@
+{{!
+    @template core/help_icon
+
+    Help icon.
+
+    Example context (json):
+    {
+        "title": "Help with something",
+        "url": "http://example.org/help",
+        "linktext": "",
+        "icon":{
+            "attributes": [
+                {"name": "class", "value": "iconhelp"},
+                {"name": "src", "value": "../../../pix/help.svg"},
+                {"name": "alt", "value": "Help icon"}
+            ]
+        }
+    }
+}}
 <a class="btn btn-link p-a-0" role="button"
    data-container="body" data-toggle="popover"
    data-placement="{{#ltr}}right{{/ltr}}{{^ltr}}left{{/ltr}}" data-content="{{text}} {{completedoclink}}"
--- a/theme/boost/templates/core/progress_bar.mustache
+++ b/theme/boost/templates/core/progress_bar.mustache
@ -15,15 +15,17 @@
    along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 }}
 {{!
+    @template core/progress_bar
+
    Progress bar.

    Example context (json):
    {
-        id: 'progressbar_test',
-        width: '500'
+        "id": "progressbar_test",
+        "width": "500"
    }
 }}
-<div class="row" id="{{id}}" class="progressbar_container">
+<div id="{{id}}" class="row progressbar_container">
    <div class="col-md-6 push-md-3">
        <p id="{{id}}_status" class="text-xs-center"></p>
        <progress id="{{id}}_bar" class="progress progress-striped progress-animated" value="0" max="100"></progress>
--- a/theme/boost/templates/core/select_time.mustache
+++ b/theme/boost/templates/core/select_time.mustache
@ -15,7 +15,20 @@
    along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 }}
 {{!
+    @template core/select_time
+
    Select time.
+
+    Example context (json):
+    {
+        "id": "test-id",
+        "name": "test-name",
+        "label": "Test label",
+        "options": [
+            {"name": "Option 1", "value": "1"},
+            {"name": "Option 2", "value": "2"}
+        ]
+    }
 }}
 <label for="{{id}}" class="sr-only">{{label}}</label>
 <select name="{{name}}" id="{{id}}" {{#attributes}} {{name}}="{{value}}"{{/attributes}} class="form-control">
--- a/theme/boost/templates/core/signup_form_layout.mustache
+++ b/theme/boost/templates/core/signup_form_layout.mustache
@ -1,3 +1,13 @@
+{{!
+    @template core/signup_form_layout
+
+    Example context (json):
+    {
+        "logourl": "https://moodle.org/logo/moodle-logo.svg",
+        "sitename": "Site name",
+        "formhtml": "<p>(Form html would go here)</p>"
+    }
+}}
 <div class="container-fluid">
    <div class="row">
        <div class="col-md-8 push-md-2 col-xl-6 push-xl-3">
--- a/theme/boost/templates/core/skip_links.mustache
+++ b/theme/boost/templates/core/skip_links.mustache
@ -1,3 +1,14 @@
+{{!
+    @template core/skip_links
+
+    Example context (json):
+    {
+        "links": [
+            {"url": "http://example.com/link1", "text": "Link 1"},
+            {"url": "http://example.com/link2", "text": "Link 2"}
+        ]
+    }
+}}
 <div>
 {{#links}}
    <a class="sr-only sr-only-focusable" href="#{{{url}}}">{{{text}}}</a>
--- a/theme/boost/templates/nav-drawer.mustache
+++ b/theme/boost/templates/nav-drawer.mustache
@ -1,3 +1,9 @@
+{{!
+    @template theme_boost/nav-drawer
+
+
+    Example context (json): {}
+}}
 <div id="nav-drawer" data-region="drawer" class="hidden-print moodle-has-zindex {{^navdraweropen}}closed{{/navdraweropen}}" aria-hidden="{{#navdraweropen}}false{{/navdraweropen}}{{^navdraweropen}}true{{/navdraweropen}}" tabindex="-1">
    {{> theme_boost/flat_navigation }}
 </div>