Changes between Version 1 and Version 2 of TracSyntaxColoring


Ignore:
Timestamp:
07/10/20 13:09:46 (9 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracSyntaxColoring

    v1 v2  
    1 = Syntax Coloring of Source Code =
    2 Trac supports language-specific syntax highlighting of source code in [wiki:WikiFormatting wiki formatted] text and the [wiki:TracBrowser repository browser].
     1= Syntax Coloring of Source Code
     2Trac 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.
    33
    4 To do this, Trac uses external libraries with support for a great number of programming languages.
     4== About Pygments
    55
    6 Currently Trac supports syntax coloring using one or more of the following packages:
     6[http://pygments.org/ Pygments] is a highlighting library implemented in pure python, very fast, easy to extend and [http://pygments.org/docs/ well documented].
    77
    8  * [http://www.codento.com/people/mtr/genscript/ GNU Enscript]
    9  * [http://silvercity.sourceforge.net/ SilverCity]
     8The 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].
    109
    11 To activate syntax coloring, simply install either one (or more) of these packages. No additional configuration is required, however to modify the colors, have a look at `trac/htdocs/css/code.css`.
     10[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].
    1211
    13 When in use, Trac will automatically prioritize !SilverCity highlighting over Enscript if possible, (see note below).
     12== Syntax Coloring Support
    1413
    15 If neither package is available, Trac will display the data as plain text.
     14=== Supported languages
    1615
    17 '''Note:''' Enscript supports a greater number of languages, however !SilverCity is generally faster since it is a library and isn't executed in an external process.
     16The 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.
    1817
    19 === About SilverCity ===
    20 !SilverCity uses the lexer from [http://www.scintilla.org/ Scintilla]. Scintilla supports more languages than !SilverCity implements. If you want to add a language to !SilverCity supported by Scintilla, it's not very difficult. See [http://projects.edgewall.com/trac/wiki/SilverCityAddLanguage SilverCityAddLanguage] for some information how.
     18Explicit 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 [wiki:TracIni#mimeviewer-mime_map-option "[mimeviewer] mime_map"] option.
    2119
     20If 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`.
    2221
    23 == Syntax Coloring Support ==
     22=== Direct Rendering
    2423
    25 || || !SilverCity || Enscript ||
    26 || Ada      ||   || X ||
    27 || Asm      ||   || X ||
    28 || * ASP    || X || X ||
    29 || * C      || X || X ||
    30 || * C#     ||   || X(2) ||
    31 || * C++    || X || X ||
    32 || * Java   ||   || X ||
    33 || Awk      ||   || X ||
    34 || CSS      || X ||   ||
    35 || Diff     ||   || X ||
    36 || Eiffel   ||   || X ||
    37 || Elisp    ||   || X ||
    38 || Fortran  ||   || X ||
    39 || Haskell  ||   || X ||
    40 || HTML     || X || X ||
    41 || IDL      ||   || X ||
    42 || Javascript || X || X ||
    43 || m4       ||   || X ||
    44 || Makefile ||   || X ||
    45 || Matlab   ||   || X ||
    46 || Objective-C|| || X ||
    47 || Pascal   ||   || X ||
    48 || * Perl   || X || X ||
    49 || * PHP    || X || X ||
    50 || PSP      || X ||   ||
    51 || Pyrex    ||   || X ||
    52 || * Python || X || X ||
    53 || * Ruby   || X || X (1) ||
    54 || Scheme   ||   || X ||
    55 || Shell    ||   || X ||
    56 || SQL      || X || X ||
    57 || Troff    ||   || X ||
    58 || TCL      ||   || X ||
    59 || Tex      ||   || X ||
    60 || Verilog  ||   || X ||
    61 || VHDL     ||   || X ||
    62 || Visual Basic |||| X ||
    63 || VRML     ||   || X ||
    64 || XML      || X ||  ||
     24Rich content may be directly //rendered// instead of syntax highlighted. This usually depends on which auxiliary packages are installed and 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. It will be syntax highlighted otherwise.
    6525
    66 ''(*) Supported as inline code blocks in [wiki:WikiFormatting Wiki text] using WikiProcessors.''
     26Similarly, 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. If you want to ensure that an HTML document gets syntax highlighted and not rendered, use the `text/xml` mimetype.
    6727
    68 ''(1) Ruby highlighting is not included in the Enscript distribution.  Highlighting rules for Ruby can be obtained from: http://neugierig.org/software/ruby/
     28HTML documents are directly rendered only if the `render_unsafe_html` settings are enabled in your TracIni file. See [TracIni#attachment-render_unsafe_content-option "[attachment] render_unsafe_content"], [TracIni#browser-render_unsafe_content-option "[browser] render_unsafe_content"] and [TracIni#wiki-render_unsafe_content-option "[wiki] render_unsafe_content"]. The setting is present in multiple sections because there are different security concerns depending on where the document comes from.
    6929
    70 ''(2) C# highlighting is not included in the Enscript distribution.  Highlighting rules for C# can be obtained from: http://wiki.hasno.info/index.php/Csharp.st
     30=== Known MIME types
    7131
    72 == Extra Software ==
    73  * GNU Enscript -- http://directory.fsf.org/GNU/enscript.html
    74  * GNU Enscript for Windows -- http://gnuwin32.sourceforge.net/packages/enscript.htm
    75  * !SilverCity -- http://silvercity.sf.net/
     32[[KnownMimeTypes]]
    7633
    7734----