{"id":9113,"date":"2026-08-25T02:19:56","date_gmt":"2026-08-25T02:19:56","guid":{"rendered":"https:\/\/metaphaze.com\/gazettebuilder\/?page_id=9113"},"modified":"2026-08-25T02:19:56","modified_gmt":"2026-08-25T02:19:56","slug":"documentation-timeline","status":"publish","type":"page","link":"https:\/\/metaphaze.com\/gazettebuilder\/documentation-timeline\/","title":{"rendered":"Documentation: Timeline"},"content":{"rendered":"\n

GazetteBuilder can generate chronological views from Entries that contain a Timeline Sort<\/strong> value.<\/p>\n\n\n\n

Timelines are inserted into normal WordPress content using the:<\/p>\n\n\n\n

[gazette_timeline]<\/pre>\n\n\n\n
shortcode.<\/p>\n\n\n\n
The shortcode can display all eligible timeline Entries or narrow the results by Entry Type and date range. Timelines may be presented horizontally or vertically and can optionally include each Entry’s Summary.<\/p>\n\n\n\n
Preparing an Entry for the Timeline<\/h2>\n\n\n\n
Timeline information is entered in the Entry Details<\/strong> section when editing an Entry.<\/p>\n\n\n\n
Two Entry fields are relevant:<\/p>\n\n\n\n
Campaign Date<\/strong>
The reader-facing date or description displayed for the Entry.<\/p>\n\n\n\n
Timeline Sort<\/strong>
The sortable date and time GazetteBuilder uses to determine where the Entry belongs chronologically.<\/p>\n\n\n\n
These fields serve different purposes.<\/p>\n\n\n\n
For example:<\/p>\n\n\n\n
Campaign Date:Friday, 11 January 1889, shortly after noon
Timeline Sort:1889-01-11 12:15<\/pre>\n\n\n\n
The Campaign Date can use natural wording appropriate to the setting. Timeline Sort provides the structured value GazetteBuilder needs to put the Entry in chronological order.<\/p>\n\n\n\n
GazetteBuilder does not need to interpret the Campaign Date in order to determine chronology.<\/p>\n\n\n\n
Basic Timeline<\/h2>\n\n\n\n
Add the shortcode to a WordPress page, post, or other location where WordPress processes shortcodes:<\/p>\n\n\n\n
[gazette_timeline]<\/pre>\n\n\n\n
This produces a timeline from eligible GazetteBuilder Entries.<\/p>\n\n\n\n
Each timeline item provides access to its full Entry.<\/p>\n\n\n\n
Filtering by Entry Type<\/h2>\n\n\n\n
Use types<\/code> to limit the timeline to particular Entry Types.<\/p>\n\n\n\n
For example:<\/p>\n\n\n\n
[gazette_timeline types=\"location,event\"]<\/pre>\n\n\n\n
This timeline contains eligible Entries whose Entry Types are Location or Event.<\/p>\n\n\n\n
Multiple Entry Types are separated by commas.<\/p>\n\n\n\n
A timeline can therefore be tailored to its purpose. One page might contain only Events while another combines Events, Documents, and Locations.<\/p>\n\n\n\n
Limiting the Date Range<\/h2>\n\n\n\n
Use min<\/code> and max<\/code> to restrict the chronological period shown.<\/p>\n\n\n\n
For example:<\/p>\n\n\n\n
[gazette_timeline min=\"1889-01-01\" max=\"1889-06-30\"]<\/pre>\n\n\n\n
This limits the timeline to qualifying Entries between those dates.<\/p>\n\n\n\n
The two values may also be used together with Entry Type filtering:<\/p>\n\n\n\n
[gazette_timeline types=\"location,event\" min=\"1889-01-01\" max=\"1889-06-30\"]<\/pre>\n\n\n\n
This displays only Location and Event Entries within the specified period.<\/p>\n\n\n\n
Horizontal Timeline<\/h2>\n\n\n\n
Use:<\/p>\n\n\n\n
[gazette_timeline orientation=\"horizontal\"]<\/pre>\n\n\n\n
to present the timeline horizontally.<\/p>\n\n\n\n
This is useful when chronological movement from left to right suits the page design.<\/p>\n\n\n\n
On narrower displays, a horizontal timeline may require horizontal movement to view additional timeline items.<\/p>\n\n\n\n
Vertical Timeline<\/h2>\n\n\n\n
Use:<\/p>\n\n\n\n
[gazette_timeline orientation=\"vertical\"]<\/pre>\n\n\n\n
to present the same information vertically.<\/p>\n\n\n\n
Entries progress from top to bottom in chronological order.<\/p>\n\n\n\n
A vertical presentation is often useful for longer timelines or pages where horizontal space is limited.<\/p>\n\n\n\n
Showing Entry Summaries<\/h2>\n\n\n\n
Use:<\/p>\n\n\n\n
[gazette_timeline summary=\"yes\"]<\/pre>\n\n\n\n
to include the GazetteBuilder Summary<\/strong> associated with each qualifying Entry.<\/p>\n\n\n\n
This gives readers additional context without requiring them to open every Entry.<\/p>\n\n\n\n
For example, a timeline item might effectively contain:<\/p>\n\n\n\n
11 January 1889
Harcourt Survey Preparations
Event
Final arrangements are made before the survey work begins.<\/pre>\n\n\n\n
The title links to the complete Entry.<\/p>\n\n\n\n
Entries without a Summary can still participate in the timeline; they simply do not have summary text to display.<\/p>\n\n\n\n
Combining Options<\/h2>\n\n\n\n
Timeline options can be combined in a single shortcode.<\/p>\n\n\n\n
For example:<\/p>\n\n\n\n
[gazette_timeline types=\"location,event\" min=\"1889-01-01\" max=\"1889-06-30\" orientation=\"horizontal\" summary=\"yes\"]<\/pre>\n\n\n\n
This requests:<\/p>\n\n\n\n
    \n
  • Location and Event Entries;<\/li>\n\n\n\n
  • between 1 January and 30 June 1889;<\/li>\n\n\n\n
  • displayed horizontally;<\/li>\n\n\n\n
  • with Entry summaries.<\/li>\n<\/ul>\n\n\n\n
    Shortcode Reference<\/h2>\n\n\n\n
    The current timeline options are:<\/p>\n\n\n\n
    Parameter<\/th>Purpose<\/th>Example<\/th><\/tr><\/thead>
    types<\/code><\/td>Limit results to one or more Entry Types<\/td>types=\"location,event\"<\/code><\/td><\/tr>
    min<\/code><\/td>Earliest Timeline Sort date to include<\/td>min=\"1889-01-01\"<\/code><\/td><\/tr>
    max<\/code><\/td>Latest Timeline Sort date to include<\/td>max=\"1889-06-30\"<\/code><\/td><\/tr>
    orientation<\/code><\/td>Select horizontal or vertical presentation<\/td>orientation=\"horizontal\"<\/code><\/td><\/tr>
    summary<\/code><\/td>Include Entry summaries<\/td>summary=\"yes\"<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
    A shortcode with no options remains valid:<\/p>\n\n\n\n
    [gazette_timeline]<\/pre>\n\n\n\n
    Entry Type Names<\/h2>\n\n\n\n
    The types<\/code> parameter uses the Entry Type identifiers recognized by GazetteBuilder.<\/p>\n\n\n\n
    For example:<\/p>\n\n\n\n
    types=\"location,event\"<\/pre>\n\n\n\n
    corresponds to the Location and Event Entry Types.<\/p>\n\n\n\n
    When creating timelines for custom Entry Types, use the corresponding identifier for the Entry Type configured in GazetteBuilder.<\/p>\n\n\n\n
    Date Filtering Uses Timeline Sort<\/h2>\n\n\n\n
    The min<\/code> and max<\/code> parameters filter against the structured Timeline Sort<\/strong> value, not the reader-facing Campaign Date.<\/p>\n\n\n\n
    This distinction allows Campaign Date to remain flexible.<\/p>\n\n\n\n
    An Entry could display:<\/p>\n\n\n\n
    Campaign Date:Early January 1889<\/pre>\n\n\n\n
    while carrying a structured Timeline Sort value used for its chronological placement.<\/p>\n\n\n\n
    The timeline relies on Timeline Sort for ordering and range filtering.<\/p>\n\n\n\n
    Publication and Release Eligibility<\/h2>\n\n\n\n
    Timeline membership does not override GazetteBuilder’s normal release rules.<\/p>\n\n\n\n
    An Entry may have a Timeline Sort value that places it within the requested period but still be unavailable because of its publication or Release Date state.<\/p>\n\n\n\n
    For example:<\/p>\n\n\n\n
    Timeline Sort: 1889-01-15
    Release Date: future<\/pre>\n\n\n\n
    does not cause the timeline to expose that Entry early.<\/p>\n\n\n\n
    Once the Entry becomes release-eligible, it can appear automatically in qualifying timeline views.<\/p>\n\n\n\n
    This means a timeline can be placed on a page once and left in place as the Gazette develops.<\/p>\n\n\n\n
    Campaign Chronology and Release Chronology Are Separate<\/h2>\n\n\n\n
    Timeline Sort describes when something belongs in the world chronology<\/strong>.<\/p>\n\n\n\n
    Release Date describes when readers are allowed to see the Entry<\/strong>.<\/p>\n\n\n\n
    They do not need to match.<\/p>\n\n\n\n
    For example:<\/p>\n\n\n\n
    Campaign Date:10 January 1889
    Timeline Sort:1889-01-10 09:00
    Release Date:09\/01\/2026 08:00<\/pre>\n\n\n\n
    The Entry belongs on 10 January 1889 in the fictional chronology but does not become eligible for readers until its 2026 release.<\/p>\n\n\n\n
    After release, it appears in the correct 1889 position rather than at the end of the timeline.<\/p>\n\n\n\n
    Stories and Timelines<\/h2>\n\n\n\n
    Story Sequence Position and Timeline Sort are also independent.<\/p>\n\n\n\n
    A Story may intentionally present Entries in an order that differs from their chronology.<\/p>\n\n\n\n
    For example:<\/p>\n\n\n\n
    Sequence 1 \u2014 11 January 1889
    Sequence 2 \u2014 12 January 1889
    Sequence 3 \u2014 Flashback to 1875
    Sequence 4 \u2014 13 January 1889<\/pre>\n\n\n\n
    The Story still presents positions 1 through 4 in authored order.<\/p>\n\n\n\n
    A timeline instead places the same qualifying Entries according to their Timeline Sort values.<\/p>\n\n\n\n
    This allows a single Entry to participate correctly in both a narrative sequence and a chronological reference view.<\/p>\n\n\n\n
    Building Different Timelines From the Same Entries<\/h2>\n\n\n\n
    Because the timeline is generated dynamically, the same underlying Entries can support multiple chronological views.<\/p>\n\n\n\n
    For example, a Gazette might contain:<\/p>\n\n\n\n
    [gazette_timeline]<\/pre>\n\n\n\n
    for a broad setting history,<\/p>\n\n\n\n
    [gazette_timeline types=\"event\"]<\/pre>\n\n\n\n
    for an Event chronology,<\/p>\n\n\n\n
    and:<\/p>\n\n\n\n
    [gazette_timeline types=\"document,event\" min=\"1889-01-01\" max=\"1889-01-31\" orientation=\"vertical\" summary=\"yes\"]<\/pre>\n\n\n\n
    for a detailed January 1889 historical page.<\/p>\n\n\n\n
    The Entries do not need to be copied or entered separately for each timeline.<\/p>\n\n\n\n
    Updating a Timeline<\/h2>\n\n\n\n
    There is no separate timeline record to maintain.<\/p>\n\n\n\n
    Gazette Builder generates the timeline from qualifying Entries whenever the shortcode is displayed.<\/p>\n\n\n\n
    To change the timeline’s contents, change the Entries or the shortcode criteria:<\/p>\n\n\n\n
      \n
    • add a Timeline Sort value to an Entry;<\/li>\n\n\n\n
    • change an Entry’s Timeline Sort value;<\/li>\n\n\n\n
    • change its Entry Type;<\/li>\n\n\n\n
    • publish or release the Entry;<\/li>\n\n\n\n
    • change the types<\/code>, min<\/code>, or max<\/code> filters in the shortcode.<\/li>\n<\/ul>\n\n\n\n
      The corresponding timeline then reflects the eligible Entries automatically.<\/p>\n\n\n\n
      The practical rule is simple: Campaign Date tells the reader when it happened; Timeline Sort tells GazetteBuilder where it belongs.<\/strong><\/p>\n","protected":false},"excerpt":{"rendered":"
      GazetteBuilder can generate chronological views from Entries that contain a Timeline Sort value. Timelines are inserted into normal WordPress content using the: [gazette_timeline] shortcode. The shortcode can display all eligible timeline Entries or narrow the results by Entry Type and date range. Timelines may be presented horizontally or vertically and can optionally include each Entry’s […]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-9113","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/metaphaze.com\/gazettebuilder\/wp-json\/wp\/v2\/pages\/9113","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/metaphaze.com\/gazettebuilder\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/metaphaze.com\/gazettebuilder\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/metaphaze.com\/gazettebuilder\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/metaphaze.com\/gazettebuilder\/wp-json\/wp\/v2\/comments?post=9113"}],"version-history":[{"count":1,"href":"https:\/\/metaphaze.com\/gazettebuilder\/wp-json\/wp\/v2\/pages\/9113\/revisions"}],"predecessor-version":[{"id":9114,"href":"https:\/\/metaphaze.com\/gazettebuilder\/wp-json\/wp\/v2\/pages\/9113\/revisions\/9114"}],"wp:attachment":[{"href":"https:\/\/metaphaze.com\/gazettebuilder\/wp-json\/wp\/v2\/media?parent=9113"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}