Home

Customization Manual for LISTSERV Maestro 3.1 - L

1. 0 0 c cece eh 27 2 7 8 Clickable Link Profile Field Placeholders 0 000 cece eee eee 27 2 8 Setting the Default Display for Data Fields 0 0 c eee ee 27 Section 3 User Interface Branding lisse n nnn 29 3 1 Adding Custom Text Strings 0 rr 29 2 2 Exchanging LOGOS oue de AB Re E E Ro eee ate ees Rees 30 Section 4 Using the Resource Translation Tool 0 0c eee eee eee 31 4 1 Requirements 2 est eed Re de RORIS RR ET De e dod a AR a ii he 31 4 2 Translating ix DAA mE Aere KIND NAG AR NABA ee RR n 32 4 2 1 Navigating the Resources Tree 0 ene 33 4 2 2 KeyNalue Entries 22202 AA AA hn 34 42 3 HTML CODE zie pattedadsie alee DD RP LIKA LANG ANDA aus 35 4 2 4 Word Replacement 0 000 cette eee 38 4 2 5 Date and Time Formats 00000 e cece ete eee 40 4 3 Installing a Translated Language 0 cece eh 44 4 4 Importing a Translated Language from a Previous Version 00000 eee eens 45 LISTSERV Maestro version 3 1 Interface Customization Manual Table of Contents 4 5 Using a Translated Language 00 eee eae 45 4 5 1 Choosing a Language for the Administration Hub and User Interface 46 4 5 2 Choosing the Language for the Subscriber Interface 46 Section 5 Creating Customized Message Templates 22 02 cece eee ee eee 47 5 1 Creating a Copy of a S
2. custom myImage gif The following image file keys are currently available app img titleBarLogo custom FILENAME Uses the image file with the FILENAME from the custom folder to replace the LISTSERV Maestro logo image that is shown at the right of the header bar that appears at the top of each page This logo is also a clickable link that may be customized Set the target URL with the app url companyURL key see above This image must be 60 x 60 pixels in size If this key is not included the LISTSERV Maestro logo will be used app img appLogo custom FILENAME Uses the file with the FILENAME from the custom folder to replace the LISTSERV Maestro logo image that is shown on the login page when the Administration Hub is not accessible Under normal conditions the login page only shows the image in the header bar plus the fields for the login However if the Administration Hub is locked by the administrator or is for other reasons not correctly running the login page displays this logo and a short message text instead of the login fields This logo image should be about 113 x 113 pixels in size but the size may vary within reasonable limits If this key is not included a version of the LISTSERV Maestro logo will be used LISTSERV Maestro version 3 1 Interface Customization Manual 30 Section 4 Using the Resource Translation Tool Maestro User Interface to another language or make changes
3. Binary inline multiple values Same as the corresponding Binary types above but the user who employs the template during content definition has the option of supplying multiple binaries for the placeholder The placeholder will be replaced with a list of the URLs of all supplied binaries both linked and inline This is useful when using the multi placeholder repeater and or the special placeholder prefix and suffix because the prefix and or suffix will appear once before after each of the multiple URLs before they are linked to build the combined replacement value which allows you to enclose each of the URLs with its own lt img gt tag to actually display the image that is represented by the binary From the values in preview drop down menu select how many dummy images shall be displayed for this placeholder during preview when no binaries have been supplied yet This placeholder type can only be used in the HTML part of an HTML template e Sample Preview There are several situations where the template is supposed to be displayed while the placeholders are not yet filled out with any content In these situations LISTSERV Maestro fills out the placeholders with dummy content as a stand in for the actual content that is yet to be provided This makes it easier to assess the overall appearance of the template while the placeholders are still empty The kind of dummy content that is used for this can be defined by the content manager de
4. In general you are fine with how the pages error messages and email notifications look but you would like to change the wording of a specific sentence or message for a specific dataset Solution Use the Customization wizard in LISTSERV Maestro to customize the pages error messages or email notifications that contain the sentence message you would like to change For information on customizing a specific page error message or email notification for a specific dataset see Section 2 2 Using the Membership Area Layout Tab and 2 3 Using the Customization Page Layout Screen plus Section 2 4 Editing Templates and Pages Section 2 5 Editing Subscriber Notification Emails or Section 2 6 Editing Informational and Error Messages Customizing the actual layout of a page for a specific dataset Situation There are certain pages in a specific dataset that you are not satisfied with and you d like to change how the pages look For example you d like to have a different order of the various elements on the page Solution Use the Customization wizard in LISTSERV Maestro to customize the pages error messages or email notifications you are not satisfied with To do this simply change the current HTML code to provide your own layout For more information see Section 2 2 Using the Membership Area Layout Tab and 2 3 Using the Customization Page Layout Screen plus Section 2 4 Editing Templates and Pages Section 2 5 Editing Subscriber Notificatio
5. Layout tab displays a general overview as described in the previous section To refresh the tab and display a list of layout elements available for customization click the Select a Page link If customization has been done then clicking on the Membership Area Layout tab takes you directly to the list of layout elements available for customization The tab is divided into two panes The left pane displays all of the recipient lists in the dataset in a tree like structure the dataset as the root and each list as a node A Hosted Recipient List is shown with a node icon that looks like a sheet of paper A Hosted LISTSERV List is shown with a node icon that looks like a sheet of paper with the LISTSERV logo A Linked LISTSERV List is shown with a node icon that looks like a sheet of paper with the LISTSERV logo and a small arrow in the lower left corner A category is represented using a folder icon Category folders with content at least one list or subcategory in it show a little icon if the folder is closed or a icon if the folder is open Click on the or icon to open or close a category folder To select a node simply click on it The right pane displays a list of all the customizable layout elements For a dataset the layout elements are divided into three tables Templates Pages and Subscriber LISTSERV Maestro version 3 1 Interface Customization Manual Section 2 Customizing the Subsc
6. Verdana Arial Helvetica sans serif font size Opt color 000000 input disabled color 777777 select font family Verdana Arial Helvetica sans serif font size Opt color 000000 j select disabled color 777777 j small 1 font size 8pt emphasis font weight bold j mandatoryFieldMarker 1 font weight bold margin left 1px LISTSERV Maestro version 3 1 Interface Customization Manual F Appendix B The Default Style Sheet error color CC0033 emphasisBackground background color F 1 F4FA disabledEditField background color ZEEEEEE j tableframe border color 333399 border style solid border width 1px 1px 1px 1px j subscribeStepActiveTitle font family Verdana Arial Helvetica sans serif font size Opt font weight bold background color 4333399 color FFFFFF subscribeStepInactive Title font family Verdana Arial Helvetica sans serif font size Opt background color 333399 color FFFFFF description j subscribed font weight bold color 009900 notsubscribed j LISTSERV Maestro version 3 1 Interface Customization Manual FF x Appendix B The Default Style Sheet selectedTab font family Verdana Arial Helvetica sans serif font size Opt font weight bold background color 4333399 color FFFFFF
7. and how to confirm it Foran Unconfirmed Member with Join Welcome Message The page is viewed by a new member who has just joined the Membership Area so they are viewing this page for the very first time and has not yet confirmed the membership A similar reminder as above is displayed and a Welcome to the Membership Area message is also displayed Foran Unconfirmed Member with List Subscription Welcome Message The page is viewed by a new member who has not only just joined the Membership Area so they are viewing this page for the very first time but has also subscribed to the first list at the same time and not yet confirmed the membership A similar reminder and welcome message as above is displayed but the welcome message is not only a general Welcome to the Membership Area message but a more specific message about the mailing list that the member has just subscribed to To simulate these different welcome messages click the State drop down menu and select one of the choices described above In addition the right pane displays the Membership Area State tab which lets you define additional settings in order to simulate different subscriber states 2 4 2 1 The Membership Area State Tab The Membership Area State tab is a special tab that is only available if the currently selected layout element is the Membership Area Page The controls on this tab can be used to simulate a certain subscriber and list state impacting
8. tableThickFrame border color 333399 border style solid border width 4px 3px 3px 3px j tableBottomLine border color 333399 border style solid border width Opx Opx 1px Opx j tableRightLine border color 333399 border style solid border width Opx 1px Opx Opx LISTSERV Maestro version 3 1 Interface Customization Manual 78 Appendix C Languages Supported for Translation ranslations for the text in the User Interface the Administration Hub and the Subscriber Interface are supported by the languages listed in the tables below Table C 1 Supported Languages for the User Interface and Administration Hub Language ISO Code English en French fr German de Spanish es Swedish sv Table C 2 Supported Languages for the Subscriber Interface Language ISO Code Arabic ar Bulgarian bg Chinese zh Czech cs Danish da Dutch nl English en Finnish fi French r German de Greek el Hebrew iw Icelandic is Italian lt Japanese ja Korean ko Norwegian no LISTSERV Maestro version 3 1 Interface Customization Manual 79 Appendix C Languages Supported for Translation Language ISO Code Polish pl Portuguese pt Romanian ro Russian ru Slovak sk Slovenian sl Spanish es Swedish sv Turkish tr Ukrainian uk Note L Soft does not provide the actual translations
9. then the placeholder is selected and shown inside of a blue box with an additional short description of the placeholder Therefore if you do not remember what a certain placeholder does exactly or why it is required or not simply select the placeholder to see this description If you are editing the wd draft version the box also contains a small green arrow icon When you click the arrow 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 available when viewing the source of the production version If you want to use a placeholder on the page then you will need to write it using the special placeholder tag syntax The syntax is slightly different depending on whether or not the placeholder contains a body or attributes Without Body The placeholder tag consists of a single tag and looks like this maestro NAMB where you must replace NAME with the placeholder name as shown in the tree Placeholder names are case sensitive With Body The placeholder tag consists of an opening and closing tag with the placeholder body between the tags such as maestro NAME placeholder body goes here maestro NAME where you must replace NAME in both the opening and closing tags with the placeholder name as shown in the tree Placeholder names are case sensitive The body which is only out
10. to date month 12 Assign values to these twelve keys so that they match the name of the months in your target language starting with January preferably in an abbreviated textual form If there is no good abbreviated textual form in your target language and the full textual form appears as too long you may also use the numerical values 1 to 12 instead The names of the months are independent of any preferences the user sets meaning that they are always used for date output Print month or day first Locate the date node Underneath this node edit the key called date printMonthFirst Set the value to true to get an output date format of Month Day Year i e American style as in Aug 12 2002 or to false to get a format of Day Month Year i e European style as in 12 LISTSERV Maestro version 3 1 Interface Customization Manual 40 Section 4 Using the Resource Translation Tool Aug 2002 This value defines the default for users without an individual preference setting e Output Format for Time Whenever LISTSERV Maestro outputs times i e the send time of a job you have two attributes of the output format that you can manipulate Use AM PM format or not Locate the date node Underneath this node edit the key called date useAM PM Set the value to true if you want to use a 12 hour format with am pm or to false if you want to use a 24 hour format military time Thi
11. 1 Creating a Copy of a System Template System templates are pre defined templates that come together with LISTSERV Maestro A system template can not be used for content definition directly but they can be copied and used as a base for a new user defined template To copy a system template click the Utility menu and then select Content Templates The Manage Content Templates screen opens In the System Templates section you ll find a list of the system templates that you can copy Click on the template s name to open the View System Template screen From this screen you can preview the system template To create a user defined template based on this system template click the Create New Template link in the upper right of the screen The Create User Defined Template Based on System Template screen opens LISTSERV Maestro version 3 1 Interface Customization Manual 47 Section 5 Creating Customized Message Templates Ng Figure 5 2 The Create User Defined Template Based on System Template Screen Create User Defined Template Based on System Template Please enter the title and subject of the new template System Template Name Basic HTML Newsletter User Template Name s Subject optional C Allow advanced editing of template source during mail job content definition Enable new template Create Template The user defined template will initially be created as an exact copy of the system template e
12. Content Template and Content Templates The New Content Templates option gives you several ways to create a new user defined template by using your own content or previous job content the Content Templates option lets you manage and copy any existing templates For more information see the User s Manual and Section 4 Creating Customized Message Templates The Forward to a Friend Web Page After enabling the Forward to a Friend feature you can customize all of the web pages the subscriber will encounter The first page you will want to customize is the default Forward to a Friend web page which coordinates with the hosted list that was selected when the job s recipients were defined In addition to the default Forward to a Friend page there are also several new Forward to a Friend message pages These messages include the Forward to a Friend Cancelled message the Forward to a Friend Confirmation message the Processing Forward to a Friend message the Forward to a Friend Not Possible message the No Unsubscribe After Forward to a Friend message and the Forward to a Friend System Error message For information on customizing these pages see Section 2 Customizing the Subscriber Interface LISTSERV Maestro version 3 1 Interface Customization Manual What s New for Customizing LISTSERV Maestro 3 1 LISTSERV Maestro version 3 1 Interface Customization Manual Section 1 Why Should
13. Creating and Administering Templates ccc eee eae ix The Forward to a Friend Web Page 0 c eee eee ix Section 1 Why Should I Customize LISTSERV Maestro ssulslse 1 1 1 Who needs to be involved les 3 Section 2 Customizing the Subscriber Interface 002 eee ee 5 2 1 Accessing the Customization Wizard 0 000 nh 5 2 2 Using the Membership Area Layout Tab cece eae 6 2 3 Using the Customization Page Layout Screen ee 9 2 4 Editing Templates and Pages 0c eee eee 12 2 4 1 The Membership Area Header Footer Template 00000 eee eee 13 2 4 2 The Membership Area Page 0 0 n 13 2 5 Editing Subscriber Notification Emails 0 0 00 0 eee ee 16 2 6 Editing Informational and Error Messages eee eee 17 24 Placeholders voro e urn eR OR CRETA wl NG Ba Ly ae 18 2 7 1 Text Number Email or Password Profile Field Placeholders 21 2 7 2 Boolean Profile Field Placeholders 0 0 00 c ee tee 21 2 7 3 Single Select Profile Field Placeholders lille elles 22 2 7 4 Multiple Select Profile Field Placeholders 2 200 cee eee eens 24 2 7 5 Subscription Status Profile Field Placeholders 0 0 eee eeeee 26 2 7 6 Subscription Type Profile Field Placeholders 00000 eee eeeee 26 2 7 7 Button Profile Field Placeholders
14. Customize LISTSERV Maestro what you and your subscribers see The customization available varies depending on the type of user you are administrator data administrator template manager end user and the type of permissions you are granted in LISTSERV Maestro O ne of the great advantages of using LISTSERV Maestro is the ability to customize If you are an administrator then you can perform limited customizations to the User Interface and the Administration Hub see Section 3 User Interface Branding for more information or you can translate the text in the User Interface to another language using the L Soft Resource Translation Tool see Section 4 Using the Resource Translation Tool for more information If you are a data administrator or you have the permission to customize subscriber pages then you can customize the Subscriber Interface which means you can modify every page and email that a subscriber will see see Section 2 Customizing the Subscriber Interface for more information If you are a template manager or you have permission to create message templates then you can create customized message templates in plain text or HTML using a variety of methods see Section 5 Creating Customized Message Templates for more information There are many situations where customization is beneficial Below is a list of the most common situations along with some advice on how to handle each 1 Customizing the page frame and or st
15. Digital Alpha AXP AXP Digital UNIX OpenVMS HP and HP UX are trademarks of Hewlett Packard Company in the United States and other countries Microsoft Windows Windows 2000 Windows XP and Windows NT are registered trademarks of Microsoft Corporation in the United States and other countries Sun Solaris SunOS and PMDF are trademarks or registered trademarks of Sun Microsystems Inc in the United States and other countries IRIX is a registered trademark of Silicon Graphics Inc in the United States and other countries Linux is a registered trademark of Linus Torvalds Intel and Pentium are registered trademarks of Intel Corporation All other trademarks both marked and not marked are the property of their respective owners This product includes software developed by the Apache Software Foundation http www apache org Some portions licensed from IBM are available at http oss software ibm com icu4j This product includes code licensed from RSA Security Inc Manuals are available in PDF format from ftp Isoft com They are also available on the World Wide Web at the following URL URL http www Isoft com manuals index htmIl L Soft invites comment on its manual Please feel free to send your comments by email to manuals lsoft com Last Updated November 6 2007 Table of Contents Preface About This Manual 222 eee vii What s New for Customizing LISTSERV Maestro 3 1 1 1 2 0 cece eee eee ix
16. HTML may default to the plain text alternative allowing them to receive a message To reach the highest number of recipients it is generally a good idea to use an alternative text with each HTML message This tab is a preview of the alternative plain text body of the HTML email message with all drop in elements resolved If errors have been encountered while LISTSERV Maestro has tried to replace the drop in placeholders with the drop in content an error message is displayed and the un replaced drop in placeholders are highlighted in the alternative text preview You cannot edit the alternative text on this tab see the Text tab but you can upload a new alternative text by clicking the Upload Text Alternative button The Text tab lets you define the alternative text of your choice Type the text directly in the box cut and paste it from another application or upload a text file by clicking the Upload Text Alternative button For this to function properly the plain text alternative and drop in content must be enabled for the email job To test how the current template would behave when used in the content definition of a mail job click the Test Template link To delete the current template click the Delete Template link To leave the screen and store any changes made to the template click the OK button To leave the screen without storing click Cancel 5 8 Defining the Template Settings The Template Settings tab on th
17. Lists with digests enabled Table 2 6 Subscription Type Profile Field Placeholder Attributes Attribute Name Mandatory Attribute Description normaltext Yes Defines the text that will be displayed as the Normal Subscription choice digesthtmltext Yes Defines the text that will be displayed as the Digest in HTML Format choice digestmimetext Yes Defines the text that will be displayed as the Digest in MIME Format choice digestplaintext Yes Defines the text that will be displayed as the Digest in Plain Text choice LISTSERV Maestro version 3 1 Interface Customization Manual 26 Section 2 Customizing the Subscriber Interface Attribute Name Mandatory Attribute Description If the Hosted LISTSERV List supports delivery in the Index format then indexhtmltext Yes Defines the text that will be displayed as the Index in HTML Format choice indexplaintext Yes Defines the text that will be displayed as the Index in Plain Text Format choice 2 7 7 Button Profile Field Placeholders This table lists the attributes that may be used with button profile field placeholders Table 2 7 Button Profile Field Placeholder Attributes Attribute Name Mandatory Attribute Description text Yes Defines the text label for the button 2 7 8 Clickable Link Profile Field Placeholders This table lists the attributes that may
18. Screen 48 Message Content Type Screen 0000s 49 Create Template From Mail Job a 50 Upload Content Template Screen 2 0000 cece te 50 General Settings on the Template Settings Tab 00 53 Template Placeholders Section on the Template Settings Tab 53 Enabling Drop In Content for a Message Template 54 Inserting a Placeholder 0 cece eee ne 56 Editing a Template Placeholder 0000 cee eect eee 56 Managing User Defined Templates 02020 e cece eee ees 69 The Default Style Sheet 0 0 02 eee eae 75 LISTSERV Maestro version 3 1 Interface Customization Manual iii List of Figures LISTSERV Maestro version 3 1 Interface Customization Manual List of Tables Text Number Email or Password Profile Filed Placeholder Attributes 21 Boolean Profile Field Placeholder Attributes ccc cee ee 21 Single Select Profile Field Placeholder Attributes 002000 eee aee 22 Multiple Select Profile Field Placeholder Attributes 0 0 0c eee eee 24 Subscription Status Profile Field Placeholder Attributes 26 Subscription Type Profile Field Placeholder Attributes 2 005 26 Button Profile Field Placeholder Attributes 0 0 0 ccc cee eee 27 Clickable Link Profile Field Placeholder Attributes 0 0 0 0 0
19. a 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 not inside other placeholders while sub level placeholders can only be used on the page if they appear inside 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 O 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 i e they must appear on the page otherwise the customization is not accepted by the system Mandatory placeholders are also marked by using a bold font for their name In the tree structure placeholders with further children are preceded by a symbol if the children are currently not visible or symbol if the children are currently visible Click on the or symbol to make the children visible or to hide them LISTSERV Maestro version 3 1 Interface Customization Manual 19 Section 2 Customizing the Subscriber Interface If you click on a placeholder i e its symbol or name
20. be used in the content definition of a mail job the template will not appear in the list of available templates when defining a job s content Enabled The template is complete and enabled and can be used in the content definition of a mail job For information on using a template to define the content of a job see the User s Manual for LISTSERV Maestro Click on a template name to edit or delete the template or use any of the action links that may appear next to the template name Copy Create a new template as a copy of this template Enable Enable a currently disabled complete template Disabled Disable a currently enabled complete template Download Download the template in form of a ZIP file that contains all data of the template This ZIP file can then be used to create a new template in this or any other LISTSERV Maestro instance by uploading it again This link is only displayed for the administrator System templates are pre defined templates that come together with LISTSERV Maestro A system template can not be used for content definition directly but they can LISTSERV Maestro version 3 1 Interface Customization Manual 69 Section 5 Creating Customized Message Templates be copied and used as a base for a new user defined template see Section 5 1 Creating a Copy of a System Template LISTSERV Maestro version 3 1 Interface Customization Manual 70 Appendix A Custom Styles and HTML Tags h
21. be used with clickable link profile field placeholders Table 2 8 Clickable Link Profile Field Placeholder Attributes Attribute Name Mandatory Attribute Description text Yes Defines the text that will represent the clickable link 2 8 Setting the Default Display for Data Fields During customization certain placeholders may be defined with optional attributes defining how each profile field will be displayed on the final page Since each profile field may appear on several pages for example on the External Subscribe pages and on the Internal Edit Profile page it would become burdensome to have to specify the display attributes for a given profile field on each page that this field appears on To avoid this it is possible to define defaults for the attributes of all profile fields of a dataset or list The default attributes for a given profile field will be used whenever the profile field s placeholder appears on a page unless that placeholder appearance defines its own attributes In other words if a profile field placeholder appears on the page without any attributes then the default attributes will apply If the placeholder on the page already contains individual attributes then the default attributes are not used and the individual attributes apply but only on this page To define the default attributes for a profile field click the Profile Placeholder Default Attributes link at the bottom of the Pages
22. bracketed with the opening and closing parts of the span tag using the emphasis class You will need to translate this text to a corresponding meaning in your target language and then employ the opening and closing parts of the span tag with the emphasis class to the word that comes closest to the same semantic as the word Sample for Swedish Skall detta lt span class emphasis gt verkligen lt span gt blir raderat Sample for German Wollen Sie dies lt span class emphasis gt wirklich lt span gt l schen The span tag is frequently used throughout the text resources of LISTSERV Maestro Make sure that you transfer them with a similar meaning to your translation using the same class attribute For a complete list of the HTML tags and custom styles that are used by LISTSERV Maestro see Appendix A Custom Styles and HTML Tags 4 2 3 4 Non HTML Exceptions Even though most of the text is used inside HTML pages there are some exceptions Inside of these exceptions the rules of HTML escape sequences HTML whitespace HTML linebreaks and HTML tags do not apply and you must be careful not to for example use a HTML escape sequence in one of these text If you would do so and for example write amp amp instead of 4 then the user would actually see the amp amp text instead of the desired amp The best approach to avoid this is to use HTML markup in translated text only if the original
23. choices 3 If less than four choices then the column row count is chosen to create a layout as compact as possible maxcols No Defines the maximum number of rows 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 but never use both at the same time Default If there are more than four choices 3 If less than four choices then the column row count is chosen to create a layout as compact as possible tablestyleclass No Defines the name of the CSS style class es assigned to the HTML table surrounding the radio button grid Default no style class rowstyleclass No Defines the name of the CSS style class es assigned to each row in the HTML table surrounding the radio button grid Note If you use rowstyleclass then you cannot use evenrowstyleclass or oddrowstyleclass Default no style class evenrowstyleclass No Defines the name of the CSS style class es assigned to every even row in the HTML table sur rounding the radio button grid Note If you use evenrowstyleclass then you must also use oddrowstyleclass but you cannot use row styleclass Default no style class oddrowstyleclass No Defines the name of the CSS style class es assigned to every odd row in the HTML table surrounding the radio button grid Note If you use oddrowstyleclass then you must also use evenrowstyleclass but you cannot use
24. for that group is displayed Click on one of the messages to select it as the layout element you want to customize or view When you initially select a message group from the drop down menu the first message in the group is selected by default LISTSERV Maestro version 3 1 Interface Customization Manual Section 2 Customizing the Subscriber Interface If you selected an input validation error for an error group then a list of available errors for that group is displayed Click on one of the errors to select it as the layout element you want to customize or view For each error group there is an Error Group Header Footer layout element that defines a common opening and closing text that is shared by all of the errors in this group This header footer appears first in the list of errors for the group and is selected by default when you initially select an error group from the drop down menu Figure 2 4 Customizing the Membership Area Layout Customize Page Layout Currently Customizing Membership Area Layout v Selected Page Template Draft Version Production Version Membership Area Header Footer v This header and footer is used by 24 pages Details The membership area header footer is the default surrounding layout for all pages in the membership 2 eS ii This part of the layout is replaced with the actual page body content The right pane contains two tabs the Draft Version tab an
25. in addition the Content Templates option lets you manage and copy any existing templates Figure 5 1 New Message Template Options RV Maestro a n B m Mail Job Report Recipient Warehouse Utility LISTSERV Back To Preferences Logout Refrescs Create Empty Template Dashboard New Content Template Create Empty Template Content Templates Create Template Based on Mail Job Ex sa Currently In The System New Drop In Content Upload Template Open Jobs Drop Ins 3 Datasets 4 Ongoing Jobs New Sender Profile Hosted Lists 3 Completed Jobs Sender Profiles Hosted Recipients 1 045 of which tracked jobs eR ala Print Page Remaining Quota 50 000 With these options you ll be able to create professional looking HTML messages with or without HTML coding LISTSERV Maestro 3 1 now comes with ready to use message templates that contain placeholders that when selected in the template designer will let you fill in predefined areas with your own text or images In addition all text including any changes you may make down the road will be entered into both the HTML and the text part of your message so you only need to enter the text once Each placeholder can represent one or several instances of plain text or HTML or a linked or inline binary When using the template designer you can also preview each placeholder providing a full picture of what the template will look like when it is finished 5
26. ins for a drop in with this name If the name is not found delivery of the mail fails with an error message like Drop In with name sample not found If drop in content is disabled any drop in placeholder names that might appear in the message will not be replaced with the corresponding content Instead the placeholder names will appear verbatim in the body of the message Figure 5 8 Enabling Drop In Content for a Message Template Drop In Content Settings Enable or disable the drop in content feature for the job To create a new drop in content element or to edit an existing one click on the Utility menu and select New Drop in Content or Drop Ins If drop in content is enabled define the opening and closing tags that are used to enclose drop in content placeholders so that LISTSERV Maestro can recognize them For example if the opening tag is and the closing tag is you would create a drop in placeholder that looked like this PLACEHOLDER_NAME Disable drop in content for this job Enable drop in content for this job Use the following placeholder tags Opening tag 1 Closing tag For more information on drop ins see the User s Manual for LISTSERV Maestro LISTSERV Maestro version 3 1 Interface Customization Manual 54 Section 5 Creating Customized Message Templates 5 10 Using Template Placeholders Template placeholders make content templates easy to use and truly customizable a
27. rowstyleclass Default no style class LISTSERV Maestro version 3 1 Interface Customization Manual 23 Section 2 Customizing the Subscriber Interface Attribute Name Mandatory Attribute Description cellstyleclass No Defines the name of the CSS style class es assigned to each cell in the HTML table surrounding the radio button grid Default no style class For the radiogrid type if this field is an optional field defaultvalueposition No If the profile field is an optional field then one of the choices is No Selection This attribute defines where the No Selection choice will be rendered The available positions are first first radio button in the grid last last radio button in the grid above first radio button in the grid which will be rendered in a separate row above all other choices and below the last radio button in the grid which will be ren dered in a separate row below all other choices Default first 2 7 4 Multiple Select Profile Field Placeholders This table lists the attributes that may be used with multiple select profile field placeholders Table 2 4 Multiple Select Profile Field Placeholder Attributes Attribute Name Mandatory Attribute Description type No Defines how the multiple select field will be rendered Possible types are list a selection list or checkbox grid a grid of checkboxes Default list For the
28. step stand out from the other active step description Used to render the public description of the member ship area or current category if any subscribed Used to render the yes marker in the Subscribed column in the table that displays the available lists in the membership area Signifies that the currently logged in member has subscribed to the list LISTSERV Maestro version 3 1 Interface Customization Manual rane AP Appendix A Custom Styles and HTML Tags Custom Style Description notsubscribed Used to render the marker in the Subscribed column in the table that displays the available lists in the membership area Signifies that the currently logged in member has not subscribed to the list selectedTab Used to render the label and background of the cur rently selected tab in the membership area My Lists or My Profile tableThickFrame Used to render the membership area pages to appear with two tabs My Lists and My Profile This frame surrounds the main part of the membership area which sits beneath the two tabs tableBottomLine Used in the membership area to render a horizontal separator line between the row that displays the cur rent category and it parent categories as navigation links this row only appears if there are categories in the dataset and the lower part that shows all mailing lists in the curr
29. text contained HTML markup However in many cases the original text does not contain HTML markup but is used inside of an HTML page anyway For example the text for the assign title page key which is the title text for the Team Collaboration screen of a LISTSERV Maestro email job A translation for this text may benefit from additional HTML markup such as an additional lt br gt in the case that the translated version is very long and a linebreak would help achieving a good page layout LISTSERV Maestro version 3 1 Interface Customization Manual 37 Section 4 Using the Resource Translation Tool In other cases the text is used in a context where no web browser is involved meaning that it is sent to the user as a plain text mail or is written to a downloaded text file 4 2 4 Word Replacement In some resource texts LISTSERV Maestro employs word replacement to ease translation Consider the following example 500 duplicates have been removed from the job This text contains a value that may vary at run time Therefore you can not simply have a value with this text in the translation otherwise you would need an infinite number of texts one for each number of duplicates that may have been removed The immediate solution is to specify the text duplicates have been removed from the job and let LISTSERV Maestro affix the number of deleted duplicates at runtime For this to work the number of deleted duplicates has
30. the header footer template then only the part of the page between these two placeholders will be retained Conditional placeholders mark the beginning and end of parts of the page or template that are displayed under certain conditions For example on certain pages and templates the maestro validationErrorsPresentj and maestro validationErrorsPresent placeholders surround the text and code that will be used only if validation errors have been detected The maestro validationErrors placeholder which can only be used within this conditional block will be replaced by the relevant validation error text as defined in the error message templates When you are editing a template or page then the placeholder tree structure is displayed This structure defines the placeholders that can be used for the customization of the selected page or template Placeholders are divided into two categories Free Placeholders and Restricted Placeholders Free Placeholders may appear anywhere on the page Restricted Placeholders when used on a page must conform to the same tree structure that is shown in the left pane The placeholder tree structure shows each placeholder by name and uses symbols to denote what type of placeholder it is O Free Placeholders Free placeholders may appear anywhere on the page even inside other placeholders They are always optional which means that you can include them but do not have to
31. the list of exiting placeholders below If you instead want to define a new placeholder now select New below and supply the settings for the new placeholder Click OK to insert the placeholder at the current caret position in your template Define New Placeholder ADDRESS PHYSICAL ARTICLES Name BYLINES FEATURE HEADERS Display Title FEATURE TEXT 3 FEATURE TEXT ALT Mandatory The user must supply a value HEADERS a IMAGE LOGO The user supplied value for the placeholder is IMAGES z NEWSLETTER FOoTE Plain Text x NEWSLETTER HEADE 8 NEWSLETTER ISSUE In the preview show sample text as follows URL READMORE M Some Words v In this screen select an existing placeholder from the list on the left and click OK which will automatically insert the placeholder s NAME tag at the current cursor position 5 10 2 Editing Placeholders Template placeholders have various attributes that determine their appearance and behavior These attributes can be defined on the Edit Placeholder screen during placeholder creation or by clicking the Edit link of an existing placeholder in the list on the Template Settings tab Figure 5 10 Editing a Template Placeholder Edit Placeholder Supply the settings of the placeholder Click OK to submit the settings click Cancel to cancel Name Display Title CO Mandatory The user must su
32. the preview of the Membership Area Page shown when the Draft Version tab or Production Version tab are selected Using the Membership Area State tab different states can be experimented with and tested in order to see how each state impacts the membership area page layout Figure 2 7 The Membership Area State Tab Draft Version Membership Area State Production Version Use this page to experiment with different states of the lists in the membership area this helps you to test all available layout variants quickly without affecting the actual states of the lists in the membership area List Subscribed State Public Access State Maintenance State HLL Subscribed Open to everyone O Closed for maintenance HRL Subscribed Open to everyone C Closed for maintenance Sample List Subscribed Open to everyone closed for maintenance The states that can be defined correspond to the lists in the membership area For each list the following states can be set Subscribed State Check the Subscribed option to simulate how the page looks for a member who is subscribed to the given list Uncheck this option to simulate a member who is not subscribed to the list LISTSERV Maestro version 3 1 Interface Customization Manual 15 Section 2 Customizing the Subscriber Interface Public Access State Click the drop down menu and select the access state to simulate for the list With this how the page looks to
33. the syntax of a placeholder even though the repeater is not really a placeholder by itself The simple form without a separator looks like this multi repeat BODY The full form with a separator looks like this multi repeat BODY multi separator SEPARATOR With the following replacements Opening and Closing tags The and of above must be replaced with the correct template placeholder opening and closing tags of your template Repeater Body The word BODY must be replaced with the body text that shall actually be repeated by this repeater i e the repeater will be replaced with one or more instances of this body text Repeater Separator The word SEPARATOR must be replaced with the separator text that shall appear between two instances of the body text Such a separator is optional use the simple form described above if you do not want to specify a separator more about this below The body text and the separator text of the repeater can both contain any kind of text including template placeholders and even further nested repeater tags Actually the repeater only really makes sense if the body contains at least one template placeholder which also is defined as a multiple values placeholder And to be really useful a repeater usually contains at least two multiple value placeholders All occurrences of multiple values placeholders in the repeater body are examined For each such multi value plac
34. then an error message is displayed and the un replaced drop in placeholders are highlighted in the HTML preview To define the body from this tab you can upload an HTML file An uploaded HTML file may contain links to images on a remote server or local inline images embedded in the page To upload an HTML page click the Upload HTML button This will start a small applet that allows you to select an HTML file from your local disk for upload to the system You will need to have Java enabled in your browser for the applet to work Since the applet needs to access your local disk you will need to grant rights for the applet to function correctly The applet will load the selected HTML file and will search for all images and other binaries that are referenced in the HTML code All binaries that are referenced locally with a local file name and or path will be uploaded together with the HTML code Once the upload is complete the applet displays a short summary listing all locally referenced binaries that were uploaded as well as all binaries that were referenced as links to files on the Internet these are not uploaded All binary references that are found but could not be resolved will also be listed Confirming the summary will allow the applet to upload the data HTML and binaries to the system The system will display the uploaded page on the HTML tab By clicking the Download HTML button a previously uploaded HTML file and its
35. then check the Include plain text alternative box This ensures that recipients whose email client does not display HTML will default to the plain text alternative which allows them to receive the message Figure 5 3 Message Content Type Screen Message Content Type Please define the content type of the messages based on this template Messages based on this template can either be HTML or plain text In case of a HTML message you can also choose to include a plain text alternative This alternative may allow recipients whose e mail program can not display HTML messages correctly to still read your message s HTML Mail Include plain text alternative O Plain Text Mail Click OK to save and return to the Edit Content Template screen You are now ready to define your HTML template The first step is to enable drop in content see the Section 5 9 Using Drop In Content for details After drop in content is enabled you can define the template s content section 5 7 Defining the Template Content for details 5 4 Creating a Template Based on an Existing Job To create a template based on an existing job click on the Utility menu select New Content Template and then select Create Template Based on Mail Job This opens the Create Template From Mail Job screen LISTSERV Maestro version 3 1 Interface Customization Manual 49 Section 5 Creating Customized Message Templates Figure 5 4 Create Template From Mail Job Cr
36. to be hard coded so that it appears first in the sentence followed by some text What if in a different language the syntax of the language would not allow such a sentence For example the syntax of that other language may allow only a sentence such as From the job 500 duplicates have been removed where the variable part appears right in the middle of the sentence If this occurs then a hard coded solution is not a good idea To compensate for this LISTSERV Maestro uses word replacement In the text resources whenever there is a variable part a replacement placeholder is used instead At runtime the placeholder will be replaced with the variable value forming the desired finished sentence 4 2 4 1 Standard Number Placeholders Standard numbered placeholders appear in the text as a number that is enclosed in curly brackets such as 0 1 2 etc Using the example from the precious section we could write the text as follows 0 duplicates have been removed from the job At runtime the 0 is replaced by the variable number 500 the desired correct English sentence 500 duplicates have been removed from the job will be formed If in another language the other form of the sentence would be required then the translator can simply relocate the placeholder in the sentence such as From the job 0 duplicates have been removed This means that whenever you find one of these numbered placeh
37. user To define the default language for the Subscriber Interface of all the datasets of a certain single user use the following setting in the lui ini file DefaultCustomizationLanguage amp account amp USER ID XX If not specified the server wide default language will be used e For all of the above replace the following Xx Replace with the two letter lowercase code of the desired language For example en for English or de for German GROUPNAME Replace with the name of the group USER ID Replace with the ID or SeqNo of the single user You will need to restart LISTSERV Maestro to make the changes effective For individual datasets the data administrator can choose the default language for use on the Subscriber Pages when defining the General characteristics of the dataset The Access Pages Language drop down menu is available to choose among all the languages that have a translation file installed LISTSERV Maestro version 3 1 Interface Customization Manual 46 Section 5 Creating Customized Message Templates amp fter the administrator has given you the right to administer content templates A then the Utility menu will contain two new options New Content Template and Content Templates The New Content Templates option gives you several ways to create a new user defined template by copying a system template by using your own content or by selecting content from a previous job
38. Customization Manual 25 Section 2 Customizing the Subscriber Interface Attribute Name Mandatory Attribute Description cellstyleclass No Defines the name of the CSS style class es assigned to each cell in the HTML table surrounding the checkbox grid Default no style class 2 7 5 Subscription Status Profile Field Placeholders This table lists the attributes that may be used with subscription status profile field placeholder These placeholders are only available for Hosted Recipient Lists and Hosted LISTSERV Lists Table 2 5 Subscription Status Profile Field Placeholder Attributes Attribute Name Mandatory Attribute Description type No Defines how the Subscription Status field will be rendered Possible types are dropdown a drop down menu or radiobuttons as two radio buttons Default dropdown mailtext Yes Defines the text that will be displayed as the Subscription Active choice nomailtext Yes Defines the test that will be displayed as the Subscription Inactive choice For the radiobuttons type separator No Defines the text that will be rendered as a separator between the two radio buttons Default A single space character 2 7 6 Subscription Type Profile Field Placeholders This table lists the attributes that may be used with subscription type profile field placeholders These placeholders are only available for Hosted LISTSERV
39. Drop in content is disabled by default for a newly created template To enable drop in content click on the Drop ins icon on the Edit Template Content screen This icon is also used to change the current settings or to disable drop ins for the template Drop ins use an opening and a closing tag These tags are used by LISTSERV Maestro to identify the names of the drop in content In content templates the opening and closing tags used for drop ins must be the same as used for the template placeholders Therefore changing the tags for drop ins also changes the tags for the template placeholders and vice versa Opening and closing tags can be any characters you like that do not contain any spaces and are suggested as defaults but you may change them To include drop in content in your template simply enter the name of the drop in at the appropriate location enclosed in the tags you have defined For example if your drop in is called sample and you are using the suggested default tags then you would include the text sample in the location where you want the drop in content to appear in the final message Whenever LISTSERV Maestro finds the opening tag followed by the closing tag it will interpret all the characters in between first as a template placeholder name If no placeholder with this name is found then the name is instead interpreted as the name of a drop in LISTSERV Maestro will then look up the list of available drop
40. I LISTSERV Maestro 3 1 Interface Customization Manual www Isoft com 2007 s MAESTRO Eje susci AY d Information in this document is subject to change without notice Companies names and data used in examples herein are fictitious unless otherwise noted L Soft does not endorse or approve the use of any of the product names or trademarks appearing in this document Permission is granted to copy this document at no charge and in its entirety if the copies are not used for commercial advantage the source is cited and the present copyright notice is included in all copies Recipients of such copies are equally bound to abide by the present conditions Prior written permission is required for any commercial use of this document in whole or in part and for any partial reproduction of the contents of this document exceeding 50 lines of up to 80 characters or equivalent The title page table of contents and index if any are not considered to be part of the document for the purposes of this copyright notice and can be freely removed if present Copyright 2007 L Soft Sweden AB All Rights Reserved Worldwide LISTSERV is a registered trademark licensed to L Soft Sweden AB and L Soft international Inc ListPlex CataList and EASE are service marks of L Soft international Inc The Open Group Motif OSF 1 UNIX and the X device are registered trademarks of The Open Group in the United State and other countries
41. L ID per multi value 5 lt table gt TableRow lt tr gt lt td id ValueCell INDEX gt VALUE lt td gt lt tr gt lt table gt lt multi placeholder that generates a unique link anchor per multi value gt ParagraphWithAnchor a name Paragraph INDEX gt lt p gt VALUE lt p gt lt a gt grap lt multi placeholder that generates a unique link to the above anchor per multi value gt LinkToAnchor a href Paragraph INDEX gt VALUE lt a gt lt br gt Assuming that TableRow ParagraphWithAnchor and LinkToAnchor are defined as multiple value placeholders and assuming that the user supplies five values for TableRow three values for ParagraphWithAnchor and matching three values for LinkToAnchor then the resulting HTML would look something like this linebreaks added for readability lt Example with multi placeholder that generates a unique HTML ID per multi value gt lt table gt LISTSERV Maestro version 3 1 Interface Customization Manual 64 Section 5 Creating Customized Message Templates lt tr gt lt td id ValueCell 1 gt First cell value here lt td gt lt tr gt lt tr gt lt td id ValueCell 2 gt Second cell value here lt td gt lt tr gt lt tr gt lt td id ValueCell 3 Third cell value here lt td gt lt tr gt lt tr gt lt td id ValueCell 4 gt Fourth cell value h
42. L escape sequence Another typical character that needs to be escaped in the form of a HTML escape sequence is the ampersand character amp LISTSERV Maestro version 3 1 Interface Customization Manual 35 Section 4 Using the Resource Translation Tool lt must be entered as the escape sequence Sit gt must be entered as the escape sequence amp gt amp must be entered as the escape sequence amp amp must be entered as the escape sequence amp quot A non breaking non whitespace space may be escaped as amp nbsp Note HTML escape sequences always start with an un escaped ampersand and end with a semicolon Please see the many related resources on the web that tell you more about characters that need to be escaped in HTML for example http www w3 org TR html401 sgml entities html 4 2 3 2 HTML Whitespace and Linebreaks Any sequence of whitespace characters e g space tab linebreaks etc will be rendered as a single space by the web browser Example word 1 t t r n t t t NrMnword 2 This value starts with word 1 followed by two spaces two tabs a Windows style linebreak three more tabs another two spaces another linebreak and ends with word 2 All the characters between word 1 and word 2 all of the spaces tabs and linebreaks are considered whitespace This means that they will all be collated into a single space when rendered as part of a HTM
43. L page word 1 word 2 There will not be several spaces but only one and there will not be any visible tab or linebreak whatsoever To actually include more than one space you need to use special spaces that are written in the form of their HTML escape sequence The most widely used escape sequence for a non breaking space is amp nbsp So word l amp nbsp amp nbsp amp nbsp word 2 defines the text word 1 word 2 where the three spaces between the two words will actually appear on the rendered page Linebreaks are usually introduced by the browser that renders the page whenever a linebreak is required A linebreak is required whenever the line length is not enough to show the rest of the text therefore the text will be wrapped to the next line and the browser will use whitespace between words as the places where a possible linebreak may be inserted for this wrapping Linebreaks that are visible on the rendered page can not be inserted by inserting a linebreak by pressing ENTER into the translated text Instead you need to use a special HTML tag that has the effect of introducing a visible linebreak br Example The following text line l br line 2 will actually appear as two lines line 1 and line 2 on the rendered page 4 2 3 3 HTML Formatting in Text Resources The majority of text resources in the Translation Kit are pure text strings without any formatting directives in the form of HTML tags All format
44. LISTSERV Maestro application folders must create the custom properties files and place any custom image files on the server A graphic artist may be required to create custom image files of the correct size Translating or providing new default text for subscriber pages LUI and or HUB No special access is needed to perform the translation Anyone can download the translation kit and run the resource translation tool on their own workstation A System Administrator with direct access to the LISTSERV Maestro application folders must make the translation files produced by the resource translation tool available to LISTSERV Maestro A System Administrator must make changes to the 1ui ini file if a translation is to be the default for datasets belonging to a particular group or for all datasets on the site Creating and Customizing the Message Templates The Maestro Administrator enables any Template Manager accounts in the HUB by defining the The user may administer Content Templates user right setting The Template Manager creates customizes and enables a template for use when defining a message LISTSERV Maestro version 3 1 Interface Customization Manual Section 1 Why Should Customize LISTSERV Maestro LISTSERV Maestro version 3 1 Interface Customization Manual Section 2 Customizing the Subscriber Interface data administrator to customize every page and email that a subscriber will see This ma
45. Maestro version 3 1 Interface Customization Manual 68 Section 5 Creating Customized Message Templates 5 11 Managing Existing Templates The Manage Content Templates screen lists all currently available content templates for editing and other management of the templates To access this screen click on the Utility menu from the Toolbar and then select Content Templates The user defined templates are the content templates that can actually be used in the content definition of a mail job These templates are located at the top of the Manage Content Templates screen Figure 5 11 Managing User Defined Templates Manage Content Templates All defined content templates for your account User Defined Templates Click on a template to edit delete it Template Name Date Time saved Status Customer Support Newsletter Jun 25 2007 01 42 23 PM Enabled Copy Disable Download Marketing Newsletter Jun 25 2007 01 42 59 PM Enabled Copy Disable Download Sales Newsletter Jun 25 2007 01 43 31 PM Complete Copy Enable Download Weekly Newsletter Jun 25 2007 01 41 50 PM Enabled Copy Disable Download Each user defined template is displayed with its name date time of last change and its status Incomplete The template definition is not yet complete therefore the template can also not be enabled Complete The template definition is complete however the template has not yet been enabled and can not
46. ORE URLs to read entire articles Plain Text multiple values No Edit Copy Delete URL UNSUBSCRIBE URL to unsubscribe Plain Text Yes Edit Copy Delete URL WEB URL to view newsletter in browser Plain Text Yes Edit Copy Delete Add Placeholder Each placeholder is displayed with its name display title value type mandatory optional state and the following actions Edit Click this link to edit this placeholder The Edit Placeholder screen opens From here make changes to the placeholder and then press OK to save e Copy Click this link to create a new placeholder as a copy of this one A copy of this placeholder will appear in the list Once the copy is created rename the placeholder and make any other changes you d like to make To do this click the Edit link Delete Click to delete this placeholder You will be asked if you really want to delete the placeholder Click OK to confirm The Add Placeholder button at the bottom of the tab lets you create a new placeholder Once you click on this button the Edit Placeholder screen opens From this LISTSERV Maestro version 3 1 Interface Customization Manual 53 Section 5 Creating Customized Message Templates screen you can enter the information for the new placeholder For more information on using this screen see Section 5 10 2 Editing Placeholders 5 9 Using Drop In Content To use drop in content in your template you first need to enable it
47. RL which is why this type of placeholder should be used only in a context in the HTML code where such a URL makes sense Normally the placeholder would stand in for an image and would appear in the src attribute of an lt img gt tag like this lt img src SampleBinaryPlaceholder gt Other valid contexts would be in a style definition where an image URL is required or in a background image or sound attribute of an HTML tag This placeholder type can only be used in the HTML part of an HTML template Binary inline Same as the Binary linked or inline type above only with this type the binary will always be an inline binary This means that the user who employs the template during content definition will have no choice about this Binary linked Same as the Binary linked or inline type above only with this type the binary will always be a linked binary i e the user who employs the template during content definition will have no choice about this The following Multiple Values Placeholders are available Plain Text multiple values Same as the Plain Text type above but the user who employs the template during content definition has the option of supplying multiple values for the placeholder The placeholder will be replaced with the combined multiple values linked to each other This is useful when using the multi placeholder repeater and or the special placeholder prefix and suffix because t
48. V Maestro Solution Do not use the Customization wizard instead use the Resource Translation Tool The Translation Tool allows you to change some of the default text that LISTSERV Maestro uses for the default layout By directly modifying the default text you will influence not only a single dataset but all of the datasets that are using these defaults For this situation you are not translating text instead you are supplying custom replacement values for parts of the text Make sure to choose English as your target language when using the Translation Tool for this situation For information on the Resource Translation Tool see Section 4 Using the Resource Translation Tool Translating all text to a different language for all of your datasets all at once Situation In general you are fine with how the pages error messages and email notifications look but you would like them to appear in a different language Plus you would like all of your datasets to use this different language for the default pages Solution Use the Resource Translation Tool to customize the default texts that LISTSERV Maestro uses for the default layout By directly modifying the default text you will influence not only a single dataset but all of the datasets that are using these defaults For information on the Resource Translation Tool see Section 4 Using the Resource Translation Tool Customizing specific text for a specific dataset Situation
49. V Maestro 3 0 this feature is no longer available for the User Interface If you have customized images in place from previous versions for the User Interface and then upgrade to 3 0 or higher then these images will be ignored In order to replace the LISTSERV Maestro logo image files prepare the customized image files and save them in either GIF or JPG format There are size restrictions for the files which are detailed below Create a folder named customin the hub directory Save the image files in these custom folders so that the files are accessible to LISTSERV Maestro and so that the files will not be changed or deleted by LISTSERV Maestro s upgrade routine although the folders may be deleted during a full uninstall of LISTSERV Maestro For the Administration Hub component create a custom folder so that the path to save the image files reads maestro install folder webapps hub custom Storing image files anywhere else will either have the effect that LISTSERV Maestro will not be able to find them or they may be lost during an upgrade Once the images are saved in the custom folder LISTSERV Maestro needs to know about them Do so with the same sort of key value entries in the custom properties file s as described above Each key s value must be a relative filename that starts with a forward slash and includes the name of the custom folder itself as the first path element using the forward slash as the separator such as
50. a member can be verified with the subscription state defined via the Subscribed option see above if the list has the selected state The possible states are Open to everyone Access for subscribers only or No public access Maintenance State Check the Closed for maintenance option to simulate that the given list is currently closed for maintenance Uncheck this option to simulate that the list is not closed With this you can verify how the Membership Area Page looks to a member with the subscription state defined via the Subscribed option see above when the list is closed for maintenance and when it is not 2 5 Editing Subscriber Notification Emails To edit a notification email click the Edit Source icon on the Draft Version tab of the Customize Page Layout screen Then enter edit the information in the following fields Sender Name Enter the name that is to be used as the sender name Do not use an email address instead enter a real name This value is optional if nothing is supplied then the List Administrator s address from the dataset definition will be shown in the From field Subject Enter the subject line that is to be used for this notification email Below the Subject field is a list of all placeholders that may be included in the subject line These placeholders will be replaced with suitable values before delivery Enter the placeholder manually into the subject line or click on the link to automatically ad
51. alues Then it would be up to the user to decide how many values to supply for this placeholder If no value is supplied only allowed if the placeholder is not mandatory then the placeholder will be replaced with an empty string and the lt li gt tag will not appear since it is defined in the prefix which is not rendered for an empty optional placeholder If only a single value is supplied then the placeholder behaves just like a normal placeholder The value is used to replace the VALUE part and the result including the prefix lt li gt would be used to replace the placeholder and the resulting HTML code would look something like this lt ul gt lt li gt Single value here lt ul gt But if several values are supplied then the multi behavior comes into play Each of the values would be used individually to replace the VALUE part and the prefix lt li gt would be added to each of the values Then the result for all values would be linked together and used to replace the placeholder Therefore the resulting HTML code would look something like this sample with four values supplied linebreaks added for readability lt ul gt lt li gt First value here LISTSERV Maestro version 3 1 Interface Customization Manual 63 Section 5 Creating Customized Message Templates lt li gt Second value here lt li gt Third value here lt li gt Fourth value here lt ul gt The
52. associated binaries can be downloaded to your computer in the form of a ZIP archive This also applies to any HTML code that has been entered directly into the box on the HTML Code tab The HTML page is mandatory and must be filled out either by uploading an HTML page or by typing the HTML code directly into the box on the HTML Code tab The HTML Code tab contains the source code of the HTML body of the message To define the body type HTML code directly in the box cut and paste it from another application or upload an HTML page To edit the source code simply edit the code shown on this tab and then go back to the HTML Preview tab to view the changes To upload an HTML page click the Upload HTML button To download a previously uploaded HTML file and associated binaries in form of a ZIP archive click the Download HTML button The HTML page is mandatory and must be filled out either by uploading a HTML page or by entering the HTML code directly on the HTML Code tab LISTSERV Maestro version 3 1 Interface Customization Manual 51 Section 5 Creating Customized Message Templates The Text Preview tab displays the plain text alternative option for the HTML mail For this to function properly the plain text alternative and drop in content must be enabled for the job The alternative text is a plain text body that is an alternative for the more elaborate HTML body of the message Recipients whose email client does not display
53. at appear in the BODY or SEPARATOR blocks actually do matter as they become part of the block they belong to This is especially true for linebreaks that appear just before or after the multi separator tag or just before the closing y tag of the repeater To illustrate the repeater we use the same example as above with the article with heading sub heading and body where we also want to have a horizontal line between two articles but not before or after the first and last articles The same three placeholders heading sub heading and body as used above are required and all three must be defined as multiple values placeholders The correct code looks like this multi repeat heading lt div style font weight bold font style italic margin bottom 10px gt VALUE lt div gt sub heading lt div style font size 8pt font style italic margin bottom 5px gt VALUE lt div gt body lt div style font family serif gt VALUE lt div gt multi separator lt hr gt And the result after replacement assuming again that three values were supplied for each of the three multi value placeholders would look like this just as desired First Heading Value First Sub Heading Value First Article Body Value Second Heading Value Second Sub Heading Value Second Article Body Value Third Heading Value Third Sub Heading Value Third Article Body Value LISTSERV
54. ataset and is the first one that the subscriber sees after logging in The page is divided in two E parts the My Lists part and the My Profile part and offers navigation links that allow the MEM nn subscriber to switch between the two parts Sample dataset My Profile Current Category Sample dataset Sub Categories Subscribed List Name Action Description Sample Category Yes HLL Edit Profile Test HLL for Sample Dataset Unsubscribe Yes HRL Edit Profile HRL for Sample Dataset Unsubscribe Unsubscribe from all currently subscribed lists in this category lt l gt State Confirmed Member Default vi Under certain circumstances the Membership Area Page shows additional welcome messages to the subscriber Normally there is no welcome message displayed However the following situations have their own welcome message For a Confirmed Member Default The page is viewed in its default state as seen by normal confirmed members For a Confirmed Member LISTSERV not available Same as Confirmed Member Default see above however this state simulates that LISTSERV is not available LISTSERV itself or the network is down This situation may impact the presentation of Linked LISTSERV Lists therefore this simulated state is only available if there are any Linked LISTSERV Lists in the dataset For a Confirmed Member with the List Subscription Welcome Message The
55. cee eee 27 Keyboard Shortcuts for the Resource Translation Tool 2005 33 Predefined Date Pattems i nl AA 0004 dede E DEE GA eb ae ee ee 42 Predefined Time Patterns 0 0 0 eee eee ees 43 Custom Styles 0 naaa area ae eden eS eda de BUNGA dd Fee ee ee are 71 HIME AGS GANAN an wc Ba Pigaan ebay ated duns seein tot AO asa Ree Beas ay E Ka tes 72 Supported Languages for the User Interface and Administration Hub 79 Supported Languages for the Subscriber Interface 2000000 eee 79 LISTSERV Maestro version 3 1 Interface Customization Manual List of Tables LISTSERV Maestro version 3 1 Interface Customization Manual vi Preface About This Manual Every effort has been made to ensure that this document is an accurate representation of the functionality of LISTSERV Maestro As with every software application development continues after the documentation has gone to press so small inconsistencies may occur We would appreciate any feedback on this manual Send comments via email to manuals lsoft com The following documentation conventions have been used in this manual Menus options icons fields and text boxes on the screen will be bold e g the Dataset menu Clickable buttons will be bold and within brackets e g the OK button Clickable links will be bold and underlined e g the Edit link Directory names commands and examples of editing program files
56. cribed Pending tz lt 2 7 Placeholders Placeholders are used in pages and templates to represent parts of the page or template that are defined elsewhere and will be filled in with their final values when the page is displayed to the subscriber Placeholders come in different types Profile placeholders represent the data fields that make up the profile of individual dataset members and list subscribers The syntax for the profile placeholder of a data field called XYZ is maestro profilexyZ Whena page is displayed to the subscriber then the placeholder will be replaced by the value of XYZ for that subscriber The display name defined for the field is represented by the maestro 1abelXYZ placeholder Changing the display name in the dataset definition will automatically update all the pages that use this placeholder LISTSERV Maestro version 3 1 Interface Customization Manual 18 Section 2 Customizing the Subscriber Interface Structural placeholders represent pages or parts of pages For example in the header footer template the maestro body placeholder represents the body part of pages that inherit the header footer template In a fully customized page the maestro body placeholder marks the beginning of the body part of the page and the maestro body placeholder marks the end of the body part If the page is subsequently changed to inherit the header and footer from
57. d on customized pages For more information see Section 2 8 Setting the Default Display for Data Fields Select a page In addition to the header footer template there are a number of other layout elements which can be customized This link takes you to a list of all available layout elements Supply a custom membership area header footer The header footer is a common template which is by default shared by all pages that constitute the membership area therefore any changes to the header footer will automatically affect all pages Because of this the header footer is the ideal place to start the customization providing a common layout for all pages Comments Various comments may also be displayed depending on the type of layout element you selected to customize Header Footer Template This comment shows how many pages in the dataset and its lists that are currently using the header footer template i e pages that do not have a header footer defined of their own but are inheriting the template Click the Details link to view a detailed list of pages using this template Input Validation Errors The comment describes the currently selected error message and the circumstances under which it may occur Also unless the current message is already the error header footer of the error group then it provides a link to select the error header footer for the current error group By editing the error header footer y
58. d element which subscribers actually see The draft version remains unchanged If you have at least one layout element in the dataset where the draft version is different than the current production version then the Deploy icon allows you to deploy all these draft versions at once either the ones in the dataset itself or all draft versions in the dataset and all its lists Edit Source Click to edit the current draft version e Reset to System Default When this icon is located on the Draft tab then click it to reset the current draft version to the LISTSERV Maestro system default This will overwrite all manual changes to the draft version and will reset it to its default The production version remains unchanged When this icon is located on the Production tab then click it to reset the current production version to the LISTSERV Maestro system default This will overwrite all manual changes to the production version and will reset it to its default The draft version remains unchanged Show Preview Click to show the preview of the current production version View Source Click to view the source of the current production version E LISTSERV Maestro version 3 1 Interface Customization Manual Am Appendix D A Quick Reference Guide for the Customization Wiz Symbols Each table on the Membership Area Layout tab lists the available elements and displays their current customization status E The draf
59. d the placeholder at the current cursor position Body The main edit field for the email body The email will be sent as plain text Enter its content here Below the field a list of all placeholders that may be included in the body is shown These placeholders will be replaced with suitable values before delivery Enter the placeholder manually into the body or click on it to automatically add the placeholder at the current cursor position 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 simply leave it to the automatic line wrapping to wrap the longer lines into shorter lines just before delivery Language Charset Select the language charset character encoding to use for the email delivery The charset should match the language or the special non ASCII characters if any that were used in the body There are two icons available when editing a notification email e0 e Copy from Production Version Click to make a copy of the current production version and use it as the new draft version This will overwrite all current changes to the draft version The production version remains unchanged Reset to System Default Click to reset the current draft version to the LISTSERV Maestro system default This will overwrite all manual changes to the draft v
60. d the Production Version tab The production version is the version that subscribers who access the membership area pages actually see The draft version on the other hand is not visible to the subscribers This means that you can safely make any changes to the draft version without them becoming immediately visible For example you may want to customize one page after the other by editing their draft versions but you want to make the customized versions available all at once after you have finished with all pages Or you may want to experiment a bit with the layout without disturbing the actual production versions that subscribers see Only when you finally deploy the draft version as the new production version will your changes become visible to subscribers Depending on the type of element you selected the initial preview of the draft version is displayed in different ways If you selected a template then the preview displays the page as a normal HTML page as it would appear in the subscriber s browser Since the page being displayed is a template a rectangular placeholder frame is used at the location where the actual content will appear when the template is used by a page If you selected a normal page then the preview displays the pages as a normal HTML page as it would appear in the subscriber s browser LISTSERV Maestro version 3 1 Interface Customization Manual 10 Section 2 Customizing the Subscriber Inter
61. des using keyboard shortcuts Figure 4 3 Searching for Text in the Resource Tree 5 Find Text Search String abonn f Close Search In RUSO UEM Translated Text Start From Top _ Match Case 4 2 2 Key Value Entries Even though the Translation Tool presents the Translation Kit contents in a tree like structure LISTSERV Maestro requires that the resource keys are available in the form of key value pairs in a collection of text files that are bundled in a JAR file The Translation Tool frees you from the tedious task of creating such a collection manually however a general understanding of how resource keys and their values are used in LISTSERV Maestro is still useful Each resource key pair looks as follows lt KEY gt lt VALUE gt where lt KEY gt is replaced with the name of the key and lt VALUE gt with the language specific value associated with this key For example app caption cancel Cancel This defines a key called app caption cancel which has a value of Cancel LISTSERV Maestro version 3 1 Interface Customization Manual 34 Section 4 Using the Resource Translation Tool How it works Whenever some language dependent text needs to appear in the User Interface the program simply contains the key for that text and a replacement directive Therefore when LISTSERV Maestro needs to display a page containing this text it finds the Display the text associated
62. down list of the valid Translation Kits To begin your translation select the Translation Kit select the Translation Kit component and then select the target language Click OK to begin translating Figure 4 1 Resource Translation Tool Startup S5 L Soft Resource Translation Tool 1 0 2 Version LISTSERV Maestro 2 1 2 v Component LISTSERV Maestro User Interface Subscriber Pages v Language French v The main window of the Translation Tool is divided in two main areas the left area contains the resource key tree of the selected component and the right area is divided into an upper and a lower part The upper part displays the original text for the selected resource key the lower part displays the currently defined custom text for the selected target language Figure 4 2 Translation Tool Main Window L Soft Resource Translation Tool 1 0 2 LISTSERV Maestro User Interface Subscriber Pages 2 1 E OK E5 LISTSERV Maestro User Interface Subscriber Pages Original Text For hosted subs closed msg containerClosedForMaintenance E LUI Subscriber Pages Resources lt p gt Access to lt span E3 hosted class enphasis gt maestro datasetName lt spam gt is currently E subs not possible due to system maintenance operations lt br gt Please gt td area try again at a later time lt p gt C7 closed hosted subs closed title containerClosedFo 5 hosted subs closed msg containerClosedF 3 host
63. e Edit Content Template screen is available for both plain text and HTML templates The General Settings section contains two options Allow Advanced Editing When a template is used during the content definition of a mail job then the user who uses the template usually only has to fill in the blanks that are left by the template placeholders The user does not have to bother with the actual message body as this body is already defined by the template Therefore by default when a template is used to define the message content it is not even possible to modify the message body except by filling out the placeholders Under certain circumstances it may be desirable to allow a user to not only fill out the placeholders but to also modify or edit the whole of the message body This is what this option is for If checked then editing of the message body outside of the placeholders is allowed while the template is being used for content definition If not checked then only the placeholders can be filled out Highlight Placeholders When a template is used to define the message content then the user will have to provide content for all placeholders in the template To LISTSERV Maestro version 3 1 Interface Customization Manual 52 Section 5 Creating Customized Message Templates make this process simpler for the user LISTSERV Maestro highlights the currently selected placeholder in the preview To select the background co
64. e a prefix and a suffix to the content that will not appear if the user does not enter a content at all the prefix and suffix are only included if the user actually supplies a non empty content An example of this is NAME prefix VALUE suffix where NAME is replaced with the actual placeholder name and where you replace prefix with the desired prefix text and suffix with the desired suffix text using the following rules The string VALUE including the enclosing characters must appear between prefix and suffix if any are present e Both prefix and or suffix may be empty may be left out e Both prefix and suffix may contain linebreaks The linebreaks will become part of the prefix suffix LISTSERV Maestro version 3 1 Interface Customization Manual 61 Section 5 Creating Customized Message Templates Any characters after NAME and before VALUE will be part of the prefix including all linebreaks even linebreaks that appear immediately before VALUE except for any whitespace that appears immediately after the word NAME and that appears on the same line as the word NAME Such whitespace is ignored Also if the first line contains only whitespace after the word NAME then the linebreak at the end of this line will also be ignored and will not be part of the prefix See below for examples Any characters after VALUE and before the closing tag or whatever closing tag is app
65. e been made the customized pages may become incompatible with the dataset For example if new fields are added to the dataset then customized pages that do not include placeholders for these new fields are no longer valid When this happens the following symbols may be displayed instead of the symbols described above EI e The draft version of the page is customized but the customized version is no longer compatible with the dataset Therefore before you can view or deploy the current customized draft version you will have to make it compatible to the dataset again 3 The production version of the page is customized but the customized version is no longer compatible with the dataset Therefore the system has automatically modified the customized production version to make it compatible again and has saved a backup copy of the original customized production version If the customization of any page is currently incompatible to the matching dataset then the tab also displays an additional notification message about this and contains a link to a page where you can access all incompatible pages 2 3 Using the Customization Page Layout Screen If no customization has been done previously the Customize Page Layout screen can be accessed by clicking the Supply a custom membership area header footer link as described in Section 2 1 Accessing the Customization Wizard If customization has been done then the Customize Page Layout scre
66. e draft version The production version remains unchanged Reset to System Default Click to reset the current draft version to the LISTSERV Maestro system default This will overwrite all manual changes to the draft version and will reset it to its default The production version remains unchanged To submit the changes click OK To cancel editing without submitting any changes click Cancel Figure 2 9 Editing the Source Code of an Error Message Customize Page Layout Currently Customizing Membership Area Layout Selected Page Template 3 Draft Version Production Version Invalid Subscription Profile be Invalid Subscription Profile Ca E mail Address Empty Invalid E mail Address Address Change For Candidate Not Possible class error The user has supplied invalid input data for some of the fields on a page that asks for Error Group Header Footer subscription profile values Header lt p class error The subscription profile that you have provided below could not be accepted because of the following problems lt ul Step 2 Password Different Password Field Empty Existing Subscriber Password Field Empty Invalid Password Invalid LISTSERV Password Password Too Short Password Too Long Password Not Confirmed Address Already Subscribed Footer ul p Iready Member Iready Member Pending Address Change While Subscribing NG Address Already Subs
67. e text This title text will then be used to replace the TITLE attribute wherever it appears in the prefix or suffix The main use for this attribute is to provide the text for the title and or alt attribute of the lt img gt tag that the binary placeholder is used to generate for example like this prefix and suffix color coded like above BinaryPlaceholder img src VALUE title TITLE alt TITLE gt Note Observe how in the example the lt img gt tag is opened in the placeholder prefix and closed in the placeholder suffix and that the TITLE attribute appears in the suffix as a Stand in for the yet to be supplied title and alt attributes 5 10 5 Multiple Values Placeholders with Prefix Suffix The prefix and suffix have an especially important role when used together with placeholders that may have multiple values Plain Text multiple values or HTML multiple values The multiple values of these placeholders are linked to each other and the resulting value is used to replace the placeholder This by itself is not very useful as the user could just as well have supplied the multiple values already as one combined LISTSERV Maestro version 3 1 Interface Customization Manual 62 Section 5 Creating Customized Message Templates text in a normal single value placeholder However multiple value placeholders become useful when a prefix and or suffix are employed because the prefix suffix i
68. e 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 There are two icons available when editing a template or page Copy from Production Version Click to make a copy of the current production version and use it as the new draft version This will overwrite all current changes to the draft version The production version remains unchanged e Reset to System Default Click to reset the current draft version to the LISTSERV Maestro system default This will overwrite all manual changes to the draft version and will reset it to its default The production version remains unchanged LISTSERV Maestro version 3 1 Interface Customization Manual 12 Section 2 Customizing the Subscriber Interface Figure 2 5 Editing the Source Code of a Template Customize Page Layout Selected Page Template List Edit Profile Template Free Placeholders The placeholders below can be used anywhere on the page CJ datasetName B datasetDescription ej listName a listDescription Restricted Placeholders The placeholders below are only meaningful inside of their parent placeholders m g validationErrorsPresent O editListProfile O subscribeToList a profileFields O okButton Currently Customizing Membership Area Layout Draft Version Production version Membership area header footer inherited bod
69. eate Template From Mail Job Select the job to create the template from Existing Job Select v Create Template Click the Existing Job drop down menu select the job you want to use for your template and then click Create Template The Edit Content Template screen opens with the new template pre populated with the same content as the selected source job From this screen make any changes to the template and then click OK to save For more information on the Edit Content Template screen see Section 5 7 Defining the Template Content 5 5 Uploading Pre Defined Text To create a new template by uploading pre defined text click on the Utility menu select New Content Template and then select Upload Template The Upload Content Template screen opens Figure 5 5 Upload Content Template Screen Upload Content Template Supply the template to upload below I Eiowse Template File Enter the filename of the content template ZIP file located on your local system or use the Browse button to browse for the file and then click Upload to upload the template Note The uploaded template ZIP file must be a file that has previously been downloaded from LISTSERV Maestro which can also be a different LISTSERV Maestro instance with the download link provided on the template list page Once you have uploaded the template file you will be taken to the Edit Content Template screen which is where you can make an
70. ed Recipients Statistics Locate the hosted statistics node Underneath this node edit the hosted statistics msg downloadDateFormat key Completed Job Statistics Locate the hosted statistics node Underneath this node edit the hosted statistics msg downloadDateFormat key Membership Subscriber Statistics Locate the hosted statistics node Underneath this node edit the hosted statistics msg downloadDateFormat key Any of these four reports XXX msg downloadDateFormat keys must contain a pattern that will be translated into an actual date and time string at runtime In this pattern the following pattern fields must appear but you may switch them around change their order and insert other fill characters in order to create a format that LISTSERV Maestro version 3 1 Interface Customization Manual 41 Section 4 Using the Resource Translation Tool suits you Remember that uppercase and lowercase are important and that all pattern fields will be replaced with numerical counterparts i e no textual names of months etc MM two uppercase M characters Replaced with the month of the year 01 12 dd two lowercase d characters Replaced with the day of the month 01 31 yyyy four lowercase y characters Replace with the 4 digit value of the year HH two uppercase H characters Replaced with the hour of the day 00 23 mm two lowercase m characters Replaced with the min
71. ed placeholders i e the ones without any further parents in the tree structure can be used anywhere on the page at top level not inside other placeholders while sub level placeholders can only be used on the page if they appear inside 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 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 i e they must appear on the page otherwise the customization is not accepted by the system Mandatory placeholders are also marked by using a bold font for their name LISTSERV Maestro version 3 1 Interface Customization Manual 82 Appendix D A Quick Reference Guide for the Customization Wiz Links Links are the most common function in the Customization Wizard To select a template or page to customize simply click on the link for that template or page To perform a specific function simply click on that link Some of these links are Advanced Customization Used to customize an advanced element such as user messages or input validation errors Profile Placeholder Default Attributes Used to customize the placeholders use
72. ed subsiclosed title containerClosedFo 3 hosted subsiclosed msg containerClosedF French Custom Text press CTRL UP CTRL DOWN to navigate in the tree DJ hosted subsiclosed title listClosedForMainh cr Kp L acc s au site span hosted subs closed msg listClosedForMain lc 1ass enphasis gt maestro datasetName lt span gt n est pas gt CJ confirm ossible present di aux op rations d entretien du gt 7 list lsyst me lt br gt Veuillez essayer de nouveau plus tard lt p gt gt CJ login CI password CT requestPassword C resources gt CJ subscribe CI unsubscribe CJ unsubscribeConfirm LISTSERV Maestro version 3 1 Interface Customization Manual 32 Section 4 Using the Resource Translation Tool Clicking the Save button prompts the tool to create an appropriate resources jar file which is named as follows note that lang is replaced with the two letter ISO code of the selected target language see Appendix C Languages Supported for Translation for more information e hubResources lang jar for the HUB e luiResources lang jar for the LUI main application e luiSubscriberResources lang jar for the Subscriber Interface These files are written to the translationsV version folder of the Translation Tool s work folder For example if you have chosen to translate the Subscriber Interface of LISTSERV Maestro 2 1 1 to German
73. efreshed with the current custom text for the new property key Table 4 1 Keyboard Shortcuts for the Resource Translation Tool Shortcut Function Alt F Opens the Find screen If this is already open then it begins searching Alt C Closes the Find screen Alt N Finds the next occurrence of the previous search string Alt S Saves the changes Alt E Exits the Translation Tool 33 Section 4 Using the Resource Translation Tool Shortcut Function Ctrl Enter or Used while editing a custom text selects the subsequent Ctrl down arrow properties key node for editing Used while editing a custom text selects the previous Gn Top among properties key node for editing 4 2 1 2 Finding a Node in the Resource Tree Working on a translation frequently requires that you locate a specific properties key node in the resources tree Finding the node can be accomplished by manually navigating in the resource tree by expanding and collapsing tree nodes and scrolling until you find the node that you are looking for To speed up this task the Translation Tool comes with a Find feature Click the Find button in the bottom left corner of the main window to open the Find screen A node can be found by supplying a part of the property key by supplying a part of the original text or by supplying a part of the translated text See Table 4 1 for finding no
74. eholder the number of values as supplied by the user is determined The maximum number of values over all multi value placeholders then defines the repeat count This means that the multi value placeholder in the repeater body with the most values defines the repeat count of the repeater The repeater is then replaced with as many instances of the repeater body as defined by the repeat count all linked together into one long value During each such instance of the repeater body each multi value placeholder that occurs in the body will display only one value from its multi value list which is the value that matches the current repeat instance That is in the first body instance all multi value placeholders will display only their first values In the second instance each will display only its second value if any and so on If a separator is defined then between two instances of the repeater body one instance LISTSERV Maestro version 3 1 Interface Customization Manual 67 Section 5 Creating Customized Message Templates 9 of the separator text is inserted The separator appears only between two instances it does not appear before the first instance or after the last one Note When using a multi placeholder repeater in a HTML context then linebreaks usually do not matter so you can use them to format the repeater in a way that works best for you However when using a repeater in a plain text context then any linebreaks th
75. el Small Horizontal Oblong 20x10 Pixel Medium Horizontal Oblong 100x50 Pixel Large Horizontal Oblong 500x250 Pixel Note The sizes of the dummy images will only be observed if the img tag itself does not have any width or height attributes If these attributes are present then they override the sizes of the selected dummy image and the image will be stretched or shrunk accordingly Disable Placeholder Highlighting in HTML Only available for Plain Text or HTML placeholders for binary placeholders highlighting is always disabled In some situations where the template is being displayed to the user LISTSERV Maestro attempts to highlight the currently selected placeholder with a high contrast background color making it easier for the user to see which placeholder is selected This highlighting is achieved by embedding additional HTML code into the previewed template embedded during the preview only In some situations this additionally embedded HTML code disrupts the actual HTML code of the template that surrounds the placeholder which causes the template to appear broken In these cases it is best to disable the highlighting of the placeholder This can be done with this option Or more precisely if this option is checked then any LISTSERV Maestro version 3 1 Interface Customization Manual 60 Section 5 Creating Customized Message Templates appearances of the placeholder in the HTML part of t
76. emoved However the user should avoid complicated HTML code in such placeholders as the rules by which the HTML code is converted into plain text are rather simple 1 Any HTML entities for example like amp amp or amp quot will be resolved into the correct replacement character 2 Any paragraph and linebreak tags lt p gt lt br gt and similar will be converted to normal linebreaks 3 Any occurences of ordered or unordered lists with list entries lt ol gt lt ul gt and lt li gt will be converted into simple ordered unordered lists 4 All other HTML tags will simply be removed LISTSERV Maestro version 3 1 Interface Customization Manual SU Section 5 Creating Customized Message Templates Binary linked or inline This is a special placeholder that allows the template manager to define a binary usually an image in the HTML template of which the actual content is not yet known but will be supplied later by the user who employs the template during content definition When doing so the user who defines the content may decide if the binary data the image file is supposed to be linked remotely from a URL at a web server or if the binary data shall be bundled into the mail as an inline attachment Binary placeholders can be used for images JPEG GIF and PNG or background sounds MIDI During content definition the placeholder will be replaced with a URL to the image either a linked or inline U
77. emplate settings 52 disabling 69 downloading 69 enabling 69 managing 69 placeholders 55 Index in multiple values prefix suffix 64 Title in prefix suffix 62 creating 55 editing 56 inserting 55 multi placeholder repeater 65 multiple values in prefix suffix 62 prefix and suffix rules 61 system copying 47 defined 69 user defined copying 50 defined 69 using drop in content 54 O UU Oz Resource Translation Tool choosing a language for the HUB 46 Interface Customization Manual Index choosing a language for the User Interface 46 choosing for the Subscriber Interface 46 date and time formats 40 finding a node in the Recourse Tree 34 HTML code 35 importing a translated language 45 installing a translated language 44 introduction 31 key value entries 34 navigating the Resource Tree 33 navigating with keyboard shortcuts 33 requirements 31 translating 32 using a translated language 45 word replacement 38 S T Template Placeholders 55 Index in multiple values prefix suffix 64 Title in prefix suffix 62 creating 55 editing 56 inserting 55 multi placeholder repeater 65 multiple values in prefix suffix 62 prefix and suffix rules 61 Translating all text to a different langauge for all datasets 2 languages supported 79 requirements 31 starting 32 the language 31 who needs to be involved 3 N xz c LISTSERV Maestro version 3 1 Interface Customization Manual E
78. en can be accessed by clicking on the name of one of the layout elements on the Membership Area Layout Tab For information on this tab see Section 2 2 Using the Membership Area Layout Tab In the upper right corner of the Customize Page Layout screen the Currently Customizing drop down menu allows you to easily switch from customizing a dataset to customizing a list To customize the membership area layout for the dataset click the drop down menu and select Membership Area Layout This layout is shown by default if this is your first time accessing this screen To customize the list s in the dataset click the drop down menu and select the list you want to customize i e if you have a list named XYZ then select Layout of List XYZ The Customize Page Layout screen is divided into two panes The left pane is where you select the page or template that you want to customize The default is the Membership Area Header Footer page To change simply click the Selected Page Template drop down menu and select a different page or template to work with From this menu you can also select to customize notifications messages or errors Once you make a selection the area below the drop down menu displays the following Ifyou selected a template page normal page or a notification email then a short description of the selected layout element is displayed If you selected a message text for a message group then a list of available messages
79. ence of a string that looks like a numbered or a named placeholder will be rejected upon validation as placeholder unknown in original text 4 2 5 Date and Time Formats Date formats the order in which day month and year appear when printed as a date differ from country to country While Americans usually write month day year the Swedes write year month day and Germans use day month year The user can specify which output and input formats for date and time is preferred under Preferences User Interface General If the user has not specified a preference then dates and times are printed and parsed using default settings These default settings can be influenced during translation so that the defaults match the target language you are translating to This means that users without individual preferences set will see dates and times formatted to match the target language Because of this there are specific date format keys that you need to take into special consideration Note The following information assumes that you are working on the User Interface Resources All nodes mentioned here are found in this Translation Kit component e Output Format for Date Whenever LISTSERV Maestro outputs dates i e the send date of a job you have two attributes of the output format that you can manipulate The name of the month Locate the date node Underneath this node edit the twelve keys called date month 1
80. ent category tableRightLine Used in the membership area to render a vertical separator line between the left column that displays the sub categories of the current category this col umn only appears if there are sub categories and the part of the line that shows all mailing lists in the current category Table A 2 HTML Tags HTML Tag Description lt body gt Indicates the main body of the HTML page Styles defined for this tag e g the font background etc define the default styles for the entire page The other HTML tags inherit this style and can overwrite them when necessary lt p gt The standard text paragraph tag Used for all text that does not fall into a special class lt h1 gt The level 1 header tag Used for the header of each page lt h2 gt The level 2 header tag Used for sub level headers to separate different sections on the same page lt a gt The link tag Used for all clickable links lt td gt The table cell tag Used for all table cells lt th gt The table header cell tab Used for the header of the table that contains the mailing lists in the current category when viewed in the membership area lt input gt The input tag Used for single line edit fields checkboxes and buttons LISTSERV Maestro version 3 1 Interface Customization Manual PM i e Appendix A Custom Styles and HTML Tags HTML Tag Description lt select gt The select tag Used for single selec
81. ent version and if the work folder of the previous installation is still present then this requirement is met automatically Click the Import button to view a list of all the available previous versions for the currently selected Translation Kit component If for example the French translation of the subscriber pages of LISTSERV Maestro is selected and the Tool work folder contains a subfolder called translationsV2 1 1 which in turn contains a jar file called luiSubscriberResources fr jar then the version 2 1 1 is listed Select the desired version and click OK The import transfers the translations for all unchanged properties to the current version An unchanged property means that the given property existed in the previous version and that its original text has not been changed by L Soft during the transition from the imported version to the current version The import uses this criterion to decide if the translation for a property that was present in the previous version can safely be imported to the current version If in contrast L Soft did change the original text for a property or added a property then an existing translation for the property is not imported to the current version Instead the import marks the property node in the resources tree with a yellow asterisk When such a node is selected the right pane shows four texts instead of the usual two The upper two are the imported versions of the original text and if present t
82. ere lt td gt lt tr gt lt tr gt lt td id ValueCell 5 gt Fifth cell value here lt td gt lt tr gt lt table gt lt multi placeholder that generates a unique link anchor per multi value gt lt a name Paragraph 1 gt lt p gt First paragraph value here lt p gt lt a gt lt a name Paragraph 2 gt lt p gt Second paragraph value here lt p gt lt a gt lt a name Paragraph 3 gt lt p gt Third paragraph value here lt p gt lt a gt lt multi placeholder that generates a unique link to the above anchor per multi value gt lt a href Paragraph 1 gt Click here to go to the first paragraph lt a gt lt br gt lt a href Paragraph 2 gt Click here to go to the second paragraph lt a gt lt br gt lt a href Paragraph 3 gt Click here to go to the third paragraph lt a gt lt br gt Note Observe how each table cell has a unique ID and each paragraph a unique anchor name and how the links at the bottom point to one of these unique anchors Of course if two placeholders are used in this way one to generate link anchors and one to generate the matching links to those anchors then this will only work if the user who uses the template during content definition makes sure that both placeholders have the same number of values and that the ordering of the values in both placeholders matches otherwise the links will point to the wrong anchors or there will be links with
83. ers If you have submitted this request please confirm it by clicking on the link The placeholders below can be used anywhere in below z the notification mail body 4 bscriberAdd 3 3 EB The system will add linebreaks to the notification mail body if a IR RU DE Maximum Line Length 2 line of the message exceeds this length datasetName Gl confini ink Language Charset West European Latin 1 charset ISO 8859 1 O subscriberPassword 2 6 Editing Informational and Error Messages To edit a message text or an input validation error select the message group or error group you want to edit and then select the specific message error from the list of available elements in the left pane of the Customize Page Layout screen Once you ve selected the message error then click the Edit Source icon on the Draft Version tab Finally enter edit the information in the following fields if applicable Title This field is only available for informational messages Enter the text that is to be used as the title of the message HTML tags can be used to format it see Appendix A Custom Styles and HTML Tags Below this field there is a list of all placeholders that may be included in the title These placeholders will be replaced with suitable values Enter the placeholder manually into the field or click on it to automatically add the placeholder at the current cursor position e Text This field is available for informational
84. ersion and will reset it to its default The production version remains unchanged LISTSERV Maestro version 3 1 Interface Customization Manual 16 Section 2 Customizing the Subscriber Interface To submit the changes click OK To cancel editing without submitting any changes click Cancel Figure 2 8 Editing the Source Code of a Notification Email Customize Page Layout Currently Customizing Membership Area Layout Selected Page Template Draft Version Production Version Membership Area Join Confirmation Mail E9 O e This mail is sent to the e mail address of a user who has joined the membership area system defined password as a new member It asks for double confirmation of the join request and A contains the subscriber address the name of the Subject Confirmation to Join Membership Area maestro datasetName membership area the system defined password 3 and a URL that the user must click on to finally confirm the join request Sender Name j optional Dear Subscriber e Note This e mail has been automatically generated Do not reply Subject Placeholder We have received a request for the e mail The placeholder below can be used in the address maestro subscriberAddress to join maestro datasetName notification mail subject datasetName The login password for this address has been set to maestro subscriberPassword Mail Body Placehold
85. es related to list HLL select a layout element from the lists below To customize pages related to the dataset or another list select the corresponding item in the overview to the left Matching Templates External Unsubscribe Page External List Unsubscribe Template External Subscribe Step 1 List Subscribe Step 1 Template External Subscribe Step 2 List Subscribe Step 2 Template Internal Subscribe Edit Profile List Edit Profile Template Unused Pages Unused Templates External Subscribe List Subscribe Template Defaults Profile Placeholder Default Attrib The templates are defined on dataset level Profile Placeholder Default Attributes and apply to all lists in the dataset which do not individually override template usage El This icon is displayed next to elements with a customized draft version This icon is displayed next to elements with a customized production version To start customizing a layout element simply click on it The Customize Page Layout Screen opens and is divided into two panes The left pane contains information on the selected page The right pane contains two tabs Draft Version and Production Version For more information on this screen see Section 2 3 Using the Customization Page Layout Screen To customize an advanced element such as user messages or input validation errors click on the Advanced Customization link at the bottom of the tab The Membership Area Layout tab
86. eturn to the preview of the template click the Back to Template link To edit the template click the Edit Source icon on the Draft Version tab of the Customize Page Layout screen Then enter edit the HTML source code This HTML code also includes the placeholders as specified in the left pane see Section 2 7 Placeholders When editing the Header Footer Template Cascading Style Sheets CSS should be used to customize the style of the page The HTML code for the default pages pages that 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 For a list of these custom styles and HTML tags see Appendix A Custom Styles and HTML Tags 2 4 2 The Membership Area Page The Membership Area Page is the home page of the dataset and is the first page that the subscriber sees after logging in This page is divided into two sections My List and My Profile and contains links that let the subscriber navigate between these two sections LISTSERV Maestro version 3 1 Interface Customization Manual 13 Section 2 Customizing the Subscriber Interface Figure 2 6 Editing the Membership Area Page Customize Page Layout Currently Customizing Membership Area Layout v Selected Page Template Draft Version Membership Area State Production Version MeimberstapiAresi Page x Header and Footer Inherited The membership area page is the home page of the d
87. face If you selected a subscriber notification email then the preview displays the email in text format and also displays the other email attributes like the From address Subject line and language charset that will be used It also displays the currently used maximum line length i e the line length used to wrap the text with If you selected a message page text then the preview of the message page texts is shown by displaying the actual message page which by itself is one of the normal pages see above as a HTML page as it would appear in the browser of the subscriber with the currently selected message in place e Ifyou selected an input validation error then the error is shown by displaying a default page with the selected error message displayed on this default page Various action icons may be displayed letting you execute certain actions on the current draft version of the selected layout element Not all actions are always available Edit Source Click to edit the current draft version For information on editing a specific layout element see the following sections Section 2 4 Editing Templates and Pages Section 2 5 Editing Subscriber Notification Emails and Section 2 6 Editing Informational and Error Messages E View Source Click to view the source of the current production version Deploy as Production Version Click to deploy the current draft version as the new production version This will make a cop
88. folder which means you only have to copy the JAR file once If you have translated the Administration Hub component of the Translation Kit then you only have to copy the JAR file into the lib folder on the server where the Administration Hub is installed Do not copy the file to the LISTSERV Maestro User Interface server if different If you installed a translation of the HUB or LUI then you must restart LISTSERV Maestro on all of the servers where you put the JAR files LISTSERV Maestro version 3 1 Interface Customization Manual 44 Section 4 Using the Resource Translation Tool If you installed a translation of the Subscriber Interface then a restart is not required Instead new versions of the JAR files can be reloaded from the Administration HUB Go to Global Component Settings gt Maestro User Interface gt General Administration The General Administration of Maestro User Interface screen opens In the Subscriber Access Page Translations section click the Refresh Translations Now button 4 4 Importing a Translated Language from a Previous Version If the Translation Kit and the output folder for a previous version of LISTSERV Maestro are present in the work folder and if the corresponding resources JAR file for the selected target language is present for the previous version then the Import button is enabled Note If you upgraded an existing installation of a previous version of the Translation Tool to the curr
89. g list in the overview to the left Templates List Subscribe Template Login Page List Subscribe Step 1 Template Join Page Step 1 List Subscribe Step 2 Template Join Page Step 2 External List Subscribe Template Membership Area Page List Edit Profile Template Edit General Profile Page External List Unsubscribe Template Change Password Page Membership Area Header Footer Request Password Page p pi pr Q s q Subscriber Notification Mails uick Unsubscribe Page Subscription Password Mail Unsubscribe Confirmation Page Membership Area Join Confirmation Message Page Mail Unused Pages List Subscription Confirmation Mail Join Page Address Change Confirmation Mail i LISTSERV Password Page E This icon is displayed next to elements with Defaults a customized draft version Profile Placeholder Default Attributes This icon is displayed next to elements with a customized production version Advanced Customization Message Pages and Input Validation Errors LISTSERV Maestro version 3 1 Interface Customization Manual Section 2 Customizing the Subscriber Interface Figure 2 3 The Membership Area Layout Tab for a List Recipient Dataset Details o Sample dataset 3 Sample Category GEN HRL List Details Settings Overview Subscriber Statistics Membership Area Layout Subscriber Pages And Templates To customize the layout of the pag
90. he imported version of the translation Next follow the usual two texts i e the current version s original text and the editable text field for the current version s translation Looking at the upper three texts should assist you in deciding if the imported translation can be used as a translation for the current version and if you want to supply a translation for a key that did not require a translation The yellow asterisks remain in place during your current edit session If you exit the tool and re open it the asterisks disappear By importing the translations from the same version again the yellow asterisks are once again created This and all subsequent imports will not overwrite the changes that you have made in your current edit session 4 5 Using a Translated Language All languages that are installed are cumulative they will all be available at the same time in parallel This means that on any LISTSERV Maestro installation the default language English will always be available and in addition all other languages that were translated and installed as described above will also be available LISTSERV Maestro version 3 1 Interface Customization Manual 45 Section 4 Using the Resource Translation Tool 4 5 1 Choosing a Language for the Administration Hub and User Interface LISTSERV Maestro will automatically determine the correct language for any user accessing the User Interface with a web browser The web browser sends
91. he prefix and or suffix will appear once before after each of the multiple values before they are concatenated to build the combined replacement value From the values in preview drop down menu select how many dummy values shall be displayed for this placeholder during preview when no values LISTSERV Maestro version 3 1 Interface Customization Manual 58 Section 5 Creating Customized Message Templates have been supplied yet Only the two plain text placeholder types see also above are allowed to be used in a plain text template or in the alternative text of a HTML template HTML multiple values Same as the HTML type above but the user who employs the template during content definition has the option of supplying multiple values for the placeholder The placeholder will be replaced with the combined multiple values linked to each other This is useful when using the multi placeholder repeater and or the special placeholder prefix and suffix because the prefix and or suffix will appear once before after each of the multiple values before they are concatenated to build the combined replacement value From the values in preview drop down menu select how many dummy values shall be displayed for this placeholder during preview when no values have been supplied yet This placeholder type can only be used in the HTML part of an HTML template Binary linked or inline multiple values Binary linked multiple values
92. he template will no longer be highlighted Appearances in the plain text part if any will always be highlighted 5 10 3 Special Prefix and Suffix Rules for Template Placeholders When using optional placeholders in a template it is sometimes desirable that some content defined in the template will only appear if the placeholder is actually filled out and will not appear if the placeholder is left empty For example consider an HTML template that is supposed to render a bulleted list with up to five bullets where each list item except for the first is optional i e the user who employs the template during content definition can decide how many bullets there are simply by filling out some and leaving empty the rest like this lt ul gt li5 Placeholder 1 1i gt Placeholder 2 1i gt Placeholder 4 lt lt lt 1li gt Placeholder 3 lt lt 1i gt Placeholder 5 lt ul gt This would actually not work because if some placeholders are left empty then their bullets rendered by the lt li gt tag would still be visible like this three placeholders filled out two left empty e Content of first placeholder Content of second placeholder e Content of third placeholder It would be better if the preceding li tag would simply not appear at all leaving the placeholder empty To facilitate this template placeholders in LISTSERV Maestro use a special syntax that allows you to defin
93. holder is replaced with the email address of a subscriber navigating the subscriber pages The placeholder attributes are written as a sequence of key value pairs and are only needed for advanced placeholders such as maestro passwordLink text Click here which is replaced with a link to the Request Password screen that is rendered with the text Click here 4 2 4 4 Placeholder Validation Each text that you supply as a translated version for a resource key is checked to ensure it contains exactly the placeholders numbered or named that are present in the original text For example let s look at the original text for the hosted subs login title login key in the Subscriber Interface component of the translation kit Login for maestro datasetName LISTSERV Maestro version 3 1 Interface Customization Manual 39 Section 4 Using the Resource Translation Tool The supplied translated text for this key is validated to contain the maestro datasetName text Any other string in the form of maestro myPlaceholder or number for any number will be rejected as placeholder unknown in original text Similarly consider the original text for the newJobs authorizeSending label clickOnNumberOfLinks key in the LISTSERV Maestro User Interface component of the Translation Kit Click on at least one of 0j links This original text defines that the placeholder 0j is known and supported any other occurr
94. hows how many list pages are currently using the corresponding template i e pages that only define the layout of the actual list profile fields locally but also inherit the rest of the page layout from this template LISTSERV Maestro version 3 1 Interface Customization Manual 11 Section 2 Customizing the Subscriber Interface Any of the Normal Pages The comment displays if the page inherits the header footer template see above or if the header footer is defined locally on the page Any of the Message Page Texts The comment describes the currently selected message and the circumstances under which it is displayed to the subscriber Any of the Input Validation Errors The comment describes the currently selected error message and the circumstances under which it may occur Also unless the current message is already the error header footer of the error group then it provides a link to select the error header footer for the current error group By editing the error header footer you can provide all errors in one error group with the same opening and closing texts Additional controls may also appear allowing you to simulate certain system states so you can verify their impact on the actual preview These controls vary depending on the layout element selected and only a few elements offer them For information on these controls please see the online help 2 4 Editing Templates and Pages Ti Templates contai
95. ide for the Customization Wizard 81 ICONS eet ka ahem aia NANANG oR eke ba A aed o Pda Rl KNA BN Aa tan dna tae Nua aad dea san 81 SYMDONS dares eder a BINTANA GLEN DAA KANA ed ad kA KN KALAW new A 82 LINKS gsc EDT 83 enum ect rc 83 Drop Down Menls seac varea ea sai sa aa a eae UAR RARUS ee a Rd UR ee 84 LL EC PRIM Dur 85 LISTSERV Maestro version 3 1 Interface Customization Manual List of Figures General Overview of the Membership Area Layout Tab 0 00000 e eee 5 The Membership Area Layout Tab fora Dataset 00 cee eee 7 The Membership Area Layout Tab for a List 02 cee eee eee 8 Customizing the Membership Area Layout 2 eee eee 10 Editing the Source Code of a Template 000 00 eee ees 13 Editing the Membership Area Page sssleeee een 14 The Membership Area State Tab llle 15 Editing the Source Code of a Notification Email anaana 17 Editing the Source Code of an Error Message ee 18 Defining the Attributes for a Profile Field llle 28 The Edit Default Attributes Screen 28 Resource Translation Tool Startup 0 0000 cee eee 32 Translation Tool Main Window llle 32 Searching for Text in the Resource Tree lille 34 New Message Template Options 2 0 00 cece eee 47 The Create User Defined Template Based on System Template
96. ince we are aware of this we write the original value with placeholders 0 recipients have opened mail 1 This means that 0 will be replaced with the number of recipients and 1 will be replaced with the ID of the mail Therefore in the other language version we would have to make sure to use the correct placeholders in the right positions The mail 1 was opened by 0 recipients which effectively reverses the order of the two placeholders when read from left to right If we did not reverse the order and use a text like The mail 0 was opened by 1 recipients then after replacement we would get a nonsense sentence like The mail 250 was opened by XYZ recipients Because of this whenever there are more than one replacement placeholders in the same text you need to take extra care and understand the meaning of each placeholder what will it be replaced with so that you can use each placeholder at the correct position in your translated text even if that should change the order of the placeholders 4 2 4 3 Named Placeholders on the Subscriber Pages The placeholders on the subscriber pages of the Subscriber Interface may require advanced attributes and are therefore written as follows maestro placeholder name placeholder attributes The placeholder name conveys the semantics of the placeholder in a self explanatory way for example the maestro subscriberAddress place
97. into the topic of membership area customization is displayed Note If the subscriber pages are not customized then LISTSERV Maestro will use the default setting for the visual layout and text Figure 2 1 General Overview of the Membership Area Layout Tab Recipient Dataset Details f J Sample dataset Dataset Info 425 Sample Category pd HLL Settings Overview Membership Statistics Membership Area Layout EL Membership Area Layout Customization All subscriber pages for the membership area Sample dataset are currently not customized and use the LISTSERV Maestro default settings for the visual layout and the texts To better integrate the membership area subscriber pages with your own web site you should consider customizing the layout A good first step for customization is to supply a customized membership area header footer which acts as a shared visual frame for all subscriber pages Supply a custom membership area header footer Alternatively you can start the customization with any of the other available pages of the dataset Select a page LISTSERV Maestro version 3 1 Interface Customization Manual Section 2 Customizing the Subscriber Interface o To start customization click on either the name of the dataset or the name of the list you want to customize and then click one of these links Supply a custom membership area header footer This link lets you access the Cust
98. is section lists all of the custom styles and HTML tags used by LISTSERV Maestro Table A 1 Custom Styles Custom Style Description small Used to render text smaller than the normal text for example comments and list descriptions emphasis Used to render phrases or individual words in an emphasized style mandatoryFieldMarker error Used to render the asterisk marker for mandatory profile fields Used to render error messages emphasisBackground Used to render table cells or entire tables in an emphasized style by giving them a background that stands out from the normal page background disabledEditField tableframe Used to render edit fields and selection fields in a grayed state to make their disabled nature more apparent Used to render a frame around box like tables that group together certain related input fields or text Also used to render the membership area pages to appear with two tabs My Lists and My Profile This frame surrounds the two tabs at the top subscribeStepActiveTitle Used to render the title of the currently active sub scription step stand out from the other inactive step Used on the page where a subscriber can join the membership area or subscribe to a list without first logging in subscribeStepInactiveTitle Corresponds to the subscribeStepActiveTitle custom style Used to render the title of the currently inactive subscription
99. k up leading to mail delivery failure 5 10 1 Creating and Inserting Placeholders There are several ways to create a new placeholder Click the Add Placeholder button on the Template Settings tab For more information see Section 5 8 Defining the Template Settings Click the Copy link associated with a placeholder on the Template Settings tab For more information see Section 5 8 Defining the Template Settings Click the Click here to insert a placeholder link at the top of the Text tab This will open the Insert Placeholder screen which allows you to create a new placeholder by selecting the New option in the left list and filling out the placeholder attributes in the right part The NAME tag of the new placeholder will be automatically inserted at the current cursor position in the current text input box Press CTRL Space while typing in the text box on the Text tab This will also open the Insert Placeholder screen e Ifyou simply want to insert an already existing placeholder somewhere in the current text box you can either simply type its NAME tag or you can open the Insert Placeholder screen by clicking the Click here to insert a placeholder link or pressing CTRL Space LISTSERV Maestro version 3 1 Interface Customization Manual 55 Section 5 Creating Customized Message Templates Figure 5 9 Inserting a Placeholder Insert Placeholder To use a previously defined placeholder select one from
100. kes it easier to focus on your subscriber s touch points and convey your organization s message This same customization can be applied to all of the pages related to a single dataset or to each individual page For example text for some lists can be in English while text for others can be in French or the entire look and feel of the signup page for an individual list can be different from all other lists in the dataset T he Customization Wizard for the Subscriber Interface makes it possible for the Each template in the Customization Wizard maintains two versions a draft version and a production version This allows you to test the draft version of the template using varying conditions before releasing it into production Also each screen of the Customization Wizard contains its own context sensitive help These instructions guide you through the Customization Wizard describing each template or page listing the placeholders used and showing you how each template or page relates to the others 2 1 Accessing the Customization Wizard To access the Customization Wizard click on Recipient Warehouse gt Datasets from the Toolbar The Recipient Dataset screen opens Click on the name of the dataset that you want to customize The Recipient Dataset Details screen opens The right pane contains two tabs click on the Membership Area Layout tab If you have not customized your subscriber pages then a general overview and introduction
101. lect Page This menu is shown if you are customizing a list Click the drop down menu and select the layout element you want to customize Select Page Template This menu is shown if you are customizing a dataset Click the drop down menu and select the layout element you want to customize LISTSERV Maestro version 3 1 Interface Customization Manual 84 Index A B Branding adding custom text strings 29 introduction 29 C Custom Style 71 Customization Wizard using 5 Customizing specific text for a specific dataset 2 specific text for all datasets 1 the layout of a page for a specific dataset 2 the page frame and or style 1 the Subscriber Interface 5 using the Customization Wizard 5 who needs to be involved 3 D Default Style Sheet 75 E F G H HTML Tags 71 l Importing a translated language 45 Installing a translated language 44 J K L Language choosing for the HUB 46 choosing for the Subscriber Interface 46 choosing for the User Interface 46 importing 45 installing a translated language 44 translating 31 types supported for translation 79 using a translated language 45 LISTSERV Maestro version 3 1 85 LISTSERV Maestro what s new ix Message Templates creating a copy of a system template 47 a copy of an existing user defined template 50 based on an existing job 49 by uploading pre defined text 50 HTML 49 plain text 49 customizing 47 defining the content 51 defining the t
102. length of this bulleted list would depend only on how many values the user supplies when using the template during a content definition 5 10 6 INDEX in a Multiple Values Placeholder Prefix Suffix Another useful feature for multiple values placeholders is the INDEX attribute that can be used in the prefix and or suffix Any appearance of this attribute will be replaced with the index number of the multi value For example assume the following template definition where MultiPlaceholder is of the HTML multiple values type MultiPlaceholder lt p gt INDEX Paragraph VALUE lt p gt Now assume that the user fills out this placeholder with four values Then the resulting HTML code would look something like this linebreaks added for readability lt p gt 1 Paragraph First value here lt p gt lt p gt 2 Paragraph Second value here lt p gt lt p gt 3 Paragraph Third value here lt p gt lt p gt 4 Paragraph Fourth value here lt p gt The above is an example of how the INDEX attribute can be used to generate a numbered list where a normal ordered list using the lt li gt tag would not be appropriate or in a plain text where this tag can of course not be used Another useful case where the INDEX attribute can be employed is to generate a unique HTML ID or unique links and unique link anchor names lt Example with multi placeholder that generates a unique HTM
103. licable in your template will be part of the suffix including all linebreaks even linebreaks that appear immediately after VALUE or before the closing tag See below for examples If the user does not supply placeholder content then the whole placeholder starting with the opening tag and ending with the closing tag will be replaced with an empty string i e the prefix and suffix will not appear in this case If the user supplies a non empty content then the whole placeholder again starting with the opening tag and ending with the closing tag will be replaced with the text that is built by linking the prefix content and suffix This means that in the prefix VALUE suffix string the VALUE part including the enclosing characters is replaced with the user content and the resulting string including prefix and suffix is used to replace the placeholder For examples of placeholders with a prefix and or suffix see the online help for the HTML Preview tab 5 10 4 TITLE in a Binary Placeholder Prefix Suffix If the placeholder is a placeholder of one of the Binary types then the special TITLE attribute may be used anywhere in the prefix and or suffix of that placeholder it may even appear several times If the TITLE attribute is used then when the placeholder is filled out during content definition the user will have the option of not only providing the binary source for the placeholder but also a titl
104. lined in the example above can be any further HTML code and may also contain linebreaks i e stretch over several lines or paragraphs Also the placeholder tags of the placeholder s children must appear within this body For example if you have 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 With Attributes Some placeholders may additionally contain attributes using the following syntax 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 A placeholder may also contain several attributes like this maestro NAME ATTR1 VALUE1L ATTR2 VALUE2 ATTR3 VALUE3 If an attribute is not specified a suitable default will be assumed LISTSERV Maestro version 3 1 Interface Customization Manual 20 Section 2 Customizing the Subscriber Interface Placeholders that use attributes are Text Number Email or Password Profile Field Placeholders Boolean Profile Field Placeholders Single Select P
105. list type if the placeholder is defined in a context where the enabled disabled state of the field is the same under all circumstances then styleclass No Defines the name of the CSS style class es assigned to the selection list Default no style class For the list type if the placeholder is defined in a context where the enabled disabled state of the field differs according to the circumstances then enabledclass No Defines the name of the CSS style class es 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 es assigned to the selection list if the field appears in a disabled context Default no style class For the checkboxgrid type LISTSERV Maestro version 3 1 Interface Customization Manual 24 Section 2 Customizing the Subscriber Interface Attribute Name Mandatory Attribute Description order No Defines if the order of the checkboxes in the grid will be horizontal and vertical Default horizontal maxrows No Defines the maximum number of rows in the check box 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 but never use both at the same time Default If there are more than four choices 3 If less than four choices then the column row count is chosen to create a lay
106. lor for this highlighting click the Change link and select a color Make sure to use a color that has a good contrast in comparison to the foreground color used in the template Figure 5 6 General Settings on the Template Settings Tab General Settings Allow advanced editing of template source during mail job content definition Highlight placeholders with Yellow Change The Template Placeholders section contains a table of all placeholders that are currently defined in the template Figure 5 7 Template Placeholders Section on the Template Settings Tab Template Placeholders This list shows the currently defined placeholders Placeholder Display Title Value Type Mandatory ADDRESS PHYSICAL Physical address of your organization Plain Text Yes Edit Copy Delete ARTICLES Body text for articles Plain Text multiple values Yes Edit Copy Delete BYLINES Bylines for articles Plain Text multiple values No Edit Copy Delete HEADERS Headers for articles Plain Text multiple values Yes Edit Copy Delete IMAGE LOGO Logo in top left corner of header Binary linked or inline Yes Edit Copy Delete IMAGES Images to go with articles Binary linked or inline multiple values No Edit Copy Delete NEWSLETTER FOOTER Footer text for newsletter Plain Text Yes Edit Copy Delete NEWSLETTER HEADER Header text for newsletter Plain Text Yes Edit Copy Delete NEWSLETTER ISSUE Issue number for newsletter Plain Text Yes Edit Copy Delete URL READM
107. messages and input validation errors Enter the text that is to be used as the actual message HTML tags can be used to format it see Appendix A Custom Styles and HTML Tags Below this field there is a list of all placeholders that may be included in the message These placeholders will be replaced with suitable values Enter the placeholder manually into the message or click on it to automatically add the placeholder at the current cursor position Header or Footer These fields are only available for the header footer page of an input validation error 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 LISTSERV Maestro version 3 1 Interface Customization Manual 17 Section 2 Customizing the Subscriber Interface contains an opening lt ul gt tag and the footer contains the matching closing lt ul gt tag together they define an unnumbered list in HTML Consequently the default error messages all start with lt li gt to constitute a bullet in this list For a list of HTML tags see Appendix A Custom Styles and HTML Tags There are two icons available when editing a notification email Copy from Production Version Click to make a copy of the current production version and use it as the new draft version This will overwrite all current changes to th
108. n Emails or Section 2 6 Editing Informational and Error Messages LISTSERV Maestro version 3 1 Interface Customization Manual Section 1 Why Should Customize LISTSERV Maestro 6 Creating a customized message template Situation There are certain email jobs that you create on a weekly basis for your newsletter These email jobs can be very time consuming and you wish they could look better but you re not very good at HTML coding Or you know some HTML coding but you don t have the time to create what you really want Solution Using LISTSERV Maestro s template designer will let you easily create professional looking HTML messages with or without the HTML coding The template designer will save you time and will also give you the opportunity to save templates for future use For more information see Section 5 Creating Customized Message Templates 1 1 Who needs to be involved Customizing the Subscriber Pages The Maestro Administrator defines any Data Administrator account in the HUB by defining the The user may administer hosted Recipient Datasets user right setting The Data Administrator may perform membership area layout customizations or use the Team Collaboration feature to assign permission to another account in the same group to customize the subscriber pages Customizing the LUI and HUB pages headers and footers User Interface branding A System Administrator with administrative access to the
109. n menu or radiogrid a grid of radio buttons Default dropdown For the dropdown type if the placeholder is defined in a context where the enabled disabled state of the field is the same under all circumstances then styleclass No Defines the name of the CSS style class es assigned to the drop down menu Default no style class For the dropdown type if the placeholder is defined in a context where the enabled disabled state of the field differs according to the circumstances then enabledclass No Defines the name of the CSS style class es assigned to the drop down menu if the field appears in an enabled context Default no style class disabledclass No Defines the name of the CSS style class es assigned to the drop down menu if the field appears in a disabled context Default no style class For the radiogrid type LISTSERV Maestro version 3 1 Interface Customization Manual 22 Section 2 Customizing the Subscriber Interface Attribute Name Mandatory Attribute Description order No Defines if the order of the radio buttons in the grid will be 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 but never use both at the same time Default If there are more than four
110. n the default layout and design for the subscriber pages in the membership area Templates are used to give a uniform look to your subscriber pages and can help you customize many pages all at once By inheriting parts from the template repetitious work can be saved on individual pages and a change to the template will automatically apply to all pages that use the template Pages are specific subscriber pages for the dataset list They can be customized individually with no impact on others or they can be customized by inheriting parts from a template If you choose to edit the current draft version of a template or page by clicking the Edit Source icon then you will need to edit the HTML source code This HTML code also includes the placeholders as specified in the left pane see Section 2 7 Placeholders It also defines the general layout of the page as well as the design style see Appendix A Custom Styles and HTML Tags The HTML code is edited in the main edit field in the center Above the edit field a drop down list 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 list is not available for the Membership Area 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 chang
111. nistration Hub components permit limited To do this the administrator must create a text file called custom properties that must be located in the relevant application folder To customize the User Interface component maestro install folder lui To customize the Administration Hub component maestro install folder hub This file must be a text file that follows the rules of LISTSERV Maestro INI files see the LISTSERV Maestro Administrator s Manual for details This means that the file must consist of entries of the form key value with which the administrator can define customized text strings 3 1 Adding Custom Text Strings Each custom text string consists of a key value pair where the key is as listed below and the value is the text that is to appear in the User Interface and follows the INI file rules The following text string keys are currently available for customization app title companyName YOUR TEXT Sets YOUR TEXT to be used in the window title bar of each browser window that is used to access the Maestro User Interface or the Administration Hub component The text will appear as the first text in the title bar before the application name If this key is not included the text L Soft will be shown Supply an empty value to not show any text before the application name app msg headerText YOUR TEXT Adds YOUR TEXT as a header text at the top of the page The header text will be drawn so that it will appear on top of
112. older of this type Only the two plain text placeholder types can be used in a plain text template or in the alternative text of a HTML template HTML The placeholder s content will be interpreted depending on the context If the placeholder appears in the HTML part of a message then the HTML code appears unescaped and will thus be interpreted as normal HTML This allows the user who employs the template during content definition to include HTML formatting code in the placeholder value e g for attributes like underline bold color font etc but it also requires the user to remember to manually escape any HTML sensitive characters that are not be supposed to be interpreted as HTML code If such a placeholder is used in the plain text part of a message then the HTML code that the user enters will be converted automatically to plain text see below If the placeholder appears both in the HTML and the plain text part of a message then each of the above applies for each respective part i e in the HTML part the placeholder s value will be interpreted as HTML in the plain text part it will automatically be converted to plain text Therefore it is for example safe for the user to use simple formatting tags like lt b gt or lt u gt for bold or underlined style so that in the HTML part some special formatting will be applied even if the same placeholder appears in the plain text part because there these tags will automatically be r
113. olders in the text string then you must make sure to Include exactly the same number of placeholders in your translated version with exactly the same number indexes Determine the meaning of each placeholder what will it be replaced with so you can use the same placeholder with the same meaning even in your translated version Use the correct order of placeholders which may vary from the order in the original text see the next section 4 2 4 2 Placeholder Order Numbered placeholders can occur in the text in any sequence the first placeholder in a text when read from left to right does not necessarily have to be the one numbered 0 LISTSERV Maestro version 3 1 Interface Customization Manual 38 Section 4 Using the Resource Translation Tool In most cases this may very well be so but it is not a general rule that needs to be followed This 1 contains 0 two placeholders is just as valid as This 0 contains 1 two placeholders More important than the actual 0 1 2 order is that the semantically correct placeholder is used at each position Consider the following sentence 250 recipients have opened mail XYZ This sentence contains two variable values the number of recipients that have opened the mail 250 and the ID of the mail XYZ Now in another language the syntax may require this sentence to be written as The mail XYZ was opened by 250 recipients S
114. omize Page Layout screen For more information see Section 2 3 Using the Customization Page Layout Screen In addition this link takes you directly to the Membership Area Header Footer Template This template is by default shared by all pages in the membership area therefore any changes to it will automatically affect all pages Because of this the template is the ideal place to start the customization providing a common layout for all pages For more information on customizing this template see Section 2 4 1 The Membership Area Header Footer Template Select a page This link refreshes the Membership Area Layout tab displaying a list of layout elements available for customization For more information see Section 2 2 Using the Membership Area Layout Tab Important The introductory page is only shown if no customization has been previously performed If any of the layout elements for the membership area have been customized then the Membership Area Layout tab is shown with a list of customizable layout elements For a dataset the layout elements are divided into three tables Templates Pages and Subscriber Notification Mails For a list the layout elements are divided into two tables Pages and Matching Templates For more information see Section 2 2 Using the Membership Area Layout Tab 2 2 Using the Membership Area Layout Tab O pa Be im If no customization has been done previously then clicking on the Membership Area
115. only the ability to translate the text Translations contributed by other customers may be available on an as is unsupported basis LISTSERV Maestro version 3 1 Interface Customization Manual 80 Appendix D A Quick Reference Guide for the Customization Wizard Customization Wizard This guide is by no means a complete list of every icon symbol link comment or drop down menu that you will see Instead it references only those important functions that you will frequently use For a complete reference to the Customization Wizard see Section 2 Customizing the Subscriber Interface or the online help T his section is meant to be used as a quick reference guide while you are using the Icons Various action icons may be displayed while viewing the current draft version or production version of the selected layout element These icons allow you to perform certain actions on the layout element Not all actions are always available Copy from Production Version Click to make a copy of the current production version and use it as the new draft version This will overwrite all current changes to the draft version The production version remains unchanged Deploy as Production Version Click to deploy the current draft version as the new production version This will make a copy of the current draft version of the selected layout element and write it into the element s production version making this the version of the selecte
116. ou can provide all errors in one error group with the same opening and closing texts List Page Templates The first comment shows if the template page inherits the header footer template see above or if the header footer is defined locally on the list page template The second comment below the first one shows how many list pages are currently using the corresponding template i e pages that only define the layout of the actual list profile fields locally but also inherit the rest of the page layout from this template Message Page Texts The comment describes the currently selected message and the circumstances under which it is displayed to the subscriber Normal Pages The comment displays if the page inherits the header footer template see above or if the header footer is defined locally on the page LISTSERV Maestro version 3 1 Interface Customization Manual 283 Appendix D A Quick Reference Guide for the Customization Wiz Drop Down Menus Drop down menus are a common feature when customizing a template or page The menus available for customization will vary depending on the template or page you are customizing Some menus are universal and will help you pick the template or page you to customize Some of these menus are e Currently Customizing Click the drop down menu and select Membership Area Layout to customize the dataset or Layout of List to customize a specific list in the dataset Se
117. out anchors or anchors without links pointing to them Note Any appearance of the INDEX attribute in the prefix suffix of a normal non multiple value placeholder will not be replaced This attribute shows its special behavior only in the prefix suffix of a multiple value placeholder 5 10 7 Multi Placeholder Repeater As described above using a placeholder with multiple values usually together with the placeholder prefix suffix is very useful for creating a list of user supplied items where the number of items is not known in advance However this alone does not cover a situation like the following assume that the template is meant for a newsletter where each article in the newsletter is supposed to appear with a heading a sub heading and a body all with different styles Article Heading Article Sub Heading Article Body goes here where the matching HTML code looks like this LISTSERV Maestro version 3 1 Interface Customization Manual 65 Section 5 Creating Customized Message Templates lt div style font weight bold font style italic margin bottom 10px gt Article Heading lt div gt lt div style font size 8pt font style italic margin bottom 5px gt Article Sub Heading lt div gt lt div style font family serif gt Article Body goes here lt div gt Of course one solution would be to have a placeholder called article and make this placeholder a multi value placeholder so that the
118. out as compact as possible maxcols No Defines the maximum number of rows in the check box 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 but never use both at the same time Default If there are more than four choices 3 If less than four choices then the column row count is chosen to create a layout as compact as possible tablestyleclass No Defines the name of the CSS style class es assigned to the HTML table surrounding the check box grid Default no style class rowstyleclass No Defines the name of the CSS style class es assigned to each row in the HTML table surrounding the checkbox grid Note If you use rowstyleclass then you cannot use evenrowstyleclass or oddrowstyleclass Default no style class evenrowstyleclass No Defines the name of the CSS style class es assigned to every even row in the HTML table sur rounding the checkbox grid Note If you use evenrowstyleclass then you must also use oddrowstyleclass but you cannot use row styleclass Default no style class oddrowstyleclass No Defines the name of the CSS style class es assigned to every odd row in the HTML table surrounding the checkbox grid Note If you use oddrowstyleclass then you must also use evenrowstyleclass but you cannot use row styleclass Default no style class LISTSERV Maestro version 3 1 Interface
119. page is viewed by a confirmed existing member who has just subscribed to an additional list from outside of the Membership Area via the special external subscribe pages At the end of the external subscribe the member was automatically logged into the Membership Area and was directed to this page which is the first page the member sees after the system has accepted the external subscription Therefore this page takes over the job of informing the member of the success of their external subscribe and displays a message that they are now freshly subscribed to the given mailing list For a Confirmed Member with List Subscription Welcome Message LISTSERV not available Same as Confirmed Member with List Subscription Welcome Message see above however this state simulates that LISTSERV is not available LISTSERV itself or the network is down This situation may impact the presentation of Linked LISTSERV Lists therefore this simulated state is only available if there are any Linked LISTSERV Lists in the dataset LISTSERV Maestro version 3 1 Interface Customization Manual 14 Section 2 Customizing the Subscriber Interface For an Unconfirmed Member with Membership Unconfirmed Message The page is viewed by a member who has still not confirmed their membership via the confirm link in the double opt in confirmation mail In this case a message is displayed reminding the member of the still unconfirmed state of their membership
120. pending on the type of the placeholder Dummy Text For Plain Text and HTML placeholders there are several choices to roughly define which kind of dummy text shall be displayed The choices are LISTSERV Maestro version 3 1 Interface Customization Manual 59 Section 5 Creating Customized Message Templates Some Many Words Some Many Sentences Some Many Paragraphs Some Many Digits Some Many Letters Sample URL Notes The Dummy Text should be selected according to the expected kind of content that will be provided by the user for the given placeholder For example if the placeholder appears in a context where it will be filled out with a number like a ZIP code or phone number then Some Digits would be the closest match If the placeholder will be filled out with a lot of text then Many Paragraphs is probably better The Sample URL option is a special choice that will result in a replacement that looks like a dummy http URL This type is appropriate if the expected content will most likely be a URL for example in a context like Click this URL Placeholder to go to Dummy Images For placeholders of the binary types the following choices are available to display dummy images No Sample Image Small Square 20x20 Pixel Medium Square 100x100 Pixel Large Square 500x500 Pixel Small Vertical Oblong 10x20 Pixel Medium Vertical Oblong 50x100 Pixel Large Vertical Oblong 250x500 Pix
121. pply a value The user supplied value for the placeholder is Plain Text v In the preview show sample text as follows Some Words v The following attributes can be defined from this screen Name The name of the placeholder This is the name that you must use as a replacement for NAME in the NAME tag Only the following characters are allowed in a placeholder name a z A Z 0 9 and LISTSERV Maestro version 3 1 Interface Customization Manual 56 Section 5 Creating Customized Message Templates Display Title This is the title or name of the placeholder that will be displayed to users that employ the template during content definition Enter a title that makes it easy for the user to understand the purpose of the placeholder Mandatory Defines if the placeholder is mandatory or not For a mandatory placeholder the user must supply a non empty content For an optional placeholder the user may decide to leave the placeholder empty e Value Type Defines the placeholder s content type The following Single Value Placeholders are available Plain Text The placeholder s content will be interpreted literally as plain text If the placeholder is used in a HTML part then any special HTML code characters in the content will be escaped before replacement Therefore it will not be possible to include any HTML formatting like bold color font etc in a placeh
122. r uncheck it if you want to create the new template in the disabled state this allows you to edit it further before you enable it Note All these settings can later be changed again so if you are not sure about any setting just enter what fits best at the moment Click the Create Template button to create the new user defined template The new user defined template will be displayed in the User Defined Templates section of the Manage Content Templates screen LISTSERV Maestro version 3 1 Interface Customization Manual 48 Section 5 Creating Customized Message Templates 5 2 Creating a Plain Text Template To create a plain text template click on the Utility menu select New Content Template and then select Create Empty Template This opens the Edit Content Template screen with a new blank template This template can be used to create a plain text or HTML template To define a plain text template click on the Text icon and then select Plain Text Mail on the Message Content Type screen Next you ll want to define your content on the Edit Content Template screen For more information see Section 5 7 Defining the Template Content 5 3 Creating HTML Templates To create an HTML template click the Utility menu select New Content Templates and then select Create Empty Template The Edit Content Template screen opens Click on the HTML icon The Message Content Type screen opens Select the HTML Mail option and
123. re could be several articles That would mean each of the values would constitute one article However this would mean that the heading sub heading and body of each article would all have to be supplied in the article s value which would mean that the special styles for the heading and subheading would have to be supplied in the value by the user who uses the template to define the message content When this happens the definition of the heading sub heading and body styles would be out of the hands of the template manager and would become the responsibility of the user who uses the template to define the message content which is probably not what is desired The other solution one could think of would be to have three placeholders one called heading one called sub heading and one called body and all three would be defined as multiple values placeholders and each could contain the correct styles in the prefix suffix The user who uses the template to define the message content would simply have to supply the correct headings sub headings and bodies of all desired articles making sure to supply them in the correct order in all three placeholders and to supply an equal number of values for all The styles for each would then be supplied automatically by the prefix suffix mechanism But there would still be a problem because the correct way to put these three placeholders into the template code would be like this heading lt div
124. refreshes and contains two tables Message Page Texts and Input Validation Errors Click on a link to customize that particular layout element For information on editing messages and validation errors see Section 2 6 Editing Informational and Error Messages Note The Advanced Customization link is only available if you re customizing the subscriber pages for a dataset To customize how profile data fields are displayed on all pages click the Profile Placeholder Default Attributes link For more information see Section 2 8 Setting the Default Display for Data Fields If atleast the draft or production version of a layout element is customized or both then either an equals or a not equals sign is displayed between the two icons This lets you z know whether or not the current draft version is equal to the current production version If both versions are not customized then the equals sign is not displayed because the two versions are the same If you have at least one layout element in the dataset where the draft version is different than the current production version then the Deploy icon allows you to deploy all these draft versions at once either the ones in the dataset itself or all draft versions in the dataset and all its lists LISTSERV Maestro version 3 1 Interface Customization Manual Section 2 Customizing the Subscriber Interface When changes are made to the dataset or lists after customizations hav
125. riber Interface Notification Mails For a list the layout elements are divided into two tables Pages and Matching Templates Note The List Pages table contains the actual layout elements that can be customized for the selected list while the Matching Templates table contains the layout elements of the dataset that the list belongs to However since the list pages by default make use of these templates the templates have been included for convenience When you make changes to the list templates these changes apply to all lists in the datasets To make changes to individual list pages you must change the pages not the templates Each table lists the available elements and displays their current customization status The draft version of the layout element is not customized The draft version of the layout element is customized The production version of the layout element is not customized O The production version of the layout element is customized Figure 2 2 The Membership Area Layout Tab for a Dataset Recipient Dataset Details gt Sample dataset Dataset Info Sample Category z HLL Settings Overview Membership Statistics Membership Area Layout HRL Subscriber Pages And Templates To customize the layout of the dataset related subscriber pages for the membership area Sample dataset select a layout element from the lists below To customize list related pages select the correspondin
126. rofile Field Placeholders Multiple Select Profile Field Placeholders Subscription Status Profile Field Placeholders Subscription Type Profile Field Placeholders Button Profile Field Placeholders Clickable Link Profile Field Placeholders 2 7 1 Text Number Email or Password Profile Field Placeholders This table lists the attributes that may be used with text number email or password profile field placeholders Table 2 1 Text Number Email or Password Profile Filed Placeholder Attributes Attribute Name Mandatory Attribute Description size No Defines the size of the edit field Default 60 for text email password or 10 for number If the placeholder is defined in a context where the enabled disabled state of the field is the same under all circumstances then styleclass No Defines the name of the CSS style class es assigned to the edit field Default no style class If the placeholder is defined in a context where the enabled disabled state of the field differs according to the circumstances then enabledclass No Defines the name of the CSS style class es 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 es assigned to the edit field if the field appears in a disabled context Default no style class 2 7 2 Boolean Profile Field Placeholders This table lists
127. s they define the blanks that the user will have to fill out A template placeholder appears in the template body in the following form SNAME where and are the opening and closing tags and NAME is replaced with the name of the placeholder The character that prefixes the name must always appear for a template placeholder A placeholder with a given name can appear several times throughout the template body and may appear both in the HTML and the plain text part if the placeholder s type allows this The opening and closing tags for the placeholders can be freely defined and can be any characters you like that do not contain any spaces and are suggested as defaults but you may change them by clicking the Placeholders icon in the icon bar Note The opening and closing tags that are defined for the placeholders will also be used for drop ins if drop ins are enabled for the template It is important to choose opening and closing tags with care making sure that they do not otherwise appear in the template For example if you decide to use parentheses and for opening and closing tags any text that appears between any set of parentheses will be interpreted as the name of a template placeholder or drop in Since parentheses have a high probability for use in the normal text of a message using them as tags is not recommended because they may cause an error in placeholder or drop in name loo
128. s added individually to each of the supplied multiple values and only then are the multiple values linked together to build the final replacement value This means that if a prefix and or suffix is defined and the user later supplies several values for the placeholder then not only will the prefix appear before and the suffix after the supplied value but the prefix and or suffix also appears between the various multiple values This very useful if the template manager wants to define a list of items without already knowing how many items there are going to be Consider the bullet list example above As the example was defined the template manager had set up a bulleted list with up to five bullets Since the bullet definition itself the lt li gt tag was defined in the prefix any empty bullets were effectively avoided should the user decide not to provide values for some of the placeholders So far so good The only problem is that the maximum number of bullets was predefined as five by the template manager If the user later would want to add a sixth bullet then he would have to ask the template manager to change the template With a multiple values placeholder this problem is avoided In this case the definition of the bulleted list in the template would look something like this lt ul gt MultiPlaceholder lt li gt VALUE lt ul gt And the MultiPlaceholder placeholder would have to be defined as HTML multiple v
129. s and fill characters To define the parse version locate the date node and edit the key called date timeFormat custom forParsing this value is initially empty 4 3 Installing a Translated Language To install a translated language into an existing LISTSERV Maestro installation simply copy the JAR file that you have created during translation to the lib folder inside of your LISTSERV Maestro Installation folder It is recommended that you keep the copy of the JAR file in your work folder even if you have completed the translation If you are installing the JAR file for the selected component and target language for the first time you should not find a file with a conflicting name If you are updating an existing translation JAR file simply replace the existing file with your new version If you have translated only the Subscriber Interface component of the Translation Kit then you have to copy the JAR file into the lib folder on the server where the LISTSERV Maestro User Interface is installed If you have translated the LISTSERV Maestro User Interface component of the Translation Kit then the JAR file needs to be accessible to both the HUB and LUI Therefore if the HUB and LUI are on separate servers then you will need to copy the file into the lib folder on both the servers where the Administration Hub and the Maestro User Interface are installed If both components are on the same server then they will share the same lib
130. s value defines the default for users without an individual preference setting Separator character for hours and minutes Locate the date node Underneath this node edit the key called date timeSeparator Set the value to the character that is to be used to separate hours and minutes For example use if the desired output is something like 09 15 This value defines the default for users without an individual preference setting Report Download Format for Date and Time Whenever LISTSERV Maestro prepares report results for download in the form of a ZIP file it puts a readme txt text file into that ZIP file with some information about the downloaded report This information also contains date and time information You can modify the appearance of this date time format by editing the following four keys one for each report type Details Report Locate the reports reportDetails node Underneath this node edit the reports reportDetails msg downloadDateFormat key Distribution Report Locate the reports reportDistribution node Underneath this node edit the reports reportDistribution msg downloadDateFormat key Raw Events Report Locate the reports reportRaw node Underneath this node edit the reports reportRaw msg downloadDateFormat key Sum Report Locate the reports reportSum node Underneath this node edit the reports reportSum msg downloadDateFormat key Deliver
131. so that LISTSERV Maestro can understand them Therefore you should probably choose an order separators and fill characters that are most common in the locale matching your target language and should also provide a similar display version with the same separators and fill characters To define the parse version edit the key called date dateFormat custom forParsing this value is initially empty Time pattern To set the input time format locate the date node and edit the date timeFormat default key Set it to a value that is either the numerical pattern number of any of the predefined time patterns or set it to custom if you want to define a custom time pattern for input This value defines the default for users without an individual preference setting You can choose between two pre defined time patterns or provide your own customized pattern Each pattern exists as two versions the pattern used for parsing the user input and the pattern that is displayed to the user so that the user knows which format to use for the input Table 4 3 Predefined Time Patterns Pattern Number Display Version Parse Version 1 hh mm HH mm 2 hh mm HH mm The parse version of the predefined patterns cannot be changed However you may change the display version of the predefined patterns To change the display version locate the date node and edit the keys called date timeFormat N forDisplay
132. style font weight bold font style italic margin bottom 10px gt VALUE lt div gt sub heading lt div style font size 8pt font style italic margin bottom 5px gt VALUE lt div gt body lt div style font family serif gt VALUE lt div gt But the result after replacement assuming that three values were supplied for each of the three multi value placeholders would look like this First Heading Value Second Heading Value Third Heading Value First Sub Heading Value Second Sub Heading Value Third Sub Heading Value First Article Body Value LISTSERV Maestro version 3 1 Interface Customization Manual 66 Section 5 Creating Customized Message Templates Second Article Body Value Third Article Body Value because each of the three multiple values placeholders would simply iterate over all its values followed by the values of the next placeholder and so on which is not the desired result Instead what should happen is that the values of the three multiple values placeholders would be repeated in an alternating fashion The first heading followed by the first sub heading followed by the first body only then followed by the second heading followed by the second sub heading and so on LISTSERV Maestro does provide a mechanism for this special behavior of the multiple values placeholders in form of the multi placeholder repeater The syntax of the repeater looks similar to
133. t drop down lists and multi ple select boxes LISTSERV Maestro version 3 1 FEE Interface Customization Manual Appendix A Custom Styles and HTML Tags LISTSERV Maestro version 3 1 Interface Customization Manual ate Appendix B The Default Style Sheet his section displays the style sheet used by the default template Figure B 1 The Default Style Sheet body font family Verdana Arial Helvetica sans serif font size Opt font weight normal font style normal font variant normal text transform none text decoration none background color FFFFFF color 000000 pt font family Verdana Arial Helvetica sans serif font size 9pt color 000000 j hl font family Verdana Arial Helvetica sans serif font size 12pt font weight bold color CC0033 margin Opt Opt 5pt Opt h2 font family Verdana Arial Helvetica sans serif font size 10pt color 333399 margin Opt Opt 5pt Opt a text decoration underline color 333399 LISTSERV Maestro version 3 1 Interface Customization Manual 275 Appendix B The Default Style Sheet td font family Verdana Arial Helvetica sans serif font size Opt color 000000 th font family Verdana Arial Helvetica sans serif font size 9pt font weight bold color 000000 background color F1F4FA input font family
134. t version of the layout element is not customized The draft version of the layout element is customized The production version of the layout element is not customized The production version of the layout element is customized The draft version of the page is customized but the customized version is no longer compatible with the dataset Therefore before you can view or deploy the current customized draft version you will have to make it compatible with the dataset again The production version of the page is customized but the customized version is no longer compatible with the dataset Therefore the system has automatically modified the customized production version to make it compatible again and has saved a backup copy of the original customized production version The draft version is the same as the production version The draft version is not the same as the production version If neither version is customized then no comparison symbol is displayed because the two versions are using the default version The placeholder tree shows each placeholder by its name using the following symbols O O Free Placeholder Free placeholders may appear anywhere on the page even inside other placeholders They are always optional which means that you can include them but do not have to Optional Restricted Placeholders Restricted placeholders must adhere to their parent child structure This means that all top level restrict
135. table on the Membership Area Layout tab while customizing the subscriber pages of a dataset or list The Profile Placeholder Default Attributes information is displayed For more information on placeholders and their attributes see Section 2 7 Placeholders LISTSERV Maestro version 3 1 Interface Customization Manual 27 Section 2 Customizing the Subscriber Interface Figure 2 10 Defining the Attributes for a Profile Field Recipient Dataset Details OY Sample dataset 03 Sample Category 84 HLL Settings Overview Membership Statistics Membership Area Layout Z HRL Profile Placeholder Default Attributes Dataset Info To customize the default attributes of the profile field placeholders click on a field name from the list below Return to subscriber pages and templates customization Profile Field EMAIL lt no default attributes defined gt NAME lt no default attributes defined gt RECIP ID no default attributes defined gt Password lt no default attributes defined gt Default Attributes Click on the name of the field you want to customize The Edit Default Attributes screen opens specify the attributes in the same way as for specifying them in the placeholder when including the placeholder in the customized HTML code Figure 2 11 The Edit Default Attributes Screen Edit Default Attributes Please insert your default attributes for the placeholders of the text profile field EMAIL Leave
136. the attributes that may be used with Boolean profile field placeholder Table 2 2 Boolean Profile Field Placeholder Attributes Attribute Name Mandatory Attribute Description If the placeholder is defined in a context where the enabled disabled state of the field is the same under all circumstances then LISTSERV Maestro version 3 1 Interface Customization Manual 21 Section 2 Customizing the Subscriber Interface Attribute Name Mandatory Attribute Description styleclass No Defines the name of the CSS style class es assigned to the checkbox Default no style class If the placeholder is defined in a context where the enabled disabled state of the field differs according to the circumstances then enabledclass No Defines the name of the CSS style class es assigned to the checkbox if the field appears in a disabled con text Default no style class disabledclass No Defines the name of the CSS style class es assigned to the checkbox if the field appears in a disabled con text Default no style class 2 7 3 Single Select Profile Field Placeholders This table lists the attributes that may be used with single select profile field placeholders Table 2 3 Single Select Profile Field Placeholder Attributes Attribute Name Mandatory Attribute Description type No Defines how the single select field will be rendered Possible types are dropdown a drop dow
137. the blue header bar shown at the top of each page The blue header bar will be the background behind the text which is drawn with a white bold faced font about as large as the page headers that appear on each page right below the header bar If this key is not included no text will be shown app msg footerText YOUR TEXT Adds YOUR TEXT as a footer text at the bottom of the page The footer text will be drawn in the bottom left corner of each page where it will appear to the left of the Protected by F Secure message if available It will be drawn in the same small standard page font as the F Secure message If this key is not included no text will be shown app url companyURL YOUR URL Uses YOUR URL must be a valid http URL as the target link of the logo that appears at the top right of each page This logo is set to the LISTSERV Maestro logo with LISTSERV Maestro version 3 1 Interface Customization Manual 29 Section 3 User Interface Branding a target URL of http www 1soft com Customizing the logo s target URL is most effective when used together with exchanging the LISTSERV Maestro logo with a customized institutional or company logo see below If this key is not included the URL will point to http www lsoft com 3 2 Exchanging Logos 9 Important In previous versions of LISTSERV Maestro this feature was available for the User Interface and the Administration Hub Starting in LISTSER
138. the input field empty to use the system default attributes size 60 disabledclass disabledEditField For example assume there is a profile field called FNAME and that it should display with an edit field of size 40 Either include the placeholder maestro profileFNAME size 40 directly on the page or include the placeholder without attributes maestro profileFNAME on the page and define the default attribute size 40 on the Edit Default Attributes screen Note The default versions of all membership area pages the versions that are used if no customized versions are provided all use the profile field placeholders without any individual attributes therefore any pages that are displayed in their default state will also use the profile placeholder default attributes you define LISTSERV Maestro version 3 1 Interface Customization Manual 28 Section 3 User Interface Branding 9 User Interface branding by allowing the administrator the choice of using institutional or company logo images instead of the LISTSERV Maestro logos and by adding a few text strings at prominent locations such as the header and footer of each page Note The Subscriber Interface is fully customizable see Section 2 Customizing the Subscriber Interface for details To change the text used in the LUI and HUB interfaces see Section 4 Using the Resource Translation Tool T he Maestro User Interface and the Admi
139. the locale information of the user to LISTSERV Maestro and then LISTSERV Maestro presents the User Interface using the language matching this locale If no matching language is found then the default language English is used To choose a language you need to tell your web browser the language that you want to use In Internet Explorer 5 0 and later select Tools gt Internet Options On the General tab click the Languages button The Language Preference screen opens Edit the list of language preferences by adding removing languages and changing the order of the selected languages 4 5 2 Choosing the Language for the Subscriber Interface In contrast to the rest of the LISTSERV Maestro User Interface the Subscriber Interface of a given dataset ignores the locale information that is sent by the web browser and uses a fixed language that is determined differently To define the server wide default language for the Subscriber Interface use the following setting in the lui ini file DefaultCustomizationLanguage XX If not specified English will be used as the server wide default language For datasets owned by a group To define the default language for the Subscriber Interface of all datasets of a certain group use the following setting in the lui ini file DefaultCustomizationLanguage amp group amp GROUPNAME XX If not specified the server wide default language will be used For datasets owned by a non group single
140. the workstation of the person doing the translation Once the translation is ready to be deployed a system administrator must copy the translated JAR files to the folders in the appropriate directories on the LISTSERV Maestro server s Prior to beginning the translation 1 Download the latest version of the Resource Translation Tool from the L Soft web site and install iton your workstation or server Instructions for installing and starting the Translation Tool are found in the installation kit zip file As instructed you may need to install a Java Runtime Environment JRE or edit the command file to point to the JRE installed with LISTSERV Maestro for example set JAVA 1 5 HOME c program files l soft application server java 2 Download the Translation Kit for the currently installed build of LISTSERV Maestro from the L Soft web site and place it in the Translation Tool s work folder It is not necessary to unzip it If you are unsure which build you are running browse to this web page your LISTSERV Maestro domain lui build LISTSERV Maestro version 3 1 Interface Customization Manual 31 Section 4 Using the Resource Translation Tool 4 2 Translating To begin translating start the Translation Tool according to the instructions found in the zip file Upon startup the Translation Tool performs an integrity check of the Translation Kit files in the Translation Tool s work folder and shows a drop
141. then the folder is named translationsV2 1 1 and contains among others the luiSubscriberResources de jar file Note Each component also lists English as a target language This allows you to use the Translation Tool to customize text without actually performing a translation All descriptions in this document are applicable without changes to the target language English 4 2 1 Navigating the Resources Tree Translating or customizing text for LISTSERV Maestro requires editing text that is distributed over a considerable number of property keys in the Translation Kit Frequently the text is only short snippets which can be translated quickly each on its own 4 2 1 1 Navigating with Keyboard Shortcuts To select a property key for translation the Translation Tool supports standard mouse navigation However if a cluster of text needs to be edited navigation via keyboard shortcuts can greatly reduce the time required for the translation Assume that you are working on the translation for one of the property keys e g in the editor for the custom text of a property key Use the standard keyboard keys to navigate in the text that is displayed in the editor If you want to finish editing the text for the current property key and want to edit the text for the next property key press Ctrl Enter This keyboard shortcut locates the next property key node from the resources tree and automatically selects it for editing the editor is r
142. ting is done on the pages themselves into which the text values are inserted However some text resources do LISTSERV Maestro version 3 1 Interface Customization Manual 36 Section 4 Using the Resource Translation Tool contain actual HTML tags which contain formatting that can not be easily imposed from the outside For example if you have a sentence in which you want to emphasize a single word in the middle by rendering it in a bold font then you can not do so with an outside formatting directive Instead you have to include the corresponding bold tag right into the text of the sentence itself bracketing the word you want to emphasize If you find a HTML tag recognizable as being enclosed in lt and gt in a text then you should see to it that the same tag with the same semantics appears in your translated version of the text Most commonly used are span tags lt span gt A span tag actually consists of an opening part lt span gt and a closing part lt span gt These two tags bracket word s in the text to which a special formatting shall be applied The formatting is then included in the opening span tag in the form of a class attribute lt span class emphasis gt Example Do you lt span class emphasis gt really lt span gt want to delete this This defines a text with a question to the user where the word really is to be emphasized therefore it has been
143. to the English language text using the L Soft Resource Translation Tool It assumes a good acquaintance with computers and how to work with files in the file system T his section gives an overview of how to translate the text of the LISTSERV 4 1 Requirements To be able to translate the LISTSERV Maestro User Interface the following basic requirements must be met e You need to have an installation of the L Soft Resource Translation Tool e You need to have a Translation Kit that matches the LISTSERV Maestro version that you have installed You need a good understanding of editing HTML code plus the meaning of the various HTML tags and how to escape reserved HTML characters The Translation Kit for LISTSERV Maestro comes in the form of a ZIP file for each LISTSERV Maestro version For example the Maestro 2 1 1 TransKit zip is for LISTSERV Maestro version 2 1 1 Important You must not use a Translation Kit that is not meant for your LISTSERV Maestro version Once you have obtained the Translation Kit for the correct Maestro version put the ZIP file into the work subfolder of your Resource Translation Tool Installation folder The Translation Kit contains several components one for the Administration Hub one for the User Interface and one for the Subscriber Interface Each component supports a list of target languages The Translation Tool does not need to be installed on the same server as LISTSERV Maestro It may run on
144. ts that require a translation therefore if you leave a key value empty for a non English translation then the default English text for this key is shown together with the other translated values which results in a language mix up To help you distinguish between supplied and un supplied parts each supplied key is marked with a green checkmark This green checkmark is propagated to higher levels of the resource key tree display once all entries in the lower level are marked as supplied completely 4 2 3 HTML Code LISTSERV Maestro uses a web based User Interface that consists of HTML pages displayed in a web browser This means that the largest part of all language dependent text is displayed as part of a HTML page and must follow the rules imposed on HTML 4 2 3 1 HTML Escape Sequences In HTML some characters have special meanings For example the lt and gt characters are used to enclose special HTML tags that are used to format the HTML page This type of HTML tag may look like this lt body gt The appearance of a word enclosed in lt and gt signals to the browser that this word is not supposed to appear as a visible word instead itis a special HTML tag that conveys some special meaning to the browser e g how to render and format the following text If you actually want a lt or gt character to appear on the page then you need to escape this character in the form of a HTM
145. ute of the hour 00 59 Examples 28th of August 2002 5 minutes after 3 p m will be formatted as follows MM dd yyyy HH mm 08 28 2002 15 05 yyyy MM dd HH mm 2002 28 08 15 05 HH mm dd MM yyyy 5 05 28 08 2002 These settings are independent of any user preferences meaning that the user cannot influence the date and time formats of these downloaded reports Input Format for Date and Time Whenever the user needs to input a date and time value for LISTSERV Maestro to understand then the user must follow a certain pattern Date pattern To set the input date format locate the date node Underneath this node edit the date dateFormat default key Set it to a value that is either the numerical pattern number of any of the predefined date patterns e g 1 2 3 or 4 see below or set it to custom if you want to define a custom date pattern for input see below This value defines the default for users without an individual preference setting You can choose between four pre defined date patterns or provide your own customized pattern Each pattern exists as two versions the pattern used for parsing the user input and the pattern that is displayed to the user so that the user knows which format to use for the input Table 4 2 Predefined Date Patterns Pattern Number Display Version Parse Version 1 mm dd yyyy MM dd yyyy 2 dd mm yyyy dd MM yyyy 3 dd mm yyyy dd MM yyyy 4 yyy
146. where N stands for the pattern number of the pattern in question LISTSERV Maestro version 3 1 Interface Customization Manual 43 Section 4 Using the Resource Translation Tool If none of the predefined patterns match your requirements then you may define a custom pattern In that case you must supply both the display version and the parse version of that pattern For the display version you are free to choose what it looks like however you should choose a pattern that makes it easy for the user to understand the formatting that is required To define the display version locate the date node and edit the key called date timeFormat custom forDisplay this value is initially empty For the parse version you need to follow strict rules the pattern string must contain exactly two pattern fields HH and mm See Report Download Format for Date and Time in Section 4 2 5 Date and Time Formats for details of these fields and examples You can order them in any way you want and include any separator or fill characters however you must be aware that the user needs to enter them in exactly the same order with the same separators and fill characters so that LISTSERV Maestro can understand them Therefore you should probably choose an order separators and fill characters that are most common in the locale matching your target language and should also provide a similar display version with the same separator
147. will appear in Courier New font Emphasized words or phrases will be underlined Some screen captures have been cropped and or edited for emphasis or descriptive purposes Unless otherwise specified directory paths are for Microsoft Windows installations of LISTSERV Maestro For Linux or Solaris substitute the Maestro top level directory for Program Files L Soft Application Server This symbol denotes an important note or warning This symbol denotes optional advice that can help you save time This symbol denotes a new feature for LISTSERV Maestro 3 1 LISTSERV Maestro version 3 1 Interface Customization Manual vii Preface About This Manual LISTSERV Maestro version 3 1 Interface Customization Manual viii What s New for Customizing LISTSERV Maestro 3 1 Creating and managing what your subscribers see has never been easier LISTSERV Maestro 3 1 gives you the ability to create and manage message templates along with the ability to further customize these templates In addition your subscriber pages now include customizable pages for the Forward to a Friend feature These enhancements are described in the following sections Creating and Administering Templates Due to the addition of the new Message Templates feature you can now create and manage these templates After the administrator has given you the right to administer content templates then the Utility menu will contain two new options New
148. with the key XYZ directive looks up the key in the resource bundle and then displays the value associated with this key Therefore by simply changing the value of a key you can change what LISTSERV Maestro will display Important When making changes to key values be sure to make the changes correctly in order to preserve the meaning If you decide to not supply the value for a key in your translation LISTSERV Maestro will look up the original value If you use the Translation Tool to supply custom English text for resource keys then it is sufficient to supply the values only for the keys that you want to customize and to leave the customizations for the other keys empty By default the original values are correctly combined with your custom texts If you use the Translation Tool for a translation to a foreign language leaving any key value empty must be considered carefully Some resource keys define values that are actually language independent or can be used with the default English value even for foreign languages One example of such a value is the value for the hosted subs subscribe msg charset confirmMailForMemberAreaJoin key in the Subscriber Interface component of the Translation Kit The value for this key defines a character set and the default value ISO 8 85 9 1 is suitable for many Western European languages which means that the custom value for this key can remain empty in many cases However most key values are actual tex
149. xcept for the following settings which you are now asked to provide for the new template User Template Name Enter the name for the new user defined template Subject Enter the subject line for the new user defined template This setting is optional and can be left out in which case the subject line of the user defined template will remain empty Allow advanced editing of template source during mail job content definition When a template is used when defining a message then the user who uses the template only has to fill in the blanks that are left by the template placeholders The user does not have to bother with the actual message body as this body is already defined by the template Therefore by default when a template is used to define a message it is not even possible to modify the message body except by filling out the placeholders Under some circumstances you may want a user to not only fill out the placeholders but to also modify or edit the whole of the message body This is what this option is for if checked then editing of the message body outside of the placeholders is allowed while the template is being used for content definition If not checked then only the placeholders can be filled out Enable new template Only user defined templates that are in the enabled state may be used to define a message Check this option if you want the new user defined template to be enabled right from the beginning o
150. y additional changes to the uploaded template before saving it For more information on this screen see Section 5 7 Defining the Template Content 5 6 Creating a Copy of an Existing User Defined Template To create a template as a copy of an existing template click on the Utility menu and then select Content Templates The Manage Content Templates screen opens This screen contains a list of all user defined and system templates To copy any of these templates simply click the Copy link next to the template you d like to copy A copy of the template is added to the User Defined Templates section Once the copy is complete you ll want LISTSERV Maestro version 3 1 Interface Customization Manual 50 Section 5 Creating Customized Message Templates to rename the template To do this click on the name and rename it on the Edit Content Template screen For more information see Section 5 7 Defining the Template Content 5 7 Defining the Template Content The Edit Content Template screen lets you define th e content for your HTML template The Subject field is the subject line of the message It is mandatory and must be filled out The HTML Preview tab is where you can upload or download the HTML body of your message Once defined it also displays the HTML body of the message with all drop in elements resolved If errors have been encountered while LISTSERV Maestro has tried to replace the drop in placeholders with the drop in content
151. y defined below EJ E5 maestro editListProfile lt hl gt Edit Profile for maestro listName lt hl gt lt p gt Edit your information below lt p gt maestro editListProfile maestro subscribeToList lt hl gt Subscribe to maestro listName lt hl gt lt p gt Please fill out the fields below lt p gt maestro subscribeToList maestro validationErrorsPresent maestro validationErrors naestro validationErrorsPresent maestro profileFields lt p gt maestro okButton text nbsp nbsp 0Kenbsp nbsp maestro cancelButton text Cancel lt p gt v O cancelButton 2 4 1 The Membership Area Header Footer Template The Membership Area Header Footer Template is a common template that is shared by all pages in the membership area therefore any changes to this template will automatically affect all pages Because of this the Membership Area Header Footer template is the ideal place to start customization providing a common frame or layout for every page For example you can add a common header or footer or you can define common HTML styles colors and fonts If you are viewing the Membership Area Header Footer template in the Customize Page Layout screen then the Details link is available Click this link to see a list of the pages that are using this template To view a specific page in the list simply click the Open link next to that page To exit the list and r
152. y mm dd yyyy MM dd The parse version of the predefined patterns can not be changed however you may change the display version To change the display version open the LISTSERV User Interface Resources locate the date node and edit the keys LISTSERV Maestro version 3 1 Interface Customization Manual 42 Section 4 Using the Resource Translation Tool called date dateFormat N forDisplay where N stands for the pattern number of the pattern in question If none of the predefined patterns match your requirements then you may define a custom pattern In that case you must supply both the display version and the parse version of that pattern For the display version you are free to choose what it looks like however you should choose a pattern that makes it easy for the user to understand the formatting that is required To define the display version edit the key called date dateFormat custom forDisplay this value is initially empty For the parse version you need to follow strict rules The pattern string must contain exactly three pattern fields MM dd and yyyy See Report Download Format for Date and Time for details of these three fields and examples You can order them in any way you like and include any separator or fill characters however you must be aware that the user has to enter them in exactly the same order with the same separators and fill characters
153. y of the current draft version of the selected layout element and write it into the element s production version making this the version of the selected element which subscribers actually see The draft version remains unchanged 5 E 8 Copy from Production Version Click to make a copy of the current production version and use it as the new draft version This will overwrite all current changes to the draft version The production version remains unchanged Reset to System Default Click to reset the current draft version to the LISTSERV Maestro system default This will overwrite all manual changes to the draft version and will reset it to its default The production version remains unchanged Show Preview Click to show the preview of the current production version E Various comments may also be displayed depending on the type of layout element you selected to customize Header Footer Template This comment shows how many pages in the dataset and its lists that are currently using the header footer template i e pages that do not have a header footer defined of their own but are inheriting the template Click the Details link to view a detailed list of pages using this template Any of the List Page Templates The first comment shows if the template page inherits the header footer template see above or if the header footer is defined locally on the list page template The second comment below the first one s
154. yle Situation You are fine with the default layout of the membership area pages but you do not want to use the default style Instead of the default blue bar at the top of each page and the default colors and fonts you want to define a design style of your own including a common frame for all pages and common styles fonts and colors Solution Use the Customization wizard in LISTSERV Maestro to customize the Membership Area Header Footer Template This template is inherited by all pages of the membership area therefore by defining your own common frame i e header footer in this template and by providing your own HTML styles you can easily give the pages your own unique design For an overview of the Customization wizard see Section 2 Customizing the Subscriber Interface For information on customizing the Membership Area Header Footer Template see Section 2 4 1 The Membership Area Header Footer Template 2 Customizing specific text for all of your datasets all at once Situation In general you are fine with the appearance of the pages error messages and email notifications but you would like to change the wording of a few sentences or messages You would like to only make these changes once allowing your datasets to use the changes and preventing you from having to repeat these same changes for each new dataset LISTSERV Maestro version 3 1 Interface Customization Manual Section 1 Why Should Customize LISTSER
155. ystem Template 0 0 02 eee 47 5 2 Creating a Plain Text Template eee 49 5 3 Creating HTML Templates 0 0 ccc e m eae 49 5 4 Creating a Template Based on an Existing Job 00 cee eee 49 5 5 Uploading Pre Defined Text 0 0 liliis eens 50 5 6 Creating a Copy of an Existing User Defined Template 2 20200005 50 5 7 Defining the Template Content 0 0 0 0 0 eee eae 51 5 8 Defining the Template Settings 0 0 cece eae 52 5 9 Using Drop In Content 0 eee 54 5 10 Using Template Placeholders 000000 c eee teens 55 5 10 1 Creating and Inserting Placeholders 0 00 c cee eee 55 5 10 2 Editing Placeholders oaea erar naa naaa ia Ea n e 56 5 10 3 Special Prefix and Suffix Rules for Template Placeholders 61 5 10 4 TITLE in a Binary Placeholder Prefix Suffix llle 62 5 10 5 Multiple Values Placeholders with Prefix Suffix llle 62 5 10 6 INDEX in a Multiple Values Placeholder Prefix Suffix 64 5 10 7 Multi Placeholder Repeater 0 000 c cece lees 65 5 11 Managing Existing Templates 0 0 uaaa aaaea 69 Appendix A Custom Styles and HTML Tags 22 22 eee n nnn 71 Appendix B The Default Style Sheet eee eee 75 Appendix C Languages Supported for Translation 020 0 eee eee ee 79 Appendix D A Quick Reference Gu

Customization Manual for LISTSERV Maestro 3.1 - L

Contents

Download Pdf Manuals

Related Search

Related Contents