Skip to content

Latest commit

 

History

History
418 lines (229 loc) · 10.5 KB

componentized-page.schema.md

File metadata and controls

418 lines (229 loc) · 10.5 KB

Componentized page Schema

https://ns.adobe.com/xdm/content/componentized-page

A componentized page is a part of a digital experience that is authored though modular components. Examples for componentized pages include web pages as managed by a web content management system or mobile app pages as managed by a mobile content management system. Componentized pages are modular (consist of smaller content components), hyperlinked (link to other pages), and include digital assets (like images or videos).

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Experimental No Forbidden Permitted content/componentized-page.schema.json

Schema Hierarchy

  • Componentized page https://ns.adobe.com/xdm/content/componentized-page
    • Asset http://ns.adobe.com/adobecloud/core/1.0/asset

Componentized page Example

{
  "repo:name": "example",
  "repo:path": "/content/example",
  "dc:title": "Example Page for XDM.",
  "xdm:shortTitle": "Example",
  "repo:createDate": "2017-09-26T13:27:36+00:00",
  "xdm:repositoryCreatedBy": "https://identity.adobe.io/users/[email protected]",
  "repo:modifyDate": "2017-09-26T13:31:19+00:00",
  "xdm:repositoryLastModifiedBy": "https://identity.adobe.io/users/[email protected]",
  "xdm:language": "en-US",
  "xdm:template": "https://francois.corp.adobe.com:4502/apps/foundation/generic_page",
  "teaser": {
    "type": "https://francois.corp.adobe.com:4502/apps/foundation/teaser",
    "title": "Sunglasses",
    "image": {
      "@type": "http://ns.adobe.com/adobecloud/core/1.0/asset",
      "repo:id": "urn:aaid:aem:4123ba4c-93a8-4c5d-b979-ffbbe4318185",
      "@id": "https://francois.corp.adobe.com:4502/content/dam/Fx_DUKE-small.jpg"
    }
  },
  "par": {
    "@type": "https://francois.corp.adobe.com:4502/apps/foundation/generic_container",
    "xdm:items_order": [
      "title0",
      "text0",
      "image0"
    ],
    "xdm:items": {
      "title0": {
        "type": "https://francois.corp.adobe.com:4502/apps/foundation/title",
        "title": "Protect Your Eyes"
      },
      "image0": {
        "type": "https://francois.corp.adobe.com:4502/apps/foundation/image",
        "image": {
          "@type": "http://ns.adobe.com/adobecloud/core/1.0/asset",
          "asset_id": "urn:aaid:aem:4123ba4c-93a8-4c5d-b979-1234e4318185",
          "id": "https://francois.corp.adobe.com:4502/content/dam/Glasses-small.jpg"
        }
      },
      "text0": {
        "type": "https://francois.corp.adobe.com:4502/apps/foundation/text",
        "text": "<p>Even during high UV levels...</p>"
      }
    }
  }
}

Componentized page Properties

Property Type Required Defined by
dc:title string Optional Componentized page (this schema)
repo:createdBy string Optional Asset
repo:etag string Optional Asset
repo:id string Optional Asset
repo:modifiedBy string Optional Asset
repo:name string Required Componentized page (this schema)
repo:path string Required Componentized page (this schema)
repo:size integer Optional Asset
repo:version string Optional Asset
tiff:imageLength integer Optional Asset
tiff:imageWidth integer Optional Asset
xdm:language string Optional Componentized page (this schema)
xdm:navOrder integer Optional Componentized page (this schema)
xdm:shortTitle string Optional Componentized page (this schema)
xdm:template string Optional Componentized page (this schema)
xdm:unlisted boolean Optional Componentized page (this schema)
* any Additional this schema allows additional properties

dc:title

Full title of the page.

dc:title

  • is optional
  • type: string
  • defined in this schema

dc:title Type

string

repo:createdBy

ID of the user who initiated the action that caused the resource to be created in the repository.

repo:createdBy

  • is optional
  • type: string
  • defined in Asset

repo:createdBy Type

string

repo:etag

ETag

An ETag is an HTTP response header returned by an HTTP/1.1 compliant web server used to determine change in content of a resource at a given URL.

repo:etag

  • is optional
  • type: string
  • defined in Asset

repo:etag Type

string

repo:id

A unique identifier given to every addressable asset in a given repository.

repo:id

  • is optional
  • type: string
  • defined in Asset

repo:id Type

string

repo:id Example

"urn:aaid:sc:US:6dc33479-13ca-4b19-b25d-c805eff8a69e"

repo:modifiedBy

ID of the user who initiated the action that most recently caused the resource to be modified in the repository.

repo:modifiedBy

  • is optional
  • type: string
  • defined in Asset

repo:modifiedBy Type

string

repo:name

Name of the page in the repository. This could be a file name or any name provided by the repository to the page.

repo:name

  • is required
  • type: string
  • defined in this schema

repo:name Type

string

repo:path

Shows the hierarchy of the page. The path semantics should be same as that defined in RFC 3986. In case a repository is not path based then it can return the information which will help in browsing. It could be just an document id, or something like {catalog}/{id} in case of a document database.

repo:path

  • is required
  • type: string
  • defined in this schema

repo:path Type

string

repo:size

Size

Size of the asset in bytes.

repo:size

  • is optional
  • type: integer
  • defined in Asset

repo:size Type

integer

  • minimum value: 0

repo:version

The version ID of the piece of content. It will be generated both on explicit and implicit save or upload.

repo:version

  • is optional
  • type: string
  • defined in Asset

repo:version Type

string

tiff:imageLength

Length

Height in pixels. To maintain continuity with the XMP and TIFF standards, the height of an image or video is specified in the property imageLength. The duration of the video (also commonly called length) is specified in the property extent

tiff:imageLength

  • is optional
  • type: integer
  • defined in Asset

tiff:imageLength Type

integer

  • minimum value: 0

tiff:imageWidth

Width

Width in pixels

tiff:imageWidth

  • is optional
  • type: integer
  • defined in Asset

tiff:imageWidth Type

integer

  • minimum value: 0

xdm:language

Specifies the language of this page. the language property should conform to BPC 47, for example en-GB.

xdm:language

  • is optional
  • type: string
  • defined in this schema

xdm:language Type

string

All instances must conform to this regular expression (test examples here):

^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$

xdm:navOrder

When this page is shown in a collection of pages, use nav_order to sort. The smallest nav_order should be the first item in the sorted collection.

xdm:navOrder

  • is optional
  • type: integer
  • defined in this schema

xdm:navOrder Type

integer

  • minimum value: 0

xdm:shortTitle

Short title of the page that is suitable to be displayed in navigation links.

xdm:shortTitle

  • is optional
  • type: string
  • defined in this schema

xdm:shortTitle Type

string

xdm:template

The template that was used to create this page.

xdm:template

  • is optional
  • type: string
  • defined in this schema

xdm:template Type

string

  • format: uri-reference – URI Reference (according to RFC3986)

xdm:unlisted

Indicates if this page should be hidden by default in navigational collections.

xdm:unlisted

  • is optional
  • type: boolean
  • defined in this schema

xdm:unlisted Type

boolean