diff --git a/docs/guides/templates/index.md b/docs/guides/templates/index.md index 37ea64d4c4..0ba386ad0a 100644 --- a/docs/guides/templates/index.md +++ b/docs/guides/templates/index.md @@ -528,6 +528,15 @@ Templates can be overridden by a theme. 1. Copy the `ratingui.mustache` file into the newly created `theme/timtam/templates/mod_wiki` and edit it. You should see your changes immediately if theme designer mode is on. Templates are cached just like CSS, so if you are not using theme designer mode you will need to purge all caches to see the latest version of an edited template. If the template you are overriding contains a documentation comment it is recommended to remove it. It will still show the documentation in the template library. +### Examples + +| Path for original template | Component | Theme override path | +| --- | --- | --- | +| `public/blocks/myoverview/templates/view-summary.mustache` | `block_myoverview` | `public/theme/mytheme/templates/block_myoverview/view-summary.mustache` | +| `public/group/templates/group_details.mustache` | `core_group` | `public/theme/mytheme/templates/core_group/group_details.mustache` | +| `public/lib/templates/modal.mustache` | `core` | `public/theme/mytheme/templates/core/modal.mustache` | +| `public/theme/boost/templates/navbar.mustache` | `theme_boost` | `public/theme/mytheme/templates/theme_boost/navbar.mustache` | + ## Documenting the templates Theme designers need to know the limits of what they can expect to change without breaking anything. Also, correctly documented templates can be previewed in the "Template library" tool shipped with Moodle. diff --git a/versioned_docs/version-4.1/guides/templates/index.md b/versioned_docs/version-4.1/guides/templates/index.md index 37ea64d4c4..fe1d284320 100644 --- a/versioned_docs/version-4.1/guides/templates/index.md +++ b/versioned_docs/version-4.1/guides/templates/index.md @@ -528,6 +528,15 @@ Templates can be overridden by a theme. 1. Copy the `ratingui.mustache` file into the newly created `theme/timtam/templates/mod_wiki` and edit it. You should see your changes immediately if theme designer mode is on. Templates are cached just like CSS, so if you are not using theme designer mode you will need to purge all caches to see the latest version of an edited template. If the template you are overriding contains a documentation comment it is recommended to remove it. It will still show the documentation in the template library. +### Examples + +| Path for original template | Component | Theme override path | +| --- | --- | --- | +| `blocks/myoverview/templates/view-summary.mustache` | `block_myoverview` | `theme/mytheme/templates/block_myoverview/view-summary.mustache` | +| `group/templates/group_details.mustache` | `core_group` | `theme/mytheme/templates/core_group/group_details.mustache` | +| `lib/templates/modal.mustache` | `core` | `theme/mytheme/templates/core/modal.mustache` | +| `theme/boost/templates/navbar.mustache` | `theme_boost` | `theme/mytheme/templates/theme_boost/navbar.mustache` | + ## Documenting the templates Theme designers need to know the limits of what they can expect to change without breaking anything. Also, correctly documented templates can be previewed in the "Template library" tool shipped with Moodle. diff --git a/versioned_docs/version-4.4/guides/templates/index.md b/versioned_docs/version-4.4/guides/templates/index.md index 37ea64d4c4..fe1d284320 100644 --- a/versioned_docs/version-4.4/guides/templates/index.md +++ b/versioned_docs/version-4.4/guides/templates/index.md @@ -528,6 +528,15 @@ Templates can be overridden by a theme. 1. Copy the `ratingui.mustache` file into the newly created `theme/timtam/templates/mod_wiki` and edit it. You should see your changes immediately if theme designer mode is on. Templates are cached just like CSS, so if you are not using theme designer mode you will need to purge all caches to see the latest version of an edited template. If the template you are overriding contains a documentation comment it is recommended to remove it. It will still show the documentation in the template library. +### Examples + +| Path for original template | Component | Theme override path | +| --- | --- | --- | +| `blocks/myoverview/templates/view-summary.mustache` | `block_myoverview` | `theme/mytheme/templates/block_myoverview/view-summary.mustache` | +| `group/templates/group_details.mustache` | `core_group` | `theme/mytheme/templates/core_group/group_details.mustache` | +| `lib/templates/modal.mustache` | `core` | `theme/mytheme/templates/core/modal.mustache` | +| `theme/boost/templates/navbar.mustache` | `theme_boost` | `theme/mytheme/templates/theme_boost/navbar.mustache` | + ## Documenting the templates Theme designers need to know the limits of what they can expect to change without breaking anything. Also, correctly documented templates can be previewed in the "Template library" tool shipped with Moodle. diff --git a/versioned_docs/version-4.5/guides/templates/index.md b/versioned_docs/version-4.5/guides/templates/index.md index 37ea64d4c4..fe1d284320 100644 --- a/versioned_docs/version-4.5/guides/templates/index.md +++ b/versioned_docs/version-4.5/guides/templates/index.md @@ -528,6 +528,15 @@ Templates can be overridden by a theme. 1. Copy the `ratingui.mustache` file into the newly created `theme/timtam/templates/mod_wiki` and edit it. You should see your changes immediately if theme designer mode is on. Templates are cached just like CSS, so if you are not using theme designer mode you will need to purge all caches to see the latest version of an edited template. If the template you are overriding contains a documentation comment it is recommended to remove it. It will still show the documentation in the template library. +### Examples + +| Path for original template | Component | Theme override path | +| --- | --- | --- | +| `blocks/myoverview/templates/view-summary.mustache` | `block_myoverview` | `theme/mytheme/templates/block_myoverview/view-summary.mustache` | +| `group/templates/group_details.mustache` | `core_group` | `theme/mytheme/templates/core_group/group_details.mustache` | +| `lib/templates/modal.mustache` | `core` | `theme/mytheme/templates/core/modal.mustache` | +| `theme/boost/templates/navbar.mustache` | `theme_boost` | `theme/mytheme/templates/theme_boost/navbar.mustache` | + ## Documenting the templates Theme designers need to know the limits of what they can expect to change without breaking anything. Also, correctly documented templates can be previewed in the "Template library" tool shipped with Moodle. diff --git a/versioned_docs/version-5.0/guides/templates/index.md b/versioned_docs/version-5.0/guides/templates/index.md index 37ea64d4c4..fe1d284320 100644 --- a/versioned_docs/version-5.0/guides/templates/index.md +++ b/versioned_docs/version-5.0/guides/templates/index.md @@ -528,6 +528,15 @@ Templates can be overridden by a theme. 1. Copy the `ratingui.mustache` file into the newly created `theme/timtam/templates/mod_wiki` and edit it. You should see your changes immediately if theme designer mode is on. Templates are cached just like CSS, so if you are not using theme designer mode you will need to purge all caches to see the latest version of an edited template. If the template you are overriding contains a documentation comment it is recommended to remove it. It will still show the documentation in the template library. +### Examples + +| Path for original template | Component | Theme override path | +| --- | --- | --- | +| `blocks/myoverview/templates/view-summary.mustache` | `block_myoverview` | `theme/mytheme/templates/block_myoverview/view-summary.mustache` | +| `group/templates/group_details.mustache` | `core_group` | `theme/mytheme/templates/core_group/group_details.mustache` | +| `lib/templates/modal.mustache` | `core` | `theme/mytheme/templates/core/modal.mustache` | +| `theme/boost/templates/navbar.mustache` | `theme_boost` | `theme/mytheme/templates/theme_boost/navbar.mustache` | + ## Documenting the templates Theme designers need to know the limits of what they can expect to change without breaking anything. Also, correctly documented templates can be previewed in the "Template library" tool shipped with Moodle.