Customize Page Layout: Edit Draft Version of a Dataset Layout Element
To edit the draft version of a customized page, select the
Custom Pages & Emails node of the desired dataset
or list, then select the Subscriber Pages tab in the pane on the right and click on the link of
the desired customized page. Then in the customization interface, select the Draft Version tab
and click on the Edit Source icon in the top right corner of that tab.
To edit the draft version of a customized message or input validation error, while the Custom Pages & Emails node is selected, select the Messages and Input Validation Errors tab, then proceed as described above.
To edit the draft version of a customized message or input validation error, while the Custom Pages & Emails node is selected, select the Messages and Input Validation Errors tab, then proceed as described above.
This screen allows for editing the draft version of the currently selected dataset layout element.
For each layout element, there are two different versions: The draft version and the production
version. The production version is the version that subscribers who access the subscriber area
pages actually see. The draft version, on the other hand, is not visible to the subscribers.
Therefore, any changes can be safely made to the draft version without them becoming
immediately visible. For example, pages can be customized one after the other by editing
their draft versions, but the customized versions are to be made available all at once when
each of the pages are finished. Or, the layout can be experimented with a bit, without
disrupting the actual production versions that subscribers see.
Only when the draft version is finally deployed as the new production version will the changes
become visible to subscribers.
There are two panes on this page, which are described in more detail below.
At the top right of this page, there is a drop-down list labelled "Currently Customizing:" that contains an entry for the subscriber area layout, and an entry for the layout of each list in the dataset. Navigating from the layout currently being customized to the layout of a different object (the subscriber area or a list) in the same dataset can be done quickly by making a selection in this drop-down list.
Left Pane: Selected Page / Template
The left pane displays a drop-down list which shows the currently selected layout element (usually a page or template, but can also be a notification, message or error text). By opening the drop-down list, it can be used to navigate to a different layout element of the dataset, simply by selecting the desired element.
Depending on which kind of layout element is being edited, the area below the drop-down list displays the following:
- Template Page, Normal Page or
Notification Email:
The placeholders available for the customization of the page or email message are displayed in a
tree-like structure.
See below for a more detailed description of the placeholder tree.
- Message Text: A list of all messages in the currently
selected message group is displayed.
The currently selected message is displayed with a bold font. Click on a message to select it.
- Input Validation Error: A list of all errors in the
currently selected error group is displayed.
The currently selected error is displayed with a bold font. Click on an error to select it.
Right Pane: Edit Draft Version
The right pane displays several tabs, with the "Draft Version" tab currently being the active tab.
The content of this tab is different depending on which kind of layout element is being edited:
- Template Page or Normal Page:
Templates and pages are edited by editing their HTML source code. This HTML code also
includes the placeholders as specified in the left pane (see below for
placeholder details). It also defines the general layout of
the page as well as the design style (see below for style details).
The HTML code is edited in the main edit field in the center.
Above the edit field, a drop-down menu is used to define what part of the page is to be edited (in the edit field) and which part is to be inherited from the applicable page template (this drop-down menu is not available for the header/footer template). By inheriting parts from the template, repetitious work can be saved on the individual pages where the HTML code that is already defined in the template does not need to be included. Also, a change to the template will automatically apply to all pages that use the template.
To submit the changes, click [OK]. To cancel editing without submitting any changes, click [Cancel].
- Notification Email: Notification emails are edited by supplying
the HTML and plain text content for the email, plus some additional configuration settings.
Note: Each notification email always has both the HTML and plain text content defined, even if a dataset should be configured to use only plain text notification emails.
The drop-down menu at the very top defines how the HTML and plain text versions are defined. There are two choices:
- Use HTML below for HTML part and generate the Plain Text version
automatically
With this choice, only the HTML version of the email is supplied in the main edit field in the center, including all relevant HTML tags to format the message. The plain text version of the email will be automatically generated from the HTML code, using a few simple rules to convert the HTML format tags into matching plain text formatting. Since formatting in plain text is obviously limited (for example no different colors, font styles, bold, italic or underline), this automatic conversion only works for relatively simple HTML code. The result of the automatic conversion can be seen in the preview once you submit the changes with [OK]. If the result is not satisfactory, then you will have to use the option of providing separate content for both types (see below).
- Define separate HTML and Plain Text versions
With this choice, the center of the tab displays two sub-tabs, one for HTML and one for plain text. Each tab contains the main edit field into which you enter the content for the corresponding type.
- Notification email header/footer inherited, body defined below:
With this choice, the header/footer definition as defined in the email notification header/footer
template, will be used. In the main edit box, supply only the raw body of the email. This body
will be merged with the header/footer template by using it to replace the {{maestro:body}}
placeholder in the template.
The template also defines the character encoding for the email and, in case of the plain text content, the maximum line length (for word wrapping). Therefore, if you are inheriting the template, then you can not specify these settings individually for the notification email in question. Because of this, you need to remember to write the raw body in such a way that it is compatible with the character encoding that is specified through the template.
- All content defined below: With this choice, you need to
supply the full email content in the main edit box. You also need to define the language
encoding for the email and, in case of plain text content, the maximum line length for
the automatic word wrapping.
In addition to the actual mail content, you also need to provide the following settings (not all of them are available if you edit the header/footer template or an email notification that already inherits some of these settings from the template):
- Sender Name: Enter the name that is supposed to
be used as the sender name in the From: field of the email. Do not use
an email address, but a real name. This value is optional; if nothing is supplied,
only the From address will appear in the From: field. The address that
will appear in the From: field is always the "List Administrator"
address from the dataset definition.
- Subject: Enter the subject line that is
supposed to be used for this notification email. See the left pane for any placeholders
that may be included in the subject line. These placeholders will be replaced with suitable
values before delivery (see below for placeholder details).
- Maximum Line Length: Enter the maximum line length
for automatic line wrapping of the body content. In the body, use [ENTER] to
insert a linebreak only when a hard linebreak is actually meant to appear.
Otherwise, simple leave it to the automatic line wrapping to wrap the longer
lines (paragraphs) into shorter lines just before delivery.
- Character Encoding: Select the character encoding
to use for the mail delivery. The encoding should match the language
(or the special non-ASCII characters, if any) that was used in the body.
To submit the changes, click [OK]. To cancel editing without submitting any changes, click [Cancel].
- Use HTML below for HTML part and generate the Plain Text version
automatically
- Message Text: Messages are edited by filling out the
following two edit fields:
- Title: Enter the text that is supposed to be
used as the title of the message. HTML tags can be used to format it.
Below the title input field there is a list of all placeholders that may
be included in the title. These placeholders will be replaced with suitable
values. Either enter the placeholder manually into the title or click on it to
automatically add the placeholder at the current cursor position.
- Text: Enter the text that is supposed to be
used as the actual message. HTML tags can be used to format it. Below
the message input field there is a list of all placeholders that may be
included in the message. These placeholders will be replaced with suitable
values. Either enter the placeholder manually into the message or click on it to
automatically add the placeholder at the current cursor position.
- Title: Enter the text that is supposed to be
used as the title of the message. HTML tags can be used to format it.
Below the title input field there is a list of all placeholders that may
be included in the title. These placeholders will be replaced with suitable
values. Either enter the placeholder manually into the title or click on it to
automatically add the placeholder at the current cursor position.
- Input Validation Error: Errors are edited by filling out
the Text field. Enter the text that is supposed to
be used as the error message. HTML tags can be used to format it. Below this
field there is a list of all placeholders that may be included in the error.
These placeholders will be replaced with suitable values. Either enter the placeholder
manually into the error or click on it to automatically add the placeholder at the
current cursor position.
A special case is the header/footer of each error group where there are actually two edit fields, one for the header and one for the footer. Fill out each with the corresponding text (and HTML code) that is to be used as the opening text (header) and closing text (footer) of each error message in this group. For example, by default the header of each error group contains an opening <ul> tag and the footer contains the matching closing </ul> tag; together, they define an unnumbered list in HTML. Consequently, the default error messages all start with <li> to constitute a bullet in this list.
To submit the changes, click [OK]. To cancel editing without submitting any changes, click [Cancel].
At the top right of the edit tab, two action icons are displayed to allow the executing of certain actions while editing the layout element:
Copy From
Production Version: Click to make a copy of the current production version. This
will replace all current changes in the edit fields with the matching values from the
production version. To back out of this without the changes taking effect, click "Cancel" to
cancel editing without submitting the production version copy. The production version
remains unchanged.
Reset To System
Default: Click to reset the edit fields to the LISTSERV Maestro system default.
This will overwrite all manual changes made in the edit fields and will reset them to
their defaults. To back out of this without the changes taking effect, click "Cancel" to
cancel editing without submitting the default settings. The production version remains
unchanged.
The Placeholder Tree
The placeholder tree is displayed only for template pages (dataset only) and normal pages. It defines the placeholders which can (or in some cases must) be used for the customization of the selected page or template.
The placeholders are separated into "Free Placeholders" and "Restricted Placeholders". Free placeholders may appear anywhere on the page, while restricted placeholders, when used on the page, must conform to the same tree structure which is shown here in the left pane.
The placeholder tree shows each placeholder by its name using the following symbols:
The symbol for free placeholders.
Free placeholders may appear anywhere on the page, even "inside" of other placeholders. They are always optional, which means that they can be included, but they don't have to be.
The symbol for optional restricted
placeholders.
Restricted placeholders must adhere to their parent-child structure. This means that all top-level restricted placeholders (i.e. the ones without any further parents in the tree structure) can be used anywhere on the page at top level but not "inside" of other placeholders. Sub-level placeholders can only be used on the page if they appear "inside" of their matching parent placeholder (as defined by the tree structure).
An optional restricted placeholder can be included on the page, but does not have to be included. If such a placeholder is omitted, all its children (if any) must be omitted, too.
The symbol for mandatory restricted
placeholders.
The same rules about restricted placeholders as already described above for optional restricted placeholders apply here, too, but placeholders of this type are mandatory. In other words, they must appear on the page or else the customization will not be accepted by the system.
Mandatory placeholders are also additionally marked by using a bold font for their name.
In the tree, placeholders with further children are preceeded by a
symbol (if the children are currently not visible) or 
symbol (if the children currently are visible). Click on the symbol to make the children visible
or hide them.
If the placeholder itself is clicked (its symbol or name), the placeholder is selected. A
selected placeholder is shown inside of a blue box, with an additional short description of the
placeholder and what it is for. Therefore, if it's not certain what a particular placeholder
does exactly, or why it is required or not, simply select the placeholder to see this
description.
If the draft version is being edited, the box also contains a small arrow
. When the arrow is clicked, the placeholder tag
for the placeholder will automatically be inserted into the page code (in the right pane) at the
current cursor position. This arrow is not visible when viewing the source of the production
version.
If a placeholder is to be used on the page, it must be written using the special placeholder tag syntax. The syntax is slightly different depending on if the placeholder is one with a body or not:
- Without Body: The placeholder tag consists of a single tag
and looks like this:
{{maestro:NAME}}
where "NAME" must be replaced with the placeholder name, as shown in the tree. Note: placeholder names are case sensitive!
- With Body: The placeholder tag consists of an opening and
closing tag, with the placeholder body inbetween, like this:
{{maestro:NAME}}...placeholder body goes here...{{/maestro:NAME}}
where in both the opening and closing tag "NAME" must be replaced with the placeholder name, as shown in the tree. Note: placeholder names are case sensitive!
The body, which is only outlined in the example above, can be any further HTML code and may also contain linebreaks to strech over several lines or paragraphs.
It is also inside of this body that the placeholder tags of the placeholder's children must appear. For example, with a tree definition like this:
validationErrorsPresent 
validationErrors
then the page must contain a placeholder structure similar to the following:
{{maestro:validationErrorsPresent}}
...this is the validationErrorsPresent-placeholder's body, which contains the child placeholder:
{{maestro:validationErrors}}
...here the body continues, up to the closing tag:
{{/maestro:validationErrorsPresent}}
Some placeholders may additionally contain attributes in their placeholder name, which is then
written as follows:
{{maestro:NAME ATTRIBUTE="VALUE"}}
where "NAME" is to be replaced as shown above, and
"ATTRIBUTE" and "VALUE" are to be
replaced with the attribute name and value, respectively.
A placeholder may also contain several attributes, like this:
{{maestro::NAME ATTRIBUTE1="VALUE1" ATTRIBUTE2="VALUE2" ATTRIBUTE3="VALUE3"}}
If an attribute is not specified, a suitable default will be assumed.
Placeholders with attributes:
- Text, Number, Email, or Password Profile Field Placeholder
- Boolean or Tracking Permission Profile Field Placeholder
- Single-Select Profile Field Placeholder
- Multiple-Select Profile Field Placeholder
- Button Placeholder (has mandatory attributes)
- Clickable Link Placeholder (has mandatory attributes)
- Quick Login Option Placeholder
- Subscription-Status Profile Field Placeholder
- Subscription-Type Profile Field Placeholder
- Acknowledge Style Profile Field Placeholder
- Mail Header Style Profile Field Placeholder
- Hide Subscription Option Profile Field Placeholder
- LISTSERV List Topic Profile Field Placeholder
(Placeholder types not listed above do not allow any attributes.)
Text, Number, Email, or Password Profile Field Placeholder:
| Attribute Name | Mandatory | Attribute Description |
|---|---|---|
| size | No | Defines the size of the edit field. Default: "60" (for text, email, password) or "10" (for number) |
| Only if the placeholder is defined in a context where the field is always enabled: | ||
| styleclass | No | Defines the name of the CSS style class (or classes) that shall be assigned to the edit
field. Default: No style class. |
| OR: Only if the placeholder is defined in a context where the field is always disabled: | ||
| styleclass | No | Defines the name of the CSS style class (or classes) that shall be assigned to the edit
field. Default: "disabledEditField" (as defined by the style sheet) |
| OR: Only if the placeholder is defined in a context where the enabled/disabled state of the field differs according to the circumstances: | ||
| enabledclass | No | Defines the name of the CSS style class (or classes) that shall be assigned to the edit
field if the field appears in an enabled context. Default: No style class. |
| disabledclass | No | Defines the name of the CSS style class (or classes) that shall be assigned to the edit
field if the field appears in a disabled context. Default: "disabledEditField" (as defined by the style sheet) |
(If the placeholder is for a profile field with input type "Read Only", then of the attributes listed
above only the styleclass attribute can be specified.)
Boolean or Tracking Permission Profile Field Placeholder:
| Attribute Name | Mandatory | Attribute Description |
|---|---|---|
| type | No | Defines how the boolean field shall be rendered. Possible types are: "checkbox": Field is rendered as a checkbox. "dropdown": Field is rendered as a dropdown list with two choices. "radiogrid": Field is rendered as a pair of radio buttons. Default: "checkbox" |
| Only for types "dropdown" or "radiogrid": | ||
| yes | Yes | Defines the text of the dropdown list choice or the radio button that corresponds to the boolean "true" value. |
| no | Yes | Defines the text of the dropdown list choice or the radio button that corresponds to the boolean "false" value. |
| order | No | Defines the ordering of the two dropdown list choices or radio buttons. Possible order values are: "noyes": The choice that corresponds to the boolean "false" value comes first, followed by the "true" choice. "yesno": The choice that corresponds to the boolean "true" value comes first, followed by the "false" choice. Default: "noyes" |
| Only for type "dropdown": | ||
| select | No | Defines the text of a third choice that will always appear as the first choice of the dropdown list
and which acts as a "reminder" choice. The user will not be allowed to submit the page while this
choice is still selected. This choice is therefore only meant to remind the user to select one of
the other two choices. Normally you would supply a text like "--Please Select--" or similar for this
reminder choice. Defining the reminder choice is optional. Depending on if it is defined or not,
the dropdown list will show the following behavior: If the boolean profile field does not yet have an associated value (i.e. it is still unclear if the value is "true" or "false"), and the reminder choice is defined, then when the page is displayed, the reminder choice will initially be selected. If however the reminder choice is not defined, then whichever of the other two choices is the first choice will initially be selected (see "order" above). If the profile field however already has a value, then the matching "yes" or "no" choice is initially selected, no matter if the reminder choice is present or not. Note: On pages where the profile field always already has an associated value (and where therefore the reminder choice would never be the initially selected choice anyway), this "select" attribute is not available as an attribute of the placeholder. On such pages, the dropdown list can therefore only be defined with the two standard values. Default: No third choice will be available, only the two standard choices for "true" and "false" are shown. |
| Only for type "radiogrid": | ||
| align | No | Defines how the two radio buttons will be aligned in respect to each other. Possible alignment
values are: "horizontal": The two radio buttons will appear in one horizontal row next to each other. "vertical": The two radio buttons will appear stacked in one vertical column. Default: "horizontal" |
| For all types, but only if the placeholder is defined in a context where the enabled/disabled state of the field is the same under all circumstances: | ||
| styleclass | No | Defines the name of the CSS style class (or classes) that shall be assigned to the
checkbox, dropdown list or the radio buttons. Default: No style class. |
| OR: For all types, but only if the placeholder is defined in a context where the enabled/disabled state of the field differs according to the circumstances: | ||
| enabledclass | No | Defines the name of the CSS style class (or classes) that shall be assigned to the
checkbox, dropdown list or the radio buttons if the field appears in an enabled context. Default: No style class. |
| disabledclass | No | Defines the name of the CSS style class (or classes) that shall be assigned to the
checkbox, dropdown list or the radio buttons if the field appears in a disabled context. Default: No style class. |
Single-Select Profile Field Placeholder:
| Attribute Name | Mandatory | Attribute Description |
|---|---|---|
| type | No | Defines how the single-select field shall be rendered. Possible types are: "dropdown": Field is rendered as a dropdown list. "radiogrid": Field is rendered as a grid of radio buttons. Default: "dropdown" |
| Only for type "dropdown", if the placeholder is defined in a context where the field is always enabled: | ||
| styleclass | No | Defines the name of the CSS style class (or classes) that shall be assigned to the dropdown
list. Default: No style class. |
| OR: Only for type "dropdown", if the placeholder is defined in a context where the field is always disabled: | ||
| styleclass | No | Defines the name of the CSS style class (or classes) that shall be assigned to the dropdown
list. Default: "disabledEditField" (as defined by the style sheet) |
| OR: Only for type "dropdown", if the placeholder is defined in a context where the enabled/disabled state of the field differs according to the circumstances: | ||
| enabledclass | No | Defines the name of the CSS style class (or classes) that shall be assigned to the dropdown
list if the field appears in an enabled context. Default: No style class. |
| disabledclass | No | Defines the name of the CSS style class (or classes) that shall be assigned to the dropdown
list if the field appears in a disabled context. Default: "disabledEditField" (as defined by the style sheet) |
| OR: Only for type "radiogrid": | ||
| order | No | Defines the order the radio buttons in the grid shall be arranged. Possible values are
"horizontal" and "vertical".
Default: "horizontal". |
| maxrows | No | Defines the maximum number of rows in the radio grid. Columns will be added as necessary to
be able to include all choices defined by the profile field. Note: Use either "maxrows" or "maxcols" (or none), but never both. Default: If there are more than four choices then the default is "3"; if less choices, the column/row count is chosen to create as "compact" a layout as possible. |
| maxcols | No | Defines the maximum number of columns in the radio grid. Rows will be added as necessary to
be able to include all choices defined by the profile field. Note: Use either "maxrows" or "maxcols" (or none), but never both. Default: If there are more than four choices then the default is "3"; if less choices, the column/row count is chosen to create as "compact" a layout as possible. |
| tablestyleclass | No | Defines the name of the CSS style class (or classes) that shall be assigned to the HTML
table which will surround the radio button grid. Default: No style class. |
| rowstyleclass | No | Defines the name of the CSS style class (or classes) that shall be assigned to each row in
the HTML table which will surround the radio button grid. Note: If "rowstyleclass" is used, then do not use "evenrowstyleclass" and "oddrowstyleclass" as well. Default: No style class. |
| evenrowstyleclass | No | Defines the name of the CSS style class (or classes) that shall be assigned to every even
row in the HTML table which will surround the radio button grid. Note: If "evenrowstyleclass" is used, then "oddrowstyleclass" must also be used. Do not use "rowstyleclass" as well. Default: No style class. |
| oddrowstyleclass | No | Defines the name of the CSS style class (or classes) that shall be assigned to every odd row
in the HTML table which will surround the radio button grid. Note: If "oddrowstyleclass" is used, then "evenrowstyleclass" must also be used. Do not use "rowstyleclass" as well. Default: No style class. |
| cellstyleclass | No | Defines the name of the CSS style class (or classes) that shall be assigned to each cell in
the HTML table which will surround the radio button grid. Default: No style class. |
| Only for type "radiogrid" if the field is an optional field: | ||
| defaultvalueposition | No | If the profile field is an optional profile field, then one of the choices is the "No
Selection" choice. This attribute defines where in the grid the "No Selection" choice is to
be rendered. Available choices are: "first": "No Selection" is the first radio button in the grid. "last": "No Selection" is the last radio button in the grid. "above": "No Selection" is the first radio button in the grid that will be rendered in a separate row above all other choices. "below": "No Selection" is the last radio button in the grid that will be rendered in a separate row below all other choices. Default: "first". |
| Only used if the profile field is the source field for another field
(single- or multiple select), where the lookup table subset that the other field displays depends
on the value selected in this profile field, and the subscriber
who views the page has JavaScript disabled, so a change in this field is not recognized automatically
but must be submitted manually by the subscriber. In this situation, the profile field is displayed either as enabled, so that the subscriber can change its value and then must click an "apply" button. Or it is displayed as disabled, so that the subscriber must first click a "change" button before the field is enabled and the value can be changed. |
||
| applytext | No | The text that will be used for the "apply" button that is shown with the profile field control,
when the profile field is enabled and its value can be changed. The "apply" button needs to be clicked
to submit the changed value. Note: The button is not visible if the subscriber has JavaScript enabled, in which case the submit happens automatically as soon as the subscriber changes the selection. Default: The text "Apply". |
| changetext | No | The text that will be used for the "change" button that is shown with the profile field control,
when the profile field is disabled and the "change" button needs to be clicked first before the field's
value can be changed. Note: The button is not visible if the subscriber has JavaScript enabled, in which case the fields is always enabled and its value can always be changed. Default: The text "Change". |
| applychangeclass | No | Defines the name of the CSS style class (or classes) that shall be assigned to the "change" or
"apply" button (if visible, see above) that is shown with the profile field in some situations. Default: "maestroFakeLink small" (as defined by the style sheet) - i.e. the two classes "maestroFakeLink" and "small" (the first class "maestroFakeLink" makes the button look like a normal link, instead of a button). |
(If the placeholder is for a profile field with input type "Read Only", then of the attributes listed
above only the styleclass attribute can be specified.)
Multiple-Select Profile Field Placeholder:
| Attribute Name | Mandatory | Attribute Description |
|---|---|---|
| type | No | Defines how the multiple-select field shall be rendered. Possible types are: "list": Field is rendered as a selection list. "checkboxgrid": Field is rendered as a grid of checkboxes. Default: "list" |
| Only for type "list", if the placeholder is defined in a context where the field is always enabled: | ||
| styleclass | No | Defines the name of the CSS style class (or classes) that shall be assigned to the selection
list. Default: No style class. |
| OR: Only for type "list", if the placeholder is defined in a context where the field is always disabled: | ||
| styleclass | No | Defines the name of the CSS style class (or classes) that shall be assigned to the selection
list. Default: "disabledEditField" (as defined by the style sheet) |
| OR: Only for type "list", if the placeholder is defined in a context where the enabled/disabled state of the field differs according to the circumstances: | ||
| enabledclass | No | Defines the name of the CSS style class (or classes) that shall be assigned to the selection
list if the field appears in an enabled context. Default: No style class. |
| disabledclass | No | Defines the name of the CSS style class (or classes) that shall be assigned to the selection
list if the field appears in a disabled context. Default: No style class. |
| OR: Only for type "checkboxgrid": | ||
| order | No | Defines the order the checkboxes in the grid shall be arranged. Possible values are "horizontal" and "vertical". Default: "horizontal". |
| maxrows | No | Defines the maximum number of rows in the checkbox grid. Columns will be added as necessary
to be able to include all choices defined by the profile field. Note: Use either "maxrows" or "maxcols" (or none), but never both. Default: If there are more than four choices then the default is "3"; if less choices, the column/row count is chosen to create as "compact" a layout as possible. |
| maxcols | No | Defines the maximum number of columns in the checkbox grid. Rows will be added as necessary
to be able to include all choices defined by the profile field. Note: Use either "maxrows" or "maxcols" (or none), but never both. Default: If there are more than four choices then the default is "3"; if less choices, the column/row count is chosen to create as "compact" a layout as possible. |
| tablestyleclass | No | Defines the name of the CSS style class (or classes) that shall be assigned to the HTML
table which will surround the checkbox grid. Default: No style class. |
| rowstyleclass | No | Defines the name of the CSS style class (or classes) that shall be assigned to each row in
the HTML table which will surround the checkbox grid. Note: If "rowstyleclass" is used, do not use "evenrowstyleclass" and "oddrowstyleclass" as well. Default: No style class. |
| evenrowstyleclass | No | Defines the name of the CSS style class (or classes) that shall be assigned to every even
row in the HTML table which will surround the checkbox grid. Note: If "evenrowstyleclass" is used, then "oddrowstyleclass" must also be used. Do not use "rowstyleclass" as well. Default: No style class. |
| oddrowstyleclass | No | Defines the name of the CSS style class (or classes) that shall be assigned to every odd row
in the HTML table which will surround the checkbox grid. Note: If "oddrowstyleclass" is used, then "evenrowstyleclass" must also be used. Do not use "rowstyleclass" as well. Default: No style class. |
| cellstyleclass | No | Defines the name of the CSS style class (or classes) that shall be assigned to each cell in
the HTML table which will surround the checkbox grid. Default: No style class. |
Button Placeholder:
| Attribute Name | Mandatory | Attribute Description |
|---|---|---|
| text | Yes | The value of this attribute defines the text label for the button. |
Clickable Link Placeholder:
| Attribute Name | Mandatory | Attribute Description |
|---|---|---|
| text | Yes | The value of this attribute defines the text that shall constitute the clickable link. |
Quick Login Option Placeholder:
(Only available on the dataset login page.)
| Attribute Name | Mandatory | Attribute Description |
|---|---|---|
| styleclass | No | Defines the name of the CSS style class (or classes) that shall be assigned to the
checkbox. Default: No style class. |
Subscription-Status Profile Field Placeholder:
(Only available for Subscriber Lists in the subscriber warehouse.)
| Attribute Name | Mandatory | Attribute Description |
|---|---|---|
| type | No | Defines how the subscription status field shall be rendered. Possible types are: "dropdown": Field is rendered as a dropdown list. "radiobuttons": Field is rendered as two radio buttons. Default: "dropdown" |
| mailtext | No | The value of this attribute defines the text that shall be displayed for the
"Subscription Active" choice. Default: A suitable default text. |
| nomailtext | No | The value of this attribute defines the text that shall be displayed for the
"Subscription Inactive" choice. Default: A suitable default text. |
| Only for type "radiobuttons": | ||
| separator | No | The value of this attribute defines the text that shall be rendered for a separator
between the two radio buttons. Default: A single space character. |
Subscription-Type Profile Field Placeholder:
(Only available for Advanced Subscriber Lists.)
| Attribute Name | Mandatory | Attribute Description |
|---|---|---|
| type | No | Defines how the subscription type field shall be rendered. Possible types are: "dropdown": Field is rendered as a dropdown list. "radiobuttons": Field is rendered as radio buttons. Default: "dropdown" |
| normaltext | No | The value of this attribute defines the text that shall be displayed for the "Normal
Subscription" choice. Default: A suitable default text. |
| digesthtmltext | No | The value of this attribute defines the text that shall be displayed for the "Digest in
HTML Format" choice. Default: A suitable default text. |
| digestmimetext | No | The value of this attribute defines the text that shall be displayed for the "Digest in
Mime Format" choice. Default: A suitable default text. |
| digestplaintext | No | The value of this attribute defines the text that shall be displayed for the "Digest in
Plain Text Format" choice. Default: A suitable default text. |
| Only if the Advanced Subscriber List supports delivery in the "Index" format: | ||
| indexhtmltext | No | The value of this attribute defines the text that shall be displayed for the "Index in
HTML Format" choice. Default: A suitable default text. |
| indexplaintext | No | The value of this attribute defines the text that shall be displayed for the "Index in
Plain Text Format" choice. Default: A suitable default text. |
| Only for type "radiobuttons": | ||
| separator | No | The value of this attribute defines the text that shall be rendered for a separator
between the radio buttons. Default: A linebreak <br>. |
Acknowledge-Style Profile Field Placeholder:
(Only available for Advanced Subscriber Lists.)
| Attribute Name | Mandatory | Attribute Description |
|---|---|---|
| type | No | Defines how the acknowledge style field shall be rendered. Possible types are: "dropdown": Field is rendered as a dropdown list. "radiobuttons": Field is rendered as radio buttons. Default: "dropdown" |
| none | No | The value of this attribute defines the text that shall be displayed for the
"No acknowledgement" choice. Default: A suitable default text. |
| shortconfirmation | No | The value of this attribute defines the text that shall be displayed for the
"Short confirmation message" choice. Default: A suitable default text. |
| messagecopy | No | The value of this attribute defines the text that shall be displayed for the
"Full copy of the posting" choice. Default: A suitable default text. |
| Only for type "radiobuttons": | ||
| separator | No | The value of this attribute defines the text that shall be rendered for a separator
between the radio buttons. Default: A linebreak <br>. |
Mail-Header-Style Profile Field Placeholder:
(Only available for Advanced Subscriber Lists.)
| Attribute Name | Mandatory | Attribute Description |
|---|---|---|
| type | No | Defines how the mail header style field shall be rendered. Possible types are: "dropdown": Field is rendered as a dropdown list. "radiobuttons": Field is rendered as radio buttons. Default: "dropdown" |
| normaltext | No | The value of this attribute defines the text that shall be displayed for the
"Normal LISTSERV-style header" choice. Default: A suitable default text. |
| subjecttext | No | The value of this attribute defines the text that shall be displayed for the
"LISTSERV-style, with list name in subject" choice. Default: A suitable default text. |
| full822text | No | The value of this attribute defines the text that shall be displayed for the
"Individual To:, full headers" choice. Default: A suitable default text. |
| dualtext | No | The value of this attribute defines the text that shall be displayed for the
"'Dual' (second header in mail body)" choice. Default: A suitable default text. |
| ietftext | No | The value of this attribute defines the text that shall be displayed for the
"sendmail-style" choice. Default: A suitable default text. |
| Only for type "radiobuttons": | ||
| separator | No | The value of this attribute defines the text that shall be rendered for a separator
between the radio buttons. Default: A linebreak <br>. |
Hide-Subscription-Option Profile Field Placeholder:
(Only available for Advanced Subscriber Lists.)
| Attribute Name | Mandatory | Attribute Description |
|---|---|---|
| styleclass | No | Defines the name of the CSS style class (or classes) that shall be assigned to the
checkbox. Default: No style class. |
LISTSERV List Topic Profile Field Placeholder:
(Only available for Advanced Subscriber Lists.)
| Attribute Name | Mandatory | Attribute Description |
|---|---|---|
| styleclass | No | Defines the name of the CSS style class (or classes) that shall be assigned to the
checkbox. Default: No style class. |
Page Styles
When editing the subscriber area header/footer template, or when supplying an individual header/footer on a page, CSS styles (Cascading Style Sheets) should be used to customize the style of the pages. The HTML code that LISTSERV Maestro generates for all default pages (i.e. pages which are not customized) uses a few common HTML tags as well as custom style classes, whose look can be defined with a customized style sheet.
Please see the CSS2 specification of the W3C (World Wide Web Consortium) for details about style sheets.
The following table lists all HTML tags and custom styles used by the LISTSERV Maestro default pages and describes the use of each, so that customized styles can be defined for them. Finally, as a reference for creating styles, the style sheet that is used by the default header/footer template is shown at the end.
| <body> | The main body of the HTML page. By defining styles for this tag (for example for the font, background etc.) the default styles for the whole page can be defined. The other HTML tags inherit this style and can then overwrite it where necessary. |
| <p> | The standard text paragraph. Used for all text which does not fall into a special case. |
| <h1> | The level 1 header. Used for the header of each page. |
| <h2> | The level 2 header. Used for sub-level headers to separate different parts on the same page. |
| <a> | The link tag. Used for all clickable links. |
| <td> | The table-cell tag. Used for all table cells. |
| <th> | The table-header-cell tag. Used for the header of the table that contains the subscriber lists in the current category, when viewed in the subscriber area. |
| <input> | The input tag. Used for single line edit fields, checkboxes and buttons. |
| <select> | The select tag. Used for single select drop-down lists and multiple select boxes. |
| small | Custom style class "small". Used to render text smaller than the normal text. For example a comment or list description. |
| emphasis | Custom style class "emphasis". Used to render phrases or individual words in an emphasized style. |
| mandatoryFieldMarker | Custom style class "mandatoryFieldMarker". Used to render the little marker asterisk (*) which is shown for mandatory profile fields. |
| error | Custom style class "error". Used to render error messages. |
| emphasisBackground | Custom style class "emphasisBackground". Used to render table cells or whole tables in an emphasized style by giving them a background that stands out from the normal page background. |
| maestroFakeLink | Custom style class "maestroFakeLink". Used to render a button control with a style so that the button looks like a normal link instead of a button. |
| disabledEditField | Custom style class "disabledEditField". Used to render edit fields and selection fields in a "grayed" state to make their disabled nature more apparent. |
| tableframe | Custom style class "tableframe". Used to render a frame around box-like tables that group together certain related input fields or texts. Also used to render the subscriber area pages to appear in a "tabbed" style with two tabs (for "My Lists" and "My Profile"). Surrounds the two tabs at the top. |
| subscribeStepActiveTitle | Custom style class "subscribeStepActiveTitle". Used to render the title of the currently active subscription step (step 1 or 2) on the page where a subscriber can join the subscriber area or subscribe to a list without first logging in, to make it stand out from the other, currently inactive, step. |
| subscribeStepInactiveTitle | Custom style class "subscribeStepInactiveTitle". Corresponding "inactive" style for the "subscribeStepActiveTitle" style (see above). Used to render the title of the currently inactive subscription step. |
| description | Custom style class "description". Used to render the public description of the subscriber area or current category (if supplied). |
| subscribed | Custom style class "subscribed". Used to render the "Yes" marker in the column "Subscribed" of the table of available subscriber lists in the subscriber area, meant to signify that the currently logged in dataset subscriber has subscribed this list. |
| notsubscribed | Custom style class "notsubscribed". Used to render the "---" marker in the column "Subscribed" of the table of available subscriber lists in the subscriber area, meant to signify that the currently logged in dataset subscriber has not subscribed this list. |
| selectedTab | Custom style class "selectedTab". Used to render the label and background of the currently selected tab in the subscriber area ("My Lists" or "My Profile"). |
| tableThickFrame | Custom style class "tableThickFrame". Used to render the subscriber area pages to appear in a "tabbed" style with two tabs (for "My Lists" and "My Profile"). It surrounds the main part of the subscriber area that sits beneath the two tabs. |
| tableBottomLine | Custom style class "tableBottomLine". Used in the subscriber area to render a horizontal separator line between the row that displays the current category and its parent categories as navigable links (this row only appears if there actually are categories in the dataset), and the lower part which shows all subscriber lists in the current category. |
| tableRightLine | Custom style class "tableRightLine". Used in the subscriber area to render a vertical separator line between the left column that displays the sub-categories of the current category (this column only appears if there actually are sub-categories), and the part to the right which shows all subscriber lists in the current category. |
Default Style Sheet:
The following shows the style sheet used by the default template: