What is a Collection?

Collections are used online primarily for photo galleries. They are a comprised as a brief description (like a summary) and then a variety of child images.

In reality, a collection can have children of all the available asset types. The online display and/or printability depends on the child asset type.

Why would I want to place a Collection in Print?

In print, some publications will create a monthly photo page. Reusing the same collection is less work that then creating a print only article and attaching the print images separately.

Note, Collections cannot be printed as a child asset of another asset. They can only be placed directly.

What Ruleset Changes do I need to add?

Full support for collection assets require the following changes

  1. Add a Collection Ruleset similar to the one attached
  2. Modify the Default Ruleset to support stand alone collections
  3. Modify your Base to Duplicate Ruleset similar to above, if you have one, to support it in future Rulesets
  4. Modify your Export Ruleset to allow them to be exported correctly from Adobe InDesign and Adobe InCopy

The Raw Version

The Raw text of a collection asset, without any children might look like this:

<flags:topical><sections:kites><sections:sports><collectionAsset><collectionAssetPresentation:series><title>sample collection Title</title>
<content><p>This is my sample Collection’s Description.</p></content>
<uuid>3e009136-c68f-11e8-bbd0-00163ec2aa77</uuid><revision>16</revision><revisionChecksum>d41d8cd98f00b204e9800998ecf8427e</revisionChecksum><slug>test collection</slug><domain>winters.local</domain><setWriteback>1</setWriteback></collectionAsset>

Importantly, the body is wrapped with <collectionAsset> tags. The headline is wrapped with a <title> tag. And the Description is wrapped in the normal <content> tag. Everything else is standard. Children, the members of the collection, would be handled as any child is now. No additional support is needed for the children of a collection.

The Collection Ruleset

This is a sample of the Collection asset you can download and use.

Collection Ruleset

One way to translate collections

Calling the Collection Ruleset

You would need to add the following lines in your Default Ruleset, and potentially your Base to Duplicate and other rulesets where these collection assets might get forwarded.

Calling the Collection Ruleset
Start tag:Translate script:
 <collectionAsset> <&recursive:(Collection,1)>
Calling the Collection Ruleset

You can place this rule in a variety of places in your default, Base to Duplicate, or other rulesets to call the Collection ruleset. Since Collections can, or will eventually have, bylines, we suggest placing the Collection Ruleset above where bylines are formatted.

Export Ruleset Requirements

The Export Ruleset must be configured to send the collection's description text back to the content field and the collection's title back to the title field. Collections do not use the main story nor the print_headline elements when using the rulesets above. They instead use custom fields that we expect to use. But that also means that they need to be configured to write back to the correct locations.

Failure to add these two rules means that any edits to the Collection's text in print will not return to BLOX Total CMS nor your websites. Some sites might want to avoid writing back. That is fine, either don't add these two rules are direct them to ignore instead of title and content respectively.

You can place these two rules anywhere in your Export ruleset, but we recommend placing them up high so that any other use of title is ignored. As always, your ruleset might have other uses of these things and thus adding this might break something else you are doing. Remember, you are responsible for your actions.

Export Ruleset Changes for Collection Asset Write-back

Rule comment:

Start tag:

Translate script:
Collection Titles#!<&tbu2:(,,,,title,title)>
Collection Descriptions#!<&tbu2:(,,,,collection,content)>
Export Ruleset Rules for Collection Write-back

This images shows the two basic rules for Collection Asset write-back.