Skip to content

Commit

Permalink
Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
hschottm committed Dec 29, 2015
1 parent a8989dd commit d42a2af
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# faqextensions
faqextensions extends the FAQ module support in Contao.
faqextensions extends the FAQ module support in Contao. The extensions allow you to highlight very popular FAQ entries or your personal recommendations in the Contao frontend to make your FAQ section even better.
## Extension of existing Data Container Arrays
### tl_faq
The `tl_faq` dca has been extended with two new database fields.
Expand All @@ -26,4 +26,11 @@ $GLOBALS['TL_DCA']['tl_faq']['fields']['recommended'] = array(

## Modules
### Most frequently viewed FAQ list
This module creates a list of the most frequently viewed FAQ entries. Only FAQ entries with a `viewcount`greater 0 will be used to generate the list. You can limit the number of entries by entering an upper limit. The order of the FAQ entries is always descending by `viewcount` so the most fequently viewed entry is on top of the list.

![most_frequent_module](https://cloud.githubusercontent.com/assets/873113/12032443/a51d6e44-ae18-11e5-9117-1eebd1e4a242.png)
### Recommended FAQ list
This module creates a list of all FAQ entries marked as recommended. You can limit the number of list entries by entering an upper limit and you can set the sorter order for the entries to alphabetical by FAQ title or by creation date of the FAQ entry, both ascending and descending.

![recommended_module](https://cloud.githubusercontent.com/assets/873113/12032444/a51f9926-ae18-11e5-92b5-58f345e2a0df.png)

0 comments on commit d42a2af

Please sign in to comment.