PageSeeder primitives

This article introduces some of PageSeeder’s key primitives:

Understanding these primitives helps to explain the properties of higher level objects that are exposed through the API or the user interface.

Note

Note: This is not an exhaustive list of primitives or their attributes, it is simply an introduction to those which are typically most significant.

Identifiers for primitives

Most primitives can be referenced by either a system identifier or a public identifier.

System IdentifiersPublic Identifiers
Assigned by PageSeeder – for a single server only.Assigned by a user – can integrate externally managed IDs. For example, part numbers or ISBN codes.
Immutable – will not change over time.Often mutable – can be changed.
Unique – system-wide, within their class.Unique – within different sets.
Examples – URI ID, Member ID, XLink ID, Group ID.Examples – Doc ID, Group name.

URI

A URI is an addressable entity: it has a specific and unique URL.

URIs can have Locators, which are anchor points to which XLinks can be attached.

A URI can be shared between Groups and it can resolve or map to:

  • a file or directory in the file system
  • OR another addressable resource
  • OR nothing!

Every document in PageSeeder is a URI, including:

  • PSML documents.
  • Non-native documents (PDF, Images, Videos, Office documents, text files, arbitrary XML)
  • Folders

External URIs (aka URLs) point to external resources.

Special URI in group to attach general XLinks.

Attributes

  • ID – a system and immutable identifier
  • DOCID – a public identifier for the host but is mutable
  • Scheme, host, port, path – making the full URL unique
  • title and description – similar to the role these play for Microsoft Word documents or PDF files. 
  • Media type
  • Labels are used to attach semantics.

Note

  • GroupURIs (aka group folders) are used to share a URI.

XLink

XLinks are PageSeeder's fundamental unit. They associate content created by a Member to Locators or to another XLink.

An XLink can have custom semantics (via labels) and has built-in workflow attributes (status, due date and more). They can also be moderated and PageSeeder will keep track of moderation and modifications.

An XLink can be assigned to a Member or shared between Groups through shared URIs

In PageSeeder, XLinks are used to represent:

  • Comments
  • Task changes
  • Document Versions
  • Document Edits
  • Cross references
  • Links between documents
  • … more

XLink sequences

Attached to the same Locator or XLink, a sequence of XLinks can be used to represent

  • A threaded discussion
  • the changing states of a Task
  • the editing history of a document fragment.
  • a Document workflow

By acting like a time machine on a Locator, sequences of XLinks provide the information that's essential for formal audit trails. 

Attributes

  • ID
  • Role & Title
  • Content*
  • Creation author & date
  • Modification member & date
  • Assign member & date
  • Priority, status and due date
  • Properties and labels
  • Other XLinks in sequence

Note

  • The ID is a system and immutable identifier
  • The author is generally a Member but not necessarily
  • Properties and labels are used to provide semantics
  • Priority, status, assigned member and due date are used for workflows

Locator

A locator is an anchor point and is used to attach XLinks. It addressable as {uri(scheme, host, port, path)}#{fragment}. For example, http://pageseeder.com/info.html#contact

A URI can have multiple locators

  • Each locator is unique within the URI

There are special locators in PageSeeder

  • For the document itself;
  • To refer to the group (for properties)

The document default locator is used for:

  • Comments and tasks on the document
  • Document version

The document fragment locators are used for:

  • comments on document fragments
  • document editing

The group default locator is used for:

  • group properties

Attributes

  • ID
  • Fragment

Note

  • The Locator ID is an immutable system identifier
  • The fragment is unique within a URI

Member

A Member represents either a person who has an account on PageSeeder or another type of actor such as an external system. A Member is used to define credentials.

XLinks in PageSeeder are generally authored by a member.

Attributes

  • ID
  • Email
  • Username
  • First name and surname
  • Password
  • Notification preferences

Note

  • The Member ID is an immutable system identifier
  • Both the email and username can be used as public identifiers but they are mutable

Group

A Group is the social unit in PageSeeder and is essentially a collection of Members with specific Membership properties.

Groups are configurable: the behavior and functionality is customizable at the group level.

Groups can be public or private

There are special types of groups:

  • Personal groups
  • Projects and sub-projects

Attributes

  • ID
  • Name
  • Description & related URL
  • Visibility, owner and flags
  • Template
  • Membership fields

Note

  • The Group ID is an immutable system identifier
  • The name is a public identifier

 

Membership

A membership expresses the relationship between a Group and a Member

It is used to define:

  • The role of the member in the group
  • The notifications settings of the member for the group
  • Group specific fields

Attributes

  • ID
  • Role
  • Notification & Email settings
  • Moderator details

Note

  • The ID is an immutable system identifier

Next...

See how PageSeeder primitive are specialized into PageSeeder objects.

Created on , last edited on