Changes between Version 1 and Version 2 of TracSyntaxColoring
- Timestamp:
- Jun 6, 2024, 9:53:06 AM (5 months ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracSyntaxColoring
v1 v2 1 = Syntax Coloring of Source Code = 2 Trac supports language-specific syntax highlighting of source code within wiki formatted text in [WikiProcessors#CodeHighlightingSupport wiki processors] blocks and in the [TracBrowser repository browser]. 3 4 To do this, Trac uses external libraries with support for a great number of programming languages. 5 6 Currently Trac supports syntax coloring using one or more of the following packages: 7 8 * [http://pygments.org/ Pygments], by far the preferred system, as it covers a wide range of programming languages and other structured texts and is actively supported 9 * [http://www.codento.com/people/mtr/genscript/ GNU Enscript], commonly available on Unix but somewhat unsupported on Windows //(use is deprecated)// 10 * [http://silvercity.sourceforge.net/ SilverCity], legacy system, some versions can be problematic //(use is deprecated)// 1 = Syntax Coloring of Source Code 2 Trac supports language-specific syntax highlighting of source code within wiki formatted text in [WikiProcessors#CodeHighlightingSupport wiki processors] blocks and in the [TracBrowser repository browser]. Syntax coloring is provided using [http://pygments.org/ Pygments], which covers a wide range of programming languages and other structured texts, and is actively supported. If Pygments is not available, Trac will display the content as plain text. 11 3 12 4 13 To activate syntax coloring, simply install either one (or more) of these packages (see [#ExtraSoftware] section below). 14 If none of these packages is available, Trac will display the data as plain text. 15 16 17 === About Pygments === 5 === About Pygments 18 6 19 7 [http://pygments.org/ Pygments] is a highlighting library implemented in pure python, very fast, easy to extend and [http://pygments.org/docs/ well documented]. 20 8 21 The Pygments default style can specified in the [TracIni#mimeviewer-section mime-viewer] section of trac.ini. The default style can be overridden by setting a Stylepreference on the [/prefs/pygments preferences page].9 The Pygments default style can specified in the [TracIni#mimeviewer-section mime-viewer] section of trac.ini. The default style can be overridden by setting a //Style// preference on the [/prefs/pygments preferences page]. 22 10 23 It's very likely that the list below is outdated because the list of supported pygments lexers is growing weekly. Just have a look at the page of [http://pygments.org/docs/lexers/ supported lexers] on the pygments webpage.11 [http://pygments.org/docs/lexers/ Pygments lexer] options can be specified as [WikiProcessors WikiProcessor] arguments and defaults can be set in the [TracIni#pygments-lexer-section environment configuration]. 24 12 13 == Syntax Coloring Support 25 14 26 == Syntax Coloring Support ==15 === Supported languages 27 16 28 === Known MIME Types 17 The list of currently supported languages can be found on the [http://pygments.org/languages/ supported languages] page. The list represents the languages supported in the most recent version of Pygments, so the languages actually supported in your installation could differ if you have an older version installed. The listing of [http://pygments.org/docs/lexers/ supported lexers] provides additional information about the default mime type to keyword mappings. 29 18 30 [[KnownMimeTypes]] 19 Explicit control of the mime type associated with a [WikiProcessors WikiProcessor] and file extension is available through the `mime_map` setting. For example, by default `.m` files are considered Objective-C files. In order to treat `.m` files as MATLAB files, add `text/matlab:m` to the `mime_map` setting in the [wiki:TracIni#mimeviewer-section "[mimeviewer] section of trac.ini"]. 31 20 32 Note that the rich content may be directly //rendered// instead of syntax highlighted. This usually depends on which auxiliary packages are installed and on which components are activated in your setup. For example a `text/x-rst` document will be rendered via `docutils` if it is installed and the `trac.mimeview.rst.ReStructuredTextRenderer` is not disabled, and will be syntax highlighted otherwise. 21 If a mimetype property such as `svn:mime-type` is set to `text/plain`, there is no coloring even if file is known type like `java`. 22 23 === Direct Rendering 24 25 Rich content may be directly //rendered// instead of syntax highlighted. This usually depends on which auxiliary packages are installed and on which components are activated in your setup. For example a `text/x-rst` document will be rendered via `docutils` if it is installed and the `trac.mimeview.rst.ReStructuredTextRenderer` is not disabled, and will be syntax highlighted otherwise. 33 26 34 27 In a similar way, a document with the mimetype `text/x-trac-wiki` is rendered using the Trac wiki formatter, unless the `trac.mimeview.api.WikiTextRenderer` component is disabled. … … 36 29 HTML documents are directly rendered only if the `render_unsafe_html` settings are enabled in the TracIni (those settings are present in multiple sections, as there are different security concerns depending where the document comes from). If you want to ensure that an HTML document gets syntax highlighted and not rendered, use the `text/xml` mimetype. 37 30 38 If a mimetype property such as 'svn:mime-type' is set to 'text/plain', there is no coloring even if file is known type like 'java'. 31 === Known MIME types 39 32 40 === List of Languages Supported, by Highlighter #language-supported 41 42 This list is only indicative. 43 44 || ||= !SilverCity =||= Enscript =||= Pygments =|| 45 || Ada || || ✓ || || 46 || Asm || || ✓ || || 47 || Apache Conf || || || ✓ || 48 || ASP || ✓ || ✓ || || 49 || C || ✓ || ✓ || ✓ || 50 || C# || || ✓ ^[#a1 (1)]^ || ✓ || 51 || C++ || ✓ || ✓ || ✓ || 52 || CMake || ? || ? || ✓ || 53 || Java || ✓ ^[#a2 (2)]^ || ✓ || ✓ || 54 || Awk || || ✓ || || 55 || Boo || || || ✓ || 56 || CSS || ✓ || || ✓ || 57 || Python Doctests || || || ✓ || 58 || Diff || || ✓ || ✓ || 59 || Eiffel || || ✓ || || 60 || Elisp || || ✓ || || 61 || Fortran || || ✓ ^[#a1 (1)]^ || ✓ || 62 || Haskell || || ✓ || ✓ || 63 || Genshi || || || ✓ || 64 || HTML || ✓ || ✓ || ✓ || 65 || IDL || || ✓ || || 66 || INI || || || ✓ || 67 || Javascript || ✓ || ✓ || ✓ || 68 || Lua || || || ✓ || 69 || m4 || || ✓ || || 70 || Makefile || || ✓ || ✓ || 71 || Mako || || || ✓ || 72 || Matlab ^[#a3 (3)]^ || || ✓ || ✓ || 73 || Mygthy || || || ✓ || 74 || Objective-C || || ✓ || ✓ || 75 || OCaml || || || ✓ || 76 || Pascal || || ✓ || ✓ || 77 || Perl || ✓ || ✓ || ✓ || 78 || PHP || ✓ || || ✓ || 79 || PSP || ✓ || || || 80 || Pyrex || || ✓ || || 81 || Python || ✓ || ✓ || ✓ || 82 || Ruby || ✓ || ✓ ^[#a1 (1)]^ || ✓ || 83 || Scheme || || ✓ || ✓ || 84 || Shell || || ✓ || ✓ || 85 || Smarty || || || ✓ || 86 || SQL || ✓ || ✓ || ✓ || 87 || Troff || || ✓ || ✓ || 88 || TCL || || ✓ || || 89 || Tex || || ✓ || ✓ || 90 || Verilog || ✓ ^[#a2 (2)]^ || ✓ || || 91 || VHDL || || ✓ || || 92 || Visual Basic || || ✓ || ✓ || 93 || VRML || || ✓ || || 94 || XML || ✓ || || ✓ || 95 96 97 98 ''[=#a1 (1)] Not included in the Enscript distribution. Additional highlighting rules can be obtained for 99 [http://neugierig.org/software/ruby/ Ruby], 100 [http://wiki.hasno.info/index.php/Csharp.st C#], 101 [http://wiki.hasno.info/index.php/F90.st Fortran 90x/2003] 102 103 ''[=#a2 (2)] since Silvercity 0.9.7 released on 2006-11-23 104 105 ''[=#a3 (3)] By default `.m` files are considered Objective-C files. In order to treat `.m` files as MATLAB files, add "text/matlab:m" to the "mime_map" setting in the [wiki:TracIni#mimeviewer-section "[mimeviewer] section of trac.ini"]. 106 107 == Extra Software == 108 * GNU Enscript — http://www.gnu.org/software/enscript/ 109 * GNU Enscript for Windows — http://gnuwin32.sourceforge.net/packages/enscript.htm 110 * !SilverCity — http://silvercity.sf.net/ 111 * **Pygments — http://pygments.org/** 33 [[KnownMimeTypes]] 112 34 113 35 ----