MoodleDocs - User contributions [en]

ICON filter activatecontent

2022-09-14T10:17:30Z

Pascalschmascal: Created page with "== Activate content filter by ICON == The activate content filter by ICON lets you easily embed content from other platforms (often provided by a "Share -> embed" feature on..."

== Activate content filter by ICON ==

The activate content filter by ICON lets you easily embed content from other platforms (often provided by a "Share -> embed" feature on social media) in any content in a GDPR-compliant way.
What we mean by GDPR-compliant is that the content won't be inserted until users have given their consent by activating it with a click.

To embed content, copy the embed code from the other platform and paste it into the Moodle platform, preceded by {iconactivate} and followed by {/iconactivate}.
For example, if you're on https://www.youtube.com/watch?v=dQw4w9WgXcQ, you click on "Share" beneath the video, then on "Embed" and copy the code.
Then on Moodle, inside a text editor for example (make sure you're in HTML view if it's a rich text editor like TinyMCE or Atto), you paste it and add the snippets mentioned above like so:

<nowiki>
{iconactivate}
<iframe width="560" height="315" src="https://www.youtube.com/embed/dQw4w9WgXcQ" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
{/iconactivate}</nowiki>

You can also add a custom headline, by writing ''"|headline:Your headline here"'' before the closing {/iconactivate}, so the complete code could look like this:

<nowiki>{iconactivate}
<iframe width="560" height="315" src="https://www.youtube.com/embed/dQw4w9WgXcQ" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
|headline: This never gets old
{/iconactivate}</nowiki>

If you leave this last part out, the default header will say "Recommended external content" (you can modify this default text through language customization of course).
The language id is "headline" for component "filter_iconactivatecontent".

=== Installing via uploaded ZIP file ===

1. Log in to your Moodle site as an admin and go to _Site administration >
Plugins > Install plugins_.
2. Upload the ZIP file with the plugin code. You should only be prompted to add
extra details if your plugin type is not automatically detected.
3. Check the plugin validation report and finish the installation.

=== Installing manually ===

The plugin can be also installed by putting the contents of this directory to

{your/moodle/dirroot}/filter/iconactivatecontent

Afterwards, log in to your Moodle site as an admin and go to _Site administration >
Notifications_ to complete the installation.

Alternatively, you can run

$ php admin/cli/upgrade.php

to complete the installation from the command line.

=== License ===

2022 ICON Vernetzte Kommunikation GmbH <info@iconnewmedia.de>

This program is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any later
version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with
this program. If not, see <https://www.gnu.org/licenses/>.

ICON activatecontent

2022-09-14T09:58:29Z

Pascalschmascal: added a section for the plugin settings

{{Infobox plugin
|type = activity
|entry = Coming soon
|tracker = https://github.com/iconnewmedia-de/moodle-filter_iconactivatecontent/issues
|discussion = Coming soon
|maintainer = [[User:Pascal Collins]]
}}
== What is it? ==
This plugin is for when you want to include GDPR-compliant embeddings of content from external platforms such as YouTube, Facebook, Twitter, Instagram, Google Maps.

The issue with simply embedding the iframe code that social media platforms generate for you with their share-feature, is that those platforms might instantly set a cookie or receive the viewer's ip address upon opening your page.

The solution is to not include the iframe until the viewer has activated the content by pressing a button and thereby given their consent.
[[File:mod iconactivatecontent-before-activation.png|thumb|Before activation]]
[[File:screenshot-iconactivatecontent activated.png|thumb|After activation]]
==Using this plugin==
You add it to a course just like any other activity, by first enabling edit mode, then adding an activity.

