EXT: Modern FAQ

Extension Key: irfaq

Copyright 2004 - 2006, Ingo Renner, <typo3@ingo-renner.com>

Copyright 2006, Netcreators, <extensions@netcreators.com>

This document is published under the Open Content License

available from http://www.opencontent.org/opl.shtml

The content of this document is related to TYPO3

- a GNU/GPL CMS/Framework available from www.typo3.com

Table of Contents

EXT: Modern FAQ	1

Introduction	1

What does it do?	1

Screenshots	1

Users manual	2

FAQ	2

Configuration	2

Reference	2

Known problems	3

To-Do list	3

Changelog	3

Introduction

What does it do?

This is modern version of a faq list, it offers a 'static' view with a list of questions and the answers below. Alternativly you can choose a dynamic view which uses DHTML to fold out the answers when clicking on a question. It is not based on tt_news like EXT:faq and therefore you have questions and answers on one page! The main objective is to merge functionality of EXT:faq and EXT:faq_plus into a modern look and provide a converter when finished. You can add a searchform to the list to filter the faq list.

Screenshots

Dynamic view

Static view

Users manual

You can create catgories, experts and faq items just like any other record. Go to Web->List and choose create new record in the upper right corner, from there you'll see the faq icons.

To get the faq list on your page, just insert the plugin and choose dynamic or static view in the flexform. Add the startingpoint and you're done. To use categories you have to set your sysfolder containing the faq items as the general storage point in the page header.

FAQ

Categories aren't working, what can I do?
In most cases you just forgot to set the general storage point in the page header to the sysfolder where the FAQ items reside in.

Since the update to version 0.5.0 my category selection of the flexform is lost
The flexform has been divided in several tabs for more usability. Category selection has been transferred to its own tab. Reconfigure your category settings in this tab.

Configuration

Reference

plugin.tx_irfaq_pi1 properties: TS configuration.

Property:	Data type:	Description:	Default:
templateFile	resource	The template-file. (See example in "/typo3conf/ext/irfaq/res/irfaq.tmpl"). You can define a template for a complete pagetree or a certain page in the Constant Editor or directly in your TS setup. Example: plugin.tx_irfaq_pi1 { templateFile = fileadmin/templates/irfaq.html }	
iconMinus	resource	The minus icon used in dynamic view to show the FE user that he can click on the question to fold out the answer.	
iconPlus	resource	The plus icon. Example: plugin.tx_irfaq_pi1 { iconPlus = fileadmin/icons/irfaq_plus.gif }	
openSingle	boolean	To open only one FAQ at a time in dynamic view set this to 1	0
General Settings:
defaultCode	string	Defines default view (dynamic/static/search), comma separated Example: plugin.tx_irfaq_pi1.defaultCode = static	dynamic
pid_list	string / stdWrap	The pid, or list of pids of the folder, where your nfaq items are stored in (also known as “Starting point”). If this value is not set, and the “Starting point field” in the news content-element is also empty, the current page is used. Accepts multiple pid's comma separated! Example: # clear the value plugin.tx_irfaq_pi1.pid_list > # display faq records located in page 582 & 584 plugin.tx_irfaq_pi1.pid_list = 582,584	
general_stdWrap	->stdWrap	The field "answer" will be processed by this stdWrap settings. Example: plugin.tx_irfaq_pi1 { general_stdWrap > general_stdWrap { parseFunc < tt_content.text.20.parseFunc } } This will clear any given "general_stdWrap" from default setup, and parse the content from modern FAQ through the same parseFunc as normal content like "text" or "text with image". What is for example uesfull if you have installed EXT:dh_linklayout.	
answer_stdWrap	->stdWrap	stdWrap for display of the answer field	
question_stdWrap	->stdWrap	stdWrap for display of the question field	
text_expert_stdWrap	->stdWrap	stdWrap for display of the espert text	wrap = <br /> |
expert_stdWrap	->stdWrap	stdWrap for display of the expert's name	
expertemail_stdWrap	->stdWrap	stdWrap for display of the expert's eMail	
experturl_stdWrap	->stdWrap	stdWrap for display of the expert's website – if any	wrap = (|)
category_stdWrap	->stdWrap	stdWrap for display of the cateegories	
text_asked_by_stdWrap	->stdWrap	stdWrap for display of the asked by text	wrap = <br /> |
asked_by_stdWrap	->stdWrap	stdWrap for display of the person's name who asked the question	
related_entries_stdWrap	->stdWrap	stdWrap for display of the display of related FAQ entries (if any)	
related_links_stdWrap	->stdWrap	stdWrap for display of the display of related FAQ links (if any)	
categoryMode	int	Defines how the dieplayed FAQs are selected regarding to their category: 0 = display all categories 1 = display selected categories -1 = display deselected categories	0
categorySelection	int	You can set the categories to be shown, but the Flexform value will take precedence	
catTextMode	int+	Default is 0 which just displays the category unlinked. If set to 1 the catgory text will act as a shortcut link to the given shortcut page. If set to 2 the categoy text will link to the current page the plugin is on and act as a category selector.	2
Search Settings:
emptySearchAtStart	boolean	If search form is added, the list will be initially empty. The list of filtered faq items will only be shown when a keyword is entered in the searchform	1
searchFieldList	string	List of database columns in which to search for keywords	q,a
searchPid	int	Redirect to page id after submitting the form	

