table of contentshoosh.otago.ac.nz/.../0007/...layout-manual_v3.20a.pdf · mysource matrix paint...

MySource Matrix Paint Layout Manual

Table of Contents Chapter 1 Introduction ................................................................................................................ 5 Chapter 2 Overview .................................................................................................................... 6

Applying a Paint Layout............................................................................................................ 6 Status and Permissions ............................................................................................................ 7

Chapter 3 Formatting a Paint Layout ............................................................................................. 8 Page Contents Bodycopy .......................................................................................................... 8 Default Format Bodycopy ......................................................................................................... 8

Keyword Replacements on the Default Format Bodycopy .......................................................... 9 Chapter 4 Details Screen ............................................................................................................10

Layout Settings......................................................................................................................10 Chapter 5 Usage Screen .............................................................................................................12 Chapter 6 Type Formats .............................................................................................................13

Creating a Type Format Bodycopy ............................................................................................13 Editing a Type Format Bodycopy ..............................................................................................14 Deleting a Type Format Bodycopy ............................................................................................14

Chapter 7 Conditional Keywords Screen ........................................................................................15 Using a Conditional Keyword....................................................................................................16

Chapter 8 Example ....................................................................................................................17 Create a Type Format .............................................................................................................17 Adding the Conditional Keywords .............................................................................................17 Formatting the Layout ............................................................................................................17 Applying the Paint Layout........................................................................................................18 Viewing the Paint Layout .........................................................................................................18

Appendix 1 – Keyword Replacements ...........................................................................................20 Page Contents Keyword Replacements ......................................................................................20 Keyword Replacements for the Type Format Bodycopies..............................................................20

Index .......................................................................................................................................21


Revision History Revision Date MySource

Matrix Version Comment

V3.20a 5th January 2009 3.20.0 • Initial release for v3.20

Copyright © Squiz Pty Ltd. All Rights Reserved.

No part of this publication may be reproduced by any process, electronic or otherwise, in any material

form or transmitted to any other person or stored electronically in any form, without the prior written

consent of Squiz Pty Ltd, except as permitted under the Copyright Act 1968.

Trade Marks Notice

Squiz.net, MySource and MySource Matrix, are registered trademarks of Squiz Pty Ltd and may not be

used without the prior specific written consent. All other registered and unregistered trademarks in this

document are the sole property of their respective owners, which may not be used without their written

permission.


Chapter 1 Introduction

Chapter 1 Introduction The MySource Matrix Paint Layout manual describes the Paint Layout asset in MySource Matrix. This

includes how to add and set up a Paint Layout asset.

This annual is aimed at Backend Users, System Administrators or the Root User. It is recommended you

read this manual in conjunction with the MySource Matrix Concepts manual and the MySource Matrix

Asset Screens manual.

This manual assumes you have a fully installed and operational MySource Matrix system that you can

access via a valid username and password, a connection to the Internet and a recent version of a web

browser.

Please note that this manual does not cover any of the functionality provided in the MySource Matrix

modules.

All screen shots within this manual have been taken once the Acquire Lock(s) button has been clicked on

the screen.


Chapter 2 Overview

Chapter 2 Overview A Paint Layout defines the layout of the content of the asset and allows you to add metadata fields as

well as other information including the date and time of when the asset was published. For example, say

you had a number of media releases in your Site. Each media release needs to show the title, the date it

was published and who it was published by. Instead of adding this information every time you create a

page, you can instead create a Paint Layout that will include the extra information. An example is

shown in the figure below.

The content of the page has been defined on a Standard Page and the title and published information at

the bottom of the page has been defined in a Paint Layout. This Paint Layout can then be applied to

any new media releases that are added to the Site.

Once you have created a Paint Layout, you can set it up as required by entering the details on the

following screens:

Details

Edit Contents

Web Paths

Usage

Permissions

Workflow

Roles

Metadata Schemas

Metadata

Linking

Settings

History

Logs

Preview

Lookup Settings

Tagging

