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

= Miscellaneous functions to ticket view: CKEditor, navigation table, descriptions, sorting versions

== Description

=== Component `TextAreaDescription`

Shows next to a text area (like description itself or any custom description) an description for what the field is for.

Default values for options:
{{{#!ini
[ticket]
description_descr = 
descr_template = <div style="white-space: normal; height: 250px; overflow:scroll;" class="system-message">%s<div>
}}}

See [/attachment/wiki/TicketNavPlugin/TextAreaDescription.png Screenshot].

=== Component `CssTemplate`

Add links to style sheets located in templates folder.

[http://en.wikipedia.org/wiki/Cascading_Style_Sheets CSS] files started with `"all_templates"` are added for all Trac sites. 
CSS files starting with template name (without `.html`-suffix) are added for specific template.

To apply changes you need to restart the server. 

Examples for files which resides in projects `templates` folder:
|| `all_templates_general.css` || added to all Trac sites ||
|| `ticket_additional.css` || only added for `ticket.html` pages || 

For discussion in Trac about this topic, see [http://trac.edgewall.org/ticket/9683 Trac ticket #9683].

=== Component `CustomizedTicketView`

Small changes of ticket view.

Concretely:
 * disables field `field-reporter`, so it cannot be changed anymore
 * disables button `Reply`, so no comment could be made to any description

This plugin might interested you as well: SimpleTicketPlugin

See [/attachment/wiki/TicketNavPlugin/CustomizedTicketView.png Screenshot].

=== Component `SortMilestoneVersion`

Sorts drop-down lists of version and milestone regardless of the case and make milestone a must field, when a default milestone is set.

Default behavior of Trac for sorting milestones is:
{{{
inbox, v1, v2, Inbox, V1, V2
}}}

This plugin sorts it as following:
{{{
inbox, Inbox, v1, V1, v2, V2
}}}

=== Component `TicketNavigation`

Implements an extra Navigation menu by dividing the main ticket information in an several div areas an providing a "jump-to" to the anker with are represented in the navigation box.

== Screenshots

[[Image(TextAreaDescription.png)]]

''Screenshot of `TextAreaDescription` (red box under Beschreibung aka description) and `HtmlContent` (Editor)''

[[Image(CustomizedTicketView.png)]]

''Screenshot of `CustomizedTicketView` -- creator "Ersteller" is disabled, so it cannot be changed''

[[Image(TicketNavigation.png)]]

''Screenshot of `TicketNavigation` -- list of headers are as toolbox under mainnav''

[[Image(SortMilestones.png)]]

''Screenshot of `SortMilestoneVersion` -- milestones are sorted by name regardless of their case (upper case "TBD" is next to lower case "tbd")''

[[Image(Sortversions.png)]]

''Screenshot of `SortMilestoneVersion` -- versions are sorted in alphabetical order instead of their due / completion date''

== Bugs/Feature Requests

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

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

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

== Download

Download the zipped source from [download:ticketnavplugin here].

Or download the pre-compiled [raw-attachment:TicketDisplay-0.4.0-py2.6.egg python egg].

== Source

You can check out TicketNavPlugin from [http://trac-hacks.org/svn/ticketnavplugin here] using Subversion, or [source:ticketnavplugin browse the source] with Trac.

== Example

=== Sample configuration of `TextAreaDescription`

{{{
descr_template = <div style="white-space: normal; height: 250px; overflow:auto;text-align:left;" class="system-message">%s<div>
description_descr = <div style="font-weight: bold">Folgende Fragen sollen beantworten werden:<br/></div><ul><li>Was wurde gemacht?</li></ul>
}}}

=== Sample configuration of `HtmlContent`

{{{#!ini
[ticket]
description_format = html
editor_source = site/js/ckeditor/ckeditor.js
editor_replace = <script type="text/javascript">CKEDITOR.replace('@FIELD_NAME@', {toolbar: 'custom'});</script>
additional_css = site/css/add_ticket.css
}}}

== Recent Changes

[[ChangeLog(ticketnavplugin, 3)]]

== Author/Contributors

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