A Case Study Finder, a component required for the Case Study Library, allows Case Study content to be filtered and searched on a page.
On this page
- Before you start: create Case Study content
- How to use the Case Study Finder
- Adding a Case Study Finder on a landing page
- How the keyword search works
Create Case Study content before you start
Case Study content should first be created for the finder. Read our guide to create a Case Study on nsw.gov.au to do this.
How to use the Case Study Finder
Do
- Use on landing pages to list large amounts of case studies with the ability to search and filter them.
- Limit other components on your page. The page should mostly be dedicated to the Case Study finder. If you add other elements to the page, such as a summary or call out, position the Case Study finder last on the page.
Don't
- Add more than 1 Case Study Finder component to your landing page.
Adding a Case Study Finder on a landing page
To add a Case Study Finder to your landing page:
- Create a new full width section and click Add block.
- In the Choose a block screen, search for DCS Case Study Finder block and select the component from the search results. The Configure block screen will open and you can adjust the settings.
- The Title can be left with the default text as this is only visible to editors.
- The Related Case Study Subtype can be left on the default dropdown of Case study default.
- In the Agency field select your agency. You will need to have case studies that have been tagged with this agency for the component to generate results.
- In the Keyword settings accordion you can leave the default text of 'Keyword', or enter custom text to create a stronger call-to-action such as 'Search case studies.'
- You can choose to add filters for Category, Region and Council, although this is optional. You must have tagged your individual case studies with these optional tags for these filters to function in the Case study finder. If you haven’t added category tags to individual case studies, see how to tag a case study. If you are adding these filters:
- You can choose to customise the title, helper text and tag expand fields or leave the default text.
- You must use the values field to look up and select the options you want to display for the filter with a comma after each filter. For example, in the Council values field you could select 'Albury City Council' and 'Byron Shire Council', which would appear as 'Albury City Council (967), Byron Shire Council (946)'.
- Click the Update button.
How the Keyword search works
The Keyword search functionality will search for keywords within the following fields in the Content, Quick Facts and Tags tab of case study content.
- Content tab: Title, Summary, Description (content)
- Quick Facts tab: Lead, Collaborators, Suppliers
- Tags tab: keywords (the search keywords that each of the case studies are tagged to)
How to I add/edit/remove values for the Category, Region and Council filters
The Category, Region and Council filter values reference taxonomy terms. Only the Digital Channels Content Team will be able to update these values. Submit a Content change or update request if these values need to be updated for your needs.
See this live on nsw.gov.au
Visit Case Study Finder to see a live example of this component.
You can also see a live agency example on the SmartNSW Case Study Library page.
Need any more help?
If you have any questions, or require assistance with anything mentioned in this article, submit a request via the webform.