日韩性视频-久久久蜜桃-www中文字幕-在线中文字幕av-亚洲欧美一区二区三区四区-撸久久-香蕉视频一区-久久无码精品丰满人妻-国产高潮av-激情福利社-日韩av网址大全-国产精品久久999-日本五十路在线-性欧美在线-久久99精品波多结衣一区-男女午夜免费视频-黑人极品ⅴideos精品欧美棵-人人妻人人澡人人爽精品欧美一区-日韩一区在线看-欧美a级在线免费观看

歡迎訪問 生活随笔!

生活随笔

當前位置: 首頁 > 编程资源 > 编程问答 >内容正文

编程问答

轻量级DITA实践

發布時間:2024/3/26 编程问答 83 豆豆
生活随笔 收集整理的這篇文章主要介紹了 轻量级DITA实践 小編覺得挺不錯的,現在分享給大家,幫大家做個參考.

上篇文章提到了通過輕量級 DITA,可以讓公司全員貢獻結構化內容。有朋友反饋,怎么做呢?這篇文章聊聊怎樣搭建環境、編輯和發布內容。

場景和目標

公司的文檔團隊已經采用 DITA 作為文檔編輯和發布格式,現在計劃讓市場人員、業務專家、部門領導等不了解 XML 和 DITA 的同事能夠編寫部分內容,然后由文檔團隊成員組織、處理并發布。

同時,也適用于還沒有采用但計劃采用 DITA 編寫和發布內容的團隊。

1. 搭建環境

系統結構

將所有內容放在 Git 服務器,用于版本管理和團隊成員之間協作。編寫人員計算機上安裝 Git 客戶端(用于同步 Git 服務器上的內容)和 Markdown 編輯器(用于編寫內容)。

在負責內容發布的人員計算機上安裝發布工具,將內容發布成 PDF、HTML 等格式。

1. Git 服務器

我使用的是云端的 Git 服務 - www.giteee.com。

如果不想把內容放到云服務器上,也可以在自己公司的服務器上安裝 git 服務器。

2. Git 客戶端

我使用的是 GitHub Desktop,從這里下載安裝: https://desktop.github.com/

安裝好以后,克隆我放在 Gitee 上的樣例數據:

git clone https://gitee.com/long_jj_admin/lwdita.git

3. 編輯器

我選擇的編輯器是 VS Code。可以從這里下載:https://code.visualstudio.com/

還有其他的 Markdown 編輯器,可以根據自己喜好來選擇:

  • Typora
  • MarkdownPad
  • MacDown

4. 發布工具

DITA-OT 是 DITA 內容開源發布引擎,可以將 DITA 內容發布成 PDF、HTML 等輸出格式。使用 DITA 作為內容格式,一般都使用 DITA-OT 發布。

從這里下載和安裝 DITA-OT: https://www.dita-ot.org/

注:本實踐是在編輯人員的計算機上安裝 DITA-OT,如果發布的內容和發布需求很多,一般將 DITA-OT 安裝在發布服務器上,通過 Web 來訪問和發布。

2. 實踐

DITA 支持主題化的信息創建方法。主題(Topic)是信息的組成部分,而不是完整的文檔。主題根據信息類型的不同,可以分為 concept(概念)、task(任務)、reference(參考),和 troubleshooting(故障處理)等基本類型,這些主題通過 Map 文件組織起來形成文檔。Map 可被認為是文檔目錄結構,根據文檔不同類型,有不同的章節劃分方式。具體可以參見 Darwin Information Typing Architecture (DITA) v1.3 中對 topic、Map、以及 topic 中的元素和屬性的詳細描述。

我們使用阿里云的《智能云相冊》作為樣例數據,源數據在這里:https://help.aliyun.com/product/55352.html

這是組織好的文檔結構:

1. 編輯 Topic

輕量級 DITA 的 Topic 支持三種格式:XML, HTML 和 Markdown,并且支持這三種格式的相互轉換。Markdown 和 HTML 都是相對比較簡單的格式,我們很容易可以找到所見即所得的編輯器。本實踐中,我們主要使用Markdown格式的Topic。

打開某 Topic,比如 sect1-5.md,進行編輯(任何人都可以操作):

編寫完以后提交并推送到Git服務器。

2. 編輯 DITA Map

打開 cloudphoto.ditamap 進行編輯(由懂 DITA 的 Technical Writer 操作)。本實踐是以純文本的方式編輯XML格式的DITA Map,我們也可以使用XML編輯器,如:Oxygen,來編輯DITA Map。

DITA-OT 只支持 XML 格式的 Map,請見以下說明:

https://wiki.oasis-open.org/dita/LightweightDITASubcommittee/lwditatools

以及 DITA-OT 文檔說明:https://www.dita-ot.org/dev/topics/lwdita-input.html

3. 發布

當內容都編輯完成以后,在命令行運行以下命令將內容發布成 PDF(由 Technical Writer 操作):

dita -i .cloudphoto.ditamap -f pdf -o output

這是生成的PDF:

3. 總結

輕量級 DITA是簡化版的DITA,它去除DITA中復雜并且不常用的功能,但保持了DITA的核心能力,同時簡化了內容編輯,這為更多人貢獻內容邁進了扎實的一步。

本實踐總結了怎么搭建輕量級DITA的環境和全員使用輕量級DITA來編輯和發布內容,希望您有所收獲。同時歡迎反饋和提出你的想法。

封面畫:挪威峽灣

總結

以上是生活随笔為你收集整理的轻量级DITA实践的全部內容,希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯,歡迎將生活随笔推薦給好友。