WordPress Plugin Tutorial
Installation
Search and install the Sharif plugin from the WordPress repository.
Getting Started
When logged into the WordPress Dashboard, find the Sharif entry in the left-hand admin menu and click on it. You will be presented with the Settings page where you configure your Sharif credentials.
If you do not have a Sharif account yet, you can create one for free at Sharif.
Once you have created your account, and you have signed in:
1. Go to the setting page
2. Create a new project for your first website.
3. you will need to copy/paste the following keys to your WordPress setting form:
- Project Slug
- API Key
Note: Copy/pasting these keys manually; is very error-prone. The copy button on the right side of each key will make copy/pasting easier.
Once you have filled in the required keys on the WordPress settings form, click on the Save Changes button at the bottom of the form.
If you have correctly provided WordPress with your Sharif keys, you will see a success message.
4. If your Sharif account credit is positive, the WordPress setting page status switches to active.
5. Click on the Index button to send your content to Sharif servers. After that, everything will be kept in sync automatically.
-
Using the
[sharif_form]
shortcode (of course, if your site theme supports shortcodes) -
Or using this php code, in a suitable div (with desired width) in your html codes:
<?php if(function_exists('sharif_selectbox')){ sharif_selectbox(); } ?>
Note: Please do not use these codes simultaneously on one page, or do not repeat one of them twice on the same page.
Options
[ ] Do not use Sharif
With this option, Sharif will not replace the native WordPress search experience. Sharif will index the content, but it will not affect the native WordPress search page experience.
This option is useful when you only need Sharif Plugin to index your WordPress content. For example, if you intend to:
- Make your content searchable from another site that implements Sharif
- Build a custom search UI with your Sharif search bar implementation
[ ] Remove Sharif powered by logo link
This will remove the Sharif logo link in the search bar and only displays a pure logo image.
[ ] Remove Sharif version link
This will remove the Sharif version link at the end of each post. In this version, the named entities of your text have been recognized quite intelligently and have become a searchable link.