Manual:Extension/FlexiSkin and AutoDoc:BlueSpiceEchoConnector: Difference between pages

(Difference between pages)
No edit summary
Tag: 2017 source edit
 
m (1 revision imported)
 
Line 1: Line 1:
<bookshelf src="Book:Admin manual" />
==DescriptionMsg==
{{DISPLAYTITLE:Customizing the user interface (FlexiSkin)}}
{{AutoDocDescriptionMsg
 
|name = BlueSpiceEchoConnector
== Access ==
|desc = {{int:bs-echoconnector-extension-description
 
}}
You can access the special page (''Special:FlexiSkin)'' for customizing the skin from the ''Global actions'' menu:
}}
 
==License==
''{{Icon|bi bi-gear-fill|||middle}} (Global actions) > Management > Skin''
{{AutoDocLicense
 
|name = GPL-3.0-only
The page allows you to customize the logo, favicon, colors and font settings of the wiki. To edit the page, you need ''admin-''rights in the wiki.
}}
 
==Requirements==
[[File:FlexiSkin link.png|alt=Link for customizing the skin|center|thumb|500x500px|Link for customizing the skin]]
{{AutoDocRequirements
 
|mediawiki = {{AutoDocVersion
<span><br /></span>
|name = MediaWiki
 
|version = 1.38.0
{{Messagebox|boxtype=important|icon=|Note text=If you don't see the changes in the wiki after saving your settings, you need to clear your browser cache (<code>Ctrl</code>)+ (<code>F5</code>).|bgcolor=}}
}}
 
|extensions = {{AutoDocVersion
==Logo and Favicon ==
|name = BlueSpiceFoundation
 
|version = 4.1
===Logo===
}}
'''To upload your logo:'''
{{AutoDocVersion
 
|name = Echo
#'''Click''' ''Select a file'' <span style="color: rgb(51, 51, 51)">to choose a file from your file explorer</span> '''or drag the file''' <span style="color: rgb(51, 51, 51)">into the dotted area of the Logo upload area.</span>[[File:Manual:logo-upload-dialog.png|alt=Upload a logo|center|thumb|140x140px|Upload a logo]]
|version =
#'''Click''' the ''Preview'' button on the page and check the placement of the logo.
#'''Click''' ''Save & activate''. The logo is now visible for all users.
 
To use  '''a different logo''', click the  "x" symbol in the upload area of the logo and repeat the steps above.
 
===Favicon===
<span style="color: rgb(51, 51, 51)">The favicon is the image that is shown in the browser tabs. Follow the</span> [[Manual:Extension/FlexiSkin#Logo|steps for uploading a logo]]<span style="color: rgb(51, 51, 51)">, just use the favicon upload area instead.</span>
 
==Layout colors==
Here you can adjust the colors of the individual layout areas. 
[[File:Manual:flexi-main-annotiert-EN.png|alt=Flexiskin layout colors|center|thumb|650x650px|Flexiskin layout colors]] 
 
*'''Header color (3):''' Color settings for the header bar. These colors also apply to the mega menus.[[File:Manual:flexi-headers-EN.png|alt=Mega menu|center|thumb|650x650px|Mega menu]]
*'''Sidebar colors (4):''' Color settings for the main navigation and the page tools.
*'''Footer colors (5):''' Color settings for the footer.<span /><span /><br />
The following options to enter a color value are available:
 
*'''Standard color palette:''' A standard color can be selected by clicking on a color preview.[[File:Manual:fs-colorpicker.png|alt=Color picker|center|thumb|192x192px|Color picker]]
*'''Pencil symbol:''' Click on the pencil symbol to select a color from the color mixer.
*'''Manually entering a value:''' To provide a custom value (e.g., your for your CI colors), enter the hex-value for the color.
If you delete a color and FlexiSkin is saved with one or more empty color values, the standard colors of the Discovery skin are saved as values instead.
*
*
}}
}}
==IntegratesInto==
{{AutoDocIntegratesInto
|into = {{AutoDocListItem
|item = BlueSpiceDiscovery
}}
{{AutoDocListItem
|item = BlueSpiceEchoConnector
}}
}}
==Config==
{{AutoDocConfig
|config = {{AutoDocOption
|name = EchoEmailFormatterClasses
|value = <nowiki>array (
  'plain-text' =>
  array (
    'class' => 'BlueSpice\\EchoConnector\\Formatter\\EchoPlainTextEmailFormatter',
  ),
  'plain-text-digest' =>
  array (
    'class' => 'BlueSpice\\EchoConnector\\Formatter\\EchoPlainTextDigestEmailFormatter',
  ),
  'html' =>
  array (
    'class' => 'BlueSpice\\EchoConnector\\Formatter\\EchoHTMLEmailFormatter',
  ),
  'html-digest' =>
  array (
    'class' => 'BlueSpice\\EchoConnector\\Formatter\\EchoHtmlDigestEmailFormatter',
  ),
)</nowiki>
}}
{{AutoDocOption
|name = EchoHtmlMailTemplateNames
|value = <nowiki>array (
  'single' => 'SingleMail',
  'digest' => 'Digest',
  'primary_link' => 'PrimaryLink',
  'secondary_link' => 'SecondaryLink',
  'digest_list' => 'DigestList',
)</nowiki>
}}
{{AutoDocOption
|name = EchoHtmlMailTemplatePath
|value = <nowiki>'/templates'</nowiki>
}}
{{AutoDocOption
|name = ForceJobQueueForLargeAudienceThreshold
|value = <nowiki>499</nowiki>
}}
{{AutoDocOption
|name = UseJobQueueForNotifications
|value = <nowiki>false</nowiki>
}}
}}
==Hooks==
{{AutoDocHooks
|Hooks = {{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/ArticleDeleteComplete ArticleDeleteComplete]
|callback = \BlueSpice\EchoConnector\Hook\ArticleDeleteComplete\NotifyUsers::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUserManagerAfterAddUser BSUserManagerAfterAddUser]
|callback = \BlueSpice\EchoConnector\Hook\BSUserManagerAfterAddUser\NotifyUsers::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay BeforePageDisplay]
|callback = add-special-styles
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/EchoGetBundleRules EchoGetBundleRules]
|callback = \BlueSpice\EchoConnector\Hook\EchoGetBundleRules\GetBundleRules::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/EchoGetNotificationTypes EchoGetNotificationTypes]
|callback = \BlueSpice\EchoConnector\Hook\EchoGetNotificationTypes\GetNotificationTypesForEvent::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/GetPreferences GetPreferences]
|callback = \BlueSpice\EchoConnector\Hook\GetPreferences\AddNotificationMatrix::callback, \BlueSpice\EchoConnector\Hook\GetPreferences\HidePreferences::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/LoadExtensionSchemaUpdates LoadExtensionSchemaUpdates]
|callback = update
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/LocalUserCreated LocalUserCreated]
|callback = \BlueSpice\EchoConnector\Hook\LocalUserCreated\NotifyUsers::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/PageMoveComplete PageMoveComplete]
|callback = \BlueSpice\EchoConnector\Hook\PageMoveComplete\NotifyUsers::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/PageSaveComplete PageSaveComplete]
|callback = \BlueSpice\EchoConnector\Hook\PageSaveComplete\NotifyUsers::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/SkinTemplateNavigation::Universal SkinTemplateNavigation::Universal]
|callback = skin
}}
}}


