Installation & User Guide

Transcription

1 SharePoint Tagging Feature V1 Installation & User Guide

2 Copyright 2005 KWizCom LTD. All rights reserved. Company Headquarters P.O. Box #38514 North York, Ontario M2K 2Y5 Canada Web site: Sales Telephone:

3 Table of Contents Introduction... 4 Overview 5 Key Features & Benefits 8 Installation... 9 Software prerequisites 9 Installation Procedure 9 Post Installation 11 Component Localization Resource File Editor utility structure 13 Translating a KWizCom component 14 Use the component in your preferred language 15 Component Activation Administration Guide Tag Cloud web part - Introduction 18 Web Part Properties & Configuration Options 19 General Properties Tag Cloud Properties Display Properties Errors Tag Field Type - Introduction 24 Tagging Feature General Settings Tagging Feature Tags List Adding the Tag Field to SharePoint content Working with the Tag Cloud web part FAQ Do I have to install anything on my company's client-pcs? 29 Version Release Notes Version History 30 This Version's Known Issues/Limitations 30 Technical Support

4 Introduction KWizCom SharePoint Tagging Feature enables the tagging of SharePoint content such as documents, list items, pictures, forms etc. Furthermore, with the included Tag Cloud Web Part, SharePoint Tagging Feature enables many new capabilities such as presentation of items according to tags, tagging alerts, and more... KWizCom SharePoint Tagging Feature supports MOSS 2007 / WSS 3.0. This document provides all the information needed to install, evaluate and deploy this KWizCom product: Product overview Installation guide Component activation Administrator guide FAQ Version release notes 4

5 Overview KWizCom SharePoint Tagging Feature combines the Tag Cloud web part and the Tag Field type, providing you with a complete tagging solution for your SharePoint content. SharePoint Tagging Feature works both on site collection level as well as on a single site level. This means that you can manage tagging for an entire site collection with the designated keyword list, and you can also use a local tag list and a specific keywords list for a single site. Tag Field Type By using this field type you can tag SharePoint list and libraries items. You can type the tag's title manually, use the auto complete feature or select a tag from the list by clicking it: The SharePoint List Tag Field type allows you to tag your SharePoint content in order to easily manage it with the Tag Cloud web part. By using tagging you can also use this field in order to create custom views: 5

6 Tag Cloud Web Part The Tag Cloud web part allows you to view your tags in two convenient ways: Tag Cloud View: Each tag has a different size which is determined by the ratio of its usage in comparison with other tags. This way it is easier for you to find what your users are using the most, while still having a full picture of all site tags. 6

7 Tag Index View: In this view the tags are listed and sorted alphabetically, for easier access to all tags. 7

8 Key Features & Benefits Feature Support MOSS 2007 / WSS 3.0 Display site collection tags Select a fixed number of tags for displaying View tags with sizing - Size of tags changes according to number of tagged Items Tags alert subscription - alert users when Item was tagged using their chosen tags Multilingual (standard for all KWizCom components) Standard edition 8

9 Installation Software prerequisites Server Requirements 1. Microsoft Windows SharePoint Services 3.0 (WSS 3.0) or 2. Microsoft Office SharePoint Server 2007 (MOSS 2007) Client PC Requirements 1. Microsoft Windows XP (SP2) or Windows Vista 2. Microsoft Internet Explorer 6 or Microsoft Internet Explorer 7 Installation Procedure 1. Log in as local administrator to your SharePoint server. 2. Unzip the KWizCom SharePoint Tagging Feature installation zipped file on your WSS/SPS server. 3. Double-click the.msi file in order to begin the installation. When the installation process is complete it will recycle all application pools automatically. 4. Next, go to the site settings at the root level and click on "Site collection features" located under "Site Collection Administration": 9

10 5. Locate "KWizCom Tagging Feature" and click the "Activate" button next to it: 6. That's it! Your KWizCom SharePoint Tagging Feature is up and running! 10

11 Post Installation 1. After completion of the installation, you will see a new KWizCom entry in Windows Start -> All Programs -> KWizCom containing the following programs: About SharePoint Tagging Feature Display General Information about the component. Activate SharePoint Tagging Feature This utility enables you (the SharePoint Administrator) to activate the downloaded evaluation version. SharePoint Tagging Feature Resource Editor This utility enables you (the SharePoint Administrator) to translate the component to your local language. Please review the next sections for further details about component localization and activation. SharePoint Tagging Feature User Guide Link to user-guide document (.PDF). 2. When you browse your SharePoint Portal/ Windows SharePoint services site, a new Tagging Feature Web Part will be available for you under "virtual Server Gallery". 11

