Logo Logo

DITA 1.3 中文版

/

1 DITA 1.3 简介

1 DITA 1.3简介

达尔文信息类型化体系结构(DITA)规范定义了一组用于创作和组织面向主题信息的文档类型,以及一组用于组合、扩展和约束文档类型的机制。

1.1 关于DITA规范:全包版

DITA规范的全包版是最大的版本。它是为实现所有OASIS批准的标准的实现者而设计,同时也为开发学习和培训材料的用户而设计。

全包版

下图说明了“全包”的内容版本;它也展示了"全包版"与其他版本的关系版本。

基本版

基础版包含主题(Topic)、地图(Map)和主题方案地图。 它是最小的版本; 它专为只需要 DITA 框架最基本部分的应用程序开发人员和用户而设计。

技术内容版

技术内容版包括基本架构和技术交流者通常使用的专有化:概念(Concept),任务(Task),以及参考主题(Reference);机械行业任务;故障隔离主题;图书地图(Book Map);词汇表;以及分类图。它是中型版;它是为那些使用信息输入和记录复杂的应用程序和设备而设计,如软件,硬件、医疗器械、机械等。

全包版(本版)

全包版包含基本架构,技术内容片段,和学习和培训专优化。它是最大版本;它专为只需要 DITA 框架最基本部分的应用程序开发人员和用户而设计。

XML语法文件

DITA词汇表模块和DITA文档类型的DITA标记有几种XML语言:RELAX NG(RNG)、XML文档类型定义(DTD)和W3C XML Schema(XSD)。

虽然文件应该定义相同的DITA元素,但是如果他们之间有差异,以RELAXNG语法为准。

DITA书面规范

该规范是为DITA标准的实现者编写的,包括工具开发专门化的开发人员和XML架构师。文件包含几个部分:

  • 简介
  • 架构性规范
  • 语言参考
  • 一致性声明
  • 附录

DITA书面规范有以下格式:;XHTML版本是权威:

  • XHTML(可从OASIS网站获得)
  • CHM
  • PDF
  • DITA源
  • XHTML的ZIP(针对本地使用而优化)

1.2术语

关键词“必须”、“不得”、“必须”、“必须”、“应当”、“不得”、“应当”、“应当”不,本文件中的“推荐”、“可能”和“可选”应按【RFC 2119】里面的描述来解释.

必须

这个词,或术语“必需”或“应”,意味着定义是规范的绝对要求。

不能

这一短语或“不得”一词意味着该定义是绝对的规范禁止。

应该

这个词,或者形容词“推荐”,意思是可能存在有效的在特殊情况下忽略某一特定项目的理由在选择不同的路线。

不应该

这个短语,或短语“不推荐”,意味着可能存在有效的在特定情况下,当特定行为可接受时的原因甚至是有用的,但应该理解其全部含义和情况在实施任何与此描述的行为之前仔细权衡标签。

可能

这个词,或者形容词“可选”,意味着一个项目是真正可选的。一个供应商可能会选择包括该项目,因为一个特定的市场或者供应商认为产品需要改进另一个供应商可以省略相同的项目。一种不包括必须准备一个特定的选项来与另一个实现进行互操作其中确实包括了这个选项,尽管功能可能会减少。在同样的,包含特定选项的实现必须准备与不包括选项(当然,选项提供的功能除外)。

1.3规范性引用文件

[RFC 2119]

Bradner,S.,“RFC中用于表示需求水平”,BCP 14,RFC 2119,DOI 10.17487/RFC21191997年3月,http://www.rfc-editor.org/info/rfc2119.

[RFC 3986]

Berners Lee,T.,Fielding,R.和L.Masinter,“制服资源标识符(URI):通用语法”,STD 66,RFC 3986,DOI10.17487/RFC3986,2005年1月http://www.rfc-editor.org/info/rfc3986.

[RFC 5646]

Phillips,A.,Ed.和M.Davis,Ed.,“标签识别语言”,BCP 47,RFC 5646,DOI 10.17487/RFC5646,2009年9月,http://www.rfc-editor.org/info/rfc5646.

[XML 1.0]

可扩展标记语言(XML)1.0(第五版) ,T.Bray,J.Paoli,M.,E.Maler,F.Yergeau,编辑,W3C推荐,2008年11月26日,http://www.w3.org/TR/2008/REC-xml-20081126/ .最新版本可在http://www.w3.org/TR/xml .

