ထႅမ်းပလဵတ်ႉ:quote-meta/paramdoc/documentation

This template should be used for displaying the documentation of the parameters to quotation templates, for example English quotation templates.

Description

The template currently supports only a single parameter, |1=. Text in that parameter is output verbatim, except that certain parameter references using the syntax <<PARAM>> or <<PARAM:SYNONYM>> are replaced with documentation for that parameter.

Examples

For example, the following code:

{{quote-meta/paramdoc|1=
<<chapter:1>>
<<page:2>>
<<passage:3>>
<<trailing_params>>
}}

generates the following text (not including the horizontal rules denoting the start and end of the text):

---

• |1= or |chapter= – the name of the chapter quoted from.
• |2= or |page=, or |pages= – mandatory in some cases: the page number(s) quoted from. When quoting a range of pages, note the following:
  • Separate the first and last pages of the range with an en dash, like this: |pages=10–11.
  • You must also use |pageref= to indicate the page to be linked to (usually the page on which the Wiktionary entry appears).

This parameter must be specified to have the template link to the online version of the work.

• |3=, |text=, or |passage= – the passage to be quoted.
• |footer= – a comment on the passage quoted.
• |brackets= – use |brackets=on to surround a quotation with brackets. This indicates that the quotation either contains a mere mention of a term (for example, “some people find the word manoeuvre hard to spell”) rather than an actual use of it (for example, “we need to manoeuvre carefully to avoid causing upset”), or does not provide an actual instance of a term but provides information about related terms.

---

Here, for example, <<page:2>> describes the |page= and |pages= parameters, where |2= is a synonym for |page=. If |page= has no synonym, you should just write <<page>>, which will omit mention of any synonymous parameter.

You can also intersperse arbitrary text among the parameter references. For example, the documentation page Template:RQ:Taylor Holy Living/documentation contains the following:

{{quote-meta/paramdoc|1=
<<page:2>>

<blockquote>
Note that page 424 is misprinted as 376; specify {{para|page|424}} if quoting from this page.
</blockquote>

<<passage:3>>
<<trailing_params>>
}}

which generates:

---

• |2= or |page=, or |pages= – mandatory in some cases: the page number(s) quoted from. When quoting a range of pages, note the following:
  • Separate the first and last pages of the range with an en dash, like this: |pages=10–11.
  • You must also use |pageref= to indicate the page to be linked to (usually the page on which the Wiktionary entry appears).

This parameter must be specified to have the template link to the online version of the work.

Note that page 424 is misprinted as 376; specify |page=424 if quoting from this page.

• |3=, |text=, or |passage= – the passage to be quoted.
• |footer= – a comment on the passage quoted.
• |brackets= – use |brackets=on to surround a quotation with brackets. This indicates that the quotation either contains a mere mention of a term (for example, “some people find the word manoeuvre hard to spell”) rather than an actual use of it (for example, “we need to manoeuvre carefully to avoid causing upset”), or does not provide an actual instance of a term but provides information about related terms.

  ---

Another example with text interspersed among parameter references is found on Template:RQ:Austen Sense and Sensibility/documentation:

{{quote-meta/paramdoc|1=
<<roman_chapter:2>> The chapter numbers restart from I in each volume.
<<page:3>>
<<passage:4>>
<<trailing_params>>
}}

which generates:

---

• |2= or |chapter= – the chapter number quoted from in uppercase Roman numerals. The chapter numbers restart from I in each volume.
• |3= or |page=, or |pages= – mandatory in some cases: the page number(s) quoted from. When quoting a range of pages, note the following:
  • Separate the first and last pages of the range with an en dash, like this: |pages=10–11.
  • You must also use |pageref= to indicate the page to be linked to (usually the page on which the Wiktionary entry appears).

This parameter must be specified to have the template link to the online version of the work.

• |4=, |text=, or |passage= – the passage to be quoted.
• |footer= – a comment on the passage quoted.
• |brackets= – use |brackets=on to surround a quotation with brackets. This indicates that the quotation either contains a mere mention of a term (for example, “some people find the word manoeuvre hard to spell”) rather than an actual use of it (for example, “we need to manoeuvre carefully to avoid causing upset”), or does not provide an actual instance of a term but provides information about related terms.

  ---

Parameter references

The following parameter references are currently recognized:

• <<page>> Text for the |page=/|pages= params.
• <<page:PARAM>> Same as <<page>> but where |PARAM= is an additional synonym.
• <<page_with_roman_preface>> Text for the |page=/|pages= params where page numbers should be lowercase Roman numerals in the preface.
• <<page_with_roman_preface:PARAM>> Same as <<page_with_roman_preface>> but where |PARAM= is an additional synonym.
• <<chapter>> Text for the |chapter= param when a chapter name should be provided.
• <<chapter:PARAM>> Same as <<chapter>> but where |PARAM= is an additional synonym.
• <<roman_chapter>> Text for the |chapter= param when an uppercase Roman numeral chapter number should be provided.
• <<roman_chapter:PARAM>> Same as <<roman_chapter>> but where |PARAM= is an additional synonym.
• <<arabic_chapter>> Text for the |chapter= param when an Arabic numeral chapter number should be provided.
• <<arabic_chapter:PARAM>> Same as <<arabic_chapter>> but where |PARAM= is an additional synonym.
• <<passage>> Text for the |text=/|passage= params.
• <<passage:PARAM>> Same as <<passage>> but where |PARAM= is an additional synonym.
• <<trailing_params>> Text for additional params to mention at the end (currently |footer= and |brackets=).

See also

• Module:quote (implementation of this template)
• (underlying template used by many quotation templates)
• (module invocation syntax to simplify writing quotation templates)