Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update documentation for gmt themes #4717

Merged
merged 24 commits into from
Jan 31, 2021
Merged

Update documentation for gmt themes #4717

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
76155fd
List all parameters alphabetically
Jan 28, 2021
0441d54
Start descriptions for themes and auto settings
Jan 29, 2021
24dc40c
Complete auto scaling documentation
Jan 29, 2021
528a40f
Merge branch 'gmt-themes' into gmt-themes-docs
Jan 29, 2021
128c6af
Merge branch 'gmt-themes' into gmt-themes-docs
Jan 29, 2021
4b60d5b
Add FONT_SUBTITLE to tables
Jan 29, 2021
f723351
Fix classic default
Jan 29, 2021
97235ac
Update auto scaling description
Jan 29, 2021
94301da
Fix font settings
Jan 29, 2021
7ba6c62
Update FONT_SUBTITLE default
Jan 29, 2021
6f5a616
Update MAP_TICK_PEN_PRIMARY default docs
Jan 29, 2021
85e202b
Update theme dependent defaults
Jan 29, 2021
4b4407f
Fix a typo
Jan 29, 2021
76c5898
Format defaults documentation
Jan 29, 2021
a78be05
Move theme-settings to separate docs page
Jan 29, 2021
ffd9079
Update auto scaling links
Jan 29, 2021
4d6dcd4
Update auto scaling documentation
Jan 29, 2021
02b4e73
Link themes table to gmt.conf keywords
Jan 29, 2021
d50b28a
Add more links between auto, gmt.conf, and themes
Jan 29, 2021
917e04c
Fix formatting
Jan 29, 2021
4edd921
Update MAP_ANNOT_MIN_SPACING default
Jan 29, 2021
9c507c3
Merge branch 'gmt-themes' into gmt-themes-docs
Jan 30, 2021
598ce83
Format doc/rst/source/cookbook/features.rst
Jan 30, 2021
6a8e33c
Merge branch 'gmt-themes' into gmt-themes-docs
Jan 31, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Complete auto scaling documentation
  • Loading branch information
Meghan Jones committed Jan 29, 2021
commit 24dc40cd02fe4cb7ee599970901512a218cbb8a2
40 changes: 20 additions & 20 deletions doc/rst/source/explain_auto_scaling.rst_
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,29 +5,29 @@ Auto scaling for GMT parameters

The auto setting can be used to automatically scale GMT parameters based on
the map size. The following table shows the parameter value for a 10 cm plot
and a 50 cm plot and the scaling equation, where :math:`s` (points) is maximum
and a 50 cm plot and the scaling equation, where :math:`s` is maximum
of the plot width and height (cm)

