OmCollab common skin framework

From MIKE2.0 Methodology

omCollab provides a common skinning framework to provide a common skin across multiple applications.

Listed below are changes that should me made to the integrated skin made available as part of the open methodology framework to provide a customized local version.

Also included are recommendations for further re-factoring needed to a create a more reusable skinning framework.

Making minor changes to the Skin

Changes to skins are made across multiple files in 3 locations.

Common Directory

Files listed under /common/skins

footer.php

• Users need to change the omCollabAppURLs to the relevant for their site, e.g their licensing information
• In the sample localisation file, there is a path changeas part of my_additional_build_processes.php

header.php

no changes needed for minor (colors, icons) changes

omcollab-applications.php

• no changes needed for minor (colors, icons) changes
• Path change is used for mike2 as part of my_additional_build_processes.php

common.css

• Users will change this file to change the colors and layout of the skin
• Users will change this file to link to proper images and icons

Some minor refactoring, better commenting should be done to determine what does in common.css vs main.css Should have an images dir variable to simplify changing path names for images directory

common.php

no changes needed for minor (colors, icons) changes

main.js

no changes needed for minor (colors, icons) changes

images

Users can change multiple things in images directory, e.g. the color of icons and buttons

Wiki Directory

Files listed under /w/skins

{skinname}.php

• Although it is not strictly required, users should change from mike2 naming convention to their skinname, e.g. mike2Template to myskinTemplate.

R: Might be simpler to refactor this to have it done automatically and code could be commented better.

{skinname}.deps.php

• Needs to be changed to list the filename as it is a workaround for a php5 bug. User just needs to change this file to have their {skinname}.php

{skinnamedir}/main.css

• Users will change this file to change the colors and layout of the skin
• Users will change this file to link to proper images and icons

• Some minor refactoring, better commenting should be done to determine what does in common.css vs main.css

• Should have an images dir variable to simplify changing path names for images directory

Deploy

Files listed under /deploy

my_additional_build_processes.php

This is a localization file, best used for copying local skins as part of deployment or for setting local paths in skin directories.

Some refactoring to be done

Nothing major planned at this stage, but a few items on initial review:

• Better commenting of code needed within the framework

• Some minor refactoring and commenting should be done to more clearly show the separation of responsibilities with main.css and common.css

• There are places where variables could be set as opposed to continually giving the full path name, e.g. common.css should have an images dir variable to simplify changing path names for images directory