Create a Searchable FAQ Page

Tips & Tricks
#1

Plugin required: Shiraz from kookma plugin library.

image
image845×760 36.1 KB

FAQs Page

Searchable Frequently Ask Questions (FAQ) page can be created with a details or slider macro.

Each FAQ is a tiddler with

  1. the question as tiddler title
  2. the answer as the tiddler text

To create a FAQs page

  • a $list widget to filter the tiddlers contain faq (create faq tiddlers in advance)
  • an input box to search in questions (e.g tiddler title)
  • a details or slider macro to show accordion like questions and answers
  • a keyboard widget to assign the Esc shortcut key to clear the search box

Remarks

The search box only search in questions (tiddler title). It is possible to modify the code to search also in answer (tiddler text). For example in demo/advanced/details-faqs to search in title (questions) and answers (tiddler text):

replace filter="[tag[Custom Styles FAQ]search:title{$:/temp/demo/qa/search-details}]"

with filter="[tag[Custom Styles FAQ]search:title,text{$:/temp/demo/qa/search-details}]"

For more details see Shiraz 2.7.4 — create stylish contents in Tiddlywiki (kookma.github.io)

Example: Create FAQ in 5 minutes!

  1. FAQ page using slider Shiraz 2.7.4 — create stylish contents in Tiddlywiki
  2. FAQ page using details Shiraz 2.7.4 — create stylish contents in Tiddlywiki
2 Likes