本文最早于2017.10.24發(fā)布于 TC互聯(lián)技術(shù)傳播社區(qū)巡语,時任互聯(lián)小編屹徘。內(nèi)容未有更新隅熙,僅遷移備份至個人賬號墓臭。
本文介紹何為Lightweight DITA蘸鲸,以及Lightweight DITA三種基本文件格式的特點和示例。
久聞DITA大名窿锉,但面對近200種元素望而生畏酌摇?
統(tǒng)一的DITA authoring tool,
人人都學是不是成本太高了點嗡载?
既有HTML文件窑多,又有Markdown文件,
難不成都得先轉(zhuǎn)一遍DITA XML洼滚?
專業(yè)TW埂息,開發(fā)人員,市場人員遥巴,
難道就不能愉快地協(xié)同和復(fù)用了嗎千康?
……
如果你有以上困惑和猶豫,那么了解下“苗條版”的DITA吧——Lightweight DITA铲掐。
或許拾弃,你會發(fā)現(xiàn)DITA不一樣的性感,馬上開啟你的DITA之旅摆霉。
何為Lightweight DITA
Lightweight DITA砸彬,簡稱LwDITA颠毙,故名思義,輕(shou)量(shen)級(hou)的DITA標準砂碉。
相比于DITA 1.3,LwDITA具有以下特點:
元素類型更少(smaller element type)
元素的屬性值更少(smaller element attribute set)
內(nèi)容模型更嚴格(stricter content models)
功能設(shè)置更少(reduced feature set)
新增多媒體元素類型
除以上基本區(qū)別外刻两,LwDITA相較于DITA 1.3最大的一個特點:能建立XML增蹭、HTML5、Markdown文件之間的映射磅摹。換言之滋迈,LwDITA支持建立由三種不同標記語言編寫的topic文件組成的map。
從此户誓,你可以:
體驗更簡潔饼灿、輕量級的DITA
不同格式偏好的技術(shù)寫作者不必顧慮文件格式的“強行一致”
由不同標記語言編寫的源文件能輕松轉(zhuǎn)換并發(fā)布
是不是聽著就很贊!5勖馈碍彭!下面就來細細一探究竟。
支持的文件格式
LwDITA支持三種文件格式:
XDITA:基于XML
HDITA:基于HTML5
MDITA:基于Markdown
XDITA
使用XML編寫的LwDITA文件格式悼潭,是DITA的一個子集庇忌,包含多媒體元素類型,能與HTML5文件相互轉(zhuǎn)換舰褪。
XDITA適用于想使用DITA標準寫作技術(shù)信息皆疹,卻無需完整的DITA標準的技術(shù)寫作者。
例如:
使用XML 編輯器占拍,但只想使用DITA的部分元素和屬性值
減少開發(fā)和維護樣式表(CSS)的成本
讓已有的DITA內(nèi)容兼容Markdown或者HTML5內(nèi)容
以下為一個XDITA topic示例:
以下為一個XDITA map示例:
注意:XDITA 要求在 <topicmeta> 必須包含<navtitle> 略就,聲明map中topic的標題。
HDITA
使用HTML5編寫的LwDITA文件格式晃酒,包含定制的數(shù)據(jù)屬性表牢,以實現(xiàn)與DITA之間的相互轉(zhuǎn)換。
HDITA特別適合下列群體:
市場文檔寫作者掖疮,不使用XML編輯器初茶,但能貢獻基于DITA的產(chǎn)品信息
使用HTML寫作工具的開發(fā)人員
教師或培訓師,想要為學習管理系統(tǒng)創(chuàng)建在線的課程內(nèi)容
想使用移動端設(shè)備編輯內(nèi)容的博主或內(nèi)容架構(gòu)師
只需編寫內(nèi)容但無需發(fā)布的文檔作者
熟悉和偏好HTML5元素的文檔寫作者
以下為一個HDITA topic示例:
以下為一個HDITA map示例:
MDITA
使用Markdown編寫的LwDITA文件格式浊闪。包含兩種類型:
核心類型(core profile)對應(yīng)Github Flavored Markdown恼布。
擴展類型(extended profile)適用于特殊的Markdown Flavor,提供DITA-like的體驗
MDITA特別適合下列群體:
市場文檔寫作者搁宾,不使用XML編輯器折汞,但能貢獻基于DITA的產(chǎn)品信息
貢獻產(chǎn)品文檔的開發(fā)人員,但希望自由選擇標記語言文檔編輯工具
負責API文檔應(yīng)用的開發(fā)或者技術(shù)寫作者盖腿,需要將內(nèi)容與其他技術(shù)文檔應(yīng)用共享
想要使用移動端(但不支持XML編輯器)編輯的寫作者
希望內(nèi)容后期能快速地轉(zhuǎn)換為結(jié)構(gòu)化的內(nèi)容
希望利用DITA重用和發(fā)布機制爽待,但不依賴于XML標簽的寫作者
MDITA topic示例
核心類型(core profile)
包含Markdown業(yè)已支持的元素:
- Title
- Paragraph
- Section title
- Unordered list
- Table
- Code block
MDITA core profile對應(yīng)Github Flavored Markdown Spec.
以下為一個MDITA core-profile topic示例:
擴展類型(extended profile)
MDITA extended profile支持以下兩類情況损同,與其他LwDITA文件格式或DITA1.3轉(zhuǎn)換性更好。
-
YAML front matter header 鸟款。
可用于提供 @id 屬性膏燃,同時也可以包含prolog metadata信息。
若topic需要添加YAML front matter header何什,務(wù)必將其放在MDITA文件的文件頭位置组哩,且必須用兩行 三短線之間。
其他HDITA支持的屬性和元素類型处渣。
以下是一個MDITA extended-profile topic示例伶贰。