blob: 0311f0a37d6649cd9d95435de27369c6fafcc91b [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/2000/REC-xhtml1-20000126/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<style type="text/css">
/* <![CDATA[ */ @import "/branding/css/tigris.css"; /* ]]> */
</style>
<script src="/branding/scripts/sc.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="/branding/css/print.css" media="print" />
<title>Remote branding</title>
</head>
<body class="docs" onload="self.focus()">
<div class="docs" id="remotebranding">
<h2>Remote Branding</h2>
<p>Remote branding allows you to edit your site's master templates and static HTML and commited to the site's CVS repositiory. Once commited, edits show immediately on the site. You can make changes on your local, check them into the CVS repository, and they will automatically show on the site. While remote branding allows for quick and immediate changes, it does not have a place to preview or stage, so an errant edit can trash a running site.</p>
<h3>Files for Remote Branding</h3>
<p>Remote Branding files reside in two directories: <strong>LOOK</strong> and <strong>WWW</strong>.</p>
<p>The <strong>LOOK</strong> directory contains files that appear on every page. This includes the top banner, the footer, and the left navigational column. The following files can be found in the look/www/master directory:</p>
<ul>
<li>Banner.wm-- the top banner/header area</li>
<li>Footer.wm-- the bottom footer area</li>
<li>Nav_Column.wm-- the left navigational column area</li>
<li>Project_Nav.wm-- the navigation for project resources, which appears underneath the top banner on each project-related page</li>
<li>style.css-- the cascading style sheet for the site</li>
<li>headerscript.js-- javascript that is included in the &lt;head&gt; of each page on the site</li>
<li>images/-- the directory of all of the images on the site</li>
</ul>
<p>The <strong>WWW</strong> directory contains static html content, such as site documentation, project files, and help files.</p>
<h3>How to Modify Remote Branding Files</h3>
<p>To make changes to the remote branding files, you must have an account on the site and the role of Developer (or higher permissions) on the <strong>WWW</strong> and/or <strong>LOOK</strong> projects.</p>
<ol>
<li>log into CVS</li>
<li>check out two directories, look and www.</li>
<li>
Find the files you wish to modify and move them into a working directory on your local machine.
<p>Note the URL of the file you wish to change. If it is simply $URL/FILENAME, or $URL/project/www/FILENAME, the file will be located in the current (www/www/) directory. If it is $URL/docs/FILENAME, or $URL/project/www/docs/FILENAME, it will be located in the the /docs directory (www/www/docs). If it is in another directory, such as $URL/[DIRECTORIES]/FILENAME or $URL/project/www/[DIRECTORIES]/FILENAME, it will be located in the /[DIRECTORIES] directory (www/www/[DIRECTORIES]).</p>
</li>
<li>Edit files using the editor of your choice, save your changes, and exit the file editor.</li>
<li>Commit the changes to the CVS repository, which will deploy your changes onto the live site. BE VERY CAREFUL, as once you commit, the changes will appear, including any mistakes in spelling, html code, or file names in links or image tags.</li>
<li>Refresh your browser if it is already open on a page that should be affected by your change.</li>
</ol>
<p>Note: Servlets, eg $URL/servlets/ProjectMail, cannot be changed in the above manner. Changing template front ends for the servlets requires customization from the provider, CollabNet.</p>
<div class="courtesylinks">
<p><a href="#toc">Top</a> | <a href="/nonav/servlets/HelpTOC">Help index</a></p>
</div>
</div>
</body>
</html>