carbidev/com.nokia.tools.variant.user_1.0.0.v20090225_01-11/html/topics/workingWithSettings.html
author terytkon
Wed, 02 Jun 2010 10:50:41 +0300
changeset 1 fe41c66bacc7
parent 0 30eb2d538f02
permissions -rw-r--r--
Changed rest of the sfl licences to epl :)

<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html lang="en-us" xml:lang="en-us">
<head>
<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
<meta name="copyright" content="(C) Copyright 2005" />
<meta name="DC.rights.owner" content="(C) Copyright 2005" />
<meta content="topic" name="DC.Type" />
<meta name="DC.Title" content="Working with Settings" />
<meta content="XHTML" name="DC.Format" />
<meta content="workingWithSettings" name="DC.Identifier" />
<link href="..\..\css/commonltr.css" type="text/css" rel="stylesheet" />
<title>Working with Settings</title>
</head>
<body>


  <div class="nested0" id="workingWithSettings"><a name="workingWithSettings"><!-- --></a>
    <h1 class="topictitle1">Working with Settings</h1>

    <!-- <div />--> 
    <div class="nested1" id="editingSettingsValues"><a name="editingSettingsValues"><!-- --></a>
      <h2 class="topictitle2">Editing Values of Settings</h2>

		<div>
			<div class="section">Situation: You want to edit the value of a setting.</div>

			<ol>
				<li>
					<span>Browse to the setting in the software variant proposal form (or use Search to jump to the setting).</span>
				</li>

				<li>
					<span>Fill out the value of the setting by typing in freetext, selecting the correct option(s) or associating a resource to the setting.</span>
				</li>

			</ol>

			<div class="section">Carbide.v displays the value in the software variant proposal form with the setting.<br />
                           The setting's name font is shown bold in the editor to notify that the setting has been changed.<br />
                           Setting is added to the list of changed settings <a href="workingWithVariantProposals.html#viewingChanges">Changes view</a></div>
      <br />
      <div class="example"> <img src="images/editing_setting.png" alt="Editing simple settings." /> </div>
		</div>

    </div>
    <div class="nested1" id="editingSettingsValues"><a name="editingSettingsValues"><!-- --></a>
      <h2 class="topictitle2">Editing Sequence Settings</h2>
      
    <div class="nested1" id="editingSequences"><a name="etitingSequences"><!-- --></a>
      <h4>Editing Sequence Items</h4>

		<div>
			<div class="section">Situation: You want to edit the value of a setting which contains a sequence.</div>

			<ol>
				<li>
					<span>Browse to the setting in the software variant proposal form (or use Search to jump to the setting).</span>
				</li>
	      <li>
	      	<span>Expand the sequence's items by clicking the <img src="images/expandall.gif" alt="Expand all" /><span class="uicontrol"> expand all</span> button.</span>
				</li>
				<li>
	      	<span>Select the sequence item you want to edit</span>
					</li>
				<li>
					<span>Edit the subsettings' values by typing in freetext, selecting the correct option(s) or associating a resource to the setting.</span>
				</li>

			</ol>

			<div class="section">Carbide.v displays the value in the software variant proposal form with the setting.<br />
                           The setting's name font is shown bold in the editor to notify that the setting has been changed.<br />
                           Setting is added to the list of changed settings(Changes view) </div>

		</div>
		</div>
		<p />
		<div class="nested1" id="editingSequences"><a name="addingSequences"><!-- --></a>
      <h4>Adding Sequence Items</h4>
      
			<div class="section">Situation: You want to add a new item to a setting which contains a sequence.</div>

			<ol>
				<li>
					<span>Browse to the setting in the software variant proposal form (or use Search to jump to the setting).</span>
				</li>
	      <li>
					<span>Add new sequence item by pressing the <img src="images/add_obj.gif" alt="Add new sequence item" /><span class="uicontrol"> add new sequence item</span> button.</span>
				</li>
				<li>
					<span>Fill out the particular settings' values of the sequence item by typing in freetext, selecting the correct option(s) or associating a resource to the setting.</span>
				</li>

			</ol>

			<div class="section">Carbide.v displays the value in the software variant proposal form with the setting.<br />
                           The setting's name font is shown bold in the editor to notify that the setting has been changed.<br />
                           Setting is added to the list of changed settings(Changes view) 
      </div>

		</div>
		<p />
		<div class="nested1" id="editingSequences"><a name="removingSequences"><!-- --></a>
      <h4>Removing Sequence Items</h4>
      
			<div class="section">Situation: You want to remove an item from a setting which contains a sequence.</div>

			<ol>
				<li>
					<span>Browse to the setting in the software variant proposal form (or use Search to jump to the setting).</span>
				</li>
	      <li>
					<span>Expand the sequence's items by clicking the <img src="images/expandall.gif" alt="Expand all" /><span class="uicontrol"> expand all</span> button.</span>
				</li>
	      <li>
					<span>Select the item you want to remove and press the <img src="images/delete_16_tlb.png" alt="Remove sequence item" /><span class="uicontrol"> remove sequence item</span> button.</span>
				</li>
			</ol>

			<div class="section">Carbide.v removes previously selected setting item from the editor.<br />
                           The setting's name font is shown bold to notify that the setting has been changed.<br />
                           Setting is added to the list of changed settings(Changes view) </div>
      <br />
      <div class="example"> <img src="images/editing_sequences.png" alt="Editing sequence settings." /> </div>

		</div>
		</div>

    <div class="nested1" id="validatingSettingsValues"><a name="validatingSettingsValues"><!-- --></a>
      <h2 class="topictitle2">Validating Values of Settings for Correctness</h2>

		<div>
			<div class="section">Situation: You want to feel sure that you only fill out settings with values in correct format.</div>

		<ul>
			<li>
			<div class="p">
				<span>Type a value in <span class="uicontrol">correct format</span> to a setting field.</span>
			</div>
		  </li>
	 </ul>

		
			<div class="section">Carbide.v accepts and displays the value in the form. If you have typed an erraneus value to the format, Carbide. v can display one of the following validation errors:</div>

	 <ol type="disc">
			<li><b>Numbers</b>
			<ul>
			 <li>Incorrect format of number</li>
			 <li>Minimum value is not reached</li>
			 <li>Maximum value is exceeded</li>
			 <li>The maximum number if digits is exceeded</li>
			 <li>The value doesn't match pattern</li>
			 </ul>
      </li>
      <br />
      <li><b>Strings</b>
      <ul>
			 <li>Exact length is not matched</li>
			 <li>Minimum length of string is not reached</li>
			 <li>Maximum length of string is exceeded</li>
			 <li>The value doesn't match pattern</li>
      </ul>
      </li>
      <br />
      <li><b>Dates and times</b>
      <ul>
			 <li>Incorrect format of date</li>
			 <li>Incorrect format of time</li>
			 <li>Incorrect format of date time</li>
			 <li>Incorrect format of duration</li>
      </ul>
      </li>
      <br />
      <li><b>Sequences</b>
      <ul>
			 <li>Minimum number of sequences is not reached</li>
       <li>Maximum number of sequences exceeded</li>
      </ul>
      </li>
      <br />
      <li><b>Files and others</b>
			<ul>
			 <li>File is not in the Resources Library</li>
			 <li>Directory is not in the Resources Library</li>
			 <li>Value is missing</li>
      </ul>
      </li>    
   </ol>        
      <div class="section">Carbide.v notifies that by displaying a red marker on the particular row in the editor. 
                           Setting is added to the list of errorneous settings in the <a href="workingWithVariantProposals.html#viewingErrors">Errors view</a>.</div>
      <br />
      <div class="example"> <img src="images/validating_values.png" alt="Validating Values." /> </div>


		</div>

    </div>

	  
    <div class="nested1" id="selectingSettings"><a name="selectingSettings"><!-- --></a>
      <h2 class="topictitle2">Selecting Settings</h2>

		<div>
			<div class="section">Situation: You want to do something (for instance hide) with one or more settings.</div>

			<ul>
				<li>
					<span>To select one setting, simply click the setting.</span>
				</li>

				<li>
					<span>To select several settings, press Ctrl key down and click each of the settings.</span>
				</li>
