Page: Snippets

Available from Stentor version 6.1.0.

Introduction

Snippets are reusable pieces of content. A snippet is stored in the database, and can be used on multiple pages. When the contents of the snippet is changed in the database, all pages that embed this snippet will reflect these changes.

You create a new snippet by choosing the 'define snippet' component. Use this container to construct your snippet. Enter a name for the snippet when ready. Click the 'Save & embed' button to store the snippet in the database. The component is automatically converted to an 'embed snippet' component.

An 'embed snippet' is used to link to a snippet that is stored in the database. Enter the name in the search field and pick the snippet from the matching results.

An embedded snippet can be changed by clicking 'Unlink & edit'. The link with the database is severed and you can make any necessary changes. You can store these changes under a new name (the 'old' snippet will still be in the database as well), or under the same name if you check the 'Overwrite' option.

If you're in the Stentor Administrator you can edit snippets by clicking the icon next to the title. You'll be taken to a webeditor environment without the option to save a page (there is no page), but where you can change, copy, and create snippets. These actions are meant to be done in the webeditor, not in the Administrator.

Example 'define snippet'

This snippet is not saved yet. When the page is saved, the snippet isn't automatically saved as well, but will stay in the 'define' mode. Once a name is entered and 'Save & embed' clicked you can use the snippets in other places as well.

Example 'embed snippet'

This snippet is linked to the database. You can't edit this snippet directly, you'll have to click 'Unlink & edit' first. You'll be taken to 'define snippet' mode.

Change an embedded snippet

This snippet is no longer linked to the database. The name is pre-filled, so you can quickly make changes to an existing snippet. As confirmation you'll have to check the 'Yes, overwrite existing snippet' box.

You can also simply change the name field to store the snippet under a different name. When you type a name of an existing snippet, you'll see the 'Overwrite' checkbox as an indication.

Can I create a new snippet in the Administrator?

No, you'll always do this through the webeditor in the page where you want to show the snippet.

How do I copy an existing snippet?

Choose 'embed snippet' and find the snippet you wish to copy. Click 'Unlink & edit', and make your changes. Then, change the name and click 'Save & embed'.

Can I make a copy in the Administrator?

No, webeditor snippets are exclusively maintained through the webeditor. Exception: for translation of snippets you can make copies in different languages, but you shouldn't modify the id (possibly you'll want to modify the title).

Can I rename a snippet?

Yes, change the title through the Administrator.

How do I translate a snippet?

You can use the Administrator; select the snippet and click 'copy', remove the 'copy-of-' text from the prefix field and select the appropriate language. You may wish to modify the title as well if it is language-dependent.

Can I place a snippet inside another snippet?

Yes, you can. The only limitation is that you cannot place a snippet inside itself (not even indirectly through another snippet).

How do I delete a snippet?

Make sure this snippet isn't used on other pages or snippets. Then, use the Administrator to select and delete the snippet from the database.