Changes between Version 16 and Version 17 of TicketNavPlugin


Ignore:
Timestamp:
Jun 8, 2015, 2:05:41 PM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes, removed descriptions of deprecated components, tagged wtih nolicense

Legend:

Unmodified
Added
Removed
Modified

  • TicketNavPlugin

    v16 v17  
    11[[PageOutline(2-5,Contents,pullout)]]
    22
    3 = Some miscellaneous functions to ticket view (CKEditor, navigation table, descriptions, sorting versions, etc.) =
     3= Miscellaneous functions to ticket view: CKEditor, navigation table, descriptions, sorting versions
    44
    5 == Description ==
     5== Description
    66
    7 === Component `TextAreaDescription` ===
    8 Shows next to a text area (like description itself or any custom description)
    9 an description for what the field is for.
     7=== Component `TextAreaDescription`
     8
     9Shows next to a text area (like description itself or any custom description) an description for what the field is for.
    1010
    1111Default values for options:
    12 {{{
     12{{{#!ini
    1313[ticket]
    1414description_descr =
    … …  
    1818See [/attachment/wiki/TicketNavPlugin/TextAreaDescription.png Screenshot].
    1919
    20 
    21 === Component `CssTemplate` ===
     20=== Component `CssTemplate`
    2221
    2322Add links to style sheets located in templates folder.
    2423
    25 [http://en.wikipedia.org/wiki/Cascading_Style_Sheets CSS] files
    26 started with `"all_templates"` are added for all Trac sites.
    27 CSS files starting with template name (without `.html`-suffix)
    28 are added for specific template.
     24[http://en.wikipedia.org/wiki/Cascading_Style_Sheets CSS] files started with `"all_templates"` are added for all Trac sites.
     25CSS files starting with template name (without `.html`-suffix) are added for specific template.
    2926
    3027To apply changes you need to restart the server.
    … …  
    3633For discussion in Trac about this topic, see [http://trac.edgewall.org/ticket/9683 Trac ticket #9683].
    3734
    38 === Component `CustomizedTicketView` ===
     35=== Component `CustomizedTicketView`
    3936
    4037Small changes of ticket view.
    … …  
    4845See [/attachment/wiki/TicketNavPlugin/CustomizedTicketView.png Screenshot].
    4946
     47=== Component `SortMilestoneVersion`
    5048
    51 === Component `SortMilestoneVersion` ===
    52 Sorts drop-down lists of version and milestone regardless of the case and
    53 make milestone a must field, when a default milestone is set.
     49Sorts drop-down lists of version and milestone regardless of the case and make milestone a must field, when a default milestone is set.
    5450
    5551Default behavior of Trac for sorting milestones is:
    … …  
    6359}}}
    6460
    65 
    66 === Component `TicketNavigation` ===
     61=== Component `TicketNavigation`
    6762
    6863Implements 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.
    6964
    70 
    71 === ~~Component~~ `HtmlContent` (old) ===
    72 
    73 '''Deprecated - use CkEditorPlugin instead! '''
    74 '''See also''' CkEditorPlugin-Tickets #8586 for discussion of implementation.
    75 The scope of CkEditorPlugin is changing output of CKEditor to trac wiki syntax, which would be better tha saving in HTML (as this Component is doing).
    76 
    77 Enables HTML content in description, adding Javascript editor and
    78 adding additional CSS file for manipulation CSS declarations.
    79 
    80 Options:
    81 || '''option name''' || '''values''' || '''description''' ||
    82 || description_format || `wiki` | `html` || format for ticket description (default: '''wiki''') ||
    83 || editor_source || valid path || Usually it should stored in project or common js folder. For ckeditor for example it could be site/js/ckeditor/ckeditor.js. ||
    84 || editor_replace || valid path || Javascript, which should replace textareas. ||
    85 || additional_css || valid path || Path to additional css file, which overrides css-declarations. ||
    86 
    87 Sample configuration:
    88 {{{
    89 [ticket]
    90 description_format = html
    91 editor_source = site/js/ckeditor/ckeditor.js
    92 editor_replace = <script type="text/javascript">CKEDITOR.replace('@FIELD_NAME@', {toolbar: 'custom'});</script>
    93 additional_css = site/css/add_ticket.css
    94 }}}
    95 
    96 In above sample configuration [http://ckeditor.com/ CKEditor] is used as online editor and
    97 the editor source is located in projects-folder `htdocs/js/ckeditor`,
    98 after each `textarea` with HTML-Option content of `editor_replace` will be added.
    99 The file in option `additional_css` will be added and therefore will override these declarations.
    100 
    101 '''Attention:''' To have a correct preview, file `ticket_box.html` has to be edited:
    102 {{{
    103 1 <py:if test="field">
    104 2   <py:choose test="">
    105 3     <py:when test="ticket[field.name] and field.format == 'html'">${wiki_to_html(context, '{{{ \n#!html \n' + ticket[field.name]  + '\n}}}', escape_newlines=preserve_newlines)}</py:when>
    106 4     <py:when test="'rendered' in field">${field.rendered}</py:when>
    107 5     <py:otherwise>${ticket[field.name]}</py:otherwise>
    108 6   </py:choose>
    109 7 </py:if>
    110 }}}
    111 
    112 Line 3 has to be inserted into `py:choose` block in above template-snippet.
    113 
    114 {{{
    115 <div py:if="ticket.description" class="searchable" xml:space="preserve">
    116 <py:choose>
    117     <py:when test="description_format == 'html'">${wiki_to_html(context, '{{{ \n#!html \n' + ticket.description  + '\n}}}', escape_newlines=preserve_newlines)}</py:when>
    118     <py:otherwise>${wiki_to_html(context, ticket.description, escape_newlines=preserve_newlines)}</py:otherwise>
    119 </py:choose>
    120 </div>
    121 }}}
    122 
    123 Also `py:choose` block has to be added into div-block near the end of file (see above template-snippet).
    124 
    125 
    126 === ~~Component~~ `DisplayDate` (old) ===
    127 
    128 '''This Component is removed in version 0.5, since it is fixed in Trac itself with revision 10629'''
    129 (see Trac-Ticket [http://trac.edgewall.org/ticket/9777 #9777]).
    130 
    131 
    132 === Screenshots ===
     65== Screenshots
    13366
    13467[[Image(TextAreaDescription.png)]]
    … …  
    15285''Screenshot of `SortMilestoneVersion` -- versions are sorted in alphabetical order instead of their due / completion date''
    15386
    154 
    155 == Bugs/Feature Requests ==
     87== Bugs/Feature Requests
    15688
    15789Existing bugs and feature requests for TicketNavPlugin are
    … …  
    15991
    16092If you have any issues, create a
    161 [http://trac-hacks.org/newticket?component=TicketNavPlugin&owner=framay new ticket].
     93[/newticket?component=TicketNavPlugin new ticket].
    16294
    163 == Download ==
     95[[TicketQuery(component=TicketNavPlugin&group=type,format=progress)]]
     96
     97== Download
    16498
    16599Download the zipped source from [download:ticketnavplugin here].
    … …  
    167101Or download the pre-compiled [raw-attachment:TicketDisplay-0.4.0-py2.6.egg python egg].
    168102
    169 == Source ==
     103== Source
    170104
    171105You can check out TicketNavPlugin from [http://trac-hacks.org/svn/ticketnavplugin here] using Subversion, or [source:ticketnavplugin browse the source] with Trac.
    172106
    173 == Example ==
     107== Example
    174108
    175 === Sample configuration of `TextAreaDescription` ===
     109=== Sample configuration of `TextAreaDescription`
    176110
    177111{{{
    … …  
    180114}}}
    181115
    182 === Sample configuration of `HtmlContent` ===
     116=== Sample configuration of `HtmlContent`
    183117
    184 {{{
     118{{{#!ini
    185119[ticket]
    186120description_format = html
    … …  
    190124}}}
    191125
    192 == Recent Changes ==
     126== Recent Changes
    193127
    194128[[ChangeLog(ticketnavplugin, 3)]]
    195129
    196 == Author/Contributors ==
     130== Author/Contributors
    197131
    198132'''Author:''' [wiki:framay] [[BR]]
    199 '''Maintainer:''' [wiki:framay] [[BR]]
     133'''Maintainer:''' [[Maintainer]] [[BR]]
    200134'''Contributors:'''