Skip to content

Commit 00959c1

Browse files
committed
Update documentation
1 parent 5a90f5d commit 00959c1

File tree

1 file changed

+86
-1
lines changed

1 file changed

+86
-1
lines changed

README.md

+86-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,92 @@ You can manage your keywords on the configuration view of the module with the "c
2222

2323
To associate one or more keywords to a content or a folder, go to tab "Modules" of content or folder editing view.
2424

25-
This module allow you to use 6 new loops : keyword_category, keyword_product, keyword_content, keyword_folder, keyword_group and keyword.
25+
This module allow you to use **6 new loops** :
26+
*keyword_category*, *keyword_product*, *keyword_content*, *keyword_folder*, *keyword_group* and *keyword*.
27+
And **4 Smarty functions** :
28+
*category_has_keyword*, *folder_has_keyword*, *product_has_keyword*, *content_has_keyword*
29+
30+
## Loops
31+
32+
#### keyword
33+
**Input**
34+
| Argument | Value | Default value |
35+
|--------- | ----|----|
36+
|id|(int) keyword id||
37+
|visible|(int) 1 or 0|1|
38+
|keyword|(string) The keyword code||
39+
|folder|(int) ID or list of ID's of folder||
40+
|content|(int) ID or list of ID's of content||
41+
|category|(int) ID or list of ID's of category||
42+
|product|(int) ID or list of ID's of product||
43+
|order|(string) alpha, alpha-reverse, manual, manual_reverse, random, given_id|alpha|
44+
|keyword_group|(int) ID or list of ID's of keyword group||
45+
46+
**Output**
47+
| Variable |
48+
|--------- |
49+
|$ID|
50+
|$KEYWORD_GROUP_ID|
51+
|$IS_TRANSLATED|
52+
|$LOCALE|
53+
|$TITLE|
54+
|$CODE|
55+
|$CHAPO|
56+
|$DESCRIPTION|
57+
|$POSTSCRIPTUM|
58+
|$POSITION|
59+
|$VISIBLE|
60+
|$CONTENTS_ASSOCIATION|
61+
|$FOLDERS_ASSOCIATION|
62+
|$CATEGORIES_ASSOCIATION|
63+
|$PRODUCTS_ASSOCIATION|
64+
|$HAS_PREVIOUS|
65+
|$HAS_NEXT|
66+
|$PREVIOUS|
67+
|$NEXT|
68+
69+
#### keyword_group
70+
**Input**
71+
| Argument | Value | Default value |
72+
|--------- | ----|----|
73+
|id|(int) keyword group id||
74+
|visible|(int) 1 or 0|1|
75+
|keyword|(string) The keyword group code||
76+
|order|(string) alpha, alpha-reverse, manual, manual_reverse, random, given_id|alpha|
77+
78+
**Output**
79+
| Variable |
80+
|--------- |
81+
|$ID|
82+
|$IS_TRANSLATED|
83+
|$LOCALE|
84+
|$TITLE|
85+
|$CODE|
86+
|$CHAPO|
87+
|$DESCRIPTION|
88+
|$POSTSCRIPTUM|
89+
|$POSITION|
90+
|$VISIBLE|
91+
|$HAS_PREVIOUS|
92+
|$HAS_NEXT|
93+
|$PREVIOUS|
94+
|$NEXT|
95+
96+
#### keyword_category, keyword_product, keyword_folder & keyword_content
97+
**Input**
98+
| Argument | Value | Default value |
99+
|--------- | ----|----|
100+
|keyword|(string) The keyword code||
101+
|association\_order|(string) manual, manual_reverse, random|manual|
102+
103+
**Output**
104+
Same as default loops category, product, folder & content with :
105+
| Variable |
106+
|--------- |
107+
|$FOLDER_POSITION|
108+
|$CONTENT_POSITION|
109+
|$CATEGORY_POSITION|
110+
|$PRODUCT_POSITION|
26111

27112
Here is an example of using each :
28113

0 commit comments

Comments
 (0)