Académique Documents
Professionnel Documents
Culture Documents
USER GUIDE
65bit Software Ltd
Revision History
© Copyright 2005 - 2010 65bit Software Limited. All Rights reserved. Reproduction or copying prohibited.
Adobe and InDesign are either trademarks or registered trademarks of Adobe Systems Incorporated in the United States
and/or other countries.
All other trademarks and copyrights are the property of their respective owners.
CONTENTS
CONTENTS
CHAPTER 1 GETTING STARTED.......................................... 17
Welcome......................................................................................... 17
What is EasyCatalog?.................................................................... 17
Demo Version................................................................................. 19
Purchasing EasyCatalog................................................................ 19
Activating EasyCatalog.................................................................. 19
Common Activation Errors............................................................. 20
Transferring an Activation............................................................... 21
Keeping Up To Date....................................................................... 22
Support Questions......................................................................... 22
Integration opportunities................................................................ 22
Resellers......................................................................................... 22
Package Contents.......................................................................... 23
Editing Documents Without EasyCatalog Loaded......................... 24
CHAPTER 7 SYNCHRONIZING............................................ 79
Introduction.................................................................................... 79
Getting the Latest Data.................................................................. 79
Synchronizing With a Different File................................................. 80
Updating the Document................................................................. 80
Updating a Book............................................................................ 81
Checking For Errors....................................................................... 81
Text Content......................................................................... 81
Picture Content.................................................................... 81
How Document Formatting Is Preserved....................................... 82
Updating the Panel from the Document......................................... 83
All......................................................................................... 83
Selection.............................................................................. 83
With Document Selection.................................................... 83
Updating Page Numbers................................................................ 84
Updating Data with Page Positions............................................... 86
Updating the Data Source.............................................................. 87
CHAPTER 1
GETTING STARTED
WELCOME Thank you for evaluating EasyCatalog for Adobe InDesign.
• Increased productivity:
DEMO VERSION Your EasyCatalog plug-in will run in demo mode until a valid
registration code is entered. The EasyCatalog trial is valid for thirty
days from the date it is first run.
Thank you for taking time to evaluate EasyCatalog – if you have any
questions or would like further information, please visit our web site
at www.65bit.com.
We are here to help you with during your evaluation so if you have
any questions whatsoever, please contact us using the support form
at our website:
http://www.65bit.com/support/support.shtm
http://www.65bit.com/purchase/purchase.shtm
ACTIVATING Following purchase, you will be supplied with a serial number for
each of the modules that you have purchased.
EASYCATALOG
EasyCatalog uses internet activation to validate your license codes,
which typically takes a few seconds to process. Once registered, all
limitations of the demo version will be lifted.
ACTIVATING serial number. Internet activation also helps to ensure that you do
not unintentionally violate your EasyCatalog license agreement.
EASYCATALOG
(CONTINUED) To activate, select ‘About EasyCatalog’ from the InDesign application
menu (on the Macintosh), or from ‘Help’ menu (on Windows).
The most common cause of this error is entering the serial number
incorrectly. Please ensure that you enter the complete serial number
(including all dashes). EasyCatalog serial numbers do not contain
the letters ‘I’, ‘O’, ‘U’ or ‘Z’ as these can be confused for other
characters. Try copying and pasting the serial number from your
order confirmation email into the activation dialog.
The serial number you have entered has been blacklisted and cannot
be used to activate EasyCatalog. Please contact the vendor who
sold the license for further information.
http://www.65bit.com/support/support.shtm
In the event of this error persisting, please download and install the
‘eSellerate Engine’ from:
http://shopper.esellerate.net/ics/support/default.asp?deptID=5620
TRANSFERRING AN
Activations cannot be transferred in the CS2
ACTIVATION version of EasyCatalog.
TRANSFERRING AN
ACTIVATION Transfer an activation using
(CONTINUED) the ‘Deactivate’ button. This
button will only be available
when all modules shown in the
list are activated.
After a few seconds your serial number will deactivate and you should
be able to activate the serial number on another machine in around 5
- 10 minutes.
If you have any problems with activation, please contact us using the
support form at our website:
http://www.65bit.com/support/support
KEEPING UP TO DATE Periodically, bug fixes and enhancements are released on our
website. Please use the ‘Check for Updates’ button on the ‘About
EasyCatalog’ dialog to ensure that you are always running the latest
version of EasyCatalog.
http://www.65bit.com/support/support.shtm
INTEGRATION EasyCatalog has been designed for easy integration into third- party
database and asset management systems. Systems integrators
OPPORTUNITIES who are interested in integration opportunities should contact us at
sales@65bit.com.
EasyCatalog CS1
CS2 The main Adobe InDesign plug-in. This plug-
CS3 in is responsible for much of the functionality
EasyCatalog UI CS4 outlined in this manual.
CS5
EDITING DOCUMENTS Documents created with EasyCatalog can be opened and edited
in a copy of InDesign that does not have the EasyCatalog plug-ins
WITHOUT loaded. However, any changes made to the content of the document
EASYCATALOG may cause problems if the document is subsequently re-opened in
LOADED EasyCatalog.
!
broken links in your document. If you have any
questions please contact us using the support
form on the website.
CHAPTER 2
DATA PROVIDER EasyCatalog uses Data Providers - other InDesign plug-ins written to
interface with EasyCatalog - to import your data. Examples of data
MODULES
sources are CSV (comma separated) files or any ODBC-compliant
database.
Existing data
snapshots are listed
here
Your configuration may differ from the one shown here - if you are
not acquiring data from a file, please consult the documentation that
accompanies your Data Provider plug-in. Depending on the Data
Provider being used, configuration may not even be necessary.
IMPORTING FROM A ➀ The process begins by selecting ‘New File Data Source’ from the
File→New→New EasyCatalog Panel menu option.
FILE
➁ Select your data file using the standard file selection dialog.
EasyCatalog will now examine the file to determine the best settings
for importing your data - these will be presented in the configuration
dialog. Don’t panic! This is by far the most complex stage in
configuring EasyCatalog - for the majority of users, the settings
determined by EasyCatalog will suffice.
➂ ➃
➀ Location
Shows the path to the selected file, and allows a new file to be
chosen. Use the ‘Reveal’ button to go to the file in Windows Explorer
(Windows) or the Finder (Macintosh).
➁ Content
The menus in this area allow you to specify how the file is structured.
When importing a file for the first time, EasyCatalog will attempt to
automatically determine the correct settings for each of these pop-
ups by inspecting a sample of the file.
Setting Description
Specify the type of file being used - either ASCII or
Unicode.
File Encoding EasyCatalog provides full support for importing unicode
files. EasyCatalog can import UTF-8 and UTF-16 encoded
Unicode files.
Specify the character that’s used to separate each field in
Field Delimiter
the file
continued...
Example File
The first row in this file contains the names of each of the columns, so the ‘First
Record contains field names’ check-box should be set.
The Field Delimiter: the character The Record Delimiter: the character
used to separate each field in the file used to separate each record in the
(in this example, a comma) file (in this example, a carriage-return)
➂ Sample
Each time any of the ‘Content’ settings are changed, the ‘Sample’
pane will change to show how the file will be imported using the
current configuration. If you are unsure of the settings to specify, you
can experiment until the desired results are shown in the ‘Sample’
frame.
➃ Field Information
Key
Each record from your data source should contain a unique identifier
- this ‘key’ field is used to link document content to the source data.
Typical examples of key fields include SKUs and product codes.
Where there is no single field that identifies a record, multiple fields
may be specified to form a compound key.
IMPORTING FROM A Configuration of the ‘key’ attribute is critical to ensuring that record
updates and synchronisation of data work reliably.
FILE
(CONTINUED)
The choice of key field is critical to the operation
!
of EasyCatalog. The key field is used to uniquely
identify each record from the data source and
must never change.
As a record must have some data that changes, you must have one
field that is not a key.
Formatting Fields
Hit the ‘Options’ button to open the ‘Field Options’ dialog. It isn’t
necessary to fully configure each field at this time, since the Field
Options dialog is available at any time.
See the ‘Field Options’ chapter for more information on the settings
available in the Field Options dialog.
IMPORTING THE DATA Once you are happy with the configuration options, press the OK
button to import the file. If the configuration is correct, a new
EasyCatalog panel will open showing a spreadsheet-style view of
your data. Further information on working with the EasyCatalog data
panels can be found in the ‘Panels’ chapter.
COMMON ERRORS Common import problems, along with possible resolutions are shown
below:
AND WARNINGS
A data source of this name already exists in your workspace
folder. Do you want to overwrite it?
You are attempting to open a data source with the name of a data
source that already exists. You may continue by answering ‘yes’
to this dialog, but the previous version of the data source will be
deleted.
COMMON ERRORS A data source of the same name is already open. Please use
another name or close all related panels and try again.
AND WARNINGS
(CONTINUED) You are attempting to open a new data source using the name of a
data source that already exists. Although similar to the above error
message, you cannot continue as panels for the old data source are
still open. To overwrite the old data source, close its data panels
using the ‘Close Panel’ menu option - you may need to show hidden
data panels using the ‘EasyCatalog Panels’ menu on the Window
menu.
In the column(s) you have nominated as the key field(s), you have
duplicate values (the value that is duplicated is shown in the error).
To overcome this, remove duplicate keys from the source data or
check that your key field configuration is correct.
To rectify this problem, ensure that each record in the file contains
the same number of fields, and that the number of fields matches the
number of field names supplied in the first row/record of the file.
COMMON ERRORS Duplicate records were found and have been removed
AND WARNINGS Records that contain exactly the same content cannot be imported,
(CONTINUED) as each would have the same key field values. This message is
informative, and the duplicate records will be removed and the file
imported. You should check to see whether you need to import these
missing records and, if so, include exta information in the source
data to differentiate between each record.
All fields imported must have a name, and this error is indicating that
one or more have empty names. This error will only occur when ‘First
record contains field names’ is selected. Check the source data to
ensure that each field has a name, and that the number of fields in
each record does not exceed to number of field names specified in
the first record/row of the file.
DATA CACHING AND EasyCatalog does not require a permanent connection to your data
- by caching your data in a local ‘workspace’ folder, you are able to
THE WORKSPACE
continue working with EasyCatalog even when your data source is
FOLDER unavailable.
Your workspace folder also contains all of the settings for each data
source you create, allowing you to close and re-open data sources
without having to re-configure them each time.
DELETING A DATA Once you have finished with a data source, it can be deleted using
the ‘Delete’ button from the Information dialog. To
SOURCE
access the ‘Information’ dialog, hit the ‘info’ button at
the bottom of one of the data panels.
Use the Delete button on the Information dialog to permanently delete a data
source from your workspace folder.
CHAPTER 3
FIELD OPTIONS
INTRODUCTION EasyCatalog provides facilities for fields to be formatted prior to
placement in a document. By setting Field Options you can, for
instance, ensure that your price fields are formatted to use the
correct currency symbol and number of decimal places.
Once you are happy with your configuration, these options can be
exported to file so you can store a copy of your setup and share this
with other EasyCatalog users.
EDITING FIELD The Field Options dialog can be accessed in a number of ways:
OPTIONS Whilst configuring a new data source
Alt + Double Click in the header area of a Import and Export the Field
column to display the Field Options dialog Options configuration to a file
Display the Field Options dialog for the a field by selecting it from the list
THE FIELD OPTIONS This dialog is divided into two panes – the left-hand list shows the
predefined options available. Selecting any one of these will change
DIALOG
the right-hand pane to show further configuration options.
The ‘Field Format’ pane is used to identify the field’s type and format
Fields that are defined as ‘Alphanumeric’ will appear in exactly the same format
as the original data
Select this option to strip ‘white space’ - tabs, spaces, etc. - that
appears at the start or end of the field’s content.
!
only affect data on import. Updating your data
source with new document content will not
create tagged content.
Formatted Fields
Example of formatted content:
HTML
EasyCatalog also provides basic support for simple HTML tags.
When the ‘HTML’ check-box is set:
• Character entities, such as ‘¨’ in text content will be converted
to an appropriate glyph. Numeric entities such as 算 are
also supported.
• A numbered list will be inserted when <OL> tags are encountered
in the text.
• A bulletted list will be inserted when <UL> is used within the
text.
• <BR> tags will be replaced with a carriage-return.
• Text between <P> and </P> tags will be inserted into its own
paragraph.
• <FONT> tags will be processed and the appropriate font
applied.
• Unrecognized tags will be stripped from the source text prior to
placement in the document. Tags other than the defaults shown
here should be configured using the Field Formatting Tags dialog.
When checked, this option allows white space to be inserted into the
field in the document, such as additional carriage-returns, tabs, etc.
Additionally, ‘Update Panel’ will only update the field in the panel
when non-white-space characters have been modified.
Number
The ‘Field Format’ pane is used to identify a field’s type and format
The panel offers pre-set options for formatting numeric fields as currency. Select
the format pop-up to preview the format in the ‘Example’ pane.
Custom Formats
Where your needs are not met by any of the available options,
the ‘Custom’ option allows a number format to be specified either
through the use of a formatting string or using special keywords.
199,99
[PRECISION=2]
Specifies the number of digits that
PRECISION Values will be formatted to
will appear after the decimal point.
two decimal places
[THOUSANDS=.]
Specifier a character or characters
to use to as the thousands Values greater than a
separator. The thousands thousand will use a comma
THOUSANDS
separator is used to divide the as a thousands separator -
value into groups of three, right-to- e.g.:
left from the decimal point.
1.234.567
Characters can be optionally [REMOVE=0.(<1)]
removed when the content of
REMOVE For values less than 1,
the field matches the specified
remove “0.”
criteria.
The ‘Hyperlink’ field format allows InDesign hyperlinks to be inserted into the document.
The contents of the ‘Text’ field appears in the document; the ‘URL’
field is used as the hyperlink destination URL. To include the content
of other fields, enclose the field name within { brackets }.
Imported Text
FIELD FORMAT
(CONTINUED)
If the field contains a full path to the file to import, the ‘Folder’ and ‘Extension’
options can remain empty. If the field contains only a filename specify the folder
containing the file and (optionally) the file extension used (if this information is
not included in the filename).
!
Fields of type ‘Imported Text’ will not be updated
as part of the ‘Update Panel’ operation.
GENERAL
FORMATTING
OPTIONS
The ‘General’ pane allows a character style sheet to be applied to this field when
placed in the document
Style
GENERAL the current document, or the default character style sheets if there is
no document open, will be listed in this popup.
FORMATTING
OPTIONS When inserting the field into the document, you must ensure that the
(CONTINUED) character style sheet is available. A warning will be displayed if it is
not, and the field will be inserted without applying the style sheet.
Prefix
Suffix
Any characters that should always appear after the content of this
field should be specified here.
Note that both the prefix and suffix are not applied to empty fields.
Cleansing Options
EasyCatalog allows the content of each field to be ‘cleansed’ before
it is used in the document. ‘Data Cleansing’ is a simple search-and-
replace that is applied to the data during import and before any
formatting options are applied.
#=£;
ESY=EasyCatalog;
REGEX:^^a=b;
*=^8;
All instances of the asterisk (*) will be replaced with the InDesign
bullet character.
Code Description
^# Auto Page Numbering
^x Section Marker
^8 Bullet •
^^ Caret ^
^2 Copyright Symbol ©
^p End of Paragraph
continued....
PICTURE IMPORT In addition to inserting textual field content into an InDesign text flow,
EasyCatalog can also be configured to import images into picture
OPTIONS
boxes. The picture to import is specified by the content of each field.
OPTIONS ➀➁➂➃
(CONTINUED)
➄➅➆
Attribute Description
This option determines how the image will be scaled to fit into
its containing box.
Scaling Description
The picture will not be scaled when it is
None
imported
The picture will be proportionally scaled to fit
Proportionally its containing picture box. There may be white
Fit space around the image if the image frame has
a different aspect ratio to the image.
The picture will be scaled to fit the picture box but,
unlike ‘Proportionally Fit’, it will completely fill the
Fill Frame box ensuring there is no white space around the
➀ Scaling image. The aspect ratio of the original image
will not be maintained when using this option.
The picture will be proportionally scaled to fill
the picture box but, unlike ‘Proportionally Fit’,
Fill
it will completely fill the box ensuring there is
Proportionally
no white space around the image. Some of the
image may be outside of the box.
Pictures will always be imported and scaled to
Fixed Scale the percentage specified by the ‘Scale’ pop-
up.
If your data also contains picture scaling
Field
information, this option can be used to
Specified
nominate the field containing this value.
When the ‘Scaling’ option is set to ‘Fixed Scale’, this pop-up
should be used to specify the scale to import the image at. If
➁ Scale/Field
‘Field Specified’ is set as the ‘Scaling’ option this menu should
be used to select the field containing the scaling information.
After the image has been imported into the frame, it can be
➂ Alignment
aligned to any of its containing frame’s corners or edges.
continued....
OPTIONS ➃ X Offset
These options are used to offset the image within its containing
(CONTINUED) frame. Specify the name of a field containing the X and/or Y
➄ Y Offset
offset that must be applied to the image.
When checked, this option will force the field to be inserted as
an anchored item when there is a text insertion point (instead of
➅ Insert as Inline
the text content of the field being inserted). An offset from the
➆ Y Offset
baseline can also be specified by choosing the name of the field
containing this information in the pop-up menu.
If the field contains a full path to the image, the folder location does
not need to be specified.
If the field contains only the filename of the image to import, the
folder location should be specified:
To choose the image file folder location, press the ‘Choose’ button.
The Content Location field can also be built dynamically using the
contents - or parts of - other fields: e.g.:
In this example, the Content Location folder path will be built using
the fourth and fifth characters of the ‘code’ field. All of the ‘String’
functions shown in the Custom Fields Reference chapter can be
used in the Content Location field to build a path to the image.
Extension
If the field contains a full path to an image - including the file extension
- the ‘Extension’ field should remain empty.
If the field contains a filename without the file extension, the extension
should be specified in the ‘Extension’ field. To specify that all image
files have a ‘.jpg’ file extension, for example, specify ‘.jpg’ in this
field.
PICTURE IMPORT Multiple file extensions can be specified by separating them with a
semi-colon: e.g.
OPTIONS
(CONTINUED) jpg;gif;tiff
URL
The Image URL field can also be built dynamically from the contents
of the record’s other fields. For example:
http://www.65bit.com/images/FIELDSTR(key).jpg
A new menu option is available - ‘Images’ - when any of the fields in the
panel are configured to retrieve from a URL
Download All
Download and cache all images referenced in the panel.
Download Missing
Download images referenced in the panel that have not previously been downloaded.
Replacement Image
Where the image for this field can not be found, the image specified
by the ‘Replacement Image’ setting will be imported. For example,
an ‘Awaiting Photo’ image could be specified here for use when the
correct image is missing.
If the replacement image is used, the field will still be shown as being
in error during a ‘Synchronise with Document’ operation.
DATABASE UPDATE The options shown here are used in conjunction with the ODBC Data
Provider, and are covered separately in the ODBC Data Provider
manual.
ADVANCED OPTIONS The “Advanced Options” pane contains settings that ordinarily will
not require any adjustment.
Field Group
This field will not be updated in the panel when using the ‘Update
Panel’ function from the data panel’s pop-out menu.
This field will not be updated in the document when using the ‘Update
Panel’ functionality.
This option will populate any empty fields in the column with data
from the first non-empty field above it in the data. This option is
commonly used when only the first record in a group contains the
grouping information:
These two columns only contain grouping data for the first record in each group.
The ‘Fill Down’ option has populated all empty fields with data from the first
populated field above in the column. These columns can now be used as part
of the grouping configuration.
This option takes effect from the next time the data is retrieved using
the ‘Synchronize with Data Source’ option.
Export...
When you are happy with your Field Options configuration, you can
export these settings to a file - this file can either be imported on a
different machine (reducing configuration time on each workstation),
or can be imported in the event of you having to recreate your data
source.
Import...
Select the Field Options file to import - fields are matched by name,
and fields that are missing from your current data will be ignored. You
must therefore also ensure that field names do not change between
exporting your Field Options and re-importing them.
CHAPTER 4
When placed in the document, the formatting tags will be removed and the
appropriate attributes will be applied.
i
Formatting tags apply to all fields in the data-
source that have the ‘Formatted’ Alphanumeric
Field Option set (see ‘Field Options’).
DEFAULT
FORMATTING TAGS
!
The following default tags are only defined for
fields configured as ‘HTML’ in Field Options.
Tag
Default Configuration
Open Close
A bold font-style will be applied to the text
<b> </b>
within the tags.
An italic font-style will be applied to the text
<i> <i>
within the tags.
An underline font-style will be applied to the
<u> </u>
text within the tags.
Superscript will be applied to the text within
<sup> </sup>
the tags.
Subscript will be applied to the text within the
<sub> </sub>
tags.
Strike-through will be applied to the text within
<strike> </strike>
the tags.
The text within the tags will be placed in its
<p> </p>
own paragraph.
<div> tags will be imported in the same way
<div> </div>
as the <p> tag.
The <ol> tag defines an ordered (numbered)
<ol> </ol> list. Items within the list should be inside of
<li> tags.
The <ul> tag defines an unordered (bullet) list.
<ul> </ul> Items within the list should be inside of <li>
tags.
Define an item within an ordered or unordered
<li> </li>
list.
The <em> tag is imported in the same way as
<em> </em>
the <i> tag.
The <strong> tag is imported in the same way
<strong> </strong>
as the <b> tag.
<br/>
Inserts a carriage-return character
<br>
i
Any other tags not shown above or defined in the
Formatting Tags dialog will be stripped from fields
defined as ‘HTML’ in Field Options.
Status Column
The status column shows whether the style-sheet used by the tag is
available for use in the current (front-most) document.
If the status column is red, the required style sheet is not available.
When placed in the document, the tag will be removed from the field
content and formatting will not be applied.
Tag
The tag shown here will be stripped from the field content when
placed in the document, and the action shown will be applied to all
text following the tag.
Action
The action shows the attributes that will be applied to the text when
the tag is encountered in the field content. Stylesheets, or just the
attributes of them, can be applied or removed from the text that
follows the tag.
CREATING A NEW TAG To create a new tag, click the ‘Add’ button on the ‘Field Formatting
Tags’ dialog.
➄ ➃ ➂➁
➀ Name
The name of this tag as it appears in the field content.
➁ Affects
Tags can either affect attributes applied to the paragraph, or the
characters within the paragraph.
➂ Action
Action Description
When this tag is encountered in the text, the stylesheet defined
Apply Stylesheet
below will be applied to the text.
When this tag is encountered, only the overrides defined by
this stylesheet (as shown in ➄ below) will be applied to the
Apply Overrides text. The actual stylesheet is not applied to the text, therefore
later modifications to the stylesheet will not affect the text in
the document.
The overrides (shown in ➄ below) will be removed from the
Remove Overrides
text.
➃ Stylesheet
This style-sheet defines the text attributes to apply to the text. Where
‘Affects’ is set to ‘Paragraph Attributes’, a list of paragraph style
sheets will be shown here; where ‘Affects’ is ‘Character Attributes’, a
list of character style sheets will be shown.
EDITING A TAG To edit a tag, either double click the entry in the
Field Format Tags dialog, or select the tag and
hit the ‘Edit’ button.
DELETING A TAG To delete a tag, select it in the list and hit the
‘Delete’ button.
IMPORTING TAG Use the ‘Import’ button to import tag definitions previously exported
with the ‘Export’ button. Exisiting tag definitions shown in the dialog
DEFINITIONS
will be replaced with those in the file.
CHAPTER 5
EASYCATALOG PANELS
INTRODUCTION The EasyCatalog panel is your view on the snapshot of data acquired
by a Data Provider. Using a spreadsheet-style appearance, the data
in the panel can be sorted, grouped and filtered to make working
with large volumes of data easy.
Multiple panels can be open for the same data source, each with
different filters, columns, sort orders and groups applied to the same
source data.
Multiple data sources can also be open at once, allowing you to work
on publications that require data from a number of sources.
OPENING A NEW
➀ A new panel will be
EASYCATALOG DATA created after creating a
PANEL new data source
➁ Select an existing
data source to create a
new panel
➂ A new view of the data can be created by using the ‘New Panel’
menu option on existing EasyCatalog panels.
PANEL OVERVIEW The EasyCatalog panel shows a wealth of information and offers a
variety of ways to manipulate your data. In addition to showing your
data, each EasyCatalog panel shows status information for each
field and offers sorting, filtering and grouping options.
Data can be grouped in the panel - show or hide the contents of each group by
clicking the disclosure triangle
All fields within this group are placed in the document and their content match the
data source
One of the fields in this group is placed in the document, but its content does not
match the data source
TABLE ROWS Each row in the table shows the current status of
each record and field.
This record has been removed from the source data, and
has effectively been deleted. This record should be removed
from the document.
This record was updated in the source data. The fields that
have changed will be shown in the red dotted outline.
If this column has the geometry icon, the record has a Product
Style associated with it. See ‘Templates and Libraries’ for further
information.
This icon will only appear when the panel is grouped and
indicates that this record is inheriting its Product Style from
the parent group.
STATUS COLOURS The background colour of each row indicates the current status of
each record and field.
Placed fields are shown in dark If one of the record’s fields is placed,
green the entire row will be shown in light
green
A blue dotted outline indicates that the field has been updated from the
document and requires updating in the data source.
One of the fields for this record is placed. The field that is
placed will be shown in dark green or red.
This field was updated when the data was last retrieved
from the data source.
The field in the panel has been updated from the document
and needs updating in the data source.
FINDING FIELDS IN Double-click on a placed field to find it in the document. Only fields
on visible, unlocked, layers will be shown.
THE DOCUMENT
Placed Fields
Error
SELECTING ROWS Entire rows or individual table cells can be selected in the table. The
panel selection affects the behaviour of some of the menu options
AND FIELDS
and buttons on the panel, such as the ‘insert’ button.
Select the entire row by clicking in the status column on the left
Field Selection
Shift Key
Alt
Row Selection
Marquee Selection
!
to its type - therefore, it is important to correctly
configure the field’s type using the Field Options
dialog.
Sub-sorting
Note that the automatic filtering will be removed from a panel once
a row has been dragged – the filter is removed, although only the
records that were visible when the filter was applied will remain.
REORDERING The positions, or order, of columns may be changed for each panel.
COLUMNS To reorder columns, simply drag them into position: click and hold
the mouse button in the header area of the column you want to move.
Drag the column into it’s new position – the position of the drop will
be shown whilst dragging.
To sort the columns into order alphabetically, right (or Ctrl) click in the
panel data area and select ‘Reorder Columns Alphabetically’ from
the contextual menu that appears.
SHOWING AND By default, the data for every field is shown in each panel.
HIDING COLUMNS Each column may also be hidden - the only column that must always
remain visible is the status
column on the left.
FIXING THE POSITION Columns at the left of the panel can be prevented from scrolling
horizontally allowing, for example, your key fields to be permanently
OF COLUMNS
visible in the panel.
Hold the shift key down to drag the divider bar from the left-hand column
Columns that have been fixed will not scroll horizontally with the rest of the
data in the panel.
GROUPING DATA Grouping allows you to group related items of data within the panel
and define complex group and sub-group relationships which can
either be used to make your data more manageable, or represent the
physical layout of your publication. Groups are a powerful feature of
EasyCatalog and are used extensively during advanced pagination.
CREATING GROUPS To group data within EasyCatalog, first make sure the panel contains
the data you wish to group. If the panel data has been previously
filtered, then only items that are visible will be grouped. If you wish
to group all items from the data source, select the ‘Show All’ menu
option to ensure nothing is missed out. Once the data shown is
correct, select the ‘Group...’ menu option. This presents the
‘Grouping Configuration’ dialog.
GROUPING The dialog is split into two sections. The left shows a list of all fields
from the current data source; the right shows the current grouping
CONFIGURATION
configuration.
DIALOG
The ‘Grouping Configuration’ dialog is used to define the hierarchy of your data,
and the sort-order that should be used.
CONFIGURATION To remove a field from the current grouping, either double click
DIALOG on it in the ‘Grouping Configuration’ list or select it and press the
(CONTINUED) ‘Remove’ button.
The order of the groups as they are presented in the source data
can be preserved by selecting the ‘Data Source Order’ option in the
‘Override Default Sorting Prior To Grouping Menu’.
Use this option when you are grouping by a field, such as a group
code or a sort-order, but require a more meaningful field to be
displayed in the panel. For example, you may want to group the data
using a group code field but need a more meaningful ‘group name’
field to be displayed in the panel.
GROUPED PANELS Once a panel has been grouped, any sort options applied to the
panel will work on a group-by-group basis. For example, if the
panel is grouped by ‘Manufacturer’, then sorting by ‘Price’ would
sort by ‘Price’ within ‘Manufacturer’, thereby obeying the defined
groupings.
Data is shown in the panel in a hierarchical form. Click the disclosure triangle to
show and hide sub-groups and records.
Status indicator shows if any or the sub-groups or records are placed
and/or in error
Subsets can also be applied to grouped panels - the subset filter will
behave in the same way as an ungrouped panel, although the results
will appear hierarchically.
HOW SORTING The records, and the order in which they are sorted, can lead to
much greater efficiency when working with document tables.
AND REORDERING
CAN HELP WITH An InDesign table can be created containing the records and fields in
the order they are shown in the panel – therefore, you should reorder
PAGINATION
the records and fields to appear as you want them to look in the
document - see ‘Tables’.
LOCKING A PANEL Individual panels can be locked to prevent any records being added
or removed. Locking a panel does not affect your ability to sort or re-
order the records. Advanced Filters are also removed from the panel
to prevent the content of the panel being affected by a field’s status
changing.
To lock a panel, select ‘Lock Panel’ from the panel’s pop-out menu.
A locked panel can be unlocked simply by selecting ‘Unlock Panel’
from the pop-out menu. Note that filters will need to be reapplied to
the panel after unlocking.
Give your panel configuration a name: this name will appear on the
‘Configurations’ menu
DEFINING A The panel configuration can also be stored so that each time a new
panel is opened via the File→New→EasyCatalog Panel
DEFAULT PANEL
menu, it will have the current configuration options
CONFIGURATION applied.
Use the ‘Save As Default’ button to store the panel’s current configuration as the
default settings for all new panels created for this data source.
Closing a Panel
When you have permanently finished with a panel, use the ‘Close
Panel’ pop-out menu option. Once closed, the panel’s configuration
(such as sorting, grouping, etc) will be lost unless you have saved
it as the default configuration for the data source, or as a named
configuration (see above).
CREATING A NEW EasyCatalog allows multiple views of the same data source, each
with different subset filters, grouping and sorting configurations.
VIEW OF THE DATA
A new panel can be created using the ‘New Panel…’ panel menu
option. Give the panel a name, and use one of the four options to
specify its content. The name of a panel need not be the same as
the name of the data source.
Create a new panel using the ‘New Panel...’ menu option. Give the new panel a
name and specify which records should be copied to it.
Option Description
A new panel will be created containing the same records
Exactly the Same
and grouping as the existing panel.
Only the records selected in the panel will be present in the
Panel Selection
new panel.
The new panel will contain all of the records for this data
All Items
source.
A new, empty, panel is created. To populate this panel, drag
Empty records from an existing panel to it or use the subset options
to specify the data that should be used to populate it.
CHAPTER 6
FILTERING DATA
INTRODUCTION EasyCatalog makes working with large volumes of data easy - using
a simple query builder from within EasyCatalog, your data can be
filtered to show only the records you need to use.
FILTERING ON FIELD Subsets are defined by a simple field, operator, value configuration
dialog - to apply a simple filter to a dialog, select ‘Show Subset...’
CONTENT
from the panel menu.
➄ ➅ ➆
➀ Search Entire Data
All of the data from the data source will be searched.
➀ Search Currently Shown Items
Only the data currently visible in the panel will be filtered. Filter
definitions created using this option can not be saved.
➁ Field Popup
A list of all fields for the data source will be shown in this pop-up.
➂ Operator Popup
The operators ('Less than', 'Greater than', etc) shown in this pop-up
menu are determined by the field type (as defined in Field Options)
for the field selected in the field pop-up.
➃ Save As...
Save this filter definition. You will be prompted for a name, which will
appear in the ‘Saved Subsets’ menu on the EasyCatalog panel.
➄ Match All (logical ‘and’)
All of the search criteria must be satisfied to allow the record to pass
through the filter. In the example above, ‘Parent Category’ must be
equal to ‘Electrical’ and ‘Inc VAT Price’ must be less than 500.
➄ Match Any One (logical ‘or’)
Any of the search criteria must be satisfied to allow the record
through. In the above example, ‘Parent Category’ must be equal to
‘Electrical’ or ‘Inc VAT Price’ must be less than 500.
➅ More Choices / Fewer Choices
Query criteria can be added or removed using these buttons. Up to
a maximum of five criteria can be defined for a single subset.
➆ Show Entire Group
This option is only available for grouped panels. When checked, the
entire group will be displayed if any of the records within the group
match the criteria specified.
ADVANCED SUBSETS In addition to simply filtering by the value of field from the data source,
‘Advanced Subsets’ can be defined which include information about
each record’s status, and are applied in addition to any other filters
already applied to the panel.
The top area of the dialog allows the data to be filtered based
on each record’s status after a ‘Synchronize with Data Source’
operation.
All of these options refer to what happened to the data the last time
it was synchronized with the data source, via the ‘Synchronize with
Datasource’ menu option.
Option Description
Unchanged Show records that were not modified
Show the records that were created as a result of the
New synchronisation process - i.e. they were not present in the
data snapshot before synchronisation, but are now.
Show the records that were removed during the synchronisation
- i.e. records that were present in the data snapshot, but are
Deleted not now. Note that records are not removed from the snapshot
during synchronisation - they are marked for deletion until
purged by the user.
Updated Show the records that changed during synchronisation.
SAVED SUBSETS The ‘Saved Subsets’ menu option shows all previously saved filter
definitions.
To apply one of the subsets, select it from the menu. Note that any
existing filter will be replaced with the saved definition.
AUTOMATICALLY In addition to listing the saved subsets, this menu also allows you to
automatically create subset definitions based on the content of one
CREATING QUERIES
of the data source fields.
Select the field that you would like to automatically create filters for. A filter will
be created for each unique value in the selected field - each individual filter will
only show records for a particular department, for example.
A filter has been created for each unique 'Dept' name - equivalent to creating a
filter definition of ‘Department is ...’ for each department value.
REMOVING A FILTER A subset can be removed from a panel by selecting the ‘Show All’
menu option. Note that the subset definition will be lost, so be sure
FROM A PANEL
to save it before selecting ‘Show All’.
CHAPTER 7
SYNCHRONIZING
INTRODUCTION EasyCatalog offers bidirectional linking of data to the InDesign
document - any changes made to the source data can be reflected
to the document, and any changes made to the document can be
sent back to the source of the data.
GETTING THE LATEST EasyCatalog works with snapshots of data - an internal picture of the
data that was taken at a moment in time. When data changes at its
DATA
source the snapshot needs updating.
The data will be retrieved from its original source and compared
against the existing snapshot. All changes will be shown in the data
source’s panels, and will remain until the next ‘Synchronize with Data
Source’ operation.
Any new records are shown with the new icon in the status column.
Any records that are have been removed from the data source are marked as
deleted. All records that have been marked as deleted can later be removed
once deleted from the document.
Where fields have been updated, the record is shown as updated in the status
column, and each field that changed is highlighted with a red broken outline.
UPDATING THE The document can be updated with a single click - each EasyCatalog
panel offers various options for updating the entire document, or
DOCUMENT
parts of the document.
Three options are available that determine the scope of the document updates
Any fields that are updated will have their field markers changed
back to green to indicate that the field is no longer in error.
All
Update the entire document
Selection
Update those fields that are selected in the document.
Hold down the shift key whilst selecting any of the above menu
options to re-apply pagination rules such as 'Fit Box to Text'. This
option is only available when the Pagination Module is loaded.
Right click (or Ctrl-click on Macintosh) in the column you would like
to update in the document and select the 'Update All (field name)
Fields In The Document' menu option.
CHECKING FOR The content of the document can be checked to ensure that its
content matches the data from the data source.
ERRORS
Any discrepancies found will be highlighted in the document with
red Field Markers, and the field will also be shown in the red in the
EasyCatalog panel.
Text Content
Text content must match exactly the content from the data source -
numeric fields must also be in the correct format.
Field markers, which are normally shown in green, will be changed to red for all
fields which are in error.
Picture Content
CHECKING FOR • If the ‘missing image’ has been used, as the correct image for
a field was missing.
ERRORS
(CONTINUED) Picture frame labels are also shown in red if the picture in the box is in error.
HOW DOCUMENT When fields have changed on the database, EasyCatalog intelligently
applies the changes to the document - rather than replacing each
FORMATTING IS
field in the document in its entirety, new content is merged into the
PRESERVED existing document content. This helps to preserve any formatting
that may have been applied to any of the characters in the field.
If the document needs updating, the updates are merged into the document to
help preserve any formatting that may have been applied. Here, the ‘.99’ is in
superscript. The field should read ‘£24.00’ - EasyCatalog will merge the changes
and only replace the last two characters.
Only the last two characters have been changed - rather than replacing the
entire contents of the field which would have resulted in all characters being
formatted the same.
This is how the field would have looked if all characters had been replaced, and
illustrates the importance of only applying the differences to the document.
!
will only be preserved for Formatted or HTML-
encoded fields when the 'Updates Preserve Local
Formatting' option is enabled in Field Options.
UPDATING THE The link between document and data is bidirectional - therefore, any
changes made to the document can be reflected back to the panel
PANEL FROM THE
(and the original source of the data, such as the database).
DOCUMENT
Note that if a field is placed in the document twice, the last occurrence
of the field will be used as the content for the field. Also, only the
front-most, current, document will be used to update the panel.
All
Selection
Update the fields in the panel that are selected in the document.
Right click (or Ctrl-click on Macintosh) in the column you would like
to update in the panel and select the 'Update All (field name) Fields
In The Panel' menu option.
i
Only data shown in the panel can be used to
update the data source - therefore, you should
‘Update Panel’ prior to ‘Update Data Source’.
UPDATING PAGE The page number(s) where each record appears can stored in one
of the record's fields using the ‘Update Panel→With Page Numbers’
NUMBERS
menu option.
➀➁➂➃
➄➅➆
➀ Search For: Field
Option Description
All fields for a record will be searched for in the document.
All When one is found, its page number will be used to update
the 'Update' field.
The document will be searched for the specified field, and the
Field Name page this field is placed on will be used to update the 'Update'
field.
➂ Update : Field
Nominate the field that should be updated with the page number the
record is placed on.
➃ Update : Records
Option Description
All All records in the data source will be updated.
Panel Selection Only the records selected in the panel will be updated.
➄ Populate With
Option Description
The page number that the record first appears on will be
First Page
used.
The page number for the last occurrence of the record will be
Last Page
used.
A list of all pages numbers for all instances of the record will
be stored in the field.
All Pages
For example, if a record appears on pages 1,2,3 and 5 the field
will be updated with “1-3, 5”.
If your data panel is grouped, this option will update all records in
each group with a list of the page numbers for every record in the
group. This option would be used, for example, to get a list of pages
that all records in a particular category appear on.
➆ Only update records in current document
By turning this option on, only the records placed in the current
document will have their page numbers updated. If this option is off,
any records not placed in the current document will have their page
number fields emptied.
➀ Select any field or record in the panel you would like to update.
UPDATING DATA WITH The panel can also be updated with the X and Y position of each
record in the document using the 'Update Panel → With Page
PAGE POSITIONS
Positions' menu option. The X and Y position of the frame containing
the field will be used to update the panel (not the position of the field
within the frame).
➀➁
➂➃➄
➀ Search For: Field
Limit the update to searching for a specific field (rather than any field
for the record) and whether only text fields, picture fields or both
types should be searched for.
Option Description
All fields for a record will be searched for in the document.
All When one is found, its position will be used to update the
'Update' field.
The document will be searched for the specified field, and the
Field Name position of this field is placed on will be used to update the
'Update' field.
Option Description
Both text and picture boxes will be searched for a field for
All
each record.
Text Only text boxes fields will be searched in the document.
Picture Only picture boxes will be searched in the document.
PAGE POSITIONS Nominate the fields that should be updated with the position of the
(CONTINUED) 'Search For' field.
➄ Update : Records
Option Description
All All records in the data source will be updated.
Panel Selection Only the records selected in the panel will be updated.
Once the panel has been synchronized with the document, the
original data source can be updated. The source of the data will
determine how it is updated.
File-based data
A file ‘Save As’ dialog will be displayed. In the normal manner, enter
a file name and select where you would like the file to be saved. The
format of the file will be the same as the original input format.
EasyCatalog also tracks the fields that have been updated - those
that were changed in the panel. The fields that will be updated are
shown with a blue dashed outline in the EasyCatalog data panel.
Only the fields that have been changed will be updated on the database
- resulting in faster update times through fewer transactions.
!
configured will be updated on the database.
Ensure that the 'Update Using Statement' check
box is set in the Field Options.
CHAPTER 8
PAGINATION BASICS
INTRODUCTION EasyCatalog offers a number of pagination options - from the simple
insertion of single fields into text, right through to designing complex
‘Product Styles’ and the automatic creation of page content.
SINGLE FIELD The simplest of all pagination options, a single field can be inserted
by simply selecting the desired field in the EasyCatalog panel and
INSERTION
hitting the ‘insert’ button.
The current document selection will determine whether the field text
is inserted, or a picture imported for the field.
Inserting text
If there is a valid text insertion point in the document, the field content
will be inserted. This method is useful for constructing documents
where records do not appear in a structured manner and field text
must be inserted into normal text runs.
Any character style sheet which has been defined for a field (in Field
Options) will be applied to the field text.
Green ‘Field Marker’ characters will also be inserted around the field
content - these markers are non-printing and are used to designate
where the field content is in the document. After a document
synchronization, these field markers will appear in red when the
document content does not match the data source content (see
‘Synchronizing’).
Ensure that there is a valid text insertion point, select a single field in the
EasyCatalog panel and hit the insert widget.
Field markers are non printing and are zero-width, and are used to
track the content of fields in the document.
Individual field marker characters can not be deleted - they can only
be removed if both the start and end marker characters are included
in the selection.
Field content is shown between green, or red, field markers in the document
Field marker characters can only be deleted if the entire field is selected. As
this selection range does not encompass the entire field, the start field marker
character will not be deleted
All characters other than the marker character have been deleted.
INSERTION If an empty picture frame is selected, the picture will be imported for
(CONTINUED) the selected field.
The content of the field determines the name of the picture file that
will be imported. To find the picture file, EasyCatalog will attempt to
import the image from the following locations:
Missing Images
In the event of the image file not being found in any of the above
locations, the ‘Replacement Image’ image will be imported (if
specified in Field Options). In the event of the ‘Replacement Image’,
or no image, being imported, the field will be shown as being in error
in the document and in the panel.
SINGLE FIELD
INSERTION
(CONTINUED)
If the picture can be found, it will be imported, aligned and scaled as defined by
the Field Options
i
If the correct image for a field can not be found, the
‘Replacement Image’ specified in Field Options
will be used.
SHOWING AND The appearance of the field markers when designing your document
can be specified using the ‘Show/Hide Field Marker’ panel menu
HIDING FIELD
option. This viewing preference is a document-based preference
MARKERS - therefore, the visibility setting of the markers will remain with the
document.
The visibility of the field markers does not affect EasyCatalog’s ability
to update document content, or the user’s ability to delete them - the
markers are there, but invisible.
Field Markers will also not show when viewing your document in
‘Preview’ mode or on frames when “Hide Frame Edges” has been
used.
Relinking Fields
Open the document that was created with your old data source.
Fields in this document will be re-linked to a new data source.
➲ Create your new Data Source
Either create your new data source, or open the panel that you want
to link the document to.
Fields in the document will be linked to the new data source - fields
which were relinked correctly will be shown as green or red in the
new panel.
REPLACING FIELD EasyCatalog allows the content of one field to be substituted with the
content of another from the same data source. Field replacement is
CONTENT
useful for producing multiple versions of the same document, using
different pricing for instance.
Replacing Fields
The panel will update to show that the old field (the ‘Search For’ field)
has been replaced with the new field (the ‘Replace With’ field). Only
fields on unlocked layers will be replaced.
REMOVING FIELD To remove field markers from the document - effectively unlinking it
from the data - use the ‘Remove Field Markers’ menu.
MARKERS
!
Removing Field Markers breaks the link between
the document and the data permanently.
All
All Field Markers will be removed from the document.
MARKUP FIELD If you need to link existing document content to a field in the panel,
use the ‘Markup Field’ keyboard short-cut.
Select a field in the panel and the content in the document to link to
Use the keyboard short-cut assigned above to link the document content to the
selected field
CHAPTER 9
Field Specifiers are not linked to a data source - they simply specify
the name of a field to use. Therefore, templates and libraries can be
used with multiple data sources, provided the field names exist in
each of the data sources.
INSERTING FIELD To insert a Field Specifier, select the required field from the ‘Field
Specifiers’ menu on the EasyCatalog panel. The current document
SPECIFIERS
selection will determine the behaviour of this menu option:
The current document selection determines how a Field Specifier will be inserted
into the document.
INSERTING FIELD A Field Specifier is a place-holder that shows EasyCatalog where, and how,
SPECIFIERS fields should appear when paginated
(CONTINUED)
During pagination, the ‘Description’ field will appear here. All formatting settings,
such as font and size will be retained.
The Field Specifier has been replaced by a standard EasyCatalog field after
pagination which is tracked in exactly the same manner as other fields.
During pagination, the text content of the Field Specifier tag will be
merged with the field that is being placed. This merging process
offers a further powerful level of control over formatting, which is
best explained using the example shown below.
INSERTING FIELD
SPECIFIERS
(CONTINUED)
Here, we are ‘showing’ EasyCatalog how a typical price should appear. The
last three characters (‘.99’) have superscript applied, although any character
formatting including font and size changes could have been used.
The field content ‘£13.20’ was The field content ‘£29.99’ was
merged with the content already in merged with the content already
the document ‘9999.99’. By only in the document ‘9999.99’. Here,
replacing the characters it needed EasyCatalog simply replaced the initial
to, EasyCatalog has preserved the ‘999’ with ‘£2’.
formatting of the field.
SPECIFIERS The frame will be tagged with the name of the selected field. During
(CONTINUED) pagination of a record, the picture for each tagged frame will be
imported. The importing of pictures for Field Specifiers behaves in
exactly the same way as inserting a field directly into a picture box.
CONVERTING FIELD Field Markers in the current document selection can be converted to
Field Specifiers using the ‘Convert to Field Specifiers’ menu option.
MARKERS TO FIELD
SPECIFIERS Text Field Markers
The text content between the blue marker characters will be replaced
with the field name.
The picture frame will update to show the name of the field; any
image inside of the box will be removed.
Use the ‘Convert to Field Specifier’ menu to convert Field Markers to Field
Specifiers
The content of text Field Specifier is replaced with the field name; picture Field
Specifiers show the field name and any image content is removed.
All boxes that should be populated with fields for a single record
should be placed in the same InDesign group (using the Object→Group
menu)- this grouping identifies to EasyCatalog the boxes that make-
up individual records. This step is critical to ensuring that EasyCatalog
uses the same record when populating individual fields in the group.
This grouping is referred to as a ‘Product Style’.
Create the Product Style using standard InDesign tools, placing Field Specifiers
where field content should appear.
Here, a frame-based
Field Specifier has
been used. The scaling,
alignment and other
field options for the
‘Stock Code’ field will
be used to import the
picture. Field Specifiers can appear anywhere text can -
here they are inside an InDesign table
Drag a single record to any box in the Product Style. The Field
Specifiers will be replaced with field content (in the case of text-
based Field Specifiers), and pictures will be imported (for frame-
based Field Specifiers).
Dr
Boxes for the Product Style ag
are grouped - if they are not,
only the box dragged to will be
populated with record data
EASYCATALOG ➀ Design a single Product Style in the document, using the standard
LIBRARIES InDesign tools and inserting Field Specifiers for each of the fields
that should appear. Product Styles are designed in the same way
as for templates (above).
Dr
to the EasyCatalog
Library.
EASYCATALOG ➀ Ensure that the ‘EasyCatalog Library’ menu option is set on the
LIBRARIES library.
(CONTINUED) ➁ Select the record that should be used to populate the library item
in one of the EasyCatalog panels.
➂ Drag the required library item to the page. When dropped, each
Field Specifier in the library item will be replaced with field content
in exactly the same way as paginating a template (above).
Dr
➁ Drag the library item ag
to the document - when
dropped in the document, Field
Specifiers will be replaced with
the selected record content
ASSOCIATING Product Styles can also be associated, and stored against, individual
records from the data source. This association allows the decision of
PRODUCT STYLES
how a record should appear to be made early on in the production
WITH RECORDS process, and the actual pagination can occur much later - even by a
different user.
Drag
This record can now be paginated by dragging from the status column to the
document
Drag
PAGINATION
ATTRIBUTES
i These advanced pagination options are
only available with the optional EasyCatalog
Pagination module.
AUTOMATICALLY The size of text and picture boxes can be automatically adjusted to
fit their content by applying the ‘Fitting’ attribute from the Pagination
ADJUSTING THE SIZE
Rules panel.
OF BOXES
The box can be resized horizontally, vertically or in both directions.
DELETING BOXES Boxes within the Product Style can be deleted based on the contents
of one of the fields being used to populate the style.
BRINGING BOXES TO The z-order of boxes can also be adjusted by applying an Action
from the Pagination Rules panel. This option is useful where you
THE FRONT
have multiple boxes defined in your style, but only want one to be
visible (by bringing it to the front) based on the contents of one of
your fields.
CHAPTER 10
TABLES
INTRODUCTION EasyCatalog offers a number of options to insert tabular content
into the document. Records and fields are inserted into the table in
the order they are shown in the panel, so by re-ordering and sorting
the data you can define how you want your table to appear before
placing it in the document.
SIMPLE TABLES Simple tables are ideal for situations where you want to quickly insert
a table and manually reformat it later. Inserting a table is as easy
as selecting the records and fields to insert in the panel and hitting
the ‘insert’ button. The CS3, CS4 and CS5 versions of EasyCatalog
apply the default table style ‘[Basic Table]’ to the inserted table.
Prior to inserting your table, you need to ensure that the data in your
panel is in the order you would like it to appear in the table. For
example, if you want your records to be inserted in ascending price
order ensure that the panel is sorted by the price field.
New tables can only be inserted when you have a valid text insertion
point that is not within an existing table.
Table headers
are automatically
created using
the names of the
selected fields
Insertion point
The data from the panel has been inserted into the document table:
These fields have not been placed due to insufficient space in the table
EASYCATALOG EasyCatalog also allows the use of tables within Product Styles.
DESIGNING THE As with all Product Style components, design the table using the
standard InDesign tools - apply cell and row attributes as necessary,
TABLE
and insert Field Specifiers into the table cells where field content
should eventually appear. Again, attributes can also be applied to the
Field Specifiers to adjust the appearance of the fields.
Header rows will be populated with data for the first record used in the table
Records are inserted into the table in the order in which they appear
in the panel - therefore, ensure that the records in the panel are sorted
in the order that they should populate the table. See ‘Simple Tables’,
above, for more information on configuring the panel.
DESIGNING THE Where a table row contains cells that have been merged vertically, all rows
TABLE spanned by the merged cell(s) will be populated with data for the same record.
(CONTINUED) These cells have been merged vertically
Although these Field Specifiers are on different table rows, they will be
populated with data for the same record
Tables can also be populated by dragging a group from the panel to the
document. The table will be populated with all records within the group.
POPULATING THE EasyCatalog Tables can be used in template documents and may
also form part of an EasyCatalog Library item.
TABLE
Tables within Templates
Select all of the records that should populate the table - groups can
also be selected, in which case the table will be populated with all
records within the group(s). To populate the table, simply drag the
records/groups from the panel to the document.
If the table forms part of a Product Style grouping, drag all of the
records that should populate the table to any box in the group. Any
fields that are outside of the table, including in a different box, will be
populated with the fields from the first record.
To populate the table, drag the records from the panel to the document
DR
AG
The Field Specifiers in the table have been replaced with field content, and
the table has been expanded to accommodate the amount of data dragged
TABLE Select all of the records (in the panel) that should be used to populate
(CONTINUED) the table. When the library item is dragged to the document, any
EasyCatalog tables in the item will be populated with all of the
selected records - any fields outside of the table will be populated
with the fields for the first selected record.
DR
AG
The table has been populated with all of the records selected in the panel
ADVANCED TABLE Properties can also be assigned to table cells, rows and columns
that allow you to define additional behaviours that affect how the
OPTIONS
table will appear after pagination. For example, using the Row
Options, the grouping hierarchy of the EasyCatalog data panel can
be inserted into a table by including header and footer rows for each
group.
GROUP HEADER AND The hierarchy or grouping of the EasyCatalog data panel can also be
used to populate a table. Rows can be inserted at the start and end
FOOTER ROWS
of each group defined in the panel using the ‘Table→Row Options’
dialog:
➂ ➁ ➀
By default, each row in the table will be populated with data for the
records shown in the panel.
Using the ‘Row Options’ dialog, you can tell EasyCatalog that the
selected row(s) in the table should appear once per group, at the
start of the group (as a header) or at the end of each group in the
table (as a footer) using the ‘Insert’ pop-up ➁.
➀ Group Menu
Select the point in the grouping hierarchy where this row should
appear. For example, if you require a header row at the start of each
‘Manufacturer’ group select ‘Manufacturer’ in the pop-up.
➂ Allow Single Instances
The header row has not been inserted, as the table only contains data for a single
manufacturer
REMOVING EMPTY Table rows can be removed from the table if they are empty or the
fields they contain are empty.
ROWS
➀➁ ➂
Delete... Description
➀ Never The row will not be deleted after population.
➁ When Fields The row will be deleted only if the EasyCatalog fields in the
Are Empty column are empty, even if there is other text in the cells.
➂ When Cells Are Every cell in the row must be completely empty for the it to
Empty be deleted.
AUTOMATICALLY Adjacent table cells can be merged together if their content matches
after being populated with data.
MERGING CELLS
Using the ‘Table→Cell Options’ dialog, each cell can be configured to
merge horizontally and/or vertically.
MERGING CELLS Cells can be merged automatically if their contents match exactly.
Cells will not merge across the groups configured in the EasyCatalog
panel, regardless of whether group rows have been inserted into the
table.
Table cells will not be merged vertically across different groups. In this example,
the bottom cell was not merged into the cells above because it belongs to a
different group in the panel.
➀
➀ Delete
The options here determine when the column will be deleted, and
what constitutes a column being considered to be empty:
Delete... Description
The column will never be deleted automatically after
Never
pagination.
When Fields Are The column will be deleted only if the EasyCatalog fields in
Empty the column are empty, even if there is other text in the cells.
When Cells Are Every cell in the column must be completely empty for the
Empty column to be deleted.
‘When Fields Are Empty’ will only check the contents of the
EasyCatalog fields in the column (it will ignore any other cell
content). In this example, the column would be deleted.
COLUMNS
The last three columns in this
(CONTINUED)
example have been set to delete
when all fields in the column are
empty.
Using these attributes, it is possible to populate the table with data that contains
a variable number of columns. In this example, there are two groups: one
contains data in all three price columns, one contains data in only the first two
RESIZING COLUMNS
Width Description
Fixed The column will never be resized.
The option is only used when columns have been deleted from
Variable the table (see above). Each ‘variable’ column will received an
equal proportion of the width of the deleted columns.
The column will be resized to fit its content between the
minimum and maximum parameters. If the column cannot be
Fit to Content
resized to fit the amount of text, it will be given a width that is
proportional to the amount of text in the column.
The width of the column will be set to the value specified by
Specified By Field
the nominated field.
Except when using the ‘Specified by Field’ option, the width of the
table will not exceed the width of the original table prototype.
AUTOMATICALLY
APPLYING CELL
!
This functionality is not available in the CS2 version
STYLES of EasyCatalog.
Select the field that contains the name of the cell style to apply to the selected
table cells.
CHAPTER 11
AUTOMATIC PAGINATION
i These advanced pagination options are only available with the optional EasyCatalog
Pagination module.
Optionally:
• Filter your data to show only the records you would like to
paginate
• Sort your data so that the records are shown in the order that
you would like them to flow into the document
➂ Paginate
Product Styles are inserted, one after the other, into an InDesign text
flow. A Product Style can be inserted for each group and/or record
shown in the panel’s hierarchy.
Determine the running order of records using EasyCatalog’s filtering, sorting and
grouping features
➀➁ ➂ ➃
During pagination, EasyCatalog will:
➀ Look in the pagination library for an item that can be used to paginate the
‘Parent Category’ group. If one exists, it will paginated and populated with
the contents of this group.
➁ Look for a library item that can be used to paginate the ‘Child Category’
group. If one exists, it will paginated with the contents of this group.
➂ Look for a Product Style that has been configured to be populated with
‘Record Data’. This Product Style will paginated for each record, so in the
example shown above three Product Styles would be inserted.
This stage is also optional, and should be used when your data
should appear hierarchically in the publication. If your data is not
hierarchical, you may skip this step – your Pagination Library should
also only contain a ‘Paginate → Record Data’ Product Style.
• Manufacturer Heading
• Make Heading
• Products
Use the ‘Grouping Configuration’ dialog to group your data to reflect the
hierarchical structure of your publication.
➀ CONFIGURE THE As will be shown later, it is possible to create Product Styles that will
be used at each level in the grouping hierarchy – so, for example, you
PANEL
(CONTINUED) could create a Product Style for a Manufacturer heading, one for a
Make heading, etc. It is also possible to use a different heading style
based on an indicator in your data.
If your data also requires further sorting, use the panel sorting
options to create the correct running order of records (see Chapter
5, ‘EasyCatalog Panels’)
➁ CREATE YOUR Product Styles used during automatic pagination are created in the
same manner as normal, drag and drop Product Styles (see Chapter
PRODUCT STYLES
9, ‘Templates and Libraries’). When using Product Styles during
automatic pagination however, further attributes need to be applied
that identify when a Product Style should be used (at what level in
the hierarchy, for example) and whether any post-processing should
occur, such as resizing boxes. These attributes are applied to the
Product Style using the ‘Pagination Rules’ panel which is available
from the ‘Window’ menu.
Tables
The lowest-level
Product Style, this will
be used to paginate
individual records
We want to insert a
header each time a
‘Parent Category’ group
should be inserted
Similarly, we want to
insert a header for each
‘Child Category’ group
Tables
➂ PAGINATE
➲ Select the records or groups to
paginate. Now choose ‘Paginate…’
from your EasyCatalog Panel pop-out
menu.
TEXT FLOW Mainly used for publications where records flow in one after another,
such as directories or price lists, Flow-based pagination will insert
PAGINATION
your Product Styles into an InDesign text flow.
‘Asset Name’
This option should be used when the source data contains a field
which identifies the name of a library item to use. Further information
on this can be found later in the chapter (‘Choosing Product Styles
based on Field Content’).
Select ‘Master Text Frame’ - this option will create a master text frame on the
A-Master
Macintosh: Hold down the Shift and Option (Apple) keys and click in this area
to override the master text box on the page.
Windows: Hold down Shift and Ctrl whilst clicking and click in this area to
override the master text box on the page.
Paginating into this overridden master text frame will allow the Pagination
Module to automatically insert new pages when required.
POSITIONAL Positional Pagination should be used when your source data contains
information regarding where each Product Style should appear in the
PAGINATION
document.
The options available here allow fields from your data source to be
associated with the attributes required to correctly position your
Product Styles.
Positional Pagination
In this example, we are configuring EasyCatalog to use the ‘y’ field from the data
source to specify the vertical position of the Product Style - the ‘Units’ popup
indicates that any measurements in this field are in points. All measurements
are relative to the top-left of the page
Field Description
Select the field that contains the page number to position the
Page No
Product Style on.
Select the fields that contain the X (horizontal) and Y (vertical)
X Position
coordinates. Change the ‘Units’ popup to specify the units used
Y Position
in each of the fields.
Width These fields are optional, and should be specified if your Product
Height Styles can be resized
Select the field that contains the name of the item in the Pagination
Asset Name
Library to use.
GUIDE-BASED Useful for publications that follow have a ‘grid’ type design, Product
Styles can be automatically positioned at the intersection of page
PAGINATION
guides.
Guide-based Pagination
Guide-Based Pagination
➀
➁
➂
➃
➄
➅ ➆➇➈
Automatically Inserting Pages
Direction of Flow
Direction Description
Product Styles will flow horizontally across the page in the order
specified by the panel until there are no more valid positions. The
Across/Down
Product Styles will then flow across the page along the next valid
horizontal guide below.
Product Styles will flow vertically down the page in the order
specified in the panel until there are no more valid positions. The
Down/Across
Product Styles will then flow down the page along the next valid
vertical guide to the right.
➁ ‘Asset’
The optional gutter parameter will ensure that sufficient space is left
between Product Styles and any obstructions found. This option is
only available when ‘Collision Detection’ is on.
CHOOSING PRODUCT During automatic pagination, the Pagination Module can select
which library item to use from the Pagination Library based on the
STYLES BASED ON
content of one of your fields in the data.
FIELD CONTENT
There are two ways of affecting the library item that is chosen:
On the ‘Paginate...’ dialog, select the the field that contains the name
of the library item to use.
Name each library item using the ‘Information’ button on the library panel. The
name of the library item should match the contents of one of your fields in the
data.
Specify the name of the field containing the library style name in the Pagination
dialog
‘USING MASTER Unlike the other forms of pagination, instead of defining a series of
Product Styles in a Pagination Library, ‘Master Pages’ pagination
PAGES’ PAGINATION
uses Product Styles defined on the document’s master pages.
Both the Product Style - and their positions - are defined by the
document’s master pages. The order that the data flows into the
document is determined by applying the ‘Position Index’ attribute to
each Product Style.
Use ‘Position Index’ to specify the order of pagination on the master page
The order the records will flow into the page or spread is determined by the
‘Position Index’ pagination rule.
1 2 3
4 5 6
Product Styles are placed on the
7 8 9
document’s master pages.
10 11 12
➀
➁
➂
➀ Paginate
1 2 3 1 2 3
4 5 6 4 5 6
7 8 9 7 8 9
10 11 12 10 11 12
1 2 3 4 5 6
7 8 9 10 11 12
13 14 15 16 17 18
19 20 21 22 23 24
Use ‘Position Index’ to specify the order of pagination on the master page
The order the records will flow into the page or spread is determined by the
‘Position Index’ pagination rule.
1 2 3
4 5 6
The ‘Position Index’ attribute specifies
the order that the records or groups
in the panel will be paginated in the
document. If the panel is grouped,
this Product Style will be populated
with the first group selected in the
panel; if the panel is not grouped this Style will be populated with data for the first
7 8 9
record in the panel.
10 11 12
CREATING AN INDEX EasyCatalog provides the ability to update the source data with the
page number each record is placed on. Using this information, it is
possible to generate an index using the Pagination Module.
To generate an index, your source data will need
to include a field to receive the page number
the record is placed on. In most cases, this can
simply be an empty column.
➀ Group and sort your data panel so that the records are shown in
the order you would like the index to appear in.
➂ Paginate your index - typically you would use the ‘Into Text Flow’
pagination type.
CHAPTER 12
i The Pagination Rules panel is only available as part of the Pagination Module which
must be purchased separately.
INTRODUCTION This chapter provides a reference for the attributes available on the
Pagination Rules panel. Using this panel, it is possible to specify
both processing instructions (such as when to use a Product Style
during pagination) and layout instructions (such as fitting each box
to the depth of the text).
USING THE The Pagination Rules panel is split into two sections: the top portion
PAGINATION RULES shows the attributes assigned to the currently-selected box in the
document; the bottom section shows the ‘actions’ that have been
PANEL defined for the box.
Attributes
Actions
Attributes
Attributes are used to define options that are applied to the box
during pagination.gr
Actions
Actions are simple rules that are evaluated at pagination time and
can be used, for example, to delete a box based on the contents of
one of the fields being paginated.
EDITING ATTRIBUTES To modify any of the properties shown in the panel, double click on it
or select it and use the ‘Edit…’ menu on the pop-out menu.
Double-click on a row to edit the attribute or use the ‘Edit’ menu option
APPLYING Some attributes, such as the fitting options, can be applied to any
of the boxes within the Product Style. Other attributes affect how
PAGINATION RULES
the Product Style is used during pagination or how it is placed in
the document - in this instance, the Pagination attribute should be
applied to the Product Style group.
Where your Product Style consists of multiple boxes, group the boxes together
and apply the pagination rule to the group. If your Product Style consists of a
single box, apply the pagination rule to this box.
ATTRIBUTE Paginate
REFERENCE Pagination Types Flow-based, Guide-based, Postional
Apply to Outermost/group box
Dependant Attributes None
Apply this attribute to the outer-most box in the Product Style (if
the Product Style consists of multiple boxes, group them together
and apply this attribute to the group box). This attribute is used
to associate the Product Style with a level in your panel grouping
hierarchy and is mandatory for all types of automatic pagination.
Paginate... Description
The Product Style should be used each time EasyCatalog
Once Per Record
wants to insert an individual record into the document.
Apply this attribute to Product Styles that should be used
when paginating groups. You must set the ‘Group Name’
field to specify which group the Product Style should be
Once Per Group
used for. For example, to specify that the Product Style
should be used to paginate the ‘Manufacturer’ group, set
the Group Name attribute to ‘Manufacturer’.
This attribute is typically applied to page headings that
contain information about the first or last record on a page
Furniture Data
or spread. See the ‘Page Headings’ chapter for more
information.
ATTRIBUTE
REFERENCE When using the Relational Module, the Group
!
(CONTINUED) Name attribute should always be set as a
Relational panel can contain records in multiple
groups.
Group Name
Insert
This option affects whether the Product Style will be anchored in the
pagination text flow or if the text content of the Product Style will be
inserted.
Attribute Description
This option will insert the Product Style as an anchored box
As Inline in the pagination text flow – this is required if your Style
consists of more than one box.
This option must only be used when the Product Style
consists of one text box. Instead of anchoring the Product
Frame Contents
Style in the text flow, EasyCatalog will copy the text content
from the text box and paste it into the pagination text flow.
ATTRIBUTE
‘Insert’ Flow-based Pagination Rule
REFERENCE ‘Frame Contents’ will insert the contents of the Product Style into the
(CONTINUED) pagination text flow.
‘As Inline’ will anchor the Product Style into the pagination text flow.
Paragraph Style
The Paragraph Style Sheet named here will be applied to the Product
Style when it is anchored in the pagination text flow. Using InDesign’s
paragraph style sheets allows typographical controls, such as ‘space
before’, ‘keep together’, etc to be applied to each anchored Style.
Note that the Paragraph Style Sheet specified here must be present
in the document being paginated into.
Append Return
When inserting the Product Style ‘As Inline’, this option specifies
whether to add a carriage-return after the anchored item.
Option Description
The Product Style will be inserted after the previous Product
No Break
Style.
Flow-based and Guide-based Pagination Only
Guide-based Pagination
Option Description
Don’t Prevent The Product Style will be allowed to break across any frame,
Breaking page or column.
The Product Style will not be allowed to break across a
Over Columns column. If it does, a column-break character will be inserted
before the Product Style content.
The Product Style will not be allowed to break across a
Over Pages page. If it does, a page-break character will be inserted
before the Product Style content.
The Product Style will not be allowed to break across a
Over Frames frame. If it does, a frame-break character will be inserted
before the Product Style content.
Fitting
Fit Content To Frame will automatically adjust the size of the box’s
text content until it fits. Both the point size and horizontal scale can
be adjusted until the text fits.
Maximum and Minimum parameters can be specified for point size and
horizontal scale adjustment. All parameters a percentages based on the
size of the text in the box prior to fitting.
Example:
Assuming that before fitting the text box contains 10pt text, the
Minimum Text Size is set to 50 and the Maximum Text Size is set to
150:
If the text is overset, the size of the text will be reduced until all of the
text fits in the box with a minimum point size of 5pt (50% of 10pt).
ATTRIBUTE Otherwise, the text size will be increased until it fits the box exactly,
up to a maximum of 15pt (150% of 10pt).
REFERENCE
(CONTINUED) ‘Grow and Flow’ (Guide-Based Pagination Only)
The ‘Grow and Flow’ fitting option provides the ability for a Product
Style to be split when pagination reaches the bottom of the page.
When applied to a text frame, the ‘Grow and Flow’ fitting option will
expand the text box vertically until all of the text fits in the box, or until
the page’s bottom margin is reached. In this instance, the Product
Style will be inserted at the start of the next page and any frames with
the ‘Grow and Flow’ fitting attribute applied will be linked together,
allowing their text content to flow across the page boundary.
Ungroup
Usage
Pagination Types Flow-based, Guide-based, Positional
Apply to Outermost/group box
Dependant Attributes None
Last Instance
Single Instance
Position
Index 1
When dragging a group of records, the first record will go into the box set with
Position Index 1, the second into Position Index 2, etc.
ATTRIBUTE
REFERENCE
(CONTINUED)
Specify the name of the field in { brackets }. In this example, the record
containing the highest ‘price’ field will be used to populate the box.
Continuation
This attribute will remove any lines in the textual content of the box
that contain only empty fields. This attribute is useful when paginating
data that contains optional values that should not be present when
empty.
White space (tabs, spaces, etc) at the end of the text content in
the box will be stripped after pagination. This attribute is useful for
removing unwanted extra carriage returns.
The Object Style specified by the contents of the nominated field will
be applied to this box during pagination.
This object style is applied only during pagination, so will not change
during an ‘Update Document’ operation if the contents of the
nominated field change.
The nominated field can either contain the name of a swatch to apply
to the box or a hexadecimal value that specifies an RGB colour to
use - e.g.
If the field contains ‘My Swatch’, the swatch called ‘My Swatch’ will
be applied during pagination time; if the field contains ‘#FF0000’ the
box will be coloured red. The format of the field content should be:
#RRGGBB
Option Description
Do Nothing The box will remain in the document when empty.
Delete The box will be removed from the document.
ACTIONS Actions are evaluated at pagination time, and allow you to affect the
appearance of boxes within your Product Style based on the data
being paginated.
Actions can be
added, edited
and deleted from
the Pagination
Rules Panel’s
pop-out menu or
using the buttons
at the bottom of
Delete the panel
Add
When this
expression
evaluates to
true....
ACTIONS For fields defined in Field Options as ‘Alphanumeric’ use the operators listed
(CONTINUED) in the top of the operators pop-up. For numeric field types, including currency
types, use the operators shown at the bottom of the operator pop-up.
Alphanumeric
comparison
operators
Numeric
comparison
operators
Bring to Front
When the action evaluates to ‘true’, the box will be moved to the
front of the document z-order. This action is the equivalent of using
the Object→Arrange→Bring to Front menu option.
Delete
The box will be deleted when the action expression evaluates to true.
Hide
Available in the CS4 and CS5 versions only, this attribute will hide the
box if the action evaluates to true. The box will be shown again if the
action later evaluates to false.
To hide the box in CS4, the box is set to ‘non printing’ and is
transparent; the CS5 version takes advantage of InDesign’s ability to
hide and show individual page items.
ACTIONS Ignore
(CONTINUED)
Pagination Types Flow-based, Guide-based, Positional
Apply to Outermost/Group Box
Dependant Attributes None
SPECIAL FIELD EasyCatalog also offers reserved field names that can be used as the
field name in the action:
NAMES
Field Description
CHAPTER 13
INTRODUCTION Custom Fields provide a way to add new fields to the source data,
the value of which can be computed using predefined functions.
This chapter lists the functions that are available, and gives an
example of their use.
CREATING A NEW New Custom Fields can be created in the EasyCatalog data panel by
CUSTOM FIELD right-clicking (or Ctrl-clicking on
Macintosh) in the data area of
the panel and selecting “New
Custom Field”.
i
Custom Fields can also be used with Relational
Data sources, although they must be created in the
appropriate child data source.
TYPES OF Functions in this reference have been split into four categories:
Math Functions
Logic Functions
Group Functions
As Custom Fields are defined at the data source level, the visible
structure of the data in your panel is not important and cannot be
used to determine the order of records used by the group functions.
Therefore, all group functions typically have two parameters: a group
path and a field to sort the records by. The group path parameter
defines the fields use to group the data.
When using group functions, the Custom Field for all records in the
group will typically (but not always) be populated with the same value.
Example
The ‘GROUPLIST’ function will populate the Custom Field with a list
of all unique values in a specified field. In this example, we want
to create a comma separated list of all “Price”s within each Child
Category group.
COMBINING Multiple functions can be used within the same Custom Field
statement to create complex operations:
FUNCTIONS IN A
SINGLE CUSTOM IF(FIELDVAL('Price'),'>=',1,CONCAT('£',FIELDVAL('Price')),
FIELD CONCAT(FIELDVAL('Price'),'p'))
TYPES OF Each function shown in this reference chapter will expect its
parameters to be of a specific type. These parameter types are:
PARAMETER
Type Description
Specify only the name of the field. Usually, the field name would be
Field
enclosed in single quotes. e.g: LEFTSTR ('Description',5)
Either specify a string literal or use the FIELDSTR command to
String retrieve the contents of another field. e.g.: LENGTH(FIELDSTR('
Manufacturer'))
Either specify a numeric literal or use the FIELDVAL command to retrieve
Number
the numeric contents of another field.IF(FIELDVAL('Price')...
Some functions show a parameter of type '...', which indicates that
... the function accepts any number of parameters. Typically, the type of
these additional parameters is the same as the preceding parameter.
WHAT IS THE The two most commonly used functions are FIELDSTR and FIELDVAL.
If they are being used as arguments to another function, as a general
DIFFERENCE
rule use FIELDVAL if the function is expecting a numeric argument;
BETWEEN FIELDSTR use FIELDSTR if it’s expecting a string.
AND FIELDVAL?
FIELDSTR will return the formatted content of the given field -
including any prefixes, suffixes, number formats, etc. FIELDVAL
will return the raw numeric content of the field excluding number
formatting, prefixes, etc.
Example:
SUBSTR (Description,3,8)
Description SUBSTR(Description, 3, 8)
Apple Computer le Compu
LEFTSTR
This function returns characters from the left (start) of the given field.
Example:
LEFTSTR (Description,5)
RIGHTSTR
This function returns characters from the right (end) of the given field.
Example:
RIGHTSTR (Description,3)
Example:
PARTSTR(images, 2, ',')
EAN13
This function can be used to translate from an EAN13 code into the
correct glyphs in the free ‘eanbwrp36tt’ font.
Example:
EAN13('Stock Code')
The output from this function should be placed in the document and
the ‘eanbwrp36tt’ font applied to its content.
EAN8
This function can be used to translate from an EAN8 code into the
correct glyphs in the free ‘eanbwrp36tt’ font.
Example:
EAN8('Stock Code')
The output from this function should be placed in the document and
the ‘eanbwrp36tt’ font applied to its content.
Example:
LOWER('Description')
Description LOWER(‘Description’)
Apple Computer apple computer
UPPER
Example:
UPPER('Description')
Description UPPER(‘Description’)
Apple Computer APPLE COMPUTER
CONCAT
This function will concatenate (join) the values of all of its arguments
together.
Example:
CONCAT(FIELDSTR(‘Price’),’, Available in
Price Availability
‘,FIELDSTR(‘Availability’))
10.99 2 days 10.99, Available in 2 days
5.99 1 week 5.99, Available in 1 week
Example:
STRIPWHITESPACE
Example:
STRIPWHITESPACE(FIELDSTR('Category'))
TITLECASE
Example:
TITLECASE(FIELDSTR('Category'))
Description TITLECASE(FIELDSTR(‘Description’))
this sentence should appear in title This Sentence Should Appear In Title
case Case
Example:
SENTENCECASE(FIELDSTR('Category'))
Description SENTENCECASE(FIELDSTR(‘Description’))
this sentence should appear in This sentence should appear in sentence
sentence case case
LENGTH
Example:
LENGTH(FIELDSTR('Manufacturer'))
Manufacturer LENGTH(FIELDSTR(‘Manufacturer’))
Apple Computer 14
Example:
INDEXOF(FIELDSTR('Description'), 'Apple')
LASTINDEXOF
Returns the character index of the last instance of one string within
another, or -1 if the first string does not contain the second.
Example:
LASTINDEXOF(FIELDSTR('Description'), 'Apple')
COUNTOF
Example:
COUNTOF(FIELDSTR('Description'), 'pl')
Apple iMac 1
I like Apples 1
Dell Computer 0
Apple iMac by Apple, Inc. 2
CONTAINSANY
Tests to see if the ‘Search In’ string contains any of the strings
specified by the subsequent parameters.
Example:
Example:
Example:
MUL(FIELDVAL(Price),10)
Price MUL
10.00 100.00
15.00 150.00
17.50 175.00
DIV
Example:
MUL(FIELDVAL(Price),10)
Price DIV
10.00 1.00
15.00 1.50
17.50 1.75
MOD
Example:
MOD(FIELDVAL(Price),10)
Price MOD
10.00 0.00
15.00 5.00
17.50 7.50
Example:
SUM(FIELDVAL('Price), 10)
Price SUM
10.00 20.00
15.00 25.00
17.50 27.50
MIN
Example:
MIN(FIELDVAL('Price'),10)
Price MIN
5.00 5.00
10.00 10.00
15.00 10.00
17.50 10.00
Example:
MAX(FIELDVAL('Price'),10)
Price MAX
5.00 10.00
10.00 10.00
15.00 15.00
17.50 17.50
AVG
Example:
AVG(FIELDVAL('Price'),10)
Price AVG
5.00 7.50
10.00 10.00
15.00 12.50
17.50 13.75
Example:
LOGIC FUNCTIONS IF
(CONTINUED)
Unlike the ‘COMPARESTR’ command, the ‘IF’ command also allows
an operator to be specified to make more complex comparisons.
Example:
Example:
OR
This function will return TRUE if the values of any of its arguments
are true.
Example:
Example:
XREFFEILD('PartNo',FIELDSTR('XRefPartNo'),'Page')
This example will search for a record whose 'Part No' field contains
the value of this record's 'XRefPartNo' field. When one is found, the
contents of its 'Page' field will be returned.
GROUPLIST will take values from the nominated field and create a
delimited list.
Example:
Price GROUPLIST
15.00 10.00, 15.00 and 20.00
10.00 10.00, 15.00 and 20.00
20.00 10.00, 15.00 and 20.00
GROUPSUM
Example:
This command will total all of the Price fields within the Child Category
grouping.
Price GROUPSUM
15.00 45.00
10.00 45.00
20.00 45.00
Example:
This command will return the average all of the Price fields within the
Child Category grouping.
Price GROUPAVG
15.00 15.00
10.00 15.00
20.00 15.00
GROUPMAX
Example:
This command will return the maximum value of the ‘Price’ field in
the Child Category field.
Price GROUPMAX
15.00 20.00
10.00 20.00
20.00 20.00
Example:
This command will return the minimum value of the ‘Price’ field in the
Child Category field.
Price GROUPMIN
15.00 10.00
10.00 10.00
20.00 10.00
GROUPFIRST
Example:
This command will first sort the ‘Price’ field into ascending ‘Price’
order and return the first value.
Price GROUPFIRST
10.00 10.00
15.00 10.00
20.00 10.00
Example:
This command will first sort the ‘Price’ field into ascending ‘Price’
order and return the last value.
Price GROUPLAST
10.00 20.00
15.00 20.00
20.00 20.00
GROUPRTOTAL
Example:
This command will process all records within the Parent Category:Child
Category group, sorted by Price. It will then keep a running total of
the nominated field:
Price GROUPRTOTAL
10.00 10.00
15.00 25.00
20.00 45.00
Example:
This function will evaluate to ‘A’ for the first record in the Child
Category group; ‘B’ for the second, etc. Once all vaues in the list
have been exhausted, EasyCatalog will continue with the first,
second, etc.
Price GROUPSEQUENCE
10.00 A
15.00 B
20.00 A
17.50 C
19.00 D
GROUPCOUNTUNIQUE
Example:
Price GROUPCOUNTUNIQUE
10.00 3
15.00 3
15.00 3
17.50 3
17.50 3
This function will evaluate to the same value for every record in the
group.
Example:
Price GROUPCOUNT
10.00 5
15.00 5
15.00 5
17.50 5
17.50 5
This function will evaluate to the same value for every record in the
group.
GROUPSERIES
Example:
Price GROUPSERIES
10.00 10
15.00 110
15.00 210
17.50 310
17.50 410
Example:
Price GROUPCOUNTUNIQUE
10.00 TRUE
15.00 TRUE
15.00 FALSE
15.00 FALSE
17.50 TRUE
17.50 FALSE
GROUPISFIRST
This function returns ‘TRUE’ for the first ‘n’ number of records in the
specified group.
Example:
Price GROUPISFIRST
5.00 TRUE
10.00 TRUE
15.00 FALSE
17.50 FALSE
Example:
Price GROUPSERIESONFIELDCHANGE
5.00 1
5.00 1
10.00 11
15.00 21
17.50 31
GROUPISLAST
This function returns ‘TRUE’ for the last ‘n’ number of records in the
specified group.
Example:
GROUPISLAST('Parent Category:Child Category', 'Price', 2)
Price GROUPISLAST
5.00 FALSE
10.00 FALSE
15.00 TRUE
17.50 TRUE
GROUPCROSSTABLEHEAD
The GROUPCROSSTABLEHEAD function is used to determine the
headers for each column in the table. The value returned by this function
will also be used as a parameter to the GROUPCROSSTABLEVALUE
function to determine the value to display in each table cell.
GROUP FUNCTIONS Like all ‘GROUP’ functions, the scope of this function can be limited
(CONTINUED) to the nominated grouping. This could be used, in this example,
to prevent colours from products belonging to one department
affecting the colours from another. In this example, all products are
in the same parent group so we do not need to specify a group path.
So, assuming that we only ever have three possible colours per
product, we could create three new Custom Fields with the following
functions:
GROUPCROSSTABLEVALUE
GROUP FUNCTIONS In essence, this function is searching the ‘colour’ field for the value
(CONTINUED) shown in the ‘col1’/‘col2’/‘col3’ field. When found, the value in the
‘price’ field will be used; if it’s not found then the literal value of the
last parameter will be used (‘-’) instead.
This data panel can now be used to create a table such as:
product code red blue green
AAA123 $10.00 $20.00 $20.00
BBB321 $15.00 - $25.00
CHAPTER 14
CONDITIONAL PROCESSING
INTRODUCTION ‘Conditional Processing’ is a simple scripting-like language that
allows decisions to be made by EasyCatalog during pagination
operations. For example, content can be inserted or excluded based
on the value of one of the fields being paginated.
Logic statements are included in the standard InDesign text flow and are
processed by EasyCatalog before populating Field Specifiers.
THE ‘IF’ COMMAND The ‘IF’ command is used to include or exclude portions of text in a
Product Style if an expression evaluates to true.
The ‘IF’ command consists of four parts: the command name itself,
two ‘operands’ and one ‘operator’.
The if command must be enclosed within ‘@@’ to distinguish it from other text
The ‘operator’
The ‘operands’ - to compare with the contents of fields, enclose the field
name within { and }
THE ‘IF’ COMMAND The types of the operands must be the same - for example, it is
(CONTINUED) illegal to compare a numeric field to an alphanumeric field. A field’s
type is defined by the ‘Field Options’ dialog.
These fields must be defined in Field Options as the same type - i.e. they
must both be alphanumeric or numeric
Alphanumeric Fields
Numeric Fields
THE ‘ELSE’ Where alternative action must be taken in the event of the ‘if’
expression evaluating to false, the ‘@@else’ command may be
COMMAND
included.
NESTING ‘IF’ ‘If’ statements can be nested within other ‘if’ statements. For
example, the following situation is valid:
COMMANDS
Nesting ‘IF’ commands
SPECIAL FIELD EasyCatalog also offers special reserved field names that can be
used as part of the logic statement to determine, for example, the
NAMES
position of a record within its parent group.
Field Description
Returns ‘yes’ if the record is the first record in its parent
{first}
group; ‘no’ if it is not.
Returns ‘yes’ if the record is the last record in its parent
{last}
group; ‘no’ if it is not.
Returns the index number of the record being paginated
{index} within its parent group - i.e. the first record would have an
index number of 1, the second would be 2, etc.
Returns: ‘yes’ if the index number of the record within its
{odd}
parent group is odd; ‘no’ if it is even.
continued...
NAMES {even}
Returns: ‘yes’ if the index number of the record within its
(CONTINUED) parent group is even; ‘no’ if it is odd.
Returns ‘yes’ if the record being paginated is the only one
{onlyrecord}
in its group.
{countunique Counts the number of unique values for the given field within
fieldname} the record’s group.
{length fieldname} Returns the number of characters in the given field.
Example of ‘countunique’
All operands in the if statement must be of the same type (as defined
in Field Options). When comparing against static values, be sure to
include alphanumeric content in single or double quotes.
It should read:
@@if {mynumericfield} = 123@@
For example, the following example is illegal as there are two @@if
commands but only one @@endif.
@@if {myfield} > 10@@myfield is greater than 10!
@@if {anotherfield} = 1@@anotherfield contains 1!
@@endif@@
CHAPTER 15
PAGE HEADERS
i Furniture options are only available with the optional EasyCatalog Pagination module.
Furniture page items are usually found on master pages, and are
typically used for page headers, etc, that should contain summary
information for the records placed on the page or spread.
DEFINING FURNITURE Furniture boxes are designed on the page using Field Specifiers, in
exactly the same way as Product Styles are defined for EasyCatalog
Libraries. Typically, furniture page items will be included as part of
the master page design to ensure that they are present on each page
of the document after pages have been inserted by Pagination.
Use the ‘Pagination Rules’ panel to define the boxes that should be populated
with Furniture data.
DEFINING FURNITURE ‘Furniture’ is an attribute that is applied to a page item using the
(CONTINUED) Pagination Rules panel. The record data to use to populate the page
items must also be specified using the ‘Populate Using’ attribute.
POPULATING Use the ‘Update Furniture’ panel menu option to populate all Furniture
page items in the document.
FURNITURE
Furniture page items will be populated in the same manner as
Product Styles – Field Specifiers will be replaced with field data.
Once populated, Furniture page items can be updated again at a
later time using the ‘Update Furniture’ menu option.
The Furniture box has been populated with the data for the last record on the
page - the record closest to the bottom-right of the page.
CHAPTER 16
Using the Record Viewer panel, you can view individual records,
quickly filter and place your data on the page. To help to identify
fields already placed in the document, the Record Viewer panel can
also show the record(s) in the current document selection.
THE RECORD VIEWER Using the Record Viewer panel, you can import, filter and place your data
PANEL OVERVIEW in the document.
Use the ‘Data Sources’ pop-up menu to import your data or switch to data
you’ve previously imported
Further options are
available from the pop-
out menu
Quickly filter your data
using the ‘Find’ options.
The index number of the current record is shown here. Jump directly to a
record by entering its number here.
FINDING RECORDS EasyCatalog offers a number of ways to step through the records
from you data source, and can also filter the records shown based
on the content of their fields.
➃ ➁ ➀ ➂
Moving Sequentially through the records
Either use the ➀ horizontal scroll bar at the bottom of the panel,
or use the ➁ left and ➂ right scroll buttons to move a record at a
time. If the panel is filtered using the ‘Find’ options (below), the next/
previous record matching the search criteria will be shown.
By Index number
Jump straight to a record by entering it’s index number into the ➃ edit
field at the bottom of the Record Viewer panel.
➀ ➁ ➂ ➃ ➄
➀ Key Fields
Key fields containing the text entered into the ‘Find’ field will be
shown in the panel. Only records whose key fields contain the text
entered will be shown in the panel. To search for an exact match,
enter the search term in double quotes - e.g. "11SS"
➁ Text
All fields containing the text entered into the ‘Find’ field will be shown
in the panel. To search for an exact match, enter the search term in
double quotes - e.g. "11SS"
➂ Expression
Enter a regular expression into the ‘Find’ field. The complete syntax
of regular expressions is outside of the scope of this documentation,
but a number of tutorials are available on the internet. Examples of
some of the most useful expressions are shown in the table below:
Example Results
^12 Shows all records beginning with ‘12’
12$ Shows records ending with ‘12’
^1.*2$ Shows records that begin with ‘1’ and end with ‘2’
Shows all records that contain ‘1’ followed by any character
1.2
followed by ‘2’
Shows all records that contain ‘1’ followed by any number
1.*2
of characters followed by a ‘2’
➄ Range
Enter a numeric range of record index numbers into the ‘Find’ field.
Ranges and single index numbers are allowed - for example:
1,2,10-20
INTERACTION WITH The Record Viewer will automatically update to show the range of
records selected in any of your EasyCatalog data panels. A ‘Range’
EASYCATALOG
filter will be applied to the Record View panel to allow you to step
PANELS through each of the selected records.
Note that the data source selected in the data source pop-up must
match the data source of the EasyCatalog panel for the filter to be
applied.
INSERTING FIELDS To insert a field, select it in the panel and either use the ‘insert’ button
in the bottom left of the panel. The current document
selection will determine whether the field content is
inserted as text, or if an image is imported.
Picture-box Selection
The picture for the selected field will be inserted into the picture
box. The content of the field determines how much configuration is
required in the ‘Field Options’:
• If the field contains only the filename of the image, such as ‘1234.
jpg’, the ‘Content Location’ must be configured in the field’s Field
Options dialog.
• If the field contains only part of the filename, such as ‘1234’, you
may also need to specify the file type extension (e.g. ‘.jpg’) in the
Field Options dialog.
The frame will be tagged with the key field of the record - this is a
visual aid to help to identify which record a picture belongs to.
INSERTING MULTIPLE Multiple records can be inserted automatically into the document, or
into an existing table, using the ‘Copy and Repeat’ menu option from
RECORDS
the Record Viewer panel’s pop-out menu.
Select the text you want to use as the prototype in the document.
➃ Select ‘Copy and Repeat’ from the Record Viewer panel pop-
out menu.
RECORDS Table rows can also be repeated for each record selected in the
(CONTINUED) Record Viewer panel. Again, by defining a prototype row that defines
how each record should appear in the table, multiple records can be
inserted at the click of a button.
Define a single prototype row in the table, by inserting fields into the
correct cells and applying character and paragraph formatting where
appropriate.
Select the row or rows that should be used as a prototype for all of
the records being inserted into the document. Multiple table rows
can be used for each record being inserted into the table.
➃ Select ‘Copy and Repeat’ from the Record Viewer panel pop-
out menu.
PANEL MENU Inserts the selected field in the document. The same can be achieved
by selecting the field in the panel and using the the ‘insert’ button.
!
the document is in Preview mode, and field
markers on graphic frames will not be shown
when ‘Hide Frame Edges’ has been selected.
Retrieves the latest data for the data source selected in the ‘Data
Source’ pop-up. The data that is imported into EasyCatalog is cached
locally each time a ‘Synchronize with Data Source’ is performed --
this allows you to continue working with data even when the data
source (such as a database) is not currently available.
The current data source can be deleted using the ‘Delete’ button on
the Information dialog. Any open EasyCatalog panels for this data
source will be closed, and the data source will be removed from your
local workspace folder.
Update Document
To ensure your document always contains the latest data from your
data source, or to correct any changes that may have been incorrectly
THE RECORD VIEWER made to data in your document, use the ‘Update Document’ menu
option.
PANEL MENU
(CONTINUED) Only fields which need updating will be updated in the document,
and any character-level formatting will be preserved where possible
by merging the changes into the document rather than replacing the
entire content of the fields.
• All
Update all of the fields in the document.
• Selection
Field Options
About...
Displays the ‘About EasyCatalog...’ dialog, which also allows the
software to be activated once a serial number has been purchased.
CHAPTER 17
CREATING A DATA ➀ The first step is to create a standard EasyCatalog data source,
ensuring that you configure all settings (such as field options, etc)
SOURCE TEMPLATE
that you would want to be used when creating data sources.
Include parameters in the query inside {{ braces }}. These parameters will be
substituted with values entered by the user when creating a new data source
from this template.
CREATING A DATA ➁
SOURCE TEMPLATE
(CONTINUED) ➁ From the data panel you have
just created, use the ‘Close Panel’
menu option.
➂ Go to “InDesign→Preferences
➂ →EasyCatalog” (on Macintosh) or
“Edit→P references→E asyCatalog”
(on Windows).
➃ Press the “Reveal” button at the
top of the dialog that appears.
➄ Go into the highlighted folder.
Inside, you should see a folder for
each of the data sources you have
created.
➅ Move the folder for the data source you just created into the
“EasyCatalog Data Source Templates” folder.
DRAG
CREATING A DATA ➇ At the top of the “File→New→EasyCatalog Panel” menu, you should see
SOURCE TEMPLATE your template listed as a new data source type.
(CONTINUED)
SOURCE TEMPLATE ➀ Drag the template’s folder from the ‘EasyCatalog Data Source
Templates’ folder into your EasyCatalog workspace folder.
➁ Open the data source from the “File→New→EasyCatalog Panel”
menu.
➂ Edit the data source.
➃ Use the “Close Panel” menu option to close the data source.
➄ Move the data source folder into the ‘EasyCatalog Data Source
Templates’ folder.
DELETING A DATA Templates should be deleted by removing the relevant folder from
the ‘EasyCatalog Data Source Templates’ folder.
SOURCE TEMPLATE
CHAPTER 18
REPORTS
INTRODUCTION EasyCatalog provides simple reports showing the contents of the
panel, data source or front-most document.
All reports are generated as XML, and by default all reports generated
will be shown in your default web-browser.
REPORT TYPES EasyCatalog currently offers three types of report, available from
the “Reports” menu, which can be found on your EasyCatalog data
panel.
This report shows all records and fields in the data source in a similar
format to the EasyCatalog data panel.
Panel Report
This report will shown only the records that are in the panel. They will
appear in the same order as the panel obeying any sorting, grouping
and filtering options you have configured.
Document Report
Generates a report showing the links in the front-most document.
The page number the link is placed on, and information about the
data source and key field it is linked to is included in the report.
This report is useful when you have a link in the document and you
cannot determine which data source it is linked to: simply copy the
link to a new document and then run this report.
XML REPORTS All of the above reports are generated as an XML file, which is
stored in an ‘EasyCatalog Reports’ folder inside of your EasyCatalog
workspace folder. This XML file is then opened in your default web-
browser.
CHAPTER 19
APPLICATION PREFERENCES
INTRODUCTION Available from the standard InDesign
preferences menu, EasyCatalog provides a new
‘EasyCatalog’ pane on the standard application
‘Preferences’ dialog.
The EasyCatalog panel offers preferences that affect the general behavior of the
plug-in - they are not preferences for the current, front-most document.
THE WORKSPACE
FOLDER
Enable this check box when the workspace folder is being shared
by multiple users. The configuration of data sources - such as field
options, data source options, etc - will be stored in the workspace
folder. The snapshot of data will be stored locally on each machine.
CONTENT TRACKING
‘Content Tracking’
Field tracking can be disabled for individual fields using the ‘Content
Tracked’ Field Option.
With this option turned off, you must manually perform a ‘Synchronise
with Document’ operation to update the panels.
ALLOW PAGINATION
TO BE UNDOABLE
ONLY AVAILABLE WITH THE
PAGINATION MODULE
The ‘Allow pagination to be undoable’ option speeds up automatic pagination by
disabling the undo support in InDesign
DATA SOURCE
DEFAULTS
Check the ‘Ignore White Space Changes’ check box to turn this option on
automatically for new data sources created
HTTP AUTHENTICATION
HTTP PROXY
‘Content Tracking’
The settings specified here are used when retrieving images from a
URL, and are also used as defaults for retrieving XML data via the
XML Data Provider.
HTTP Authentication
Specify a user name and password here if the server you are
connecting to require these credentials.
HTTP Proxy
If all HTTP requests should use a proxy server, enter the address of
the proxy server and (optionally) your user name and password for
the proxy server.
CHAPTER 20
MENU REFERENCE
Permanently close this panel
Create a new panel based on
this one Prevent records from being added
Remove all records from this or removed to this panel
panel
Store and retrieve panel
configurations, such as column
positions, sizes, etc.
Group and ungroup the panel to
show data hierarchically
Generate xml-based reports on the
contents of the panel, data source
Automatic pagination (provided or document
by the optional Pagination Update page headers and footers
Module) (provided by the optional Pagination
Module)
Retrieve the latest data from the
data source Refresh the statuses of each field
Update the data source with shown in the panel
changes made to the data in the
InDesign document
Update the document with changes
Update the panel with changes made to the source data
made to the data in the
document
Remove the selected record(s) from
Show all records from the data the panel
source (remove any filter that
has been applied) Filter the data shown in the panel
Apply a filter that has been
previously saved Filter the data based on its status
shown in the panel