藉由 DITA 文件使用檢查完整度
Arbortext Editor 會延伸常規檢查完整度功能,為 DITA 文件提供優化完整度檢查。當您編寫 DITA 文件並選擇 > 或按一下檢查完整度工具列按鈕時,會開始對文件執行常規完整度檢查。完成常規完整度檢查後,Arbortext Editor 會執行優化完整度檢查,以檢查是否有 DITA 特定問題。然後,會在完整度檢查日誌中報告所有問題。如果執行優化完整度檢查時花費了幾秒鐘以上的時間,即會顯示進度列。
常規完整度檢查會檢查可使用與文件關聯的文件類型驗證的項目。優化完整度檢查會檢查在 DITA 標準中描述,但無法針對 DTD 或 XML 架構驗證的項目。例如,優化完整度檢查會檢查是否有遺失的檔案、不正確或不尋常的 URL 格式、不尋常的 format 和 type 屬性值、被淘汰元素或屬性的使用等等。
您可以在 DITA 主題或 DITA 圖上執行優化完整度檢查。對於 DITA 主題,優化完整度檢查只會在主題上執行。根據 ditacheckreferences 進階偏好設定的設定,對於 DITA 圖,優化完整度檢查不只會在結構圖上執行,也會在任何其他從結構圖參照的 DITA 圖或主題上執行。優化完整度檢查中也會包含參照自 DITA 圖(參照自原始結構圖) 的 DITA 內容。您也可以選取部分的 DITA 圖,並只在結構圖的該部分上執行優先完整度檢查。在此情況下,常規完整度檢查會在整個結構圖上執行,但優化完整度檢查只會在結構圖所選的部分上執行。
當優先完整度檢查開始時,已開始優化完整度檢查 …訊息會在 Arbortext Editor 視窗底端的訊息區域中顯示。此訊息會隨著檢查的進行顯示優化完整度檢查的狀態。檢查完成時,會顯示優化完整度檢查已完成:無錯誤/警告訊息訊息或優化完整度檢查結束:詳情請參閱訊息視窗訊息。若為後者,則會顯示完整度檢查日誌視窗,其中列出任何 DITA 相關的警告或在文件中偵測到的錯誤。每個錯誤或警告在關聯的訊息後都有一個連結。連按兩下此連結會將游標移到關聯的文件中偵測到錯誤或警告的位置中。如果錯誤或警告與從 DITA 圖參照的文件有關,則會以新的 Arbortext Editor 視窗開啟該文件。
優化完整度檢查會檢查下列種類的 DITA 相關問題:
• DITA 標示問題 - 是指例如使用淘汰的標示、未由文件類型檢查的屬性值無效、使用用於分項化的標籤等問題
• DITA 參照問題 - 是指例如 href 屬性值無效、format 與 type 屬性值不尋常或錯誤等問題。
請注意,針對其檢查 format 屬性的值由 ditaexpectedformats 進階偏好設定的設定決定。
• DITA 金鑰與金鑰參照問題 - 是指與金鑰及金鑰參照有關的問題,例如未定義金鑰參照、金鑰定義名稱無效,以及解析 conkeyref 參照的問題。
完整度檢查日誌視窗有兩個選單與一個捷徑選單。
檔案選單有以下選項:
• 儲存 — 將訊息視窗的內容儲存至 .xml 檔案。如果這是自視窗顯示之後第一次儲存,會要求您選取輸出檔案名稱。
• 另存新檔 — 以其他名稱將內容儲存為輸出。
• 另存為 HTML — 將內容儲存為 .htm 檔案。
• 列印 - 列印訊息視窗的發行版本。此印出將會顯示目前設定為由檢視選單顯示的資訊。
• 關閉 — 關閉訊息視窗。
檢視選單包含以下選項:
• 顯示 — 決定在訊息視窗中顯示的內容類型:
◦ 訊息 — 顯示所有資訊 (訊息、警告及錯誤)。
◦ 警告 — 僅顯示警告和錯誤。這是預設設定。
◦ 錯誤 — 僅顯示錯誤。
• 字型大小 — 提供兩個用來變更訊息視窗中字型大小的選項:
◦ 增加 — 加大顯示的字型大小。
◦ 減少 — 縮小顯示的字型大小。
當您在訊息視窗中按一下滑鼠右鍵時,會顯示捷徑選單。它包含以下選項:
• 複製 — 將所選區域複製到剪貼簿中。此選項僅適用於您在所選區域內按一下滑鼠鍵時。
• 追蹤連結 — 如果您在訊息視窗中的連結上按一下滑鼠右鍵,並選取此選項,連結的文件就會顯示出來,而且游標將定位在來源文件中的適當位置。如果訊息視窗中沒有連結,此選項將沒有作用。
• 摺疊/展開 — 縮疊或延展目前條目。
優化完整度檢查有以下限制:
• 對於 DITA 圖,常規完整度檢查只會在該結構圖上執行,不會在任何從原始結構圖參照的 DITA 主題或結構圖上執行。
• 優化完整度檢查不會包含從其他主題參照的 DITA 主題。
• 對於包含大量主題參照的 DITA 圖,完成優化完整度檢查所需的時間可能比常規完整度檢查的長。