Search Box portlet

What is the Search Box portlet?

A portlet which generates a Search Box on the webpage in which the portlet is hosted, which allows the user to search for specific content within the portlet’s scope.

Adding content in the Search Box portlet

1. Navigate to the page that you would like to add the Search Box portlet to (you need to be logged in).

2. Once on the page, use the drop down menu on the right side of the edit bar that will be 'Your name'.

3. Select 'Manage portlets'.

4. You will now be taken to a page that allows you to select 'Primary portlets' and 'Secondary portlets'. Depending on the content type you can use, one or the other, or both. It is most common to use the 'Primary portlets'.

5. Using the ‘Add portlet' drop down menu under the portlet location that you require, select 'Search Box.’ You will then be taken to a page where you can configure this portlet.

6. There are three headed sections in the Search Box portlet edit interface:

7. Content;

   1. Name

      1. This content of this field will be displayed as default in the search bar.

   2. Field name

      1. If using the 'GET' form method (detailed below), the content of this field will determine how the URL is adapted after a search is processed.

   3. Form action

      1. This functionality allows the user to link the search bar to another section on the website, dependant on the URL provided in this field. You only require the part of the URL that is listed after (and including) the first '/'.

   4. Form method

      1. GET

         1. If selected, the URL will change (adapted by the chosen content of the ‘Field name’ field) following a search.

      2. POST

         1. If selected, the URL will remain the same following a search.

8. Style

   1. Box border

      1. This feature allows the user to deploy a border of their choice on either or both sides of the portlet.

   2. Box type

      1. This feature allows the user to deploy a highlighted background to the portlet.

9. Advanced;

   1. Show only for sub-items

      1. Check this box if you would like to add the portlet at a section level, and define that it shows only on all the items in the section, rather than on the section as well.

Editing content in the Search Box portlet

1. Click on your name in the top right of the edit bar to access the drop-down menu, ensuring that you are on the correct page, which hosts the portlets in question.

2. Select ‘Manage portlets’ from the dropdown menu

3. Click onto the portlet you wish to and edit any of the fields you would like to.

Removing the Search Box portlet

1. If you wish to remove the Search Box portlet, click on your name in the top right of the edit bar to access the drop-down menu, ensuring that you are on the correct page, which hosts the portlets in question.

2. Select ‘Manage portlets’ from the dropdown menu

3. Click on the X button, next to the portlet you wish to delete.