一些写作技术细节

海云青飞 https://www.tuenhai.com 2018-11-22

有些人很忙,没有时间看长篇大论,会翻一下序言和后记了解个大概

也有奇怪的人最喜欢看附录,找一下有没有书的主题以外的内容,就像寻找游戏的彩蛋一样,最好是能带来一点新奇和兴奋, 海云青飞 觉得这样想的人挺有意思,作为作者应该考虑到他们的需求,于是就有了本篇,主要本书编写的一些技术细节

海云青飞 对真实有洁癖,对大道有追求,不曾料到真的能找到那一片纯真的天空。整体观说,人类是命运共同体,我信仰整体观,那么就有必要、有义务分享那片纯真。怎么分享,如果直白说出来,我不是名人,恐怕没有多少影响

于是我找到了很多人感兴趣的《黄帝内经》,从整体观的角度点评一下《黄帝内经》

整体观是体,《黄帝内经》是用,我已经掌握了体,已经不必乞灵于古人了,全文逐句解释《黄帝内经》并无必要,就在别人文章的基础上作些点评吧

全书精华列在书首

把全书的精华摘录出来放在全书正文的最前面,方便作者改进,也方便读者把握重点

这样做特别是造福了一些“懒人”,精读一页就可以快速了解作者主要观点

有关代码

如果手动处理文章,那太不优雅了,用的是类似下面的程序代码,一分钟搞定

xys = function(){
    var outDir = //C:\tuenhai.com\
    wb.go("http://www.xys.org/dajia/zhongyi.html")
    wb.wait(,8654)

    eles = wb.queryEles({tagName = "a"; innerText = "<@王力微@>|<@内经@>"},6543)
    for i, ele in eles {
        var text = my.net.down(ele.href)

        // to UTF8 encoding
        text = string.fromto(text,936,65001)

        // join lines  : means Chinese character
        text = string.replace(text, "(:)[\r\n](:)", "\1\2")

        text = string.trim(text)

        string.save(outDir ++ ele.innerText ++ ".md", text)
    }
}

本书引用文章来自 XYS,在此感谢原作者

源文件用 Markdown 格式保存

Markdown 格式的发明极大方便了写作者,现在 海云青飞 写文章都是用此格式

Markdown 一级、二级标题的写法分 格式标记侵入文本所知行式格式标记非侵入文本所在行式

# 一级标题,格式标记侵入了文本所在行
## 二级标题,格式标记侵入了文本所在行

一级标题,格式标记没有侵入文本所在行
========

二级标题,格式标记没有侵入文本所在行
------------

海云青飞 https://www.tuenhai.com 觉得,格式标记侵入文本所知行式 不够优雅

我用的都是 格式标记非侵入文本所在行式,好在一、二级标题一般也够用了

另外,列表尽量用无序列表,这样调整条目顺序时很省心

文件名、目录名的格式

目录名、文件名会成为网页网址的一部分,有一些讲究

  • 目录名宜短

    一个网页的网址太长不利于复制,于是网址非关键部分宜短。目录名相对文件名来说非关键,可以无目录名,或者用一个字母表示

    如果文件数目不多,不用目录名

    文件数目较多,分目录保存文件方便管理

  • 文件名用小写拼音字母,并用-分隔

    中文是不能用作网址的,所以文件名要用英文字母,中文读者要用拼音字母

    Windows 文件名是大小写不敏感的,Linux 是大小写敏感的,文件名全用小写就同时兼容两个平台了

  • 文件名的排序

    文件名的前面要加上排序标记,这样方便在电脑里定位, 一般是在文件名前面加上数字,比如这样:

    01-huang-di-nei-jing.md
    

    同目录下有10个以上文件时,就要用到2位数字了

    排序标记是非重要部分,越短越好, 海云青飞 常用一位字母来排序,最多是26种组合,一个目录一般是在26个文件以内,挺好,类似这样:

    a-huang-di-nei-jing.md
    b-ling-su-shang-dui.md
    

文件编辑器用 Visual Studio Code

这是目前为止 海云青飞 最喜欢的 Markdown 文件编辑器

  • Mardown 文件可以即时同步预览效果
  • 正则表达式替换非常方便

    • 在文件目录右键,可以 Find in folder... 在目录里替换

    • 替换效果可以预览

      这个功能十分贴心。正则表达式有时可能写错,有了预览可以预防替换错误

比如,我现在写的文章都是没有段末句号的,包括引用的文章。如果一个个手工删除,那是不可想象的,现在方便了,全书所有文章的段末句号几秒就全去掉了

另外,段首空两格,在网络文章里更加用不到,用替换的方法全部移除

全书整理差不多时,还要用一些全局替换

重要文件保存在云盘里

人寿有时,这不能令人类满意,于是就有了许多的求道者,有了许多的教徒

电脑的硬件也有寿命,如果文件只是保存在本机电脑,硬盘坏了,可能多年的心血就毁了

人要长生可能不容易,文件要长生却是简单,把所有重要文件保存在云盘里就行了,硬盘坏了,文件仍在。所以有的人想,将来人的生命能不能备份在云盘里呢
◌● 转载请注明出处: https://yi.tuenhai.com/z/ji-shu-xi-jie.html ●◌

results matching ""

    No results matching ""