Editing Module:Param Parse/doc

Jump to navigation Jump to search
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
{{documentation}}
{{documentation}}


These params and functions are used to validate and format information passed into an Infobox. See [[Module:Infobox]] for details and instructions on creating an Infobox. If the information is missing or not valid, the functions here should return nil.
These functions are used to validate and format information passed into an Infobox. See [[Module:Infobox]] for details and instructions on creating an Infobox. If the information is missing or not valid, the functions here should return nil.


Here is a summary of all the params:
Here is a summary of all the functions:
{| class="wikitable"
! param
! explanation
|-
| parse.name
| Title
|-
| parse.examine
| Examine info
|-
| parse.image
| <nowiki>[[File:IMAGE.png]]</nowiki>. Use the class '''infobox-image''' in the table
|-
| parse.image_size300
| <nowiki>[[File:IMAGE.png|300x300px]]</nowiki> by default unless overridden. Use the class '''infobox-image''' in the table
|-
| parse.episode
| Episode name
|-
| parse.premium
| Premium (Yes, No, N/A)
|-
| parse.release
| TODO
|-
| parse.profession
| TODO
|-
| parse.variant
| TODO - Which category the subject is a variant of
|}

Here are some general use functions that can be used for custom or new params:
{| class="wikitable"
{| class="wikitable"
! function name
! function name
Line 43: Line 10:
| has_content(arg)
| has_content(arg)
| Returns arg if any non-whitespace character is found in the string.
| Returns arg if any non-whitespace character is found in the string.
|-
| image(img)
| Returns img if any non-whitespace character is found in the string.
|-
| image_smw(img)
| Searches for and returns "File:___.png"
|-
|-
| number(num)
| number(num)
| Removes any commas and parses the string as a number
| Removes any commas and parses the string as a number
|-
| episode(episode)
| Returns a plink of the episode, e.g. [[File:Hopeport episode icon.png|18px]] [[Hopeport]]
|-
| episode_smw(episode)
| Returns the name of the episode if valid
|-
|-
| yes_no(text)
| yes_no(text)
Line 52: Line 31:
| yes_no_smw(text)
| yes_no_smw(text)
| Maps "Yes", "No" to true and false respectively
| Maps "Yes", "No" to true and false respectively
|}

== Creating New Params ==
Ideally, params should be defined here so that they can be reused between different Infoboxes. Here is how to create a new param:

<syntaxhighlight lang="lua">
parse.paramname = {
name = <param>,
func = <func>,
empty = 'empty', -- optional
category_never = 'category', -- optional
category_partial = 'category', -- optional
category_incomplete = 'category', -- optional
category_complete = 'category', -- optional
smw_property = 'Property', -- optional
smw_func = <func>, -- optional
}
</syntaxhighlight>


{| class="wikitable"
! key
! value
|-
| name
| parameter name as used in the Template
|-
| func
| A function in [[Module:Param Parse]] to validate and process the Template argument. You can also use a local function, but this is not recommended.
If func is a function, will call func(Infobox.raw_param(name)):
<syntaxhighlight lang="lua">
{name = <param>, func = <func>, ... },
</syntaxhighlight>
If func is a table, it takes the following parameters:
<syntaxhighlight lang="lua">
{name = <param>, func = { name = <func>, params = <func_params>}, ... },
</syntaxhighlight>
{| class="wikitable"
| name
| function in [[Module:Param Parse]]
|-
| params
| a list of parameters to pass the the function, in the form of constants, or Infobox.raw_param(name), Infobox.param(name), Infobox.smw_param(name)
|}
|-
| empty (optional)
| text to display in the infobox if func returns nil; defaults to "? (edit)"
|-
| category_never (optional)
| category to add if func returns nil for all versions
|-
| category_partial (optional)
| category to add if func returns nil for some versions, but a value for other versions
|-
| category_incomplete (optional)
| category to add if func returns nil for at least 1 version (i.e. category_never and category_partial combined)
|-
| category_complete (optional)
| category to add if func returns a value for all versions
|-
| smw_property (optional)
| if this string is defined, the parameter will be saved into SMW
|-
| smw_func (optional)
| function to validate and process the Template argument to save into SMW. func is used by default if smw_func is not defined
|}
|}
Please note that all contributions to Brighter Shores Wiki are considered to be released under the CC BY-NC-SA 3.0 (see Brighter Shores:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!
Cancel Editing help (opens in new window)
Preview page with this template

Templates used on this page:

This page is a member of a hidden category:

Retrieved from ‘https://brightershoreswiki.org/w/Module:Param_Parse/doc’