Masterplan

Classification: masterplan
Version: main
Language: en
Description: Manual covering TYPO3 extension masterplan
Keywords: project, a-z, navigation
Copyright: 2013-2019
Author: Stefan Froemken
Email: projects@jweiland.net
License: This document is published under the Open Publication License available from http://www.opencontent.org/openpub/
Rendered: Wed, 07 Jan 2026 18:57:13 +0000

The content of this document is related to TYPO3, a GNU/GPL CMS/Framework available from www.typo3.org.

Table of Contents

Introduction

What does it do?

With masterplan you can create and show projects you're currently working on and show detail information onto your website. You can define start- and end date, add some pictures or additional files for download.

Currently this extension has a hard-coded relation to EXT:service_bw2.

Users Manual

Target group: Editors

Select a page where you want to insert masterplan
Insert a new content element of type: Insert Plugin
On tab Plugin select Masterplan from selectbox.
Confirm reload to load special input fields for our extension (FlexForm).
Save

Project Record

Select a Storage Page
Create a new record of type Project
Give it a title and maybe add some images and further information.
Enter a description which will be shown on configured detail page
By default you can insert up to 5 images to project record.
At tab Categories you can relate your project to a category.

Installation

Target group: Administrators

The extension needs to be installed like any other extension of TYPO3 CMS:

Visit ExtensionManager
Switch over to Get Extensions
Search for masterplan
Install extension

Configuration

Target group: Developers, Integrators

How to configure the extension. Try to make it easy to configure the extension. Give a minimal example or a typical example.

Minimal Example

It is necessary to include static template Masterplan (masterplan)

We prefer to set a Storage PID with help of TypoScript Constants:

plugin.tx_masterplan.persistence {
   # Define Storage PID where project records are located
   storagePid = 4
}

TypoScript Setup Reference

pidOfDetailPage

Example: plugin.tx_masterplan.settings.pidOfDetailPage = 4

If you want, you can change the links in project listing to link to another page UID. By default the detail view uses current page.

pidOfListPage

Example: plugin.tx_masterplan.settings.pidOfListPage = 2

If you have defined a detail page you may link back to the list page. By default the link back to list view used the current page.

pidOfLocationPage

Example: plugin.tx_masterplan.settings.pidOfLocationPage = 3

You can assign a PoiCollection of EXT:maps2 to a project. Choose a page UID where the maps2 plugin is located.

list

Default: 50c for width and height

Example: plugin.tx_masterplan.settings.list.image.width = 150c

Currently not implemented in Template, but if you want, you can use this setting to show one or more images with a defined width and height.

show

Default: 240c for width and 180c for height

Example: plugin.tx_masterplan.settings.show.image.width = 120c

If you want, you can use this setting to show one or more images with a defined width and height.

pageBrowser

You can fine tuning the page browser

Example: plugin.tx_masterplan.settings.pageBrowser.itemsPerPage = 15 Example: plugin.tx_masterplan.settings.pageBrowser.insertAbove = 1 Example: plugin.tx_masterplan.settings.pageBrowser.insertBelow = 0 Example: plugin.tx_masterplan.settings.pageBrowser.maximumNumberOfLinks = 5

itemsPerPage

Reduce result of project records to this value for a page

insertAbove

Insert page browser above list of project records

insertBelow

Insert page browser below list of project records. I remember a bug in TYPO3 CMS. So I can not guarantee that this option will work.

maximumNumberOfLinks

If you have many project records it makes sense to reduce the amount of pages in page browser to a fixed maximum value. Instead of 1, 2, 3, 4, 5, 6, 7, 8 you will get 1, 2, 3...8, 9 if you have configured this option to 5.

Administrator manual

This chapter describes how to manage the extension from a superuser point of view.

Routes

With TYPO3 9 you have the possibility to configure RouteEnhancers

Example Configuration

routeEnhancers:
  MasterplanPlugin:
    type: Extbase
    extension: Masterplan
    plugin: Masterplan
    routes:
      -
        routePath: '/first-masterplan-page'
        _controller: 'Project::list'
      -
        routePath: '/show/{project_title}'
        _controller: 'Project::show'
        _arguments:
          project_title: project
    requirements:
      project_title: '^[a-zA-Z0-9\-]+$'
    defaultController: 'Project::list'
    aspects:
      project_title:
        type: PersistedAliasMapper
        tableName: tx_masterplan_domain_model_project
        routeFieldName: path_segment

Updating

If you update EXT:masterplan to a newer version, please read this section carefully!

Update to Version 4.0.0

We have removed TYPO3 9 compatibility.

As f:widget.paginate is deprecated and POST requests are not allowed anymore in this widget, we have rewritten the widget to new TYPO3 Pagination API.

Please remove the f:widget.paginate from Templates and insert this code:

<f:render partial="Component/Pagination"
          arguments="{pagination: pagination, paginator: paginator, actionName: actionName}" />

Update to Version 3.0.4

We have changed some method arguments, please flush cache in InstallTool

Update to Version 3.0.0

We have removed TYPO3 8 and added TYPO3 10 compatibility. With this change we have removed all ViewHelpers.

mp:getTarget(): You will find targets in {project.areaOfActivity} in sub-property targets. mp:getAreaOfActivities(): Please use {project.areaOfActivity} or new {areaOfActivities} mp:sorting(): Was not used since over 5 years.

Known Problems

Currently masterplan has a hard-coded relation to EXT:service_bw2. So, if you don't have an account for Service BW this extension may not be the right one for you.

ChangeLog

Version 6.0.5

[TASK] Updated wizard title with [extension] name format

Version 6.0.4

[BUGFIX] Remove deprecated usage of SoftRef parser: images

Version 6.0.3

[BUGFIX] Removed Lazy Load for Category property

Version 6.0.2

[BUGFIX] Fixed Property Type issues

Version 6.0.1

[TASK] SiteSets Configuration fixes
[BUGFIX] Fixed invalid Controller action combination

Version 6.0.0

TYPO3 13 LTS Compatibility Fixes
Remove old version compatibilities

Version 4.0.0

Remove TYPO3 9 compatibility
Add Events to all Controller Actions
Add Event Listener to add Pagination

Version 3.0.4

Move SlugHelper from constructor argument into getSlugHelper()

Version 3.0.2

Add addQueryStringMethod to f:widget.paginate

Version 3.0.1

Set title as required, as it is required for path_segment generation

Version 3.0.0

Removed TYPO3 8 compatibility
Add TYPO3 10 compatibility
Removed all masterplan ViewHelpers
Wrapped all templates in HTML namespace
New SVG icons for extension and tables
Implement new structure of areaOfActivities
Better structure of TCA for backend
Repair filtering projects in ProjectRepository
Add path_segment for Slugs incl. UpgradeWizard
Add new documentation

Contribute

Contribution to masterplan is very welcome.

If you wish to contribute, please follow these conventions:

Writing Issues

If you find a problem in the extension, please write an issue.
If you can fix the problem yourself, please submit a pull request. In this case, it is not necessary to create an issue first.

Submitting a Pull Request

Please adhere to TYPO3 Coding Guidelines
For commit messages, please follow the TYPO3 Commit Message Rules

Please see the general GitHub documentation for more information, for example Creating a pull request