{| class="wikitable" style=""
|+Standardfarben des "Discovery"-Skin
!
!Background
!Foreground
!Highlight
|-
|Header
|<span style="color: rgb(32, 33, 34)">#ffffff</span>
|#252525
|#3e5389
|-
|Sidebar
|<span style="color: rgb(32, 33, 34)">#f1f3f9</span>
|#252525
|#3e5389
|-
|Footer
|#<span style="color: rgb(32, 33, 34)">d3d3d3</span>
| #454545
|  -
|}
== Content==
These settings apply to all styles of the content area of a wiki page:<span /><span /><br />
=== Colors===
Here you can adjust the background, font and link colors. Broken links in the wiki are shown in red by default so that they can be easily identified. You should carefully consider whether you want to deviate from this convention. If you want to color visited links differently than standard links, you can insert the following setting in the Free CSS area:<syntaxhighlight lang="css">
#mw-content-text a:visited,[class^="mw-content-"] a:visited {color: #951b81;}
</syntaxhighlight>
===Font ===
The font settings only apply to the text in the content area. The text in other areas such as B. in the navigation and toolbars or in the menus is not affected.
===Layout===
If you want to change the layout width just test it on many devices to make sure your setting works as intended. Other wiki users work with different display settings and can be negatively affected by this change. Unless you have a specific reason to change the content width, you shouldn't adjust this setting. The standard content width is 61.25 rem.
===Headers===
You can adjust the color, font size and underlining for all heading levels. You can also change the unit for the font settings (e.g. ''px'' instead of ''rem''). If you are not familiar with the differences between these units, just leave the default setting, ''rem''. This is based on the superordinate size setting in the wiki. In contrast, ''em'' sizes are in relation to the enclosing container.
[[File:Manual:fs-headings-EN.png|alt=Heading levels|center|thumb|358x358px|Heading levels]]
==Free CSS==
{{Messagebox|boxtype=note|icon=|Note text=If the same styles are defined in both FlexiSkin or FlexiSkin Free CSS and in MediaWiki:Common.css, the styles from Common.css are applied.|bgcolor=}}
For additional customizations that are not possible with the FlexiSkin settings, you can use the ''Free CSS'' field if you are familiar with CSS.  Here are some examples.
===Neutral page tools (right sidebar)===
If you select a color for your left navigation bar, you sometimes don't want the color to be applied to the right sidebar (the page tools). To keep the light-grey background, add the following Free CSS:<syntaxhighlight lang="css">
/*right sidebar*/
#sb-sec-cnt {background-color:#efefef; color:#252525;}
#sb-sec-cnt .card-header.menu-title {color:#747474;}
</syntaxhighlight>
[[File:Manual:flexi-free-CSS.png|alt=Example of Free CSS|center|thumb|650x650px|Example of Free CSS]]
===Neutral top bar backgrounds and hovers===
When you set the header hightlight color, it can happen that the automatically calculated values for the searchbar as well as the button hovers and backgrounds don't fit your needs.
[[File:Manual:flexiskin-highlights-standard.png|alt=Flexiskin highlights standard|center|thumb|650x650px|Flexiskin highlights standard]]
In this case, you can neutralize them to grey.
[[File:Manual:flexiskin-highlights-neutral.png|alt=Neutral highlight colors|center|thumb|650x650px|Neutral highlight colors]]
Add the following Free CSS:
<syntaxhighlight lang="css">
/*top bar neutral search box, button backgrounds and hovers */
#nb-pri form input, #nb-pri form button{border-color:#f1f3f3}
#nb-pri form input, #nb-pri form button,#sb-pri-tgl-btn, #sb-pri-tgl-btn:hover,.mws-dropdown-primary.dropdown-menu a:hover,a.ico-btn:hover, a#sb-sec-tgl-btn, #nb-pri form .bs-extendedsearch-searchbar-clear  {background:#f1f3f3}
.mws-button-primary:hover {background-color:#747474; color:#fff}
/*top bar neutral bottom border*/
#nb-pri {box-shadow: 0 0 4px 0 #747474}
.card.mega-menu {box-shadow: inset 0 2px 3px -2px #747474}
/*mega menu neutral bottom overlay*/
@media (min-width: 768px){.dropdown-menu.megamenu .mm-bg {background-color:#747474}}
</syntaxhighlight>
<span /><span /><br />
[[Category:BlueSpice Cloud]]
[[de:{{FULLPAGENAME}}]]
[[en:Manual:Extension/FlexiSkin]]

Revision as of 11:44, 22 June 2023

DescriptionMsg

Connects BlueSpice with Echo

License

GPL-3.0-only

Requirements

  • MediaWiki: 1.38.0
  • BlueSpiceFoundation: 4.1

Echo: *

IntegratesInto

  • BlueSpiceDiscovery
  • BlueSpiceEchoConnector

Config

Configuration

Name Value
EchoEmailFormatterClasses array ( 'plain-text' => array ( 'class' => 'BlueSpice\\EchoConnector\\Formatter\\EchoPlainTextEmailFormatter', ), 'plain-text-digest' => array ( 'class' => 'BlueSpice\\EchoConnector\\Formatter\\EchoPlainTextDigestEmailFormatter', ), 'html' => array ( 'class' => 'BlueSpice\\EchoConnector\\Formatter\\EchoHTMLEmailFormatter', ), 'html-digest' => array ( 'class' => 'BlueSpice\\EchoConnector\\Formatter\\EchoHtmlDigestEmailFormatter', ), )
EchoHtmlMailTemplateNames array ( 'single' => 'SingleMail', 'digest' => 'Digest', 'primary_link' => 'PrimaryLink', 'secondary_link' => 'SecondaryLink', 'digest_list' => 'DigestList', )
EchoHtmlMailTemplatePath '/templates'
ForceJobQueueForLargeAudienceThreshold 499
UseJobQueueForNotifications false

Hooks

Hooks



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

No categories assignedEdit

Discussions