Permalink
Browse files

统一风格

  • Loading branch information...
1 parent 6a4ed64 commit 4ddd4b14bdcc3e022d7e04e5e802965fe16f2214 @seisman committed Sep 15, 2015
Showing with 2,036 additions and 1,774 deletions.
  1. +2 −2 SAC_Docs.tex
  2. +3 −0 SAC_macros.tex
  3. +1 −1 appendix/doc-maintenance/compile-doc.tex
  4. +30 −23 appendix/doc-maintenance/github-and-git.tex
  5. +2 −2 appendix/doc-maintenance/intro-to-manual.tex
  6. +11 −9 appendix/doc-maintenance/mainteners-wanted.tex
  7. +3 −3 appendix/messages/msg1.tex
  8. +14 −11 appendix/messages/msg2.tex
  9. +20 −16 appendix/naming-convections.tex
  10. +22 −18 appendix/resp/intro-to-resp.tex
  11. +35 −23 appendix/resp/physical-details.tex
  12. +49 −37 appendix/resp/resp-file.tex
  13. +73 −64 basic/command.tex
  14. +13 −12 basic/convection.tex
  15. +10 −8 basic/display.tex
  16. +21 −19 basic/funcgen-and-datagen.tex
  17. +10 −9 basic/how-to-learn.tex
  18. +17 −13 basic/how-to-read.tex
  19. +1 −1 basic/philosophy.tex
  20. +18 −15 basic/read-and-write.tex
  21. +6 −7 basic/start-and-quit.tex
  22. +16 −13 call-in-script/call-sac-in-bash.tex
  23. +20 −18 call-in-script/call-sac-in-perl.tex
  24. +10 −8 call-in-script/call-sac-in-python.tex
  25. +4 −4 call-in-script/ch-origin.pl
  26. +1 −1 call-in-script/do-loops.pl
  27. +5 −4 call-in-script/intro-to-scripts.tex
  28. +1 −1 commands/about.tex
  29. +2 −2 commands/abs.tex
  30. +13 −12 commands/addf.tex
  31. +17 −9 commands/apk.tex
  32. +8 −9 commands/arraymap.tex
  33. +19 −11 commands/bbfk.tex
  34. +21 −12 commands/beam.tex
  35. +5 −3 commands/begindevices.tex
  36. +8 −6 commands/beginframe.tex
  37. +1 −1 commands/chnhdr.tex
  38. +3 −3 commands/color.tex
  39. +2 −2 commands/contour.tex
  40. +1 −1 commands/funcgen.tex
  41. +4 −4 commands/getbb.tex
  42. +1 −1 commands/gtext.tex
  43. +1 −1 commands/highpass.tex
  44. +11 −11 commands/history.tex
  45. +3 −3 commands/line.tex
  46. +3 −3 commands/listhdr.tex
  47. +2 −2 commands/load.tex
  48. +1 −1 commands/map.tex
  49. +4 −3 commands/marktimes.tex
  50. +1 −1 commands/markvalue.tex
  51. +1 −1 commands/message.tex
  52. +1 −1 commands/mtw.tex
  53. +3 −3 commands/null.tex
  54. +4 −4 commands/pickauthor.tex
  55. +7 −7 commands/pickphase.tex
  56. +6 −6 commands/pickprefs.tex
  57. +2 −2 commands/plabel.tex
  58. +1 −1 commands/plotalpha.tex
  59. +4 −4 commands/plotc.tex
  60. +2 −1 commands/plotdy.tex
  61. +1 −1 commands/plotsp.tex
  62. +3 −1 commands/plotxy.tex
  63. +1 −1 commands/qdp.tex
  64. +1 −1 commands/read.tex
  65. +6 −6 commands/readtable.tex
  66. +4 −3 commands/rms.tex
  67. +5 −5 commands/sgf.tex
  68. +3 −3 commands/symbol.tex
  69. +4 −4 commands/synchronize.tex
  70. +1 −1 commands/tsize.tex
  71. +1 −1 commands/unwrap.tex
  72. +9 −9 commands/width.tex
  73. +2 −2 commands/wiener.tex
  74. +3 −3 commands/wild.tex
  75. +2 −2 commands/write.tex
  76. +3 −1 commands/writesp.tex
  77. +2 −2 commands/xvport.tex
  78. +2 −1 commands/zcolors.tex
  79. +2 −2 commands/zlines.tex
  80. +1 −1 contributor.tex
  81. +3 −3 cover.tex
  82. +26 −19 data-process/cut-data.tex
  83. +4 −4 data-process/data-analysis.tex
  84. +34 −0 data-process/data-format.tex
  85. +31 −27 data-process/event-info.tex
  86. +0 −35 data-process/fetch-data.tex
  87. +1 −0 data-process/filter.tex
  88. +25 −22 data-process/instrument-response.tex
  89. +7 −7 data-process/intro-to-process.tex
  90. +17 −12 data-process/merge-traces.tex
  91. +32 −27 data-process/naming.tex
  92. +88 −83 data-process/picking-phase.tex
  93. +12 −11 data-process/quality-control.tex
  94. +14 −12 data-process/resampling.tex
  95. +8 −7 data-process/rglitches.tex
  96. +6 −5 data-process/rmean-rtrend-taper.tex
  97. +10 −9 data-process/rotate.tex
  98. +6 −1 data-process/sort-traces.tex
  99. +3 −3 data-process/station-info.tex
  100. +8 −8 data-process/time-zone-correction.tex
  101. +23 −20 data-process/traveltime.tex
  102. +16 −16 fileformat/binary-and-alphanumeric.tex
  103. +70 −67 fileformat/header-structure.tex
  104. +153 −145 fileformat/header-variables.tex
  105. +11 −9 fileformat/intro-to-fileformat.tex
  106. +166 −148 fileformat/sac-time.tex
  107. +17 −17 frontmatterIII.tex
  108. +23 −19 graphics/composite-plots.tex
  109. +8 −7 graphics/format-conversion.tex
  110. +23 −21 graphics/intro-to-gui.tex
  111. +49 −37 graphics/plot-appearance.tex
  112. +36 −28 graphics/plot-commands.tex
  113. +9 −8 graphics/plot-contour.tex
  114. +12 −11 graphics/save-image.tex
  115. +5 −8 introduction/history.tex
  116. +9 −10 introduction/linux-install.tex
  117. +7 −9 introduction/mac-install.tex
  118. +2 −3 introduction/maillist.tex
  119. +8 −9 introduction/request.tex
  120. +5 −11 introduction/variants.tex
  121. +6 −6 introduction/what-is-sac.tex
  122. +9 −7 libs/call-libsac.tex
  123. +18 −13 libs/call-libsacio.tex
  124. +12 −10 libs/intro-to-libs.tex
  125. +7 −7 macros/blackboard-variables.tex
  126. +15 −14 macros/header-variables.tex
  127. +57 −54 macros/inline-functions.tex
  128. +16 −16 macros/intro-to-sac-programming.tex
  129. +73 −54 macros/macros.tex
  130. +6 −6 sacio/intro-to-sacio.tex
  131. +27 −22 sacio/sacio-in-c.tex
  132. +2 −2 sacio/sacio-in-fortran.tex
  133. +1 −1 scripts/SAC_logo.sh
  134. +6 −4 tools/pssac.tex
  135. +4 −4 tools/sac-config.tex
  136. +7 −6 tools/saclst.tex
  137. +6 −4 tools/sgftops.tex
  138. +27 −24 tricks-and-traps/command-line-length.tex
  139. +13 −12 tricks-and-traps/debug.tex
  140. +29 −24 tricks-and-traps/endian.tex
  141. +9 −5 tricks-and-traps/init-macro.tex
  142. +11 −10 tricks-and-traps/read-dir.tex
  143. +12 −12 tricks-and-traps/tab-and-space.tex
  144. +14 −12 tricks-and-traps/undefined-header-variables.tex
  145. +11 −9 tricks-and-traps/wh-wover.tex
  146. +15 −15 version.tex