This is the form that you'll be presented:<br>
[[File:screenshot-iconactivatecontent form.png|thumb|The form for adding/updating an instance of this activity]]
===External content===
Here is where you paste the HTML that the external platform will have given you for embedding on other pages.
====Embedding a YouTube video====
When you watch a video on YouTube, you'll see a "Share" link to the bottom right of the video. When you click it, you get a selection of possible share-options. The first option in the list is "Embed". Clicking it will give you the HTML for the iframe to embed. Copy this HTML snippet and paste it into the "External content" field of this plugin.
====Embedding a Tweet, Facebook post or Instagram post====
All three platforms are very similar: To the top right of the tweet you'll find three dots. Click on them to get a menu with further options. Further down you have "Embed Tweet". It opens a new tab with the HTML code to embed. Click on the "Copy Code" button next to it, then copy this into the "External content" field of this plugin. Note: From Facebook you can only embed your public posts!
====Embedding Google Maps====
When you've entered a location in Google maps, you get multiple buttons, the first one being "Directions", the last one "Share". Click the share button. A new layer pops up. It has two tabs. The first one is "Send a link". We don't want that one. Choose the second tab "Embed a map" instead. Then click on "Copy HTML"
===Headline, Text, Footer===
Those are the texts that will get displayed until the user has activated the external content. The default texts are just a suggestion. If you're using one of the platforms mentioned above, the "Platform" placeholder will automatically get replaced by the name of the platform as soon as the text editor for external content loses focus. The plugin will also automatically select the corresponding icon to display next to the teaser text.
===Icon===
The icon will be displayed to the right side of the text (see above "Headline, Text, Footer"). Five common icons are already available from the drop down: Twitter, YouTube, Facebook, Instagram and Google Maps. You also have the possibility to upload an icon of your choice or to not display any icon at all. Using icons is highly recommended as it allows users to quickly recognize the platforms that this will lead to.

== Settings ==
The plugin only has one setting: Maximum width. As the name suggests, it allows you to define the maximum width that you want it to take on the page. If you just type a number, or a number followed by "px", like 900, or 900px, the width is defined in Pixels. Alternatively you can add "%", like "90%". The percentage is relative to its surrounding block, the content column of the course.

You can of course also define widths from within your theme's CSS. This will give you the ability to define different widths for different screen sizes, for example. To do so, define width, min-width and/or max-width for the selector ".iconactivatecontent .externalcontent". You might have to use "!important" to override the activity's default max-width. width and min-width don't have a default.

==Installing via uploaded ZIP file==
Log in to your Moodle site as an admin and go to Site administration > Plugins > Install plugins.
Upload the ZIP file with the plugin code. You should only be prompted to add extra details if your plugin type is not automatically detected.
Check the plugin validation report and finish the installation.
Installing manually
The plugin can be also installed by putting the contents of this directory to

{your/moodle/dirroot}/mod/iconactivatecontent
Afterwards, log in to your Moodle site as an admin and go to Site administration > Notifications to complete the installation.

Alternatively, you can run

$ php admin/cli/upgrade.php
to complete the installation from the command line.