Many of these screens are the same or similar to those for a Standard Page and are described in the

MySource Matrix Asset Screens manual. In this manual we will only describe the Details and Usage

screens.

Applying a Paint Layout

Once you have created a Paint Layout, you can apply it to an asset on the Lookup Settings screen.

For more information on this screen, please refer to the MySource Matrix Asset Screens manual.

Figure 1: Example media release


Chapter 2 Overview

Status and Permissions

To allow a public user to see the Paint Layout for an asset, grant Public Read Permission to the Paint

Layout. Otherwise, you will need to grant at least Read Permission to the specific users that you want

to be able to view the layout. The Paint Layout also needs to be Live.

Tip: A Paint Layout will only be visible if a Design has been applied to the asset. If the

Paint Layout does not appear, a Design may not have been applied. For more

information on how to apply a Design, refer to the Settings Screen chapter in the

MySource matrix Asset Screens manual.


Chapter 3 Formatting a Paint Layout

Chapter 3 Formatting a Paint Layout When you create a Paint Layout, a number of Bodycopy assets

are automatically created beneath it, as shown in the figure to the

right. These assets allow you to format the layout of the Paint

Layout.

Page Contents Bodycopy

The Page Contents Bodycopy is used to define the overall layout of the Paint Layout. To change what

information is being shown, right click on the Page Contents Bodycopy in the Asset Map and select

Edit Contents. In the WYSIWYG Editor, enter the information you want to show on the page. By

default, the keyword replacement Paint Layout will appear in the WYSIWYG Editor. This keyword

replacement will show the layout that has been defined in the Type Formats.

Default Format Bodycopy

The Default Format Bodycopy is used to define what information to display for the asset. This can be

done through keyword replacements and metadata fields. For example, in the page shown in the figure

below, the tile and published information is being shown. This has been defined in the Default Format

Bodycopy.

Tip: If you do not include the keyword replacement Paint Layout on the Page Contents

Bodycopy, the layout you have defined will not appear on the screen.

Figure 2: Dependant assets

Figure 3: Example page


Chapter 3 Formatting a Paint Layout

To change what information is being shown, right click on the Default Formats Bodycopy in the Asset

Map and select Edit Contents. In the WYSIWYG Editor, enter the information you want to show on the

page. By default, the keyword replacement Asset Contents will appear in the WYSIWYG Editor.

Keyword Replacements on the Default Format Bodycopy

A list of keyword replacements is provided in the WYSIWYG Editor toolbar on the Edit Contents screen

of the Default Format Bodycopy. You can use these keyword replacements in conjunction with text,

images, and links etc to layout what to show for the asset. For a full list of the standard keyword

replacement, refer to the Keyword Replacements chapter in the MySource Matrix Concepts manual. The

additional keyword replacements that are available include the following:

Asset Lineage: this will show the path of where the asset exists in the system.

Asset Lineage Linked: this will show the path of where the asset exists in the system. Each

asset in the path is hyperlinked.

Asset Contents: this will show the content of the asset that the Paint Layout has been applied

to. Without this keyword replacement, the content of the asset will not be shown on the page.

Along with the standard list of keyword replacements you can also use the metadata keyword

replacement to display a metadata field for an asset on the Default Format Bodycopy. For more

information on this, refer to the Keyword Replacements chapter in the MySource Matrix Concepts

manual.

Tip: If you do not include the keyword replacement Asset Contents on the Default

Format Bodycopy, the content of the asset that you apply the Paint Layout to will not

be shown on the page.


Chapter 4 Details Screen

Chapter 4 Details Screen The Details screen allows you to configure various settings including whether or not to use a specific

type format. The Details screen of the Paint Layout is shown in the figure below.

For more information on the Status, Future Status, Thumbnail and Details section of the screen,

please refer to the Details Screen chapter in the MySource Matrix Asset Screens manual.

Layout Settings

This section allows you to create a Bodycopy asset for an asset type. For example, you can create a

Standard Page Format to define the layout for a Standard Page. When you apply the Paint Layout

