Keyword Search

• The Keyword Navigation Object is used for obtaining keywords from a Content Type element in the current, parent or specified section, storing these keywords and then using them to find all content with matching keywords in another specified Content Type element.
• And in plain English that means if, for instance news items are "tagged" with keywords, you can specify elsewhere on the site that only news items with the matching keywords should be displayed.
• To make sure the keywords are entered correctly, create a list, and add an element to your News Content using the list to specify which keyword(s) to display on the site.

Before You Start

Be sure you have the following added to your training site:

• “News” section with a “News” content type enabled. If you don’t have one, you may duplicate one to your Site structure.
• Add a few news stories that we’ll fetch later.

Create a keyword list

Having a list of keywords gives you full control of the keyword options available to your content editors when they are categorizing their news items.

1. To create a list, go to: Assets > Lists > +Add new list.
2. Fill in the List information:
   1. Name: enter a name for your list.
   2. Description: enter a description for your list.
   3. Localization:
      1. Use current language version of this list: when this box is checked, no translations of this list will be used.
      2. Only use this list when localized versions are not available: when this box is checked, this list is used regardless of whether there is a translation.
   4. Primary group: select a group if appropriate
3. List items: add your list entries, i.e., the keywords you wish to use in your News Content.
   1. Name: this is what the user sees when creating content
   2. Value: this is what is published on the site. If this value is left blank -the list item is not published on the site
   3. Selected: check this box to ensure the list is selected by default when the list is used
   4. Sublist: select when you want to create a cascading list. Using the drop-down list, select the sublist to be linked to other sublists. By doing so, you create multiple levels in the cascading list.
4. Click Save changes to save the list.

Add the list to your news content type

• Lists can be added to Content Types using one of the List Elements.
• The example below shows the list added to a content type using the Check Box element. If you have many list items, you might prefer to use the Multiple Select element. 

1. You need to add a list element to your News Content. To do this, go to Assets >Content Types.
2. Filter for your news Content Type and click Actions > Edit to begin editing.
3. Select the Elements tab and click +Add element.
4. Add an element similar to the one in the table below.

5.  Click Save changes.
6. Enable the News Story Content Type and ensure you also add/update at least 1 piece of content using the News Content Type, as the new element will otherwise not be in use.

Create Sections and enable Content Type

1. On the Site Structure screen, create news section under your News section. Select Edit section from the Actions menu beside your News section.
2. Select the Content types tab.
3. Using the Filter tool, find your Keyword Selector Content Type, and click the radio button to enable the Content Type for either the branch or the section:
   1. Enabled (branch): the Content Type can be used in this section as well as all its sub-sections.
   2. Enabled (section): the Content Type can be used in this section only.
4. Click Save changes.

Create a Keyword Content Type

The Keyword Content Type will allow you to specify the keyword(s) for the search/fetch criteria.

1. To start the work, go to Assets > Content Types > +Create content type.
2. Fill in the General information:
   1. Name: enter a name here. This should suggest what type of content it is used for, e.g., Keyword Selector.
   2. Description: describe when to use this Content Type, e.g., Specify keyword to search/fetch content by.
   3. Minimum user level: if you wish to restrict who can use this Content Type, you can set a level here.
   4. Enable Direct Edit: decide if this Content Type can be used in Direct Edit.
   5. eForm: not required.
   6. Workflow: if relevant, enable a workflow for content using this Content Type.
3. Select the Elements tab.
4. Each Content Type has a Name element by default. This is used to name the content and is typically not displayed on the published site.
5. Click +Add element to add the other elements you need by filling in the information as outlined below:

6. Click Save changes, the Content Layout tab appears.
7. In the Content layouts tab, click +Add content layout to establish a new content layout; this ensures the content can be displayed.
   1. Name: use text/html.
   2. File extension: should be left at Default.
   3. Syntax type: select to enable syntax highlighting, e.g. HTML/XML.
   4. Content layout processor: select this as Handlebars Content.
   5. Content layout code: This is where we will put the Navigation tag of our Keyword Search Content Navigation object. We have not built the navigation yet so, for now, let’s put a placeholder. i.e., Navigation object to go here.

8. Click Save changes. The main part of the Content Type is complete.
9. Enable your Content Type to the Athletics News, Business School News, and Computer Science News Sections.

Add keyword content to your sections

• The Keyword Selector Content Type contains a Keyword element. The Keyword element is going to provide the Keyword for the Search/Fetching of content.
• Add the Keyword Search/Fetch content type to each of your filtered news sections.

1. Navigate to the Site Structure screen and select Add Content from the Actions menu beside the sections you created earlier.
2. Select your Keyword Selector Content Type.
3. Give the piece of content a name.
4. Select one or multiple Keywords from the list, i.e. Athletics News
5. Save and approve your content.
6. Repeat these steps for each News section you have.
7. Preview your news sections to see the results.

