diff options
| author | Kristian Evers <kristianevers@gmail.com> | 2018-03-31 00:10:09 +0200 |
|---|---|---|
| committer | Kristian Evers <kristianevers@gmail.com> | 2018-03-31 00:10:09 +0200 |
| commit | 038e3f0a508b7908f16f3517dcb0bc87d6275ab5 (patch) | |
| tree | 16825d2e99ea46d7c8341deb6e43af835e28efda /docs/source/operations/projections | |
| parent | 4d0f064652acfb16b6c23852e9a257f815b9675f (diff) | |
| download | PROJ-038e3f0a508b7908f16f3517dcb0bc87d6275ab5.tar.gz PROJ-038e3f0a508b7908f16f3517dcb0bc87d6275ab5.zip | |
Use Sphinx option directives to document PROJ options
Instead of listing the various projection options in a table we write
them as :option: tags instead. This makes it easier to write a more
elaborate description of the parameter. Additionally we can create
"master"-description of commonly used parameters such as +lon_0 and +k_0
and include them where necessary. This is handled in separate files, one
for each common parameters, that are stored in
docs/source/operations/options/.
Diffstat (limited to 'docs/source/operations/projections')
| -rw-r--r-- | docs/source/operations/projections/merc.rst | 35 |
1 files changed, 25 insertions, 10 deletions
diff --git a/docs/source/operations/projections/merc.rst b/docs/source/operations/projections/merc.rst index 8895abc8..31ca250a 100644 --- a/docs/source/operations/projections/merc.rst +++ b/docs/source/operations/projections/merc.rst @@ -16,16 +16,12 @@ The projection is conformal which makes it suitable for navigational purposes. +---------------------+----------------------------------------------------------+ | **Defined area** | Global, but best used near the equator | +---------------------+----------------------------------------------------------+ -| **Implemented by** | Gerald I. Evenden | ++ **Domain** | 2D | +---------------------+----------------------------------------------------------+ -| **Options** | +| **Input type** | Geodetic coordinates | +---------------------+----------------------------------------------------------+ -| `+lat_ts` | Latitude of true scale. Defaults to 0.0 | +| **Output type** | Projected coordinates | +---------------------+----------------------------------------------------------+ -| `+k_0` | Scaling factor. Defaults to 1.0 | -+---------------------+----------------------------------------------------------+ - - .. image:: ./images/merc.png :scale: 50% @@ -36,7 +32,7 @@ Usage ######## Applications should be limited to equatorial regions, but is frequently -used for navigational charts with latitude of true scale (``+lat_ts``) specified within +used for navigational charts with latitude of true scale (:option:`+lat_ts`) specified within or near chart's boundaries. Often inappropriately used for world maps since the regions near the poles cannot be shown [Evenden1995]_. @@ -53,8 +49,27 @@ Example using scaling factor:: 12545706.61 2746073.80 -Note that ``+lat_ts`` and ``+k_0`` are mutually exclusive. -If used together, ``+lat_ts`` takes precedence over ``+k_0``. +Note that :option:`+lat_ts` and :option:`+k_0` are mutually exclusive. +If used together, :option:`+lat_ts` takes precedence over :option:`+k_0`. + +Options +######### + +.. note:: All options are optional for the Mercator projection. + +.. include:: ../options/k_0.rst + +.. include:: ../options/lat_ts.rst + +.. include:: ../options/lat_0.rst + +.. include:: ../options/lon_0.rst + +.. include:: ../options/x_0.rst + +.. include:: ../options/y_0.rst + +.. include:: ../options/ellps.rst Mathematical definition ####################### |