Templates download/Image cards: Difference between revisions

(Created page with "<div class="downloadarea"> <span class="getButton">Download</span> 450x450px|link=Special:FilePath/banner-example.png </di...")
 
No edit summary
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
<div class="downloadarea">
<div class="downloadarea">
<span class="getButton">[[Media:HW-banner.zip|Download]]</span>
<span class="getButton">[[Media:HW-ImageCards.zip|Download]]</span>


[[File:banner-example.png|450x450px|link=Special:FilePath/banner-example.png]]
[[File:Image cards large.png|450x450px|alt=large image cards example]]
</div>This template creates a page banner that you can include on portal pages, for example. You can see an example here in the Helpdesk on the page [[Community]].
</div>This template creates a set of images that is useful for linking to wiki pages.
==Importing the template==
== Importing the template==
The import file is included in the archive file ''HW-banner.zip''. Unpack the zip file first.
The import file is included in the archive file ''HW-IamgeCards.zip''. Unpack the zip file first.


On the page ''Special:Import'' follow these steps:
On the page ''Special:Import'' follow these steps:
#'''Select file''' and choose ''HW-banner.xml''.
#'''Select file''' and choose ''HW-ImageCards.xml''.
#'''Enter''' an Interwiki prefix. Since this field is required, simply add ''hw'' (for hallowelt).
#'''Enter''' an Interwiki prefix. Since this field is required, simply add ''hw'' (for hallowelt).
#'''Keep''' the selection ''Import to default locations''.
#'''Keep''' the selection ''Import to default locations''.
Line 17: Line 17:
The xml import creates the following files in your wiki:
The xml import creates the following files in your wiki:


*Template:Banner
*Template:Image_cards
*Template:Banner/styles.css
*Template:Image_cards/start
*Template:Image_cards/end
*Template:Image_cards/styles.css


==Creating a banner==
==Adding image cards to a page ==


#From the Visual Editor ''Insert > Template'' menu, add the template "Banner". <br />[[File:step4.png|thumb|Inserting the template through VisualEditor|462x462px|alt=Inserting the template through VisualEditor|center]]
===General considerations ===
#Click on the inserted template to view the available parameters for formatting the look of the banner.<br />


[[File:step5.png|thumb|center|450x450px|alt=Available banner settings|Available banner settings]]
*'''Start and end templates:''' Each card set needs the '''start''' template (Image cards/start) and the '''end''' template (Image cards/end). Make sure to add the end template right after the last image card without a line-break. If you have a line break, you will see some unnecessary space after the last card.
*'''Card sizes:''' You can choose between ''medium'' (''standard)'', ''small'' and ''large'' image cards.  By default, standard cards are shown.
*'''Images or icons:''' You can choose to create image cards or icon cards. Icon cards are only available in the sizes ''small'' and ''medium.''  If you want to uses images, you need to upload them to your wiki first.


