Snippet Tag Attributes
 

Introduction

Configuration of each Snippet is accomplished by adding the desired attribute (and the value for that attribute) to the snippet tag.

An attribute is always followed by its value, and uses the following pattern:

attribute="value goes here"
or
attribute='value goes here'


A Word About Using Single And Double Quotes

You can use either 'single' or "double" quotes to specify the attribute value, as long as they match. (ie: If you start with a single quote then you must end with a single quote. You can't mix them up, otherwise the system will get confused as to where your value starts and stops.)

Note: You must be careful that your attribute value does not use the same type of quote character being used to specify the value. ie: If you use single quotes to specify your attribute value, then the value can not use the single quote character. So you must NOT do something like this:

attribute='value 'goes' here'
or
attribute="value "goes" here"

If you wanted to include quotes in your attribute value, then you could do something like this:

attribute='value "goes" here'
or
attribute="value 'goes' here"


Specifying Multiple Attribute Values

If an attribute has more then one value, then the list of values MUST be comma-seperated. (It doesn't matter if you have a space after the comma, but I think it's easier to read if you do.)

attribute="value1,value2,value3"
or
attribute='value1, value2, value3'


Some Examples To Show How It All Works

Here is an example of a basic snippet tag that has one attribute.

<!-- #BeginSnippet attribute="value" -->

Here's an example of one attribute that has three values:

<!-- #Beginsnippet attribute='value1, value2, value3' -->

Here's an example of two attributes:

<!-- #beginSnippet attribute1="value" attribute2='value' -->


The Full List Of Snippet Tag Attributes

Here is an example of how to specify a snippet that has a name of "My Snippet", is editable only by "user1" and "user2", has a width of 100%, and a height of "350 pixels".

<!-- #beginSnippet name="My Snippet" users='user1,user2' width="100%" height="350" -->


The Full List Of Snippet Tag Attributes

Here is the full list of all attributes you can use, including usage instructions.

Attribute Name
 Description
name

Summary:

Give your snippet a nice name to make it easier for your client to identify it.

Usage:

name="Name for snippet goes here"
users

Summary:

An "Access Control List" (ACL) of users who have the ability to edit this snippet. If this attribute is not specified, then ALL users will be able to edit the snippet. If this attribute is specified then access to the snippet will be limited to only Admin Users, Power Users, Super Users, and the users that are included in this list.

Usage:

users="user1, user2"
 
wysiwyg

Summary:

Should this snippet use the WYSIWYG visual editor? The value you specify for this attribute will override the value from the Editor Group.

For example, if you do NEVER want a particular snippet to use the visual editor then you can use this attribute to disable the editor for that snippet. (ie: The snippet text will always be displayed for editing in a regular textbox.)

Usage:

wysiwyg="no"
wysiwyg="yes"

Note: This feature is not available in the free LITE version. Please consider supporting the SnippetMaster software by purchasing the PRO version if you would like to use this feature. Thanks! (A free trial is available if you want to test it out.)
 
width

Summary:

What width should the editor be for this snippet? The value you specify for this attribute will override the value from the Editor Group.

For example, if you know the user will be editing a really wide page, then you can set the width to 100% and the editor will use the entire browser width.

You can specify either pixels or percent.

Usage:

width="400"
width="100%"

Note: This feature is not available in the free LITE version. Please consider supporting the SnippetMaster software by purchasing the PRO version if you would like to use this feature. Thanks! (A free trial is available if you want to test it out.)
 
height

Summary:

What height should the editor be for this snippet? The value you specify for this attribute will override the value from the Editor Group.

For example, if you know the user will only need to enter one or two lines of text, then you can limit the height to perhaps 100 pixels.

You can specify either pixels or percent.

Usage:

height="400"
height="50%"

Note: This feature is not available in the free LITE version. Please consider supporting the SnippetMaster software by purchasing the PRO version if you would like to use this feature. Thanks! (A free trial is available if you want to test it out.)
 
lastsavedts

Summary:

This is a read-only tag that indicates the date and time (the "timestamp") when this snippet was last saved. If you manually change the value, then it will automatically be updated the next time the snippet is edited and saved.

Usage:

Not applicable. This tag is set automatically by the program.
 
lastsavedby

Summary:

This is a read-only tag that indicates the username who last saved this snippet. If you manually change the value, then it will automatically be updated the next time the snippet is edited and saved.

Usage:

Not applicable. This tag is set automatically by the program.