DITA+DCS 如何迁移到 Markdown+GitHub

迁移过程

1. 把所有 DITA 文件放到同一个目录

可以自己写一个 python 脚本。有时间写了放到这里。

2. DITA 转换成 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 文件转换成 Markdown 文件

先用 Oxygen 把 DITA 文件转换成 HTML, 再用 Pandoc (https://pandoc.org/MANUAL.html) 把 HTML 转换成 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 转换成 SUMMARY. md

5. Conref.dita 转换成 conref.md

参考 《Markdown 吐血整理经验大全》里的 conref 部分(https://www.jianshu.com/p/6e12c9500f51)

6. 在 GitHub 上创建 master branch.

参考 《GitHub,Markdown 的好搭档》(https://www.jianshu.com/p/d5f77b3830b8)

7. 将转换后的文件放到 GitHub 本地目录。

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

转换后 clean-up

用工具转换后还是有很多问题,需要人工校对每个文档,检查问题。

1. Conref 替换问题。

转换成 .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.  检查文档确保符合规范。

- 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 吐血整理经验大全》中 Markdown 标签部分(https://www.jianshu.com/p/6e12c9500f51)

《你知道什么时候使用粗体、斜体、monospace 吗?》(https://www.jianshu.com/p/10ba5c55c86a)

d. 确保 PII compliance、accessibility 和 易于 translation

《文档质量之规范写作》(https://www.jianshu.com/p/dd44ab8f9bf4)

《技术文档写作常用工具大全》(https://www.jianshu.com/p/06696de014af)

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,547评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,399评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,428评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,599评论 1 274
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,612评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,577评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,941评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,603评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,852评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,605评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,693评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,375评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,955评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,936评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,172评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,970评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,414评论 2 342

推荐阅读更多精彩内容

  • By clicking to agree to this Schedule 2, which is hereby ...
    qaz0622阅读 1,427评论 0 2
  • 昨天下午,我看到了期盼已久的他,只是隔着手机屏幕说在一起的他,活生生站在我面前的时候,我发现那种感觉好陌生,好奇怪...
    橙槿阅读 138评论 0 0
  • 和朋友一起聊了很久。我们就是这样的,很久不聊天,但是一聊天就可以聊很久。我了解到了他的一些事情。原来每个人生活都是...
    三穗丸子阅读 134评论 0 0
  • 在我们的生活与工作中,网络无处不在,并且在不断地发展。说到网络,就不得不说网络协议了,在TCP和UDP协议中,...
    hoozenorg阅读 2,088评论 0 19
  • 不知道什么时候看过一篇文章,讲的是那个女主是个极简主义者,家里的日用品少之又少,连自己的内裤都只有两条,各个季节...
    十三等于一阅读 484评论 0 0