KWizCom SharePoint SEO Toolkit

Transcription

1 KWizCom Corporation KWizCom SharePoint SEO Toolkit User Guide

2 Copyright KWizCom corporation. All rights reserved. Company Headquarters KWizCom 50 McIntosh Drive, Unit 109 Markham, Ontario ON L3R 9T3, Canada Web site: Sales Telephone: Copyright KWizCom corp. All rights reserved. Page 2 of 21

3 CONTENTS Contents... 3 Introduction General... 5 Product Overview... 5 The Business Need... 7 Key Features... 7 Installation Guide... 7 Software Requirements... 7 Server Requirements... 8 Client Requirements... 8 Installation Procedure... 8 Post Installation... 8 How to Uninstall Administration Guide... 9 Component Activation... 9 Activating Sharepoint SEO Toolpack Upon Activisation Sharepoint SEO Toolpack Configuration Introduction SEO Settings page - Categories & Configuration Options SEO supported MasterPage Configuration User Guide Copyright KWizCom corp. All rights reserved. Page 3 of 21

4 FAQ Can I use the Sharepoint SEO Toolkit on several site collections? Do I have to install anything on my company's client-pcs? Does this Feature support WSS 3.0? Version Release Notes Version History Appendix A: Project Filter Examples Copyright KWizCom corp. All rights reserved. Page 4 of 21

5 INTRODUCTION GENERAL This document provides all the information needed to install, evaluate and deploy KWizCom s SEO Toolkit: Introduction Installation Guide Administrator Guide User Guide FAQ Version Release Notes PRODUCT OVERVIEW KWizCom SharePoint SEO Toolkit KWizCom SharePoint SEO Toolkit is a package of tools that answer the search engine optimization needs of your SharePoint portal including creating and crawling settings of the sitemap and Robots files and adding custom page Meta tags. Now you have the tools to make your SharePoint site collections accessible from any search engine! Here s how: Copyright KWizCom corp. All rights reserved. Page 5 of 21

6 Creation of sitemap.xml and Robots.txt files - these files indicate which content of your sites should or should not be crawled by the search engines. The ability to set page Meta tags - these tags display text or dynamic content defined per site or library. You can easily define these new settings via the SEO settings pages available for every site or list/document library. Copyright KWizCom corp. All rights reserved. Page 6 of 21

7 THE BUSINESS NEED KWizCom SharePoint SEO Toolkit was created to answer the following issues/limitations: XML Site Map Creation - Sitemaps are an easy way for webmasters to inform search engines that pages on their sites are available for crawling. In its simplest form, a sitemap is an XML file that lists URLs for a site along with additional metadata about each URL (when it was last updated, with what frequency changes tend to occur and how important the page is, relative to other URLs in the site) so that search engines can more intelligently/effectively crawl the site. Simply put, the site map categorizes the site's content to make search engine results more relevant Robots text file creation - Web site owners use the /Robots.txt file to give instructions about their site to web robots, telling them which content they shouldn't crawl. Editing Page Meta Tags - Meta Tags are information inserted into the "head" area of web pages. Aside from the title tag (which appears as the tab title of the browser), information in the header area of web a page is not seen by those viewing your pages in browsers. The meta information in this area is used to convey information that a human visitor may not be concerned with but assists the search engines in showing on-the-mark results. KEY FEATURES Main key features of KWizCom SharePoint SEO Toolkit are: Feature SEO Toolkit MOSS 2007 out-of-the-box Creation of sitemap.xml and Robots.txt files according to protocol Ability to define crawling settings Page Meta Tags management interface Creation of supporting SEO site columns and content types INSTALLATION GUIDE SOFTWARE REQUIREMENTS Copyright KWizCom corp. All rights reserved. Page 7 of 21

