You are here

Home » API reference » Frequently Asked Questions 8

faq-category-questions-top.html.twig in Frequently Asked Questions 8

Template file for the questions section of the FAQ page if set to show categorized questions at the top of the page.

Available variables:

  • display_header: Boolean value controlling whether a header should be displayed.
  • header_title: The category title.
  • category_name: The name of the category.
  • answer_category_name: Whether the category name should be displayed with the answers.
  • group_questions_top: Whether the questions and answers should be grouped together.
  • category_depth: The term or category depth.
  • description: The current page's description.
  • term_image: The HTML for the category image. This is empty if the taxonomy image module is not enabled or there is no image associated with the term.
  • display_faq_count: Boolean value controlling whether or not the number of faqs in a category should be displayed.
  • question_count: The number of questions in category.
  • nodes: The array of nodes to be displayed. Each node stored in the $nodes array has the following information:
    • question: The question text.
    • body: The answer text.
    • links: Represents the node links, e.g. "Read more".
  • use_teaser: Tells whether node.body contains the full body or just the teaser
  • container_class: The class attribute of the element containing the sub-categories, either 'faq-qa' or 'faq-qa-hide'. This is used by javascript to open/hide a category's faqs.
  • question_list: An array of question links.
  • question_list_style: The style of the question list, ul for unordered, ol for ordered.
  • subcat_list: An array of sub-categories. Each sub-category stored in the subcat_list array has the following information:
    • subcat.link: The link to the sub-category.
    • subcat.description: The sub-category description.
    • subcat.count: The number of questions in the sub-category.
    • subcat.term_image: The sub-category (taxonomy) image.
  • subcat_list_style: The style of the sub-category list, either ol or ul (ordered or unordered).
  • subcat_body_list: The sub-categories faqs, recursively themed (by this template).

See also

template_preprocess_faq_category_questions_top()

File