[tsref:plugin.tx_irfaq_pi1]

Known problems

None at the moment

To-Do list

Add remaining features from EXT:faq

Add a converter EXT:faq / EXT:faq_plus -> EXT:irfaq

feature requests welcome

Changelog

V0.1.0

first public release

ADD manual

FIX labels in TCE Form

V0.1.3

ADD finish translation

V0.2.0

FIX category selection was not implemented

ADD sysfolder icon (edit page header -> contains extension)

V0.2.3

FIX category selection – double output of FAQ items

CHG Manual

V0.3.0

ADD listing of FAQs in page view

V0.4.0

ADD dutch translation

ADD show/hide all function

ADD show one FAQ at a time mode

ADD category selection by GET vars

ADD category Text modes (nothing, shortcut, category selector)

ADD field 'asked by' to show who asked the question (was introduced with faq_plus)

FIX sorting of categories and FAQs

FIX RTE transformation is working now

CHG Manual updated

CHG default CSS

CHG default template

CHG TCE Form labels now use the labels from EXT:lang where appropriate

Thanks a lot to Ben van't Ende and Rupert Germann for helping out with ideas and programming!!

V0.4.1

FIX small bug when using multiple instances of irfaq on one page

V0.4.3

FIX Modern FAQ is now XHTML Strict compatible

V0.4.4

FIX fixed bug with old php versions, where a seed was needed for the random generator

V0.4.5

FIX after fixing the bug in v0.4.4 the bug which was fixed in v0.4.1 was back, this is solved now by using a different seed.

V0.4.13

FIX The answer string was not processed correctly with the parseFunc function from tslib_cObj based on configuration set in "lib.parseFunc_RTE" in the current TypoScript template.

Changed all locallang files from PHP to XML

Default CSS-styles from standard TS to static template

V0.5.0

ADD search functionality (Sponsored by Gemeente Heemskerk, http://www.heemskerk.nl)

V1.0.0

ADD related faq entries (Thanks to Dmitry Dulepov, Sponsored by Gemeente Heemskerk, http://www.heemskerk.nl)

ADD related links (Thanks to Dmitry Dulepov, Sponsored by Gemeente Heemskerk, http://www.heemskerk.nl)

EXT: Modern FAQ - 3

EXT: Modern FAQ

Kasper Skårhøj

2002-11-01T00:32:00

Patrick Broens

Kasper Skårhøj