8 SERVER REQUIREMENTS Microsoft Office SharePoint Server 2007 (MOSS 2007) CLIENT REQUIREMENTS Microsoft Windows XP SP2/ Vista SP1 Microsoft Internet Explorer 6 + or Mozilla Firefox 2+ or Google Chrome INSTALLATION PROCEDURE 1. Log in to your SharePoint server as local admin. 2. Download the product s latest version from KWizCom s internet web site. You are downloading an evaluation version which is fully functional for 30 days. For more information on this please see further details about product activation in the Administrator guide (next section). 3. Unzip the product s zip file on your SharePoint server. 4. Double-click the.msi file in order to begin the web installation. 5. When the installation process is complete all application pools will be recycled automatically. POST INSTALLATION After completing the installation, you will see a new KWizCom entry in Windows Start -> All Programs -> KWizCom which will contain the following programs: o o About SharePoint SEO Toolkit This displays general information about the component. Activate SharePoint SEO Toolkit This utility enables you (the SharePoint Administrator) to activate the downloaded evaluation version. HOW TO UNINSTALL 1. Log in to our SharePoint server as local admin. 2. Go to Control Panel and double-click Add or Remove Programs. Copyright KWizCom corp. All rights reserved. Page 8 of 21

9 3. Select the SharePoint SEO Toolkit entry and click the Remove button. 4. Click Yes to approve the removal of the component. 5. Once the product is uninstalled, close the Add or Remove Programs screen. ADMINISTRATION GUIDE This section describes all administration activities related to the product, including: product localization, product configuration and customization. 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 between the versions is that the evaluation version is time-limited and will cease to operate after a period of one month. Congratulations! You decided to order a KWizCom component. Here is what to do next: 1. Order the component on the KWizCom website or contact our sales team at sales@kwizcom.com. 2. After you make the order, send us the installed evaluation version's Product Code (you will see the product code on the "About" product page: Product Code Copyright KWizCom corp. All rights reserved. Page 9 of 21

10 Please note: Use the Activation Request web form, on KWizCom web site to send us your product code. 3. Get the component activation key we will send this to you via once your order is processed. 4. Activate your installed evaluation version - click Start -> All Programs -> KWizCom -> SharePoint SEO Toolkit -> Activate SharePoint SEO Toolkit ACTIVATING SHAREPOINT SEO TOOLKIT 1. Log on to the SharePoint site collection and click Site Actions-> Site Settings-> Modify All Site Settings 2. Under Site Collection Administration click Site Collection Features 3. Click the "Activate" button next to the SharePoint SEO Toolkit Feature Note: You need to activate the feature for every site collection in which you desire to utilize the SEO capabilities. UPON ACTIVISATION The following site columns and content type are added to the site collections galleries to assist you in configuration of your SEO settings: SEO Item content type SEO Page content type Both content types include the following site columns: (which may also be added to other content types) Disallow Crawl choice (Yes or No) field SEO Priority number (with Show as percentage option limited to 100%) field SEO Frequency choice (Always, Hourly, Daily, Weekly, Monthly, Yearly, Never) field Page Title single line of text field Page Description single line of text field Page Author single line of text field Page Copyright single line of text field Copyright KWizCom corp. All rights reserved. Page 10 of 21

11 Page Expires Date field Page Keywords single line of text field Note: These site columns and content types are removed if the feature is deactivated. SHAREPOINT SEO TOOLKIT CONFIGURATION INTRODUCTION When you browse your SharePoint Portal you will see that a new SharePoint SEO Toolkit settings page is available under each site/list settings menu. New site columns and content type are available to assist in your SEO settings configuration. This section reviews the SharePoint SEO Toolkit settings page categories and configuration abilities. SEO SETTINGS PAGE CATEGORIES & CONFIGURATION OPTIONS The SEO settings are grouped into the following categories: Scheduling Parameters (available only on site collection level) Site Map Definitions Page Meta Tags Tokens Override Parameters (available on all levels under the site collection level) The following sections provide details about each category. Scheduling Parameters Property Description Comment Run every _ days This property defines how often the sitemap and Copyright KWizCom corp. All rights reserved. Page 11 of 21

