summaryrefslogtreecommitdiff
path: root/www/wiki/extensions/SemanticMediaWiki/res/smw/suggester/README.md
blob: ef74349bfcaaf03768699313f41d2e1506dad29f (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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

## Register an input context

Adding a input context can be done fairly easy using something like:

<pre>
// Ensures that the module is loaded before trying to access an
// instance.
mw.loader.using( [ 'ext.smw.suggester' ], function() {

	var context = $( '#someElement > input' );

	if ( context.length ) {

		var entitySuggester = smw.Factory.newEntitySuggester(
			context
		);

		// Register default tokens
		entitySuggester.registerDefaultTokenList(
			[
				'property',
				'concept',
				'category'
			]
		);
	};
} );
</pre>

## Register an additional token

It may be desired to define additional tokens that active a suggestion request.

<pre>
mw.loader.using( [ 'ext.smw.suggester' ], function() {

	var context = $( '#someElement > input' );

	if ( context.length ) {

		var entitySuggester = smw.Factory.newEntitySuggester(
			context
		);

		// Register default tokens
		entitySuggester.registerDefaultTokenList(
			[
				'property',
				'concept',
				'category'
			]
		);

		entitySuggester.registerTokenDefinition(
			'property',
			{
				token: '?p:',
				beforeInsert: function( token, value ) {
					return value.replace( 'p:', '' );
				}
			}
		);
	};
} );
</pre>