Template:BSExtensionInfobox and Manual:Displaying page sections as cards: Difference between pages

(Difference between pages)
No edit summary
Tag: 2017 source edit
 
No edit summary
 
Line 1: Line 1:
<noinclude>This is the "BSExtensionInfobox" template. Used mainly for MediaWiki extensions, but also for BlueSpice extensions that don't have a page in the AutoDoc namespace. For AutoDoc extensions, use the template BSExtensionInfo.
{{Featurepage|featured=true|featuredesc=How-to: Display page sections as cards|featurestart=03/21/2022}}
It should be called in the following format:
Sections of a wiki page can be displayed as  "cards" with just a little bit of effort.  


<pre>{{BSExtensionInfobox
== What are cards? ==
|desc=
Cards are combinations of contiguous page sections that share the same column layout. Each wiki page can contain such cards.
|status=
<gallery widths="480" heights="250">
|developer=
File:Manual:karten-before.png|alt=Wiki page without cards|Wiki page without cards
|type=
File:Manual:karten-after.png|alt=Wiki page with cards|Wiki page with cards
|compatible=
</gallery>
|edition=
|category=
|active=
|license=
|docu=
}}
</pre>


Edit the page to see the template text.
== Create card styles ==
</noinclude><includeonly>{{#default_form:BSExtensionInfoboxForm}}
Before sections can be formatted as cards, a user with admin rights must add and save the following information to the page ''MediaWiki:Common.css'':
<h1>{{#switch: {{PAGENAME}}|BlueSpiceDiscovery|BlueSpiceCalumma|Chameleon=Skin:{{PAGENAME}}|Extension: {{PAGENAME}} }}</h1>
<syntaxhighlight lang="css">
<br />
/* Styles for section cards */
<i class="bi bi-arrow-right-circle"></i> [[:Category:Extension|all extensions]]
.sectionflex {display: flex; flex-wrap: wrap; justify-content:space-between;}
{| class="extension-infobox  fullwidth"
.sectionflex.col1 > div {flex-basis:100%; padding:10px 20px 20px 20px; margin:10px 0;}
|-
.sectionflex.col2 > div {flex-basis:49%; padding:10px 20px 20px 20px; margin:10px 0;}
!class="extension-infobox-header" colspan="4"|Overview
.sectionflex.col3 > div {flex-basis:32%; padding:10px 20px 20px 20px; margin:10px 0;}
|-
.sectionflex > div h2 {margin:0 0 1em 0; font-size:1.3em}
! Description:
.sectionflex.frame > div {border: 1px solid #e7e7e7}
|colspan="3" | [[BSExtensionInfoDescription::{{{desc|}}}]]
.sectionflex.background> div {background: #f1f3f9}
|-
.sectionflex .ve-ce-branchNode-slug, .sectionflex  span.mw-editsection {display:none}
! State:
@media (max-width: 767px) {.sectionflex.col2 > div, .sectionflex.col3 > div {flex-basis:100%; margin-top:2em}}
| [[BSExtensionInfoStatus::{{{status|}}}]]
! Dependency:
| {{#arraymap:{{{compatible|}}}|,|y|[[BSExtensionInfoCompatible::y]]}}
|-
! Developer:
| {{#arraymap:{{{developer|}}}|,|y|[[BSExtensionInfoDeveloper::y]]}}
! License:
| [[BSExtensionInfoLicense::{{{license|-}}}]]
|-
! Type:
| {{#if:{{{docu|}}}|[{{{docu|}}} {{{type|}}}]|{{{type|}}}}} {{#set:BSExtensionInfoType={{{type|}}}}}
! Category:
| {{#arraymap:{{{category|-}}}|,|z|[[BSExtensionInfoCategory::z]]}}
|-
! Edition:
| colspan="3"|{{#arraymap:{{{edition|}}}|,|@@|[[BSExtensionInfoEdition::@@]]}}
|-
!class="extension-infobox-helppage" colspan="4"|{{#ifexist: Manual:Extension/{{PAGENAME}} | <div class="questionmark-icon"> '''[[Manual:Extension/{{PAGENAME}}|View help page]]'''</div>|{{#if: {{{docu|}}}|For more info, visit '''[{{{docu|}}} Mediawiki].'''|}} }}
|}
<div id="importdata">
{{#if: {{{features|}}}|==Features==
{{{features}}}|}}


{{wcagCheck}}
</syntaxhighlight>
 
== Create cards ==
To format sections as cards:
 
# '''Create''' a page that contains different sections. Sections are marked by headings.
# '''Open''' the page in source editing mode.
# '''Add''' the start of a card container as <code><nowiki><div class="sectionflex col2 background"></nowiki></code> above the first section you want to include in the card display (i.e., above the first heading of that section). A heading starts with two equal (=) signs:<syntaxhighlight lang="text">
<div class="sectionflex col2 background">
==Introduction==
With more than 165,000 inhabitants, Regensburg is the fourth-largest city in the State of Bavaria after Munich, Nuremberg and Augsburg.
</syntaxhighlight>
# '''Wrap''' all sections that you want to include in this card layout in a starting <code><nowiki><div></nowiki></code> and an end <code><nowiki></div></nowiki></code> tag:<syntaxhighlight lang="text">
<div class="sectionflex col2 background">
<div>
==Introduction==
With more than 165,000 inhabitants, Regensburg is the fourth-largest city in the State of Bavaria after Munich, Nuremberg and Augsburg.(...)
</div>
<div>
==Topography==
Regensburg is situated on the northernmost part of the Danube river at the geological crossroads of four distinct landscapes (...)
</div>
</syntaxhighlight>
# '''Close''' the sectionflex container itself with an end <code><nowiki></div></nowiki></code> tag:<syntaxhighlight lang="text">
<div class="sectionflex col2 background"> <! --- Start card layout-->
<div> <! --- Start card -->
==Introduction==
With more than 165,000 inhabitants, Regensburg is the fourth-largest city in the State of Bavaria after Munich, Nuremberg and Augsburg.(...)
</div> <! --- End card -->
<div> <! --- Start card -->
==Topography==
Regensburg is situated on the northernmost part of the Danube river at the geological crossroads of four distinct landscapes (...)
</div> <! --- End card -->
</div>  <! --- End card layout -->
</syntaxhighlight>
The two sections should now be displayed as cards:
[[File:Manual:karten-after.png|alt=Two sections in the card layout|center|thumb|750x750px|Two sections in the card layout: <code><nowiki><div class="sectionflex col2 background"></nowiki></code>]]
 
== Available card formats ==
You can choose between 1-column ("col1"),  2-column ("col2") or 3-column ("col3") cards with grey background ("background") or grey frame ("frame"). For example:
 
[[File:Manual:karten-col3-frame.png|alt=3-column layout with frame|center|thumb|750x750px|3 columns with frame:  <code><nowiki><div class="sectionflex col3 frame"></nowiki></code>]]
 
== Combination of cards ==
It is possible to combine different card layouts on one wiki page:
<syntaxhighlight lang="css">
<div class="sectionflex col2 frame">
<div>
==Section 1==
Content section 1
</div>
<div>
==Section 2==
Content section 1
</div>
</div>
 
<div class="sectionflex col3 background">
<div>
==Section 3==
Content section 3
</div>
<div>
==Section 4==
Content section 4
</div>
<div>
==Section 5==
Content section 5
</div>
</div>
</div>
__NOTOC__
 
__HIDETITLE__
 
[[Category:Extension]]{{Translation}}</includeonly>
</syntaxhighlight>
[[en:{{FULLPAGENAME}}]]
[[de:Handbuch:Seitenabschnitte_als_Karten_darstellen]]
[[Category:Customization]]
[[Category:Portal]]

Revision as of 15:09, 15 September 2022

Sections of a wiki page can be displayed as "cards" with just a little bit of effort.

What are cards?

Cards are combinations of contiguous page sections that share the same column layout. Each wiki page can contain such cards.

Create card styles

Before sections can be formatted as cards, a user with admin rights must add and save the following information to the page MediaWiki:Common.css:

/* Styles for section cards */
.sectionflex {display: flex; flex-wrap: wrap; justify-content:space-between;}
.sectionflex.col1 > div {flex-basis:100%; padding:10px 20px 20px 20px; margin:10px 0;}
.sectionflex.col2 > div {flex-basis:49%; padding:10px 20px 20px 20px; margin:10px 0;}
.sectionflex.col3 > div {flex-basis:32%; padding:10px 20px 20px 20px; margin:10px 0;}
.sectionflex > div h2 {margin:0 0 1em 0; font-size:1.3em}
.sectionflex.frame > div {border: 1px solid #e7e7e7}
.sectionflex.background> div {background: #f1f3f9}
.sectionflex .ve-ce-branchNode-slug, .sectionflex  span.mw-editsection {display:none}
@media (max-width: 767px) {.sectionflex.col2 > div, .sectionflex.col3 > div {flex-basis:100%; margin-top:2em}}

Create cards

To format sections as cards:

  1. Create a page that contains different sections. Sections are marked by headings.
  2. Open the page in source editing mode.
  3. Add the start of a card container as <div class="sectionflex col2 background"> above the first section you want to include in the card display (i.e., above the first heading of that section). A heading starts with two equal (=) signs:
    <div class="sectionflex col2 background">
    ==Introduction==
    With more than 165,000 inhabitants, Regensburg is the fourth-largest city in the State of Bavaria after Munich, Nuremberg and Augsburg.
    
  4. Wrap all sections that you want to include in this card layout in a starting <div> and an end </div> tag:
    <div class="sectionflex col2 background">
    <div>
    ==Introduction==
    With more than 165,000 inhabitants, Regensburg is the fourth-largest city in the State of Bavaria after Munich, Nuremberg and Augsburg.(...)
    </div>
    <div>
    ==Topography==
    Regensburg is situated on the northernmost part of the Danube river at the geological crossroads of four distinct landscapes (...)
    </div>
    
  5. Close the sectionflex container itself with an end </div> tag:
    <div class="sectionflex col2 background"> <! --- Start card layout-->
    <div> <! --- Start card -->
    ==Introduction==
    With more than 165,000 inhabitants, Regensburg is the fourth-largest city in the State of Bavaria after Munich, Nuremberg and Augsburg.(...)
    </div> <! --- End card -->
    <div> <! --- Start card -->
    ==Topography==
    Regensburg is situated on the northernmost part of the Danube river at the geological crossroads of four distinct landscapes (...)
    </div> <! --- End card -->
    </div>  <! --- End card layout -->
    

The two sections should now be displayed as cards:

Two sections in the card layout
Two sections in the card layout: <div class="sectionflex col2 background">

Available card formats

You can choose between 1-column ("col1"), 2-column ("col2") or 3-column ("col3") cards with grey background ("background") or grey frame ("frame"). For example:

3-column layout with frame
3 columns with frame: <div class="sectionflex col3 frame">

Combination of cards

It is possible to combine different card layouts on one wiki page:

<div class="sectionflex col2 frame">
<div>
==Section 1==
Content section 1
</div>
<div>
==Section 2==
Content section 1
</div>
</div>

<div class="sectionflex col3 background">
<div>
==Section 3==
Content section 3
</div>
<div>
==Section 4==
Content section 4
</div>
<div>
==Section 5==
Content section 5
</div>
</div>

Discussions