12 Robots files will be updated. Starting time This property defines the starting time of the sitemap and Robots files crawl. Site Map Definitions Property Description Comment Disallow crawl Change frequency This property defines whether the site/list should be crawled or not This property defines how often the crawled content changes, the options are fixed: Always Hourly Daily Weekly Monthly Early Never This property can inherit its values from any yes/no field. The default is the "Disallow crawl" SEO site column. This property can inherit its values from any choice field that includes the stated options. The default is the "SEO Frequency" site column. Copyright KWizCom corp. All rights reserved. Page 12 of 21

13 Priority This property indicates the importance of the page relative to other site pages, ranging from 0 to 100. This property can inherit its values from any number field. The default is "SEO Priority" site column. Page Meta Tags Property Description Comment Title Description Author This property defines how the page title appears when browsing to the page This property defines the page description which is added as a meta tag to the page header This property defines the page Author which is added as a meta tag to the page header This property supports text, tokens and single line of text fields, which can be added using the token {Field} This property supports text, tokens and single line of text fields, which can be added using the token {Field} This property supports text, tokens and single line of text fields, which can be added using the token {Field} Copyright This property defines the page copyrights description This property supports text, tokens and single line Copyright KWizCom corp. All rights reserved. Page 13 of 21

14 Expires Keywords which is added as a meta tag to the page header This property defines the page expiration date which is added as a meta tag to the pages header This property defines the pages Keywords which are added as Meta tags to the pages header of text fields, which can be added using the token {Field} This property supports text, tokens and date fields, which can be added using the token {Field} This property supports text, tokens and single line of text fields, which can be added using the token {Field} Tokens Tokens are meaningful names enclosed in curly brackets. In this context tokens are used to map page meta tags with dynamic content or available fields and site columns. Property Description Comment {SiteCollectionTitle}, {SiteCollectionDescription}, {SiteCollectionAuthor}, {SiteCollectionCopyright}, {SiteCollectionKeywords} {SiteTitle}, {SiteDescription}, {SiteAuthor}, {SiteCopyright}, {SiteKeywords} {Field} When editing a page meta tag one of these tokens may be clicked to insert the page meta tags as defined on the site collection level When editing a page meta tag, one of these tokens may be clicked to insert the page meta tags as defined on the sites level When editing a page meta tag - clicking on the {Field} token opens a dropdown of fields from which the user can select one. The dropdown content depends on the context: in site or site collection settings - the dropdown displays all site columns of the same type. In list settings - the dropdown displays all list fields of the same type. Available on site and list levels Available on list level only Available on all levels Override Parameters By default all the SEO settings defined on the site collection level are related to sub sites and lists located under the site collection. This definition can be overridden at each level by clicking the "Override Copyright KWizCom corp. All rights reserved. Page 14 of 21

15 Parameters" button. Once clicked a pop up window will ask if you are sure you want to break the inheritance chain by clicking Ok. Once the inheritance is broken changes can be made to the SEO settings page (which will be passed onwards to any existing subsites). If the changed settings are no longer relevant, clicking on the same button which will now read "Inherit Parameters" will re-inherit the settings from the upper level. Note: Although the settings are inherited it is possible to produce settings on a site/site collection level that use a site column that is not used in some lists. To prevent this from becoming a problem settings containing {Field} tokens will be validated for existence and will be replaced with the default defined in the list s SEO settings page. Copyright KWizCom corp. All rights reserved. Page 15 of 21

