Manual:Extension/BlueSpiceDiscovery/Main navigation and Reference:Replace Text: Difference between pages

(Difference between pages)
No edit summary
Tag: 2017 source edit
 
No edit summary
 
Line 1: Line 1:
{{DISPLAYTITLE:Main navigation}}
{{BSExtensionInfobox
<bookshelf src="Book:Admin manual" />
|desc=Provides a form to let administrators do string replacements on the entire wiki, for both page contents and page titles.
==How does the main navigation work?==
|status=stable
By default, some links are provided as entry points to the wiki. Wiki administrators can deactivate these links in the [[Manual:Extension/BlueSpiceConfigManager|configuration manager]] if needed. In addition, you can also add new links below the entrypoints (admin permissions required). Please note that no hierarchical links can be created. Therefore, it makes sense to mainly set up links to the most important topics and to  portal pages that contain additional links or page lists.
|developer=Yaron Koren, Niklas Laxström
[[File:Manual:skin-discovery-hauptnavigation-EN.png|alt=Main navigation|center|thumb|402x402px|Main navigation]]
|type=MediaWiki
|edition=BlueSpice pro, BlueSpice free (deactivated), BlueSpice Farm, BlueSpice Cloud
|compatible=MediaWiki
|category=Administration
|license=GPL v2+
|docu=https://www.mediawiki.org/wiki/Extension:Replace_Text
|features=<div class="hw-messagebox notification-note "><span class="boxlabel">Note:</span>The replace text operation is a deferred operation and is placed in the job queue. It is possible that the changes are not immediately shown on all affected pages.


==Visual edit mode (menu editor)==
''runJobs.php'' can be run from the ''maintenance'' folder to do the replacement immediately and to process the job queue.</div><span></span>
{{BSVersion|bsvFrom=4.2|bsvTo=|bsvFeature=Visual menu editor}}
}}
'''To add a new menu header using the menu editor:'''
{{wcagCheck
|wcagStatus=2-testing complete
|wcagCheckedfor=Authoring tool
|wcagTestdate=2022-08-08
|wcagLevel=AA
|wcagSupport=partially supports
|wcagWorkaround=no
|wcagComments=keyboard accessible.


#'''Click''' ''edit sidebar'' at the bottom of the navigation menu. the page ''MediaWiki:Sidebar'' from the browser address bar. If the page does not exist yet, you will see a notice on the page.
Screenreader issues: no form field labels, warning box has no aria-label; initial focus for replacement founds is not set, so it is difficult to select pages.
#'''Click''' ''Add new element'' to create a new menu header.
|extensionType=extended
#'''Enter''' the text for your menu header. In a multilingual wiki, you can also enter a [[mediawikiwiki:Help:System_message|message key]].
|extensionFocus=admin
}}
'''ReplaceText''' is a  MediaWiki extension that provides both a special page and a command line script that allows administrators to search and replace any text in wiki pages and titles across the wiki.


<span><span /><span /><br /></span>
<section begin="menulinks" />
'''To add links:'''


