模板:Collapsible option/doc

模板:Collapsible option是一個實用模板，為嵌入包含在模板文檔頁模式頁面上提供了一個標準化的消息，用於那些可通過參數|state=進行管理的可摺疊模板。

它可以用於模板頁面本身（包裝在<noinclude>...</noinclude>標籤內），但通常最好將其放在模板的模板文檔框中。

state參數的可選用

用於管理可摺疊模板的|state=參數並不總是需要指定值，換句話說，模板默認的|state=參數也就等同於模板設置的|state=參數，前提是以這種方式編寫模板。為在模板:Collapsible option消息中表明這一點，請添加參數|statename=ptional。這樣修改後的消息顯示起來會是這樣（如果它用於自己）：

如何控制本模板的顯示狀態

• 使用{{Collapsible option|collapsed}}使本模板顯示為摺疊（隱藏）狀態。
• 使用{{Collapsible option|expanded}}使本模板顯示為展開（顯示）狀態。
• 使用{{Collapsible option|autocollapse}}使本模板僅在頁面上有其他相同類型的模板時，顯示為摺疊（隱藏）狀態。
• 除非另有設定（請見模板代碼內的|state=參數），autocollapse為預設狀態。

通過在模板數據設置以下內容來啟用這種可選擇的方法;：

• {{{1|}}} 作為可摺疊模板的|state=參數的一部分。

例如，像|state={{{state|{{{1|}}}}}}或|state={{{state|{{{1|<noinclude>expanded</noinclude>}}}}}}等。

• 可摺疊模板的state參數包含<noinclude>，<includeonly>。

例如，像|state={{{state<includeonly>|collapsed</includeonly>}}}

然而，如果模板本身包含可摺疊的部分（例如模板:Navbox with collapsible groups），那麼啟用這種可選擇的方法可能會引入關於何時摺疊或展開的模糊性。在這些情況下，應保留使用|state=參數的要求。

設置默認狀態

要設置模板:Collapsible option顯示的默認狀態，請在模板:Collapsible option中添加參數|default=collapsed（默認為摺疊狀態）或|default=expanded（默認為展開狀態）。這樣修改後的消息顯示起來會是這樣（如果它用於自己）：

如何控制本模板的顯示狀態

• 使用{{Collapsible option|state=collapsed}}使本模板顯示為摺疊（隱藏）狀態。
• 使用{{Collapsible option|state=expanded}}使本模板顯示為展開（顯示）狀態。
• 使用{{Collapsible option|state=autocollapse}}使本模板僅在頁面上有其他相同類型的模板時，顯示為摺疊（隱藏）狀態。
• collapsed已被設為預設狀態。

要將顯示消息恢復為所設置的默認值，請刪除模板:Collapsible option內先前包含的任何|default=。

在條目的文章內容中，不得使用|default=collapsed，也就是摺疊狀態，例如隱藏表格，或將額外的細節塞入信息框中。(有關更多信息，請參閱維基百科:格式手冊 § 滾動列表與摺疊元素。) 該選項在導航模板中是允許的，因為它們本身不屬於文章內容。

斜槓和nobase參數

如果模板:Collapsible option輸出的模板名稱包含模板名稱包含斜槓（/），則需要添加參數|nobase=（設置為on，true等），以便正確顯示名稱（即，使用{{PAGENAME}}而不是默認的{{BASEPAGENAME}}）。

模板數據

該模板用於控制頁面上特定元素的顯示狀態，可摺疊、展開或在其他相同類型模板存在時自動摺疊。默認狀態為自動摺疊。

模板參數

參數		描述	類型	狀態
狀態	state	用於定義模板的顯示狀態，可設置為"collapsed"（摺疊）、"expanded"（展開）或其他自定義狀態，影響模板在頁面中的默認呈現方式。 建議值 collapsed expanded autocollapse {{{state<includeonly>|collapsed</includeonly>}}}	字串	非必填
默認狀態	default	用於指定模板的默認狀態，當未明確設置狀態參數時，模板將以此參數所指定的狀態作為默認顯示狀態。	字串	非必填
狀態名稱	statename	用於定義模板顯示狀態的名稱。它指定模板的狀態標籤，可用於在模板代碼中引用不同的狀態，以便動態控制模板的顯示狀態。	不明	非必填

參見

• {{Navbox documentation}}, 使用本模板
• {{Collapsible lists option}}
• {{Collapsible sections option}}
• Help:Collapsing