Lightweight DITA系列

本文最早于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 topic example

以下為一個XDITA map示例:

XDITA map example

注意: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 topic example

以下為一個HDITA map示例:

HDITA map example

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示例:

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示例伶贰。

MDITA extended-profile topic

MDITA map示例

MDITA map example
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市罐栈,隨后出現(xiàn)的幾起案子黍衙,更是在濱河造成了極大的恐慌,老刑警劉巖荠诬,帶你破解...
    沈念sama閱讀 207,113評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件琅翻,死亡現(xiàn)場離奇詭異,居然都是意外死亡浅妆,警方通過查閱死者的電腦和手機望迎,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,644評論 2 381
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來凌外,“玉大人辩尊,你說我怎么就攤上這事】导” “怎么了摄欲?”我有些...
    開封第一講書人閱讀 153,340評論 0 344
  • 文/不壞的土叔 我叫張陵,是天一觀的道長疮薇。 經(jīng)常有香客問我胸墙,道長,這世上最難降的妖魔是什么按咒? 我笑而不...
    開封第一講書人閱讀 55,449評論 1 279
  • 正文 為了忘掉前任迟隅,我火速辦了婚禮,結(jié)果婚禮上励七,老公的妹妹穿的比我還像新娘智袭。我一直安慰自己,他們只是感情好掠抬,可當我...
    茶點故事閱讀 64,445評論 5 374
  • 文/花漫 我一把揭開白布吼野。 她就那樣靜靜地躺著,像睡著了一般两波。 火紅的嫁衣襯著肌膚如雪瞳步。 梳的紋絲不亂的頭發(fā)上闷哆,一...
    開封第一講書人閱讀 49,166評論 1 284
  • 那天,我揣著相機與錄音单起,去河邊找鬼抱怔。 笑死,一個胖子當著我的面吹牛嘀倒,可吹牛的內(nèi)容都是我干的野蝇。 我是一名探鬼主播,決...
    沈念sama閱讀 38,442評論 3 401
  • 文/蒼蘭香墨 我猛地睜開眼括儒,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了锐想?” 一聲冷哼從身側(cè)響起帮寻,我...
    開封第一講書人閱讀 37,105評論 0 261
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎赠摇,沒想到半個月后固逗,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,601評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡藕帜,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,066評論 2 325
  • 正文 我和宋清朗相戀三年烫罩,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片洽故。...
    茶點故事閱讀 38,161評論 1 334
  • 序言:一個原本活蹦亂跳的男人離奇死亡贝攒,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出时甚,到底是詐尸還是另有隱情隘弊,我是刑警寧澤,帶...
    沈念sama閱讀 33,792評論 4 323
  • 正文 年R本政府宣布荒适,位于F島的核電站梨熙,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏刀诬。R本人自食惡果不足惜咽扇,卻給世界環(huán)境...
    茶點故事閱讀 39,351評論 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望陕壹。 院中可真熱鬧质欲,春花似錦、人聲如沸帐要。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,352評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽榨惠。三九已至奋早,卻和暖如春盛霎,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背耽装。 一陣腳步聲響...
    開封第一講書人閱讀 31,584評論 1 261
  • 我被黑心中介騙來泰國打工愤炸, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人掉奄。 一個月前我還...
    沈念sama閱讀 45,618評論 2 355
  • 正文 我出身青樓规个,卻偏偏與公主長得像,于是被迫代替她去往敵國和親姓建。 傳聞我的和親對象是個殘疾皇子诞仓,可洞房花燭夜當晚...
    茶點故事閱讀 42,916評論 2 344

推薦閱讀更多精彩內(nèi)容

  • 文章介紹何為Lightweight DITA,以及Lightweight DITA三種基本文件格式的特點和示例速兔。 ...
    莉莉鄧閱讀 1,517評論 0 1
  • width: 65%;border: 1px solid #ddd;outline: 1300px solid #...
    邵勝奧閱讀 4,764評論 0 1
  • 姓名:馮健 305A期學員 【日精進打卡第6天】 一墅拭、【知~勤學】 ①持誦 《六項精進》背誦5遍總27遍 《大學開...
    馮jian閱讀 174評論 1 1
  • 肆虐的臺風如期而至,沒留懸念涣狗,沒留念想谍婉,夾雜著一陣細雨,一陣暴雨镀钓。 門外的銀杏樹隨著風的節(jié)奏穗熬,拼命地搖曳著,枝頭的...
    商山一芙蓉閱讀 185評論 4 7
  • ①多個target中使用相同的Pods依賴庫 比如,名稱為CocoaPodsTest的target和Second的...
    CRAZYBADAM閱讀 1,520評論 0 0