<html xmlns="http://www.w3.org/1999/xhtml">

<head>

<meta http-equiv="X-UA-Compatible" content="IE=Edge" />

<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>MEP29: Text light markup &#8212; Matplotlib 3.2.0 documentation</title>

<link rel="stylesheet" href="../../_static/mpl.css?v3.2.0-3-gea62ccde8" type="text/css" />

<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />

<link rel="stylesheet" type="text/css" href="../../_static/graphviz.css" />

<link rel="stylesheet" type="text/css" href="../../_static/gallery.css" />

<link rel="stylesheet" type="text/css" href="../../_static/copybutton.css" />

<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>

<script src="../../_static/jquery.js"></script>

<script src="../../_static/underscore.js"></script>

<script src="../../_static/doctools.js"></script>

<script src="../../_static/language_data.js"></script>

<script src="../../_static/clipboard.min.js"></script>

<script src="../../_static/copybutton.js"></script>

<script >var copybuttonSkipText = '>>> ';</script>

<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>

<link rel="search" type="application/opensearchdescription+xml"

title="Search within Matplotlib 3.2.0 documentation"

href="../../_static/opensearch.xml"/>

<link rel="shortcut icon" href="../../_static/favicon.ico"/>

<link rel="index" title="Index" href="../../genindex.html" />

<link rel="search" title="Search" href="../../search.html" />

<link rel="next" title="Licenses" href="../license.html" />

<link rel="prev" title="MEP28: Remove Complexity from Axes.boxplot" href="MEP28.html" />

<link rel="top" title="Matplotlib 3.2.0 documentation" href="#" />

<link rel="canonical" href="https://matplotlib.org/stable/devel/MEP/MEP29.html" />

<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />

<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>

</head><body>

<div id="unreleased-message"> You are reading an old version of the documentation (v3.2.0). For the latest version see <a href="https://matplotlib.org/stable/devel/MEP/MEP29.html">https://matplotlib.org/stable/devel/MEP/MEP29.html</a></div>

<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">

<a href="../../index.html">

<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 3.2.0</span></div>

<img src="../../_static/logo2_compressed.svg" height="125px" border="0" alt="matplotlib"/></a>

<!-- The "Fork me on github" ribbon -->

<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>

</div>

<nav class="main-nav">

<ul>

<li><a href="../../users/installing.html">Installation</a></li>

<li><a href="../../contents.html">Documentation</a></li>

<li><a href="../../gallery/index.html">Examples</a></li>

<li><a href="../../tutorials/index.html">Tutorials</a></li>

<li><a href="../index.html">Contributing</a></li>

<li class="nav-right">

<form class="search" action="../../search.html" method="get">

<input type="text" name="q" aria-labelledby="searchlabel" placeholder="Search"/>

</form>

</li>

</ul>

</nav>

<div class="related" role="navigation" aria-label="related navigation">

<h3>Navigation</h3>

<ul>

<li class="right" style="margin-right: 10px">

<a href="../../genindex.html" title="General Index"

accesskey="I">index</a></li>

<li class="right" >

<a href="../../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<li class="right" >

<a href="../license.html" title="Licenses"

accesskey="N">next</a> |</li>

<li class="right" >

<a href="MEP28.html" title="MEP28: Remove Complexity from Axes.boxplot"

accesskey="P">previous</a> |</li>

<li><a href="../../index.html">home</a>|&nbsp;</li>

<li><a href="../../contents.html">contents</a> &raquo;</li>

<li class="nav-item nav-item-1"><a href="../index.html" >The Matplotlib Developers' Guide</a> &#187;</li>

<li class="nav-item nav-item-2"><a href="index.html" accesskey="U">Matplotlib Enhancement Proposals</a> &#187;</li>

</ul>

</div>

<div class="sphinxsidebar" role="navigation" aria-label="main navigation">

<div class="sphinxsidebarwrapper">

<h3><a href="../../contents.html">Table of Contents</a></h3>

<ul>

<li><a class="reference internal" href="#">MEP29: Text light markup</a><ul>

<li><a class="reference internal" href="#status">Status</a></li>

<li><a class="reference internal" href="#branches-and-pull-requests">Branches and Pull requests</a></li>

<li><a class="reference internal" href="#abstract">Abstract</a></li>

<li><a class="reference internal" href="#detailed-description">Detailed description</a></li>

<li><a class="reference internal" href="#implementation">Implementation</a><ul>

<li><a class="reference internal" href="#improvements">Improvements</a></li>

<li><a class="reference internal" href="#problems">Problems</a></li>

<li><a class="reference internal" href="#backward-compatibility">Backward compatibility</a></li>

<li><a class="reference internal" href="#alternatives">Alternatives</a></li>

<div class="relations">

<h3>Related Topics</h3>

<li><a href="../../contents.html">Documentation overview</a><ul>

<li><a href="../index.html">The Matplotlib Developers' Guide</a><ul>

<li><a href="index.html">Matplotlib Enhancement Proposals</a><ul>

<li>Previous: <a href="MEP28.html" title="previous chapter">MEP28: Remove Complexity from Axes.boxplot</a></li>

<li>Next: <a href="../license.html" title="next chapter">Licenses</a></li>

</ul></li>

</ul></li>

</ul></li>

<div id="sidebar-pagesource" role="note" aria-label="source link"

style="margin-top: 1.5em; padding-top: 0.1em; border-top: 1px solid #86989b">

<a href="../../_sources/devel/MEP/MEP29.rst.txt"

style="color: #c0c0c0" rel="nofollow">Show Page Source</a>

</div>

</div>

</div>

<div class="document">

<div class="documentwrapper">

<div class="bodywrapper">

<div class="body" role="main">

<div class="section" id="mep29-text-light-markup">

