Microsoft PowerPoint - DITA技术分析报告 ppt [兼容模式]

Size: px

Start display at page:

Download "Microsoft PowerPoint - DITA技术分析报告 ppt [兼容模式]"

织祚成
6 years ago
Views:

1 中国标准化研究院 DITA Darwin Information o Typing Architecture 高昂中国标准化研究院高新技术与信息标准化研究所

2 报告的主要内容 DITA 背景概述 DITA 设计原则 DITA 的主要元素主题映射与样式 DITA 与 DocBook 对比分析 DITA 工具和使用 DITA 编译过程演示 2

3 DITA 含义 DITA( 达尔文信息分类体系结构,Darwin Information Typing Architecture) 是一种面向主题的文档类型定义 (Document Type Definitions,DTD) 系统, 用于定义编写和交付内容信息的规则 DITA 通过 XML 架构来描述管理和发布内容信息, 并用于内容信息的编写生成和交付 DITA 目前由结构化信息标准组织 OASIS 维护,DITA 通过将文档组织为可重用的模块 (Topics 主题 ) 并将模块进行组织来表示信息内容, DITA 提供了主题的元数据注释, 用户可以便捷的搜索过滤和处理内容 Darwin: DITA utilizes principles of inheritance for specialization Information Typing: DITA was originally designed for technical information based on an information architecture of Concept, Task and Reference Architecture: DITA is a model for extension both of design and of processes 3

4 DITA 是什么不是什么 DITA is an architecture for creating topic-oriented, information-typed typed content that can be reused and single- sourced in a variety of ways It is also an architecture for creating new topic types and describing new information domains based on existing types and domains DITA is not just another tool but an international standard to support structured authoring and reuse in any technical domain 4

5 DITA 核心设计原则 Topic orientation Discrete units of information covering a specific subject with a specific intent Topic granularity Self-contained topics combine with other topics into information sets Strong typing DTDs and schemas guarantee that DITA types follow identical information structures Specialization Architecture for extending basic types to new types adapted for a particular use within an information set Common base class Top-level "generic" base type provides fallback for all types 5

6 DITA 的 Topic 主题 DITA 是基于主题的, 因为主题是允许以不同单元交付可重用上下文而不影响作者效率的最理想尺寸如果选择小一些的单元, 作者需要核对所有上下文的单元, 以确保信息流正确如果选择大一些的单元, 信息不容易重新合并到不同交付上下文所需的结构从 Topic 的粒度划分来看,Topic 要大到能自我容纳, 同时要小到特殊上下文需要的以任何高级结构的有效重用 <topic> 是单一非嵌套主体和任何数量的嵌套主题的容器 <title> 提供自我描述, 与创作内容的标题一致 <body> 是段落级内容和任何数量的非嵌套部分的容器主题可以增加一个前言, 其中包括简短描述和其他可选的元数据 6

7 DITA 的 Topic 主题 (Cont.) Topic 是按单一题目范围组织的一段信息从结构上看, 它是一个后面跟随着文本和图象的主题, 可选的按节组织方式主题有许多不同类型, 最通用的是概念任务和引用 Topic A unit of information which is meaningful when it stands alone. Concept Task Reference Provides background information that users need to know. Provides procedural details such as step-by-step instructions. Provides quick access to facts. 7

8 DITA 主题 (TOPIC) 示例 <task id="installstorage"> <title>installing a hard drive</title> <shortdesc>you open the box and insert the drive.</shortdesc> <prolog><metadata> <audience type="administrator"/> <keywords> <indexterm>hard drive</indexterm> <indexterm>disk drive</indexterm> </keywords> </metadata></prolog> <taskbody> <steps> <step><cmd>unscrew the cover.</cmd> <stepresult>the drive bay is exposed.</stepresult> </step> <step><cmd>insert the drive into the drive bay.</cmd> <info>if f you feel resistance, try another angle.</info> </step> </steps> </taskbody> <related-links> <link href="formatstorage.dita"/> <link href="installmemory.dita"/> </related-links> </task> Identifier, title, and shortdesc Properties of the topic Type-specific content body Relationships to other topics 8

9 从主题 (Topic) 到任务 (Task) 的细化 topic task title il prolog metadata body related -links title prolog metadata taskbody related -links prereq context steps result example taskxmp postreq step cmd, (info substeps tutorialinfo stepxmp xmp choices choicetable)*, choices)*, result? stepresult? 9

