모듈:Unsubst/설명문서
이 문서는 모듈:Unsubst에 대한 설명입니다. 여기에는 틀 사용법, 분류 등 원래의 모듈 문서에는 포함되지 않는 내용을 담고 있습니다. |
이 모듈은 보호대상 등급이 매겨졌습니다. 이것은 매우 많은 문서에 사용되는 가시성이 높은 모듈이거나 매우 자주 문서 풀어넣기됩니다. 반달이나 실수가 많은 페이지에 영향을 미칠 수 있고 사소한 편집이 서버의 대량 로드가 일어날 수 있기 때문에, 이것은 편집 보호되었습니다. |
Helper module to facilitate a substituted template transform into a template transclusion.
Maintenance templates, such as {{Citation needed}} or {{Refimprove}}, should never be substituted. A trick to avoid that is to make a template substitute to its transcluded form.
Infoboxes should use Module:Unsubst-infobox, as should any other templates with parameters listed in block format by default.
Usage[편집]
To turn a template into a self-substituting template, wrap the existing template code with:
{{SAFESUBST:<noinclude />#invoke:Unsubst||$B= [ ... existing template code ... ] }}
The wikitext to display when not substed must be given as "$B". All other parameters passed to the #invoke will be copied to the generated template invocation as default values. If the value of any of these default parameters is __DATE__
, that value in the generated template invocation will be the current month and year.
Some templates have a <noinclude>
but no matching </noinclude>
at the end of the template. In such cases the missing </noinclude>
must be added before the ending }}
.
Advanced[편집]
{{SAFESUBST:<noinclude />#invoke:Unsubst||$params=[ parameters ]|$aliases=[ aliases ]|$flags=[ flags ]|$B= [ ... existing template code ... ] }}
Due to Lua limitations, parameters are normally ordered randomly when the template is substituted. |$params=
can be used in #invoke:Unsubst to list template parameters in order, comma-separated (e.g. egg,bacon,sausage,cheese,spam
). Numbered parameters should be before others in the list. Any remaining parameters are tacked onto the end of the generated invocation.
Parameter aliases can be listed in |$aliases=
(and shouldn't be listed in |$params=
), and will be replaced automatically. Each alias and its replacement should be formatted as alias>replacement
, and each of those pairs should be comma-separated (e.g. œuf>egg,melt>cheese
). Note that this parameter can function with or without |$params=
.
Parameter |$flags=
can be used to modify other facets of the module's behaviour; entries are comma-separated. Valid flags are override
(allows parameters in the #invoke: to take precedence over parameters in the original template invocation); keep-whitespace
(prevents whitespace from being trimmed from unnamed parameters); and remove-empty
(removes empty parameters).
These parameters can be manipulated using parser functions to provide more complicated options (note that in the parameters any parser function, or template or module invocation, should also have SAFESUBST:<noinclude />
).
Example[편집]
Consider a template Template:Example containing the following code:
{{SAFESUBST:<noinclude />#invoke:Unsubst||foo=bar |date=__DATE__ |$B= [ ... Template code goes here ... ] }}
Original | Result |
---|---|
{{subst:example}} |
{{Example|date=5월 2024}}
|
{{subst:example|foo=X}} |
{{Example|foo=X|date=5월 2024}}
|
{{subst:example|baz=X}} |
{{Example|baz=X|date=5월 2024}}
|
{{subst:example|date=January 2001}} |
{{Example|foo=bar|date=January 2001}}
|