Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | |||
|
services:pvw:conf:faqs [2015/03/17 09:34] r2d2 change $faqs to $pvw_conf |
services:pvw:conf:faqs [2015/03/18 10:15] (current) eric |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== FAQs Page ====== | ====== FAQs Page ====== | ||
| - | The **conf/faqs.php** contains all your FAQs texts. | + | The **conf/faqs.php** contains all of your FAQs texts. |
| //This is a php file, that contains an [[http://php.net/manual/en/language.types.array.php|array]] of [[http://php.net/manual/en/language.types.string.php|string variables]]// | //This is a php file, that contains an [[http://php.net/manual/en/language.types.array.php|array]] of [[http://php.net/manual/en/language.types.string.php|string variables]]// | ||
| ===== Definition ===== | ===== Definition ===== | ||
| - | Each of your FAQs is defined like that : | + | Each of your FAQs are defined as the following : |
| <code php> | <code php> | ||
| Line 14: | Line 14: | ||
| Where: | Where: | ||
| - | * **SECTION** is the section in which to sort your faqs | + | * **SECTION** is the section in which your FAQs are sorted. |
| - | * **INDEX** is an unique index for this section question/answer pair (can be a number or a string) | + | * **INDEX** is a unique index for this section. question/answer pairs can be a number or a string. |
| - | * **TEXT** can be any string, that can even include HTML tages (ie for long anwser that might need LI or some P tags. | + | * **TEXT** can be any string that can even include HTML tags (like long answers that might need LI or P tags. |
| - | Here is an exemple : | + | Here is an example : |
| <code php> | <code php> | ||
| $pvw_conf['faqs']['general']['1']['q'] ="I have a question ?"; | $pvw_conf['faqs']['general']['1']['q'] ="I have a question ?"; | ||
| Line 27: | Line 27: | ||
| $pvw_conf['faqs']['general']['spammer']['q']="Can I send Spam ?"; | $pvw_conf['faqs']['general']['spammer']['q']="Can I send Spam ?"; | ||
| - | $pvw_conf['faqs']['general']['spammer']['a']="Of course you can, but to your mother only"; | + | $pvw_conf['faqs']['general']['spammer']['a']="Of course you can, but to martians only"; |
| - | $pvw_conf['faqs']['support']['1']['q'] ="Will you come at home to repair my software ?"; | + | $pvw_conf['faqs']['support']['1']['q'] ="Will you come to my place to repair my software ?"; |
| - | $pvw_conf['faqs']['support']['1']['a'] ="Of course yes, and we even bring a coffee."; | + | $pvw_conf['faqs']['support']['1']['a'] ="Of course we will and we'll even bring coffee."; |
| </code> | </code> | ||
| ===== Sections ===== | ===== Sections ===== | ||
| - | Sections are completely optionnals, but are usefull to separate your FAQs in differents sections, especially if you have many FAQS. | + | Sections are totally optional but they can be very useful if you want to separate your FAQs into different sections, especially if you plan to print many FAQs. |
| - | //If you dont want to use sections, simply put all your faqs in the same section, ie 'general' and no sections will be displayed.// | + | //If you don't need or want to use sections, simply put all of your FAQs content within the same section such as 'general' and no sections will be displayed.// |
| - | Each section index used in FAQs definitions must be named using the following syntax: | + | Each section index used in FAQ definitions must be named using the following syntax: |
| <code php> | <code php> | ||
| $pvw_conf['faqs_sections']['SECTION'] ="NAME"; | $pvw_conf['faqs_sections']['SECTION'] ="NAME"; | ||
| Line 44: | Line 44: | ||
| Where : | Where : | ||
| - | * **SECTION** is the section inde used in FAQs definitions | + | * **SECTION** is the section index used for FAQs definitions. |
| - | * **NAME** is the title that will be used for each Section | + | * **NAME** is the title that will be used for each of the sections. |
| Example : | Example : | ||
| Line 58: | Line 58: | ||
| ===== Sorting ===== | ===== Sorting ===== | ||
| - | Faqs are groupped by section and sorted : | + | FAQs are groupped by sections and sorted as : |
| - | * first in the order the **$pvw_conf['faqs_sections']** are defined in the configuration file, | + | * First in the order the **$pvw_conf['faqs_sections']** are defined in the configuration file, |
| - | * then in the order the **$pvw_conf['faqs']** are defined in the configuration file. | + | * Then in the order the **$pvw_conf['faqs']** are defined in the configuration file. |
| Line 67: | Line 67: | ||
| {{indexmenu_n>40}} | {{indexmenu_n>40}} | ||
| - | |||