1 files changed, 66 insertions, 0 deletions
diff --git a/www/wiki/extensions/SemanticMediaWiki/res/smw/suggester/README.md b/www/wiki/extensions/SemanticMediaWiki/res/smw/suggester/README.md
new file mode 100644
index 00000000..ef74349b
--- /dev/null
+++ b/www/wiki/extensions/SemanticMediaWiki/res/smw/suggester/README.md
@@ -0,0 +1,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>
+\ No newline at end of file