Template:Gartenlaube

From Wikimedia Commons, the free media repository
Jump to navigation Jump to search
Template documentationview · edit · history · purge ]
This documentation is transcluded from Template:Gartenlaube/doc.

This template creates the book box for pages and illustrations of Die Gartenlaube.
Original versions of this template were written by Joergens.mi (talk · contribs).

Usage

{{Gartenlaube
 |year =
 |type =
 |page =
 |previous_page =
 |next_page =
 |is_first_page =
 |is_last_page =
 |source =
 |permission =
 |caption =
 |file_extension =
 |padding =
}}

Template parameters

ParameterDescriptionDefaultStatus
yearpublication yearThe year of publication.emptyrequired
typetype of fileWhether the file is a page or an illustration. Must be either of page or illustration.emptyrequired
pagepage numberThe page number of the current file (page or illustration). Includes the letter prefix if it exists (p 001 for example).emptyrequired
previous_pageprevious page numberThe page number of the previous page. Note that in some cases, page numbers can contain a letter (such as 438b for example. If unspecified, the previous page number will be computed from the page parameter.page - 1optional
next_pagenext page numberThe page number of the next page. Note that in some cases, page numbers can contain a letter (such as 438b for example. If unspecified, the previous page number will be computed from the page parameter.page + 1optional
is_first_pageis first pageWhether this is the first page of the book ("p 001" or "p 1" in most cases).0optional
is_last_pageis last pageWhether this is the last page of the book.0optional
sourcesourceOverride source defined in {{Gartenlaube/source}}.emptyoptional
permissionpermissionOverride source defined in {{Gartenlaube/permission}}.emptyoptional
captioncaptionThe caption of the illustration, if applicable.emptyoptional
file_extensioncaptionThe file extension of the files. By default it is 'jpg' and does not need to be specified. In some cases it can be 'JPG'.jpgoptional
paddingpaddingThe number of digits of the page numbers in the file names. In most cases it's 3, in rare occasions it's 4.3optional
Template data
<templatedata>JSON</templatedata> ./. {{TemplateBox}}
TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.


Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.


Wikipedia's help about TemplateDataCommons-specific information

This template creates the book box for pages and illustrations of [[:w:Die Gartenlaube|Die Gartenlaube]].<br><span style="font-weight:normal">Original versions of this template were written by [[:User:Joergens.mi|Joergens.mi]] ([[:User talk:Joergens.mi|talk]]<span style="white-space:nowrap">&nbsp;'''·'''</span> [[:Special:Contributions/Joergens.mi|contribs]]).</span>

Template parameters[Edit template data]

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
captioncaption

The caption of the illustration, if applicable.

Stringoptional
captionfile_extension

The file extension of the files. By default it is 'jpg' and does not need to be specified. In some cases it can be 'JPG'.

Default
jpg
Stringoptional
is first pageis_first_page

Whether this is the first page of the book ("p 001" or "p 1" in most cases).

Default
0
Booleanoptional
is last pageis_last_page

Whether this is the last page of the book.

Default
0
Booleanoptional
next page numbernext_page

The page number of the next page. Note that in some cases, page numbers can contain a letter (such as <code>438b</code> for example. If unspecified, the previous page number will be computed from the <code>page</code> parameter.

Default
<code>page</code> + 1
Stringoptional
paddingpadding

The number of digits of the page numbers in the file names. In most cases it's 3, in rare occasions it's 4.

Default
3
Numberoptional
page numberpage

The page number of the current file (page or illustration). Includes the letter prefix if it exists (<code>p 001</code> for example).

Stringrequired
permissionpermission

Override source defined in [[Template:Gartenlaube/permission|{{Gartenlaube/permission}}]].

Stringoptional
previous page numberprevious_page

The page number of the previous page. Note that in some cases, page numbers can contain a letter (such as <code>438b</code> for example. If unspecified, the previous page number will be computed from the <code>page</code> parameter.

Default
<code>page</code> - 1
Stringoptional
sourcesource

Override source defined in [[Template:Gartenlaube/source|{{Gartenlaube/source}}]].

Stringoptional
type of filetype

Whether the file is a page or an illustration. Must be either of <code>page</code> or <code>illustration</code>.

Stringrequired
publication yearyear

The year of publication.

Numberrequired

Additional information

The template is intended to be used in the following namespaces: the File namespace

The template is intended to be used by the following user groups: all users

Placement: At the top of the page

Relies on: