在網頁編輯器中控制內容品質

Last update: Fri Jan 12 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

主題：
Web Editor

建立對象：

User
Admin

本文概述AEM Guides網頁編輯器中驗證的可能性。
透過設計Web編輯器，會利用系統中的DITA架構設定來強制使用者建立符合DITA規範的內容。如此一來，儲存在系統中的所有內容都會結構化、可重複使用且有效的DITA內容。

除了支援DITA規則外，網頁編輯器也支援根據"結構描述」規則。

"結構描述「是指用於定義XML檔案測試的規則型驗證語言。您可以匯入Schematron檔案，也可以在Web編輯器中編輯它們。使用「Schematron」檔案，您可以定義特定規則，然後針對DITA主題或地圖驗證這些規則。 Schematron規則可以強制實施定義為規則的限制，以確保XML結構的一致性。這些限制是由擁有內容品質和一致性的SME所推動。

注意：網頁編輯器支援ISO架構。

瞭解「Schematron」在網頁編輯器中如何運作

設定結構描述規則

請參閱以下主題中的「支援Schematron檔案」一節：使用手冊

在檔案儲存時強制執行驗證規則

Webeditor設定可讓超級使用者設定每次使用者更新內容時所執行的Schematron規則/檔案。如需更多詳細資料，請參閱以下的「驗證」一節：使用手冊

從網頁編輯器設定設定設定規則

您可以手動執行驗證嗎？

可以，作為作者/使用者，在建立內容時，您可以使用Webeditor中的「方案」面板來上傳Schematron檔案，並在編輯器中開啟的檔案上執行驗證。

為了使其運作，資料夾設定檔管理員必須允許所有使用者在驗證面板中新增結構描述檔案。 請參閱編輯器設定（上方提供的熒幕擷圖）

選擇結構描述檔案
執行驗證

支援的規則

目前版本的AEM Guides僅支援使用「宣告」型規則進行驗證。 (請參閱資產vs報表)尚未支援任何以「報表」為基礎的規則。

有關Schematron規則的範例和更多說明

範例使用案例

檢查連結是否為外部連結，以及連結的範圍是否為「外部」

code language-none

code language-none
`<sch:pattern> <sch:rule context="xref[contains(@href, 'http') or contains(@href, 'https')]"> <sch:assert test="@scope = 'external' and @format = 'html'"> All external xref links must be with scope='external' and format='html' </sch:assert> </sch:rule> </sch:pattern>`

<sch:pattern>
    <sch:rule context="xref[contains(@href, 'http') or contains(@href, 'https')]">
        <sch:assert test="@scope = 'external' and @format = 'html'">
            All external xref links must be with scope='external' and format='html'
        </sch:assert>
    </sch:rule>
</sch:pattern>

檢查地圖中是否至少有一個"topicref"，或在"ul"下是否至少有一個"li"

code language-none

code language-none
`<sch:pattern> <sch:rule context="map"> <sch:assert test="count(topicref) > 0"> There should be atleast one topicref in map </sch:assert> </sch:rule> <sch:rule context="ul"> <sch:assert test="count(li) > 1" > A list must have more than one item. </sch:assert> </sch:rule> </sch:pattern>`

<sch:pattern>
    <sch:rule context="map">
        <sch:assert test="count(topicref) > 0">
            There should be atleast one topicref in map
        </sch:assert>
    </sch:rule>

    <sch:rule context="ul">
        <sch:assert test="count(li) > 1" >
            A list must have more than one item.
        </sch:assert>
    </sch:rule>
</sch:pattern>

「indexterm」元素應一律存在於「prolog」中

code language-none

code language-none
`<sch:pattern> <sch:rule context="*[contains(@class, ' topic/indexterm ')]"> <sch:assert test="ancestor::node()/local-name() = 'prolog'"> The indexterm element should be in a prolog. </sch:assert> </sch:rule> </sch:pattern>`

<sch:pattern>
    <sch:rule context="*[contains(@class, ' topic/indexterm ')]">
        <sch:assert test="ancestor::node()/local-name() = 'prolog'">
            The indexterm element should be in a prolog.
        </sch:assert>
    </sch:rule>
</sch:pattern>

資源

recommendation-more-help

11125c99-e1a1-4369-b5d7-fb3098b9b178