list-ref
A reference to a list that appears in a section page area.
Syntax
<list-ref name="text" id-ref="text"? (source="text" sourceid="text")? dbid="text"? exported-dbid="text"? unique-name="text"? number-of-items="int"? publication-name="text"? > <options>...</options>? </list-ref>
Examples
This example shows a
list-ref
element used to place the first two content items from the list "important" in an area. Thesource
andsource-id
attributes identify the section to which the referenced list belongs. Both this section and the list must already exist in the database or appear before this element in the syndication file<area name="left"> <list-ref source="ex" sourceid="s12" name="important" number-of-items="2"/> </area>
Attributes
name="
text"
-
The name of the list to which this list-ref refers. A list is not uniquely referenced by its name. You must therefore also identify the section to which the list belongs by specifying one of:
-
id-ref
-
source
andsourceid
-
dbid
-
unique-name
-
id-ref="
text"
(optional)-
The
id
of the section to which this list-ref is to be added. If this attribute is specified, asection
element with anid
attribute that matches this attribute must appear somewhere before thislist-ref
element in the syndication file.If
dbid
orsource
andsourceid
are specified, then this attribute is ignored. source="
text"
(optional)-
The
source
of the section to which this list-ref is to be added. If this attribute is specified, thensourceid
must also be specified. One of the following two conditions must be satisfied:-
The target publication must already contain a section with
source
andsourceid
attributes that matchsource
andsourceid
, or -
A
section
element withsource
andsourceid
attributes that matchsource
andsourceid
must appear somewhere before thislist-ref
element in the syndication file.
If
dbid
is specified, thensource
andsourceid
are ignored. -
sourceid="
text"
(optional)-
The
sourceid
of the section to which this list-ref is to be added. If this attribute is specified, thensource
must also be specified. One of the following two conditions must be satisfied:-
The target publication must already contain a section with
source
andsourceid
attributes that matchsource
andsourceid
, or -
A
section
element withsource
andsourceid
attributes that matchsource
andsourceid
must appear somewhere before thislist-ref
element in the syndication file.
If
dbid
is specified, thensource
andsourceid
are ignored. -
dbid="
text"
(optional)-
The
dbid
of the section to which this list-ref is to be added. 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
section
element with adbid
attribute that matches this attribute must appear somewhere before thislist-ref
element in the syndication file.
-
exported-dbid="
text"
(optional)unique-name="
text"
(optional)-
The
unique-name
orname
of the section to which this list-ref is to be added. If this attribute is specified, then one of the following conditions must be satisified:-
The target publication must already contain a section with a
uniquename
orname
attribute that matches this attribute, or -
A
section
element with aunique-name
orname
attribute that matches this attribute must appear somewhere before thislist-ref
element in the syndication file.
If this is not the case, or if there is a matching
name
attribute but it is not unique, then import will fail.If
dbid
orsource
andsourceid
orid
are specified, then this attribute is ignored. -
number-of-items="
int"
(optional)-
The number of items from this list that are to appear in an area. The specified number of items are taken from the top of the list.
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
andsource-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.