TYPO3 Logo
How to Document TYPO3
Options
Give feedback View source How to edit Edit on GitHub Full documentation (single file)

How to Document TYPO3

BASICS

  • Basic principles
  • ReST Cheat Sheet
  • Markdown Cheat Sheet

REFERENCE

  • reStructuredText
    • Code blocks and code structure
      • Code blocks with syntax highlighting
      • Configuration values (confval)
      • Inline code & text roles
      • PHP domain
      • Site settings
    • Content styles and content elements
      • Accordion
      • Admonitions: Tip, Note, Warning, See also, etc
      • Bold, Italic etc.
      • Cards
      • Comments
      • Special characters
      • Tables
      • Tabs
      • Versions
      • ViewHelper
      • Embed YouTube videos
    • Figures and diagrams
      • Images
      • PlantUML diagrams
    • Links
      • Anchors
      • API links
      • Composer / Extensions
      • Core source
      • Documentation references
      • example.org
      • External URLs
    • Lists
      • Styled numbered sections (bignums)
      • Bullet lists / unordered lists
      • Definition lists
      • Directory tree
      • List items as buttons
      • Numbered lists
    • Menus and headers
      • Headlines
      • Main menu
      • Content menu
      • Including files
      • Navigation title
      • Orphans
      • Sidebar
  • CGL for ReST files
  • File structure
  • guides.xml
  • Rendering container

HOWTOS

  • Edit Locally
  • Edit on GitHub
  • Contribute
    • Help
  • Migrate
    • Markdown to ReST
  • Render
  • Document extensions
    • Webhook
    • Reregister versions
    • FAQ
    • Contribute to system extensions
    • Contribute to third-party extensions

ADVANCED

  • Advanced
    • Coding guidelines for reST files
    • Spelling
    • Formats (reST, Markdown)
    • Spelling, terms and glossary
    • Guidelines for creating images
    • How to add translations
    • Licenses
    • Policy for making and reviewing contributions

MAINTAINERS

  • For maintainers
    • Backport changes
    • Apply changelog entries to the docs
    • Code snippet generation
    • Fluid ViewHelper reference generation
    • New major Core version is released
    • Tools of the Documentation Team
  • Sitemap
  1. How to Document
  2. reStructuredText
  3. Menus and headers
  4. Navigation title
Give feedback Edit on GitHub

Navigation title: A page title displayed in menus

It is possible to define a different, usually shorter, title for a page to be displayed in menus.

While the title of a page is a very important tool to pass information to both the readers and search engines including our internal elastic search, elaborate titles usually take up to much space within the menu, the breadcrumb etc.

For example, the title of the page you are currently reading is quite long: Navigation title: A page title displayed in menus. This title is also used as automatic title in references, unless otherwise specified: Navigation title: A page title displayed in menus.

However in the main menu and in the breadcrumb the shorter navigation title is displayed.

A navigation title can be defined as follows:

:navigation-title: Navigation title

..  include:: /Includes.rst.txt
..  _navigation-title:

=================================================
Navigation title: A page title displayed in menus
=================================================

[...]

For example, the title of the page you are currently reading is quite long:
`Navigation title: A page title displayed in menus`. This title is also used
as automatic title in references, unless otherwise specified:
:ref:`navigation-title`.
Copied!
  • Previous
  • Next
Reference to the headline

Copy and freely share the link

This link target has no permanent anchor assigned. You can make a pull request on GitHub to suggest an anchor. The link below can be used, but is prone to change if the page gets moved.

Copy this link into your TYPO3 manual.

  • Home
  • Contact
  • Issues
  • Repository

Last rendered: May 03, 2025 12:46

© since 2017 by the TYPO3 contributors
  • Legal Notice
  • Privacy Policy