- 1 -
什麼情況下需要用到內容重用
我們為公司的產品編寫一系列的文件,比如:XXX產品安裝手冊、XXX產品配置手冊、XXX產品使用手冊等。這些文件中,有些內容是相同的,比如:版權說明和公司介紹。
使用傳統寫手冊的方法,每個手冊是獨立的一個檔案。 內容相同的部分,透過複製黏貼的方式在不同手冊中存在多份。使用這種方法的問題是:
一旦這個內容需要修改,同樣的內容需要修改多次,而且可能存在漏改。
比如:公司併購,所有手冊中的版權宣告都需要進行修改。
在寫手冊前,我們就需要考慮這種情況,來對文件進行設計,為以後的變更做好準備。理想的情況是:
同樣的內容只儲存一份,內容透過引用在不同的手冊裡出現。這樣,如果要修改只需要修改一次,而且不會漏改。
- 2 -
Markdown怎麼實現重用
DITA 是基於XML的體系結構,用於編寫、製作、交付面向主題的資訊型別的內容。如果公司使用DITA來編寫手冊,它本身具備了內容重用的機制。
因為種種原因,我們覺得Markdown更好用,但是Markdown是否有我們需要的內容重用功能呢?
先說答案:Markdown本身不支援內容重用。
但是,沒錯這裡說的就是但是,
Gitbook提供內容重用的機制
,來支援我們實現這個需求。
Gitbook提供的內容重用機制有:
1. 變數
Gitbook中提供了定義變數,並在內容中引用這個變數的能力。在出版成PDF或者使用者瀏覽網站的時候根據變數的值動態生成內容。
在我們的內容中,有比較少的文字重複出現,而且根據情況會變化,比如:產品的名字。針對這種情況,我們可以定義一個變數,然後在內容中引用這個變數,從而達到重用的效果。
2. 內容引用
Gitbook中提供了在一個Markdown檔案引用另外一個Markdown檔案的能力。在出版成PDF或者使用者瀏覽網站的時候被引用的內容將被合併到檔案中。
在我們的內容中,有比較多的文字重複出現,比如:版權宣告。針對這種情況,我們可以把重複出現的內容放在一個Markdown檔案中,然後在其他Markdown中引用這個檔案。
- 3 -
上手實踐
這是我的Gitbook專案檔案和目錄:
1. 透過變數來重用內容
1)在book。json中定義一個變數:
{ “variables”: { “productName”: “雲伺服器ECS” }}
2)在內容中引用此變數 (可往右滑動)
# 什麼是{{ book。productName }}{{ book。productName }}是阿里雲提供的效能卓越、穩定可靠、彈性擴充套件的IaaS(Infrastructure as a Service)級別雲計算服務。
看效果(橫屏比較清楚):
影片載入中。。。
2. 透過內容引用來重用內容
1)把重複的內容放到獨立的Markdown檔案中 (common/copyright。md)
© 2009-2021 Alibeta。com 版權所有 增值電信業務經營許可證: 滬-20210008
2)在檔案中引用共享的內容
更多有關阿里雲最新產品動態,請訂閱雲產品動態。{% include “。。/common/copyright。md” %}
看效果(橫屏比較清楚):
影片載入中。。。