to a Standard Page, it will use the Standard Page Format instead of the Default Format. The

Default Format will only be used for assets that are not Standard Pages.

To add a specific type format, select the asset type in the Add Custom Asset Type field and click

Commit. The Bodycopy asset will appear under the Type Formats Folder in the Asset Map and the

asset type will be listed in the Custom Asset Types section, as shown in the figure on the following

page.

Figure 4: Details screen of the Paint Layout


Chapter 4 Details Screen

By default the Inherit Types flag will be ticked. This means that the child types of the selected asset

type will also use the layout that is defined in this Bodycopy. For example, if you have selected a User

asset type, and checked the inherit box, then the Users, Backend Users, System Administrators and

the Root User will also use the layout defined in the Bodycopy. If you do not want to use the

Bodycopy for the child types, deselect this box and click Commit.

To add additional Bodycopy assets, select the asset type from the Add Custom Asset Type list and

click Commit.

For more information on creating and editing type formats, please refer to the Type Formats chapter in

this manual.

Figure 5: Custom Asset Types section


Chapter 5 Usage Screen

Chapter 5 Usage Screen The Usage screen shows assets that are currently using the Paint Layout. The Usage screen of the

Paint Layout is shown in the figure below.

By default, if the Paint Layout has not been applied to any assets, no information will appear on the

screen, as shown in the figure above. Once the Paint Layout has been applied to an asset, the

information shown in the figure below will appear.

The top-level assets where the Paint Layout has been applied, along with the number of child assets

under it that are also using the Paint Layout is shown. You can click on the name of the asset to go to

the Lookup Settings screen of that asset.

Figure 6: Usage screen of a Paint Layout

Figure 7: Usage screen of a Paint Layout


Chapter 6 Type Formats

Chapter 6 Type Formats By default, when you create a Paint Layout, a Type Formats

Folder containing a Default Format Bodycopy is created

underneath it, as highlighted in the figure to the right. This is used

to define what information to display for the asset. For example, in

the page shown in the figure below, the title and published

information is being shown. This has been defined in the Default

Format Bodycopy.

This default format, however, is used for all asset types that the Paint Layout is applied to. For

example, if you apply this Paint Layout to a Standard Page and a Folder, the layout defined in the

Default Format Bodycopy will be used for both asset types. You can, however, create a Bodycopy

asset for each asset type. For example, you can create a Bodycopy for the Standard Page and a

Bodycopy for the Folder.

The advantages of creating a Type Format Bodycopy for a specific asset type are as follows:

You can change the layout for each asset type without having to create different Paint Layouts.

For example, you can show the last updated information for Standard Pages but show the

published information for Folders.

MySource Matrix can provide you with more specific keyword replacements to use within the

Bodycopy. For example, for a PDF File, along with the standard keyword replacements it can

also show the keyword replacements File Size and Friendly name for the file. These additional

keyword replacements will appear in the select keyword list in the WYSIWYG Editor toolbar.

Creating a Type Format Bodycopy

To create a Type Format Bodycopy, right click on the Paint Layout and select Details. In the Custom

Layout Settings section, select the asset type in the Add Custom Asset Type field and click Commit.

The asset type will be listed in the Custom Asset Types section, as shown in the figure on the following

page.

Figure 8: Type Formats Folder

Figure 9: Example


Chapter 6 Type Formats

The Bodycopy will also appear under the Type Formats Folder in

the Asset Map, as highlighted in the figure to the right.

By default the Inherit Types flag will be ticked. This means that the child types of the selected asset

type will also use the layout that is defined in this Bodycopy. For example, if you have selected a User

asset type, and checked the inherit box, then the Users, Backend Users, System Administrators and

the Root User will also use the layout defined in the Bodycopy. If you do not want to use the

Bodycopy for the child types, deselect this box and click Commit.

To add additional Bodycopy assets, select the asset type from the Add Custom Asset Type list and

click Commit.

Editing a Type Format Bodycopy

To edit a Type Format Bodycopy, right click on the Bodycopy in the Asset Map and select Edit

