華夏公益教科書:助手

此父頁面下的助手是一組互動式頁面，旨在幫助人類使用者執行各種任務——從新手到專家，從日常任務到可能每隔幾年才出現一次的事情。在我們編寫這些頁面時，將它們列在這裡。它們還在分類：互動式助手中進行了分類。

編寫助手有一些重要的約定在本頁底部；最終希望有一個或多個助手來幫助構建和維護助手。

助手列表

獨立

• 麵包板 (文件)

約定

• 對對話方塊操作的名稱空間使用{{SITENAME}}魔法字。這樣可以避免將專案的名稱硬編碼到將來可能在其他專案上使用或改編的頁面中。全域性助手也使用該名稱空間，如果明確引用它，應該使用魔法字，但其他模板通常會處理這種情況，如下所述。
• 給定助手的所有頁面都是一個父頁面的子頁面，即助手根頁面；或者位於模板空間中，並具有相應的名稱。助手主頁面及其所有子頁面屬於助手類別，而模板屬於子類別，文件頁面屬於另一個子類別。

• 助手主頁面有兩種命名方案，全域性和本地。
• 全域性主頁面名稱的形式為{{SITENAME}}:Assistant:<name>。子頁面為{{SITENAME}}:Assistant:<name>/...；模板為Template:Assistant:<name>/...或偶爾為Template:Assistant:<name>。助手類別為Category:Assistant:<name>。助手頁面的分類透過模板{{AssistantCat}}來協調。
• 本地主頁面是（非助手）頁面的子頁面<page>，位於除模板或類別之外的任何名稱空間中。主頁面名稱的形式為<page>/Assistant:<name>。子頁面為<page>/Assistant:<name>/...；模板為Template:<page>/Assistant:<name>/...或偶爾為Template:<page>/Assistant:<name>。助手類別為Category:<page>/Assistant:<name>.
• 有一些魔法字模板可以為當前頁面所屬的助手派生關聯的助手頁面名稱形式：{{ASSTDOC}}給出助手文件主頁面的名稱，{{ASSTROOT}}給出助手主頁面的名稱；{{ASSTCATEGORY}}給出助手類別的名稱；{{ASSTTEMPLATE}}給出助手模板的基本名稱。{{ASSTTEXT}}返回助手文字描述。（還有一些其他模板。）

• 有四種類型的助手

• 直接助手。助手是一個模板，它提供控制元件以立即在轉入頁面上執行簡單功能。
• 框架助手。主要助手頁面只能透過檢視動詞訪問，並使用{{dialog/preview}}來顯示要操作的目標頁面的修改後的形式。
• 單頁面獨立助手。助手主要由一個頁面組成，其佈局與目標頁面（與框架助手形成對比）有很大不同。
• 多頁面獨立助手。助手具有多個不同的主頁面。

這些助手中的任何一個都可能有一些輔助頁面；它們之間的區別在於不同的主要重點。

• 根頁面

• 對於直接助手，根頁面應該是指向模板的重定向。在模板的文件頁面上使用模板{{assistant/direct}}。
• 對於框架助手，根頁面應該是主要框架頁面；檢視動詞故意不支援重定向的目標。使用模板{{assistant/framing}}。相應的模板頁面通常提供一個按鈕來在轉入頁面上呼叫框架助手。
• 對於單頁面獨立助手，根頁面應該是內容頁面，因為沒有理由用重定向使事情變得更復雜。使用{{dialog/ifsupported}}以在直接作為維基頁面訪問時實現優雅的行為，以及{{assistant/single}}。
• 對於多頁面獨立助手，根頁面應該是指向子頁面的重定向，因此助手中的所有主要內容頁面都處於同一級別。對重定向根進行分類（透過{{AssistantCat}}，和往常一樣）。

• 重定向目標應該使用{{dialog/ifsupported}}以在直接作為維基頁面訪問時實現優雅的行為，以及{{assistant/viewable}}。考慮將其命名為{{ASSTROOT}}/start；一個可識別的標準名稱是可取的，因為任何透過檢視動詞進入助手的按鈕都必須直接指向子頁面。

• 主要文件頁面

• 始終子頁面{{ASSTROOT}}/doc，但如果助手是直接的，則應重定向到模板文件。
• 如果主頁面是多頁面助手的重定向，則主要文件頁面應該為每個子頁面和模板包含一個部分。這些部分應該與各個頁面的文件一致；這可以透過{{assistant/extract doc}}來實現。
• 如果主頁面是內容頁面，則在文件的參見部分中的關鍵子頁面和模板連結就足夠了。

• 助手的某些頁面旨在透過將其命名為檢視動詞來訪問；某些頁面旨在轉入到另一個頁面上；還有一些頁面可以以這兩種方式訪問。以下大多數原則都與管理這些不同的訪問模式及其不同的行為有關。
• 子頁面和模板

• 在子頁面上，使用{{assistant/viewable}}。
• 轉入時，始終將所有可用的輸入引數傳遞給它。
• 當透過標記{{{...}}}使用引數時，不要在它的預設值中巢狀另一個模板引數，例如{{{foo|{{{bar}}}}}}。非巢狀保留了透過對話方塊引數的可替換性，因為對話方塊引數（截至目前）僅替換非巢狀的模板引數。
• 當指定與輸入引數相對應的欄位時，將模板引數指定為初始值，例如{{dialog/text|id=foobar|{{{foobar|}}}}}。這適用於頁面檢視或轉入、模板傳遞引數或未傳遞引數以及對話方塊傳遞引數或未傳遞引數的任何組合。
• 當在任何頁面上指定按鈕時，始終明確地從它傳出所有輸入引數（除了SUBJECT-CONTENT之類的不會透過操作請求傳遞的內容）。如果這些引數中的任何一個沒有作為資料欄位在本地儲存（例如，通過當前頁面上的{{dialog/text}}），明確地將模板引數指定為傳出對話方塊引數的值，例如{{dialog/button/view|...|foobar::{{{foobar|}}}|...}}。這同樣適用於頁面檢視或轉入、模板傳遞引數或未傳遞引數以及對話方塊傳遞引數或未傳遞引數的任何組合。

• 子頁面和模板的文件頁面

• 記錄子頁面，使用{{assistant/documentation}}。
• 記錄多頁面助手的每個頁面，維護一個它可能使用的輸入引數列表，不區分模板引數和對話方塊引數。
• 記錄模板，使用{{assistant/template}}。
• 記錄對話方塊編輯表單，使用{{assistant/form}}。
• 為了在助手的主文件頁面轉入時正確顯示文件，對於頁面相對引用，使用 {{OBJECTPAGENAME}}。

另請參閱

• 相關通用模板列表