Application Keywords

Speck content items can be saved with keywords, and content items can be retrieved based on keyword matches.

To limit the keywords users can choose from when saving content items and force users to select keywords from a list rather than simply enter keywords as free-text, you can add some application keywords.

Speck includes a content type, spKeywords, which is the default source of the application keywords. To enable the interface for managing application keywords you need to set the manageKeywords application configuration setting to yes.

Users who are members of either the spSuper or spKeywords roles can manage the application keywords and will see a "Navigation" link on the Speck toolbar when logged in and can use this to add, edit and delete application keywords (application keywords are usually used to drive navigation menus too). The spKeywords role is a reserved role name.

Using another source for the application keywords
As an application is being initialised, Speck loads the application keywords into memory. Normally, these are read from the spKeywords database table, but you can specify another source using a keywords configuration file and the optional "keywords" setting in the application configuration file. The configuration file allows you to specify a source, either file or database (same as with the various security files). If the source is file, the application keywords are read from the file section of the keywords configuration file. If the source is set to database, the settings in the database section of the keywords configuration file will be used to obtain the keywords from a database table. The keywords configuration file should be lowercase, have a ".cfg" extension and be saved in the /speck/config/keywords/ directory.

There is an example file distributed with Speck for you to work from. After saving your configuration file, you need to add a "keywords" setting in the application configuration file. The value of this setting should match the filename of your keywords configuration file, without the extension.