{{Messagebox|boxtype=important|Note text=The settings only take effect after you save the page if you have just inserted the banner template on your page.}}
<span><span /><span /><span /><span /><span /><br /></span>
[[Templates download/Image cards#Available settings|See below for a complete list of available settings (template parameters).]]


===Image cards===
The easiest way to add card is to choose a starting layout from the examples provided on this page. Simply copy and paste the example code in source-editing mode into your page.


All settings for the banner are optional. This means that a box can  be generated without image, heading, or text.
{{Messagebox|boxtype=important|icon=|Note text=Always paste any code using plaintext - '''<code>Ctrl+Shift+v</code>''' - in your wiki in source editing mode to avoid creating unnecessary tags which will break the view.|bgcolor=}}


==Example settings ==
====Standard-sized image cards====
[[File:hw-banner-vorlage.png|center|thumb|650x650px|Banner settings|link=Special:FilePath/hw-banner-vorlage.png]]
[[File:Image cards standard.png|alt=Standard-sized cards|center|thumb|950x950px|Standard-sized cards]]
{| class="wikitable" style="width:950px;"
 
|+ style="box-sizing: inherit; padding-top: 8px; padding-bottom: 8px; color: rgb(119, 119, 119); text-align: left; font-weight: bold;" |
<span><span /><span /><span /><span /><span /><span /><br /></span>
! style="background-color:rgb(234, 236, 240);text-align:center;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |
 
! style="background-color:rgb(234, 236, 240);text-align:center;width:200px;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Element
'''Code to copy:'''
! style="background-color:rgb(234, 236, 240);text-align:center;width:180px;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Value
 
! style="background-color:rgb(234, 236, 240);text-align:center;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Description
(Replace the file names for ''imgname='' with the correct file names from your wiki )<syntaxhighlight lang="text">
{{Image cards/start|cardsize=}}
{{Image cards|imgname=yourimage1.jpg|label=London|imglink=https://google.de|alt=office in London headquarters}}
{{Image cards|imgname=yourimage2.jpg|label=Helsinki|imglink=http://google.de|alt=}}
{{Image cards|imgname=yourimage3.jpg|label=Madrid|imglink=Main Page|alt=}}
{{Image cards|imgname=yourimage4.jpg|label=Hamburg|imglink=Main Page|alt=}}
{{Image cards|imgname=yourimage5.jpg|label=Regensburg|imglink=|alt=}}{{Image cards/end}}
</syntaxhighlight>
 
====Large image cards====
[[File:Image cards large.png|alt=Large image cards|center|thumb|850x850px|Large image cards]]
 
<span><span /><span /><span /><br /></span>
Code to copy:
 
(Replace the file names for ''imgname='' with the correct file names from your wiki )
<syntaxhighlight lang="text">
{{Image cards/start|cardsize=large|flexwrap=wrap}}
{{Image cards|imgname=yourimage1.jpg|label=Sales & Marketing|imglink=Main Page}}
{{Image cards|imgname=yourimage2.jpg|label=IT Admin|imglink=Main Page}}
{{Image cards|imgname=yourimage3.jpg|label=Development|imglink=Main Page}}
{{Image cards|imgname=yourimage4.jpg|label=Tech Support|imglink=Main Page}}
{{Image cards|imgname=yourimage5.jpg|label=Accounting|imglink=Main Page}}
{{Image cards|imgname=yourimage6.jpg|label=Management|imglink=Main Page}}{{Image cards/end}}
</syntaxhighlight>
[[File:Image cards bootstrap icons.png|alt=Bootstrap icon name|thumb|Bootstrap icon name]]
 
===Icon cards===
Supported icons:
 
* [https://icons.getbootstrap.com/ Bootstrap icons]: Syntax is: ''bi bi-gear''
* [https://fontawesome.com/v6/search Font Awesome up to 6.2.1]{{Bsvs|bsvFrom=4.3|bsvTo=|bsvFeature=}}: ''fa-solid fa-house'' (v. 6) or ''fas fa-wrench'' (v.5)
 
{{Messagebox|boxtype=important|icon=|Note text=BlueSpice does not always include the latest version of bootstrap icons. [https://en.wiki.bluespice.com/w/skins/BlueSpiceDiscovery/resources/bootstrap/icons/index.html See the list of currently supported icons.]|bgcolor=}}<span><span /><span /><span /><span /></span>
 
[[File:Image cards icons.png|alt=Icon cards|center|thumb|950x950px|Icon cards]]
 
<span><span /><span /><span /><span /><br /></span>
Code to copy:
 
(Replace the file names for ''imgname='' with the correct file names from your wiki )<syntaxhighlight lang="text">
{{Image cards/start|cardsize=}}
{{Image cards|iconname=bi bi-gear|iconcolor=Tomato|label=Processes|imglink=Main Page|alt=}}
{{Image cards|iconname=bi bi-lightbulb|label=How-to's|imglink=Main Page|alt=}}
{{Image cards|iconname=bi bi-eyeglasses|label=Knowledge base|imglink=https://google.de|alt=}}
{{Image cards|iconname=bi bi-signpost|label=Directories|imglink=Main Page|alt=}}
{{Image cards|iconname=bi bi-geo-alt|label=Locations|imglink=|alt=}}{{Image cards/end}}
</syntaxhighlight>
==Available settings==
 
===Template:Image_cards/start===
{| class="wikitable" style="width:100%;"
! style="background-color:rgb(234, 236, 240);text-align:center;width:200px;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" class="" |Parameter
! style="background-color:rgb(234, 236, 240);text-align:center;width:180px;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" class="" |Value
! style="background-color:rgb(234, 236, 240);text-align:center;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" class="" | Description
|- style="box-sizing: inherit;"
|- style="box-sizing: inherit;"
| rowspan="3" style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |1
| style="width:200px;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |cardsize
| style="width:200px;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Banner image
| style="width:180px;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |
| style="width:180px;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |QM:Flower_white.jpg
* medium (can stay empty, it is the default)
| style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Image name (with namespace prefix, if it exists, but without the ''File:'' prefix). The banner  image is optional.
* small
|- style="box-sizing: inherit;"
* large
| style="width:200px;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Image width
| style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Sets the size of the individual cards
| style="width:180px;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |200
|-
| style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Number. The width will automatically be used as pixel-value. Default value: ''200''
| rowspan="2" |justifycontent
|- style="box-sizing: inherit;"
|
| style="width:200px;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Image alignment
* space-between (default)
| style="width:180px;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |left, right
|Spreads the cards out evenly in the available space
| style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Shows the imag to the left or right. Default value: ''left''.
 
|- style="box-sizing: inherit;"
 
| rowspan="3" style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |2
If the number of cards causes a line break  and you don't want to switch from "space-between" to "flex-start", you can insert additional blank placeholder cards that "push" the cards in the second row to the left. You have to test the number of required placeholders. Here, 2 placeholders would be generated:<syntaxhighlight lang="text">
| style="width:200px;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Heading
{{Image cards|class=placeholder}}
| style="width:180px;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Meine Überschrift
{{Image cards|class=placeholder}}
| style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Heading text
</syntaxhighlight>
|- style="box-sizing: inherit;"
|-
| style="width:200px;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Heading size
|
| style="width:180px;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |1.6em
* flex-start
| style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Size can also be entered as 16px or any other css size value. Default value: ''1.6em''.
|If there is a wrap to another line, the cards are left-aligned
|- style="box-sizing: inherit;"
|-
| style="width:200px;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Heading color
|flexwrap
| style="width:180px;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |#444444
|
| style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Color as [https://www.w3schools.com/colors/colors_picker.asp hex value].
* nowrap (default)
|- style="box-sizing: inherit;"
|Cards get smaller if many images are added to avoid wrapping
| rowspan="3" style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |3
|-
| style="width:200px;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Text
|flexwrap
| style="width:180px;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Das ist der Inhalt.
|
| style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Text of the  box.
* wrap
|- style="box-sizing: inherit;"
|Cards keep their original size. Images that don't fit on the first row will move to the next row.  
| style="width:200px;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Text size
This setting should be used with cardsize=large.
| style="width:180px;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |1.2em
|}
| style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |''see Heading size''
 
|- style="box-sizing: inherit;"
===Template:Image_cards===
| style="width:200px;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Text color
{| class="wikitable" style="width:100%;"
| style="width:180px;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |#444444
! style="background-color:rgb(234, 236, 240);text-align:center;width:200px;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" class="" |Parameter
| style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |''see Heading color''
! style="background-color:rgb(234, 236, 240);text-align:center;width:180px;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" class="" |Value
|- style="box-sizing: inherit;"
! style="background-color:rgb(234, 236, 240);text-align:center;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" class="" |Description
| style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |4
|-
| style="width:200px;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Content padding
| style="width:200px;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |imgname
| style="width:180px;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |20px
| style="width:180px;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |e.g.:
| style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Distance of the title/text area to the box and the image. Default value:''10px.''
 
|- style="box-sizing: inherit;"
myimage.jpg, myimage.png
| style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |5
| style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Name of the image without a namespace prefix.
| style="width:200px;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Padding of the container box
 
| style="width:180px;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |10px
It needs to be blank or not present if icons are used instead of images.
| style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Padding of the box itself. Default value: ''0.''
|-
|- style="box-sizing: inherit;"
|label
| style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |6
|e.g.:  
| style="width:200px;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Background color
London
| style="width:180px;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |#efefef
|Label that is shown under the image/icon.
| style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |<span>Color as</span> [https://www.w3schools.com/colors/colors_picker.asp hex value] <span>. Default value</span> ''#efefef'' (a light grey)
|-
|imglink
|e.g.:
Main_Page
 
Help:Main_Page
 
<nowiki>https://google.com</nowiki>
|Link to a wiki page or a website.
The link is optional.
|-
|alt
|e.g.:
office in London headquarters
|Provided for assistive technologies of users who cannot see the image.
This is not necessary when using icons, since icons are loaded as background images only.
|-
|iconname
|e.g.:
bi bi-lightbulb
|Used instead of imgname if icons are used as a visual.
|-
|iconcolor
|e.g.:
Tomato,
 
<nowiki>#</nowiki>607d8b
|HTML-color value. This includes [https://www.w3schools.com/colors/colors_names.asp color names] or generally [https://www.w3schools.com/colors/colors_schemes.asp HEX-values].
|}
|}
<br />
__NOTOC__

Latest revision as of 10:35, 11 May 2023

This template creates a set of images that is useful for linking to wiki pages.

Importing the template

The import file is included in the archive file HW-IamgeCards.zip. Unpack the zip file first.

On the page Special:Import follow these steps:

  1. Select file and choose HW-ImageCards.xml.
  2. Enter an Interwiki prefix. Since this field is required, simply add hw (for hallowelt).
  3. Keep the selection Import to default locations.
  4. Click Upload file...

The template is now available in your wiki.

Pages included in the import

The xml import creates the following files in your wiki:

  • Template:Image_cards
  • Template:Image_cards/start
  • Template:Image_cards/end
  • Template:Image_cards/styles.css

Adding image cards to a page

General considerations

  • Start and end templates: Each card set needs the start template (Image cards/start) and the end template (Image cards/end). Make sure to add the end template right after the last image card without a line-break. If you have a line break, you will see some unnecessary space after the last card.
  • Card sizes: You can choose between medium (standard), small and large image cards. By default, standard cards are shown.
  • Images or icons: You can choose to create image cards or icon cards. Icon cards are only available in the sizes small and medium. If you want to uses images, you need to upload them to your wiki first.


See below for a complete list of available settings (template parameters).

Image cards

The easiest way to add card is to choose a starting layout from the examples provided on this page. Simply copy and paste the example code in source-editing mode into your page.

Important!Always paste any code using plaintext - Ctrl+Shift+v - in your wiki in source editing mode to avoid creating unnecessary tags which will break the view.


Standard-sized image cards

Standard-sized cards
Standard-sized cards


Code to copy:

(Replace the file names for imgname= with the correct file names from your wiki )

{{Image cards/start|cardsize=}}
{{Image cards|imgname=yourimage1.jpg|label=London|imglink=https://google.de|alt=office in London headquarters}}
{{Image cards|imgname=yourimage2.jpg|label=Helsinki|imglink=http://google.de|alt=}}
{{Image cards|imgname=yourimage3.jpg|label=Madrid|imglink=Main Page|alt=}}
{{Image cards|imgname=yourimage4.jpg|label=Hamburg|imglink=Main Page|alt=}}
{{Image cards|imgname=yourimage5.jpg|label=Regensburg|imglink=|alt=}}{{Image cards/end}}

Large image cards

Large image cards
Large image cards


Code to copy:

(Replace the file names for imgname= with the correct file names from your wiki )

{{Image cards/start|cardsize=large|flexwrap=wrap}}
{{Image cards|imgname=yourimage1.jpg|label=Sales & Marketing|imglink=Main Page}}
{{Image cards|imgname=yourimage2.jpg|label=IT Admin|imglink=Main Page}}
{{Image cards|imgname=yourimage3.jpg|label=Development|imglink=Main Page}}
{{Image cards|imgname=yourimage4.jpg|label=Tech Support|imglink=Main Page}}
{{Image cards|imgname=yourimage5.jpg|label=Accounting|imglink=Main Page}}
{{Image cards|imgname=yourimage6.jpg|label=Management|imglink=Main Page}}{{Image cards/end}}
Bootstrap icon name
Bootstrap icon name

Icon cards

Supported icons:

  • Bootstrap icons: Syntax is: bi bi-gear
  • Font Awesome up to 6.2.1  v4.3+: fa-solid fa-house (v. 6) or fas fa-wrench (v.5)
Important!BlueSpice does not always include the latest version of bootstrap icons. See the list of currently supported icons.

Icon cards
Icon cards


Code to copy:

(Replace the file names for imgname= with the correct file names from your wiki )

{{Image cards/start|cardsize=}}
{{Image cards|iconname=bi bi-gear|iconcolor=Tomato|label=Processes|imglink=Main Page|alt=}}
{{Image cards|iconname=bi bi-lightbulb|label=How-to's|imglink=Main Page|alt=}}
{{Image cards|iconname=bi bi-eyeglasses|label=Knowledge base|imglink=https://google.de|alt=}}
{{Image cards|iconname=bi bi-signpost|label=Directories|imglink=Main Page|alt=}}
{{Image cards|iconname=bi bi-geo-alt|label=Locations|imglink=|alt=}}{{Image cards/end}}

Available settings

Template:Image_cards/start

Parameter Value Description
cardsize
  • medium (can stay empty, it is the default)
  • small
  • large
Sets the size of the individual cards
justifycontent
  • space-between (default)
Spreads the cards out evenly in the available space


If the number of cards causes a line break and you don't want to switch from "space-between" to "flex-start", you can insert additional blank placeholder cards that "push" the cards in the second row to the left. You have to test the number of required placeholders. Here, 2 placeholders would be generated:
{{Image cards|class=placeholder}}
{{Image cards|class=placeholder}}
  • flex-start
If there is a wrap to another line, the cards are left-aligned
flexwrap
  • nowrap (default)
Cards get smaller if many images are added to avoid wrapping
flexwrap
  • wrap
Cards keep their original size. Images that don't fit on the first row will move to the next row.

This setting should be used with cardsize=large.

Template:Image_cards

Parameter Value Description
imgname e.g.:

myimage.jpg, myimage.png

Name of the image without a namespace prefix.

It needs to be blank or not present if icons are used instead of images.

label e.g.:

London

Label that is shown under the image/icon.
imglink e.g.:

Main_Page

Help:Main_Page

https://google.com

Link to a wiki page or a website.

The link is optional.

alt e.g.:

office in London headquarters

Provided for assistive technologies of users who cannot see the image.

This is not necessary when using icons, since icons are loaded as background images only.

iconname e.g.:

bi bi-lightbulb

Used instead of imgname if icons are used as a visual.
iconcolor e.g.:

Tomato,

#607d8b

HTML-color value. This includes color names or generally HEX-values.



To submit feedback about this documentation, visit our community forum.

No categories assignedEdit

Discussions