Template:ConvoCite/doc: Difference between revisions

parameters
updated doc
 
(3 intermediate revisions by one other user not shown)
Line 1: Line 1:
==Usage==
==Usage==
This template can be used to reference conversations. It links to the conversation page of the first hero. Quotations are optional.
This template can be used to reference conversations. It links to the conversation page of the first hero. Conversation number and quotations can be added.


  <nowiki>{{ConvoCite|hero1=First hero|hero2=Second hero}}</nowiki>
  <nowiki>{{ConvoCite|hero1=First hero|hero2=Second hero}}</nowiki>


(Note: Unlike [[Template:VoiceLineCite]], the quotations aren't pre-formatted, allowing for more flexibility by the editor. This might be changed in the future)
==Example usages==
==Example usages==
Example:
Example:
Line 12: Line 11:
{{ConvoCite|hero1=Abrams|hero2=Dynamo}}
{{ConvoCite|hero1=Abrams|hero2=Dynamo}}


With quotation:
With number:
  <nowiki>{{ConvoCite|hero1=Abrams|hero2=Dynamo|quote='''Abrams:''' ''"Stay close to me Professor, I'll keep you safe."''}}</nowiki>
  <nowiki>{{ConvoCite|hero1=Abrams|hero2=Dynamo|number=2}}</nowiki>
Result:
Result:


{{ConvoCite|hero1=Abrams|hero2=Dynamo|quote='''Abrams:''' ''"Stay close to me Professor, I'll keep you safe."''}}
{{ConvoCite|hero1=Abrams|hero2=Dynamo|number=2}}
 
With one quotation:
<nowiki>{{ConvoCite|hero1=Abrams|hero2=Dynamo|number=2|hero_quote1=Abrams|quote1=Stay close to me Professor, I'll keep you safe.}}</nowiki>
Result:
 
{{ConvoCite|hero1=Abrams|hero2=Dynamo|number=2|hero_quote1=Abrams|quote1=Stay close to me Professor, I'll keep you safe.}}
 
With two quotations:
<nowiki>{{ConvoCite|hero1=Abrams|hero2=Dynamo|number=2|hero_quote1=Abrams|quote1=Stay close to me Professor, I'll keep you safe.|hero_quote2=Dynamo|quote2=Detective, I was about to say the same thing to you.}}</nowiki>
Result:
 
{{ConvoCite|hero1=Abrams|hero2=Dynamo|number=2|hero_quote1=Abrams|quote1=Stay close to me Professor, I'll keep you safe.|hero_quote2=Dynamo|quote2=Detective, I was about to say the same thing to you.}}
 
With alternative name
<nowiki>{{ConvoCite|hero1=Abrams|hero2=Dynamo|l1=Atlas|l2=Prof|number=2|hero_quote1=Abrams|quote1=Stay close to me Professor, I'll keep you safe.|hero_quote2=Dynamo|quote2=Detective, I was about to say the same thing to you.}}</nowiki>
Result:
 
{{ConvoCite|hero1=Abrams|hero2=Dynamo|l1=Atlas|l2=Prof|number=2|hero_quote1=Abrams|quote1=Stay close to me Professor, I'll keep you safe.|hero_quote2=Dynamo|quote2=Detective, I was about to say the same thing to you.}}
 
With prefix (puts word "Conversation" at the start of the sentence which is mostly used for localization)
<nowiki>{{ConvoCite|hero1=Abrams|hero2=Dynamo|prefix=1|number=2|hero_quote1=Abrams|quote1=Stay close to me Professor, I'll keep you safe.|hero_quote2=Dynamo|quote2=Detective, I was about to say the same thing to you.}}</nowiki>
Result:
 
{{ConvoCite|hero1=Abrams|hero2=Dynamo|prefix=1|number=2|hero_quote1=Abrams|quote1=Stay close to me Professor, I'll keep you safe.|hero_quote2=Dynamo|quote2=Detective, I was about to say the same thing to you.}}


<templatedata>
<templatedata>
Line 22: Line 45:
"params": {
"params": {
"hero1": {
"hero1": {
            "type": "string",
"type": "string",
"description": "Name of the first hero and the one it will be linked to",
"description": "Name of the first hero and the one it will be linked to",
"required": true
"required": true
},
},
        "hero2": {
"hero2": {
            "type": "string",
"type": "string",
            "description": "Name of the second hero",
"description": "Name of the second hero",
            "required": true
"required": true
        },
},
        "quote": {
"number": {
            "type": "string",
"type": "string",
            "description": "Transcription of the relevant quote (formatting - bold, italics etc. - needs to be included)",
"description": "Number of the conversation (1-3)",
            "required": false
"required": false
        }
},
"hero_quote1": {
"type": "string",
"description": "Hero that the quote belongs to",
"required": false
},
"quote1": {
"type": "string",
"description": "Transcription of the relevant quote",
"required": false
},
"hero_quote2": {
"type": "string",
"description": "Hero that the 2nd quote belongs to",
"required": false
},
"quote2": {
"type": "string",
"description": "Transcription of the 2nd relevant quote",
"required": false
},
"hero_quote3": {
"type": "string",
"description": "Hero that the 3rd quote belongs to",
"required": false
},
"quote3": {
"type": "string",
"description": "Transcription of the 3rd relevant quote",
"required": false
},
"prefix": {
"description": "Put word Conversation at the start of the sentence",
            "type": "boolean"
},
"l1": {
"description": "Alternative name of the first hero",
"type": "string"
},
"l2": {
"description": "Alternative name of the second hero",
"type": "string"
}
},
},
"format": "inline",
"format": "inline",
    "paramOrder": [
"paramOrder": [
"hero1",
"hero1",
        "hero2",
"hero2",
        "quote"
"number",
"hero_quote1",
"quote1",
"hero_quote2",
"quote2",
"hero_quote3",
"quote3",
"prefix",
"l1",
"l2"
]
]
}
}
</templatedata><noinclude>[[Category:Template documentation]]</noinclude>
</templatedata><noinclude>[[Category:Template documentation]]</noinclude>