<h1>MEP29: Text light markup<a class="headerlink" href="#mep29-text-light-markup" title="Permalink to this headline">¶</a></h1>

<div class="contents local topic" id="contents">

<ul class="simple">

<li><a class="reference internal" href="#status" id="id1">Status</a></li>

<li><a class="reference internal" href="#branches-and-pull-requests" id="id2">Branches and Pull requests</a></li>

<li><a class="reference internal" href="#abstract" id="id3">Abstract</a></li>

<li><a class="reference internal" href="#detailed-description" id="id4">Detailed description</a></li>

<li><a class="reference internal" href="#implementation" id="id5">Implementation</a><ul>

<li><a class="reference internal" href="#improvements" id="id6">Improvements</a></li>

<li><a class="reference internal" href="#problems" id="id7">Problems</a></li>

<li><a class="reference internal" href="#backward-compatibility" id="id8">Backward compatibility</a></li>

<li><a class="reference internal" href="#alternatives" id="id9">Alternatives</a></li>

<div class="section" id="status">

<h2><a class="toc-backref" href="#id1">Status</a><a class="headerlink" href="#status" title="Permalink to this headline">¶</a></h2>

<p>Discussion</p>

<div class="section" id="branches-and-pull-requests">

<h2><a class="toc-backref" href="#id2">Branches and Pull requests</a><a class="headerlink" href="#branches-and-pull-requests" title="Permalink to this headline">¶</a></h2>

<p>None at the moment, proof of concept only.</p>

<div class="section" id="abstract">

<h2><a class="toc-backref" href="#id3">Abstract</a><a class="headerlink" href="#abstract" title="Permalink to this headline">¶</a></h2>

<p>This MEP proposes to add lightweight markup to the text artist.</p>

<div class="section" id="detailed-description">

<h2><a class="toc-backref" href="#id4">Detailed description</a><a class="headerlink" href="#detailed-description" title="Permalink to this headline">¶</a></h2>

<p>Using different size/color/family in a text annotation is difficult because the

<code class="xref py py-obj docutils literal notranslate"><span class="pre">text</span></code> method accepts argument for size/color/family/weight/etc. that are used

for the whole text. But, if one wants, for example, to have different colors,

one has to look at the gallery where one such example is provided:

<a class="reference external" href="http://matplotlib.org/examples/text_labels_and_annotations/rainbow_text.html">http://matplotlib.org/examples/text_labels_and_annotations/rainbow_text.html</a></p>

<p>This example takes a list of strings as well as a list of colors which makes it

cumbersome to use. An alternative would be to use a restricted set of <a class="reference external" href="https://developer.gnome.org/pygtk/stable/pango-markup-language.html">pango</a>-like markup and to interpret this markup.</p>

<p>Some markup examples:</p>

<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>Hello &lt;b&gt;world!&lt;/b&gt;`

Hello &lt;span color=&quot;blue&quot;&gt;world!&lt;/span&gt;

<div class="section" id="implementation">

<h2><a class="toc-backref" href="#id5">Implementation</a><a class="headerlink" href="#implementation" title="Permalink to this headline">¶</a></h2>

<p>A proof of concept is provided in <a class="reference external" href="https://github.com/rougier/matplotlib/blob/markup/examples/text_labels_and_annotations/markup.py">markup_example.py</a> but it currently only handles the horizontal direction.</p>

<div class="section" id="improvements">

<h3><a class="toc-backref" href="#id6">Improvements</a><a class="headerlink" href="#improvements" title="Permalink to this headline">¶</a></h3>

<ul class="simple">

<li>This proof of concept uses regex to parse the text but it may be better

to use the html.parser from the standard library.</li>

<li>Computation of text fragment positions could benefit from the OffsetFrom

class. See for example item 5 in <a class="reference external" href="http://matplotlib.org/devdocs/tutorials/text/annotations.html#using-complex-coordinates-with-annotations">Using Complex Coordinates with Annotations</a></li>

<div class="section" id="problems">

<h3><a class="toc-backref" href="#id7">Problems</a><a class="headerlink" href="#problems" title="Permalink to this headline">¶</a></h3>

<li><p class="first">One serious problem is how to deal with text having both latex and

html-like tags. For example, consider the following:</p>

<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$&lt;b&gt;Bold$&lt;/b&gt;

<p>Recommendation would be to have mutual exclusion.</p>

<div class="section" id="backward-compatibility">

<h2><a class="toc-backref" href="#id8">Backward compatibility</a><a class="headerlink" href="#backward-compatibility" title="Permalink to this headline">¶</a></h2>

<p>None at the moment since it is only a proof of concept</p>

<div class="section" id="alternatives">

<h2><a class="toc-backref" href="#id9">Alternatives</a><a class="headerlink" href="#alternatives" title="Permalink to this headline">¶</a></h2>

<p>As proposed by &#64;anntzer, this could be also implemented as improvements to

mathtext. For example:</p>

<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="sa">r</span><span class="s2">&quot;$\text{Hello \textbf</span><span class="si">{world}</span><span class="s2">}$&quot;</span>

<span class="sa">r</span><span class="s2">&quot;$\text{Hello \textcolor</span><span class="si">{blue}{world}</span><span class="s2">}$&quot;</span>

<span class="sa">r</span><span class="s2">&quot;$\text{Hello \textsf{\small world}}$&quot;</span>

</div>

</div>

</div>

<div class="clearer"></div>

</div>

<div class="footer">

&copy; Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2018 The Matplotlib development team.

<br />

Last updated on Mar 04, 2020.

Created using

<a href="http://sphinx-doc.org/">Sphinx</a> 2.4.3.

Doc version v3.2.0-3-gea62ccde8.

</div>

</body>