Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mespeche committed May 27, 2014
1 parent a28e78e commit e43926b
Showing 1 changed file with 23 additions and 2 deletions.
25 changes: 23 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Module Keyword Thelia 2

This module is used to associate content or folders to one or more keywords.
This module is used to associate category, product, content or folders to one or more keywords.
This allows you for example to display items based on a particular keyword or structure your page with a tag system.

## How to install
Expand All @@ -22,10 +22,24 @@ You can manage your keywords on the configuration view of the module with the "c

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

This module allow you to use 3 new loops : keyword_content, keyword_folder and keyword.
This module allow you to use 6 new loops : keyword_category, keyword_product, keyword_content, keyword_folder, keyword_group and keyword.

Here is an example of using each :

__Use the keyword_category loop (list of categories related to the "my_keyword" keyword)__
```html
{loop name="categories" type="keyword_category" keyword="my_keyword" order="manual_reverse"}
...
{/loop}
```

__Use the keyword_product loop (list of products related to the "my_keyword" keyword)__
```html
{loop name="products" type="keyword_product" keyword="my_keyword" order="manual_reverse"}
...
{/loop}
```

__Use the keyword_content loop (list of contents related to the "my_keyword" keyword)__
```html
{loop name="contents" type="keyword_content" keyword="my_keyword" folder="1" order="manual_reverse"}
Expand Down Expand Up @@ -60,3 +74,10 @@ __Use the keyword loop (list all keywords that are visible)__
...
{/loop}
```

__Use the keyword group loop (list all keyword groups that are visible)__
```html
{loop name="keyword_group_list" type="keyword_group" visible="*" order="manual" backend_context="1" lang=$lang_id}
...
{/loop}
```

0 comments on commit e43926b

Please sign in to comment.