List/Inbox content-ref

A reference to a content item.

Syntax

<content-ref
    id-ref="text"?
    publication-name="text"?
    (source="text" sourceid="text")?
    dbid="text"?
    position="text"?
    exported-dbid="text"?
  />

Examples

This example shows a list/inbox content-ref element. The source and source-id attributes identify the referenced content item. This content item must already exist in the database or appear before this element in the syndication file.
```
<content-ref source="ex" sourceid="13"/>
```

Attributes

id-ref="text" (optional)

The id of the referenced content item. If this attribute is specified, a content element with an id attribute that matches this attribute must appear somewhere before this content-ref element in the syndication file.

If dbid or source and sourceid are specified, then this attribute is ignored.

publication-name="text" (optional)

The name of the publication to which the referenced content item or section belongs. This attribute may only be used in combination with the source and source-id attributes. It is needed to ensure unique identification in situations where cross-publishing is in use and the referenced content item or section does not belong to the current publication.

source="text" (optional)

The source of the referenced content item. If this attribute is specified, then sourceid must also be specified. One of the following two conditions must be satisfied:

The target publication must already contain a content item with source and sourceid attributes that match this element's source and sourceid, or
A content element with source and sourceid attributes that match source and sourceid must appear somewhere before this content-ref element in the syndication file.

If dbid is specified, then source and sourceid are ignored.

sourceid="text" (optional)

The sourceid of the referenced content item. If this attribute is specified, then source must also be specified. One of the following two conditions must be satisfied:

The target publication must already contain a content item with source and sourceid attributes that match this element's source and sourceid, or
A content element with source and sourceid attributes that match source and sourceid must appear somewhere before this content-ref element in the syndication file.

If dbid is specified, then source and sourceid are ignored.

dbid="text" (optional)

The dbid of the referenced content item. If this attribute is specified, then one of the following two conditions must be satisfied:

The target publication must already contain a section with a dbid attribute that matches this attribute, or
A content element with a dbid attribute that matches this attribute must appear somewhere before this content-ref element in the syndication file.

This attribute is never present in syndication files that have been exported from a database. IDs are always written to exported-dbid attributes in exported syndication files.

position="text" (optional)

The pinned position of the referenced content item in a list.

A pinned content item will always stay in the same position in a list.

The value must be a number larger than 0.

exported-dbid="text" (optional)

The dbid of the referenced content item.

This attribute is generated during export from the , but ignored during import. It is provided mainly for information and debugging purposes.