DITA+DCS 如何遷移到 Markdown+GitHub

遷移過程

1. 把所有 DITA 文件放到同一個(gè)目錄

可以自己寫一個(gè) python 腳本痢毒。有時(shí)間寫了放到這里管毙。

2. DITA 轉(zhuǎn)換成 Markdown 格式

Convert your? .dita files in Oxygen. You can convert individually or in bulk using a flat ditamap. To transform in Oxygen: Configure Transformation Scenarios>New>Dita-OT Transformation>Markdown.

3. HTML 文件轉(zhuǎn)換成 Markdown 文件

先用 Oxygen 把 DITA 文件轉(zhuǎn)換成 HTML, 再用 Pandoc (https://pandoc.org/MANUAL.html) 把 HTML 轉(zhuǎn)換成 Markdown 文件悔常。

a. Download pandoc-1.19.1-windows.msi from GitHub (jgm/pandoc) and run it to install.

b. Check that everything works okay:

C:\>pandoc --version

pandoc 1.19.1

Pandoc is a command-line tool. Refer to https://pandoc.org/MANUAL.html?for all possible parameters, but this is typical for simple transforms:

C:\testtopics>pandoc test1.html -f html -t markdown -o test1.md

4. DITAMAP 轉(zhuǎn)換成 SUMMARY. md

5. Conref.dita 轉(zhuǎn)換成 conref.md

參考 《Markdown 吐血整理經(jīng)驗(yàn)大全》里的 conref 部分(http://www.reibang.com/p/6e12c9500f51)

6. 在 GitHub 上創(chuàng)建 master branch.

參考 《GitHub球订,Markdown 的好搭檔》(http://www.reibang.com/p/d5f77b3830b8)

7. 將轉(zhuǎn)換后的文件放到 GitHub 本地目錄筝家。

如:C:\Users\xxx\Documents\GitHub\xxx-docs.

轉(zhuǎn)換后 clean-up

用工具轉(zhuǎn)換后還是有很多問題轧钓,需要人工校對(duì)每個(gè)文檔序厉,檢查問題。

1. Conref 替換問題毕箍。

轉(zhuǎn)換成 .md 文件后弛房,conref 全變成 <span class="keyword">term_context</span>? 的格式,需要手工改成 {{site.data.keyword.term_keyword}} 的格式而柑。

a. Find the label term_keyword and take it as an example.

term_keyword:??

? keyword_context

b. Input the conref text for your agent in any text editor, for example, {{site.data.keyword.term_keyword}}. It is for future copy/paste use.?

c. Open Notepad++ or Visual Studio Code.?

d. In Notepad++, click Search -> Find in Files ( In Visual Studio Code, it is Edit-> Replace in files).?

e. In the Find what field, input the original conref text from converted dita topics. For keyword_context, it is <span class="keyword">keyword_context</span>. In the Replace with field, input the correct conref text that you created in step 2, for example, {{site.data.keyword.term_keyword}}. ?

f. In the Directory field, navigate to the directory where you store your .md files, for example,

C:\Users\xxx\Documents\GitHub\product-docs.?

g. Click Replace in Files. Then all occurences of the <span class="keyword">term_context</span> will be replaced with the correct conref text {{site.data.keyword.term_keyword}}.

2.? 檢查文檔確保符合規(guī)范文捶。

- Varname changes to italic.

- UI Control and Param name change to bold.?

- Script names should be in monospace and bold, for example, pre_install.sh.

- File names and paths/directorys should be in monospace.

- codeph in dita should be in codeblock.

For example:

```

```

{: codeblock}?

- Section in dita does not work in md, we need to add ** xx** to make it bold.

- Check the procedure steps are displayed well. Remove redundant space because it will cause the steps to be displayed as a codeblock text or make the step number in a mess.

- Check the links, especially the index links within the page. Usually the parent/child topic links work correctly, but if you have index links in the page that link to corresponding sections within the same page, the anchor is probably corrupted, so you need to re-create the anchor links in .md file. ?

LIMITATION: you can only link to another page NOT another section in another page.

- Adding registered trademark symbols: So in Oxygen, we had our lovely Trademarks tool, which you ran and it magically added our registered trademarks to the required company/product names in our topics. In MD, a little different, so basically for any company/product name that you need to include a registered trademark symbol for, you simply add &reg directly after the product or company name.

3. 檢查文檔確保文檔一致性。

參考:

《Markdown 吐血整理經(jīng)驗(yàn)大全》中 Markdown 標(biāo)簽部分(http://www.reibang.com/p/6e12c9500f51)

《你知道什么時(shí)候使用粗體媒咳、斜體粹排、monospace 嗎?》(http://www.reibang.com/p/10ba5c55c86a)

d. 確保 PII compliance涩澡、accessibility 和 易于 translation

《文檔質(zhì)量之規(guī)范寫作》(http://www.reibang.com/p/dd44ab8f9bf4)

《技術(shù)文檔寫作常用工具大全》(http://www.reibang.com/p/06696de014af)

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末顽耳,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子妙同,更是在濱河造成了極大的恐慌射富,老刑警劉巖,帶你破解...
    沈念sama閱讀 206,839評(píng)論 6 482
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件粥帚,死亡現(xiàn)場(chǎng)離奇詭異辉浦,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)茎辐,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,543評(píng)論 2 382
  • 文/潘曉璐 我一進(jìn)店門宪郊,熙熙樓的掌柜王于貴愁眉苦臉地迎上來掂恕,“玉大人,你說我怎么就攤上這事弛槐“猛觯” “怎么了?”我有些...
    開封第一講書人閱讀 153,116評(píng)論 0 344
  • 文/不壞的土叔 我叫張陵乎串,是天一觀的道長(zhǎng)店枣。 經(jīng)常有香客問我,道長(zhǎng)叹誉,這世上最難降的妖魔是什么鸯两? 我笑而不...
    開封第一講書人閱讀 55,371評(píng)論 1 279
  • 正文 為了忘掉前任,我火速辦了婚禮长豁,結(jié)果婚禮上钧唐,老公的妹妹穿的比我還像新娘。我一直安慰自己匠襟,他們只是感情好钝侠,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,384評(píng)論 5 374
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著酸舍,像睡著了一般帅韧。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上啃勉,一...
    開封第一講書人閱讀 49,111評(píng)論 1 285
  • 那天忽舟,我揣著相機(jī)與錄音,去河邊找鬼淮阐。 笑死叮阅,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的枝嘶。 我是一名探鬼主播帘饶,決...
    沈念sama閱讀 38,416評(píng)論 3 400
  • 文/蒼蘭香墨 我猛地睜開眼,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼群扶!你這毒婦竟也來了及刻?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 37,053評(píng)論 0 259
  • 序言:老撾萬榮一對(duì)情侶失蹤竞阐,失蹤者是張志新(化名)和其女友劉穎缴饭,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體骆莹,經(jīng)...
    沈念sama閱讀 43,558評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡颗搂,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,007評(píng)論 2 325
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了幕垦。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片丢氢。...
    茶點(diǎn)故事閱讀 38,117評(píng)論 1 334
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡傅联,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出疚察,到底是詐尸還是另有隱情蒸走,我是刑警寧澤,帶...
    沈念sama閱讀 33,756評(píng)論 4 324
  • 正文 年R本政府宣布貌嫡,位于F島的核電站比驻,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏岛抄。R本人自食惡果不足惜别惦,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,324評(píng)論 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望夫椭。 院中可真熱鬧掸掸,春花似錦、人聲如沸益楼。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,315評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)感凤。三九已至,卻和暖如春粒督,著一層夾襖步出監(jiān)牢的瞬間陪竿,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,539評(píng)論 1 262
  • 我被黑心中介騙來泰國(guó)打工屠橄, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留族跛,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 45,578評(píng)論 2 355
  • 正文 我出身青樓锐墙,卻偏偏與公主長(zhǎng)得像礁哄,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子溪北,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,877評(píng)論 2 345

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

  • By clicking to agree to this Schedule 2, which is hereby ...
    qaz0622閱讀 1,436評(píng)論 0 2
  • 昨天下午桐绒,我看到了期盼已久的他,只是隔著手機(jī)屏幕說在一起的他之拨,活生生站在我面前的時(shí)候茉继,我發(fā)現(xiàn)那種感覺好陌生,好奇怪...
    橙槿閱讀 140評(píng)論 0 0
  • 和朋友一起聊了很久蚀乔。我們就是這樣的烁竭,很久不聊天,但是一聊天就可以聊很久吉挣。我了解到了他的一些事情派撕。原來每個(gè)人生活都是...
    三穗丸子閱讀 136評(píng)論 0 0
  • 在我們的生活與工作中,網(wǎng)絡(luò)無處不在衔峰,并且在不斷地發(fā)展佩脊。說到網(wǎng)絡(luò),就不得不說網(wǎng)絡(luò)協(xié)議了垫卤,在TCP和UDP協(xié)議中威彰,...
    hoozenorg閱讀 2,090評(píng)論 0 19
  • 不知道什么時(shí)候看過一篇文章,講的是那個(gè)女主是個(gè)極簡(jiǎn)主義者穴肘,家里的日用品少之又少歇盼,連自己的內(nèi)褲都只有兩條,各個(gè)季節(jié)...
    十三等于一閱讀 485評(píng)論 0 0