為AEM Guides自訂現有的AEM網站範本
本指南提供逐步指示,讓您自訂現有的AEM網站範本,以便與AEM Guides搭配使用,從DITA map和主題產生AEM Sites。
如果您使用現成可用的AEM Guides (AEMG Docs)範本,設定和元件已準備就緒,可按原樣使用以發佈您的AEM Guides內容。 不過,如果您想要搭配自訂品牌使用現有的AEM Sites範本來發佈AEM Guides內容,請依照下列步驟,將您的網站範本與AEM Guides演算需求保持一致。
先決條件
-
您擁有AEM範本的適當許可權和存取權。
-
您瞭解AEM可編輯範本和AEM網站結構。
-
您已有使用可編輯範本建立的現有網站階層。
-
您現有專案中至少有兩個範本:
- 檔案容器頁面範本 用於將DITA map呈現為檔案根。
- 主題頁面範本 用於呈現個別DITA主題頁面。
範本命名考量事項
範本名稱會依專案設定而有所不同。 例如,在OOTB AEMG Docs設定中:
-
檔案容器頁面: /conf/AEMG-Docs-Site/settings/wcm/templates/kb-content
-
主題頁面: /conf/AEMG-Docs-Site/settings/wcm/templates/topic-content
自訂: 自訂程式包含兩個主要步驟:
- 範本設定:識別並設定兩個範本(容器和主題)。
- 轉譯指南元件:內嵌必要的AEM Guides元件,以啟用目錄、導覽和中繼資料顯示等功能。
範本設定
從您的AEM網站選擇並設定兩個可編輯的範本。
檔案容器頁面範本
「檔案容器頁面」範本是用來建立轉譯DITA map內容的「產品檔案容器」頁面。
-
它是特定檔案集(例如產品手冊或指南)的入口點或首頁。
-
將id="category-page"屬性新增至範本之初始節點的jcr:content。 這可確保AEM Guides會自動將從此範本建立的所有頁面視為檔案容器。
-
新增具有強制屬性的文字元件: text="$category.html$"。
-
通常會包含導覽元素,例如檔案內章節或主題的連結。
-
它可以自訂為包含品牌、頁首、頁尾和其他設計元素。
範例使用案例:
如果您有產品手冊的DITA map,檔案容器頁面範本將會產生該手冊的首頁,顯示概覽和個別主題的連結。
主題頁面範本
-
主題頁面範本 用於建立個別 DITA主題 的頁面。
-
DITA map中的每個主題都會使用此範本呈現為個別頁面。
-
包含具有必要屬性的 文字元件: text="$topic.content$"。
-
在網站產生期間,此預留位置會取代為DITA主題的實際內容。
- 文字元件通常置於 Container元件 內,以確保配置與樣式正確無誤。
- 可以自訂以包含所有主題頁面一致的頁首、頁尾和導覽元素。
範例使用案例:
如果您有有關「安裝指示」的DITA主題,主題頁面範本將會產生顯示該主題內容的頁面。
容器元件:
在相同範本的結構中新增相同的(容器和文字元件):
自訂範本中的轉譯指南元件
若要啟用目錄、頁面重新導向、導覽和中繼資料顯示等核心AEM Guides元件功能,您必須在自訂範本中加入特定AEM Guides元件。 這些元件必須明確新增至對應的可編輯範本(檔案容器頁面或主題頁面),以確保目標功能在網站產生和執行階段期間可用。
如需元件及其使用方式的清單,請參閱下表:
元件使用案例
-
重新導向元件(childredirect): 將此元件新增至檔案容器頁面範本,讓從DITA map產生的產品首頁自動重新導向至第一個主題頁面。 如果您的檔案容器頁面設計為具有自訂元件和配置的獨立首頁,則不需要此元件。
-
目錄(guidessidenavigation): 將此專案新增至主題頁面範本,以便與主題內容一起呈現可瀏覽的目錄。 TOC衍生自DITA map,可協助使用者瀏覽同層級主題。
啟用Guides使用者端程式庫
依預設,AEM Guides元件套件中提供的使用者端資料庫(clientlibs)不會套用至自訂範本。 若要啟用這些功能:
-
編輯範本:
-
以 編輯器模式 開啟 產品頁面。
-
選取 編輯範本 (這將開啟conf/settings/wcm/templates/structure.html之類的URL)。
-
-
更新頁面原則:
-
移至 頁面資訊 按鈕,並選取 頁面原則。
-
新增下列使用者端程式庫:
- 使用者端資料庫
- 使用者端資料庫JavaScript頁面標題
-
-
儲存變更: 新增必要的使用者端程式庫後儲存範本。