-
Notifications
You must be signed in to change notification settings - Fork 111
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[FEATURE] Document Navigation title (#422)
- Loading branch information
Showing
1 changed file
with
44 additions
and
0 deletions.
There are no files selected for viewing
44 changes: 44 additions & 0 deletions
44
Documentation/WritingReST/Reference/Menus/NavigationTitle.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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`. |