================================= ========================= ============================================
Parameter [10cm value, 50cm value] Scaling equation
================================= ========================= ============================================
FONT_ANNOT_PRIMARY [9.0p, 14.3p] :math:`(2/15 * (s - 10) + 9)`
FONT_ANNOT_SECONDARY [10.8p, 17.2p] :math:`(2/15 * (s - 10) + 9) * 6/5`
FONT_HEADING [25.2p, 40.1p] :math:`(2/15 * (s - 10) + 9) * 14/5`
FONT_LABEL [12.6p, 20.1p] :math:`(2/15 * (s - 10) + 9) * 7/5`
FONT_LOGO [7.2p, 11.5p] :math:`(2/15 * (s - 10) + 9) * 4/5`
FONT_TAG [14.4p, 22.9p] :math:`(2/15 * (s - 10) + 9) * 8/5`
FONT_TITLE [10.8p, 17.2p] :math:`(2/15 * (s - 10) + 9) * 11/5`
MAP_ANNOT_OFFSET_PRIMARY [2.7p, 4.3p] :math:`(2/15 * (s - 10) + 9) * 3/10`
MAP_ANNOT_OFFSET_SECONDARY [2.7p, 4.3p] :math:`(2/15 * (s - 10) + 9) * 3/10`
MAP_FRAME_WIDTH [2.7p, 4.3p] :math:`(2/15 * (s - 10) + 9) * 3/10`
MAP_GRID_PEN_PRIMARY :math:`(2/15 * (s - 10) + 9) * 1/40`
MAP_GRID_PEN_SECONDARY :math:`(2/15 * (s - 10) + 9) * 1/20`
MAP_HEADING_OFFSET :math:`(2/15 * (s - 10) + 9) * 8/5`
MAP_LABEL_OFFSET :math:`(2/15 * (s - 10) + 9) * 3/5`
MAP_TICK_LENGTH_PRIMARY :math:`(2/15 * (s - 10) + 9) * 1/5`
MAP_TICK_LENGTH_SECONDARY :math:`(2/15 * (s - 10) + 9) * 1/10`
MAP_TICK_PEN_PRIMARY :math:`(2/15 * (s - 10) + 9) * 1/20`
MAP_TICK_PEN_SECONDARY :math:`(2/15 * (s - 10) + 9) * 1/40`
MAP_TITLE_OFFSET :math:`(2/15 * (s - 10) + 9) * 6/5`
FONT_ANNOT_PRIMARY [9.00p, 14.33p] :math:`(2/15 * (s - 10) + 9)`
FONT_ANNOT_SECONDARY [10.80p, 17.20p] :math:`(2/15 * (s - 10) + 9) * 6/5`
FONT_HEADING [25.20p, 40.13p] :math:`(2/15 * (s - 10) + 9) * 14/5`
FONT_LABEL [12.60p, 20.10p] :math:`(2/15 * (s - 10) + 9) * 7/5`
FONT_LOGO [7.20p, 11.47p] :math:`(2/15 * (s - 10) + 9) * 4/5`
FONT_TAG [14.40p, 22.93p] :math:`(2/15 * (s - 10) + 9) * 8/5`
FONT_TITLE [19.80p, 31.53p] :math:`(2/15 * (s - 10) + 9) * 11/5`
MAP_ANNOT_OFFSET_PRIMARY [2.70p, 4.30p] :math:`(2/15 * (s - 10) + 9) * 3/10`
MAP_ANNOT_OFFSET_SECONDARY [2.70p, 4.30p] :math:`(2/15 * (s - 10) + 9) * 3/10`
MAP_FRAME_WIDTH [2.70p, 4.30p] :math:`(2/15 * (s - 10) + 9) * 3/10`
MAP_GRID_PEN_PRIMARY [0.23p, 0.36p] :math:`(2/15 * (s - 10) + 9) * 1/40`
MAP_GRID_PEN_SECONDARY [0.45p, 0.72p] :math:`(2/15 * (s - 10) + 9) * 1/20`
MAP_HEADING_OFFSET [14.40p, 22.93p] :math:`(2/15 * (s - 10) + 9) * 8/5`
MAP_LABEL_OFFSET [5.40p, 8.60p] :math:`(2/15 * (s - 10) + 9) * 3/5`
MAP_TICK_LENGTH_PRIMARY [1.80p, 2.87p] :math:`(2/15 * (s - 10) + 9) * 1/5`
MAP_TICK_LENGTH_SECONDARY [0.90p, 1.43p] :math:`(2/15 * (s - 10) + 9) * 1/10`
MAP_TICK_PEN_PRIMARY [0.45p, 0.72p] :math:`(2/15 * (s - 10) + 9) * 1/20`
MAP_TICK_PEN_SECONDARY [0.23p, 0.36p] :math:`(2/15 * (s - 10) + 9) * 1/40`
MAP_TITLE_OFFSET [10.8p, 17.2p] :math:`(2/15 * (s - 10) + 9) * 6/5`
================================= ========================= ============================================
2 changes: 1 addition & 1 deletion doc/rst/source/gmt.conf.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1170,7 +1170,7 @@ Calendar/Time Parameters
correspond to 1729 through 1799, while numbers 00 through 28
correspond to 1800 through 1828. [1950].

.. include:: themes.rst_
.. include:: explain_theme_settings.rst_

.. include:: explain_auto_scaling.rst_

Expand Down