aboutsummaryrefslogtreecommitdiff
path: root/mod/categories/readme.txt
blob: 49241b2f43e9b253a8de737f15756d7f854f1416 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
Site-wide categories
--------------------

NOTES FOR PROGRAMMERS:

If you're not a programmer, don't worry! All the main Elgg tools
are already adapted to use categories, and a growing number of
third party Elgg tools use it too.


This plugin uses views and events hooks to allow you to easily add
site-wide categories across Elgg tools.

This is a two-line addition to any plugin.

In your edit/create form:

	echo elgg_view('categories', $vars);

In your object view:

	echo elgg_view('categories/view', $vars);
	
Note that in both cases, $vars['entity'] MUST be populated with
the entity the categories apply to, if it exists. (i.e., there's
no need for this on a create form.)