Posted by indytechcook on April 18, 2012 at 3:09pm
Last updated by videographics on Wed, 2012-05-16 17:39
Last updated by videographics on Wed, 2012-05-16 17:39
Definitions will be used to help standardize the vocabulary used in this project. This will help clarify any confusing concepts.
Definitions
Definitions will be used to help standardize the vocabulary used in this project. This will help clarify any confusing concepts.
- Content
- Content refers to anything an editor or non-site administrator would change in the UI. This could be nodes, settings, layouts, etc
- Configuration
- Configuration is managed in code. The process could be features, install update hooks, etc. Anything not allowed to be changed in the UI by non site administrators.
- Content Staging
- In the context of the LSD CSI, Content Staging refers to workflow and site preview on a single site. CSI is split into two sections: Workflow and Site Preview.
- Workflow
- How content is published. This could be an approval process or a single step publishing via a scheduled event.
- Site Preview
- The ability to view the site with certain Site Conditions applied.
Workflow
The workflow flowcharts show recommended use patterns. The system will not require any particular workflow methods or particular modules. The only workflow requirement will be the use of revision to manage the workflow of a piece of content.
- State
- A representation of a revision of an entity.
- Transition:
- Action taken on a revision of an entity to move between states. Events has permission and actions associated to them.
Preview System
- Site State
- A Site State object defines a target that can be previewed. The Site State is how the system will know when it's in preview mode and what conditions should be applied. All other parts of the system interact with the Site State object. The Site State Object will be the storage container interface for the preview system. The Site State Object is unique per session. A user can only have one active Site State at a time but different users can use different Site States at the same time.
- Preview Condition
- Preview Conditions define what filters can be used to set the preview mode. Preview Conditions will expose the input form and interact with the Site State Object to store and retrieve the conditions for the preview mode. The Preview Condition will not store the data themselves, only interface with the data.
- Revision Overrides
- A revision collection is a collection of overrides and extras that are used when a site is loading. This will be represented by a cache table “revision_override” that will be filled during the Prepare data phase of the Preview Process.
- Preview Mode
- Preview Mode is if the site is currently being viewing with an active Site State. When the site is in Preview, the Preview Reaction objects will control the loading of entities and altering of queries.
- Preview Reactions
- A preview reaction knows how to interface with the Site State override data that was set by the Preview Setters. The two primary Preview Reactions will be a query alter and a entity load overrider.
- Preview Setter
- Preview Setters are fired when the user submits the Preview Selection Form with the Preview Conditions set. A Preview Setter will know how to interface with the user submitted data in the Preview Condition to create a list of overrides. The list will contain an id, revision id and type. For example, the node Preview Setter will return nid, vid and node.