Skip to content

Commit

Permalink
[FEATURE] Document Navigation title
Browse files Browse the repository at this point in the history
  • Loading branch information
linawolf committed May 9, 2024
1 parent 8081d06 commit 805f8b8
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions Documentation/WritingReST/Reference/Menus/NavigationTitle.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
:navigation-title: Navigation title

.. _navigation-title:

=================================================
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:
:ref:`navigation-title`.

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

A navigation title can be defined as follows:

.. code-block:: rst
:capition: SomePage.rst
: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`.

0 comments on commit 805f8b8

Please sign in to comment.