[[PageOutline(2-5,Contents,pullout)]]

= Display navigation menu as fixed menu or other navigation options

== Description

Normally, when you scroll a Trac page, the main menu and other navigation controls may scroll out of the visible area. This plugin enables a more elegant way: either let the main menu stay fixed on top of the window or add bottom controls of context navigation.

Type of displaying menu, see screenshot of [/attachment/wiki/NavigationDisplayPlugin/prefs_display_sample.png PreferencePanel]. Possible types are:
 - `normal` (default): leaves menu as in the Trac standard
 - `fixed_menu`: fixes menu on top of browser window
 - `buttom_ctx_menu`: adds context menu at bottom of page, if available

This plugin implements [t:#8135].

Furthermore mainnav entries are customizable through the user preferences page, see also [t:#10543].

=== Screenshot for option `fixed_menu`

[[Image(fixed_menu_sample.png, border=2)]]

=== Screenshot for option `buttom_ctx_menu`

[[Image(buttom_ctx_menu_sample.png, border=2)]]

=== Preference Panel

The display types can be set by each user differently through the Preferences panel:

[[Image(prefs_display_sample.png, border=2)]]

== Bugs/Feature Requests

Existing bugs and feature requests for NavigationDisplayPlugin are 
[report:9?COMPONENT=NavigationDisplayPlugin here].

If you have any issues, create a 
[/newticket?component=NavigationDisplayPlugin new ticket].

[[TicketQuery(component=NavigationDisplayPlugin&group=type,format=progress)]]

== Download

Download the zipped source from [export:navigationdisplayplugin here].

== Source

You can check out NavigationDisplayPlugin from [/svn/navigationdisplayplugin here] using Subversion, or [source:navigationdisplayplugin browse the source] with Trac.

== Installation

General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.

== Configuration

You can set the system default value in your `trac.ini` file as follows:
{{{#!ini
[trac]
display_nav = fixed_menu
}}}

Possible values for option `display_nav` are described above. If you do not specify them, then this plugin has no effect.

== Recent Changes

[[ChangeLog(navigationdisplayplugin, 3)]]

== Author/Contributors

'''Author:''' [wiki:framay] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:'''