12 3. In the root level's site settings you will find the "KWizCom Tagging Feature Management": There you can configure general settings for the KWizCom Tagging Feature (see the Administration Guide in order to find out how). 12

13 Component Localization Every KWizCom component comes with localization utility called "Resource File Editor" that enables translation of the component user interface to any required language. This section describes this utility and the translation process. Resource File Editor utility structure This utility displays the following dialog that enables the administrator to translate every displayed string (captions, menu items, user-messages) to the required target language. Here you select the target language All internal string names The captions that should be displayed in your localized language The default displayed caption for each string in English 13

14 The application displays 2 controls: "Select Culture" drop-down contains a list of target languages. Strings grid This grid contains all the strings displayed by the component. The grid includes 3 columns: a. Internal Name This column displays the internal name of each string (read only). b. Default Value The default displayed value in English (read only). c. Localized Value The translated value in the selected language. This is where you enter the required translated value. Once you finish translating all the component strings, click "Create" and a resource file will be created. This resource file will automatically be used by the component upon changing the user language on your server. For example: In an MS SharePoint-based component, you should create a site using your required SharePoint Language Pack. According to the SharePoint site language, the relevant language's resource file will be used by the component. Translating a KWizCom component 1. On your Windows task bar, select: Start->All Programs->KWizCom->SharePoint Tagging Feature web part-> SharePoint Tagging Feature Resource Editor 2. Select your target language on the "Select Culture" drop-down list. 3. Translate all the displayed strings in the strings grid by entering a translated value in the "Localized Value" column. 4. Click the "Create"/"Update" button in order to create/save a resource file for the selected target language. 14

15 5. If you want to create additional resource files for more target languages, simply repeat stages 2-4 for each language. 6. Close the utility by clicking the "Close" button. Use the component in your preferred language All KWizCom components use.net localization mechanism. This means that a KWizCom component will automatically use a language resource file according to the displayed application's language (this is true for all types of components). 15