Contents. Format the layout of the Paint Layout in the WYSIWYG Editor through the keyword

replacements listed in the toolbar. For more information on the standard keyword replacements, please

refer to the Formatting the Paint Layout chapter in this manual.

Deleting a Type Format Bodycopy

To delete a Type Format Bodycopy, right click on the Paint Layout in the Asset Map and select

Details. In the Layout Settings section, click the Remove box for the type format that you want to

delete and click Commit. The Type Format Bodycopy will be removed from the Type Formats Folder

in the Asset Map.

Tip: If you do not include the keyword replacement Asset Contents on the Bodycopy,

the content of the asset that you apply the Paint Layout to will not be shown on the

page.


Figure 10: Type Format Bodycopy


Chapter 7 Conditional Keywords Screen

Chapter 7 Conditional Keywords Screen On each of the Type Formats Bodycopy, the Conditional Keywords screen can be found. This screen

allows you to specify conditions that must be satisfied for a section of your content to be displayed. If the

condition is not satisfied, the appropriate section of content is not displayed to the user. The Conditional

Keywords screen of the Default Format Bodycopy is shown in the figure below.

To add a condition select the type of condition you want to use from the Condition Type list and click

Commit. Additional fields will then appear on the screen allowing you to configure that condition. You

can add as many conditions as you want.

The Admin Access Condition, Form Posted Condition, Keyword Regexp Condition, User Type

Condition and Write Access Condition should only be used under very specific circumstances and

hence are not described in this manual. All other conditions are as follows:

Asset Status Condition: this condition specifies that the content will be shown if the asset is or

is not a particular Status.

In User Group Condition: this condition specifies that the content will be shown if the user is

part or not part of a User Group.

Logged In Condition: this condition specifies that the content will be shown if the user is either

logged in or not logged in.

Logical Condition: this condition specifies that the content will be shown if a combination of

keywords evaluates to either true or false.

Server Variable Condition: this condition specifies that the content will be shown if a specific

user variable either matches or does not match the pattern specified. For example, you can

specify that the content will be shown if the browser the user is using is Internet Explore. To do

this, select The following server variable matches the specified pattern from the list

provided, enter HTTP_USER_AGENT into the Server Variable field and enter MSIE into the

Pattern field.

Simple Edit Mode Condition: this condition specifies that the content will be shown if the user

is using or is not using the Simple Edit Interface.

User Agent Condition: this condition specifies that the content will be shown or will not be

shown if the user is using a specific browser. For example, you can specify that the content will

be shown if the browser the user is using is Internet Explore. To do this, select The user agent

string matches the pattern from the list provided and enter MSIE into the User Agent

Figure 12: Conditional Keywords screen


Chapter 7 Conditional Keywords Screen

Pattern field.

User Frequency Condition: this condition specifies that the content will be shown if the user

has spent a certain amount of time on your Site or has visited the Site a certain number of

times.

User IP Condition: this condition specifies that the content will be shown if the user has a

particular IP range.

Using a Conditional Keyword

Once you have set up a condition on the Conditional Keywords screen, a number of keyword

replacements will be available on the Edit Contents screen of the Bodycopy. These keyword

replacements allow you to configure the content so that only certain areas will be visible if certain

conditions are met and are as follows:

Begin <condition name>: if the condition is true, the content that is shown between this

keyword replacement and either the keyword replacement Else <condition name> or End

<condition name> will be shown.

Full Structure for <condition name>: this keyword replacement will add the keyword

replacements Begin <condition name>, Else <condition name> and End <condition

name> in the WYSIWYG Editor. You can then add the required content in between these

keyword replacements.

<condition name>: this will show 1 if the condition is true or 0 if it is false.

Else <condition name>: if the condition is false, the content that is shown between this

keyword replacement and the keyword replacement End <condition name> will be shown. This

keyword replacement is optional

End <condition name>: use this keyword replacement to indicate where the conditional

content ends.

Please note <condition name> is the name of the condition on the Conditional Keywords screen.