10 从任务 (Task) 到业务 (Business Task) 细化 task businesstask title title prolog prolog metadata metadata taskbody btaskbody related -links related-links prereq result prereq result context example taskxmp context example steps postreq bsteps postreq step step cmd, (info substeps tutorialinfo stepxmp xmp choices choicetable)*, choices)*, result? stepresult? appstep appdesc 10

11 主题的结构细化以 Topic 为核心进行内容组织 Topic Concept Task Reference minitask it bctask manpages UI help APIs Messages Java APIs C++ APIs 11

12 映射 (Map) 示例 <map title="tasks"> <topichead navtitle="installing" t lli " audience="admin"> <topicmeta> <shortdesc>install products before configuring or using them.</shortdesc> <topicmeta> <topicref href="installstorage.dita"> <topicref href="unscrewcover.dita"/> <topicref href="insertdrive.dita"/> <topicref href="replacecover.dita"/> ep e </topicref> <topicref href="installwebserver.dita"> <topicref href="closeprograms.dita"/> <topicref href="runsetup.dita"/> <topicref href="restart.dita"/> </topicref> <topicref href="installdb.dita"> <topicref href="closeprograms.dita"/> <topicref href="runsetup.dita"/> <topicref href="restart.dita"/> </topicref> </topichead> </map> A heading doesn t have to have a topic Title and properties can be assigned in the map The map organizes a set of topics in a hierarchy A topic can appear multiple times in the hierarchy h 12

13 DITA 映射方式 A DITA map applies context to the topics Organizes a set of topics in a hierarchy and sequence Can reuse the same topic with different collections of topics Sets properties of the topic at a position within the hierarchyh 13

14 DITA 处理过程.DTD.schema Document Type Definition gives structure and validation to your XML source file.ditaval.dita.ditaval file specifies what information to include or exclude from your final output using attribute values.ditamap DITA map - DITA source file - specifies the order of where you author the DITA source files your content pieces for your final output Output File (html) (.html).xslt.css Stylesheets - are applied to the XML file to produce a formatted output HTML file - is one of the outputs produced from the XML source file (You can also produce PDF, HTML Help, and more) 14

15 DITA 与 DocBook 标准特性对比 DocBook DocBook is a document type definition (DTD) for writing technical books and articles, with the structure that such forms imply. py DocBook is hierarchical by nature, and must be developed to allow for singlesourced content DocBook has a fixed element and attribute set. Definitions Concepts DITA DITA is both a DTD and a set of rules for writing online contextual documentation such as software help files. DITA separates content from context, allowing multiple architectures of information DITA is extensible, allowing the definition of information types Book (section) oriented Context Topic oriented Large set of elements and attributes Key Features Topic based, separation of content targeted for technical documentation and context, specialization Simple. Can usually be downloaded and set up in a day. Regular XML file called an include file with all files included in the document PDF HTML HTMLHelp Download and Installation Document File Output More complex. Usually requires more time and some technical expertise. ditamap file with all files and each file s related links Unrestricted, but all need development Well supported by the XML community Community Small but strong, growing community With a little development, DocBook can do what DITA is attempting on a smaller scale Complexity DITA is impressively engineered, but can be too industrial-strength strength 15

16 DITA 与 DocBook 对比 DITA 和 DocBook 通过定义规范化的文档描述规则, 来解决文档交付过程中遇到的问题面向不同类型的交付出版物,DITA 和 DocBook 各有见长, 但在实际应用中也有自身的限制因素 DITA 解决了出版物的结构化描述和内容重组问题, 且支持多语言版本制作, 适用于对格式有严格限定的技术手册类出版物但 DITA 不能实现很完美的样式渲染, 且对于内容与格式一体化的复杂出版物, DITA 很难进行主题和界定与划分所以使用 DITA 进行书籍出版的成本和难度较高相比较来说,DocBook 适用于通用出版物, 文档易于组织和排版但 DocBook 内容以 Section 段落组织, 不具备 DITA 的内容映射机制, 无法做到类似 Topic 这样粒度的内容划分与重组且对于内容需要频繁修改的文档排版,Docbook 略显力不从心 16

