- 1 -
概述
使用结构化写作/DITA写作,内容和样式是分离的。 编写的内容放在DITA文件中,样式是放在样式模板文件中。 而且针对不同的格式的输出(如:PDF,MS Word),样式模板文件不同。
文档工程师写作时专注于写内容,不用关心/调整文档格式。
样式模板由样式开发工程师或者供应商来提供定制开发。 只需要做一次,可以应用于多个文档的输出。
通过这种方式,为文档工程师省去调整文档样式的工作,同时确保团队输出风格一致的文档。这大大节省了文档工程师的时间和精力,并提高手册发版速度。
这篇文章展示摩拿科技在项目中一些常见的样式定制的地方。
- 2 -
样式定制示例
1. 首页
通过定制首页,可以按照公司品牌形象统一手册风格,并且可以定义符合规范和公司要求的中文字体。
以下是定制首页的样例,它包含:
-
封页最上边和最下边显示横线
-
加公司logo
-
手册名称居中并粗体显示
-
手册其他信息以小2号的文字大小居中显示
-
使用鸿蒙字体
2. 页眉页脚
页眉页脚在每一页上重复呈现,根据当前页内容动态显示。
以下是页眉的样例,它包含:
-
左侧显示公司Logo
-
右侧动态显示手册名称和章节标题
-
页眉和正文自定义分割线:线宽、颜色自定义
以下是页脚的样例,它包含:
-
左侧显示公司网址
-
中间显示版权信息
-
右侧显示页码
3. 有序/无序列表
以下是列表的样例,它包含:
-
左侧对齐、左侧缩进
-
多级列表嵌套自动编号、自定义缩进距离
-
注中的列表,对齐方式和字号
4. 图
以下是图的样例,它包含:
-
图标题位于图片下方居中显示(也可以放置在图上方)
-
图自动编号,比如:图 1-1,表示第一章的第一张图
-
根据文档语言显示文字,例如:中文显示“图1-1”,英文显示“Fig 1-1”
-
确保图标题和图显示在同一页
-
引用图的地方自动显示图编号和标题,这样避免在引用的地方手动维护图编号和图标题。(引用的示例在1.2系统框架的第一段话中)
-
自动生成图目录
5. 表格
以下是表格的样例,它包含:
-
表格标题行字体加粗并且居中显示
-
将公司品牌的主颜色设置为表格标题行的背景颜色
-
PDF全文表格固定宽度:例如100%显示
-
表格标题位于表格上方,表格自动编号,比如:表 1-1,代表第一章的第一个表格
-
根据文档语言显示标题文字,例如:中文显示“表1-1”,英文显示“Table 1-1”
-
表格标题和表格显示在一页
-
跨页的表格标题和标题行重复显示
-
自动生成表格目录
-
窄而长的表格两栏显示
-
宽的表格使用横向纸面输出
-
将表格缩小比例显示(60%),可显示更多内容
6. 警告注意注
以下是警告注意注的样例,它包含:
-
提示文字前显示图标,根据不同类型显示不同的图标
-
提示文字根据手册语言变化,中文手册则显示:警告,英文手册则显示:Caution
-
字体比正文小一号
7. 代码块
以下是代码块的样例,它包含:
-
以灰色背景显示代码
-
代码字体和正文不同,它的字体是“Courier New”
-
根据代码语法高亮显示
- 3 -
总结
结构化写作的好处之一是为文档工程师省去为文档调整格式的工作,并确保团队输出风格一致的文档。
摩拿提供样式定制服务,为文档团队扫除结构化转型过程中碰到的样式定制这个拦路虎。