cogSpellchecker Search UI Extension
TypeXAR
CategoryUI Extension
Developed by

Ludovic Dubost

Active Installs9
Rating
LicenseGNU Lesser General Public License 2.1
Compatibility

Tested with XWiki 9.2 but it should work with most versions

Installable with the Extension Manager

Description

This extension is adding a spellchecker to the search interface. The query that the user will fill in will be spell-checked against an english dictionary. If the spellchecker finds something wrong it will propose the first suggestion from the list.

spellcheck.png

For now this spellchecker is only configured in english. To support another language, dictionaries will be necessary.

This tool uses jazzy 0.6

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

A UI Extension point needs to be added until Open XWIKI-14205 is integrated in XWiki.

To add the extension point locate #\displaySearchForm in the page Main.SolrSearchMacros and add the foreach/end block after it:

    #displaySearchForm()
    #foreach ($extension in $services.uix.getExtensions("org.xwiki.platform.search.widget"))
{{html clean=false}}
$services.rendering.render($extension.execute(), 'xhtml/1.0')
{{/html}}
    #end
    #if ($text != '')

Dependencies

Dependencies for this extension (org.xwiki.contrib:application-application-spellchecker 1.0):

  • com.tupilabs:jazzy 0.6
Tags:
Created by Ludovic Dubost on 2017/04/14 12:09
    

Get Connected