Revision: 5229
http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5229&view=rev
Author: mdboom
Date: 2008-05-23 10:41:07 -0700 (Fri, 23 May 2008)
Log Message:
-----------
Adding cross-references.
Modified Paths:
--------------
trunk/matplotlib/doc/users_guide/add_new_projection.txt
Modified: trunk/matplotlib/doc/users_guide/add_new_projection.txt
===================================================================
--- trunk/matplotlib/doc/users_guide/add_new_projection.txt 2008-05-23
16:12:50 UTC (rev 5228)
+++ trunk/matplotlib/doc/users_guide/add_new_projection.txt 2008-05-23
17:41:07 UTC (rev 5229)
@@ -14,9 +14,11 @@
"projections".
From the user's perspective, the scale of a plot can be set with
-``set_xscale()`` and ``set_yscale()``. Projections can be chosen using
-the ``projection`` keyword argument to the ``plot()`` or ``subplot()``
-functions::
+:meth:`~matplotlib.axes.Axes.set_xscale` and
+:meth:`~matplotlib.axes.Axes.set_xscale`. Projections can be chosen
+using the ``projection`` keyword argument to the
+:func:`~matplotlib.pylab.plot` or :func:`~matplotlib.pylab.subplot`
+functions, e.g.::
plot(x, y, projection="custom")
@@ -30,8 +32,8 @@
Creating a new scale
====================
-Adding a new scale consists of defining a subclass of ``ScaleBase``
-(in the ``matplotlib.scale`` module), that includes the following
+Adding a new scale consists of defining a subclass of
+:class:`matplotlib.scale.ScaleBase`, that includes the following
elements:
- A transformation from data coordinates into display coordinates.
@@ -53,20 +55,19 @@
- Formatters (major and minor) that specify how the tick labels
should be drawn.
-Once the class is defined, it must be registered with ``matplotlib``
-so that the user can select it.
+Once the class is defined, it must be registered with matplotlib so
+that the user can select it.
A full-fledged and heavily annotated example is in
-``examples/custom_scale_example.py``. There are also some ``Scale``
-classes in ``scale.py`` that may be used as starting points.
+:file:`examples/api/custom_scale_example.py`. There are also some classes
+in :mod:`matplotlib.scale` that may be used as starting points.
Creating a new projection
=========================
-Adding a new projection consists of defining a subclass of ``Axes``
-(in the ``matplotlib.axes`` module), that includes the following
-elements:
+Adding a new projection consists of defining a subclass of
+:class:`matplotlib.axes.Axes`, that includes the following elements:
- A transformation from data coordinates into display coordinates.
@@ -75,10 +76,11 @@
- Transformations for the gridlines, ticks and ticklabels. Custom
projections will often need to place these elements in special
- locations, and ``matplotlib`` has a facility to help with doing so.
+ locations, and matplotlib has a facility to help with doing so.
- - Setting up default values (overriding ``cla()``), since the
- defaults for a rectilinear axes may not be appropriate.
+ - Setting up default values (overriding
+ :meth:`~matplotlib.axes.Axes.cla`), since the defaults for a
+ rectilinear axes may not be appropriate.
- Defining the shape of the axes, for example, an elliptical axes,
that will be used to draw the background of the plot and for
@@ -90,13 +92,14 @@
- Set up interactive panning and zooming. This is left as an
"advanced" feature left to the reader, but there is an example of
- this for polar plots in ``polar.py``.
+ this for polar plots in :mod:`matplotlib.projections.polar`.
- Any additional methods for additional convenience or features.
-Once the class is defined, it must be registered with ``matplotlib``
+Once the class is defined, it must be registered with matplotlib
so that the user can select it.
A full-fledged and heavily annotated example is in
-``examples/custom_projection_example.py``. The polar plot
-functionality in ``polar.py`` may also be of interest.
+:file:`examples/api/custom_projection_example.py`. The polar plot
+functionality in :mod:`matplotlib.projections.polar` may also be of
+interest.
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2008.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
Matplotlib-checkins mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/matplotlib-checkins
