Template:CiteGodLetter/doc: Difference between revisions

From RuneRealm Wiki
Jump to navigation Jump to search
Content added Content deleted
No edit summary
Tag: Reverted
No edit summary
Tag: Manual revert
 
Line 1: Line 1:
{{documentation}}
{{Documentation}}
__NOTOC__
This template displays a box to format letter written by players on the transcriptions of the [[God letters]] and [[Postbag from the Hedge]]

==Usage==
==Usage==
<pre>{{CiteGodLetter|issue=|letter=|notes=|name=|group=}}</pre>
This template can be used by entering the following onto a relevant page.


The template automatically populates the citation with the relevant link and info by only adding the <code>|issue=</code> parameter.
<pre>{{Letter|Text to be displayed}}</pre>


===Issue===
{{Letter|Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.}}
The issue number of the God Letter. Found at the top next to the title. Do not include "Issue ", supply only a number.


===Letter===
<includeonly>[[Category:Formatting templates|{{PAGENAME}}]]</includeonly>
This is for specifying the number of the letter being cited. This field contains no formatting, therefore type exactly what you wish to appear. For example, the first letter and its reply are "Letter 1", the second is "Letter 2", and so on. It may also be necessary to use "Introduction" other descriptors to cover information which is outside of a normal letter and reply format.


{{References standard parameters}}
{{TemplateData|<templatedata>
{{citations}}
{
"params": {
"1": {
"label": "Text",
"description": "Text to be displayed within the letter",
"example": "Lorem ipsum dolor sit amet...",
"type": "string"
}
},
"description": "This template displays a box to format letter written by players on the transcriptions of the God letters and Postbag from the Hedge",
"format": "inline"
}
</templatedata>
}}

Latest revision as of 11:32, 17 October 2024

This is a documentation subpage for Template:CiteGodLetter.
It contains usage information, categories, and other content that is not part of the original template page.
Template:CiteGodLetter invokes function godletterref in Module:References using Lua.

Usage

{{CiteGodLetter|issue=|letter=|notes=|name=|group=}}

The template automatically populates the citation with the relevant link and info by only adding the |issue= parameter.

Issue

The issue number of the God Letter. Found at the top next to the title. Do not include "Issue ", supply only a number.

Letter

This is for specifying the number of the letter being cited. This field contains no formatting, therefore type exactly what you wish to appear. For example, the first letter and its reply are "Letter 1", the second is "Letter 2", and so on. It may also be necessary to use "Introduction" other descriptors to cover information which is outside of a normal letter and reply format.

Standard parameters

The following parameters are standard across all citation templates.

notes

Optional. This parameter allows you to add text beginning one space after the end of the citation. Having no formatting (meaning you will have to format it yourself), this area can be used for anything you require.

name

Optional. If you want to use this reference more than once, you must name it the first time you use it, then whenever you want to use it again, add {{NamedRef|name}} wherever you want it to re-appear.

group

Optional. This can be used to put the reference into a specific group, to separate it from other types of reference. See here for more on reference groups.