《Steem 指南》近期文稿编写遇到的几个问题
This post is a contribution to the open source project Steem Handbook. Details could be found in the post Steem Handbook Calls for Support.
最近,《Steem 指南》的 GitHub 项目收到了很多 PR。我合并后,却发现没法顺利编译成书,需要花时间去找 bug,而这两天比较忙,书稿就一直没更新。今天集中处理了一下,把问题汇总在这里。有的我已经手动修改了,有的还没改,烦请涉案人自己修改一下,更新到项目里为盼。
1. 几处插图,作者用的是网上的图片链接,而编译成书要求必须是本地图片。
红色部分是作者原文,绿色是我修改的。解释一下就是,先把超级链接的图片下载下来,然后按章节编号来改名,并保存到项目里的 images 文件夹,最后用相对链接的方式插到文稿里。
2. 标题脚注,这个怪我,事先没说清楚。
标题末尾,花括号可要可不要。如果要的话,加在标题行的末尾;如果标题后面有脚注,那么花括号要放在脚注后面。
再次解释一下花括号,有两个用处:一是为了交叉引用时自动编号,可是大家一般都不使用交叉引用;二是为了让该章节的网址可读性更强,可是大家一般不在乎。所以,不必加花括号。
3. @ 前要多个反斜杠 \。
这个属于特殊要求,因为编译书稿用的软件会把 @ 符号做特殊处理,所以要用斜杠来阻止这种特殊处理。
4. 冗余格式。
上面这截图,红色是原文,为啥加了个超级链接?我给删了
5. 标题里不必手动编号。
上面这个截图,因为原文用了三个#号,所以转换成书时就成了三级标题,并且添加了自动编号。但是读这段文字的话,会发现没必要手动编号,而且作为标题来讲文字有些长。其实,用个加粗和列表格式就够了,不必列为标题。
上面说的脚注、插图、交叉引用等,都不属于markdown的基础语法,所以平时用不到,但是要编成书就得用到了。大家不熟悉没关系,以后接触多了就习惯了。
辛苦各位志愿者了!
相关链接:
辛苦大鹏了,某个程度上来说,我做出了错误的示范,也算做了个好事?
辛苦大鹏了,错误难免,我觉得这种错误不是你犯就是我犯,早点发现更好。
是避免不了的。早发现早治疗。
当然是好事!大大的好事!
@dapeng 大鹏哥幸苦了~
为人民服务
我还没搞懂,继续学习。
写几次就懂了。
标题脚注是指某某校对?每一处校对都必须加上脚注?还想问脚注该怎么加啊。。。
另,标题脚注那张图片是不是还存在问题?虽然还是看不懂花括号的作用。。。
好多小白问题,问别人都说大鹏哥的帖子里都有。翻了几次也没找到,就想厚着脸皮试试问问大鹏哥本尊,还望大鹏哥见谅。
一直想开始学习但又不知从何下手,之前也有看过一些使用 GitHub 的新手教程,但具体到开始校对时又少了一些针对性。希望能在大鹏哥这里找到一个技术性的突破口。有点儿白嫖了,但还是先谢过,虽然这句话最没用。
不要紧,大家都是摸着石头过河,有问题多交流就是了。关于如何使用脚注,最简单的办法就是直接看实例:先看看书稿网页版里展示的模样,再对照着看大家提交的书稿原文。花括号的用法如果让人费解,那就暂时不用它。至于如何使用github来提交你的文稿,读本文里所说的实施纲要就行,里面有教程的链接。