17 DITA 与 DocBook 对比 (Cont.) DITA 和 DocBook 专注于交付技术信息, 但 DITA 侧重于交付主题, 而 DocBook 侧重于交付书籍 DITA 提供基于主题级粒度的信息分类, 允许作者组织并描述特定信息领域在生成多种文档格式的信息重用过程中, 能够保持内容的高度一致性在最终交付物的输出格式方面,DITA 能够生成 PDF CHM HTML 等大部分的出版交付类型 DocBook 常用的交付格式为 PDF 和 HTML, 其他输出格式需要借助相关的功能插件在学习应用方面,DITA 包含众多语法和标签定义, 在应用过程中的学习曲线较陡, 在文档生成过程中一般需要使用 Ant 命令进行编译而 DocBook 相对容易理解和使用, 一般使用者从了解到上手使用 DocBook 制作文档仅用一天时间即可希望了解更多 DITA 与 DocBook 的对比分析的朋友, 可以进一步阅读 DCL 数据转换实验室包含更为详尽内容的文章 17

18 Docbook 与 DITA 结构对比 18

19 标准 DITA 项目结构中的树形结构 19

20 DITA 开放工具箱 DITA 开放工具箱是 OASIS 的 DITA 标准的 DTD 和 Schema 的 Java 实现, 能够将 DITA 文档的 Maps 和 Topics 转换为最终的交付文档 ( HTML PDF RTF) DITA 开放工具箱包含 Ant 构建模板 DITA 词汇表 DTD 定义,DITA 词汇表的 XML Schema 定义以及 Java 文档处理类库等内容对于 DITA 文档, 源文件和映射文件中的标记项由 DTD 和 Schema 定义, 借助 XSLT 和 CSS 文档, 经处理渲染后得到最终交互文档在商业产品方面, 提供软件产品生命周期管理的 PTC 公司开发的 XML 文档处理器 Arbortext, 支持 DITA 的编辑与转换工作 Syntext 公司开发的开源的 XML 编辑器 Serna Free 支持 DITA Docbook XHTML 等 XML 文件类型, 能够实现可视化的编辑工作 20

21 DITA 开放工具箱 DITA-OT ant css demo doc dtd lib out resource samples schema temp xsl Contents or purpose Templates for defining what to build Styles for displaying XML source files in editors or browsers Experiments or demonstrations of DITA capabilities Documentation ti for DITA or the Open Toolkit Document type definitions for the DITA vocabulary Java implementation of advanced processing Formatted output (created during processing) Styles and other resources for XHTML and other output Example DITA content for exercising the processing XML Schema definitions for the DITA vocabulary Intermediate files (created during processing) XSLT files for XHTML and PDF processing 21

22 DITA-OT 的条件编译在 DITA-OT 进行 DITA 文档编译时, 可以让 DITA- OT 在编译时进行有条件的编译处理, 针对不同类型的需求生成内容可定制的文档 <p audience= config > 设置配置信息如下 <ul> <li audience= admin programmer > 程序管理员专用信息, 这里的内容编译生成为项目经理提供的文档 </li> <li audience= programmer > 这里的内容编译生成为程序设计人员提供的文档 </li> <li audience= programmer platform= unix > 这里的内容为在 UNIX 系统环境下工作的程序员生成 </li> <li platform="unix"> 这里的内容只显示给 UNIX 平台 </li> </ul> </p> 22

23 DITA 的生产交付 23

24 DITA 编辑器 Serna Free 是开源的所见即所得的 XML 编辑器, 支持 DITA Docbook XHTML 等 XML 文件类型 24

25 DITA 编辑器 25

26 Vex Visual Editor Vex is a Visual Editor for XML that hides the raw XML tags from the user. Vex uses standard DTD files to define document types and CSS stylesheets to define document layout. Vex contains definitions for DocBook and DITA. 26

27 讨论交流 DITA Darwin Information Typing Architecture 27

<4D6963726F736F667420506F776572506F696E74202D20C8EDBCFEBCDCB9B9CAA6D1D0D0DEBDB2D7F92E707074>

<4D6963726F736F667420506F776572506F696E74202D20C8EDBCFEBCDCB9B9CAA6D1D0D0DEBDB2D7F92E707074> 软件架构师研修讲座胡协刚软件架构师 UML/RUP 专家 szjinco@public.szptt.net.cn 中国软件架构师网东软培训中心小故事 : 七人分粥当前软件团队的开发现状和面临的问题软件项目的特点解决之道 : 从瀑布模型到迭代模型解决项