MDL-69549 core: Add context export API
[moodle.git] / lib / templates / content / export / course_summary.mustache
1 {{!
2     This file is part of Moodle - http://moodle.org/
4     Moodle is free software: you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation, either version 3 of the License, or
7     (at your option) any later version.
9     Moodle is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
14     You should have received a copy of the GNU General Public License
15     along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
16 }}
17 {{!
18     @template core/content/export/course_summary
20     Renders course summary and overview information.
21     This template is not for use within moodle.
23     Classes required for JS:
24     * none
26     Data attributes required for JS:
27     * none
29     Context variables required for this template:
30     * global
32     Example context (json):
33     {
34         "global": {
35             "righttoleft": 0,
36             "language": "en",
37             "sitename": "Kevin's Emporium of fine course material",
38             "siteurl": "https://kevin.example.com",
39             "pathtotop": "./",
40             "contentexportfooter": "This file is part of the content downloaded from <a href='https://example.com'>Kevin's Emporium of fine course material</a> by Jennifer Collins on Tuesday, 24th February 2021, 12:21 am.",
41             "contentexportsummary": "This file is part of the content downloaded from <a href='https://example.com/course/view.php?id=4'>Kevin's Emporium of fine course material</a> on Tuesday, 24th February 2021, 12:21 am.",
42             "coursename": "Marketing 101",
43             "courseshortname": "MKT101",
44             "courselink": "https://example.com/course/view.php?id=4",
45             "exportdate": "Tuesday, 24th February 2021, 12:21 am",
46             "maxfilesize": "40MB"
47         },
48         "summary": "<p>This is a summary of the course, and it may contain PLUGINFILE references.</p>",
49         "overviewfiles": [
50             {
51                 "filepath": "./_course/overviewfiles/example.pdf",
52                 "filename": "Example PDF"
53             },
54             {
55                 "filepath": "./_course/overviewfiles/example.jpg",
56                 "filename": "Example JPG"
57             }
58         ]
59     }
60 }}
61 {{<core/content/export/external_page}}
62 {{$pagecontent}}
63     <div class="alert alert-info alert-block">
64         {{{global.contentexportsummary}}}
65     </div>
66     {{#summary}}
67     <h2>{{#str}}summary, core{{/str}}</h2>
68     <div>
69         {{{summary}}}
70     </div>
71     <hr>
72     {{/summary}}
74     {{#overviewfiles.0}}
75     <h2>{{#str}}courseoverviewfiles, core{{/str}}</h2>
76     <div>
77         {{#overviewfiles.0}}
78         <ul>
79         {{#overviewfiles}}
80             <li><a href="{{filepath}}" title="{{#str}}contentexport_viewfilename, core, {{filename}}{{/str}}">{{filename}}</a></li>
81         {{/overviewfiles}}
82         </ul>
83         {{/overviewfiles.0}}
84     </div>
85     <hr>
86     {{/overviewfiles.0}}
87 {{/pagecontent}}
88 {{/core/content/export/external_page}}