P012.写作规则
关于文件命名和文本内容的约定及解释,俗称”写作规则”。
@史荣久 / 2014-10-15 / CC-BY-SA-3.0
文件命名
通常,文件名由半角句点(.
)分隔的区域
构成。
区域
为小写半角英数([0-9a-z]
)及半角减号(-
)构成。
各区域
应尽量有明确含义。常用的区域
包括:
序号
表文件的编号,格式为[0-9a-z][0-9]{2}
。
小于1000时(001
-999
),大等于1000时(a00
-z99
)
如:001.this-is-moilion.md
zz
表示为相同序号文件的辅助文件,如反馈。
相同序号的文件排序 zz 会排到尾部。
现在使用的命名约定有:
文本文件:序号
+.
+文件名
+.
+扩展名
如:001.this-is-moilion.md
图片文件:可包含像素,色彩等特征信息。
如:500x200-001.jpg
反馈文件:序号
+.zz.
+其他名字
+.md
如:001.2015.md
和001.zz.foot-print.md
书写约定
文本资料以markdown
语法为基础,扩展名为.md
。
参考:http://help.github.com/articles/markdown-basics/
此外,鼓励手动换行,即,行尾加2个英文空格(
)
标题使用#
表示,并在#
后,标题前加一个空格( )
重点词汇,需要引号括起来,已表示区分,引号分三种:
双引号(“
),单引号(‘
),反单引(波浪号~
的那个键)。
单引和双引没有区别,根据个人习惯使用。建议使用双引。
反单引,有特殊意义,用来表示代码,专有词,醒目词等。
中文句子用中文标点,英文句子用英文标点。不建议混用。
中文可用,「 」
『 』
〈 〉
《 》
不建议使用Tab(\t
),应该使用4个空格(
)代替。
题图:《规矩图》,它们在古代是两种工具,分别校对圆形和方形。