Difference between revisions of "Template:Portal image banner/doc"
Jump to navigation
Jump to search
test>FR30799386 (→Parameters: ....) |
m (27 revisions imported) |
||
| (4 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| + | {{documentation subpage}} | ||
{{Uses TemplateStyles|Template:Portal image banner/styles.css}} | {{Uses TemplateStyles|Template:Portal image banner/styles.css}} | ||
{{Template rating|beta}} | {{Template rating|beta}} | ||
| Line 14: | Line 15: | ||
<pre> | <pre> | ||
{{Portal image banner | {{Portal image banner | ||
| − | |||
| first image | first caption | | first image | first caption | ||
| second image | second caption | | second image | second caption | ||
| Line 21: | Line 21: | ||
| overflow= | | overflow= | ||
| link= | | link= | ||
| − | |mode= | + | | mode= |
}} | }} | ||
</pre> | </pre> | ||
| Line 31: | Line 31: | ||
:Caption for the file. | :Caption for the file. | ||
;{{para|maxheight}} | ;{{para|maxheight}} | ||
| − | :Specifies the maximum height for the container of the image. '''It is recommend that the overflow parameter be defined when this parameter is used.''' | + | :Specifies the maximum height for the container of the image, using pixels (e.g. 300px). '''It is recommend that the overflow parameter be defined when this parameter is used.''' |
;{{para|overflow}} | ;{{para|overflow}} | ||
:Only needed when maximum height is declared. The parameter defines the behavior of the image when it becomes bigger than max-height. This parameter corresponds to the [https://www.w3schools.com/cssref/pr_pos_overflow.asp css overflow property]. The following options are available : | :Only needed when maximum height is declared. The parameter defines the behavior of the image when it becomes bigger than max-height. This parameter corresponds to the [https://www.w3schools.com/cssref/pr_pos_overflow.asp css overflow property]. The following options are available : | ||
| Line 40: | Line 40: | ||
;{{para|link}} | ;{{para|link}} | ||
:specifies the |link= parameter for the files. | :specifies the |link= parameter for the files. | ||
| + | ;{{Para|croptop}} | ||
| + | :Allows you to crop the image from the top. It should only be a numerical value which represents the percentage of the image to be cropped. | ||
;{{para|mode}} | ;{{para|mode}} | ||
:When set to '''slideshow''', creates a user selectable slideshow to cycle through all available panorama images. | :When set to '''slideshow''', creates a user selectable slideshow to cycle through all available panorama images. | ||
| − | {{Red|Note : This feature is still in alpha.}} | + | :{{Red|Note : This feature is still in alpha.}} |
| + | |||
==Demonstration {{Purge|Purge to see the other banners}}== | ==Demonstration {{Purge|Purge to see the other banners}}== | ||
{{Portal image banner | {{Portal image banner | ||
Latest revision as of 16:38, 8 September 2020
| 40px | This is a documentation subpage for Template:Portal image banner. It contains usage information, categories and other content that is not part of the original template page. |
Script error: No such module "Uses TemplateStyles". Template:Template rating
| 30px | This template uses Lua: |
As many images and captions as desired may be specified, with an option to set a slideshow mode to cycle through all images, in the following format:
{{Portal image banner
| first image | first caption
| second image | second caption
| third image | third caption
}}
Full set of parameters:
{{Portal image banner
| first image | first caption
| second image | second caption
| third image | third caption
| max-height=
| overflow=
| link=
| mode=
}}
Contents
Parameters
|1=,|3=,|5=, ... (or equivalent positional parameters)- File name. The "File:" prefix is optional.
|2=,|4=,|6=, ... (or equivalent positional parameters)- Caption for the file.
|maxheight=- Specifies the maximum height for the container of the image, using pixels (e.g. 300px). It is recommend that the overflow parameter be defined when this parameter is used.
|overflow=- Only needed when maximum height is declared. The parameter defines the behavior of the image when it becomes bigger than max-height. This parameter corresponds to the css overflow property. The following options are available :
- scroll - The rest of the image becomes visible when the picture is scrolled downwards
- Hidden - Hides the rest of the image
- auto - Displays it anyway.
- inherit - The overflow property acquires the value of its parent container.
|link=- specifies the |link= parameter for the files.
|croptop=- Allows you to crop the image from the top. It should only be a numerical value which represents the percentage of the image to be cropped.
|mode=- When set to slideshow, creates a user selectable slideshow to cycle through all available panorama images.
- Note : This feature is still in alpha.
Demonstration Script error: No such module "Purge".
Kolkata, in India