Build keyword search content navigation

The Keyword Search Content Navigation Object is going to match keywords within a Content Type, with the keywords assigned to the News Content. It finds any matches and displays all News Content matching the keywords under the section where the Keyword Search Content Navigation Object is located. 

1. To build the Keyword Search Content Navigation Object, go to Assets > Navigation > +Add new navigation. 
2. Scroll down to find and click on the Keyword Search Content Navigation type.
3. The Keyword Search Navigation object contains the following options:
   1. Enabled:  the Navigation Object needs to be enabled, otherwise nothing will output.
   2. Name: enter a name for the Keyword Search e.g. News Keyword Search.
   3. Description: enter a description for the Keyword Search Content.
   4. Primary group: select if relevant.
   5. View in preview: lets you view non-approved content in preview.
      
      Keyword retrieval
       
      
      1. Keyword fetch method: in this exercise you will be adding a piece of content specifying Keywords, the Keywords you specify will determine which content is displayed. Specify where this content is to be fetched from (in this exercise select Current Section):
         1. Current section: content will be fetched from the Current Section.
         2. Parent section: content will be fetched from the Branch, starting at the Section you specify.
         3. Specified section: content will be fetched from a selected section.
      2. Root section: if “Specified section” is selected (above), select the root section for your keyword fetch method.
      3. Narrow keyword selection: check this box to narrow the selected keywords to the current piece of content being published. In this exercise this can be left blank.
      4. Content type to get keywords: this is where you select which Content Type you use for specifying the Keywords to search for, i.e. the Keyword(s) Selector Content Type.
      5. Get keywords element name: in this exercise there is only one element outputting the keywords in the type selected above. Select this element (i.e. Keyword) from the populated list.
         
         Content retrieval
         
         
         1. Content fetch method: select the location of the content containing the keywords.
            1. Specified section: this is the section that contains the content you wish to compare against the keywords selected above. In this exercise this will be the section which contains the news stories.
            2. Branch: selects from a branch.
            3. Branch at level: selects the start and end level from within the branch.
         2. Search section from: Choose section, or from the content element.
         3. Search section: select the section that contains your news items.
         4. Content type to search keywords: select the Content Type you wish to search for matching keywords against, i.e. the News Story Content Type.
         5. Search keywords element name: select the keyword element within the Content Type selected above.
         6. Number of pieces of content to display: the number of pieces of Content to display on one page.
         7. Sort type: is how you wish the content to be sorted when it is displayed on the site:
            1. Use Name (A-Z): Order Name element A-Z.
            2. Use Name (Z-A): Order Name element Z-A.
            3. Use Last Modify Date: Order by last modified date.
         8. Sort the results by a date element: if this option is checked, this will order the results according to a date element in the Content Type instead of using the sort type option above.
         9. Include hidden sections: if checked, include the content in hidden sections in the search.
         10. Allow matching of composite keywords: this will show partial matches so "composite" keywords can be matched to a "single" keyword. For example, if the "Get keywords element" contains "apple, pear, orange", it will match any content containing "apple" or "pear" or "orange".
         11. Allow matching on sub-items: this option will include content tagged with a taxonomy item's subitems. For example, if the keywords are entered using a cascading list, selecting a parent option in the list will display all content that match the parent or the sub-list related to the parent.
         12. Enable cross language searching: this option will allow you to enable matching across language searching, once enabled you need to select the languages to search in the option below.
         13. Before HTML: this contains the code to be output before the content. It could for instance be a list tag <ul>.
         14. After HTML: this contains the code to be output after the content. It could for instance be a closing list tag </ul>.
         15. Content layouts:
             1. Use channel default.
             2. Use alternative content layout.
             3. Pagination output across pages.
4. Click Next to save the navigation object.
5. Copy the Handlebars expression to your clipboard; to be pasted into your Content Type’s Content Layout.

Add Navigation Tag to Content Type’s Content Layout

• In an earlier step you created a Content Layout with a placeholder of: “Navigation object to go here.” Now you have the Navigation Handlebars expression in your clipboard and you can paste it into the Content Layout. 

1. Go to Assets > Content Types.
2. Filter for your Keyword Search/Fetch Content Type and click Actions > Edit to begin editing.
3. Select the Content layouts tab.
4. Click into your text/html layout to edit it.
5. Select the Content layout code tab.
6. Remove your placeholder and paste your navigation tag. If you do not have the Handlebars expression in your clipboard, you can regenerate it using the </> Generate Handlebars Expression button.

Feedback survey

Congratulations on completing the Advanced Web Developer Training module.

Please provide feedback in our on-line survey.