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

写作规范 #22

Open

dongzhuoer opened this issue Jul 9, 2017 · 2 comments

Contributor

dongzhuoer commented Jul 9, 2017 •

edited

Loading

我看你给现在还open的那个Pull request提了很多意见@yihui，不如专门发布一个写作规范吧。省得提交新内容后又得改同样的错误。粗略整理如下

标点格式
1. 破折号和书名号之间不必空格
2. 标点一律用中文的，包括（）：等
3. 中英文之间暂时不要空格吧，将来xeCJK可以自动调整空格。
4. 列表项统一用-，打字方便，少按一次Shift
5. 包的名字用粗体，俩星号围起来
内容风格
1. 不写明版本号，如R-x.x.x.tar.gz
2. 参考文献不列就不列，要列的话就直接在正文中写好了，以正文或脚注形式（比如Tufte样式）。
3. R的手册提名字和大概位置就可以了，不必列入文献
4. 图片使用PNG格式（请传imgur.com，完稿统一下载到本地）……GIF难入TeX大门。
5. 能写例子的时候就多写点例子，不要让读者去想象去猜去查。

Owner

yihui commented Aug 18, 2017

谢谢你的建议，不过我估计近两年我是难以抽身继续写这稿子了。

bubifengyun commented Aug 29, 2017

建议不错，我打算采纳一部分。也就是标点符号部分，用在 https://github.com/bubifengyun/deepin-bible ，非常感谢

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment