schooldirectory
jweiland/schooldirectory
7.0
en
Stefan Froemken
This document is published under the Creative Commons BY 4.0 license.
Tue, 10 Jun 2025 10:16:15 +0000
Manual covering TYPO3 extension schooldirectory
Table of Contents
schooldirectory is an extension for TYPO3 CMS. It is useful to manage and display schools for a city.
Target group: Editors
Insert PluginPlugin select Schooldirectory from selectbox.SchoolIf your TYPO3 installation works in composer mode, please execute following command:
composer req jweiland/schooldirectory
vendor/bin/typo3 extension:setup --extension=schooldirectoryIf you work with DDEV please execute this command:
ddev composer req jweiland/schooldirectory
ddev exec vendor/bin/typo3 extension:setup --extension=schooldirectoryOn non composer based TYPO3 installations you can install schooldirectory still
over the ExtensionManager:
Login
Login to backend of your TYPO3 installation as an administrator or system maintainer.
Open ExtensionManager
Click on Extensions from the left menu to open the ExtensionManager.
Update Extensions
Choose Get Extensions from the upper selectbox and click on
the Update now button at the upper right.
Install schooldirectory
Use the search field to find schooldirectory. Choose the schooldirectory
line from the search result and click on the cloud icon to
install schooldirectory.
This chapter describes the various configuration settings of 'schooldirectory`.
Some general settings for schooldirectory can be configured
in Admin Tools -> Settings.
Default: 0
Only valid, if you have installed EXT:, too.
While creating location records we catch the address and automatically create a maps2 record for you. Define a storage PID where we should store these records.
Tip
You must configure the extension maps2 first to run this extension correctly.
Default: Value from Constants EXT:schooldirectory/Resources/Private/Templates/
You can override our Templates with your own SitePackage extension. We prefer to change this value in TS Constants.
Default: Value from Constants EXT:schooldirectory/Resources/Private/Partials/
You can override our Partials with your own SitePackage extension. We prefer to change this value in TS Constants.
Default: Value from Constants EXT:schooldirectory/Resources/Layouts/Templates/
You can override our Layouts with your own SitePackage extension. We prefer to change this value in TS Constants.
Set this value to a Storage Folder (PID) where you have stored the records.
Example: plugin.
Default: 0
Example: plugin.
Define the page UID where the EXT:maps2 plugin is located to show an address on a map.
Default: 0
Example: plugin.
Often it is useful to move the detail view onto a separate page for design/layout reasons.
Default: 0
Example: plugin.
Define the page UID where you have inserted the search plugin of
schooldirectory.
Here you can define the width and height of images in list view.
Example:
settings {
list {
width = 50c
height = 50c
minWidth = 50
maxWidth = 50
minHeight = 50
maxHeight = 50
}
}Here you can define the width and height of images in show view.
Example:
Example:
settings {
show {
width = 240c
height = 180c
}
}Default: 1
Example: plugin.
Merge record titles starting with numbers to 0- in glossary.
Default: 1
Example: plugin.
Prepend an additional button in front of the glossary to show all records again.
Default: 15
Example: plugin.
Reduce result of records to this value for a page
This chapter describes how to manage the extension from a superuser point of view.
With TYPO3 9 you have the possibility to configure RouteEnhancers
routeEnhancers:
SchooldirectoryPlugin:
type: Extbase
extension: Schooldirectory
plugin: List
limitToPages: [27]
routes:
-
routePath: '/{letter}'
_controller: 'School::list'
-
routePath: '/schulen/s/info/{school_title}'
_controller: 'School::show'
_arguments:
school_title: school
requirements:
letter: '^(0-9|[a-z])?$'
school_title: '^[a-zA-Z0-9\-_]+$'
defaultController: 'School::list'
aspects:
school_title:
type: PersistedAliasMapper
tableName: tx_schooldirectory_domain_model_school
routeFieldName: path_segment
letter:
type: StaticValueMapper
map:
0-9: 0-9
'a': 'a'
'b': 'b'
'c': 'c'
'd': 'd'
'e': 'e'
'f': 'f'
'g': 'g'
'h': 'h'
'i': 'i'
'j': 'j'
'k': 'k'
'l': 'l'
'm': 'm'
'n': 'n'
'o': 'o'
'p': 'p'
'q': 'q'
'r': 'r'
's': 's'
't': 't'
'u': 'u'
'v': 'v'
'w': 'w'
'x': 'x'
'y': 'y'
'z': 'z'
'': ''If you update EXT:schooldirectory to a newer version, please read this section carefully!
We have added TYPO3 11 compatibility.
We have moved Schooldirectory.js from TypoScript to f:asset VH. Please update your own partials to load that file with f:asset.
We have removed TYPO3 9 compatibility.
As ViewHelper widgets are deprecated since TYPO3 10, we have completely reworked the Ajax Search Widget. Further we are using the the Paginator API. So please update following Fluid Templates:
We have completely rewritten the JavaScript. If you have a modified version, please update to your needs.
We have changed some method arguments, please flush cache in InstallTool
We have remove TYPO3 8 compatibility. We have added TYPO3 10 compatibility. Please execute the schooldirectory UpgradeWizards in Installtool.
It may happen that AJAX requests will not work in development mode, because of appended "Parse time" by TYPO3.
The links to issue and the GitHub repository are maintained in the Settings.cfg.
You may want to remove this file if all important links are already handled in Settings.cfg.