An example of the conditional keyword replacement structure is shown in the figure below.

Figure 13: Example conditional keyword structure


Chapter 8 Example

Chapter 8 Example To understand the Paint Layout, consider the

following example. We have a media releases section in

our site. Each media release is a Standard Page and

they are stored under a Folder called Media

Releases, as shown in the figure to the right. Each

media release needs to show the title of the page, the short description of the article, the content of the

page, the date it was published and who published it. Also, if the user is logged in, it needs to show when

it was created and who created it. To do this, create a Paint Layout called Media Releases and set it

up as follows:

Create a Type Format

Create a Type Format for the Standard Page. To do this, right click on the Paint Layout and select

Details. In the Add Custom Asset Type field, select Standard Page and click Commit. The asset type

will be listed in the Custom Asset Types section, as shown in the figure below.

The Standard Page Format Bodycopy will also appear under the

Type Formats Folder in the Asset Map, as highlighted in the

figure to the right.

Adding the Conditional Keywords

Right click on the Standard Page Format in the Asset Map and select Conditional Keywords. In the

Condition Type list, select Logged In Condition and click Commit. Change the Keyword Name to

user_logged_in, select The user is logged in in the Keyword is true if field and click Commit.

Formatting the Layout

Right click on the Standard Page Format in the Asset Map and select Edit Contents. In the

WYSIWYG Editor, add the required keyword replacements as shown in the figure on the following page.

Figure 14: Media Releases Folder


Figure 16: Type Format Bodycopy

Figure 17: Logged In Condition


Chapter 8 Example

Applying the Paint Layout

To apply the Paint Layout to all of the pages in the Media Releases Folder, right click on the Folder

and select Lookup Settings. In the Paint Layout section of the screen, select the Media Releases

Paint Layout in the Layout field and click Commit. The Paint Layout will be applied to the Folder and

its child assets. Any new media releases that are added to this Folder will inherit this Paint Layout.

Viewing the Paint Layout

The figure below shows the MySource Matrix to support PHP5 media release before the Paint Layout

was applied.

Once it has been applied, the title, short description and published information will appear on the page,

as shown in the first figure on the following page. When a user logs into the system, the created

information will also appear on the page, as shown in the second figure on the following page.

Figure 18: WYSIWYG Editor on the Standard Page Format



Chapter 8 Example




Appendix 1 – Keyword Replacements

Appendix 1 – Keyword Replacements This appendix outlines the keyword replacements that can be used within the Paint Layout.

Page Contents Keyword Replacements

Keyword Replacement Information shown

%paint_layout% The layout that has been defined in the Type Formats.

Keyword Replacements for the Type Format Bodycopies

For a full list of the keyword replacements that can be used on the Default Format Bodycopy, please

refer to the Appendix in the MySource Matrix Concepts manual. Below are the additional keyword

replacements that can be used.

Keyword Replacement Information shown

%asset_lineage% The path of where the asset exists in the system.

%asset_lineage_linked% The path of where the asset exists in the system. Each asset in

the path is hyperlinked.

%asset_contents% The content of the asset that the Paint Layout has been applied

to.


Index

IndexAdd Custom Asset Type, 10, 13, 14

Conditional Keywords Add, 15 Asset Status Condition, 15 In User Group Condition, 15 Keyword Replacements, 16 Logged In Condition, 15 Logical Condition, 15 Server Variable Condition, 15 Setting up, 16 Simple Edit Mode Condition, 15 User Agent Condition, 15 User Frequency Condition, 16 User IP Condition, 16

Custom Asset Types, 10, 13

Custom Layout Settings, 13

Default Format Bodycopy, 8, 13

Inherit Types, 11, 14

Page Contents Bodycopy, 8

Remove, 14

Type Format Add, 10

Type Formats Advantages, 13 Create, 13 Delete, 14 Edit, 14

table of contentshoosh.otago.ac.nz/.../0007/...layout-manual_v3.20a.pdf · mysource matrix paint...

Documents