<!--
				<li>
					<span>To select several adjacent settings, click the first of the settings, press Shift key down and click the last setting.</span>
				</li>
-->
				<li>
					<span>To select all settings in a group of settings, click your right mouse button on the form and select 'Select all' in the context menu or click the particular toolbar button.</span>
				</li>

			</ul>

			<div class="section">Carbide.v highlights the setting(s) that you selected and you may perform an operation on it or them.</div>

		
		</div>

    </div>

    <div class="nested1" id="restoringSettingsToDefaultValues"><a name="restoringSettingsToDefaultValues"><!-- --></a>
      <h2 class="topictitle2">Restoring Settings to their Default Values</h2>

		<div>
			<div class="section">Situation: You want to have the default value for a setting instead of the altered one.</div>

		<ol>
			<li>
				<span>Select one or mote settings.</span>
			</li>

			<li>
				<span>Click right mouse button and select <span class="uicontrol">Restore to default</span> in the context menu or click the particular toolbar button. </span>
			</li>

		</ol>

			<div class="section">The values of the settings are the default ones again. </div>
			<br />
			<div class="example"> <img src="images/restore_defaults.png" alt="Restoring default values." /> </div>

		</div>
    </div>

    <div class="nested1" id="orderSettings"><a name="orderSettings"><!-- --></a>
      <h2 class="topictitle2">Sorting of settings</h2>

		<div>
			<div class="section">Situation: You want to sort out the settings by their status markers.</div>

		<ol>
			<li>
				<span>Open a group with the settings.</span>
			</li>
	    <li>
				<span>Precondition: Change setting(s) value(s), append notes to them. </span>
			</li>
			 <li>
				<span>Depending the user steps each setting can be marked with none to three diffrent status markers: Changed status, Error status, Note appended status.</span>
			</li>
			<li>
				<span>You can sort out the settings in th editor clicking the particular <span class="uicontrol">Sort icons</span> (highlighted green) or reset the sorting by clicking the empty bar on the top (highlighted yellow)</span>
			</li>
		</ol>
		<dl><b>Sort out buttons</b>
      <dd><img src="images/srt_error.png" alt="Sort by errornous"/> - settings with errors to be displayed on the top</dd>
      <dd><img src="images/srt_note.png" alt="Sort by notes"/> - settings with appended notes to be displayed on the top</dd>
      <dd><img src="images/srt_dirty.png" alt="Sort by dirty"/> - settings with changes to be displayed on the top</dd>
    </dl>

			<div class="section">The settings in the editor are sorted out accordingly. </div>
			<br />
      <div class="example"> <img src="images/change_order.png" alt="Changing the order of settings." /> </div>

		</div>
    </div>
	  
    <div class="nested1" id="appendingNotesToSettings"><a name="appendingNotesToSettings"><!-- --></a>
      <h2 class="topictitle2">Appending Notes to Settings</h2>

		<div>
			<div class="section">Situation: You want to inform another Carbide.V user about something related to an individual setting.</div>

		<ol>
			<li>
				<span>Click the setting in the proposal form.</span>
			</li>

			<li>
				<span>Type your message in the Note field of the setting Properties pane.</span>
			</li>

		</ol>

			<div class="section">The note is visible in the Properties pane of the setting an also listed in the software variant proposal Summary page to all Carbide.v users that handle later on the same software variant proposal.<br />
                           Carbide.V displays a note marker on the particular row in the editor. Setting is added to the list of settings with appended notes in the <a href="workingWithVariantProposals.html#viewingNotes">Notes view</a>.</div>
      
      <br />
      <div class="example"> <img src="images/appending_notes.png" alt="Appending of notes." /> </div>

		</div>

    </div>

    <div class="nested1" id="removingSettings"><a name="removingSettings"><!-- --></a>
      <h2 class="topictitle2">Hiding Settings</h2>

		<div>
			<div class="section">Situation: You want to remove a setting that is not needed to be changed.</div>

		<ol>
			<li>
				<span>Select the setting(s) that you want to remove. Use <span class="uicontrol">Ctrl</span> key for multiselection.</span>
			</li>

			<li>
				<span>Click your right mouse button and select 'Hide selected settings' in the context menu or click the appropriate toolbar button</span>
			</li>

		</ol>
        <div class="section">Carbide.v removes selected settings from the current group.</div>
		</div>
    </div>
    <div class="nested1" id="relevantSetting"><a name="relevantSetting"><!-- --></a>
      <h2 class="topictitle2">Relevant setting option</h2>

		<div>
			<div class="section">Situation: The subgroup contains a setting that is visible only if certain costraints are met. You want the setting to be visible in the editor.</div>

		<ol>
			<li>
				<span>Find out the setting contrains.</span>
			</li>

			<li>
				<span>Meet the setting contrains by setting the right value of an appropriate setting.</span>
			</li>

		</ol>
        <div class="section">Carbide.v shows previously hidden setting in the appropriate group.</div>
		</div>
    </div>
 </div>
 <br/>
 <div id="footer">Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.<br/> 
                   License: <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>.
  </div>

</body>
</html>