Template:Attribution request/doc
 | This is a documentation subpage for Template:Attribution request. It may contain usage information, categories and other content that is not part of the original template page. |
 | This template may be substituted. |
| This template may have no transclusions. This is because it is substituted by a tool or script, it is used as part of a short-term or less active Wikipedia process, or for some other reason. |
 | This template is rated as alpha. It is ready for third party input, and may be used on a few pages to see if problems arise, but should be watched. Suggestions for new features or changes in their input and output mechanisms are welcome. |
This template generates a request for the Attribution bot in the form of a key=value pair string, and categorizes the page where it appears.
Usage
[edit]{{Attribution request}}
{{Attribution request|mode=run}}
Suggested usage
[edit]Suggested usage is to create a user subpage called /Attribution set for your list file, and create a subpage under it called /Attribution set/config, and place this template in the config file. If organized in this fashion, an invocation with no parameters will provide all the right values by default.
Substitution
[edit]This template may be substituted while developing your article list and the config file. When you are ready to request an echo or live run, it must be substituted so the bot can interpret the config values.
Parameters
[edit]|user=userid– userid responsible for edits that require attribution; default:{{ROOTPAGENAME}}, if namespace=User|list=– page containing a list of articles to be attributed (see required page format); default:{{BASEPAGENAME}}|log=– where to place the output log file; default:[[list]]/log|logformat=raw– returns a monospaced, non-clickable file; default:wikicode(a clickable wikicode log page)|mode=run– to request a live run; otherwise, just echoes the input file and displays what-if results in the log default:echo|additional=– a constant string to be appended to every edit summary line (prob. markup-stripped) (no default)|status=–submitorhold: whether to submit it, or keep it on hold
All params in horizontal format:
{{Attribution request |user= |list= |log= |logformat= |mode= |additional= |status=}}
All params with sample values (note that some of these are default values, and it wouldn't be necessary to provide them):
{{Attribution request |user=Jimbo |list=Jimbo/Set1 |log=Jimbo/Set1/log |logformat=wikicode |mode=echo |additional=my 2025 translations |status=hold}}
Output format
[edit]The template produces an output string with up to seven key=value pairs, separated by semicolons. They are:
| key | value | default | other values |
|---|---|---|---|
| user | |user= |
{{ROOTPAGENAME}} |
|
| list | |list= |
{{BASEPAGENAME}} |
|
| log | |log= |
[[list]]/log |
|
| format | |logformat= |
wikicode |
raw
|
| mode | |mode= |
echo |
run
|
| additional | |additional= |
any text string | |
| status | |status= |
submit or hold
|
For example:
user=Example1; list=User:Example1/Attrib set1; log=User:Example1/Attrib set1/log; format=wikicode; mode=echo; status=hold
Categorization
[edit]This template categorizes the page upon which it appears in one of these two categories:
- Category:Attribution requests pending – a list file ready to be run
- Category:Attribution requests not submitted – a holding area, where a user can work on their list or get feedback, help, etc.
Examples
[edit]Given a list file called User:Example1/Attrib set1, and a subpage under it called User:Example1/Attrib set1/config, then an invocation in the config file with no args gives the following:
{{Attribution request}}⟶user=Example1; list=User:Example1/Attrib set1; log=User:Example1/Attrib set1/log; format=wikicode; mode=echo; status=hold
and categorizes the page into Attribution requests not submitted.