Last edited one month ago
by WikiSysop

Setup:Installation Guide/With Installer and Manual:Extension/BlueSpiceDiscovery/Main navigation: Difference between pages

(Difference between pages)
VisualWikitext
No edit summary
Tag: 2017 source edit
 
No edit summary
Tag: 2017 source edit
 
Line 1: Line 1:
== Download installation package ==
{{DISPLAYTITLE:Main navigation}}
{{DISPLAYTITLE:Installation BlueSpice 4 with Installer}}
<bookshelf src="Book:Admin manual" />
==How does the main navigation work?==
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.
[[File:Manual:skin-discovery-hauptnavigation-EN.png|alt=Main navigation|center|thumb|402x402px|Main navigation]]


{{Messagebox|boxtype=neutral|icon=yes|Note text=[https://bluespice.com/download/ Download the installation package]  from the bluespice.com website.
==Visual edit mode (menu editor)==
{{BSVersion|bsvFrom=4.2|bsvTo=|bsvFeature=Visual menu editor}}
'''To add a new menu header using the menu editor:'''


#'''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.
#'''Click''' ''Add new element'' to create a new menu header.
#'''Enter''' the text for your menu header. In a multilingual wiki, you can also enter a [[mediawikiwiki:Help:System_message|message key]].


Store the installation package in a web root of your choice (see our [[Setup:Installation_Guide/Advanced/Folder_structure_under_Windows|folder structure recommendations]] for Windows installations), where you can access it via your browser.
<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]]
#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 ==
#


Make sure that [[Setup:Installation_Guide/Security_Settings/File_System_Permissions|file system permissions]] are set up properly.|bgcolor=}}
<span><span /><span /><span /><span /><br /></span> '''To add new links:'''
==Introduction==
BlueSpice 4 is installed  as a complete package with MediaWiki 1.35 and BlueSpice 4.
This installation guide gives you step-by-step instructions to install BlueSpice.


{{Messagebox|boxtype=important|Note text=If you do a fresh install of BlueSpice 4, it might be necessary to run update.php afterwards if you get an error.|bgcolor=|icon=}}This document only describes the steps for installing the web application itself. For the installation of extended functions such as [[Setup:Installation_Guide/Advanced/VisualEditor_Configuration|VisualEditor]] and [[Setup:Installation Guide/Advanced/ExtendedSearch Configuration|Extendedsearch]], please refer to the corresponding documentation.
#'''Click'''  ''edit sidebar'' below the navigation links.
#'''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>


We will not go into details about your operating system installation here, but assume that you have already checked the [[Setup:Installation_Guide#Prerequesites|system requirements]] and your server configuration. You can find more details in our detailed [[Setup:Installation Guide|installation guide]].
==Deactivating standard links==
The standard links can be deactivated in the [[Manual:Extension/BlueSpiceConfigManager|configuration manager]]. The following settings are available under ''Feature > Skinning'':


Further help on optimizing the operating system can be found in our [[Setup:Installation Guide/Advanced|compendium]].
<span><span /><span /><span /><span /><br /></span>
==Step-by-step installation==
BlueSpiceBookshelf:


{{Messagebox|boxtype=note|icon=|Note text=If you also install the paid extension "BlueSpiceWikiFarm", make sure that the codebase is not located directly in the DocumentRoot of your web server or VirtualHost - it must be located in the /w subfolder!
*Show entrypoint "Bookshelf"
|bgcolor=}}


First use your browser to call up the URL under which the web application can be reached. Then complete the following steps:  
BlueSpiceDiscovery:
{| class="wikitable" style=""
|-
|[[File:Setup:mediawiki-setup-page.png|alt=MediaWiki setup page php error|300x300px]]
||'''Step 1:  Start the installation setup'''
First, open the URL of your web application in your browser. Then click on "set up the wiki" to start the installation.


If you don't meet all necessary requirements for PHP yet, you won't be able to view this setup page yet. Please make the necessary corrections to your PHP installation first. Otherwise, you are now on the page shown in the screenshot (click on the thumbnail to see the full screenshot).
*Show entrypoint "Mainpage"
*Show entrypoint "All pages"
*Show entrypoint "Recent changes"


|-
BlueSpiceSocial:
|[[File:Setup:Screenshot (213) 123.png|alt=Select language|300x300px]]
||'''Step 2: Select your language'''
You are now in the language selection.
"Your language" defines the language that guides you through the installer,


"Wiki language" the later language settings of your wiki.
*Show entrypoint "Timeline"
|-
|[[File:Setup:Screenshot (215)3.png|alt=Installation check|300x300px]]
||'''Step 3:  MediaWiki installation check'''
This step takes you to the MediaWiki installation check.
Please read this check carefully, as possible hints may not block the installation itself, but may lead to restrictions of the wiki functionality in practice.
Make the necessary corrections to your system and reload the page in your browser before proceeding with the setup.
|-
|[[File:Setup:Screenshot (218).png|alt=Database connection|300x300px]]
||'''Step 4: Establish the database connection'''
In this step, you configure the database connection.
Here you can either specify the root user of your MySQL server and in the following step have the installer create an additional user who only has access to the BlueSpice database. The database will also be created automatically if it does not yet exist.
Or, alternatively, you can create a user and a database in advance and directly enter this information here. You can find information on the manual creation of users and databases in the [[mediawikiwiki:Manual:Installing_MediaWiki#MariaDB/MySQL|official Mediawiki documentation]].
|-
|[[File:Setup:bs3-install-05.png|alt=Database user|300x300px]]
||'''Step 5: Create the BlueSpice database user'''
Depending on the procedure you followed in the previous step, you can now define an exclusive user for your BlueSpice database. If you have already created the user explicitly for the database in advance, leave the check mark at "Use the same database account as during the installation process".
|-
|[[File:Setup:bs3-install-06.png|alt=Wiki name and admin account|300x300px]]
||'''Step 6: Create your wiki name and administrator account'''
Enter the name for your wiki. This name is displayed in the title bar of your browser and in various other places such as in notification mails.
Pay extra attention to the correct spelling, because this name can afterwards only be changed  with a certain effort and certain risks. Next, enter the username, password and e-mail address of the first wiki administrator. The administrator account is then created by the wiki during setup.
|-
|[[File:Setup:Screenshot (223)e.png|alt=Email options|center|300x300px]]
||'''Step 7: Options'''
In this step, you specify the e-mail address for  notification e-mails.
|-
|
||'''Step 8: Installation'''
This step announces the installation of the wiki. If you don't need to make any changes to the previous steps, click "Next" to start the installation process.
|-
|[[File:Setup:Screenshot (219).png|alt=Installation status|center|300x300px]]
||'''Step 9: Installation status'''
After the successful installation of BlueSpice, you  see a confirmation page that you confirm with "Next".
|-
|[[File:Setup:Screenshot (224).png|alt=Download localsettings.php|300x300px]]
||'''Step 10: Download LocalSettings.php'''
In the last step of the installation, you will be asked to download the configuration file "LocalSettings.php" of your installation. Download it and place it in the root directory of your BlueSpice codebase.
|-
|
|'''Step 11: Rename the template folders'''
#Open the folder <code><installpath-bluespice>\extensions\BluesSpiceFoundation</code> and rename the subfolder <code>config.template</code>  to <code>config</code> and create the new folder <code>data</code>.  <span /><br />These folders should have read and write access, see  [[Setup:Installation Guide/Security Settings/File System Permissions|File System Permissions]].
#Run  <code>php <installpath-bluespice>\maintenance\update.php</code> from the console.
|-
|[[File:Setup:Screenshot Landingpage.png|alt=BlueSpice start page|300x300px]]
||'''Step 12: Load the BlueSpice welcome page'''
If you now access the URL you specified for BlueSpice, you now see the BlueSpice welcome page. You can start using BlueSpice immediately.
|}


==BlueSpice WikiFarm==
BlueSpiceSocialBlog:
If you are installing '''BlueSpice WikiFarm,''' follow these [[:en:Setup:Installation_Guide/Installation_BlueSpice_WikiFarm|instructions.]] If not, skip to [[:en:Setup:Installation_Guide/Installation_BlueSpice_WikiFarm|Next steps.]]


Now open a command line and change to the folder <code><installpath-bluespice></code>.
* Show entrypoint "Blog"


Run the following command:
==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>


*<code>php maintenance/update.php</code> ''(Linux)''
This syntax is defined in the extension [[Reference:UserFunctions|UserFunctions]].<syntaxhighlight lang="text">
*<code>php maintenance\update.php</code> ''(Windows)''
{{#ifingroup:sysop,widgeteditor |
==Next steps==
*Test2                     
{{Messagebox|boxtype=note|Note text=If the page is not loading, give the group "users" change-permissions for the folder C:\Windows\Temp.}}
**somepage{{!}}Some page
For security reasons, it is recommended to prevent access to the path <code>mw-config/</code> after the installation. This can be implemented as follows:
|}}
</syntaxhighlight>


<span><br /></span>
==Additional customizations ==
=Linux=
In Apache, add the following entry to the file <code>000-bluespice.conf</code>:
<pre>
    <Directory /var/www/bluespice/w/mw-config>
        Require all denied
    </Directory>
</pre>


*[[Manual:Extension/BlueSpiceDiscovery/Main navigation/Icons|Display icons with navigation links]]
*[[Manual:Extension/BlueSpiceDiscovery/Main navigation/Language support|Multi-language navigation]]


=Windows=
<span /><span /><span /><span /><span /><br />
In IIS, create a file <code>web.config</code> in the sub-directory <code>mw-config/</code> with the following content:
[[Category:Administration]]
<pre>
[[Category:Customization]]
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <system.webServer>
        <security>
            <authentication>
                <anonymousAuthentication enabled="false" />
            </authentication>
        </security>
    </system.webServer>
</configuration>
</pre>
<headertabs /><notabtoc/>
Please note that this entry may have to be removed temporarily if the web installer is used to update the application.


{{Messagebox|boxtype=important|Note text=As next step, you can configure [[Setup:Installation Guide/Advanced/VisualEditor Configuration|VisualEditor]] and [[Setup:Installation Guide/Advanced/ExtendedSearch Configuration|Extendedsearch]].}}
[[en:{{FULLPAGENAME}}]]
[[en:{{FULLPAGENAME}}]]
[[de:Setup:Installationsanleitung/Installation von BlueSpice]]
[[de:Handbuch:Erweiterung/BlueSpiceDiscovery/Hauptnavigation anpassen]]

Revision as of 16:42, 19 January 2023

How does the main navigation work?

By default, some links are provided as entry points to the wiki. Wiki administrators can deactivate these links in the 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.

Main navigation
Main navigation

Visual edit mode (menu editor)

Visual menu editor is available from BlueSpice 4.2.

To add a new menu header using the menu editor:

  1. 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.
  2. Click Add new element to create a new menu header.
  3. Enter the text for your menu header. In a multilingual wiki, you can also enter a message key.


 <section begin="menulinks"> To add links:

  1. Select Add new subitem from the dropdown menu of the menu header.
    add a link
    add a link as a new subitem
  2. Enter the page name as the link target and the label that you want to show:
    enter link info
    enter link info
  3. Click Done.
  4. Repeat steps 1-3.
  5. Click Save changes.
Note:If you use the parser function {{#ifingroup:... 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.

<section end="menulinks">

Adding links in source editing mode


 To add new links:

  1. Click edit sidebar below the navigation links.
  2. Change to source editing mode.
  3. 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":
    *Quicklinks
**Company|Our company
**https//www.bluespice.com/de|Website
  4. Save the page. The links are now shown in the main navigation.

Link labels may collide with system messages. If this is the case, simply append the HTML-code for an empty space to the description:

**Portal|Portal&#160;

Deactivating standard links

The standard links can be deactivated in the configuration manager. The following settings are available under Feature > Skinning:


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

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 {{!}} within this function.

This syntax is defined in the extension UserFunctions.

{{#ifingroup:sysop,widgeteditor |
*Test2                       
**somepage{{!}}Some page
|}}

Additional customizations



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

Retrieved from "https://en.wiki.bluespice.com/w/index.php?title=Setup:Installation_Guide/With_Installer&oldid=5449"

Discussions