Content Planner 

Extension key

xima_typo3_content_planner

Package name

xima/xima-typo3-content-planner

Version

main

Language

en

Author

Konrad Michalik & contributors

License

This extension documentation is published under the CC BY-NC-SA 4.0 (Creative Commons) license.

This extension provides a colorful page* status functionality to support the planning of content work, e.g. a migration process.

(* also supports other records as well)

Introduction 

What does it do? 

This extension provides a page status functionality to support the planning of content work, e.g. a migration process.

Screencast 

Installation 

composer require xima/xima-typo3-content-planner

vendor/bin/typo3 database:updateschema
vendor/bin/typo3 extension:setup --extension=xima_typo3_content_planner

Configuration 

The extension is ready to use without any further setup.

You can also adapt the extension to your needs, switch features on and off and influence the visibility of the Content Planner.

Learn what configuration options are available on the following pages:

Status 

Default Status 

By default, they are four different default status available:

• Pending: The page is not yet ready for editing.
• In progress: The page is currently being edited.
• Needs review: The page is ready for review.
• Completed: The page is ready to be published.

Note

These statuses are only intended as an initial configuration. Customize the statuses according to your needs.

Custom Status 

The status are content generated on the root page.

You can add a new status, edit an existing status, change the status order or delete a status.

Field:	Description:
Title	Title of the status.
Icon	Select one of the existing icons as representative picture of the status.
Color	Select one of the existing colors for this status.

Extension configuration 

1. Go to Admin Tools > Settings > Extension Configuration
2. Choose xima_typo3_content_planner

The extension currently provides the following configuration options:

Permissions 

Access to the Content Planner functionalities is generally available to all admin users.

All other users require the necessary authorization via the TYPO3 backend permissions module.

User Settings 

The following options can be set in the user settings:

Usage 

This section describes how to properly use the extension in various ways.

Status Change 

They are several ways to change the status of a page or a record.

Page Tree 

In the page tree, you can change the status of a page via the context menu.

Module Header 

In the module header of the modules web_layout, web_list, record_edit and file_list, you can change the status of a page via the status dropdown.

Edit Form 

In the edit form of a record, you can change the status in the "Content Planner" tab.

Record List 

In the record list, you can change the status of a record via the dropdown.

Note

These option is only available for additional database records with status behavior.

Update multiple records 

New in version 1.3.0

Feature: #50 - Add table header bulk status update action

Within the record list, you can also change the status of multiple records at once.

Select the records you want to change the status of (or "Check all") and use the status dropdown in the table header.

Tip

Otherwise use the console command to update multiple records at once.

Assignee 

For every content planner record, an assignee can be set. The assignee is the person responsible for the record.

Only users with admin rights and the necessary permission can be selected.

Selection 

New in version 1.5.0

Feature: #88 - Introduce user selection modal

By clicking the assignee field in the header bar, a selection dialog will open. This dialog allows you to select a user as assignee for the record. The dialog will show all users with admin rights and the necessary permission.

Shortcuts 

Use the shortcuts beneath the select field for "Assign to me" and "Unassign" to quickly change the assignee.

Edit Form 

The assignee can be select in the edit form of the record in the "Content Planner" tab.

Comments 

Every backend user with Content Planner access can add comments to records. Comments are a great way to communicate with other users about the status of a record or to provide additional information.

Create new comment 

Show comments 

Edit comments 

New in version 1.4.0

Feature: #70 - Add edit comment functionality and associated UI updates

Use the context menu to edit, resolve or delete a comment.

An edited comment is marked with a label.

ToDos 

New in version 1.4.0

Feature: #69 - Add todo tracking to comments with resolved and total counts

Use the ToDo list within the editor to track the progress of your comments.

The ToDo count is automatically updated when you add or remove a ToDo item in the comment.

Use the ToDo widget to keep track of your ToDo tasks.

Resolution 

New in version 1.4.0

Feature: #72 - Add comment resolution functionality with sorting and filtering options

In addition to the ToDos in the comments, there is also the option of marking entire comments as completed, in order to keep the comment list clear and organized.

A comment can be marked as completed via the context menu.

Share link 

New in version 2.1.0

Comments and the entire comment modal can be shared with other backend users via a direct link. The link navigates the recipient to the record, automatically opens the comment modal and, if a specific comment was shared, scrolls to it and briefly highlights it.

Use the context menu of a comment to copy the share link to the clipboard. To share a link to the entire comment modal, use the action menu in the filter bar.

Filelist 

The Content Planner extension supports status management for files and folders in the TYPO3 Filelist module. This allows you to track the status of media assets during content migration or review processes.

Folder Status 

Folders can have a status assigned. The status is displayed in the folder tree and in the filelist header when viewing the folder contents.

The folder status header shows:

• Current status with color indicator
• Assignee selection
• Quick actions for comments

Dashboard 

The extension brings a prepared dashboard preset with a set of widgets to support the content planning process.

Create 

To create a new dashboard, click on the "Add dashboard" (+) button near the dashboard tabs in the dashboard module.

Otherwise you can add the widgets manually to an existing dashboard.

Widgets 

The dashboard provides a set of helpful widgets to get an overview of the current status of the content planner records.

Widget:	Description:
Overview	Bar chart showing the distribution of records by status.
Recent Updates	Update stream showing the latest changes to the content planner records.
Current Assignee	Short list with all records assigned to the current user.
ToDo	Display all records with open todos in the comments.
Recent Comments	Showings the latest comments on the content planner records.
Status	Filterable list of all records with the current status.
Content Planner (Configurable)	A fully customizable widget that combines the functionality of multiple widgets. Available in TYPO3 v14+ only. See Configurable Widget for details.

