Edgewall Software
Modify

Opened 15 years ago

Closed 15 years ago

Last modified 15 years ago

#8810 closed enhancement (fixed)

Clarifications with regard to Pygments

Reported by: Ryan Ollos <ryano@…> Owned by: Ryan Ollos <ryano@…>
Priority: lowest Milestone: 0.12
Component: general Version: 0.12dev
Severity: normal Keywords:
Cc: Branch:
Release Notes:
API Changes:
Internal Changes:

Description

I have a few suggestions based on my experience with configuring Pygments in trac.ini.

  1. On the Prefences page, the title of the Pygments theme tab might be changed to Syntax Highlighting. Rather than referring to the package name, more end-users are likely to understand what Syntax Highlighting or Syntax Coloring is referring to.
  2. On the Pygments theme tab, the setting is referred to as Theme, but the Pygments documentation and the trac.ini setting refers to these as Styles.
  3. The documentation TracSyntaxColoring#AboutPygments states (pygments_default_style = colorful under [mimeviewer] options has to be added). I have not found this to be true, and it is not clear to me why this would be the case since many styles can be selected in preferences. Perhaps this comment is out of date and should be removed? The editor's comment gave no clarification.

These changes are pretty straightforward and I can submit a patch if the maintainers agree with these changes.

Attachments (2)

syntaxhighlighting.patch (4.9 KB ) - added by Ryan Ollos <ryano@…> 15 years ago.
syntaxhighlighting.2.patch (4.5 KB ) - added by Ryan Ollos <ryano@…> 15 years ago.

Download all attachments as: .zip

Change History (10)

comment:1 by Remy Blank, 15 years ago

I'm +1 on this. About the default style, maybe the sentence can be reworded to indicate that the default style can be set with that option.

comment:2 by Ryan Ollos <ryano@…>, 15 years ago

Milestone: 2.00.12
Priority: normallowest
Version: none0.12dev

Hi Remy, Here is a patch implementing the changes. Any feedback you have is appreciated.

by Ryan Ollos <ryano@…>, 15 years ago

Attachment: syntaxhighlighting.patch added

by Ryan Ollos <ryano@…>, 15 years ago

Attachment: syntaxhighlighting.2.patch added

comment:3 by Ryan Ollos <ryano@…>, 15 years ago

Accidentally left a print statement in the first patch. syntaxhighlighting.2.patch is the correct one.

comment:4 by Remy Blank, 15 years ago

I wouldn't change the name in the URL (and neither the template name), as the admin panel is provided by the pygments.py module after all. But the title changes are good.

No need to re-submit a patch, I'll cherry pick from the second one.

in reply to:  4 comment:5 by Ryan Ollos <ryano@…>, 15 years ago

Documentation updates: TracSyntaxColoring@45#AboutPygments.

in reply to:  4 comment:6 by Ryan Ollos <ryano@…>, 15 years ago

Replying to rblank:

I wouldn't change the name in the URL (and neither the template name), as the admin panel is provided by the pygments.py module after all. But the title changes are good.

Thanks for the feedback. That makes sense.

Now that I have the dev environment setup and a little bit of experience making changes, I'll target finishing #8815 and #6063 over the weekend.

Something weird going on with Edgewall's trac site today …

comment:7 by Remy Blank, 15 years ago

Resolution: fixed
Status: newclosed

Patch applied in [8798]. Documentation update is good. Thanks!

comment:8 by Remy Blank, 15 years ago

Owner: set to Ryan Ollos <ryano@…>

Modify Ticket

Change Properties
Set your email in Preferences
Action
as closed The owner will remain Ryan Ollos <ryano@…>.
The resolution will be deleted. Next status will be 'reopened'.
to The owner will be changed from Ryan Ollos <ryano@…> to the specified user.

Add Comment


E-mail address and name can be saved in the Preferences .
 
Note: See TracTickets for help on using tickets.