分享

写书时的统一格式规范

 instl 2023-05-01 发布于广西

刚才在写,也就作一下记录。也是借鉴了一些其它人的IT书籍之后,自己弄的几个规范。

一,文件目录

书籍的根目录有计划好的目录文件,还有content,images,org-img三个目录

书稿总目录

content目录下,存放文字稿的word文件


content目录

org-img目录下,存放自己划的矢量原图(draw.io)


org-img目录

images目录下,按章节建立子目录(ch开头为正式章节,a开头为附录章节)
images目录

images每一个具体子目录下面,存放在此章节的图片,要按序列号递增,且已命名。(content文档里插入的所有图片,需要先放在images的对应子目录下,再作插入图片动作,这样才方便印刷取图,且清晰度可以保证)
images目录下章节目录

二,标题,章节题记,正文,列表

标题最多分三级。大章使用标题1格式(比如第四章)。其下分别是标题2(比如4.1)和标题3(比如4.1.1)格式。
章节如有题记,首行空两字,斜体五号宋体,三个短横杠后跟作者。
正文段落,首行空两字,五号宋体,如果有括号,使用半角。
正文中如果有列表符号,也是首行空两字,再加列表符号。


大章节,题记和正文

二,三级章节
正文列表

三,表格

书中表格,需要以[表.章节.序号.名称递增]。
其上下如果有文字,需要空格,但有标题,可以不空行(为了不太紧密,阅读舒适)。
表中文字,左对齐,上下居中对齐。
表格左边空两字,对齐段落开始。


表格

四,图片

书中图片,在插入前,一定要先存在于images下的对应章节目录,并作好递增和命名。
为了不超出页面宽度,图片最大宽度不能超过12cm。
图片不改比例,以能看清晰程序自定义大小(大图都固定12cm即可)。
空行原则和表格一样。


图片

五,命令行或控制台输出

命令行或控制台输出时,空行也是表格图片原则,上下有空行。
命令行或控制台输出时,内容一般较少,可作首行两字缩进,灰底不缩进。
如果需要在命令行加注释,则先3个空隔,三个短横,再写说明注释。
英文字为Calibri五号字。


命令行或脚本,控制台输出

设置页面边框底层灰色值的办法


设计页面边框底纹的方法

六,脚本或代码

脚本和代码一般较长,首行两字缩进很麻烦,可全选一起作缩进,此时灰底也会缩进。


脚本代码

如果脚本或代码中,有的分行比较难看,则可适当缩小一些行的字号。


代码特例

    本站是提供个人知识管理的网络存储空间,所有内容均由用户发布,不代表本站观点。请注意甄别内容中的联系方式、诱导购买等信息,谨防诈骗。如发现有害或侵权内容,请点击一键举报。
    转藏 分享 献花(0

    0条评论

    发表

    请遵守用户 评论公约

    类似文章 更多