https://github.com/catalyst/moodle-block_html_placeholders

https://moodle.org/plugins/block_html_placeholders
https://github.com/catalyst/moodle-block_html_placeholders

Last synced: 3 days ago
JSON representation

https://moodle.org/plugins/block_html_placeholders

• Host: GitHub
• URL: https://github.com/catalyst/moodle-block_html_placeholders
• Owner: catalyst
• Created: 2021-10-01T00:17:23.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2022-06-03T06:32:14.000Z (over 2 years ago)
• Last Synced: 2023-04-18T23:29:54.491Z (over 1 year ago)
• Language: PHP
• Homepage:
• Size: 50.8 KB
• Stars: 1
• Watchers: 6
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/catalyst/moodle-block_html_placeholders/ci/master)

* [Branches](#branches)

* [What is this?](#what-is-this)

* [Helper page?](#helper-page)

* [Examples](#examples)  

* [Installation and configuration](#installation-and-configuration)

* [Issues and feedback](#issues-and-feedback)

* [Credits and Thanks](#credits-and-thanks)

Branches

--------

For Moodle 3.9 Onwards, use the master branch.

What is this?

-------------

    

This is pretty much a copy of core block_html, but with the possibility to use placeholders in HTML content.  

A lists of known placeholders with their default values could be preconfigured on a site level .

There is some logic involved for figuring out what value needs to be set for each of the placeholders.

1. Try to get values from URL ( if that happens then those values are saved for the user).

2. Try to get values from user preferences.

3. Fall back to the default values from config.

Helper page

-------------

There is a complimentary page included with this plugin. This page uses my dashboard layout and can be used as an 

additional page for providing some information as well as setting up some placeholders for users 

(even if you don't have html_placeholders b lock on this page).

 

The page can also be used just for setting up your placeholders for a user and then redirecting to any of the Moodle pages.  

Examples

-------------

1. Your Moodle front page has an instance of html_placeholders block with {{profession}} placeholder in its content.

   

   https://example.com/?profession=Doctor -> will replace {{profession}} with Doctor 

   

   https://example.com/?profession=Nurse -> will replace {{profession}} with Nurse

2. Your Moodle front page has an instance of html_placeholders block with {{profession}} and {{type}} placeholders in 

   its content. 

   

   https://example.com/blocks/html_placeholders/landing.php?redirect=/&profession=Doctor&type=On-line -> will set  profession and type for a user and then redirect to the front page, where will replace {{profession}} with Doctor and  {{type}} with On-line

Using Shortcodes

-------------   

This plugin supports shortcodes (see https://moodle.org/plugins/filter_shortcodes).

To be able to utilise this feature you require filter_shortcodes plugin to be installed in your Moodle.  

Then you can wrap your placeholders into [htmlplaceholder] tag in any HTML content across your site.

Example: 

[htmlplaceholder]{{profession}}[/htmlplaceholder]

Installation and Configuration

------------------------------

1. Install the same as any other moodle plugin:

    Using git

     git clone [email protected]:catalyst/moodle-block_html_placeholders.git blocks/html_placeholders

    Or install via the Moodle plugin directory:

     https://moodle.org/plugins/block_html_placeholders

2. If you require using Shortcodes, then install additional filter_shortcodes plugin (see https://moodle.org/plugins/filter_shortcodes)  

3. Then run the Moodle upgrade

4. Visit Site Administration -> Plugins -> Blocks -> HTML with placeholders and configure the list of placeholders.

5. Now add the block to any page, then you can embed your placeholders as {{placeholder_name}} in HTML content or title. 

6. If you use filter_shortcodes, then you can embed your placeholders as [htmlplaceholder]{{placeholder_name}}[/htmlplaceholder] in any HTML content.

Contributing

------------

Pull requests are welcome, please adhere to the Moodle code standards.

Issues and feedback

-------------------

If you have issues please log them in github here:

https://github.com/catalyst/moodle-block_html_placeholders/issues

Or if you want paid support please contact Catalyst IT Australia:

https://www.catalyst-au.net/contact-us

Credits and thanks

------------------

This plugin was sponsored by OET Online:

https://oetonline.net.au/

This plugin was developed by Catalyst IT Australia:

https://www.catalyst-au.net/