Skip to content

Commit 5f96b77

Browse files
DOC/projections: Simplify links in the projection table by using the titles of the examples (#3407)
Co-authored-by: Dongdong Tian <[email protected]>
1 parent 7544245 commit 5f96b77

30 files changed

+88
-88
lines changed

doc/techref/projections.md

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -16,34 +16,34 @@ The table below shows the projection codes for the 31 GMT map projections:
1616

1717
| PyGMT Projection Argument | Projection Name |
1818
| --- | --- |
19-
| **A**{{ lon0 }}/{{ lat0 }}[/*horizon*]/*width* | {doc}`Lambert azimuthal equal area </projections/azim/azim_lambert>` |
20-
| **B**{{ lon0 }}/{{ lat0 }}/{{ lat1 }}/{{ lat2 }}/*width* | {doc}`Albers conic equal area </projections/conic/conic_albers>` |
21-
| **C**{{ lon0 }}/{{ lat0 }}/*width* | {doc}`Cassini cylindrical </projections/cyl/cyl_cassini>` |
22-
| **Cyl_stere**/[{{ lon0 }}/[{{ lat0 }}/]]*width* | {doc}`Cylindrical stereographic </projections/cyl/cyl_stereographic>` |
23-
| **D**{{ lon0 }}/{{ lat0 }}/{{ lat1 }}/{{ lat2 }}/*width* | {doc}`Equidistant conic </projections/conic/conic_equidistant>` |
24-
| **E**{{ lon0 }}/{{ lat0 }}[/*horizon*]/*width* | {doc}`Azimuthal equidistant </projections/azim/azim_equidistant>` |
25-
| **F**{{ lon0 }}/{{ lat0 }}[/*horizon*]/*width* | {doc}`Azimuthal gnomonic </projections/azim/azim_gnomonic>` |
26-
| **G**{{ lon0 }}/{{ lat0 }}[/*horizon*]/*width* | {doc}`Azimuthal orthographic </projections/azim/azim_orthographic>` |
27-
| **G**{{ lon0 }}/{{ lat0 }}/*width*[**+a***azimuth*][**+t***tilt*][**+v***vwidth*/*vheight*][**+w***twist*][**+z***altitude*] | {doc}`General perspective </projections/azim/azim_general_perspective>` |
28-
| **H**[{{ lon0 }}/]*width* | {doc}`Hammer equal area </projections/misc/misc_hammer>` |
29-
| **I**[{{ lon0 }}/]*width* | {doc}`Sinusoidal equal area </projections/misc/misc_sinusoidal>` |
30-
| **J**[{{ lon0 }}/]*width* | {doc}`Miller cylindrical </projections/cyl/cyl_miller>` |
31-
| **Kf**[{{ lon0 }}/]*width* | {doc}`Eckert IV equal area </projections/misc/misc_eckertIV>` |
32-
| **Ks**[{{ lon0 }}/]*width* | {doc}`Eckert VI equal area </projections/misc/misc_eckertVI>` |
33-
| **L**{{ lon0 }}/{{ lat0 }}/{{ lat1 }}/{{ lat2 }}/*width* | {doc}`Lambert conic conformal </projections/conic/conic_lambert>` |
34-
| **M**[{{ lon0 }}/[{{ lat0 }}/]]*width* | {doc}`Mercator cylindrical </projections/cyl/cyl_mercator>` |
35-
| **N**[{{ lon0 }}/]*width* | {doc}`Robinson </projections/misc/misc_robinson>` |
36-
| **Oa**{{ lon0 }}/{{ lat0 }}/*azimuth*/*width*[**+v**] | {doc}`Oblique Mercator, 1: origin and azimuth </projections/cyl/cyl_oblique_mercator_1>` |
37-
| **Ob**{{ lon0 }}/{{ lat0 }}/{{ lon1 }}/{{ lat1 }}/*width*[**+v**] | {doc}`Oblique Mercator, 2: two points </projections/cyl/cyl_oblique_mercator_2>` |
38-
| **Oc**{{ lon0 }}/{{ lat0 }}/{{ lonp }}/{{ latp }}/*width*[**+v**] | {doc}`Oblique Mercator, 3: origin and pole </projections/cyl/cyl_oblique_mercator_3>` |
39-
| **P***width*[**+a**][**+f**[**e**\|**p**\|*radius*]][**+r***offset*][**+t***origin*][**+z**[**p**\|*radius*]] | {doc}`Polar </projections/nongeo/polar>` [azimuthal] ({math}`\theta, r`) (or cylindrical) |
40-
| **Poly**/[{{ lon0 }}/[{{ lat0 }}/]]*width* | {doc}`Polyconic </projections/conic/polyconic>` |
41-
| **Q**[{{ lon0 }}/[{{ lat0 }}/]]*width* | {doc}`Equidistant cylindrica </projections/cyl/cyl_equidistant>` |
42-
| **R**[{{ lon0 }}/]*width* | {doc}`Winkel Tripel </projections/misc/misc_winkel_tripel>` |
43-
| **S**{{ lon0 }}/{{ lat0 }}[/*horizon*]/*width* | {doc}`General stereographic </projections/azim/azim_general_stereographic>` |
44-
| **T**{{ lon0 }}[/{{ lat0 }}]/*width* | {doc}`Transverse Mercator </projections/cyl/cyl_transverse_mercator>` |
45-
| **U***zone*/*width* | {doc}`Universal Transverse Mercator (UTM) </projections/cyl/cyl_universal_transverse_mercator>` |
46-
| **V**[{{ lon0 }}/]*width* | {doc}`Van der Grinten </projections/misc/misc_van_der_grinten>` |
47-
| **W**[{{ lon0 }}/]*width* | {doc}`Mollweide </projections/misc/misc_mollweide>` |
48-
| **X***width*[**l**\|**p***exp*\|**T**\|**t**][/*height*[**l**\|**p***exp*\|**T**\|**t**]][**d**] | {doc}`Linear </projections/nongeo/cartesian_linear>`, {doc}`logarithmic </projections/nongeo/cartesian_logarithmic>`, {doc}`power </projections/nongeo/cartesian_power>`, and time |
49-
| **Y**{{ lon0 }}/{{ lat0 }}/*width* | {doc}`Cylindrical equal area </projections/cyl/cyl_equal_area>` |
19+
| **A**{{ lon0 }}/{{ lat0 }}[/*horizon*]/*width* | {doc}`/projections/azim/azim_lambert` |
20+
| **B**{{ lon0 }}/{{ lat0 }}/{{ lat1 }}/{{ lat2 }}/*width* | {doc}`/projections/conic/conic_albers` |
21+
| **C**{{ lon0 }}/{{ lat0 }}/*width* | {doc}`/projections/cyl/cyl_cassini` |
22+
| **Cyl_stere**/[{{ lon0 }}/[{{ lat0 }}/]]*width* | {doc}`/projections/cyl/cyl_stereographic` |
23+
| **D**{{ lon0 }}/{{ lat0 }}/{{ lat1 }}/{{ lat2 }}/*width* | {doc}`/projections/conic/conic_equidistant` |
24+
| **E**{{ lon0 }}/{{ lat0 }}[/*horizon*]/*width* | {doc}`/projections/azim/azim_equidistant` |
25+
| **F**{{ lon0 }}/{{ lat0 }}[/*horizon*]/*width* | {doc}`/projections/azim/azim_gnomonic` |
26+
| **G**{{ lon0 }}/{{ lat0 }}[/*horizon*]/*width* | {doc}`/projections/azim/azim_orthographic` |
27+
| **G**{{ lon0 }}/{{ lat0 }}/*width*[**+a***azimuth*][**+t***tilt*][**+v***vwidth*/*vheight*][**+w***twist*][**+z***altitude*] | {doc}`/projections/azim/azim_general_perspective` |
28+
| **H**[{{ lon0 }}/]*width* | {doc}`/projections/misc/misc_hammer` |
29+
| **I**[{{ lon0 }}/]*width* | {doc}`/projections/misc/misc_sinusoidal` |
30+
| **J**[{{ lon0 }}/]*width* | {doc}`/projections/cyl/cyl_miller` |
31+
| **Kf**[{{ lon0 }}/]*width* | {doc}`/projections/misc/misc_eckertIV` |
32+
| **Ks**[{{ lon0 }}/]*width* | {doc}`/projections/misc/misc_eckertVI` |
33+
| **L**{{ lon0 }}/{{ lat0 }}/{{ lat1 }}/{{ lat2 }}/*width* | {doc}`/projections/conic/conic_lambert` |
34+
| **M**[{{ lon0 }}/[{{ lat0 }}/]]*width* | {doc}`/projections/cyl/cyl_mercator` |
35+
| **N**[{{ lon0 }}/]*width* | {doc}`/projections/misc/misc_robinson` |
36+
| **Oa**{{ lon0 }}/{{ lat0 }}/*azimuth*/*width*[**+v**] | {doc}`/projections/cyl/cyl_oblique_mercator_1` |
37+
| **Ob**{{ lon0 }}/{{ lat0 }}/{{ lon1 }}/{{ lat1 }}/*width*[**+v**] | {doc}`/projections/cyl/cyl_oblique_mercator_2` |
38+
| **Oc**{{ lon0 }}/{{ lat0 }}/{{ lonp }}/{{ latp }}/*width*[**+v**] | {doc}`/projections/cyl/cyl_oblique_mercator_3` |
39+
| **P***width*[**+a**][**+f**[**e**\|**p**\|*radius*]][**+r***offset*][**+t***origin*][**+z**[**p**\|*radius*]] | Polar {doc}`azimuthal </projections/nongeo/polar>` ({math}`\theta, r`) or cylindrical |
40+
| **Poly**/[{{ lon0 }}/[{{ lat0 }}/]]*width* | {doc}`/projections/conic/polyconic` |
41+
| **Q**[{{ lon0 }}/[{{ lat0 }}/]]*width* | {doc}`/projections/cyl/cyl_equidistant` |
42+
| **R**[{{ lon0 }}/]*width* | {doc}`/projections/misc/misc_winkel_tripel` |
43+
| **S**{{ lon0 }}/{{ lat0 }}[/*horizon*]/*width* | {doc}`/projections/azim/azim_general_stereographic` |
44+
| **T**{{ lon0 }}[/{{ lat0 }}]/*width* | {doc}`/projections/cyl/cyl_transverse_mercator` |
45+
| **U***zone*/*width* | {doc}`/projections/cyl/cyl_universal_transverse_mercator` |
46+
| **V**[{{ lon0 }}/]*width* | {doc}`/projections/misc/misc_van_der_grinten` |
47+
| **W**[{{ lon0 }}/]*width* | {doc}`/projections/misc/misc_mollweide` |
48+
| **X***width*[**l**\|**p***exp*\|**T**\|**t**][/*height*[**l**\|**p***exp*\|**T**\|**t**]][**d**] | Cartesian {doc}`linear </projections/nongeo/cartesian_linear>`, {doc}`logarithmic </projections/nongeo/cartesian_logarithmic>`, {doc}`power </projections/nongeo/cartesian_power>`, and time |
49+
| **Y**{{ lon0 }}/{{ lat0 }}/*width* | {doc}`/projections/cyl/cyl_equal_area` |

examples/projections/azim/azim_equidistant.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
r"""
2-
Azimuthal Equidistant
3-
=====================
2+
Azimuthal equidistant projection
3+
================================
44
55
The main advantage of this projection is that distances from the projection
66
center are displayed in correct proportions. Also directions measured from the

examples/projections/azim/azim_general_perspective.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
r"""
2-
General Perspective
3-
===================
2+
Perspective projection
3+
======================
44
5-
The general perspective projection imitates the view of the Earth from a finite
5+
The perspective projection imitates the view of the Earth from a finite
66
point in space. In a full view of the earth one third of its surface area can
77
be seen.
88

examples/projections/azim/azim_general_stereographic.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
r"""
2-
General Stereographic
3-
=====================
2+
General stereographic projection
3+
================================
44
55
This map projection is a conformal, azimuthal projection. It is mainly used
66
with a projection center in one of the poles. Then meridians appear as straight

examples/projections/azim/azim_gnomonic.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
r"""
2-
Gnomonic
3-
========
2+
Gnomonic projection
3+
===================
44
55
The point of perspective of the gnomonic projection lies at the center of the
66
Earth. As a consequence great circles (orthodromes) on the surface of the Earth

examples/projections/azim/azim_lambert.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
r"""
2-
Lambert Azimuthal Equal Area
3-
============================
2+
Lambert azimuthal equal-area projection
3+
=======================================
44
55
This projection was developed by Johann Heinrich Lambert in 1772 and is
66
typically used for mapping large regions like continents and hemispheres. It is

examples/projections/azim/azim_orthographic.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
r"""
2-
Orthographic
3-
============
2+
Orthographic projection
3+
=======================
44
55
This is a perspective projection like the general perspective, but with the
66
difference that the point of perspective lies in infinite distance.

examples/projections/conic/conic_albers.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
r"""
2-
Albers Conic Equal Area
3-
=======================
2+
Albers conic equal-area projection
3+
==================================
44
55
This projection, developed by Heinrich C. Albers in 1805, is predominantly used
66
to map regions of large east-west extent, in particular the United States. It

examples/projections/conic/conic_equidistant.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
r"""
2-
Equidistant conic
3-
=================
2+
Equidistant conic projection
3+
============================
44
55
The equidistant conic projection was described by the Greek philosopher
66
Claudius Ptolemy about A.D. 150. It is neither conformal or equal-area, but

examples/projections/conic/conic_lambert.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
r"""
2-
Lambert Conic Conformal Projection
2+
Lambert conic conformal projection
33
==================================
44
55
This conic projection was designed by the Alsatian mathematician Johann

0 commit comments

Comments
 (0)