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

= Adds an Editor's Guide link to the metanav bar

== Description

This is an Editor's Guide navigation item plugin for Trac.

The plugin adds a navigation item to '''metanav''', which links to the Editor's Guide. This link is visible only for users who have permission to edit wiki pages.

== Bugs/Feature Requests

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

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

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

== Download

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

== Source

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

== Installation

 1. Run: `python setup.py compile_catalog -f` ('''only for Trac 0.12''').
 1. Run: `python setup.py bdist_egg`.
 1. If necessary create a folder called `plugins` in your Trac environment.
 1. Copy the .egg file from the dist folder created by step 1 into the `plugins` directory of your Trac environment.

== Configuration

If necessary, edit your `trac.ini` file as follows:

{{{#!ini
[editorguide]
page = MyEditorGuide
}}}

By default item links to page !EditorGuide.

== Recent Changes

[[ChangeLog(editorguideplugin, 3)]]

== Author/Contributors

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