View
@@ -61,7 +61,7 @@ \chapter{SAC文件格式}
\chapter{SAC数据处理}
\label{chap:data-process}
\input{data-process/intro-to-process}
-\input{data-process/fetch-data}
+\input{data-process/data-format}
\input{data-process/merge-traces}
\input{data-process/naming}
\input{data-process/time-zone-correction}
@@ -99,7 +99,7 @@ \chapter{SAC编程}
\input{macros/inline-functions}
\input{macros/macros}
-\chapter{在脚本中调用SAC}
+\chapter{脚本中调用SAC}
\label{chap:sac-script}
\input{call-in-script/intro-to-scripts}
\input{call-in-script/call-sac-in-bash}
View
@@ -178,6 +178,9 @@
\usepackage{siunitx} % 数字与单位
\sisetup{per-mode = symbol}
+% 符号
+\usepackage{pifont}
+
\usepackage[perpage]{footmisc} % 脚注在每一页单独编号
% 脚注中verb http://tex.stackexchange.com/questions/203
\usepackage{fancyvrb}
@@ -5,7 +5,7 @@ \section{编译文档}
该项目源码是用 \LaTeX 写成的,Linux下可以用 \TeX~Live~2015 编译。
\subsection{安装\TeX~Live~2015}
-\TeX~Live 是由国际 \TeX 用户组(\TeX~Users Group,TUG)整理和发布的 \TeX
+\TeX~Live 是由国际 \TeX 用户组\TeX~Users Group,TUG整理和发布的 \TeX
软件发行套装,包含与 \TeX 系统相关的各种程序、编辑与查看工具、常用宏包
及文档、常用字体及多国语言支持。
@@ -1,17 +1,18 @@
\section{GitHub和Git}
Git是一个非常强大的版本管理工具,GitHub则是一个基于Git的开源项目托管库。
-本手册使用Git作为版本管理工具,并将源码托管在GitHub上。因而用户需要学会使用GitHub
-和Git才能更好地参与到项目的维护中来
+本手册使用Git作为版本管理工具,并将源码托管在GitHub上。因而用户需要
+学会使用GitHub和Git才能更好地参与到项目的维护中来
\subsection{熟悉GitHub}
维护者需要首先\href{https://github.com/join}{注册}一个GitHub账户,
-并向GitHub账户中添加当前机器的SSH秘钥,以使得当前机器拥有GitHub账户的读写权限。
-具体流程可以参考
+并向GitHub账户中添加当前机器的SSH秘钥,以使得当前机器拥有GitHub账户的
+读写权限。具体流程可以参考
\url{http://www.worldhello.net/gotgithub/02-join-github/010-account-setup.html}。
\subsection{安装和配置Git}
-Linux下直接用系统自带的包管理器即可安装git,同时也建议安装用于用于查看git提交信息的可视化工具gitk。
+Linux下直接用系统自带的包管理器即可安装 \texttt{git},同时也建议安装
+用于用于查看git提交信息的可视化工具 \texttt{gitk}。
CentOS/RHEL用户:
\begin{minted}{console}
@@ -30,16 +31,17 @@ \subsection{安装和配置Git}
\end{minted}
\subsection{准备工作}
-在准备维护该项目之前,建议先阅读相关书籍以了解git的原理以及GitHub的使用说明。推荐的参考书目包括(由易到难排序):
+在准备维护该项目之前,建议先阅读相关书籍以了解git的原理以及GitHub的
+使用说明。推荐的参考书目包括(由易到难排序):
\begin{itemize}
\item \href{http://rogerdudler.github.io/git-guide/index.zh.html}{git简明指南}
\item \href{http://www.worldhello.net/gotgithub/index.html}{GotGitHub}
\item \href{http://www.liaoxuefeng.com/wiki/0013739516305929606dd18361248578c67b8067c8c017b000}{廖雪峰的Git教程}
\item \href{https://git-scm.com/book/zh/v2}{Pro Git}
\end{itemize}
-首先,进入该手册的项目主页 \url{https://github.com/seisman/SAC_Docs_zh},点击右上角的Fork按钮,
-将该项目复制到你的GitHub账户下。
+首先,进入该手册的项目主页 \url{https://github.com/seisman/SAC_Docs_zh},
+点击右上角的Fork按钮,将该项目复制到你的GitHub账户下。
下面假定你的GitHub账户名为 \texttt{USER},在终端执行如下操作:
\begin{enumerate}
@@ -48,26 +50,28 @@ \subsection{准备工作}
$ git clone git@github.com:USER/SAC_Docs_zh.git
$ cd SAC_Docs_zh/
\end{minted}
-\item 将seisman账户下的官方repo添加为远程repo,并命名为seisman,这样方便以后与官方repo同步进度
+\item 将seisman账户下的官方repo添加为远程repo,并命名为seisman,
+ 这样方便以后与官方repo同步进度
\begin{minted}{console}
$ git remote add seisman https://github.com/seisman/SAC_Docs_zh.git
\end{minted}
\end{enumerate}
\subsection{正式维护该项目}
-至此,可以开始正式维护该项目了。使用Git进行协作的方式有很多中,这里参考了阮一峰的
-\href{http://www.ruanyifeng.com/blog/2015/08/git-use-process.html}{Git使用规范流程} 一文
-中的协作方式。请按照如下流程参与到该项目的维护中:
+至此,可以开始正式维护该项目了。使用Git进行协作的方式有很多中,这里
+参考了阮一峰的\href{http://www.ruanyifeng.com/blog/2015/08/git-use-process.html}{Git使用规范流程}
+一文中的协作方式。请按照如下流程参与到该项目的维护中:
\begin{enumerate}
-\item 从seisman的官方repo中拉取源码的最新版本,并合并到本地master分支,以保证本地的master分支与官方master分支同步
+\item 从seisman的官方repo中拉取源码的最新版本,并合并到本地master分支,
+ 以保证本地的master分支与官方master分支同步
\begin{minted}{console}
# 切换到本地的master分支
$ git checkout master
# pull = fetch + merge
$ git pull seisman master
\end{minted}
-\item 不要在master分支中修改文档。对文档进行修改,应新建一个单独在单独的分支。
- 分支名任意,但应尽量反映要维护的内容。这里假定分支名为 \texttt{mydev}
+\item 不要在master分支中修改文档。对文档进行修改,应新建一个单独在单独的
+ 分支。分支名任意,但应尽量反映要维护的内容。这里假定分支名为 \texttt{mydev}
\begin{minted}{console}
$ git checkout -b mydev
\end{minted}
@@ -78,14 +82,16 @@ \subsection{正式维护该项目}
$ git status
$ git commit -m "此处填写本次提交的注释信息"
\end{minted}
-\item 分支开发的过程中,可能seisman的官方master分支已经更新,可以经常与主干保持同步
+\item 分支开发的过程中,可能seisman的官方master分支已经更新,可以经常
+ 与主干保持同步
\begin{minted}{console}
# 获取seisman的更新
$ git fetch seisman
# rebase使得当前分支的提交基于最新的seisman/master
$ git rebase seisman/master
\end{minted}
-\item 分支开发的过程中,可能会有很多次commit,某些commit可能不那么重要,可以将多个commit压缩成一个或若干个commit,这样不仅清晰,也容易管理
+\item 分支开发的过程中,可能会有很多次commit,某些commit可能不那么重要,
+ 可以将多个commit压缩成一个或若干个commit,这样不仅清晰,也容易管理
\begin{minted}{console}
# 以seisman/master作为基准,对当前分支的commit做rebase
$ git rebase -i seisman/master
@@ -110,10 +116,11 @@ \subsection{正式维护该项目}
\subsection{对维护的若干说明}
为了简化维护流程,避免重复或不必要的劳动,请遵循如下原则。
-若只是对文档做简单的微调,比如修改简单的bug或typo,整理部分语句等,可以直接修改并提交PR。
-若需要对文档做大量修改,比如新增章节、调整文档结构等,请先到项目主页中提交Issue,
-由众多维护者一起讨论是否有必要做修改。
+若只是对文档做简单的微调,比如修改简单的bug或typo,整理部分语句等,
+可以直接修改并提交PR。若需要对文档做大量修改,比如新增章节、调整文档
+结构等,请先到项目主页中提交Issue,由众多维护者一起讨论是否有必要做修改。
-若暂时不打算解决某Issue,则该Issue会有标签``Pull Request Welcomed'',维护者可以随意认领
-具有``Pull Request Welcomed''标签的Issue,若某Issue已经被认领,则设置标签为``In Progress''。
-标签的设置和修改只能由seisman完成。
+若暂时不打算解决某Issue,则该Issue会有标签``Pull Request Welcomed'',
+维护者可以随意认领具有``Pull Request Welcomed''标签的Issue,若某Issue
+已经被认领,则设置标签为``In Progress''。标签的设置和修改只能由seisman
+完成。
@@ -1,7 +1,7 @@
\section{手册简介}
-《SAC参考手册》(也就是你正在阅读的文档)是一本详细介绍SAC用法的中文电子书。
+《SAC参考手册》也就是你正在阅读的文档是一本详细介绍SAC用法的中文电子书。
-2011年暑假,我(SeisMan)用20天左右的时间翻译了官方的英文帮助文档;
+2011年暑假,我SeisMan用20天左右的时间翻译了官方的英文帮助文档;
2012年初将翻译的文档整理成PDF并发布1.0版;
2013年3月用 \LaTeX 重新对文档做了排版并发布2.0版;
2014年4月重新设计了整个文档的结构并重写了文档的大部分内容,并发布3.0版;
@@ -1,9 +1,10 @@
\section{征集维护者}
-从2012年的1.0版到2015年的3.3版,本手册一直由我一人维护并持续更新。鉴于个人精力有限,
-因而希望有志愿者参与到这个开源项目中,一起维护并完善该手册。
+从2012年的1.0版到2015年的3.3版,本手册一直由我一人维护并持续更新。
+鉴于个人精力有限,因而希望有志愿者参与到这个开源项目中,一起维护并
+完善该手册。
\subsection{维护的内容}
-本手册需要维护的部分可以分为如下几类(按由简到繁、由易到难排序)
+本手册需要维护的部分可以分为如下几类按由简到繁、由易到难排序
\begin{enumerate}
\item 错别字;
\item 个别行或页面的排版问题;
@@ -18,22 +19,23 @@ \subsection{维护的内容}
\end{enumerate}
\subsection{参与方式}
-想要参与到本手册的维护,有三种方式(从易到难依次为)
+想要参与到本手册的维护,有三种方式从易到难依次为
\begin{itemize}
\item 通过邮件发送给 \url{seisman.info@gmail.com}
\item 在项目主页提交 \href{https://github.com/seisman/SAC_Docs_zh/issues}{Issue}
\item 在项目主页提交 \href{https://github.com/seisman/SAC_Docs_zh/pulls}{Pull Request}
\end{itemize}
-方式一仅用于修正错别字等简单的维护,方式二和方式三则适用于全部的维护。其中,方式一
-对维护者没有其他要求;方式二要求维护者注册GitHub账户并懂得如何提交Issue;
-方式三要求维护者注册GitHub账户,会使用版本控制工具Git,会在GitHub上
-提交Issue和Pull Request,也要求掌握 \LaTeX 及编译的基础知识。
+方式一仅用于修正错别字等简单的维护,方式二和方式三则适用于全部的维护。
+其中,方式一对维护者没有其他要求;方式二要求维护者注册GitHub账户并懂得
+如何提交Issue;方式三要求维护者注册GitHub账户,会使用版本控制工具Git,
+会在GitHub上提交Issue和Pull Request,也要求掌握 \LaTeX 及编译的基础知识。
关于方式三的具体如何操作,在后面的章节会专门介绍。
\subsection{维护者的收益}
维护者全凭志愿,没有任何物质报酬。除此之外,维护者将会:
\begin{enumerate}
-\item 被加入到维护者列表中\footnote{只有具有足够维护量的维护者才会被加入到列表中,最终解释权归SeisMan所有。};
+\item 被加入到维护者列表中\footnote{只有具有足够维护量的维护者才会被
+ 加入到列表中,最终解释权归SeisMan所有。};
\item 结识更多的SAC用户以及地震学同行;
\item 对SAC有更深的理解;
\item 学会Git,参与开源项目;
@@ -52,7 +52,7 @@
波形文件的数目与write命令给出的文件名的数目不想匹配。在该错误信息的后面,紧接着
会给出write命令中给出的文件数目以及内存中的波形数目。
-\SACTitle{1317 The following file is not a SAC data file:}
+\SACTitle{1317 The following file is not a SAC data file}
试图读入非SAC格式的文件所产生的错误。
\SACTitle{1320 Available memory too small to read file}
@@ -85,7 +85,7 @@
\SACTitle{1379 No SORT parameters given}
使用了 \nameref{cmd:sort} 命令,但未指定按照哪个参数排序。
-\SACTitle{1380 Too many SORT parameters:}
+\SACTitle{1380 Too many SORT parameters}
\nameref{cmd:sort} 命令中用于排序的参数太多。
\SACTitle{1381 Not a valid SORT parameter}
@@ -106,7 +106,7 @@
\SACTitle{1702 Non-positive values found in file}
数据文件中存在非正值。
-\SACTitle{1801 Header field mismatch:}
+\SACTitle{1801 Header field mismatch}
该错误出现在 \nameref{cmd:addf}、\nameref{cmd:subf}、\nameref{cmd:divf}、\nameref{cmd:mulf}
以及 \nameref{cmd:merge} 和 \nameref{cmd:beam} 中。
@@ -1,7 +1,8 @@
\pdfbookmark[1]{E2xxx}{E2xxx}
\SACTitle{2001 Command requires an even number of data files}
-使用 \nameref{cmd:rotate} 命令进行数据对的旋转时,需要内存中有成对的数据文件(即偶数个),
-若内存中数目不为偶数个,则报错。注意检查是否有数据漏读。
+使用 \nameref{cmd:rotate} 命令进行数据对的旋转时,需要内存中有成对的
+数据文件(即偶数个),若内存中数目不为偶数个,则报错。注意检查是否有
+数据漏读。
\SACTitle{2002 Following files are not an orthogonal pair}
出现该错误的原因是使用 \nameref{cmd:rotate} 旋转的两个分量不完全正交,
@@ -10,24 +11,26 @@
若两个头段变量有定义,但的确不正交,则无法进行分量旋转。
\SACTitle{2003 Following files are not both horizontals}
-\nameref{cmd:rotate} 命令的 \texttt{TO} 选项只能用于将两个水平的分量旋转到
-某个角度,出现该错误时应注意检查两个分量的头段变量 \texttt{cmpinc} 是否等于90度。
+\nameref{cmd:rotate} 命令的 \texttt{TO} 选项只能用于将两个水平的分量
+旋转到某个角度,出现该错误时应注意检查两个分量的头段变量 \texttt{cmpinc}
+是否等于90度。
\SACTitle{2004 Insufficient header information for rotation}
-\nameref{cmd:rotate} 命令的 \texttt{TO GCP} 选项要求头段变量中 \texttt{stla}、
-\texttt{stlo}、\texttt{evla} 和 \texttt{evlo} 必须定义。该选项会读取一对分量中的
-第一个文件中的头段
-变量,并计算反方位角,而不是直接使用头段变量中已有的反方位角值
+\nameref{cmd:rotate} 命令的 \texttt{TO GCP} 选项要求头段变量中
+\texttt{stla}、\texttt{stlo}、\texttt{evla} 和 \texttt{evlo} 必须定义。
+该选项会读取一对分量中的第一个文件中的头段变量,并计算反方位角,而不是
+直接使用头段变量中已有的反方位角值
\SACTitle{2008 Requested begin time is less than files begin time. Output truncated.}
-\nameref{cmd:interpolate} 命令中指定的开始时间小于文件起始时间,此时输出会被截断。
+\nameref{cmd:interpolate} 命令中指定的开始时间小于文件起始时间,此时
+输出会被截断。
\SACTitle{2111 Taper frequency limits are invalid. No taper applied.}
该警告出现在 \nameref{cmd:transfer} 命令中,出现该错误的原因是 \texttt{freqlimits}
选项的参数设置有误。四个频率应满足 \texttt{f1<f2<f3<f4}。
-出现该警告时,\nameref{cmd:transfer} 会忽略 \texttt{freqlimits} 选项,即在去仪器
-响应时,不使用taper函数,进而可能导致去仪器响应后的波形出现问题。
+出现该警告时,\nameref{cmd:transfer} 会忽略 \texttt{freqlimits} 选项,
+即在去仪器响应时,不使用taper函数,进而可能导致去仪器响应后的波形出现问题。
\SACTitle{2405 Cannot PRINT: no SGF files produced}
无法打印,原因是未生成SGF文件。
Oops, something went wrong.

0 comments on commit 4ddd4b1

Please sign in to comment.