section-page

Represents a section page in an Escenic publication. A section page contains links (called content-refs) to a selection of the content items in its owning section. The layout of the links on a section page is determined by layout objects defined in the layout-group publication resource. These objects are called groups and areas.

A section may have more than one section page, but only one of them is active at any given time.

A syndication file section-page element has a layout-name attribute that references a group element in the layout-group resource. This group defines the page's root group, and thus determine its layout. It also has child area elements that are used to hold the content-ref elements representing the links that are to appear on the page. The value assigned to the layout-name attribute determines what child area elements the section-page element may contain.

Syntax
<section-page
    name="text"?
    id-ref="text"?
    (source="text" sourceid="text")?
    dbid="text"?
    exported-dbid="text"?
    unique-name="text"?
    action="(remove|replace)"?
    layout-name="text"?
    activatedate="text"?
    staged="(true|false)"?
  >
  <options>...</options>?<area>...</area>+
</section-page>
Examples

  • This example imports a section page. The source and source-id attributes identify the section to which the section page is to be added. This section must already exist in the database or appear before this element in the syndication file. The layout-name attribute specifies the name of a root group defined in the publication's layout-group resource. The names of the descendant area and group elements reference members of this group as defined in the layout-group resource.

    <section-page source="ex" sourceid="s12" name="example-section-8" layout-name="news">
  <area name="center">
    <group name="twoCol">
      <area name="left">
        <list-ref source="ex" sourceid="s12" name="important" number-of-items="2"/>
      </area>
      <area name="right">
        <content-ref source="ex" sourceid="19">
          <field name="leadtext">New lead text</field>
        </content-ref>
        <content-ref source="ex" sourceid="20"/>
      </area>
    </group>
  </area>
</section-page>
Attributes
name="text" (optional)

The name of this section page.

id-ref="text" (optional)

The id of the section to which this section page is to be added. If this attribute is specified, a section element with an id attribute that matches this attribute must appear somewhere before this section-page element in the syndication file.

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

source="text" (optional)

The source of the section to which this section page is to be added. 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 section with source and sourceid attributes that match source and sourceid, or

  • A section element with source and sourceid attributes that match source and sourceid must appear somewhere before this section-page element in the syndication file.

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

sourceid="text" (optional)

The sourceid of the section to which this section page is to be added. 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 section with source and sourceid attributes that match source and sourceid, or

  • A section element with source and sourceid attributes that match source and sourceid must appear somewhere before this section-page element in the syndication file.

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

dbid="text" (optional)

The dbid of the section to which this section page 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 a dbid attribute that matches this attribute must appear somewhere before this section-page element in the syndication file.

exported-dbid="text" (optional)
unique-name="text" (optional)

The unique-name or name of the section to which this section page 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 or name attribute that matches this attribute, or

  • A section element with a unique-name or name attribute that matches this attribute must appear somewhere before this section-page 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 or source and sourceid or id are specified, then this attribute is ignored.

action="(remove|replace)" (optional)

Determines what action is taken during import if the section page already exists.

Allowed values are:

remove

All the section page's existing areas are removed and the new areas imported.

replace (default)

Imported areas replace any existing areas with the same name; other existing areas are not removed.

layout-name="text" (optional)

The name of a group defined in the layout-groups resource. The selected group will be the section page's root group and thus determine the layout of the section page. The group you specify here determines what area elements this section-page element may contain.

activatedate="text" (optional)

The date/time at which this section-page was/is to be activated, specified in the format:

yyyy-mm-dd hh:mm:ss.ffffffff
staged="(true|false)" (optional)

Indicates whether or not this section page is in a draft state.

Copyright © 2009-2018 Escenic AS