[XML 1.1]

可扩展标记语言(XML)1.1(第二版) ,T.Bray,J.Paoli,M.,E.Maler,F。Yergeau,J.Cowan,编辑,W3C推荐,2006年8月16日,http://www.w3.org/TR/2006/REC-xml11-20060816/ .最新版本可在http://www.w3.org/TR/xml11/ .

1.4非规范性引用文件

非规范性引用是对DITA实施者可能会发现有用的外部文档或资源的引用。

[ciq-v3.0]

OASIS委员会规范02,客户信息质量规范3.0版。姓名(xNL)、地址(xAL)、姓名和地址(xNAL)和当事人(xPIL),http://www.oasis-open.org/committees/download.php/29877/OASIS CIQ V3.0 CS02.zip,2008年9月20日。

[ISO 8601]

ISO/TC 154,数据元素和交换格式,日期和时间的信息交换表示,第3版,http://www.iso.org/iso/catalogue_detail?csnumber=40874,2004年12月12日。

[ISO/IEC 19757-3]

ISO/IEC JTC 1/SC 34文档描述和处理语言,信息技术文档模式定义语言(DSDL)-第3部分:基于规则的验证Schematron,http://www.iso.org/iso/catalogue_detail.htm?csnumber=40833,2006年6月1日。

[MathML 3.0]

数学标记语言(MathML)3.0版第2版,D.Carlisle,P.D.F.Ion,R.Miner,编辑,W3C推荐,2014年4月10日,http://www.w3.org/TR/2014/REC-MathML3-20140410/ . 最新版本位于http://www.w3.org/TR/MathML3/.

[XML 1.0中的命名空间]

XML 1.0中的命名空间(第三版),T.Bray,D.Hollander,A.Layman,R.Tobin,H.S.Thompson,编辑,W3C推荐,2009年12月8日,http://www.w3.org/TR/2009/REC-xml-names-20091208/ . 最新版本位于http://www.w3.org/TR/xml-names.

[XML 1.1中的命名空间]

XML 1.1中的命名空间(第二版),T.Bray,D.Hollander,A.Layman,R.Tobin,编辑,W3C推荐,2006年8月16日,http://www.w3.org/TR/2006/REC-xml-names11-20060816/ . 最新版本位于http://www.w3.org/TR/xml-names11/ .

[OASIS表格模型]

XML交换表模型文档类型定义。Norman Walsh编辑,1999年。技术备忘录TR 9901:1999。https://www.oasis-open.org/specs/tm9901.htm.

[Relex NG]

J. Clark和M.Murata,RELAX NG规范编辑,http://www.oasis-open.org/committees/relax-ng/规范20011203.html,OASIS委员会规范,2001年12月3日。

[REAX NG紧凑语法]

J. Clark,RELAX NG紧凑语法编辑,http://www.oasis-open.org/committees/relax-ng/compact-20021121.html,OASIS委员会规范,2002年11月21日。

[REAX NG与DTD兼容性]

J. Clark和M.Murata,编辑,RELAX NG DTD兼容性,http://www.oasis-open.org/committees/relax-ng/兼容性-2001 1203.html,OASIS委员会规范,2001年12月3日。

[SVG 1.1]

可缩放矢量图形(SVG)1.1(第二版),E.Dahlström,P.Dengler,A.Grasso,C.Lilley,C.McCormack,D.Schepers,J.Watt,J.Ferraiolo,J.Fujisawa,D.Jackson,编辑,W3C推荐,2011年8月16日,http://www.w3.org/TR/2011/REC-SVG11-20110816/ . 最新版本位于http://www.w3.org/TR/SVG11/ .

[XHTML 1.0]

XHTML语言™ 1.0可扩展超文本标记语言(第二版),S.Pemberton,W3C推荐编辑,2002年8月1日,http://www.w3.org/TR/2002/REC-xhtml1-20020801 . 最新版本位于http://www.w3.org/TR/xhtml1 .

[XHTML 1.1]

XHTML语言™ 1.1-基于模块的XHTML-第二版,S.McCarron,M.Ishikawa,编辑,W3C推荐,2010年11月23日,http://www.w3.org/TR/2010/REC-xhtml11-20101123 . 最新版本位于http://www.w3.org/TR/xhtml11/ .

