1 min read

《Steem 指南》进展:写作规范 - Progress in Steem Handbook

原文链接: steemit, cnsteem, busy, chainbb, steemdb, steemd, busy, markdown

This is a report of the progress in the book Steem Handbook (in Chinese). In this post we list some writing rules.

这是《Steem 指南》一书的注意事项。为了保证将来统稿的质量,减少不必要的麻烦,请各位作者按以下要求写书稿。考虑到本文在 Steem 上发布 7 天后无法更新,本文最新版见 《Steem 指南》实施纲要

  • 首选参考资料
  • 授权和署名
    • 本书暂定以 CC BY 4.0 授权。如有异议,欢迎留言。
    • 参与本书的全部贡献者(作者、编者、美工、校对等),遵从各人意愿(真名、id、匿名均可),在封面共同署名。
    • 各章节的作者和编者,在各章节标题处单独署名。
  • 内容和文风
    • 尽量写一些变动不会太大的内容,书会有比较长的生命力。
    • 简明扼要。可以适当口语化,但不要有太多的口水词和罗圈话。尽量提供干货。
  • 书稿格式
    • 书稿统一用标准的 markdown 语法来书写(见上文的首选参考资料),保存为纯文本文件。除非特殊需求,不使用扩展语法。这是为了方便移植。本帖末尾给了例子。
    • 连续两个回车来分段。也就是说,在文本文件里,两段之间要有个空行。本帖末尾给了例子。
    • 建议使用 typora 编辑器,这里有个简易教程
  • 章节层次
    • 章标题和节标题之间不要有正文。也就是说,所有的正文文字都从属于某个节。
    • 本书最多分到三级标题(即“小节”),也就是 markdown 里的三个 # 号。不要出现四级标题。如果需要的话,用粗体表示更低一级的标题即可。
    • 务必不要用 # 的方式把某段文字加粗或扩大字号。# 开头仅用作章节标题。
    • 请每个章节标题后面添加个花括号,里面是用来生成该节网页的文件名称,由于网址不支持中文,所以建议统一用标题拼音的首字母,当然也可以用英文。本帖末尾给了例子。
  • 插图
    • 请插入本地图片,不要插入网络图片。如果需要插入网络图片,请先把图片下载到本地。同时注意不要侵犯别人图片的版权。
    • 使用 markdown 标准语法来插入图片,即 ![]()。本帖末尾给了例子。
    • 尽量使用静态图片(jpg,png),避免使用动态图片(gif);当然,如果动态图片对展示内容效果更好的话,也无妨,但请备好能够替代的静态图片。这是为了方便做 pdf 和纸质书。
  • 标点符号
    • 请按照中文的标点符号规则书写。例如,省略号是……而不是......,也不是。。。
    • 最好不要用像“:)”的表情符号,除非十分有必要——想想印在纸质书里的感觉。
    • 简单规范见《中文文案排版指北》。详细规范见《中文排版需求》

img

下面是个简单的模板,演示了标题、正文分段、超级链接、插图。

# 基本常识 {#jbcs}

## 什么是 SBD {#smssbd}

SBD 就是那啥啥(见 steemit [官方网站](http://steemit.com))。

下面是个图示。

![](fig/sbd.jpg)

如有缺失错漏,欢迎大家留言。

相关文章