16 SEO SUPPORTED MASTERPAGE CONFIGURATION To configure the page meta tags to appear in the source of the page a few simple changes must be done to the site master page: 1. Go to Start-> All Programs-> Microsoft Office-> Microsoft Office SharePoint Designer 2. Click File-> Open Site and insert the URL of site to which you want to apply the SEO page meta tags and click Open 3. Under the folder list click on the _catalog folder then click on master page and choose the default master page that is defined on your site collection (If the master page was never changed click the Default.master) 4. A pop-up box will ask you if you want to check out the file- click Yes 5. Once the master page loads (note that this could take a few moments) click the Code option on the bottom of the page. 6. Go to the <HEAD runat="server"> tag: Delete the <Title ID=onetidTitle> and the closing tag </Title>, on the same line add to the asp:contentplaceholder id="placeholderpagetitle" after runat="server" add visible="false" before the /> closing tag. 7. Go up one line to <Sharepoint:RobotsMetaTags runat="server" and add visible="false" before the /> closing tag. 8. Go to the last line before the closing tag </HEAD> and insert this new line: <SharePoint:DelegateControl runat="server" ControlId="SEOMetaTagsControl"/> Copyright KWizCom corp. All rights reserved. Page 16 of 21

17 The HEAD segment should now look like this: 9. Click File-> Save and on the Site Definition Page Warning click Yes. 10. Now Right Click the checked out master page and choose Check In, check the Publish a major version and then click Ok. 11. On the pop-up requesting content approval click Yes, and a new window will open- under Pending approval will appear your master page, click the Approve option under the edit menu, you will be redirected to a new window asking for approval comments, insert a comment if necessary and click Ok. That s it! Any meta tags defined on the SEO settings page of a site/library will appear in the source code of the pages inheriting these settings Copyright KWizCom corp. All rights reserved. Page 17 of 21

18 USER GUIDE The SEO settings should be defined initially on the site collection level: First the scheduling parameters for the builder of the site map and the Robots.txt file should be defined at the most suitable to the organizations working hour's time. Then the Site Map Definitions should set the crawling policy for the content under the site collection. If there are any Page Meta Tags relevant to the entire site collection they should be set. After the initial site collection definitions are completed, any necessary changes to the SEO setting on site or list level should be made. For example, adding custom page Meta tags to Pages Library: A good practice is adding supporting fields to the pages library to map the page Meta tags of the pages library, so that the source for each page has unique meta tags that best reflect the content of the page: Add additional fields to your pages library that will be used by content editors to add the relevant page meta tags. You may add the SEO content type "SEO Item" to the library and use the supplied SEO Meta tag fields or create your own. Make sure that the master page of the current site was changed according to the SEO supported master page configuration section. Map the fields you created to the page meta tags under the list SharePoint SEO settings (using the {Field} token). Now by right clicking on any page and selecting View source you will be able to see (under the <HEAD> tag) your custom page meta tags. Copyright KWizCom corp. All rights reserved. Page 18 of 21

19 FAQ CAN I USE THE SHAREPOINT SEO TOOLKIT ON SEVERAL SITE COLLECTIONS? Yes. As long as the feature is installed on the server hosting the site collection, note that you have to activate the feature for every site collection separately. DO I HAVE TO INSTALL ANYTHING ON MY COMPANY'S CLIENT-PCS? No. KWizCom SharePoint SEO Toolkit is a server installation. DOES THIS FEATURE SUPPORT WSS 3.0? This version does not support WSS 3.0. Copyright KWizCom corp. All rights reserved. Page 19 of 21

20 VERSION RELEASE NOTES Primary Software Version Base Version Release Date July Sub-Modules Module n/a Version n/a VERSION HISTORY CR# Description Version 1.1.oo, July Copyright KWizCom corp. All rights reserved. Page 20 of 21

21 APPENDIX A: PROJECT FILTER EXAMPLES Project Filter parameter consists of pairs of valid Project field names and value compared using =, <, <=, >, >=, <>, LIKE, IN operators. The #Current# token will be replaced with the corresponding Project field value. Examples: 1. Get All Projects in where Program field equals to Test Program : [Program]='Test Program' 2. Get All Projects where Program field equals to current project s Program value [Program]='#Current#' 3. Get All finished but not completed projects Copyright KWizCom corp. All rights reserved. Page 21 of 21