(Btw. "ICON" in the name of this plugin refers to the name of the company that created this, ICON Vernetzte Kommunikation GmbH. It has nothing to do with icons being an important feature of this plugin. We hope this doesn't cause any confusion.)
==License==
2022 ICON Vernetzte Kommunikation GmbH <pascal.collins@iconnewmedia.de>

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

ICON activatecontent

2022-09-14T09:18:29Z

Pascalschmascal: Created page with "{{Infobox plugin |type = activity |entry = Coming soon |tracker = https://github.com/iconnewmedia-de/moodle-filter_iconactivatecontent/issues |discussion = Coming soon |mainta..."

{{Infobox plugin
|type = activity
|entry = Coming soon
|tracker = https://github.com/iconnewmedia-de/moodle-filter_iconactivatecontent/issues
|discussion = Coming soon
|maintainer = [[User:Pascal Collins]]
}}

== What is it? ==
This plugin is for when you want to include GDPR-compliant embeddings of content from external platforms such as YouTube, Facebook, Twitter, Instagram, Google Maps.

The issue with simply embedding the iframe code that social media platforms generate for you with their share-feature, is that those platforms might instantly set a cookie or receive the viewer's ip address upon opening your page.

The solution is to not include the iframe until the viewer has activated the content by pressing a button and thereby given their consent.

[[File:mod iconactivatecontent-before-activation.png|thumb|Before activation]]

[[File:mod iconactivatecontent-after-activation.png|thumb|Afteractivation]]

== Using this plugin ==
You add it to a course just like any other activity, by first enabling edit mode, then adding an activity.

This is the form that you'll be presented:<br>
[[File:screenshot-iconactivatecontent form.png|thumb|The form for adding/updating an instance of this activity]]

=== External content ===
Here is where you paste the HTML that the external platform will have given you for embedding on other pages.

==== Embedding a YouTube video ====
When you watch a video on YouTube, you'll see a "Share" link to the bottom right of the video. When you click it, you get a selection of possible share-options. The first option in the list is "Embed". Clicking it will give you the HTML for the iframe to embed. Copy this HTML snippet and paste it into the "External content" field of this plugin.

==== Embedding a Tweet, Facebook post or Instagram post ====
All three platforms are very similar: To the top right of the tweet you'll find three dots. Click on them to get a menu with further options. Further down you have "Embed Tweet". It opens a new tab with the HTML code to embed. Click on the "Copy Code" button next to it, then copy this into the "External content" field of this plugin. Note: From Facebook you can only embed your public posts!

==== Embedding Google Maps ====
When you've entered a location in Google maps, you get multiple buttons, the first one being "Directions", the last one "Share". Click the share button. A new layer pops up. It has two tabs. The first one is "Send a link". We don't want that one. Choose the second tab "Embed a map" instead. Then click on "Copy HTML"

=== Headline, Text, Footer ===
Those are the texts that will get displayed until the user has activated the external content. The default texts are just a suggestion. If you're using one of the platforms mentioned above, the "Platform" placeholder will automatically get replaced by the name of the platform as soon as the text editor for external content loses focus. The plugin will also automatically select the corresponding icon to display next to the teaser text.

=== Icon ===
The icon will be displayed to the right side of the text (see above "Headline, Text, Footer"). Five common icons are already available from the drop down: Twitter, YouTube, Facebook, Instagram and Google Maps. You also have the possibility to upload an icon of your choice or to not display any icon at all. Using icons is highly recommended as it allows users to quickly recognize the platforms that this will lead to.

== Installing via uploaded ZIP file ==
Log in to your Moodle site as an admin and go to Site administration > Plugins > Install plugins.
Upload the ZIP file with the plugin code. You should only be prompted to add extra details if your plugin type is not automatically detected.
Check the plugin validation report and finish the installation.
Installing manually
The plugin can be also installed by putting the contents of this directory to

{your/moodle/dirroot}/mod/iconactivatecontent
Afterwards, log in to your Moodle site as an admin and go to Site administration > Notifications to complete the installation.

Alternatively, you can run

$ php admin/cli/upgrade.php
to complete the installation from the command line.

(Btw. "ICON" in the name of this plugin refers to the name of the company that created this, ICON Vernetzte Kommunikation GmbH. It has nothing to do with icons being an important feature of this plugin. We hope this doesn't cause any confusion.)

== License ==
2022 ICON Vernetzte Kommunikation GmbH <pascal.collins@iconnewmedia.de>

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

File:screenshot-iconactivatecontent form.png

2022-09-14T09:12:12Z

Pascalschmascal: The settings for inserting/updating an instance of the activity mod_iconactivatecontent

== Summary ==
The settings for inserting/updating an instance of the activity mod_iconactivatecontent

File:screenshot-iconactivatecontent activated.png

2022-09-14T09:09:31Z

Pascalschmascal:

This screenshot shows the activity iconactivatecontent after a user has activated it by clicking/tapping

File:mod iconactivatecontent-before-activation.png

2022-09-14T09:07:42Z

Pascalschmascal: This screenshot shows the activity iconactivatecontent before a user has activated it by clicking/tapping

== Summary ==
This screenshot shows the activity iconactivatecontent before a user has activated it by clicking/tapping