- v50 information can now be added to pages in the main namespace. v0.47 information can still be found in the DF2014 namespace. See here for more details on the new versioning policy.
- Use this page to report any issues related to the migration.
Difference between revisions of "Help:Parser functions"
(document a couple functions) |
(expand more) |
||
| Line 1: | Line 1: | ||
| + | {{ambox|type=orange|text=This page is not yet complete!}} | ||
= Custom parser functions = | = Custom parser functions = | ||
== String functions == | == String functions == | ||
| Line 73: | Line 74: | ||
=== sha1 === | === sha1 === | ||
| − | Example: <pre></pre> | + | Returns the [[wikipedia:sha1|sha1]] hash of the first parameter. |
| − | → | + | |
| + | Example: <pre>{{#sha1:Dwarf Fortress}}</pre> | ||
| + | → {{#sha1:Dwarf Fortress}} | ||
=== md5 === | === md5 === | ||
| − | Example: <pre></pre> | + | Returns the [[wikipedia:md5|md5]] hash of the first parameter. |
| − | → | + | |
| + | Example: <pre>{{#md5:Dwarf Fortress}}</pre> | ||
| + | → {{#md5:Dwarf Fortress}} | ||
| + | |||
| + | == Math functions == | ||
=== randint === | === randint === | ||
| − | Example: <pre></pre> | + | Returns a random integer between the two arguments provided. |
| − | → | + | |
| + | Example: <pre>{{#randint:1|6}}</pre> | ||
| + | → {{#randint:1|6}} | ||
| + | |||
| + | <pre>{{#randint:6|1}}</pre> | ||
| + | → {{#randint:6|1}} | ||
| + | |||
| + | == Wikitext/utility functions == | ||
=== param === | === param === | ||
| − | Example: <pre></pre> | + | For use in templates: Returns the first parameter found from a list of parameter names, or the last argument if none were found. Intended to be easier to read than a chain of template default arguments. The following lines are equivalent: |
| − | → | + | <pre> |
| + | {{{first|{{{2|{{{1|{{{last|None of the parameters were found}}}}}}}}}}}} | ||
| + | {{#param:first|2|1|last|None of the parameters were found}} | ||
| + | </pre> | ||
| + | |||
| + | Example: | ||
| + | |||
| + | "Template:Sample" contains: <pre>{{#param:first|2|1|last|None of the parameters were found}}</pre> | ||
| + | ---- | ||
| + | <pre>{{sample|first=text}}</pre> | ||
| + | → text | ||
| + | ---- | ||
| + | <pre>{{sample|text}}</pre> | ||
| + | → text | ||
| + | ---- | ||
| + | <pre>{{sample|foo|bar}}</pre> | ||
| + | → bar | ||
| + | ---- | ||
| + | <pre>{{sample|a|b|last=c|first=First!}}</pre> | ||
| + | → First! | ||
| + | ---- | ||
| + | <pre>{{sample|3=foo}}</pre> | ||
| + | → None of the parameters were found | ||
Revision as of 01:59, 20 February 2014
 | This page is not yet complete! |
Custom parser functions
String functions
strc
Expands backslash escape sequences, such as:
| Text | Produces |
|---|---|
| \n | newline |
| \t | tab |
Example:
Some example{{#strc:\t}}text
Produces:
Some example text
strcount
Returns the number of occurrences of the second parameter in the first parameter. Case-sensitive
Example:
{{#strcount:This string sure has a lot of "T"'s in it! | t}}
→ 3
stricount
Same as strcount, but case-insensitive.
Example:
{{#stricount:This string sure has a lot of "T"'s in it! | t}}
→ 5
stripos
Example:
→
stristr
Example:
→
strlen
Example:
→
strpos
Example:
→
strripos
Example:
→
strrpos
Example:
→
strsplit
Example:
→
strstr
Example:
→
sha1
Returns the sha1 hash of the first parameter.
Example:
{{#sha1:Dwarf Fortress}}
→ e71c8ec81bef5a3717cba2e82840b8bbdc6570d1
md5
Returns the md5 hash of the first parameter.
Example:
{{#md5:Dwarf Fortress}}
→ c5d1f740e7c056187c120083d2405a6a
Math functions
randint
Returns a random integer between the two arguments provided.
Example:
{{#randint:1|6}}
→ 1
{{#randint:6|1}}
→ 5
Wikitext/utility functions
param
For use in templates: Returns the first parameter found from a list of parameter names, or the last argument if none were found. Intended to be easier to read than a chain of template default arguments. The following lines are equivalent:
{{{first|{{{2|{{{1|{{{last|None of the parameters were found}}}}}}}}}}}}
{{#param:first|2|1|last|None of the parameters were found}}
Example:
"Template:Sample" contains:
{{#param:first|2|1|last|None of the parameters were found}}
{{sample|first=text}}
→ text
{{sample|text}}
→ text
{{sample|foo|bar}}
→ bar
{{sample|a|b|last=c|first=First!}}
→ First!
{{sample|3=foo}}
→ None of the parameters were found