<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-gb">
	<head>
		<title>Stephen Philbin's Colourcoder - Manual</title>
		<meta name="description" content="The user's guide to Colourcoder."/>
		<meta name="keywords" content="HTML, CSS, Colourcoder, colour, color, number, code, Web, design, hexadecimal, decimal, value, guide, howto"/>
		  <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8"/>
		<meta name="Content-Script-Type" content="text/javascript; charset=UTF-8"/>
		<meta name="Content-Style-Type" content="text/css; charset=UTF-8"/>
		
		<link rel="shortcut icon" type="image/x-icon" href="/images/icons/colourcoder/colourcoder16x16.png"/>
		<link rel="stylesheet" type="text/css" href="/css/common/all.css" media="all"/>
		<link rel="stylesheet" type="text/css" href="/css/common/screen.css" media="screen"/>
		<link rel="stylesheet" type="text/css" href="/css/common/handheld.css" media="handheld"/>
		<link rel="stylesheet" type="text/css" href="/css/common/print.css" media="print"/>
		<link rel="stylesheet" type="text/css" href="/css/colourcoder/all.css" media="all"/>
		<link rel="stylesheet" type="text/css" href="/css/colourcoder/man-all.css" media="all"/>
		<link rel="stylesheet" type="text/css" href="/css/colourcoder/screen.css" media="screen"/>
		<link rel="stylesheet" type="text/css" href="/css/colourcoder/man-screen.css" media="screen"/>
		<script type="text/javascript" src="/javascript/colourcoder/download_swap.js"/>
	</head>
	<body id="colourcoder_manual">
		<h1><a href="/colourcoder">Colourcoder User's Manual</a></h1>
	  <ol id="navigation-trail">
	    <li><a href="/">Stephen Philbin.com</a></li>
	    <li><a href="/colourcoder/">Colourcoder Home</a></li>
	    <li><a href="/colourcoder/manual/">Colourcoder's Manual Page</a></li>
	  </ol>
		<div id="manual">
			
			<p>Colourcoder has been designed to be as intuitive as possible; however, it's expected that the function of some parts of Colourcoder may not be quite clear to everyone. The following is a simple guide detailing the usage and behaviour of Colourcoder.</p>
			
			<h2>Installing Colourcoder</h2>
			
			<p>Colourcoder has been designed so that it does not actually need to be installed. You simply use the <a href="/colourcoder/Colourcoder.jar">Colourcoder.jar program file</a> from whichever location is convenient to you. I would recommend a <abbr title="Universal Serial Bus">USB</abbr> memory stick so you can use it wherever you are, but just about anywhere should work.</p>
			
			<p>Despite the fact that Colourcoder does not need to be installed (at least not in the traditional sense anyway), it does still requite that a reasonably up-to-date version (Java Standard Edition 6 or higher) of Java be installed on the computer you want to use it on. Most computers do have a reasonably up-to-date version of Java installed, but if yours doesn't then you can download it (<abbr title="Java Runtime Environment">JRE</abbr> 6 or higher) from <a href="http://java.sun.com/javase/downloads/index.jsp">Sun</a>.</p>
			
			<h2>Using Colourcoder's Controls</h2>
			
			<div id="index-window">
				<ul id="index">
					<li id="index-light-levels"><a href="#light-levels">Light Levels</a></li>
					<li id="index-sample-history"><a href="#sample-history">Sample History</a></li>
					<li id="index-current-sample"><a href="#current-sample">Current Sample</a></li>
					<li id="index-check-index-button"><a href="#check-index-button">Check Colour Index Button</a></li>
					<li id="index-store-sample-button"><a href="#store-sample-button">Store Sample Button</a></li>
					<li id="index-number-format"><a href="#number-format">Number Format Selector</a></li>
					<li id="index-sample-index-field"><a href="#sample-index">Colour Sample Index Field</a></li>
				</ul>
			</div>
			
			<dl>
				<dt id="light-levels">Light Levels</dt>
				<dd>
					<p>The <a href="#light-levels">Light Levels</a> are your main controls for colour mixing. Each of the three <em>Lights</em> represent their respective part of a resulting colour, and therefore the resulting colour index. To create your colours simpliy slide each Light's level up or down to get the desired mix of colours. The higher up the bar you go, the brighter and stronger the Light is (which is why the darker colours are always toward the bottom of the bars). Any given point on a Light's coloured bar displays the colour which you would create if you moved the level of the Light up or down to it without changing the levels of any of the other Lights. So if you see one of the bars displaying a colour you want, simply change the level of the Light that is diplaying the colour you want up or down to that colour.</p>
					<p>[<a href="#index">Back to controls</a>]</p>
				</dd>
				<dt id="sample-history">Sample History</dt>
				<dd>
					<p>The <a href="#sample-history">Sample History palette</a> is where you can store any colour samples you like and would want to easily find again. Once you have stored a colour in one of the palette's cells you can recall it simply by clicking on it. The colour's index value will then be written into the <a href="#sample-index">Colour Sample Index field</a> and the levels of each <a href="#light-levels">Light</a> will be repositioned accordingly.</p>
					
					<p>[<a href="#index">Back to controls</a>]</p>
				</dd>
				<dt id="current-sample">Current Sample</dt>
				<dd>
					<p>The coloured box in the sample data section of Colourcoder's display is the <a href="#current-sample">Current Sample box</a>. It simply displays the resulting colour you get from mixing the current levels of each <a href="#light-levels">Light</a>.</p>
					
					<p>[<a href="#index">Back to controls</a>]</p>
				</dd>
				<dt id="check-index-button">Check Colour Index Button</dt>
				<dd>
				  <p>The <a href="#check-index-button"><em>Check Colour Index</em> button</a> is used to force Colourcoder to display the colour that corresponds to an index you have manually entered into the <a href="#sample-index">Colour Sample Index field</a>. So, for example, manually typing #777777 into the <a href="#sample-index">Colour Sample Index Field</a> and pressing the Check Colour Index Button would set the colour being displayed in the Current Sample box to be Grey, and adjust the levels of each <a href="#light-levels">Light</a> accordingly.</p>
					
					<p>[<a href="#index">Back to controls</a>]</p>
				</dd>
				<dt id="store-sample-button">Store Sample Button</dt>
				<dd>
					<p>The <a href="#store-sample-button"><em>Store Sample</em> button</a> is used to save any samples you find and want to keep in the <a href="#sample-history">Sample History palette</a>. Simply press the button and the colour sample shown in the <a href="#current-sample">Current Sample box</a> will be stored in a cell in the palette. Up to 40 samples can be stored in the palette. Any newly stored samples after the 40th will cause the oldest sample to be lost.</p>
					
					<p>[<a href="#index">Back to controls</a>]</p>
				</dd>
				<dt id="number-format">Number Format Selector</dt>
				<dd>
					<p>The <a href="#number-format"><em>Number Format Selector</em></a> buttons allow you to choose which number and notation format will be used to display and read colour sample values to and from the <a href="#sample-index"><em>Colour Sample Index</em> field</a>.</p>
					
					<p>[<a href="#index">Back to controls</a>]</p>
				</dd>
				<dt id="sample-index">Colour Sample Index Field</dt>
				<dd>
					<p>The <a href="#sample-index"><em>Colour Sample Index</em> field</a> displays the colour index value of the colour you have created that is being displayed in the <a href="#current_sample"><em>Current Sample</em> box</a>. It also allows you to enter arbitrary colour index values so that you can check them with the <a href="#check_index_button"><em>Check Colour Index</em> button</a> and see the colour displayed in the <em>Current Sample</em> box.</p>
					
					<p>[<a href="#index">Back to controls</a>]</p>
				</dd>
			</dl>
			
			<h2>Colourcoder's Sample History File</h2>
			
			<p>Each time Colourcoder is started it will check to see if there is a <em>sample_history</em> file in the same folder that the Colourcoder.jar program file is stored in. If there is, then it will read the data inside it to restore the colours you have chosen to save in your <a href="#sample_history"><em>Sample History</em> palette</a>. However, if no such file exists then Colourcoder will check to see if it is allowed to write this very small (0.15KB) file. If it is allowed then it will use it to store the saved samples as normal. If Colourcoder is not allowed to write the file then you will still be able to store samples in the palette as normal whilst Colourcoder is running, but once you close Colourcoder, the sample data saved in the palette will be lost.</p>
		</div>
	</body>
</html>