[XPointer 1.0]

XML指针语言(XPointer),S.J.DeRose,R.Daniel,P.Grosso,E.Maler,J.Marsh,N.Walsh,编辑,W3C工作草案(正在进行中),2002年8月16日,http://www.w3.org/TR/2002/WD-xptr-20020816/ . 最新版本位于http://www.w3.org/TR/xptr/ .

[XML Catalogs 1.1]

OASIS标准,XML目录1.1版,2005年10月7日,https://www.oasis-open.org/committees/download.php/14809/xml-catalogs.html.

[xml:tm 1.0]

A. Zydroán,R.Raya和B.Bogacki,编辑,XML文本存储器(XML:tm)1.0规范,http://www.galaglobal.org/oscarStandards/xml-tm/,本地化行业标准协会(LISA)xml:tm 1.0,2007年2月26日。

[XSD 1.0结构]

XML模式第1部分:结构第二版,H.S.Thompson,D.Beech,M.Maloney,N.Mendelsohn,编辑,W3C推荐,2004年10月28日,http://www.w3.org/TR/2004/REC-xmlschema-1-20041028/ . 最新版本位于http://www.w3.org/TR/xmlschema-1/ .

[XSD 1.0数据类型]

XML模式第2部分:数据类型第二版,P.V.Biron,A.Malhotra,编辑,W3C推荐,2004年10月28日,http://www.w3.org/TR/2004/REC-xmlschema-2-20041028/ . 最新版本位于http://www.w3.org/TR/xmlschema-2/ .

[XSL 1.0]

可扩展样式表语言(XSL)1.0版,S.Adler,A.Berglund,J.,S.Deach,T.Graham,P.Grosso,E.Gutentag,A.Milowski,S.Parnell,J.Richman,S.Zilles,编辑,W3C推荐,2001年10月15日,http://www.w3.org/TR/2001/REC-xsl-20011015/ . 最新版本位于http://www.w3.org/TR/xsl/ .

[XSL 1.1]

可扩展样式表语言(XSL)1.1版,A.Berglund,W3C推荐编辑,2006年12月5日,http://www.w3.org/TR/2006/REC-xsl11-20061205/ . 最新版本位于http://www.w3.org/TR/xsl11/ .

[XSLT 2.0]

XSL转换(XSLT)2.0版,M.Kay,编辑,W3C推荐,2007年1月23日,http://www.w3.org/TR/2007/REC-xslt20-20070123/ . 最新版本位于http://www.w3.org/TR/xslt20 .

[XTM 1.0]

S. Pepper和G.Moore,编辑,XML主题地图(XTM)1.0,http://www.topicmaps.org/xtm/index.html,TopicMaps.Org XTM 1.02001。

1.5 XHTML版本规范中的格式约定

考虑到规范的大小和复杂性,它不是作为单个XHTML文件生成的。相反,每个DITA主题都呈现为一个单独的XHTML文件。XHTML版本的规范使用某些格式约定来帮助读者浏览规范并轻松查找材料:链接预览和导航链接。

链接预览

DITA规范使用DITA元素的内容为其读者提供链接预览。这些链接预览通过边框和彩色背景以视觉方式突出显示。链接预览不规范;它们包含子主题的 元素的内容,该元素作为主题的第一段在规范上下文中呈现;两种格式的内容相同。链接预览作为增强的导航工具,使读者能够更容易地定位内容。这种可用性增强是规范说明DITA功能并举例说明DITA最佳实践的方式之一。

以下屏幕截图说明了在XHTML版本的规范中如何显示链接预览:

图-1: 链接预览

导航链接

为了方便读者从一个主题导航到另一个主题,DITA主题生成的每个XHTML文件底部都包含以下导航链接:

  • 父主题

将读者带到父主题,该主题由包含层次结构中最近的主题引用

  • 上一个主题

带读者进入阅读顺序中的前一主题

  • 下一个主题

带读者进入阅读顺序中的下一个主题

  • 返回主页面

将读者带到阅读顺序中当前主题目录中的位置

下面的屏幕截图说明了在XHTML版本的规范中如何显示导航链接:

图-2 导航链接

当读者将光标悬停在导航链接上时,还将显示DITA主题的简短描述。


< 回到目录