This issue has been created
 
 
FAQ Application / cid:jira-generated-image-avatar-1fd98824-2054-42f1-8c77-da5331efb169 FAQ-39 Open

Improve the description and category of the FAQ macro

 
View issue   ยท   Add comment
 

Issue created

 
cid:jira-generated-image-avatar-9ea13034-86ee-414e-a82a-41c9a04668a5 Charpentier Lucas created this issue on 22/Oct/26 12:10
 
Summary: Improve the description and category of the FAQ macro
Issue Type: cid:jira-generated-image-avatar-1fd98824-2054-42f1-8c77-da5331efb169 Improvement
Affects Versions: 8.4.1
Assignee: Unassigned
Created: 22/Oct/26 12:10
Priority: cid:jira-generated-image-static-major-16ba00d8-b713-44d4-bb58-a8758c1e61be Major
Reporter: Charpentier Lucas
Description:

The description of the FAQ macro restates its name and misses the rule a user needs to insert it, and the macro has no category, so it appears in no category of the Insert Macro dialog.

KOs covered

Macro Criterion Parameters Problem
faq D2 summary   "Lists FAQ entries" restates the name with a verb. It does not say that the entries are shown in a table the reader can sort and filter, and it misses a rule the user needs to insert the macro: only the entries of the space given in the filter are listed, so without a filter the macro lists nothing, see I2. The French and German descriptions are left in English.
faq D3 category   The macro has no category: the macro list gives it an empty category, so it appears in no category of the Insert Macro dialog. Like documents and liveData, the other macros that list data, it belongs in Content, where a user looking for a list of entries would look.

Impact found on macro fluidity

These 2 KOs come from the WYSIWYG usability audit of the macros, under the criteria D2 summary, D3 category of its usability criteria. The page of each macro, linked in the table, has the full notes and the steps to reproduce. Fixing them means changing the translations of the macros and, for a name or a category, their definitions.