Skip to main content

News

Introduction​

  • The News feature in the Web2Publish application is designed to display dynamic updates on the Start (home) page.
  • It allows administrators to configure and manage news items using specific configuration units. Each news item is tied to a Bucket Key-Value pair, and its behavior can be fine-tuned using configuration options in an ISON file.
  • This system supports language-specific news, meaning each language can display unique news items.

Configuration​

All News configurations are stored and maintained in the ISON configuration. This file stores the metadata necessary to define the news entities, their behavior, and how they are displayed to users.

Sample ISON Configuration​

<newsList>
    <news bucketId="{BUCKET_ID}" entityId="{BUCKET_ENTITY_ID}">
        <keys>
            <key resultEntityId="{NEW_ENTITY_ID}">new_key</key>
        </keys>
    </news>
</newsList>

Explanation of Configuration Elements​

  • <newsList>: The top-level element that wraps all news configurations. Each <news> element inside defines a separate news item.

  • <news>: Represents an individual news configuration. Each news entry is governed by the attributes and elements within.

Attributes:​
  • bucketId: A unique identifier for the bucket storing the news data. This is a required attribute.
  • entityId: Specifies the entity associated with the news. This is also a mandatory attribute.
Elements:​
  • <keys>: A container that holds key configuration details.
  • <key>: Represents the key used for filtering relevant news data
    • Attributes:
      • resultEntityId: Defines the entity ID used to filter key values for retrieving the news data.

This structure ensures flexibility in presenting news updates while allowing for language-specific and entity-based configurations.