Add-on Chronicle: Documentation

Learn how to create and compile timelines easily with Sophora's add-on Chronicle.

Table of Contents

Working with Chronicle

The chronicle add-on enables editors to arrange articles, images and other documents as single events in a timeline. Created events will be shown in a well-structured and chronological sequence.

This is a paid Sophora add-on. For details, please refer to our website.
Sophora CMS: Add-on Chronicle stellt Chroniken zusammen

Creating a Chronicle Document

  1. Select the icon "New", listed in the menu bar.
  2. Choose "Chronicle".
  3. A window to select location and Id stem will be opened. Add a name for the Id stem and confirm your entry with "Finish".
  4. The chronicle document has been created.

Note: In order to delete a chronicle document you have to click on the dots menu ("more actions") and then at "delete document".
For more details view "Creating and Editing documents".

New chronicle Sophora CMS

Adding an Event

  1. Open or search for a document you want to add to the timeline.
  2. Drag and drop the document onto chronicle. The drop marker shows the date and time where the event will be added.
  3. Click on the event. By pressing the left mouse button, while moving the mouse pointer in the required direction, you can define date or time for the event.
Compiling Events

Editing an Event

In order to change the event’s date, use the drag & drop function. At the bottom of the chronicle document you can see the dates of the events. An event can be either a time stamp or a duration.

Converting time stamp into duration

  1. Open the chronicle document which is meant to be edited.
  2. To convert a time stamp event into a duration event, hold the Ctrl key.
  3. Click on the event.
  4. Drag the event while holding the left mouse button. This way you can modify the end date (at any time).

Converting duration into time stamp

  1. Open the chronicle document which is meant to be edited.
  2. To convert a duration event into a time stamp event, open the context menu of the event.
  3. Select "Convert to Time Stamp".
Chronicle Converting Time Stamp and Duration

Removing an Event

In order to remove an event you have to open the chronicle document first. There are two options to remove an event:

  1. Select the event and press the Del key.
  2. Click the right-hand mouse button on the event and choose "Remove Event" [DELETE_OBJ].
Removing an Event

Above the chronicle there are a few features to help navigating inside the chronicle document:

  • Jump to: Enter a date and/or time to have the chronicle scroll to that date. Examples: "03/13/2014", "09/29/1978 16:00", "2014", "13:37" (Note that the date format is locale dependent).
  • View: Changes the zoom level of the chronicle to one of the predefined zoom levels.
  • Previous/Next Event: Scrolls to the previous/next event, depending on the currently selected event.
  • Show All: Automatically changes the zoom level to show all events.
  • Zoom: Infinitely variable zoom level.

You can also scroll and zoom the chronicle by using the mouse:

  • To scroll, click into a free area of the chronicle. Then, drag the mouse while holding the mouse button. Alternatively, rotate the mouse wheel.
  • To zoom, click into a free area of the chronicle. Then rotate the mouse wheel while holding the Ctrl key.
Chronicle Navigation

Administrating Chronicle

The configuration will be explained at the namespace sophora-content. You have to replace it with your domain specific namespace.

1. Open any document as administrator. You should be asked to confirm automatic creation of the chronicle node types. Click "OK" to do so.

2. Create a new document reference node type:

['sophora-content-nt:chronicleEventRef'] > 'sophora-nt:reference'

3. In the "Base" tab document, add the new reference type sophora-content-nt:chronicleEventRef.

4. Configure the reference type sophora-content-nt:chronicleEventRef:

4.1. Add a node type configuration.

4.2. Add the mixin sophora-extension-mix:chronicleEvent.

4.3. On the "Base" tab, configure these properties:

  • sophora-extension:chronicleEventStartDate: Date (simplified)
  • sophora-extension:chronicleEventEndDate: Date (simplified)
  • sophora-extension:chronicleEventDateFormat: Text or select value, depending on playout

5. Configure the node type sophora-extension-nt:chronicle:

5.1. In the "Event" component, add the reference type sophora-content-nt:chronicleEventRef to the valid child node types.

6. Create a new tab document "Chronicle" of type "Form" and add the "Story" node type (or any other node types you need.) These are the node types that will have a "Chronicle" tab.

7. In the "Story" node type (and any other node types from point 6 above), add a new child node:

+ 'sophora-content:chronicle' (nt:base)

8. Configure the new child node from point 7 above onto the "Chronicle" tab and set the input field type to "Chronicle."

8.1. Configure sophora-extension-nt:chronicle as the valid child node type.

9. For all document node types that may be used for events on a chronicle, add the reference node type sophora-content-nt:chronicleEventRef to their reference node types.