Template: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