Command 

The extension provides the following console commands:

vendor/bin/typo3 content-planner:bulk-update

typo3/sysext/core/bin/typo3 content-planner:bulk-update

Developer corner 

Many of the content planner processes are configurable or can be extended with custom implementations. This section provides an insight into which development options are available and how these can be integrated into the status process.

Additional Records 

By default the Content Planner supports the status functionality only for pages. If you want to use the status functionality for other record types, you can extend the Content Planner to support additional record types.

Follow the steps below to extend the Content Planner to support additional records, e.g. news or tt_content records:

1. Extend the additional record TCA (e.g. for news records):

\Xima\XimaTypo3ContentPlanner\Utility\ExtensionUtility::addContentPlannerTabToTCA('tx_news_domain_model_news');

2. Extend the necessary database fields:

CREATE TABLE tx_news_domain_model_news
(
    tx_ximatypo3contentplanner_status   int(11) DEFAULT NULL,
    tx_ximatypo3contentplanner_assignee int(11) DEFAULT NULL,
    tx_ximatypo3contentplanner_comments int(11) unsigned default '0' not null,
);

3. Register the additional record:

$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['xima_typo3_content_planner']['registerAdditionalRecordTables'][] = 'tx_news_domain_model_news';

PSR-14 Events 

The extension contains some PSR-14 events which make it possible to extend the extension with own functionality. You can for example adjust the status selection or react on status changes for implementing some kind of a workflow.

If you are new to PSR-14 events, please refer to the official TYPO3 documentation about PSR-14 events and Event Listeners.

<?php
namespace MyVendor\MyExtension\EventListener;

use Xima\XimaTypo3ContentPlanner\Event\PrepareStatusSelectionEvent;

final class ModifyStatusSelectionListener
{
    public function __invoke(PrepareStatusSelectionEvent $event): void
    {
        $table = $event->getTable();
        $uid = $event->getUid();
        $selectionEntries = $event->getSelectionEntriesToAdd();

        // Remove a specific status from selection
        unset($selectionEntries['3']);

        $event->setSelectionEntriesToAdd($selectionEntries);
    }
}

MyVendor\MyExtension\EventListener\ModifyStatusSelectionListener:
  tags:
    - name: event.listener
      identifier: 'my-extension/modify-status-selection'

<?php
namespace MyVendor\MyExtension\EventListener;

use Xima\XimaTypo3ContentPlanner\Event\StatusChangeEvent;

final class StatusChangeListener
{
    public function __invoke(StatusChangeEvent $event): void
    {
        $table = $event->getTable();
        $uid = $event->getUid();
        $newStatus = $event->getNewStatus();
        $previousStatus = $event->getPreviousStatus();

        // Example: Send notification when status changes to a specific status (uid 3)
        if ($newStatus?->getUid() === 3) {
            // Trigger notification logic
        }
    }
}

MyVendor\MyExtension\EventListener\StatusChangeListener:
  tags:
    - name: event.listener
      identifier: 'my-extension/status-change'

Planner Utility 

The PlannerUtility can be used to easily interact programmatically with the content planner.

class PlannerUtility

Fully qualified name

\Xima\XimaTypo3ContentPlanner\Utility\PlannerUtility

Utility class to use content planner functionalities.

getListOfStatus ( )

Simple function to get a list of all available status.

returntype

array

updateStatusForRecord ( $table, $uid, $status, $assignee = null)

Simple function to update the status of a record.

param string $table

Table name of the record.

param int $uid

UID of the record.

param \Xima\XimaTypo3ContentPlanner\Domain\Model\Status|int|string $status

Status object, UID or title of the status.

param \Xima\XimaTypo3ContentPlanner\Domain\Model\BackendUser|int|string|null $assignee

Optional user object, UID or username of the assignee.

returntype

void

getStatusOfRecord ( $table, $uid)

Simple function to get the status of a record.

param string $table

Table name of the record.

param int $uid

UID of the record.

returntype

\Xima\XimaTypo3ContentPlanner\Domain\Model\Status|null

getStatus ( $identifier)

Simple function to get a status.

param int|string $identifier

UID or title of the status record.

returntype

\Xima\XimaTypo3ContentPlanner\Domain\Model\Status|null

getCommentsOfRecord ( $table, $uid, $raw = false)

Simple function to fetch all comments of a record.

param string $table

Table name of the record.

param int $uid

UID of the record.

param bool $raw

Get raw comment records instead of optimized DTOs.

returntype

array

addCommentsToRecord ( $table, $uid, $comments, $author = null)

Simple function to fetch all comments of a record.

param string $table

Table name of the record.

param int $uid

UID of the record.

param array|string $comments

Single comment string or array of multiple comments in a row.

param \Xima\XimaTypo3ContentPlanner\Domain\Model\BackendUser|int|string|null $author

Optional user object, UID or username of the author.

returntype

void

generateTodoForComment ( $todos)

Simple function to generate the html todo markup for a comment to easily insert them into the comment content.

param array $todos

Array of todo strings.

returntype

string

clearCommentsOfRecord ( $table, $uid, $like = null)

Simple function to clear all comment(s) of a content planner record.

param string $table

Table name of the record.

param int $uid

UID of the record.

param string|null $like

Optional string to filter comments by content.

returntype

void