You are not logged in Log in Join
You are here: Home » Members » paul » Cleanskin Zope/CMF Skin » INSTALL.txt » View Document

Log in
Name

Password

 

INSTALL.txt

Installation Instructions for cleanskin

Welcome! cleanskin is a skin for the CMF. It works with CMF 1.2b1 or later and Zope 2.5.

As noted in README.txt, cleanskin is meant to be viewable from the filesystem, outside of Zope. Want a rough idea of what cleanskin looks like? Then open main_template.html in a web browser.

Installing cleanskin for Zope/CMF is similar to installing other CMF products. That is, it's pretty hard.

In a nutshell, you have to do three things:

  • Put things in the right place
  • Fixup the files
  • Run an external method

First, unpack this archive and make sure that it is available in the Products area of your Zope software area. Thus you should have a cleanskin subdirectory in Products.

Second, cleanskin follows a convention that the CMF won't support until after CMF 1.2b1. That is, filesystem skin files ending in .html won't be registered as page template objects in the skin folder. Thus you have three choices to make cleanskin work with CMF 1.2b1:

  • Copy all the .html files in cleanskin to .pt files
  • Get the CVS version of CMFCore/FSPageTemplate.py from cvs.zope.org
  • Open CMFCore/FSPageTemplate.py and add the following line at the bottom:
        registerFileExtension('html', FSPageTemplate)
    

At this point you can restart your Zope and look in the Control Panel to see if the cleanskin product installed. If something is wrong you will find a broken product icon next to cleanskin.

Third, you need to run an external method from the Extensions/Install.py module. This module is an installation script for this cleanskin skin. It's meant to be used as an External Method. To use, add an external method to the root of the CMF Site that you want ZPT skins registered in with the configuration:

id: install_cleanskin title: Install Clean Skin module name: cleanskin.Install function name: install

**Note: It's true that the module name omits Extensions from the path.**

Then go to the management screen for the newly added external method and click the Test tab. The install function will execute and give information about the steps it took to register and install the clean skin into the CMF Site instance.

When this script completes you will see two plaintext messages. To confirm that your script has worked correctly, make sure you have a cleantext folder in portal_skins. Also, click on portal_skins, then click on the Properties tab. You should see cleanskin listed as a possible skin. If you want to immediately see the results of using this skin, use this screen to make cleanskin the default skin.

Again, remember that you can view cleanskin from the filesystem, outside of Zope. Simply open cleanskin/skins/cleanskin/main_template.html in a browser.