#'''Select''' ''Add new subitem''  from the dropdown menu of the menu header.[[File:Main navigation 1667828722138.png|alt=add a link|none|thumb|add a link as a new subitem]]
Replacing the text is done in 3 steps on the ''Special:ReplaceText'' page:
#Enter the page name as the link target and the label that you want to show:[[File:Main navigation 1667828849101.png|alt=enter link info|none|thumb|enter link info]]
#'''Click''' ''Done.''
#'''Repeat''' steps 1-3.
#'''Click''' ''Save changes''.
{{Messagebox|boxtype=note|icon=|Note text=If you use the parser function <code><nowiki>{{#ifingroup:...</nowiki> </code> to display navigation elements in the source code, you must always edit the main navigation in the source code. In visual editing mode, saving removes any parser function or semantic queries.|bgcolor=}}
<section end="menulinks" />
== Adding links in source editing mode ==
#


<span><span /><span /><span /><span /><span /><br /></span> '''To add new links:'''
# Entering the existing and the new text as well as selecting the namespaces and other options
 
# Checking the pages on which the text appears. Possible adjustment of the page selection
#'''Click'''  ''edit sidebar'' below the navigation links.
# Performing the replacement.
#'''Change''' to source editing mode.
#'''Create''' one or more navigation links (with or without section heading).  The following example shows a link to the page "Company" with the label "Our company" and an external link to the BlueSpice website with the label "Website". The links are grouped together under the section heading "Quicklinks":<syntaxhighlight lang="text">
*Quicklinks
**Company|Our company
**https//www.bluespice.com/de|Website
</syntaxhighlight>
#'''Save''' the page. The links are now shown in the main navigation.
<span class="ve-pasteProtect">Link labels may collide with system messages. If this is the case, simply append the HTML-code for an empty space to the description:</span><syntaxhighlight lang="text">
**Portal|Portal&#160;
</syntaxhighlight>
 
==Deactivating standard links==
The standard links can be deactivated in the  [[Manual:Extension/BlueSpiceConfigManager|configuration manager]]. The following settings are available under ''Feature > Skinning'':
 
<span><span /><span /><span /><span /><span /><br /></span>
BlueSpiceBookshelf:
 
*Show entrypoint "Bookshelf"
 
BlueSpiceDiscovery:
 
*Show entrypoint "Mainpage"
*Show entrypoint "All pages"
*Show entrypoint "Recent changes"
 
BlueSpiceSocial:
 
*Show entrypoint "Timeline"
 
BlueSpiceSocialBlog:
 
* Show entrypoint "Blog"
 
==Group-specific navigation==
<span style="color: rgb(51, 51, 51)">It is possible to show navigation elements for specific user groups only. Please note that the pipe symbol (|) between the page name and its label has to be escaped as</span> <code><nowiki>{{!}}</nowiki></code> <span style="color: rgb(51, 51, 51)">within this function.</span>
 
This syntax is defined in the extension [[Reference:UserFunctions|UserFunctions]].<syntaxhighlight lang="text">
{{#ifingroup:sysop,widgeteditor |
*Test2                     
**somepage{{!}}Some page
|}}
</syntaxhighlight>
 
==Additional customizations ==
 
*[[Manual:Extension/BlueSpiceDiscovery/Main navigation/Long link labels|Alignment for navigation with long link labels]]
*[[Manual:Extension/BlueSpiceDiscovery/Main navigation/Icons|Display icons with navigation links]]
*[[Manual:Extension/BlueSpiceDiscovery/Main navigation/Language support|Multi-language navigation]]
 
<span /><span /><span /><span /><span /><span /><br />
[[Category:Administration]]
[[Category:Customization]]
 
[[en:{{FULLPAGENAME}}]]
[[de:Handbuch:Erweiterung/BlueSpiceDiscovery/Hauptnavigation anpassen]]

Latest revision as of 11:01, 22 May 2023

Extension: Replace Text

all extensions

Overview
Description: Provides a form to let administrators do string replacements on the entire wiki, for both page contents and page titles.
State: stable Dependency: MediaWiki
Developer: Yaron Koren, Niklas Laxström License: GPL v2+
Type: MediaWiki Category: Administration
Edition: BlueSpice pro, BlueSpice free (deactivated), BlueSpice Farm, BlueSpice Cloud Version: 4.1+
For more info, visit Mediawiki.

Features

Note:The replace text operation is a deferred operation and is placed in the job queue. It is possible that the changes are not immediately shown on all affected pages. runJobs.php can be run from the maintenance folder to do the replacement immediately and to process the job queue.

Accessibility

Test status: 2-testing complete
Checked for: Authoring tool
Last test date: 2022-08-08
WCAG level: AA
WCAG support: partially supports (workaround: no)
Comments:

keyboard accessible.

Screenreader issues: no form field labels, warning box has no aria-label; initial focus for replacement founds is not set, so it is difficult to select pages.

Extension type: extended
Extension focus: admin

ReplaceText is a MediaWiki extension that provides both a special page and a command line script that allows administrators to search and replace any text in wiki pages and titles across the wiki.


Replacing the text is done in 3 steps on the Special:ReplaceText page:

  1. Entering the existing and the new text as well as selecting the namespaces and other options
  2. Checking the pages on which the text appears. Possible adjustment of the page selection
  3. Performing the replacement.




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

Discussions