Skip to content

Commit

Permalink
Fix incorrect markdown rendering due to automatic ReST->MyST conversi…
Browse files Browse the repository at this point in the history
…ons (#1361)

Co-authored-by: Mao Zhou <[email protected]>
  • Loading branch information
seisman and ZMAlt authored Sep 12, 2024
1 parent 6523261 commit 54c5c46
Show file tree
Hide file tree
Showing 25 changed files with 53 additions and 50 deletions.
2 changes: 1 addition & 1 deletion source/basis/color.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ RGB颜色示例:
- **0/255/0**:绿色;
- **0/0/255**:蓝色;

RGB颜色除了可以用上面的表示法之外,还可以用HTML中常用的表示法 **#***RRGGBB*
RGB颜色除了可以用上面的表示法之外,还可以用HTML中常用的表示法 **#**_RRGGBB_
即分别用两位的十六进制数字表示每个颜色通道,0对应的16进制是 **00**
255对应的16进制是 **FF**。例如 **#000000** 即黑色,**#FF0000** 即红色。
十六进制数用大小写表示均可。
Expand Down
10 changes: 5 additions & 5 deletions source/basis/io-format.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ GMT 所支持的数据类型主要分为四大类:地理坐标、绝对时间

2. 度分秒:

> \[**±**\]*ddd*\[**:***mm*\[**:***ss*\[.*xxx*\]\]\]\[**W**|**E**|**S**|**N**\]
> \[**±**\]*ddd*\[**:**_mm_\[**:**_ss_\[.*xxx*\]\]\]\[**W**|**E**|**S**|**N**\]
- *ddd**mm**ss**xxx* 分别表示度、分、秒以及秒的小数部分
- **W****E****S****N** 分别代表西经、东经、南纬、北纬
Expand All @@ -34,13 +34,13 @@ GMT 所支持的数据类型主要分为四大类:地理坐标、绝对时间

日期可以是如下格式的一种:

1. 年–月–日:*yyyy*\[**-***mm*\[**-***dd*\]\]
1. 年–月–日:*yyyy*\[**-**_mm_\[**-**_dd_\]\]
**2013****2015-10****2015-01-02**
2. 年–一年中的第几日:*yyyy*\[**-***jjj*\],如 **2015-040**
3. 年–一年中的第几周–该周内第几天:*yyyy*\[**-W***ww*\[**-***d*\]\]
2. 年–一年中的第几日:*yyyy*\[**-**_jjj_\],如 **2015-040**
3. 年–一年中的第几周–该周内第几天:*yyyy*\[**-W**_ww_\[**-**_d_\]\]
**2014-W01-3****2014-W01**

时间是 24 小时制,其格式为 *hh***:**\[*mm***:**\[*ss*\[.*xxx*\]\]\]
时间是 24 小时制,其格式为 _hh_**:**\[_mm_**:**\[*ss*\[.*xxx*\]\]\]
**10:10:35.120**

举几个绝对时间的例子:
Expand Down
2 changes: 1 addition & 1 deletion source/basis/pen.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ GMT中可以通过两种方式指定画笔宽度:

4. 复杂线型

通过 *string*\[**:***offset*\] 的形式可以自定义任意复杂的线型。
通过 *string*\[**:**_offset_\] 的形式可以自定义任意复杂的线型。

*string* 是一系列由下划线 `_` 分隔的数字组成。这一系列数字中,
第奇数个数字表示实线的长度,第偶数个数字表示空白的长度。
Expand Down
6 changes: 3 additions & 3 deletions source/basis/text.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,13 +76,13 @@ GMT中可以用字体名(**区分大小写**)或对应的字体编号来指

## 描边

在给文字指定填充色的同时,还可以在填充色 *fill* 后加上 **=***pen* 以指定文本
在给文字指定填充色的同时,还可以在填充色 *fill* 后加上 **=**_pen_ 以指定文本
轮廓(即描边)的画笔属性。画笔属性 *pen* 的用法见 {doc}`pen` 一节。
比如 **red=2p,blue** 表示将文字填充为红色,并使用宽度为 **2p** 的蓝色线条给
文字描边。若填充色 *fill***-**,则不对文字做填充,即实现空心文字的效果。

使用 **=***pen* 语法绘制文本轮廓时,轮廓线条有一半宽度位于文字外部,另一半
宽度会遮住字体。为了避免这一现象,可以使用 **=~***pen* 语法,此时在绘制文字
使用 **=**_pen_ 语法绘制文本轮廓时,轮廓线条有一半宽度位于文字外部,另一半
宽度会遮住字体。为了避免这一现象,可以使用 **=~**_pen_ 语法,此时在绘制文字
轮廓时只绘制文字外部的半个线宽的线条。

## 小练习
Expand Down
4 changes: 2 additions & 2 deletions source/conf/map.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

::::{glossary}
**MAP_FRAME_TYPE**
底图边框类型 \[**fancy**\]
底图边框类型 [**fancy**]

可选值包括 **inside**|**plain**|**graph**|**fancy**|**fancy+**。

Expand All @@ -21,7 +21,7 @@
```

对于 **graph** 类型,默认箭头的顶端超过坐标轴顶点7.5%。可以通过使用
**graph,***length*\[%\] 的方式指定超过的长度或百分比。坐标轴的宽度
**graph,**_length_[%] 的方式指定超过的长度或百分比。坐标轴的宽度
由 {term}`MAP_FRAME_WIDTH` 决定,箭头的长度和宽度则分别是该宽度的10倍
和5倍。箭头的形状还可以由 {term}`MAP_VECTOR_SHAPE` 控制。

Expand Down
2 changes: 1 addition & 1 deletion source/conf/proj.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
- *a*:球半径为a,单位为 m,扁率为零。比如 6378137
- *a*,*inv_f* : *inv_f* 为扁率的倒数,比如 6378137,298.257223563
- *a*,*b*=*b* : *b* 为半短轴长度,单位为 m,比如 6378137,b=6356752.3142
- *a*,**f=***f* : *f* 为扁率,比如 6378137,f=0.0033528
- *a*,**f=**_f_ : *f* 为扁率,比如 6378137,f=0.0033528

需要注意,对于某些全球投影,GMT会对选中的地球椭球做球状近似,将扁率设为零,
并使用其平均半径。当GMT做此类近似时,会给出警告信息。
Expand Down
6 changes: 3 additions & 3 deletions source/conf/ps.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
- **Standard+**
- **ISOLatin1**
- **ISOLatin1+**
- **ISO-8859-***x*(x取值为1-10或13-15)
- **ISO-8859-**_x_(x取值为1-10或13-15)

若安装GMT时使用SI单位制,则默认值为 **ISOLatin1+** 编码;否则使用 **Standard+** 编码。

Expand Down Expand Up @@ -79,7 +79,7 @@
echo 10.5 0 $cap | gmt text -F+jML+f12p,8
done
gmt end show
```
```

**PS_LINE_JOIN**
控制线段拐点的绘制方式 \[**miter**\]
Expand Down Expand Up @@ -109,7 +109,7 @@
done
gmt subplot end
gmt end show
```
```

**PS_MITER_LIMIT**
设置 {term}`PS_LINE_JOIN`**miter** 时拐点的角度阈值 \[35\]
Expand Down
6 changes: 3 additions & 3 deletions source/conf/time.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,10 @@
其可以取如下三类值:

- **off**:即不对输入数据做任何截断和调整
- +*n**unit*:*n* 为某个整数,*unit*为某个时间单位。其表示
将输入的日期时间数据截断为 *n**unit* 的整数倍,并将其放在紧接着的时间
- +*n*_unit_:*n* 为某个整数,*unit*为某个时间单位。其表示
将输入的日期时间数据截断为 *n*_unit_ 的整数倍,并将其放在紧接着的时间
间隔的中间
- -*n**unit*:同样,但将该输入数据放在前一个时间间隔的中间
- -*n*_unit_:同样,但将该输入数据放在前一个时间间隔的中间

时间间隔单位 *unit* 可以取如下值:

Expand Down
4 changes: 2 additions & 2 deletions source/cpt/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@

在文件名后加上后缀 **+u**|**U***unit* 还可以对CPT文件中的Z值进行缩放。

- *filename.cpt***+u***unit* 可以将Z值从 *unit* 变换为以米为单位
- *filename.cpt***+U***unit* 可以将Z值从以米为单位变换成 *unit*
- *filename.cpt*__+u__*unit* 可以将Z值从 *unit* 变换为以米为单位
- *filename.cpt*__+U__*unit* 可以将Z值从以米为单位变换成 *unit*
4 changes: 2 additions & 2 deletions source/dataset/gshhg.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,8 @@ GSHHG 数据中包含了海岸线数据、河流数据和国界数据。
- **-W**\[*level*/\]*pen* 绘制不同等级的海岸线
- **-G***fill* 设置陆地、岛屿等陆区的填充色
- **-S***fill* 设置海洋、湖泊等水区的填充色
- **-C***fill***+l** 设置湖泊的填充色
- **-C***fill***+r** 设置河流湖的填充色
- **-C**_fill_**+l** 设置湖泊的填充色
- **-C**_fill_**+r** 设置河流湖的填充色

### 河流

Expand Down
2 changes: 1 addition & 1 deletion source/dataset/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ GMT检查数据更新的机制是:

GMT为每种远程数据都提供了不同的分辨率和配准方式的数据,具体信息在各个数据的小节
会详细介绍。所有GMT远程数据都可以通过指定特殊文件名的方式来使用:
**@***remote_name*\_*rr**u*\_*reg*
**@**_remote_name_\_*rr*_u_\_*reg*

- **@** 符号用于告诉GMT这是一个远程数据
- *remote_data* 是远程数据的具体名字
Expand Down
4 changes: 2 additions & 2 deletions source/grid/read.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,10 @@ netCDF格式的设计相当灵活,单个netCDF文件中可以包含**多个多
## 读取二维多变量netCDF文件

对于包含多个二维变量的netCDF网格文件,GMT默认会读取第一个二维变量作为Z值,并
忽略其余的二维变量。用户可以通过在网格文件名后加上后缀 **?***varname* 的方式指定
忽略其余的二维变量。用户可以通过在网格文件名后加上后缀 **?**_varname_ 的方式指定
要读取某个特定的二维变量,即:

> *filename***?***varname*
> *filename*__?__*varname*
其中 *varname* 是netCDF文件中包含的变量名,其可以通过netCDF提供的命令
`ncdump -c file.nc` 得到。
Expand Down
9 changes: 6 additions & 3 deletions source/install/macOS.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,12 @@

macOS 下安装 GMT 有多种方式:

1. [使用 Homebrew 安装] \[**推荐**\]
2. [使用 GMT 安装包]
3. [使用 MacPorts 安装]
1. [使用 Homebrew 安装](macos-homebrew) [**推荐**]
2. [使用 GMT 安装包](macos-bundle)
3. [使用 MacPorts 安装](macos-macports)
4. {doc}`conda`

(macos-homebrew)=
## 使用 Homebrew 安装

[Homebrew](https://brew.sh/) 是 macOS 下的第三方软件包管理工具。
Expand Down Expand Up @@ -83,6 +84,7 @@ macOS 下安装 GMT 有多种方式:
$ brew uninstall gmt
```

(macos-bundle)=
## 使用 GMT 安装包

GMT 为 macOS 用户提供了 dmg 安装包,其不仅包含了 GMT,还包含了运行 GMT 所需的
Expand Down Expand Up @@ -135,6 +137,7 @@ GMT 的 dmg 安装包只支持 macOS >= 12。
GMT 包不支持自动升级,因而要先删除旧 GMT 包,再下载新版安装包并按照上面的
步骤重新安装,即实现升级 GMT。

(macos-macports)=
## 使用 MacPorts 安装

[MacPorts](https://www.macports.org/) 是 macOS 下的第三方软件包管理工具。
Expand Down
2 changes: 1 addition & 1 deletion source/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ GMT 的某些模块基于 GMT 团队单独发展并发表的算法。算法相

**论坛/讨论组**

1. 地学 GMT 中文社区 QQ 群 \[**请勿重复加群!**入群前请先阅读“[入群须知](https://gmt-china.org/blog/community-guide/)\]
1. 地学 GMT 中文社区 QQ 群 [**请勿重复加群!** 入群前请先阅读“[入群须知](https://gmt-china.org/blog/community-guide/)]

- QQ 1 群:218905582
- QQ 2 群:791856541
Expand Down
2 changes: 1 addition & 1 deletion source/option/J.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@
所有的 [PROJ 投影](https://proj.org/en/latest/operations/projections/index.html)
但对于绘图而言,其用处却很有限。一方面,只有一部分 PROJ 的投影方式可以被
映射到 GMT 的投影语法中, 只能使用这些投影绘图;另一方面,由于 PROJ 不是一个绘图库,
其不支持设置地图比例尺或地图大小,因而,GMT 为 PROJ 语法引入了两个扩展:**+width=***size*
其不支持设置地图比例尺或地图大小,因而,GMT 为 PROJ 语法引入了两个扩展:**+width=**_size_
**+scale=1:xxxx** 使得其与经典的 GMT 中的工作方式相似。
此外,也可以在投影参数的最后加上字符串 **/1:xxx** 来指定比例尺。

Expand Down
10 changes: 5 additions & 5 deletions source/option/R.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,26 +13,26 @@
常用于指定笛卡尔数据的范围以及经线和纬线是直线的投影方式下的地理区域。
例如 **-R0/360/-90/90** 表示X方向范围是0到360,Y方向范围是-90到90。

2. **-R***xlleft*/*ylleft*/*xuright*/*yuright***+r**
2. **-R**_xlleft_/*ylleft*/*xuright*/_yuright_**+r**

通过给定矩形区域的左下角坐标 (*xlleft*, *ylleft*) 和右上角坐标 (*xuright*, *yuright*)
来指定数据范围。
例如 **-R-90/20/-65/30+r**
这种形式通常用于倾斜的地图投影中,此时不适合将经线和纬线作为地图边界。
使用这种形式可以保证底图为矩形,尽管经线和纬线可能不是直线。

3. **-R***gridfile*
3. **-R**_gridfile_

该方式会直接从2D网格文件 *gridfile* 中提取数据范围信息。
对于某些模块,该方式不仅会从网格中读取范围信息,
还会读入网格间隔和网格配准信息(见 {doc}`/option/nodereg`)。

4. **-R***code1*,*code2*,**\[**+e**|**r**|**R**\[*incs*\]\]
4. **-R**_code1_,*code2*,**\[**+e**|**r**|**R**\[*incs*\]\]

通过直接指定区域代码 *code1**code2* 等间接指定研究区域范围。
区域代码可以表示某个大洲、某个国家、某个州或省,详情见 {doc}`/dataset/dcw/index` 一节。

**+e**|**+r**|**+R***incs* 用于对通过区域代码得到的研究区域范围进一步扩张或缩减。
**+e**|**+r**|**+R**_incs_ 用于对通过区域代码得到的研究区域范围进一步扩张或缩减。
其中 **+r** 表示调整区域范围使得范围是 *incs* 的整数倍,
**+e****+r** 类似,但其保证了至少向外扩展0.25倍的 *incs*
**+R** 表示 *incs* 被解释为区域范围向外扩展的增量。
Expand All @@ -44,7 +44,7 @@

例如 **-RFR+r1** 表示取法国国界对应的区域范围并将其调整到最近的整数度数。

5. **-R***anchor**x0*/*y0*/*nx*/*ny*
5. **-R**_anchor_*x0*/*y0*/*nx*/*ny*

该方法仅可用于创建新的网格文件。通过指定网格文件中某个特定点
(由 *anchor* 决定,见 {doc}`/basis/anchor` 一节)的坐标
Expand Down
2 changes: 1 addition & 1 deletion source/option/U.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
- **-U** 不加任何参数时会在当前图的左下角添加一个带GMT标识的时间戳
- **-U***label* 会在时间戳后打印字符串 *label*,比如 `-U"This is string"`
- **-U+c** 会在时间戳后打印当前命令
- **-U+j***just***+o***dx*/*dy* 用于控制将时间戳的哪个{doc}`锚点 </basis/anchor>`
- **-U+j**_just_**+o**_dx_/_dy_ 用于控制将时间戳的哪个{doc}`锚点 </basis/anchor>`
与当前底图的左下角对齐,以及其偏移量。例如,`-U+jBL+o0/0` 表示将时间戳的
左下角与底图左下角对齐

Expand Down
2 changes: 1 addition & 1 deletion source/option/binary.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
> **-b**\[**i**|**o**\]\[*ncols*\]\[*type*\]\[**w**\]\[**+l**|**b**\]
**-bi** 表示对输入有效,**-bo** 表示对输出有效。
后面紧跟着指定有 *ncols* 列个 *type* 类型的数据,多个 *ncols**type* 之间可以
后面紧跟着指定有 *ncols* 列个 *type* 类型的数据,多个 *ncols* *type* 之间可以
用逗号分隔。**w** 表示对这些列数据强制做字节序转换。
**+l****+b** 表示整个数据按照little-endian或big-endian字节序读入。

Expand Down
2 changes: 1 addition & 1 deletion source/option/distcal.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**-j** 选项用于控制球面上两点间距离的计算方式。其语法为:

**-j****e**|**f**|**g**
**-je**|**f**|**g**

在计算地球或其它星体上任意两点间的距离时,GMT 提供了三种不同的计算方式:
平面距离、大圆路径距离和测地线距离。
Expand Down
10 changes: 5 additions & 5 deletions source/option/g.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@

*u* 用于指定 *gap* 的单位:

- 对于 **-g****x**|**y**|**d***u* 可以取距离单位 \[默认为 m\]
- 对于 **-g****X**|**Y**|**D***u* 可以取长度单位 \[默认为 {term}`PROJ_LENGTH_UNIT`\]
- 对于 **-g****x**|**y**|**z**,若输入是时间数据,则单位由 {term}`TIME_UNIT` 控制
- 对于 **-g**__x__|__y__|__d__*u* 可以取距离单位 \[默认为 m\]
- 对于 **-g**__X__|__Y__|__D__*u* 可以取长度单位 \[默认为 {term}`PROJ_LENGTH_UNIT`\]
- 对于 **-g**__x__|__y__|__z__,若输入是时间数据,则单位由 {term}`TIME_UNIT` 控制

一般而言,当两点间的X坐标、Y坐标或距离的绝对值超过 *gap* 即分段。可以进一步控制两点的差的计算方式。
*gap***+n** 表示用前一数据减去当前数据作为 *gap*
*gap***+p** 表示用当前数据减去前一数据作为 *gap*
_gap_**+n** 表示用前一数据减去当前数据作为 *gap*
_gap_**+p** 表示用当前数据减去前一数据作为 *gap*

该选项可重复多次,以指定多个分段准则。默认情况下,若符合任意一个准则则分段,
可以使用 **-ga** 选项,表明仅当所有准则都满足时才分段。
2 changes: 1 addition & 1 deletion source/option/p.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

对于3D底图而言(使用了 **-JZ** 选项),默认会在Z轴底部绘制XY平面的边框。

- 设置 *zlevel* 则可以指定在 **Z=***zlevel* 平面内绘制边框
- 设置 *zlevel* 则可以指定在 **Z=**_zlevel_ 平面内绘制边框
- **-px|y|z** 则分别用于指定绘制 YZ 平面、XZ平面或XY平面。默认为 **-pz**
绘制XY平面

Expand Down
2 changes: 1 addition & 1 deletion source/table/ascii.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ gmt plot input.dat -JX10c -R0/50/0/50 -Baf -W1p -Gred -pdf lines
```

用户可以通过设置 {term}`IO_SEGMENT_MARKER` 将段头记录的
标识符修改为任意字符,例如 **@****%**
标识符修改为任意字符,例如 **@**__%__
{term}`IO_SEGMENT_MARKER` 可以取两个特殊的值:

-**B** 表示用空行作为数据段的分隔符
Expand Down
4 changes: 2 additions & 2 deletions source/table/netcdf.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ netCDF表数据中包含了一个或多个一维数组,每个一维数组都
所需要的字段数。

若需要手动指定要从netCDF表中读入哪些变量,可以在netCDF表文件名后加上后缀
**?***var1***/***var2***/***...*或使用选项
**-bic***var1***/***var2***/***...* 以指定要读入的变量,
**?**_var1_**/**_var2_**/**_..._或使用选项
**-bic**_var1_**/**_var2_**/**_..._ 以指定要读入的变量,
其中 *var1* 等是要从netCDF表中读入的变量名。比如 **file.nc?lon/lat**
表示要从文件中读入 **lon****lat** 两个一维数组作为输入数据。

Expand Down
2 changes: 1 addition & 1 deletion source/tutorial/configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ FONT_TITLE = 24p,Helvetica,black
gmt end show
```

临时设置则是通过为命令添加选项 **--KEY=***value* 的形式实现的,
临时设置则是通过为命令添加选项 **--KEY=**_value_ 的形式实现的,
其中 **KEY** 是配置参数的名称,*value* 是配置参数的值。在下面的例子中,
在绘制左边的底图时使用了选项 `--FONT_TITLE=12p,Times-Bold,red`
所以该底图的标题的字体是红色的。由于临时设置仅对当前命令有效,其不会影响到
Expand Down
2 changes: 1 addition & 1 deletion source/tutorial/oneliner.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ gmt end show

针对这种简单情况,GMT 提供了 “单行模式”。即当绘图只需要一个 GMT 命令时,
可省略 **gmt begin****gmt end**,只需要在绘图命令后加上
**-***format* *figname* 即可。
**-**_format figname_ 即可。

例如,上面的三行命令可以用单行模式写成一行命令:

Expand Down

0 comments on commit 54c5c46

Please sign in to comment.