SkillsPlugin

This plugin allows users to specify what skills they have and their level of proficiency. The user can then display their skills on their home page, and view other users skills by browsing through specific categories/skills.

Example

Below is a screenshot of the users skill being displayed on their homepage. Click for the full image.

To get the skills displayed on the users home page, as in this example, look at SkillsDisplayOnHomePage? .

User Interface

Users

The user interface for general users can be found at the following places:

• SkillsBrowseAll?
• SkillsEditMySkills?
• SkillsSearch?

Managing Categories and Skills

To create, modify or delete categories/skills, follow the instructions at SkillsAdminIntroduction? .

Advanced Search

You can create a more advanced search, by creating the form yourself and using an extra input field. This can allow searching for users in a particular office/location. This is described in detail at SkillsAdvancedSearch? .

Syntax Rules

The Plugin handles a %SKILLS{}% variable that performs different actions. The action="" is a required parameter.

• %SKILLS{ action="userskills" }% - Displays the skills for the specific user.

  Parameter	Comment	Default
  user="TWikiGuest"	The user who's skills to display (you do not need to specify the Main web).	Current user
  twisty="open"	Can be: =open - starts expanded; closed - starts collapsed; off - disabled.	"closed"

• %SKILLS{ action="edit" }% - Displays a form allowing the current logged in user to edit their skills.

• %SKILLS{ action="browse" }% - Lists the specific skills/categories, and the users who have them.

  Parameter	Comment	Default
  category="Cat1, Cat2"	If category is defined, will list all the users who have skills in that category.	All categories
  skill="Skill1, Skill2"	If category and skill are defined, lists all the users who have that skill.	All skills
  twisty="open"	Can be: open - starts expanded; top - open at the top level, closed at the second level; closed - starts collapsed; off - disabled.	"closed"

• %SKILLS{ action="search" }% - Provides a form allowing you to search users skills.

• %SKILLS{ action="showcategories" }% - shows all existing categories.

  Parameter	Comment	Default
  format	Format of a category. Tokens: $category, $n.	"$category"
  separator	Separator between tags, $n can be used for newlines.	", "

• %SKILLS{ action="showskills" }% - shows all existing skills.

  Parameter	Comment	Default
  category	Specific category	all
  format	Format of a skill. Tokens: $skill, $category, $n.	"$skill"
  separator	Separator between skills, $n can be used for newlines.	", "
  categoryseparator	Separator between categories, $n can be used for newlines.	"$n"
  prefix	Prefix before each category. Tokens $category, $n.	none
  suffix	Suffix after each category. Tokens $category, $n.	none

Plugin Settings

Plugin settings are stored as preferences variables in TWikiPreferences.

• By default, anyone can add new skills/categories. To limit this to a list of people/groups, add the following to TWikiPreferences:
  • Set ALLOWADDSKILLS = UnknownUser

• By default, the styles using in the plugins forms are found in the style.css, attached to this topic. To define your own style sheet, add the following to TWikiPreferences:
  • Set STYLEURL = http://twiki.org/p/pub/TWiki04x01/SkillsPlugin/style.css

• Log add/create actions
  • By default, any skills or categories that are created/deleted/renamed are logged in the standard TWiki logs (defined at $TWiki::cfg{LogFileName}). To disable this, add the following to LocalSite.cfg:
    • $TWiki::cfg{Plugins}{SkillsPlugin}{Log} = 0

• Debug plugin
  • To see the output in data/debug.txt, add the following to LocalSite.cfg:
    • $TWiki::cfg{Plugins}{SkillsPlugin}{Debug} = 1

• Short description of plugin
  • Set SHORTDESCRIPTION = Allows users to list their skills, which can then be searched

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the TWiki server.

• Download the ZIP file from the Plugin web (see below)
• Unzip SkillsPlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/SkillsAdminIntroduction.txt	UI Topic
  data/TWiki/SkillsPlugin.txt	Plugin Topic
  data/TWiki/SkillsAdvancedSearch.txt	Supplemental Documentation
  data/TWiki/SkillsBrowseAll.txt	UI Topic
  data/TWiki/SkillsCreateNewCategory.txt	UI Topic
  data/TWiki/SkillsCreateNewSkill.txt	UI Topic
  data/TWiki/SkillsDeleteCategory.txt	UI Topic
  data/TWiki/SkillsDeleteSkill.txt	UI Topic
  data/TWiki/SkillsDisplayOnHomePage.txt	Supplemental Documentation
  data/TWiki/SkillsEditMySkills.txt	UI Topic
  data/TWiki/SkillsMoveSkill.txt	UI Topic
  data/TWiki/SkillsRenameCategory.txt	UI Topic
  data/TWiki/SkillsRenameSkill.txt	UI Topic
  data/TWiki/SkillsSearch.txt	UI Topic
  lib/TWiki/Plugins/SkillsPlugin.pm	Plugin Module
  lib/TWiki/Plugins/SkillsPlugin/Func.pm	Plugin Module
  lib/TWiki/Plugins/SkillsPlugin/Query.pm	Plugin Module
  lib/TWiki/Plugins/SkillsPlugin/Tag.pm	Plugin Module
  pub/TWiki/SkillsPlugin/skills_screenshot_full.png	Screenshot
  pub/TWiki/SkillsPlugin/skills_screenshot_search.png	Screenshot
  pub/TWiki/SkillsPlugin/skills_screenshot_thumb.png	Screenshot
  pub/TWiki/SkillsPlugin/style.css	Default Style Sheet
  templates/oopsgeneric.skills.tmpl	Comment Popup Template

• Configure the Plugin:
  • TWiki 4.0 and up: Run the configure script to enable the Plugin
  • Change the Plugin settings as needed
• Test if the installation was successful:
  • You should see a form allowing you to add/edit your skills?
• If needed, customise the styles by creating a new style sheet and adding the setting above to TWikiPreferences
• Start adding some categories and skills
  • SkillsCreateNewCategory?
  • SkillsCreateNewSkill?

Plugin Info

Related Topics: TWikiPlugins, AdminDocumentationCategory, TWikiPreferences