---
title: "Users manual"
manual: "clubdirectory"
version: "main"
permalink: "https://docs.typo3.org/permalink/jweiland/clubdirectory:user-manual@main"
source: "User/Index.rst"
rendered: "2026-11-03T10:50:24+00:00"
---

# Users manual {#user-manual}

Target group: **Editors**

1.  Select a page where you want to insert clubdirectory
1.  Insert a new content element of type `Club Directory` from the tab
    **Plugins** of the content element wizard.
1.  On tab **Plugin** configure the options of the plugin.
1.  Save

## Plugins {#user-manual-plugins}

-   **`Club Directory`**

    Shows the list of clubs with an A-Z navigation and the detail view of
    a club.

-   **`Club Directory Management`**

    Lets logged-in frontend users create, edit and manage their own clubs.
    New and changed clubs are hidden until the administrator activates
    them, see [Club management and moderation](https://docs.typo3.org/permalink/jweiland/clubdirectory:moderation@main).

-   **`Club Directory Search`**

    Shows the search form and the search results.

Your administrator configures on which pages these plugins are placed, see
[Pages](https://docs.typo3.org/permalink/jweiland/clubdirectory:site-settings-pages@main).

## Plugin options {#user-manual-plugin-options}

The following options are available for the plugin `Club Directory`.

### Show A-Z links {#user-manual-plugin-options-glossary}

You can decide to show A-Z links above or not. Whether an additional
All-link is prepended is configured by your administrator in the site
setting [clubdirectory.glossary2.showAllLink](https://docs.typo3.org/permalink/jweiland/clubdirectory:confval-site-setting-glossary2-showalllink@main).

### Category {#user-manual-plugin-options-category}

Sometimes it makes sense to reduce list of club entries to a given category.
The A-Z links only contain letters of clubs in this category.

### Choose a district {#user-manual-plugin-options-district}

Reduce the list of club entries to a given district. The A-Z links only
contain letters of clubs in this district.

## Detail view of a club {#user-manual-detail-view}

The detail view shows the properties of the club, including its
categories and tags, and its addresses. Addresses with a POI record link
to a map, see [clubdirectory.pidOfMaps2Plugin](https://docs.typo3.org/permalink/jweiland/clubdirectory:confval-site-setting-pidofmaps2plugin@main).

The search results and the list of own clubs of the plugin
`Club Directory Management` link to the detail view of the plugin
`Club Directory`.

## Club record {#user-manual-club-record}

1.  Select a Storage Page
1.  Create a new record of type `Club`
1.  Give it a title. We will use the first letter of title to sort it into
    our glossary navigation (if activated).
1.  Enter a description which will be shown on configured detail page
1.  By default you can insert up to 5 images to club record.
1.  At tab `Categories` you can relate club entry to a category. That way
    you can show only club records of a defined category in plugin, if you
    want.