templates/faq-category-questions-top.html.twig
View source 
  1. {#

  2. /**

  3.  * @file

  4.  * Template file for the questions section of the FAQ page if set to show

  5.  * categorized questions at the top of the page.

  6.  * 

  7.  * Available variables:

  8.  * - display_header: Boolean value controlling whether a header should be displayed.

  9.  * - header_title: The category title.

  10.  * - category_name: The name of the category.

  11.  * - answer_category_name: Whether the category name should be displayed with the answers.

  12.  * - group_questions_top: Whether the questions and answers should be grouped together.

  13.  * - category_depth: The term or category depth.

  14.  * - description: The current page's description.

  15.  * - term_image: The HTML for the category image. This is empty if the taxonomy image module 

  16.  *   is not enabled or there is no image associated with the term.

  17.  * - display_faq_count: Boolean value controlling whether or not the number of faqs in a category should be displayed.

  18.  * - question_count: The number of questions in category.

  19.  * - nodes: The array of nodes to be displayed. Each node stored in the $nodes array has the following information:

  20.  *   - question: The question text.

  21.  *   - body: The answer text.

  22.  *   - links: Represents the node links, e.g. "Read more".

  23.  * - use_teaser: Tells whether node.body contains the full body or just the teaser

  24.  * - container_class: The class attribute of the element containing the sub-categories, either 'faq-qa' or 'faq-qa-hide'. 

  25.  *   This is used by javascript to open/hide a category's faqs.

  26.  * - question_list: An array of question links.

  27.  * - question_list_style: The style of the question list, ul for unordered, ol for ordered.

  28.  * - subcat_list: An array of sub-categories.  Each sub-category stored in the subcat_list array has the following information:

  29.  *   - subcat.link: The link to the sub-category.

  30.  *   - subcat.description: The sub-category description.

  31.  *   - subcat.count: The number of questions in the sub-category.

  32.  *   - subcat.term_image: The sub-category (taxonomy) image.

  33.  * - subcat_list_style: The style of the sub-category list, either ol or ul (ordered or unordered).

  34.  * - subcat_body_list: The sub-categories faqs, recursively themed (by this template).

  35.  * 

  36.  * @see template_preprocess_faq_category_questions_top()

  37.  * 

  38.  * @ingroup themable

  39.  */

  40. #}

  41. 

  42. {% if category_depth > 0 %}

  43.     {% set hdr = 'h4' %}

  44. {% else %}

  45.     {% set hdr = 'h3' %}

  46. {% endif %}

  47. 

  48. <a id="top"></a>

  49. <div class="faq-category-menu">

  50.     <!-- category header with title, link, image, description, and count of questions inside -->

  51.     <div class="faq-qa-header">

  52.         {% if display_header %}

  53.             <{{ hdr }} class="faq-header">

  54.                 {{ term_image }}

  55.                 {{ header_title }}

  56.                 {% if display_faq_count %}

  57.                     ({{ question_count }})

  58.                 {% endif %}

  59.             </{{ hdr }}>

  60.         {% else %}

  61.             {{ term_image }}

  62.         {% endif %}

  63.         {% if description is not empty %}

  64.             <div class="faq-qa-description">{{ description }}</div>

  65.         {% endif %}

  66.         {% if term_image is not empty %}

  67.             <div class="clear-block"></div>

  68.         {% endif %}

  69.     </div><!-- Close div: faq-qa-header -->

  70.     

  71.     {% if subcat_list is not empty %}

  72.         <!-- list subcategories, with title, link, description, count -->

  73.         <div class="item-list">

  74.             <{{ subcat_list_style }} class="faq-category-list">

  75.             {% for subcat in subcat_list %}

  76.                 <li>

  77.                     {{ subcat.link }}

  78.                     {% if display_faq_count %}

  79.                         ({{ subcat.count }})

  80.                     {% endif %}

  81.                     {% if subcat.description is not empty %}

  82.                         <div class="faq-qa-description">{{ subcat.description }}</div>

  83.                     {% endif %}

  84.                     <div class="clear-block"></div>

  85.                 </li>

  86.             {% endfor %}

  87.             </{{ subcat_list_style }}>

  88.         </div>

  89.     {% endif %}

  90.     

  91.     <div class="{{ container_class }}">

  92.         {% if subcat_body_list|length > 0 %}

  93.         {% for subcat_html in subcat_body_list %}

  94.             <div class="faq-category-indent">{{ subcat_html }}</div>

  95.         {% endfor %}

  96.         {% endif %}

  97.         

  98.         {# list question links #}

  99.         {% if question_list is not empty %}

  100.             <div class="item-list">

  101.                 <{{ question_list_style }} class="faq-ul-questions-top">

  102.                     {% for question_link in question_list %}

  103.                         <li>

  104.                             {{ question_link }}

  105.                         </li>

  106.                     {% endfor %}

  107.                 </{{ question_list_style }}>

  108.             </div>

  109.         {% endif %}

  110.         

  111. {% if not group_questions_top or category_display != 'hide_qa' %}

  112.     </div> <!-- Close div: faq-qa / faq-qa-hide -->

  113. </div> <!-- Close div: faq-category-menu -->

  114. {% endif %}

  115.         

  116.         {% if answer_category_name %}

  117.             <!-- Display header before answers in some layouts. -->

  118.             <{{ hdr }} class="faq-header">

  119.                 {{ term_image }}

  120.                 {{ category_name }}

  121.             </{{ hdr }}>

  122.             <div class="clear-block"></div>

  123.         {% endif %}

  124.         

  125.         {# List questions (in title link) and answers (in body). #}

  126.         <div class="faq-category-group">

  127.             <div>

  128.                 {% if nodes|length > 0 %}

  129.                 {% for node in nodes %}

  130.                     <div class="faq-question">

  131.                         {% if question_label is not empty %}

  132.                             <strong class="faq-question-label">

  133.                                 {{ question_label}}

  134.                             </strong>

  135.                         {% endif %}

  136.                         {{ node.question }}

  137.                     </div><!-- Close div: faq-question -->

  138.                     

  139.                     <div class="faq-answer">

  140.                         {% if answer_label is not empty %}

  141.                             <strong class="faq-answer-label">

  142.                                 {{ answer_label }}

  143.                             </strong>

  144.                         {% endif %}

  145.                         {{ node.body }}

  146.                         {% if node.links is defined %}

  147.                             {{ node.links }}

  148.                         {% endif %}

  149.                     </div><!-- Close div: faq-answer -->

  150.                 {% endfor %}

  151.                 {% endif %}

  152.             </div><!-- Close div -->

  153.         </div><!-- Close div: faq-category-group -->

  154. {% if group_questions_top and category_display == 'hide_qa' %}

  155.     </div> <!-- Close div: faq-qa / faq-qa-hide -->

  156. </div> <!-- Close div: faq-category-menu -->

  157. {% endif %}