Changes between Version 2 and Version 3 of TracSyntaxColoring

Timestamp:

Apr 20, 2015 8:51:57 PM (10 years ago)

Author:

trac

Comment:

--

TracSyntaxColoring

@@ -6 +6 @@
 Currently Trac supports syntax coloring using one or more of the following packages:
 
- * [http://pygments.pocoo.org/ Pygments], by far the preferred system, as it covers a wide range of programming languages and other structured texts and is actively supported
- * [http://www.codento.com/people/mtr/genscript/ GNU Enscript], commonly available on Unix but somewhat unsupported on Windows
- * [http://silvercity.sourceforge.net/ SilverCity], legacy system, some versions can be [http://trac.edgewall.org/wiki/TracFaq#why-is-my-css-code-not-being-highlighted-even-though-i-have-silvercity-installed problematic]
+ * [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
+ * [http://www.codento.com/people/mtr/genscript/ GNU Enscript], commonly available on Unix but somewhat unsupported on Windows //(use is deprecated)//
+ * [http://silvercity.sourceforge.net/ SilverCity], legacy system, some versions can be problematic //(use is deprecated)//
 
 
@@ -17 +17 @@
 === About Pygments ===
 
-Starting with trac 0.11 [http://pygments.org/ pygments] will be the new default highlighter. It's a highlighting library implemented in pure python, very fast, easy to extend and [http://pygments.org/docs/ well documented].
+[http://pygments.org/ Pygments] is a highlighting library implemented in pure python, very fast, easy to extend and [http://pygments.org/docs/ well documented].
 
 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]. 
@@ -30 +30 @@
 [[KnownMimeTypes]]
 
+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.
+
+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.
+
+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.
+
+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'.
 
 === List of Languages Supported, by Highlighter #language-supported
@@ -43 +50 @@
 || C#              ||                 ||  ✓ ^[#a1 (1)]^  ||  ✓  ||
 || C++             ||  ✓              ||  ✓              ||  ✓  ||
+|| CMake           ||  ?              ||  ?              ||  ✓  ||
 || Java            ||  ✓ ^[#a2 (2)]^  ||  ✓              ||  ✓  ||
 || Awk             ||                 ||  ✓              ||     ||
@@ -98 +106 @@
 
 == Extra Software ==
- * GNU Enscript -- http://directory.fsf.org/GNU/enscript.html
- * GNU Enscript for Windows -- http://gnuwin32.sourceforge.net/packages/enscript.htm
- * !SilverCity -- http://silvercity.sf.net/
- * Pygments -- http://pygments.org/
+ * GNU Enscript — http://www.gnu.org/software/enscript/
+ * GNU Enscript for Windows — http://gnuwin32.sourceforge.net/packages/enscript.htm
+ * !SilverCity — http://silvercity.sf.net/
+ * **Pygments — http://pygments.org/**
 
 ----