Atto: Snippet (Atto)

atto_snippet
Maintained by Picture of Justin Hunt Justin Hunt
Snippet is simple html/text template tool for Moodle's Atto editor. Use it to add text, layouts, buttons and other content from templates directly into Moodle HTML areas.
115 sites
149 downloads
12 fans
Snippet is a template solution for Moodle content creation. Templates and variables(placeholders) are declared in the admin settings for the plugin. When the icon is click on the Atto editor, the user can choose the template and the values for each of the variables. The placeholders and template are then merged to create the final content which is then inserted on the page.

Snippet has no filter plugin companion. It returns html directly to the text area. This is useful when the content doesn't need javascript, and has the benefit that the content is instantly visible and editable in the text area (ie without filtering). As an example of this, the Youtube template will display a Youtube video in the html editor text area immediately.


Installation

If using zip, first download and unzip the file, and place the snippet folder in your Moodle's /lib/editor/atto/plugins folder. Or use git directly from the /lib/editor/atto/plugins folder, ie
git clone https://github.com/justinhunt/moodle-atto_snippet.git snippet

Then visit your site admin's notifications page. The plugin installer will walk through the installation process. At the end you will see a list of 5 templates. You can leave them for now and fill them in later.  3 of the templates are blank, and a helloworld and a youtube template are automatically created for you.

Before the Snippet icon will be visible in the Atto toolbar you will need to visit site admin -> plugins -> text editors -> atto -> atto toolbar settings, and add "snippet" to the list of icons to display. There is a text area towards the bottom of the page for this purpose.


Using Snippet

To use a snippet, look for the spider web/cog icon on the text editor. (Feel free to submit a cooler icon.) Checking on that should open the Snippet dialog with a button for each snippet.

To make a snippet, find an empty snippet template page in the plugin's admin settings, site admin -> plugins -> text editors -> atto -> Snippet(Atto) -> Snippets. Enter a name for the snippet, the content of the snippet and any default variable values. Variables can be used in the snippet content and are surrounded by {{ or }} marks. Like this: {{bigvariable}}


An example snippet:
Snippet Name
sweety

Snippet
My sweet food on {{weekday}} is: {{mysweety}}

Defaults
mysweety=candy,weekday=Monday

This could display as:
My sweet food on Thursday is: cake

If you run out of blank snippet templates, you can always create more. Set the number of snippets on the general settings page.
site admin -> plugins -> text editors -> atto -> Snippet(atto) -> General Settings

Presets

There is a dropdown list of presets at the top of each snippet settings page. These will fill the template page in with the details of a preset template. You can make your own presets and share them too. To do this you can the template by mouse clicking on the green "bundle" box on the top right of the template settings page. It will download as a .txt file. Drag an exported .txt file over the green bundle box on a blank template settings page to import it.


If you wish your exported template to appear in the presets dropdown you must place the .txt file in the presets folder under /lib/editor/atto/plugins/snippet. Or in a folder called "snippet" in your theme.



Screenshots

Screenshot #0
Screenshot #1
Screenshot #2

Contributors

Picture of Justin Hunt
Justin Hunt (Lead maintainer)
Please login to view contributors details and/or to contact them

Comments RSS

Show comments
  • Picture of Plugins bot
    Mon, 17 Apr 2017, 1:40 PM
    Approval issue created: CONTRIB-6863
  • Picture of Richard Oelmann
    Sun, 1 Oct 2017, 5:34 PM
    Hi Justin, Is there anywhere else to get more information about adding snippets to themes, and also is there any location for gathering collected snippets people have created (or bundles etc)
  • Picture of Justin Hunt
    Mon, 2 Oct 2017, 10:24 AM
    Hi Richard. I wish I had better answers for you to be honest. Snippet's cousin's Generico has a place to share templates here .. https://moodle.org/plugins/browse.php?list=category&id=38. Though I have not found time to pump prime that. The idea was to do the same with snippets. But I need a bit of a rev up I guess.

    Adding a snippet to the theme is pretty simple. I added a note just now to the readme on github. https://github.com/justinhunt/moodle-atto_snippet . You just add a folder called "snippet" and put the template bundle files in there. The same thing works for Generico actually, except the folder is called "generico." It would be really nice if we had a one button installer to setup such templates so that it "just worked" without the added step of having to go off to snippet/generico and set them up. Let me know if you think thats a good idea and I will look into it.
Please login to post comments