This project is read-only.

How to install MacawSharePointSkinner

Introduction

MacawSharePointSkinner is an HttpModule. HttpModules are configured in the web.config of your ASP.NET web site. SharePoint is an ASP.NET web site. The required DLL is installed in the Global Assembly Cache (GAC).

Procedure

Follow the steps below for installation:
  • Deploy the DLL Macaw.SharePoint.Skinner.dll from the Release directory to the GAC by dragging it to the directory c:\windows\assembly using Explorer. Note that copy – paste does not work on the assembly directory, dragging is needed for automatic installation of the DLL in the GAC. The assembly can also be installed using the gacutil tool. In this case execute the following command: gacutil /i Macaw.SharePoint.Skinner.dll. This tool can be found in the directory C:\WINDOWS\Microsoft.NET\Framework\v1.1.4322 or the framework directory you are using.
  • Make a directory to contain the MacawSharePointSkinner configuration file, for example c:\MacawSharePointSkinnerConfig. Copy the files SkinConfig.xml and SharePointSkinner.xsd to this directory.
  • Open the web.config files of the portal for which you want to enable the MacawSharePointSkinner functionality, and the SharePoint /_layouts virtual directory in NotePad or another text editor. Those files can be found in the virtual directory of the portal (when SharePoint is configured on the default web site, this directory is c:\inetpub\wwwroot), and the directory C:\Program Files\Common Files\Microsoft Shared\web server extensions\60\TEMPLATE\LAYOUTS\web.config.
  • Enable support for an appSettings section:
:
<configSections>
    *<section name="appSettings" type="System.Configuration.NameValueFileSectionHandler, System, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" />*
    <sectionGroup name="SharePoint">
    :
  • Add the appSettings section with the following keys:

MacawSharePointSkinner-ConfigFile Path of the configuration file. Must be a directory path, not an URL.
MacawSharePointSkinner-Logging ‘on’ or ‘off’ to enable or disable debugging information in comments in the page


</configSections>
<appSettings>
<!-- MACAW: configuration for MacawSharePointSkinner -->
<add key="MacawSharePointSkinner-ConfigFile" value="c:\MacawSharePointSkinnerConfig\SkinConfig.xml"/>
<add key="MacawSharePointSkinner-Logging" value="on"/>
<!-- MACAW: end of configuration for MacawSharePointSkinner -->
</appSettings>


<SharePoint>
:
6 Add the MacawSharePointSkinner HttpModule:

<httpModules>
<clear />
<add name="OutputCache" type="System.Web.Caching.OutputCacheModule" />
<add name="WindowsAuthentication" type="System.Web.Security.WindowsAuthenticationModule" />
<!-- <add name="Session" type="System.Web.SessionState.SessionStateModule"/>-->
<add name="MacawSharePointSkinner" type="Macaw.SharePoint.Skinner.Skin,Macaw.SharePoint.Skinner, Version=1.0.0.1, Culture=neutral, PublicKeyToken=efcf6ac388b9b555"/>
</httpModules>
:

2.3 Final step
The final step is to modify the MacawSharePointSkinner configuration file SkinConfig.xml.
2.4 Alternative configurations
This section describes some alternative configuration possibilities for the HttpModule dll, and for the used configuration files.
2.4.1 HttpModule dll deployment
The procedure described above deploys the Macaw.SharePoint.Skinner.dll to the global assembly cache. This deployment has the advantage that you only need one step to deploy the assembly and it is available in all virtual directories. Disadvantage is that an IISRESET is needed to activate the DLL.

If you don’t want to deploy Macaw.SharePoint.Skinner.dll to the global assembly cache, you need to deploy it to the following bin directories:

• C:\inetpub\wwwroot\bin (the path to the SharePoint virtual directory)
• C:\Program Files\Common Files\Microsoft Shared\web server extensions\60\ISAPI\BIN (to keep FrontPage working, and have skinning support on the help pages)
• C:\Program Files\Common Files\Microsoft Shared\web server extensions\60\TEMPLATE\LAYOUTS\BIN (to have skinning enabled on all pages in the ‘/_layouts/’ directory)
2.4.2 Configuration files
It is possible to specify different configuration files for the different virtual directories in their corresponding web.config files. This allows for specific skinning configurations for the SharePoint virtual directory pages and the /_layouts virtual directory pages.

It is possible to specify a file pattern as a configuration file, instead of a single file. So for example if you specify c:\MacawSharePointSkinnerConfig\SkinnerSharePoint.xml as configuration file in the web.config of the SharePoint virtual directory and c:\MacawSharePointSkinnerConfig\SkinnerLayout.xml in the web.config of the /_layouts virtual directory, you can have multiple configuration files to define your skinning operations. This is used in large Share Point modification projects where each subproject has its own configuration files. Note however that the configuration files are read in undefined order, so make the configuration files as independent as possible of each other. Especially overlapping URL redirections can lead to unpredictable behavior.

If order of interpretation of configuration files is important, it is also possible to supply multiple configuration files separated by ‘;’ characters. For example: c:\MacawSharePointSkinnerConfig\mefirst.xml; c:\MacawSharePointSkinnerConfig\restoffiles*.xml

Last edited Aug 29, 2006 at 11:14 PM by svdoever, version 2

Comments

No comments yet.