16 Component Activation KWizCom components are available for evaluation prior to purchase. This way you can try our components and verify that they indeed meet your needs. An evaluation version for each KWizCom component contains all features of the component's production version. The only difference is that an evaluation version is time-limited, and will operate for a period of one month. Once you decide to order a KWizCom component, you will need to follow the following steps: 1. Order the component on the KWizCom website 2. Send us the installed evaluation version's product Code (you will see the product Code on the "About" product page: Please use the Activation Request web form, on KWizCom web site to send us your product code. 16

17 3. Get the component activation key this key will be sent to you by once your order is processed. 4. Activate your installed evaluation version - click Start -> All Programs -> KWizCom -> SharePoint Tagging Feature -> Activate SharePoint Tagging Feature web part 17

18 Administration Guide The KWizCom Tagging Feature combines two major components in order to provide the full tagging solution: Tag Cloud web part. Tag Field Type. This section will cover these two components, starting with the Tag Cloud web part: Tag Cloud web part - Introduction When you browse your SharePoint Portal/ Windows SharePoint services site, a new KWizCom Tag Cloud Web Part will be available for you under "virtual Server Gallery": This section reviews Tag Cloud web part's properties and configuration options. 18

19 Web Part Properties & Configuration Options The web part's properties are grouped to 3 categories: General Properties Tag Cloud properties Display Properties The following sections provide details about each category. 19

20 General Properties This section includes some general properties such as: Display Mode choose between Tag Cloud mode or Tag Index mode. Filter by list type You can filter the tags according to the list types. Use site collection tags When you want to use a site collection level keywords list select 'Yes'. In order to use a single site keywords list with specific tags for that site select 'No'. Tag Cloud Properties Use this section to limit the number of tags you wish to display in the Tag cloud web part. Type 0 (zero), in order to allow an unlimited number of tags. 20

21 Display Properties In this section you customize the look and feel of the Tag Cloud web part using your own.css file. The Tagging Feature uses the following SharePoint styles: Standard View Styles:.ms-navitem Index View Styles:.ms-iactionitem.ms-pagebreadcrumbs.ms-sitemapdirectional To create your own style sheet, you will need to create a new.css file and to place it in the following directory: C:\Program Files\Common Files\Microsoft Shared\web server extensions\12\template\layouts 21

22 To create your own.css file, please follow these steps: 1. Create a new.css file using your favorite text editor. 2. Inside the file, be sure to include the styles used by the Tagging Feature (those you wish to change). 3. And to replace the 'ms' prefix with your own. Example: /* Standard View Styles */.[your_prefix]-navitem { [Insert your own style configurations here] } /* Index View Styles */.[your_prefix]-iactionitem { [Insert your own style configurations here] }.[your_prefix]-pagebreadcrumbs { [Insert your own style configurations here] }.[your_prefix]-sitemapdirectional { [Insert your own style configurations here] } Once you have your CSS file in place, simply type the custom.css file's URL at the top text box (titled "Stylesheet"). For example, if you placed the file in the folder mentioned above, type in the following URL: /_layouts/[file_name].css Then, type [your_prefix] in the second text box (titled "Stylesheet prefix"). 22

23 Errors In this section you can choose to hide the error messages from the users or to explicitly display errors for debugging. 23

24 Tag Field Type - Introduction The KWizCom SharePoint Tagging Feature Tag Field Type allows you to tag SharePoint content like documents, list items, pictures, forms, etc. This section addressed the following issues: Tagging Feature general settings. Tagging Feature Tags List. Adding the Tag Field to SharePoint content. Working with the Tag Cloud web part. Tagging Feature General Settings In order to configure the general setting of the KWizCom SharePoint Tagging Feature, go to the root level site settings and click on the "KWizCom Tagging Feature Management" located under "Site Administration Settings": In this page you can configure the Tags Field general settings for creating tags and alerts subscription settings. 24

25 Tagging Feature Tags List At the bottom of the "Tagging Feature Settings" page (see section above) you will find a link to the top-level Tags List (titled "Global Tags List"). You can navigate directly to this list using the following URL: When you add a new tag to this list you will need to fill in the following fields: Title The current tag's title. Counter This number represents the usage count of the current tag. The Tag Cloud web part displays the tags in different sizes according to their counter values. A tag's size is determined in correspondence with the ratio between its counter value and the other tags' counter values. AlertsList List of addresses for subscribed users. 25

26 Adding the Tag Field to SharePoint content After the complete installation and SharePoint feature activation of the KWizCom SharePoint Tagging Feature, a new field type will be added to your SharePoint solution. In order to start using the Tagging Feature,, you will need to add a new column to either existing SharePoint lists and libraries or to those you will create from now on: The new field type has several properties you can configure: Description General column description Require that this column contains information Select 'Yes' if you wish to make this column mandatory when creating new items. Use Site Collection Tags List Check to use the root level's Tags List. 26

27 Add to Default View Check to include this column in the default view of the SharePoint list. Working with the Tag Cloud web part After the "Tags" column has been added to the SharePoint lists you wish to tag, you can start adding tags to the lists' items. When you add (or edit) an item you will see the new property you created: You can type the relevant tag manually or click the "(Show all)" link to select one from the available tags in the Tags List: 27

28 Note: You can manually type a new tag and it will be added to the Tag List automatically try it! Once your items include tagging information in their "tags" fields, you will be able to see the tags in the Tag Cloud web part, their sizes are in proportion with their usage in the tagged items (In this example, 'Accounting Dep.' is the most used tag, so it appears larger than other tags): You can click on a tag to see the items that include this tag (click on the item's title to see its details): 28

29 FAQ Do I have to install anything on my company's client-pcs? No. KWizCom SharePoint Tagging Feature is a server installation. 29

30 Version Release Notes Primary Software Version Base version n/a Release date Oct Sub-Modules Module Version n/a n/a Version History CR # Description This Version's Known Issues/Limitations CR # Description 30

31 Technical Support You can obtain technical support using any of the following methods: The KWizCom Web site The KWizCom website at contains the most updated valuable information, including: Answers to frequently asked questions (FAQ's) about our products usability and technical questions. Product updates, which provide you with bug fixes and new features. The Web Form For technical support through the Internet, please fill in our support web form on our web site For more information on technical support, please review our support programs page. 31