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.

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

统一代码风格 #32

Open
stone-zeng opened this issue Dec 20, 2019 · 9 comments
Open

统一代码风格 #32

stone-zeng opened this issue Dec 20, 2019 · 9 comments
Assignees

Comments

@stone-zeng
Copy link
Member

  • 代码抄录环境,什么时候用哪个最好统一一下:
    • 行内:\texttt\verb\cmd
    • 行间:verbatimcommandsourcecode
  • 使用 hologo 输出 \TeX 等标记(避免上回 MiKTeX 那种问题)
  • \TeX\ 建议改为 \TeX{}(后跟标点符号时比较坑)
  • 统一 ~ 的用法
  • 合理断行、缩进
@stone-zeng stone-zeng self-assigned this Dec 20, 2019
@zepinglee
Copy link
Member

\TeX\ 建议改为 \TeX{}(后跟标点符号时比较坑)

话说为啥会坑呀?

@stone-zeng
Copy link
Member Author

\TeX\ 建议改为 \TeX{}(后跟标点符号时比较坑)

话说为啥会坑呀?

呃我以为标点跟在控制序列之后会被识别进去,试了一下并不会,那算了。

@zepinglee
Copy link
Member

TeXShop, TeXstudio, TeXworks 这几个编辑器的名字我倾向于保持 plain text 的形式,而不写成 \TeX Shop 等,因为在官网并没有“E”下沉样式的 logo。而且从当今的角度来开,\TeX 这样炫技的命名方式不太可取。

另外关于其他的 TeX 相关的名称,我建议只保留 \TeX{}\LaTeX{} 直接用宏来表示,其他一律用 \hologo{xxx}

@louisstuart96
Copy link
Contributor

你整理一下推PR上来吧,确定一种风格规范写进INSTRUCTIONS.md里。我最近腾不开手改这个。

@zepinglee
Copy link
Member

LaTeX2e Style Guide

@Liam0205
Copy link
Contributor

@zepinglee \TeX\ , 的时候,会多出额外的空格。

@louisstuart96
Copy link
Contributor

louisstuart96 commented Jan 3, 2020

代码抄录环境,什么时候用哪个最好统一一下:

  • 行内:\texttt\verb\cmd
  • 行间:verbatimcommandsourcecode

各个抄录环境目前是这么个用法:

  • commmand 沿用的是英文版 lshort 的用法,用来列举一些相对核心的命令,以内核命令为主,高频使用的宏包命令也可以放。(可能需要清理一波冗余的 \usepackage
  • sourcecode 为大段抄录环境(浮动体),用于被目录索引到的较重要例子。sourcecode 内不全是代码抄录,也会放一些排版效果示意。
  • verbatim 为小段抄录环境,用于简单的举例,比如紧跟 command 列举的命令之后。
  • \cmd 沿用了各种文档类的控制序列转义写法。其它已定义的用法写在 INSTRUCTIONS.md 里。
  • \texttt\verb 用于 \Arg \cmd \env 等已定义用法之外的抄录内容。这个可以统一一下,我之前用惯了 \texttt

@louisstuart96
Copy link
Contributor

louisstuart96 commented Apr 2, 2020

我把现有的一些改动并到master里了,近期可能更新一下版本号。
有新的改动和整理可以先在issue#32分支下面推进。
@zepinglee @stone-zeng

@stone-zeng
Copy link
Member Author

我打算把引号统一用 “...” 来输入,可以避免 ``...''{}, 这种写法。即使引号里面的内容是西文,看起来效果也还行。

stone-zeng added a commit that referenced this issue Jun 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants