Setup:Installation Guide/Webservices/PDF-Export and Reference:TitleKey: Difference between pages

(Difference between pages)
VisualWikitext
No edit summary
 
No edit summary
Tag: 2017 source edit
 
Line 1: Line 1:
{{DISPLAYTITLE:Webservice: PDF-Export}}
{{BSExtensionInfobox
__TOC__
|desc=Provides a title prefix search suggestion backend.
Make sure that the [[Setup:Installation Guide/System Preparation/Windows/Apache Tomcat|Apache Tomcat server]] is completely installed and configured on the BlueSpice server before setting up PDF-Export.
|status=stable
|developer=Brion Vibber
|type=MediaWiki
|edition=BlueSpice pro, BlueSpice free, BlueSpice Farm, BlueSpice Cloud
|compatible=MediaWiki
|category=Infrastructure
|license=GPL v2+
|docu=https://www.mediawiki.org/wiki/Extension:TitleKey
|active=Yes
|package=-
|features=
The extension'''TitleKey''' provides a case-insensitive title prefix search. It uses a separate table for the keys, so if it works cleanly it can be deployed without an expensive rebuild of core tables, and dumped when Wikimedia gets a nicer backend through [https://www.mediawiki.org/wiki/Special:MyLanguage/Extension:MWSearch MWSearch] extension.


==Moving the BShtml2PDF Application==
This extension provides no benefit if you are using [https://www.mediawiki.org/wiki/Extension:CirrusSearch CirrusSearch].<sup id="cite_ref-1" class="reference">[https://www.mediawiki.org/wiki/Extension:TitleKey#cite_note-1 [1]]</sup>
Download the file "BShtml2PDF.war" from https://sourceforge.net/projects/bluespice/files/webservices/BShtml2PDF.war/download and copy it to <code>&lt;tomcat-webapps&gt;</code>


The default paths are as follows:
For the average site administrator, the benefit of this extension is that it allows search suggestions (e.g. from [https://www.mediawiki.org/wiki/Special:MyLanguage/API:opensearch Opensearch API]) to be case-'''in'''sensitive.


*C:\Program Files\Apache Software Foundation\Tomcat 10.0\webapps '''(Apache Tomcat on Windows)'''
*/var/lib/jetty9/webapps '''(Jetty on Debian)'''


Or run the command <code>sudo mv /var/www/bluespice/w/extensions/BlueSpiceUEModulePDF/webservices/BShtml2PDF.war /var/lib/jetty9/webapps</code> in the terminal. '''(Linux)'''
For more information please visit [https://www.mediawiki.org/wiki/Extension:TitleKey MediaWiki].
 
}}
The application usually starts automatically without the need for rebooting the application server.
{{wcagCheck
 
|wcagStatus=2-testing complete
==Checking the functionality==
|wcagTestdate=2022-08-05
The correct functionality of the BShtml2PDF service can be checked as follows:
|extensionType=backend
 
}}
On Windows, open Internet Explorer using the URL <nowiki>http://localhost:8080/BShtml2PDF</nowiki>. With correct functionality, you should see the following website:
[[File:Setup:Tomcat_Check_03.png|center|400px|Tomcat Check 03]]
 
==Enable PDF Export in BlueSpice==
Go to the directory <code>&lt;installpath-bluespice&gt;/settings.d</code>. Open the file '''020-BlueSpiceUEModulePDF.php''' in a text editor.
 
Or open the 020-BlueSpiceUEModulePDF.php in the terminal using the command <code>sudo nano /var/www/bluespice/w/settings.d/020-BlueSpiceUEModulePDF.php</code>. '''(Linux)'''
 
In the second line is the code to activate the extension:
 
return; // Disabled. Needs Tomcat
 
You can either add a comment character (#) to the beginning of this line or delete the line completely, save the file and exit it.
 
{{Messagebox|boxtype=note|Note text=Give the user "Everyone" full access to the Temp folder under C:\Widows.}}
 
==Installing BlueSpice 3 with installer==
 
#Open <code>localhost/w</code> in your Browser and follow the [[:en:Setup:Installation_Guide/With_Installer|instructions]].
#For BlueSpice WikiFarm, move the .htaccess and web.config files to C:\bluespice\var
 
Open a command line and change into the folder <code>&lt;installpath-bluespice></code>. Execute the following command:
 
php maintenance/update.php ''(Linux)''
php maintenance\update.php ''(Windows))''
{{Messagebox|boxtype=note|Note text=In Windows, make sure that the environment variables are set correctly to access the "php" command.}}
{{Messagebox|boxtype=note|Note text=Note that you must update the [[Setup:Installation Guide/Security Settings/File System Permissions#Assignment_of_Permissions_with_Linux|file system permissions]] after running update.php.}}
 
When the script is finished with the "Done" message, you have successfully isntalled the web service .
 
[[File:Setup:Setup_bluespice_maintenance_update.jpg|center|400x556px]]
 
==Troubleshooting==
If there is a problem with the PDF export in BlueSpice, first check the [[Setup:Installation Guide/Security Settings/File System Permissions|file system permissions]].
==Download Web services==
If the required war-file is missing in your installation package, you can download it here: [https://buildservice.bluespice.com/webservices3.tar.gz Webservices].
 
 
[[en:{{FULLPAGENAME}}]]
[[de:Setup:Installationsanleitung/Webservices/PDF-Export]]

Latest revision as of 13:53, 5 August 2022

Extension: TitleKey

all extensions

Overview
Description: Provides a title prefix search suggestion backend.
State: stable Dependency: MediaWiki
Developer: Brion Vibber License: GPL v2+
Type: MediaWiki Category: Infrastructure
Edition: BlueSpice pro, BlueSpice free, BlueSpice Farm, BlueSpice Cloud Version: 4.1+
For more info, visit Mediawiki.

Features

The extensionTitleKey provides a case-insensitive title prefix search. It uses a separate table for the keys, so if it works cleanly it can be deployed without an expensive rebuild of core tables, and dumped when Wikimedia gets a nicer backend through MWSearch extension.

This extension provides no benefit if you are using CirrusSearch.[1]

For the average site administrator, the benefit of this extension is that it allows search suggestions (e.g. from Opensearch API) to be case-insensitive.


For more information please visit MediaWiki.

Accessibility

Test status: 2-testing complete
Last test date: 2022-08-05


Extension type: backend


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

Retrieved from "https://en.wiki.bluespice.com/w/index.php?title=Setup:Installation_Guide/Webservices/PDF-Export&oldid=4308"

Discussions